Documentation
¶
Index ¶
- func ApplicationListenerCertificate_IsConstruct(x interface{}) *bool
- func ApplicationListenerRule_IsConstruct(x interface{}) *bool
- func ApplicationListener_IsConstruct(x interface{}) *bool
- func ApplicationListener_IsResource(construct constructs.IConstruct) *bool
- func ApplicationLoadBalancer_IsConstruct(x interface{}) *bool
- func ApplicationLoadBalancer_IsResource(construct constructs.IConstruct) *bool
- func ApplicationTargetGroup_IsConstruct(x interface{}) *bool
- func BaseListener_IsConstruct(x interface{}) *bool
- func BaseListener_IsResource(construct constructs.IConstruct) *bool
- func BaseLoadBalancer_IsConstruct(x interface{}) *bool
- func BaseLoadBalancer_IsResource(construct constructs.IConstruct) *bool
- func CfnListenerCertificate_CFN_RESOURCE_TYPE_NAME() *string
- func CfnListenerCertificate_IsCfnElement(x interface{}) *bool
- func CfnListenerCertificate_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnListenerCertificate_IsConstruct(x interface{}) *bool
- func CfnListenerRule_CFN_RESOURCE_TYPE_NAME() *string
- func CfnListenerRule_IsCfnElement(x interface{}) *bool
- func CfnListenerRule_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnListenerRule_IsConstruct(x interface{}) *bool
- func CfnListener_CFN_RESOURCE_TYPE_NAME() *string
- func CfnListener_IsCfnElement(x interface{}) *bool
- func CfnListener_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnListener_IsConstruct(x interface{}) *bool
- func CfnLoadBalancer_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLoadBalancer_IsCfnElement(x interface{}) *bool
- func CfnLoadBalancer_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnLoadBalancer_IsConstruct(x interface{}) *bool
- func CfnTargetGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTargetGroup_IsCfnElement(x interface{}) *bool
- func CfnTargetGroup_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnTargetGroup_IsConstruct(x interface{}) *bool
- func NetworkListener_IsConstruct(x interface{}) *bool
- func NetworkListener_IsResource(construct constructs.IConstruct) *bool
- func NetworkLoadBalancer_IsConstruct(x interface{}) *bool
- func NetworkLoadBalancer_IsResource(construct constructs.IConstruct) *bool
- func NetworkTargetGroup_IsConstruct(x interface{}) *bool
- func NewApplicationListenerCertificate_Override(a ApplicationListenerCertificate, scope constructs.Construct, id *string, ...)
- func NewApplicationListenerRule_Override(a ApplicationListenerRule, scope constructs.Construct, id *string, ...)
- func NewApplicationListener_Override(a ApplicationListener, scope constructs.Construct, id *string, ...)
- func NewApplicationLoadBalancer_Override(a ApplicationLoadBalancer, scope constructs.Construct, id *string, ...)
- func NewApplicationTargetGroup_Override(a ApplicationTargetGroup, scope constructs.Construct, id *string, ...)
- func NewBaseListener_Override(b BaseListener, scope constructs.Construct, id *string, ...)
- func NewBaseLoadBalancer_Override(b BaseLoadBalancer, scope constructs.Construct, id *string, ...)
- func NewCfnListenerCertificate_Override(c CfnListenerCertificate, scope constructs.Construct, id *string, ...)
- func NewCfnListenerRule_Override(c CfnListenerRule, scope constructs.Construct, id *string, ...)
- func NewCfnListener_Override(c CfnListener, scope constructs.Construct, id *string, props *CfnListenerProps)
- func NewCfnLoadBalancer_Override(c CfnLoadBalancer, scope constructs.Construct, id *string, ...)
- func NewCfnTargetGroup_Override(c CfnTargetGroup, scope constructs.Construct, id *string, ...)
- func NewListenerAction_Override(l ListenerAction, actionJson *CfnListener_ActionProperty, next ListenerAction)
- func NewListenerCertificate_Override(l ListenerCertificate, certificateArn *string)
- func NewListenerCondition_Override(l ListenerCondition)
- func NewNetworkListenerAction_Override(n NetworkListenerAction, actionJson *CfnListener_ActionProperty, ...)
- func NewNetworkListener_Override(n NetworkListener, scope constructs.Construct, id *string, ...)
- func NewNetworkLoadBalancer_Override(n NetworkLoadBalancer, scope constructs.Construct, id *string, ...)
- func NewNetworkTargetGroup_Override(n NetworkTargetGroup, scope constructs.Construct, id *string, ...)
- func NewTargetGroupBase_Override(t TargetGroupBase, scope constructs.Construct, id *string, ...)
- func TargetGroupBase_IsConstruct(x interface{}) *bool
- type AddApplicationActionProps
- type AddApplicationTargetGroupsProps
- type AddApplicationTargetsProps
- type AddNetworkActionProps
- type AddNetworkTargetsProps
- type AddRuleProps
- type AlpnPolicy
- type ApplicationListener
- type ApplicationListenerAttributes
- type ApplicationListenerCertificate
- type ApplicationListenerCertificateProps
- type ApplicationListenerLookupOptions
- type ApplicationListenerProps
- type ApplicationListenerRule
- type ApplicationListenerRuleProps
- type ApplicationLoadBalancer
- type ApplicationLoadBalancerAttributes
- type ApplicationLoadBalancerLookupOptions
- type ApplicationLoadBalancerProps
- type ApplicationLoadBalancerRedirectConfig
- type ApplicationProtocol
- type ApplicationProtocolVersion
- type ApplicationTargetGroup
- type ApplicationTargetGroupProps
- type AuthenticateOidcOptions
- type BaseApplicationListenerProps
- type BaseApplicationListenerRuleProps
- type BaseListener
- type BaseListenerLookupOptions
- type BaseLoadBalancer
- type BaseLoadBalancerLookupOptions
- type BaseLoadBalancerProps
- type BaseNetworkListenerProps
- type BaseTargetGroupProps
- type CfnListener
- type CfnListenerCertificate
- type CfnListenerCertificateProps
- type CfnListenerCertificate_CertificateProperty
- type CfnListenerProps
- type CfnListenerRule
- type CfnListenerRuleProps
- type CfnListenerRule_ActionProperty
- type CfnListenerRule_AuthenticateCognitoConfigProperty
- type CfnListenerRule_AuthenticateOidcConfigProperty
- type CfnListenerRule_FixedResponseConfigProperty
- type CfnListenerRule_ForwardConfigProperty
- type CfnListenerRule_HostHeaderConfigProperty
- type CfnListenerRule_HttpHeaderConfigProperty
- type CfnListenerRule_HttpRequestMethodConfigProperty
- type CfnListenerRule_PathPatternConfigProperty
- type CfnListenerRule_QueryStringConfigProperty
- type CfnListenerRule_QueryStringKeyValueProperty
- type CfnListenerRule_RedirectConfigProperty
- type CfnListenerRule_RuleConditionProperty
- type CfnListenerRule_SourceIpConfigProperty
- type CfnListenerRule_TargetGroupStickinessConfigProperty
- type CfnListenerRule_TargetGroupTupleProperty
- type CfnListener_ActionProperty
- type CfnListener_AuthenticateCognitoConfigProperty
- type CfnListener_AuthenticateOidcConfigProperty
- type CfnListener_CertificateProperty
- type CfnListener_FixedResponseConfigProperty
- type CfnListener_ForwardConfigProperty
- type CfnListener_RedirectConfigProperty
- type CfnListener_TargetGroupStickinessConfigProperty
- type CfnListener_TargetGroupTupleProperty
- type CfnLoadBalancer
- type CfnLoadBalancerProps
- type CfnLoadBalancer_LoadBalancerAttributeProperty
- type CfnLoadBalancer_SubnetMappingProperty
- type CfnTargetGroup
- type CfnTargetGroupProps
- type CfnTargetGroup_MatcherProperty
- type CfnTargetGroup_TargetDescriptionProperty
- type CfnTargetGroup_TargetGroupAttributeProperty
- type FixedResponseOptions
- type ForwardOptions
- type HealthCheck
- type HttpCodeElb
- type HttpCodeTarget
- type IApplicationListener
- type IApplicationLoadBalancer
- type IApplicationLoadBalancerTarget
- type IApplicationTargetGroup
- type IListenerAction
- type IListenerCertificate
- type ILoadBalancerV2
- type INetworkListener
- type INetworkLoadBalancer
- type INetworkLoadBalancerTarget
- type INetworkTargetGroup
- type ITargetGroup
- type IpAddressType
- type ListenerAction
- func ListenerAction_AuthenticateOidc(options *AuthenticateOidcOptions) ListenerAction
- func ListenerAction_FixedResponse(statusCode *float64, options *FixedResponseOptions) ListenerAction
- func ListenerAction_Forward(targetGroups *[]IApplicationTargetGroup, options *ForwardOptions) ListenerAction
- func ListenerAction_Redirect(options *RedirectOptions) ListenerAction
- func ListenerAction_WeightedForward(targetGroups *[]*WeightedTargetGroup, options *ForwardOptions) ListenerAction
- func NewListenerAction(actionJson *CfnListener_ActionProperty, next ListenerAction) ListenerAction
- type ListenerCertificate
- type ListenerCondition
- func ListenerCondition_HostHeaders(values *[]*string) ListenerCondition
- func ListenerCondition_HttpHeader(name *string, values *[]*string) ListenerCondition
- func ListenerCondition_HttpRequestMethods(values *[]*string) ListenerCondition
- func ListenerCondition_PathPatterns(values *[]*string) ListenerCondition
- func ListenerCondition_QueryStrings(values *[]*QueryStringCondition) ListenerCondition
- func ListenerCondition_SourceIps(values *[]*string) ListenerCondition
- type LoadBalancerTargetProps
- type NetworkForwardOptions
- type NetworkListener
- type NetworkListenerAction
- func NetworkListenerAction_Forward(targetGroups *[]INetworkTargetGroup, options *NetworkForwardOptions) NetworkListenerAction
- func NetworkListenerAction_WeightedForward(targetGroups *[]*NetworkWeightedTargetGroup, options *NetworkForwardOptions) NetworkListenerAction
- func NewNetworkListenerAction(actionJson *CfnListener_ActionProperty, next NetworkListenerAction) NetworkListenerAction
- type NetworkListenerLookupOptions
- type NetworkListenerProps
- type NetworkLoadBalancer
- type NetworkLoadBalancerAttributes
- type NetworkLoadBalancerLookupOptions
- type NetworkLoadBalancerProps
- type NetworkTargetGroup
- type NetworkTargetGroupProps
- type NetworkWeightedTargetGroup
- type Protocol
- type QueryStringCondition
- type RedirectOptions
- type SslPolicy
- type TargetGroupAttributes
- type TargetGroupBase
- type TargetGroupLoadBalancingAlgorithmType
- type TargetType
- type UnauthenticatedAction
- type WeightedTargetGroup
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ApplicationListenerCertificate_IsConstruct ¶
func ApplicationListenerCertificate_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func ApplicationListenerRule_IsConstruct ¶
func ApplicationListenerRule_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func ApplicationListener_IsConstruct ¶
func ApplicationListener_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func ApplicationListener_IsResource ¶
func ApplicationListener_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func ApplicationLoadBalancer_IsConstruct ¶
func ApplicationLoadBalancer_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func ApplicationLoadBalancer_IsResource ¶
func ApplicationLoadBalancer_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func ApplicationTargetGroup_IsConstruct ¶
func ApplicationTargetGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func BaseListener_IsConstruct ¶
func BaseListener_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func BaseListener_IsResource ¶
func BaseListener_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func BaseLoadBalancer_IsConstruct ¶
func BaseLoadBalancer_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func BaseLoadBalancer_IsResource ¶
func BaseLoadBalancer_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func CfnListenerCertificate_CFN_RESOURCE_TYPE_NAME ¶
func CfnListenerCertificate_CFN_RESOURCE_TYPE_NAME() *string
func CfnListenerCertificate_IsCfnElement ¶
func CfnListenerCertificate_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnListenerCertificate_IsCfnResource ¶
func CfnListenerCertificate_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnListenerCertificate_IsConstruct ¶
func CfnListenerCertificate_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnListenerRule_CFN_RESOURCE_TYPE_NAME ¶
func CfnListenerRule_CFN_RESOURCE_TYPE_NAME() *string
func CfnListenerRule_IsCfnElement ¶
func CfnListenerRule_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnListenerRule_IsCfnResource ¶
func CfnListenerRule_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnListenerRule_IsConstruct ¶
func CfnListenerRule_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnListener_CFN_RESOURCE_TYPE_NAME ¶
func CfnListener_CFN_RESOURCE_TYPE_NAME() *string
func CfnListener_IsCfnElement ¶
func CfnListener_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnListener_IsCfnResource ¶
func CfnListener_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnListener_IsConstruct ¶
func CfnListener_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnLoadBalancer_CFN_RESOURCE_TYPE_NAME ¶
func CfnLoadBalancer_CFN_RESOURCE_TYPE_NAME() *string
func CfnLoadBalancer_IsCfnElement ¶
func CfnLoadBalancer_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnLoadBalancer_IsCfnResource ¶
func CfnLoadBalancer_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnLoadBalancer_IsConstruct ¶
func CfnLoadBalancer_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnTargetGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnTargetGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnTargetGroup_IsCfnElement ¶
func CfnTargetGroup_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnTargetGroup_IsCfnResource ¶
func CfnTargetGroup_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnTargetGroup_IsConstruct ¶
func CfnTargetGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func NetworkListener_IsConstruct ¶
func NetworkListener_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func NetworkListener_IsResource ¶
func NetworkListener_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func NetworkLoadBalancer_IsConstruct ¶
func NetworkLoadBalancer_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func NetworkLoadBalancer_IsResource ¶
func NetworkLoadBalancer_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func NetworkTargetGroup_IsConstruct ¶
func NetworkTargetGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func NewApplicationListenerCertificate_Override ¶
func NewApplicationListenerCertificate_Override(a ApplicationListenerCertificate, scope constructs.Construct, id *string, props *ApplicationListenerCertificateProps)
func NewApplicationListenerRule_Override ¶
func NewApplicationListenerRule_Override(a ApplicationListenerRule, scope constructs.Construct, id *string, props *ApplicationListenerRuleProps)
func NewApplicationListener_Override ¶
func NewApplicationListener_Override(a ApplicationListener, scope constructs.Construct, id *string, props *ApplicationListenerProps)
func NewApplicationLoadBalancer_Override ¶
func NewApplicationLoadBalancer_Override(a ApplicationLoadBalancer, scope constructs.Construct, id *string, props *ApplicationLoadBalancerProps)
func NewApplicationTargetGroup_Override ¶
func NewApplicationTargetGroup_Override(a ApplicationTargetGroup, scope constructs.Construct, id *string, props *ApplicationTargetGroupProps)
func NewBaseListener_Override ¶
func NewBaseListener_Override(b BaseListener, scope constructs.Construct, id *string, additionalProps interface{})
func NewBaseLoadBalancer_Override ¶
func NewBaseLoadBalancer_Override(b BaseLoadBalancer, scope constructs.Construct, id *string, baseProps *BaseLoadBalancerProps, additionalProps interface{})
func NewCfnListenerCertificate_Override ¶
func NewCfnListenerCertificate_Override(c CfnListenerCertificate, scope constructs.Construct, id *string, props *CfnListenerCertificateProps)
Create a new `AWS::ElasticLoadBalancingV2::ListenerCertificate`.
func NewCfnListenerRule_Override ¶
func NewCfnListenerRule_Override(c CfnListenerRule, scope constructs.Construct, id *string, props *CfnListenerRuleProps)
Create a new `AWS::ElasticLoadBalancingV2::ListenerRule`.
func NewCfnListener_Override ¶
func NewCfnListener_Override(c CfnListener, scope constructs.Construct, id *string, props *CfnListenerProps)
Create a new `AWS::ElasticLoadBalancingV2::Listener`.
func NewCfnLoadBalancer_Override ¶
func NewCfnLoadBalancer_Override(c CfnLoadBalancer, scope constructs.Construct, id *string, props *CfnLoadBalancerProps)
Create a new `AWS::ElasticLoadBalancingV2::LoadBalancer`.
func NewCfnTargetGroup_Override ¶
func NewCfnTargetGroup_Override(c CfnTargetGroup, scope constructs.Construct, id *string, props *CfnTargetGroupProps)
Create a new `AWS::ElasticLoadBalancingV2::TargetGroup`.
func NewListenerAction_Override ¶
func NewListenerAction_Override(l ListenerAction, actionJson *CfnListener_ActionProperty, next ListenerAction)
Create an instance of ListenerAction.
The default class should be good enough for most cases and should be created by using one of the static factory functions, but allow overriding to make sure we allow flexibility for the future.
func NewListenerCertificate_Override ¶
func NewListenerCertificate_Override(l ListenerCertificate, certificateArn *string)
func NewListenerCondition_Override ¶
func NewListenerCondition_Override(l ListenerCondition)
func NewNetworkListenerAction_Override ¶
func NewNetworkListenerAction_Override(n NetworkListenerAction, actionJson *CfnListener_ActionProperty, next NetworkListenerAction)
Create an instance of NetworkListenerAction.
The default class should be good enough for most cases and should be created by using one of the static factory functions, but allow overriding to make sure we allow flexibility for the future.
func NewNetworkListener_Override ¶
func NewNetworkListener_Override(n NetworkListener, scope constructs.Construct, id *string, props *NetworkListenerProps)
func NewNetworkLoadBalancer_Override ¶
func NewNetworkLoadBalancer_Override(n NetworkLoadBalancer, scope constructs.Construct, id *string, props *NetworkLoadBalancerProps)
func NewNetworkTargetGroup_Override ¶
func NewNetworkTargetGroup_Override(n NetworkTargetGroup, scope constructs.Construct, id *string, props *NetworkTargetGroupProps)
func NewTargetGroupBase_Override ¶
func NewTargetGroupBase_Override(t TargetGroupBase, scope constructs.Construct, id *string, baseProps *BaseTargetGroupProps, additionalProps interface{})
func TargetGroupBase_IsConstruct ¶
func TargetGroupBase_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
Types ¶
type AddApplicationActionProps ¶
type AddApplicationActionProps struct { // Rule applies if matches the conditions. // See: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html // Conditions *[]ListenerCondition `json:"conditions" yaml:"conditions"` // Priority of this target group. // // The rule with the lowest priority will be used for every request. // If priority is not given, these target groups will be added as // defaults, and must not have conditions. // // Priorities must be unique. Priority *float64 `json:"priority" yaml:"priority"` // Action to perform. Action ListenerAction `json:"action" yaml:"action"` }
Properties for adding a new action to a listener.
TODO: EXAMPLE
type AddApplicationTargetGroupsProps ¶
type AddApplicationTargetGroupsProps struct { // Rule applies if matches the conditions. // See: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html // Conditions *[]ListenerCondition `json:"conditions" yaml:"conditions"` // Priority of this target group. // // The rule with the lowest priority will be used for every request. // If priority is not given, these target groups will be added as // defaults, and must not have conditions. // // Priorities must be unique. Priority *float64 `json:"priority" yaml:"priority"` // Target groups to forward requests to. TargetGroups *[]IApplicationTargetGroup `json:"targetGroups" yaml:"targetGroups"` }
Properties for adding a new target group to a listener.
TODO: EXAMPLE
type AddApplicationTargetsProps ¶
type AddApplicationTargetsProps struct { // Rule applies if matches the conditions. // See: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html // Conditions *[]ListenerCondition `json:"conditions" yaml:"conditions"` // Priority of this target group. // // The rule with the lowest priority will be used for every request. // If priority is not given, these target groups will be added as // defaults, and must not have conditions. // // Priorities must be unique. Priority *float64 `json:"priority" yaml:"priority"` // The amount of time for Elastic Load Balancing to wait before deregistering a target. // // The range is 0-3600 seconds. DeregistrationDelay awscdk.Duration `json:"deregistrationDelay" yaml:"deregistrationDelay"` // Health check configuration. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#aws-resource-elasticloadbalancingv2-targetgroup-properties // HealthCheck *HealthCheck `json:"healthCheck" yaml:"healthCheck"` // The load balancing algorithm to select targets for routing requests. LoadBalancingAlgorithmType TargetGroupLoadBalancingAlgorithmType `json:"loadBalancingAlgorithmType" yaml:"loadBalancingAlgorithmType"` // The port on which the listener listens for requests. Port *float64 `json:"port" yaml:"port"` // The protocol to use. Protocol ApplicationProtocol `json:"protocol" yaml:"protocol"` // The protocol version to use. ProtocolVersion ApplicationProtocolVersion `json:"protocolVersion" yaml:"protocolVersion"` // The time period during which the load balancer sends a newly registered target a linearly increasing share of the traffic to the target group. // // The range is 30-900 seconds (15 minutes). SlowStart awscdk.Duration `json:"slowStart" yaml:"slowStart"` // The stickiness cookie expiration period. // // Setting this value enables load balancer stickiness. // // After this period, the cookie is considered stale. The minimum value is // 1 second and the maximum value is 7 days (604800 seconds). StickinessCookieDuration awscdk.Duration `json:"stickinessCookieDuration" yaml:"stickinessCookieDuration"` // The name of an application-based stickiness cookie. // // Names that start with the following prefixes are not allowed: AWSALB, AWSALBAPP, // and AWSALBTG; they're reserved for use by the load balancer. // // Note: `stickinessCookieName` parameter depends on the presence of `stickinessCookieDuration` parameter. // If `stickinessCookieDuration` is not set, `stickinessCookieName` will be omitted. // See: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/sticky-sessions.html // StickinessCookieName *string `json:"stickinessCookieName" yaml:"stickinessCookieName"` // The name of the target group. // // This name must be unique per region per account, can have a maximum of // 32 characters, must contain only alphanumeric characters or hyphens, and // must not begin or end with a hyphen. TargetGroupName *string `json:"targetGroupName" yaml:"targetGroupName"` // The targets to add to this target group. // // Can be `Instance`, `IPAddress`, or any self-registering load balancing // target. All target must be of the same type. Targets *[]IApplicationLoadBalancerTarget `json:"targets" yaml:"targets"` }
Properties for adding new targets to a listener.
TODO: EXAMPLE
type AddNetworkActionProps ¶
type AddNetworkActionProps struct { // Action to perform. Action NetworkListenerAction `json:"action" yaml:"action"` }
Properties for adding a new action to a listener.
TODO: EXAMPLE
type AddNetworkTargetsProps ¶
type AddNetworkTargetsProps struct { // The port on which the listener listens for requests. Port *float64 `json:"port" yaml:"port"` // The amount of time for Elastic Load Balancing to wait before deregistering a target. // // The range is 0-3600 seconds. DeregistrationDelay awscdk.Duration `json:"deregistrationDelay" yaml:"deregistrationDelay"` // Health check configuration. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#aws-resource-elasticloadbalancingv2-targetgroup-properties // HealthCheck *HealthCheck `json:"healthCheck" yaml:"healthCheck"` // Indicates whether client IP preservation is enabled. PreserveClientIp *bool `json:"preserveClientIp" yaml:"preserveClientIp"` // Protocol for target group, expects TCP, TLS, UDP, or TCP_UDP. Protocol Protocol `json:"protocol" yaml:"protocol"` // Indicates whether Proxy Protocol version 2 is enabled. ProxyProtocolV2 *bool `json:"proxyProtocolV2" yaml:"proxyProtocolV2"` // The name of the target group. // // This name must be unique per region per account, can have a maximum of // 32 characters, must contain only alphanumeric characters or hyphens, and // must not begin or end with a hyphen. TargetGroupName *string `json:"targetGroupName" yaml:"targetGroupName"` // The targets to add to this target group. // // Can be `Instance`, `IPAddress`, or any self-registering load balancing // target. If you use either `Instance` or `IPAddress` as targets, all // target must be of the same type. Targets *[]INetworkLoadBalancerTarget `json:"targets" yaml:"targets"` }
Properties for adding new network targets to a listener.
TODO: EXAMPLE
type AddRuleProps ¶
type AddRuleProps struct { // Rule applies if matches the conditions. // See: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html // Conditions *[]ListenerCondition `json:"conditions" yaml:"conditions"` // Priority of this target group. // // The rule with the lowest priority will be used for every request. // If priority is not given, these target groups will be added as // defaults, and must not have conditions. // // Priorities must be unique. Priority *float64 `json:"priority" yaml:"priority"` }
Properties for adding a conditional load balancing rule.
TODO: EXAMPLE
type AlpnPolicy ¶
type AlpnPolicy string
Application-Layer Protocol Negotiation Policies for network load balancers.
Which protocols should be used over a secure connection.
const ( AlpnPolicy_HTTP1_ONLY AlpnPolicy = "HTTP1_ONLY" AlpnPolicy_HTTP2_ONLY AlpnPolicy = "HTTP2_ONLY" AlpnPolicy_HTTP2_OPTIONAL AlpnPolicy = "HTTP2_OPTIONAL" AlpnPolicy_HTTP2_PREFERRED AlpnPolicy = "HTTP2_PREFERRED" AlpnPolicy_NONE AlpnPolicy = "NONE" )
type ApplicationListener ¶
type ApplicationListener interface { BaseListener IApplicationListener Connections() awsec2.Connections Env() *awscdk.ResourceEnvironment ListenerArn() *string LoadBalancer() IApplicationLoadBalancer Node() constructs.Node PhysicalName() *string Stack() awscdk.Stack AddAction(id *string, props *AddApplicationActionProps) AddCertificates(id *string, certificates *[]IListenerCertificate) AddTargetGroups(id *string, props *AddApplicationTargetGroupsProps) AddTargets(id *string, props *AddApplicationTargetsProps) ApplicationTargetGroup ApplyRemovalPolicy(policy awscdk.RemovalPolicy) GeneratePhysicalName() *string GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string GetResourceNameAttribute(nameAttr *string) *string RegisterConnectable(connectable awsec2.IConnectable, portRange awsec2.Port) ToString() *string ValidateListener() *[]*string }
Define an ApplicationListener.
TODO: EXAMPLE
func NewApplicationListener ¶
func NewApplicationListener(scope constructs.Construct, id *string, props *ApplicationListenerProps) ApplicationListener
type ApplicationListenerAttributes ¶
type ApplicationListenerAttributes struct { // ARN of the listener. ListenerArn *string `json:"listenerArn" yaml:"listenerArn"` // The default port on which this listener is listening. DefaultPort *float64 `json:"defaultPort" yaml:"defaultPort"` // Security group of the load balancer this listener is associated with. SecurityGroup awsec2.ISecurityGroup `json:"securityGroup" yaml:"securityGroup"` }
Properties to reference an existing listener.
TODO: EXAMPLE
type ApplicationListenerCertificate ¶
type ApplicationListenerCertificate interface { constructs.Construct Node() constructs.Node ToString() *string }
Add certificates to a listener.
TODO: EXAMPLE
func NewApplicationListenerCertificate ¶
func NewApplicationListenerCertificate(scope constructs.Construct, id *string, props *ApplicationListenerCertificateProps) ApplicationListenerCertificate
type ApplicationListenerCertificateProps ¶
type ApplicationListenerCertificateProps struct { // The listener to attach the rule to. Listener IApplicationListener `json:"listener" yaml:"listener"` // Certificates to attach. // // Duplicates are not allowed. Certificates *[]IListenerCertificate `json:"certificates" yaml:"certificates"` }
Properties for adding a set of certificates to a listener.
TODO: EXAMPLE
type ApplicationListenerLookupOptions ¶
type ApplicationListenerLookupOptions struct { // Filter listeners by listener port. ListenerPort *float64 `json:"listenerPort" yaml:"listenerPort"` // Filter listeners by associated load balancer arn. LoadBalancerArn *string `json:"loadBalancerArn" yaml:"loadBalancerArn"` // Filter listeners by associated load balancer tags. LoadBalancerTags *map[string]*string `json:"loadBalancerTags" yaml:"loadBalancerTags"` // ARN of the listener to look up. ListenerArn *string `json:"listenerArn" yaml:"listenerArn"` // Filter listeners by listener protocol. ListenerProtocol ApplicationProtocol `json:"listenerProtocol" yaml:"listenerProtocol"` }
Options for ApplicationListener lookup.
TODO: EXAMPLE
type ApplicationListenerProps ¶
type ApplicationListenerProps struct { // Certificate list of ACM cert ARNs. // // You must provide exactly one certificate if the listener protocol is HTTPS or TLS. Certificates *[]IListenerCertificate `json:"certificates" yaml:"certificates"` // Default action to take for requests to this listener. // // This allows full control of the default action of the load balancer, // including Action chaining, fixed responses and redirect responses. // // See the `ListenerAction` class for all options. // // Cannot be specified together with `defaultTargetGroups`. DefaultAction ListenerAction `json:"defaultAction" yaml:"defaultAction"` // Default target groups to load balance to. // // All target groups will be load balanced to with equal weight and without // stickiness. For a more complex configuration than that, use // either `defaultAction` or `addAction()`. // // Cannot be specified together with `defaultAction`. DefaultTargetGroups *[]IApplicationTargetGroup `json:"defaultTargetGroups" yaml:"defaultTargetGroups"` // Allow anyone to connect to the load balancer on the listener port. // // If this is specified, the load balancer will be opened up to anyone who can reach it. // For internal load balancers this is anyone in the same VPC. For public load // balancers, this is anyone on the internet. // // If you want to be more selective about who can access this load // balancer, set this to `false` and use the listener's `connections` // object to selectively grant access to the load balancer on the listener port. Open *bool `json:"open" yaml:"open"` // The port on which the listener listens for requests. Port *float64 `json:"port" yaml:"port"` // The protocol to use. Protocol ApplicationProtocol `json:"protocol" yaml:"protocol"` // The security policy that defines which ciphers and protocols are supported. SslPolicy SslPolicy `json:"sslPolicy" yaml:"sslPolicy"` // The load balancer to attach this listener to. LoadBalancer IApplicationLoadBalancer `json:"loadBalancer" yaml:"loadBalancer"` }
Properties for defining a standalone ApplicationListener.
TODO: EXAMPLE
type ApplicationListenerRule ¶
type ApplicationListenerRule interface { constructs.Construct ListenerRuleArn() *string Node() constructs.Node AddCondition(condition ListenerCondition) ConfigureAction(action ListenerAction) ToString() *string }
Define a new listener rule.
TODO: EXAMPLE
func NewApplicationListenerRule ¶
func NewApplicationListenerRule(scope constructs.Construct, id *string, props *ApplicationListenerRuleProps) ApplicationListenerRule
type ApplicationListenerRuleProps ¶
type ApplicationListenerRuleProps struct { // Priority of the rule. // // The rule with the lowest priority will be used for every request. // // Priorities must be unique. Priority *float64 `json:"priority" yaml:"priority"` // Action to perform when requests are received. // // Only one of `action`, `fixedResponse`, `redirectResponse` or `targetGroups` can be specified. Action ListenerAction `json:"action" yaml:"action"` // Rule applies if matches the conditions. // See: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html // Conditions *[]ListenerCondition `json:"conditions" yaml:"conditions"` // Target groups to forward requests to. // // Only one of `action`, `fixedResponse`, `redirectResponse` or `targetGroups` can be specified. // // Implies a `forward` action. TargetGroups *[]IApplicationTargetGroup `json:"targetGroups" yaml:"targetGroups"` // The listener to attach the rule to. Listener IApplicationListener `json:"listener" yaml:"listener"` }
Properties for defining a listener rule.
TODO: EXAMPLE
type ApplicationLoadBalancer ¶
type ApplicationLoadBalancer interface { BaseLoadBalancer IApplicationLoadBalancer Connections() awsec2.Connections Env() *awscdk.ResourceEnvironment IpAddressType() IpAddressType Listeners() *[]ApplicationListener LoadBalancerArn() *string LoadBalancerCanonicalHostedZoneId() *string LoadBalancerDnsName() *string LoadBalancerFullName() *string LoadBalancerName() *string LoadBalancerSecurityGroups() *[]*string Node() constructs.Node PhysicalName() *string Stack() awscdk.Stack Vpc() awsec2.IVpc AddListener(id *string, props *BaseApplicationListenerProps) ApplicationListener AddRedirect(props *ApplicationLoadBalancerRedirectConfig) ApplicationListener AddSecurityGroup(securityGroup awsec2.ISecurityGroup) ApplyRemovalPolicy(policy awscdk.RemovalPolicy) GeneratePhysicalName() *string GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string GetResourceNameAttribute(nameAttr *string) *string LogAccessLogs(bucket awss3.IBucket, prefix *string) Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricActiveConnectionCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricClientTlsNegotiationErrorCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricConsumedLCUs(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricElbAuthError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricElbAuthFailure(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricElbAuthLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricElbAuthSuccess(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricHttpCodeElb(code HttpCodeElb, props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricHttpCodeTarget(code HttpCodeTarget, props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricHttpFixedResponseCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricHttpRedirectCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricHttpRedirectUrlLimitExceededCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricIpv6ProcessedBytes(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricIpv6RequestCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricNewConnectionCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricProcessedBytes(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricRejectedConnectionCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricRequestCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricRuleEvaluations(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricTargetConnectionErrorCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricTargetResponseTime(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricTargetTLSNegotiationErrorCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric RemoveAttribute(key *string) SetAttribute(key *string, value *string) ToString() *string }
Define an Application Load Balancer.
TODO: EXAMPLE
func NewApplicationLoadBalancer ¶
func NewApplicationLoadBalancer(scope constructs.Construct, id *string, props *ApplicationLoadBalancerProps) ApplicationLoadBalancer
type ApplicationLoadBalancerAttributes ¶
type ApplicationLoadBalancerAttributes struct { // ARN of the load balancer. LoadBalancerArn *string `json:"loadBalancerArn" yaml:"loadBalancerArn"` // ID of the load balancer's security group. SecurityGroupId *string `json:"securityGroupId" yaml:"securityGroupId"` // The canonical hosted zone ID of this load balancer. LoadBalancerCanonicalHostedZoneId *string `json:"loadBalancerCanonicalHostedZoneId" yaml:"loadBalancerCanonicalHostedZoneId"` // The DNS name of this load balancer. LoadBalancerDnsName *string `json:"loadBalancerDnsName" yaml:"loadBalancerDnsName"` // Whether the security group allows all outbound traffic or not. // // Unless set to `false`, no egress rules will be added to the security group. SecurityGroupAllowsAllOutbound *bool `json:"securityGroupAllowsAllOutbound" yaml:"securityGroupAllowsAllOutbound"` // The VPC this load balancer has been created in, if available. Vpc awsec2.IVpc `json:"vpc" yaml:"vpc"` }
Properties to reference an existing load balancer.
TODO: EXAMPLE
type ApplicationLoadBalancerLookupOptions ¶
type ApplicationLoadBalancerLookupOptions struct { // Find by load balancer's ARN. LoadBalancerArn *string `json:"loadBalancerArn" yaml:"loadBalancerArn"` // Match load balancer tags. LoadBalancerTags *map[string]*string `json:"loadBalancerTags" yaml:"loadBalancerTags"` }
Options for looking up an ApplicationLoadBalancer.
TODO: EXAMPLE
type ApplicationLoadBalancerProps ¶
type ApplicationLoadBalancerProps struct { // The VPC network to place the load balancer in. Vpc awsec2.IVpc `json:"vpc" yaml:"vpc"` // Indicates whether deletion protection is enabled. DeletionProtection *bool `json:"deletionProtection" yaml:"deletionProtection"` // Whether the load balancer has an internet-routable address. InternetFacing *bool `json:"internetFacing" yaml:"internetFacing"` // Name of the load balancer. LoadBalancerName *string `json:"loadBalancerName" yaml:"loadBalancerName"` // Which subnets place the load balancer in. VpcSubnets *awsec2.SubnetSelection `json:"vpcSubnets" yaml:"vpcSubnets"` // Indicates whether HTTP/2 is enabled. Http2Enabled *bool `json:"http2Enabled" yaml:"http2Enabled"` // The load balancer idle timeout, in seconds. IdleTimeout awscdk.Duration `json:"idleTimeout" yaml:"idleTimeout"` // The type of IP addresses to use. // // Only applies to application load balancers. IpAddressType IpAddressType `json:"ipAddressType" yaml:"ipAddressType"` // Security group to associate with this load balancer. SecurityGroup awsec2.ISecurityGroup `json:"securityGroup" yaml:"securityGroup"` }
Properties for defining an Application Load Balancer.
TODO: EXAMPLE
type ApplicationLoadBalancerRedirectConfig ¶
type ApplicationLoadBalancerRedirectConfig struct { // Allow anyone to connect to this listener. // // If this is specified, the listener will be opened up to anyone who can reach it. // For internal load balancers this is anyone in the same VPC. For public load // balancers, this is anyone on the internet. // // If you want to be more selective about who can access this load // balancer, set this to `false` and use the listener's `connections` // object to selectively grant access to the listener. Open *bool `json:"open" yaml:"open"` // The port number to listen to. SourcePort *float64 `json:"sourcePort" yaml:"sourcePort"` // The protocol of the listener being created. SourceProtocol ApplicationProtocol `json:"sourceProtocol" yaml:"sourceProtocol"` // The port number to redirect to. TargetPort *float64 `json:"targetPort" yaml:"targetPort"` // The protocol of the redirection target. TargetProtocol ApplicationProtocol `json:"targetProtocol" yaml:"targetProtocol"` }
Properties for a redirection config.
TODO: EXAMPLE
type ApplicationProtocol ¶
type ApplicationProtocol string
Load balancing protocol for application load balancers.
TODO: EXAMPLE
const ( ApplicationProtocol_HTTP ApplicationProtocol = "HTTP" ApplicationProtocol_HTTPS ApplicationProtocol = "HTTPS" )
type ApplicationProtocolVersion ¶
type ApplicationProtocolVersion string
Load balancing protocol version for application load balancers.
TODO: EXAMPLE
const ( ApplicationProtocolVersion_GRPC ApplicationProtocolVersion = "GRPC" ApplicationProtocolVersion_HTTP1 ApplicationProtocolVersion = "HTTP1" ApplicationProtocolVersion_HTTP2 ApplicationProtocolVersion = "HTTP2" )
type ApplicationTargetGroup ¶
type ApplicationTargetGroup interface { TargetGroupBase IApplicationTargetGroup DefaultPort() *float64 FirstLoadBalancerFullName() *string HealthCheck() *HealthCheck SetHealthCheck(val *HealthCheck) LoadBalancerArns() *string LoadBalancerAttached() constructs.IDependable LoadBalancerAttachedDependencies() constructs.DependencyGroup Node() constructs.Node TargetGroupArn() *string TargetGroupFullName() *string TargetGroupLoadBalancerArns() *[]*string TargetGroupName() *string TargetType() TargetType SetTargetType(val TargetType) AddLoadBalancerTarget(props *LoadBalancerTargetProps) AddTarget(targets ...IApplicationLoadBalancerTarget) ConfigureHealthCheck(healthCheck *HealthCheck) EnableCookieStickiness(duration awscdk.Duration, cookieName *string) Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricHealthyHostCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricHttpCodeTarget(code HttpCodeTarget, props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricIpv6RequestCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricRequestCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricRequestCountPerTarget(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricTargetConnectionErrorCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricTargetResponseTime(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricTargetTLSNegotiationErrorCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricUnhealthyHostCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric RegisterConnectable(connectable awsec2.IConnectable, portRange awsec2.Port) RegisterListener(listener IApplicationListener, associatingConstruct constructs.IConstruct) SetAttribute(key *string, value *string) ToString() *string ValidateTargetGroup() *[]*string }
Define an Application Target Group.
TODO: EXAMPLE
func NewApplicationTargetGroup ¶
func NewApplicationTargetGroup(scope constructs.Construct, id *string, props *ApplicationTargetGroupProps) ApplicationTargetGroup
type ApplicationTargetGroupProps ¶
type ApplicationTargetGroupProps struct { // The amount of time for Elastic Load Balancing to wait before deregistering a target. // // The range is 0-3600 seconds. DeregistrationDelay awscdk.Duration `json:"deregistrationDelay" yaml:"deregistrationDelay"` // Health check configuration. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#aws-resource-elasticloadbalancingv2-targetgroup-properties // HealthCheck *HealthCheck `json:"healthCheck" yaml:"healthCheck"` // The name of the target group. // // This name must be unique per region per account, can have a maximum of // 32 characters, must contain only alphanumeric characters or hyphens, and // must not begin or end with a hyphen. TargetGroupName *string `json:"targetGroupName" yaml:"targetGroupName"` // The type of targets registered to this TargetGroup, either IP or Instance. // // All targets registered into the group must be of this type. If you // register targets to the TargetGroup in the CDK app, the TargetType is // determined automatically. TargetType TargetType `json:"targetType" yaml:"targetType"` // The virtual private cloud (VPC). // // only if `TargetType` is `Ip` or `InstanceId` Vpc awsec2.IVpc `json:"vpc" yaml:"vpc"` // The load balancing algorithm to select targets for routing requests. LoadBalancingAlgorithmType TargetGroupLoadBalancingAlgorithmType `json:"loadBalancingAlgorithmType" yaml:"loadBalancingAlgorithmType"` // The port on which the listener listens for requests. Port *float64 `json:"port" yaml:"port"` // The protocol to use. Protocol ApplicationProtocol `json:"protocol" yaml:"protocol"` // The protocol version to use. ProtocolVersion ApplicationProtocolVersion `json:"protocolVersion" yaml:"protocolVersion"` // The time period during which the load balancer sends a newly registered target a linearly increasing share of the traffic to the target group. // // The range is 30-900 seconds (15 minutes). SlowStart awscdk.Duration `json:"slowStart" yaml:"slowStart"` // The stickiness cookie expiration period. // // Setting this value enables load balancer stickiness. // // After this period, the cookie is considered stale. The minimum value is // 1 second and the maximum value is 7 days (604800 seconds). StickinessCookieDuration awscdk.Duration `json:"stickinessCookieDuration" yaml:"stickinessCookieDuration"` // The name of an application-based stickiness cookie. // // Names that start with the following prefixes are not allowed: AWSALB, AWSALBAPP, // and AWSALBTG; they're reserved for use by the load balancer. // // Note: `stickinessCookieName` parameter depends on the presence of `stickinessCookieDuration` parameter. // If `stickinessCookieDuration` is not set, `stickinessCookieName` will be omitted. // See: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/sticky-sessions.html // StickinessCookieName *string `json:"stickinessCookieName" yaml:"stickinessCookieName"` // The targets to add to this target group. // // Can be `Instance`, `IPAddress`, or any self-registering load balancing // target. If you use either `Instance` or `IPAddress` as targets, all // target must be of the same type. Targets *[]IApplicationLoadBalancerTarget `json:"targets" yaml:"targets"` }
Properties for defining an Application Target Group.
TODO: EXAMPLE
type AuthenticateOidcOptions ¶
type AuthenticateOidcOptions struct { // The authorization endpoint of the IdP. // // This must be a full URL, including the HTTPS protocol, the domain, and the path. AuthorizationEndpoint *string `json:"authorizationEndpoint" yaml:"authorizationEndpoint"` // The OAuth 2.0 client identifier. ClientId *string `json:"clientId" yaml:"clientId"` // The OAuth 2.0 client secret. ClientSecret awscdk.SecretValue `json:"clientSecret" yaml:"clientSecret"` // The OIDC issuer identifier of the IdP. // // This must be a full URL, including the HTTPS protocol, the domain, and the path. Issuer *string `json:"issuer" yaml:"issuer"` // What action to execute next. Next ListenerAction `json:"next" yaml:"next"` // The token endpoint of the IdP. // // This must be a full URL, including the HTTPS protocol, the domain, and the path. TokenEndpoint *string `json:"tokenEndpoint" yaml:"tokenEndpoint"` // The user info endpoint of the IdP. // // This must be a full URL, including the HTTPS protocol, the domain, and the path. UserInfoEndpoint *string `json:"userInfoEndpoint" yaml:"userInfoEndpoint"` // The query parameters (up to 10) to include in the redirect request to the authorization endpoint. AuthenticationRequestExtraParams *map[string]*string `json:"authenticationRequestExtraParams" yaml:"authenticationRequestExtraParams"` // The behavior if the user is not authenticated. OnUnauthenticatedRequest UnauthenticatedAction `json:"onUnauthenticatedRequest" yaml:"onUnauthenticatedRequest"` // The set of user claims to be requested from the IdP. // // To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. Scope *string `json:"scope" yaml:"scope"` // The name of the cookie used to maintain session information. SessionCookieName *string `json:"sessionCookieName" yaml:"sessionCookieName"` // The maximum duration of the authentication session. SessionTimeout awscdk.Duration `json:"sessionTimeout" yaml:"sessionTimeout"` }
Options for `ListenerAction.authenciateOidc()`.
TODO: EXAMPLE
type BaseApplicationListenerProps ¶
type BaseApplicationListenerProps struct { // Certificate list of ACM cert ARNs. // // You must provide exactly one certificate if the listener protocol is HTTPS or TLS. Certificates *[]IListenerCertificate `json:"certificates" yaml:"certificates"` // Default action to take for requests to this listener. // // This allows full control of the default action of the load balancer, // including Action chaining, fixed responses and redirect responses. // // See the `ListenerAction` class for all options. // // Cannot be specified together with `defaultTargetGroups`. DefaultAction ListenerAction `json:"defaultAction" yaml:"defaultAction"` // Default target groups to load balance to. // // All target groups will be load balanced to with equal weight and without // stickiness. For a more complex configuration than that, use // either `defaultAction` or `addAction()`. // // Cannot be specified together with `defaultAction`. DefaultTargetGroups *[]IApplicationTargetGroup `json:"defaultTargetGroups" yaml:"defaultTargetGroups"` // Allow anyone to connect to the load balancer on the listener port. // // If this is specified, the load balancer will be opened up to anyone who can reach it. // For internal load balancers this is anyone in the same VPC. For public load // balancers, this is anyone on the internet. // // If you want to be more selective about who can access this load // balancer, set this to `false` and use the listener's `connections` // object to selectively grant access to the load balancer on the listener port. Open *bool `json:"open" yaml:"open"` // The port on which the listener listens for requests. Port *float64 `json:"port" yaml:"port"` // The protocol to use. Protocol ApplicationProtocol `json:"protocol" yaml:"protocol"` // The security policy that defines which ciphers and protocols are supported. SslPolicy SslPolicy `json:"sslPolicy" yaml:"sslPolicy"` }
Basic properties for an ApplicationListener.
TODO: EXAMPLE
type BaseApplicationListenerRuleProps ¶
type BaseApplicationListenerRuleProps struct { // Priority of the rule. // // The rule with the lowest priority will be used for every request. // // Priorities must be unique. Priority *float64 `json:"priority" yaml:"priority"` // Action to perform when requests are received. // // Only one of `action`, `fixedResponse`, `redirectResponse` or `targetGroups` can be specified. Action ListenerAction `json:"action" yaml:"action"` // Rule applies if matches the conditions. // See: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html // Conditions *[]ListenerCondition `json:"conditions" yaml:"conditions"` // Target groups to forward requests to. // // Only one of `action`, `fixedResponse`, `redirectResponse` or `targetGroups` can be specified. // // Implies a `forward` action. TargetGroups *[]IApplicationTargetGroup `json:"targetGroups" yaml:"targetGroups"` }
Basic properties for defining a rule on a listener.
TODO: EXAMPLE
type BaseListener ¶
type BaseListener interface { awscdk.Resource Env() *awscdk.ResourceEnvironment ListenerArn() *string Node() constructs.Node PhysicalName() *string Stack() awscdk.Stack ApplyRemovalPolicy(policy awscdk.RemovalPolicy) GeneratePhysicalName() *string GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string GetResourceNameAttribute(nameAttr *string) *string ToString() *string ValidateListener() *[]*string }
Base class for listeners.
type BaseListenerLookupOptions ¶
type BaseListenerLookupOptions struct { // Filter listeners by listener port. ListenerPort *float64 `json:"listenerPort" yaml:"listenerPort"` // Filter listeners by associated load balancer arn. LoadBalancerArn *string `json:"loadBalancerArn" yaml:"loadBalancerArn"` // Filter listeners by associated load balancer tags. LoadBalancerTags *map[string]*string `json:"loadBalancerTags" yaml:"loadBalancerTags"` }
Options for listener lookup.
TODO: EXAMPLE
type BaseLoadBalancer ¶
type BaseLoadBalancer interface { awscdk.Resource Env() *awscdk.ResourceEnvironment LoadBalancerArn() *string LoadBalancerCanonicalHostedZoneId() *string LoadBalancerDnsName() *string LoadBalancerFullName() *string LoadBalancerName() *string LoadBalancerSecurityGroups() *[]*string Node() constructs.Node PhysicalName() *string Stack() awscdk.Stack Vpc() awsec2.IVpc ApplyRemovalPolicy(policy awscdk.RemovalPolicy) GeneratePhysicalName() *string GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string GetResourceNameAttribute(nameAttr *string) *string LogAccessLogs(bucket awss3.IBucket, prefix *string) RemoveAttribute(key *string) SetAttribute(key *string, value *string) ToString() *string }
Base class for both Application and Network Load Balancers.
type BaseLoadBalancerLookupOptions ¶
type BaseLoadBalancerLookupOptions struct { // Find by load balancer's ARN. LoadBalancerArn *string `json:"loadBalancerArn" yaml:"loadBalancerArn"` // Match load balancer tags. LoadBalancerTags *map[string]*string `json:"loadBalancerTags" yaml:"loadBalancerTags"` }
Options for looking up load balancers.
TODO: EXAMPLE
type BaseLoadBalancerProps ¶
type BaseLoadBalancerProps struct { // The VPC network to place the load balancer in. Vpc awsec2.IVpc `json:"vpc" yaml:"vpc"` // Indicates whether deletion protection is enabled. DeletionProtection *bool `json:"deletionProtection" yaml:"deletionProtection"` // Whether the load balancer has an internet-routable address. InternetFacing *bool `json:"internetFacing" yaml:"internetFacing"` // Name of the load balancer. LoadBalancerName *string `json:"loadBalancerName" yaml:"loadBalancerName"` // Which subnets place the load balancer in. VpcSubnets *awsec2.SubnetSelection `json:"vpcSubnets" yaml:"vpcSubnets"` }
Shared properties of both Application and Network Load Balancers.
TODO: EXAMPLE
type BaseNetworkListenerProps ¶
type BaseNetworkListenerProps struct { // The port on which the listener listens for requests. Port *float64 `json:"port" yaml:"port"` // Application-Layer Protocol Negotiation (ALPN) is a TLS extension that is sent on the initial TLS handshake hello messages. // // ALPN enables the application layer to negotiate which protocols should be used over a secure connection, such as HTTP/1 and HTTP/2. // // Can only be specified together with Protocol TLS. AlpnPolicy AlpnPolicy `json:"alpnPolicy" yaml:"alpnPolicy"` // Certificate list of ACM cert ARNs. // // You must provide exactly one certificate if the listener protocol is HTTPS or TLS. Certificates *[]IListenerCertificate `json:"certificates" yaml:"certificates"` // Default action to take for requests to this listener. // // This allows full control of the default Action of the load balancer, // including weighted forwarding. See the `NetworkListenerAction` class for // all options. // // Cannot be specified together with `defaultTargetGroups`. DefaultAction NetworkListenerAction `json:"defaultAction" yaml:"defaultAction"` // Default target groups to load balance to. // // All target groups will be load balanced to with equal weight and without // stickiness. For a more complex configuration than that, use // either `defaultAction` or `addAction()`. // // Cannot be specified together with `defaultAction`. DefaultTargetGroups *[]INetworkTargetGroup `json:"defaultTargetGroups" yaml:"defaultTargetGroups"` // Protocol for listener, expects TCP, TLS, UDP, or TCP_UDP. Protocol Protocol `json:"protocol" yaml:"protocol"` // SSL Policy. SslPolicy SslPolicy `json:"sslPolicy" yaml:"sslPolicy"` }
Basic properties for a Network Listener.
TODO: EXAMPLE
type BaseTargetGroupProps ¶
type BaseTargetGroupProps struct { // The amount of time for Elastic Load Balancing to wait before deregistering a target. // // The range is 0-3600 seconds. DeregistrationDelay awscdk.Duration `json:"deregistrationDelay" yaml:"deregistrationDelay"` // Health check configuration. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#aws-resource-elasticloadbalancingv2-targetgroup-properties // HealthCheck *HealthCheck `json:"healthCheck" yaml:"healthCheck"` // The name of the target group. // // This name must be unique per region per account, can have a maximum of // 32 characters, must contain only alphanumeric characters or hyphens, and // must not begin or end with a hyphen. TargetGroupName *string `json:"targetGroupName" yaml:"targetGroupName"` // The type of targets registered to this TargetGroup, either IP or Instance. // // All targets registered into the group must be of this type. If you // register targets to the TargetGroup in the CDK app, the TargetType is // determined automatically. TargetType TargetType `json:"targetType" yaml:"targetType"` // The virtual private cloud (VPC). // // only if `TargetType` is `Ip` or `InstanceId` Vpc awsec2.IVpc `json:"vpc" yaml:"vpc"` }
Basic properties of both Application and Network Target Groups.
TODO: EXAMPLE
type CfnListener ¶
type CfnListener interface { awscdk.CfnResource awscdk.IInspectable AlpnPolicy() *[]*string SetAlpnPolicy(val *[]*string) AttrListenerArn() *string Certificates() interface{} SetCertificates(val interface{}) CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string DefaultActions() interface{} SetDefaultActions(val interface{}) LoadBalancerArn() *string SetLoadBalancerArn(val *string) LogicalId() *string Node() constructs.Node Port() *float64 SetPort(val *float64) Protocol() *string SetProtocol(val *string) Ref() *string SslPolicy() *string SetSslPolicy(val *string) Stack() awscdk.Stack UpdatedProperites() *map[string]interface{} AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::ElasticLoadBalancingV2::Listener`.
Specifies a listener for an Application Load Balancer or Network Load Balancer.
TODO: EXAMPLE
func NewCfnListener ¶
func NewCfnListener(scope constructs.Construct, id *string, props *CfnListenerProps) CfnListener
Create a new `AWS::ElasticLoadBalancingV2::Listener`.
type CfnListenerCertificate ¶
type CfnListenerCertificate interface { awscdk.CfnResource awscdk.IInspectable Certificates() interface{} SetCertificates(val interface{}) CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string ListenerArn() *string SetListenerArn(val *string) LogicalId() *string Node() constructs.Node Ref() *string Stack() awscdk.Stack UpdatedProperites() *map[string]interface{} AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::ElasticLoadBalancingV2::ListenerCertificate`.
Specifies an SSL server certificate to add to the certificate list for an HTTPS or TLS listener.
TODO: EXAMPLE
func NewCfnListenerCertificate ¶
func NewCfnListenerCertificate(scope constructs.Construct, id *string, props *CfnListenerCertificateProps) CfnListenerCertificate
Create a new `AWS::ElasticLoadBalancingV2::ListenerCertificate`.
type CfnListenerCertificateProps ¶
type CfnListenerCertificateProps struct { // The certificate. // // You can specify one certificate per resource. Certificates interface{} `json:"certificates" yaml:"certificates"` // The Amazon Resource Name (ARN) of the listener. ListenerArn *string `json:"listenerArn" yaml:"listenerArn"` }
Properties for defining a `CfnListenerCertificate`.
TODO: EXAMPLE
type CfnListenerCertificate_CertificateProperty ¶
type CfnListenerCertificate_CertificateProperty struct { // The Amazon Resource Name (ARN) of the certificate. CertificateArn *string `json:"certificateArn" yaml:"certificateArn"` }
Specifies an SSL server certificate for the certificate list of a secure listener.
TODO: EXAMPLE
type CfnListenerProps ¶
type CfnListenerProps struct { // The actions for the default rule. You cannot define a condition for a default rule. // // To create additional rules for an Application Load Balancer, use [AWS::ElasticLoadBalancingV2::ListenerRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html) . DefaultActions interface{} `json:"defaultActions" yaml:"defaultActions"` // The Amazon Resource Name (ARN) of the load balancer. LoadBalancerArn *string `json:"loadBalancerArn" yaml:"loadBalancerArn"` // [TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy. AlpnPolicy *[]*string `json:"alpnPolicy" yaml:"alpnPolicy"` // The default SSL server certificate for a secure listener. // // You must provide exactly one certificate if the listener protocol is HTTPS or TLS. // // To create a certificate list for a secure listener, use [AWS::ElasticLoadBalancingV2::ListenerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html) . Certificates interface{} `json:"certificates" yaml:"certificates"` // The port on which the load balancer is listening. // // You cannot specify a port for a Gateway Load Balancer. Port *float64 `json:"port" yaml:"port"` // The protocol for connections from clients to the load balancer. // // For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer. Protocol *string `json:"protocol" yaml:"protocol"` // [HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. // // For more information, see [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) in the *Application Load Balancers Guide* and [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) in the *Network Load Balancers Guide* . SslPolicy *string `json:"sslPolicy" yaml:"sslPolicy"` }
Properties for defining a `CfnListener`.
TODO: EXAMPLE
type CfnListenerRule ¶
type CfnListenerRule interface { awscdk.CfnResource awscdk.IInspectable Actions() interface{} SetActions(val interface{}) AttrIsDefault() awscdk.IResolvable AttrRuleArn() *string CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string Conditions() interface{} SetConditions(val interface{}) CreationStack() *[]*string ListenerArn() *string SetListenerArn(val *string) LogicalId() *string Node() constructs.Node Priority() *float64 SetPriority(val *float64) Ref() *string Stack() awscdk.Stack UpdatedProperites() *map[string]interface{} AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::ElasticLoadBalancingV2::ListenerRule`.
Specifies a listener rule. The listener must be associated with an Application Load Balancer. Each rule consists of a priority, one or more actions, and one or more conditions.
TODO: EXAMPLE
func NewCfnListenerRule ¶
func NewCfnListenerRule(scope constructs.Construct, id *string, props *CfnListenerRuleProps) CfnListenerRule
Create a new `AWS::ElasticLoadBalancingV2::ListenerRule`.
type CfnListenerRuleProps ¶
type CfnListenerRuleProps struct { // The actions. // // The rule must include exactly one of the following types of actions: `forward` , `fixed-response` , or `redirect` , and it must be the last action to be performed. If the rule is for an HTTPS listener, it can also optionally include an authentication action. Actions interface{} `json:"actions" yaml:"actions"` // The conditions. // // The rule can optionally include up to one of each of the following conditions: `http-request-method` , `host-header` , `path-pattern` , and `source-ip` . A rule can also optionally include one or more of each of the following conditions: `http-header` and `query-string` . Conditions interface{} `json:"conditions" yaml:"conditions"` // The Amazon Resource Name (ARN) of the listener. ListenerArn *string `json:"listenerArn" yaml:"listenerArn"` // The rule priority. A listener can't have multiple rules with the same priority. // // If you try to reorder rules by updating their priorities, do not specify a new priority if an existing rule already uses this priority, as this can cause an error. If you need to reuse a priority with a different rule, you must remove it as a priority first, and then specify it in a subsequent update. Priority *float64 `json:"priority" yaml:"priority"` }
Properties for defining a `CfnListenerRule`.
TODO: EXAMPLE
type CfnListenerRule_ActionProperty ¶
type CfnListenerRule_ActionProperty struct { // The type of action. Type *string `json:"type" yaml:"type"` // [HTTPS listeners] Information for using Amazon Cognito to authenticate users. // // Specify only when `Type` is `authenticate-cognito` . AuthenticateCognitoConfig interface{} `json:"authenticateCognitoConfig" yaml:"authenticateCognitoConfig"` // [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). // // Specify only when `Type` is `authenticate-oidc` . AuthenticateOidcConfig interface{} `json:"authenticateOidcConfig" yaml:"authenticateOidcConfig"` // [Application Load Balancer] Information for creating an action that returns a custom HTTP response. // // Specify only when `Type` is `fixed-response` . FixedResponseConfig interface{} `json:"fixedResponseConfig" yaml:"fixedResponseConfig"` // Information for creating an action that distributes requests among one or more target groups. // // For Network Load Balancers, you can specify a single target group. Specify only when `Type` is `forward` . If you specify both `ForwardConfig` and `TargetGroupArn` , you can specify only one target group using `ForwardConfig` and it must be the same target group specified in `TargetGroupArn` . ForwardConfig interface{} `json:"forwardConfig" yaml:"forwardConfig"` // The order for the action. // // This value is required for rules with multiple actions. The action with the lowest value for order is performed first. Order *float64 `json:"order" yaml:"order"` // [Application Load Balancer] Information for creating a redirect action. // // Specify only when `Type` is `redirect` . RedirectConfig interface{} `json:"redirectConfig" yaml:"redirectConfig"` // The Amazon Resource Name (ARN) of the target group. // // Specify only when `Type` is `forward` and you want to route to a single target group. To route to one or more target groups, use `ForwardConfig` instead. TargetGroupArn *string `json:"targetGroupArn" yaml:"targetGroupArn"` }
Specifies an action for a listener rule.
TODO: EXAMPLE
type CfnListenerRule_AuthenticateCognitoConfigProperty ¶
type CfnListenerRule_AuthenticateCognitoConfigProperty struct { // The Amazon Resource Name (ARN) of the Amazon Cognito user pool. UserPoolArn *string `json:"userPoolArn" yaml:"userPoolArn"` // The ID of the Amazon Cognito user pool client. UserPoolClientId *string `json:"userPoolClientId" yaml:"userPoolClientId"` // The domain prefix or fully-qualified domain name of the Amazon Cognito user pool. UserPoolDomain *string `json:"userPoolDomain" yaml:"userPoolDomain"` // The query parameters (up to 10) to include in the redirect request to the authorization endpoint. AuthenticationRequestExtraParams interface{} `json:"authenticationRequestExtraParams" yaml:"authenticationRequestExtraParams"` // The behavior if the user is not authenticated. The following are possible values:. // // - deny “ - Return an HTTP 401 Unauthorized error. // - allow “ - Allow the request to be forwarded to the target. // - authenticate “ - Redirect the request to the IdP authorization endpoint. This is the default value. OnUnauthenticatedRequest *string `json:"onUnauthenticatedRequest" yaml:"onUnauthenticatedRequest"` // The set of user claims to be requested from the IdP. The default is `openid` . // // To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. Scope *string `json:"scope" yaml:"scope"` // The name of the cookie used to maintain session information. // // The default is AWSELBAuthSessionCookie. SessionCookieName *string `json:"sessionCookieName" yaml:"sessionCookieName"` // The maximum duration of the authentication session, in seconds. // // The default is 604800 seconds (7 days). SessionTimeout *float64 `json:"sessionTimeout" yaml:"sessionTimeout"` }
Specifies information required when integrating with Amazon Cognito to authenticate users.
TODO: EXAMPLE
type CfnListenerRule_AuthenticateOidcConfigProperty ¶
type CfnListenerRule_AuthenticateOidcConfigProperty struct { // The authorization endpoint of the IdP. // // This must be a full URL, including the HTTPS protocol, the domain, and the path. AuthorizationEndpoint *string `json:"authorizationEndpoint" yaml:"authorizationEndpoint"` // The OAuth 2.0 client identifier. ClientId *string `json:"clientId" yaml:"clientId"` // The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set `UseExistingClientSecret` to true. ClientSecret *string `json:"clientSecret" yaml:"clientSecret"` // The OIDC issuer identifier of the IdP. // // This must be a full URL, including the HTTPS protocol, the domain, and the path. Issuer *string `json:"issuer" yaml:"issuer"` // The token endpoint of the IdP. // // This must be a full URL, including the HTTPS protocol, the domain, and the path. TokenEndpoint *string `json:"tokenEndpoint" yaml:"tokenEndpoint"` // The user info endpoint of the IdP. // // This must be a full URL, including the HTTPS protocol, the domain, and the path. UserInfoEndpoint *string `json:"userInfoEndpoint" yaml:"userInfoEndpoint"` // The query parameters (up to 10) to include in the redirect request to the authorization endpoint. AuthenticationRequestExtraParams interface{} `json:"authenticationRequestExtraParams" yaml:"authenticationRequestExtraParams"` // The behavior if the user is not authenticated. The following are possible values:. // // - deny “ - Return an HTTP 401 Unauthorized error. // - allow “ - Allow the request to be forwarded to the target. // - authenticate “ - Redirect the request to the IdP authorization endpoint. This is the default value. OnUnauthenticatedRequest *string `json:"onUnauthenticatedRequest" yaml:"onUnauthenticatedRequest"` // The set of user claims to be requested from the IdP. The default is `openid` . // // To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. Scope *string `json:"scope" yaml:"scope"` // The name of the cookie used to maintain session information. // // The default is AWSELBAuthSessionCookie. SessionCookieName *string `json:"sessionCookieName" yaml:"sessionCookieName"` // The maximum duration of the authentication session, in seconds. // // The default is 604800 seconds (7 days). SessionTimeout *float64 `json:"sessionTimeout" yaml:"sessionTimeout"` // Indicates whether to use the existing client secret when modifying a rule. // // If you are creating a rule, you can omit this parameter or set it to false. UseExistingClientSecret interface{} `json:"useExistingClientSecret" yaml:"useExistingClientSecret"` }
Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.
TODO: EXAMPLE
type CfnListenerRule_FixedResponseConfigProperty ¶
type CfnListenerRule_FixedResponseConfigProperty struct { // The HTTP response code (2XX, 4XX, or 5XX). StatusCode *string `json:"statusCode" yaml:"statusCode"` // The content type. // // Valid Values: text/plain | text/css | text/html | application/javascript | application/json ContentType *string `json:"contentType" yaml:"contentType"` // The message. MessageBody *string `json:"messageBody" yaml:"messageBody"` }
Specifies information required when returning a custom HTTP response.
TODO: EXAMPLE
type CfnListenerRule_ForwardConfigProperty ¶
type CfnListenerRule_ForwardConfigProperty struct { // Information about how traffic will be distributed between multiple target groups in a forward rule. TargetGroups interface{} `json:"targetGroups" yaml:"targetGroups"` // Information about the target group stickiness for a rule. TargetGroupStickinessConfig interface{} `json:"targetGroupStickinessConfig" yaml:"targetGroupStickinessConfig"` }
Information for creating an action that distributes requests among one or more target groups.
For Network Load Balancers, you can specify a single target group. Specify only when `Type` is `forward` . If you specify both `ForwardConfig` and `TargetGroupArn` , you can specify only one target group using `ForwardConfig` and it must be the same target group specified in `TargetGroupArn` .
TODO: EXAMPLE
type CfnListenerRule_HostHeaderConfigProperty ¶
type CfnListenerRule_HostHeaderConfigProperty struct { // One or more host names. // // The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). // // If you specify multiple strings, the condition is satisfied if one of the strings matches the host name. Values *[]*string `json:"values" yaml:"values"` }
Information about a host header condition.
TODO: EXAMPLE
type CfnListenerRule_HttpHeaderConfigProperty ¶
type CfnListenerRule_HttpHeaderConfigProperty struct { // The name of the HTTP header field. // // The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported. HttpHeaderName *string `json:"httpHeaderName" yaml:"httpHeaderName"` // One or more strings to compare against the value of the HTTP header. // // The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). // // If the same header appears multiple times in the request, we search them in order until a match is found. // // If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string. Values *[]*string `json:"values" yaml:"values"` }
Information about an HTTP header condition.
There is a set of standard HTTP header fields. You can also define custom HTTP header fields.
TODO: EXAMPLE
type CfnListenerRule_HttpRequestMethodConfigProperty ¶
type CfnListenerRule_HttpRequestMethodConfigProperty struct { // The name of the request method. // // The maximum size is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match. // // If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached. Values *[]*string `json:"values" yaml:"values"` }
Information about an HTTP method condition.
HTTP defines a set of request methods, also referred to as HTTP verbs. For more information, see the [HTTP Method Registry](https://docs.aws.amazon.com/https://www.iana.org/assignments/http-methods/http-methods.xhtml) . You can also define custom HTTP methods.
TODO: EXAMPLE
type CfnListenerRule_PathPatternConfigProperty ¶
type CfnListenerRule_PathPatternConfigProperty struct { // One or more path patterns to compare against the request URL. // // The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). // // If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string. Values *[]*string `json:"values" yaml:"values"` }
Information about a path pattern condition.
TODO: EXAMPLE
type CfnListenerRule_QueryStringConfigProperty ¶
type CfnListenerRule_QueryStringConfigProperty struct { // One or more key/value pairs or values to find in the query string. // // The maximum size of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a query string, you must escape these characters in `Values` using a '\' character. // // If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string. Values interface{} `json:"values" yaml:"values"` }
Information about a query string condition.
The query string component of a URI starts after the first '?' character and is terminated by either a '#' character or the end of the URI. A typical query string contains key/value pairs separated by '&' characters. The allowed characters are specified by RFC 3986. Any character can be percentage encoded.
TODO: EXAMPLE
type CfnListenerRule_QueryStringKeyValueProperty ¶
type CfnListenerRule_QueryStringKeyValueProperty struct { // The key. // // You can omit the key. Key *string `json:"key" yaml:"key"` // The value. Value *string `json:"value" yaml:"value"` }
Information about a key/value pair.
TODO: EXAMPLE
type CfnListenerRule_RedirectConfigProperty ¶
type CfnListenerRule_RedirectConfigProperty struct { // The HTTP redirect code. // // The redirect is either permanent (HTTP 301) or temporary (HTTP 302). StatusCode *string `json:"statusCode" yaml:"statusCode"` // The hostname. // // This component is not percent-encoded. The hostname can contain #{host}. Host *string `json:"host" yaml:"host"` // The absolute path, starting with the leading "/". // // This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}. Path *string `json:"path" yaml:"path"` // The port. // // You can specify a value from 1 to 65535 or #{port}. Port *string `json:"port" yaml:"port"` // The protocol. // // You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP. Protocol *string `json:"protocol" yaml:"protocol"` // The query parameters, URL-encoded when necessary, but not percent-encoded. // // Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords. Query *string `json:"query" yaml:"query"` }
Information about a redirect action.
A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values.
You can reuse URI components using the following reserved keywords:
- #{protocol} - #{host} - #{port} - #{path} (the leading "/" is removed) - #{query}
For example, you can change the path to "/new/#{path}", the hostname to "example.#{host}", or the query to "#{query}&value=xyz".
TODO: EXAMPLE
type CfnListenerRule_RuleConditionProperty ¶
type CfnListenerRule_RuleConditionProperty struct { // The field in the HTTP request. The following are the possible values:. // // - `http-header` // - `http-request-method` // - `host-header` // - `path-pattern` // - `query-string` // - `source-ip` Field *string `json:"field" yaml:"field"` // Information for a host header condition. // // Specify only when `Field` is `host-header` . HostHeaderConfig interface{} `json:"hostHeaderConfig" yaml:"hostHeaderConfig"` // Information for an HTTP header condition. // // Specify only when `Field` is `http-header` . HttpHeaderConfig interface{} `json:"httpHeaderConfig" yaml:"httpHeaderConfig"` // Information for an HTTP method condition. // // Specify only when `Field` is `http-request-method` . HttpRequestMethodConfig interface{} `json:"httpRequestMethodConfig" yaml:"httpRequestMethodConfig"` // Information for a path pattern condition. // // Specify only when `Field` is `path-pattern` . PathPatternConfig interface{} `json:"pathPatternConfig" yaml:"pathPatternConfig"` // Information for a query string condition. // // Specify only when `Field` is `query-string` . QueryStringConfig interface{} `json:"queryStringConfig" yaml:"queryStringConfig"` // Information for a source IP condition. // // Specify only when `Field` is `source-ip` . SourceIpConfig interface{} `json:"sourceIpConfig" yaml:"sourceIpConfig"` // The condition value. // // Specify only when `Field` is `host-header` or `path-pattern` . Alternatively, to specify multiple host names or multiple path patterns, use `HostHeaderConfig` or `PathPatternConfig` . // // If `Field` is `host-header` and you're not using `HostHeaderConfig` , you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. // // - A-Z, a-z, 0-9 // - - . // - * (matches 0 or more characters) // - ? (matches exactly 1 character) // // If `Field` is `path-pattern` and you're not using `PathPatternConfig` , you can specify a single path pattern (for example, /img/*). A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters. // // - A-Z, a-z, 0-9 // - _ - . $ / ~ " ' @ : + // - & (using &) // - * (matches 0 or more characters) // - ? (matches exactly 1 character) Values *[]*string `json:"values" yaml:"values"` }
Specifies a condition for a listener rule.
TODO: EXAMPLE
type CfnListenerRule_SourceIpConfigProperty ¶
type CfnListenerRule_SourceIpConfigProperty struct { // One or more source IP addresses, in CIDR format. // // You can use both IPv4 and IPv6 addresses. Wildcards are not supported. // // If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. Values *[]*string `json:"values" yaml:"values"` }
Information about a source IP condition.
You can use this condition to route based on the IP address of the source that connects to the load balancer. If a client is behind a proxy, this is the IP address of the proxy not the IP address of the client.
TODO: EXAMPLE
type CfnListenerRule_TargetGroupStickinessConfigProperty ¶
type CfnListenerRule_TargetGroupStickinessConfigProperty struct { // The time period, in seconds, during which requests from a client should be routed to the same target group. // // The range is 1-604800 seconds (7 days). DurationSeconds *float64 `json:"durationSeconds" yaml:"durationSeconds"` // Indicates whether target group stickiness is enabled. Enabled interface{} `json:"enabled" yaml:"enabled"` }
Information about the target group stickiness for a rule.
TODO: EXAMPLE
type CfnListenerRule_TargetGroupTupleProperty ¶
type CfnListenerRule_TargetGroupTupleProperty struct { // The Amazon Resource Name (ARN) of the target group. TargetGroupArn *string `json:"targetGroupArn" yaml:"targetGroupArn"` // The weight. // // The range is 0 to 999. Weight *float64 `json:"weight" yaml:"weight"` }
Information about how traffic will be distributed between multiple target groups in a forward rule.
TODO: EXAMPLE
type CfnListener_ActionProperty ¶
type CfnListener_ActionProperty struct { // The type of action. Type *string `json:"type" yaml:"type"` // [HTTPS listeners] Information for using Amazon Cognito to authenticate users. // // Specify only when `Type` is `authenticate-cognito` . AuthenticateCognitoConfig interface{} `json:"authenticateCognitoConfig" yaml:"authenticateCognitoConfig"` // [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). // // Specify only when `Type` is `authenticate-oidc` . AuthenticateOidcConfig interface{} `json:"authenticateOidcConfig" yaml:"authenticateOidcConfig"` // [Application Load Balancer] Information for creating an action that returns a custom HTTP response. // // Specify only when `Type` is `fixed-response` . FixedResponseConfig interface{} `json:"fixedResponseConfig" yaml:"fixedResponseConfig"` // Information for creating an action that distributes requests among one or more target groups. // // For Network Load Balancers, you can specify a single target group. Specify only when `Type` is `forward` . If you specify both `ForwardConfig` and `TargetGroupArn` , you can specify only one target group using `ForwardConfig` and it must be the same target group specified in `TargetGroupArn` . ForwardConfig interface{} `json:"forwardConfig" yaml:"forwardConfig"` // The order for the action. // // This value is required for rules with multiple actions. The action with the lowest value for order is performed first. Order *float64 `json:"order" yaml:"order"` // [Application Load Balancer] Information for creating a redirect action. // // Specify only when `Type` is `redirect` . RedirectConfig interface{} `json:"redirectConfig" yaml:"redirectConfig"` // The Amazon Resource Name (ARN) of the target group. // // Specify only when `Type` is `forward` and you want to route to a single target group. To route to one or more target groups, use `ForwardConfig` instead. TargetGroupArn *string `json:"targetGroupArn" yaml:"targetGroupArn"` }
Specifies an action for a listener rule.
TODO: EXAMPLE
type CfnListener_AuthenticateCognitoConfigProperty ¶
type CfnListener_AuthenticateCognitoConfigProperty struct { // The Amazon Resource Name (ARN) of the Amazon Cognito user pool. UserPoolArn *string `json:"userPoolArn" yaml:"userPoolArn"` // The ID of the Amazon Cognito user pool client. UserPoolClientId *string `json:"userPoolClientId" yaml:"userPoolClientId"` // The domain prefix or fully-qualified domain name of the Amazon Cognito user pool. UserPoolDomain *string `json:"userPoolDomain" yaml:"userPoolDomain"` // The query parameters (up to 10) to include in the redirect request to the authorization endpoint. AuthenticationRequestExtraParams interface{} `json:"authenticationRequestExtraParams" yaml:"authenticationRequestExtraParams"` // The behavior if the user is not authenticated. The following are possible values:. // // - deny “ - Return an HTTP 401 Unauthorized error. // - allow “ - Allow the request to be forwarded to the target. // - authenticate “ - Redirect the request to the IdP authorization endpoint. This is the default value. OnUnauthenticatedRequest *string `json:"onUnauthenticatedRequest" yaml:"onUnauthenticatedRequest"` // The set of user claims to be requested from the IdP. The default is `openid` . // // To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. Scope *string `json:"scope" yaml:"scope"` // The name of the cookie used to maintain session information. // // The default is AWSELBAuthSessionCookie. SessionCookieName *string `json:"sessionCookieName" yaml:"sessionCookieName"` // The maximum duration of the authentication session, in seconds. // // The default is 604800 seconds (7 days). SessionTimeout *string `json:"sessionTimeout" yaml:"sessionTimeout"` }
Specifies information required when integrating with Amazon Cognito to authenticate users.
TODO: EXAMPLE
type CfnListener_AuthenticateOidcConfigProperty ¶
type CfnListener_AuthenticateOidcConfigProperty struct { // The authorization endpoint of the IdP. // // This must be a full URL, including the HTTPS protocol, the domain, and the path. AuthorizationEndpoint *string `json:"authorizationEndpoint" yaml:"authorizationEndpoint"` // The OAuth 2.0 client identifier. ClientId *string `json:"clientId" yaml:"clientId"` // The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set `UseExistingClientSecret` to true. ClientSecret *string `json:"clientSecret" yaml:"clientSecret"` // The OIDC issuer identifier of the IdP. // // This must be a full URL, including the HTTPS protocol, the domain, and the path. Issuer *string `json:"issuer" yaml:"issuer"` // The token endpoint of the IdP. // // This must be a full URL, including the HTTPS protocol, the domain, and the path. TokenEndpoint *string `json:"tokenEndpoint" yaml:"tokenEndpoint"` // The user info endpoint of the IdP. // // This must be a full URL, including the HTTPS protocol, the domain, and the path. UserInfoEndpoint *string `json:"userInfoEndpoint" yaml:"userInfoEndpoint"` // The query parameters (up to 10) to include in the redirect request to the authorization endpoint. AuthenticationRequestExtraParams interface{} `json:"authenticationRequestExtraParams" yaml:"authenticationRequestExtraParams"` // The behavior if the user is not authenticated. The following are possible values:. // // - deny “ - Return an HTTP 401 Unauthorized error. // - allow “ - Allow the request to be forwarded to the target. // - authenticate “ - Redirect the request to the IdP authorization endpoint. This is the default value. OnUnauthenticatedRequest *string `json:"onUnauthenticatedRequest" yaml:"onUnauthenticatedRequest"` // The set of user claims to be requested from the IdP. The default is `openid` . // // To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. Scope *string `json:"scope" yaml:"scope"` // The name of the cookie used to maintain session information. // // The default is AWSELBAuthSessionCookie. SessionCookieName *string `json:"sessionCookieName" yaml:"sessionCookieName"` // The maximum duration of the authentication session, in seconds. // // The default is 604800 seconds (7 days). SessionTimeout *string `json:"sessionTimeout" yaml:"sessionTimeout"` }
Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.
TODO: EXAMPLE
type CfnListener_CertificateProperty ¶
type CfnListener_CertificateProperty struct { // The Amazon Resource Name (ARN) of the certificate. CertificateArn *string `json:"certificateArn" yaml:"certificateArn"` }
Specifies an SSL server certificate to use as the default certificate for a secure listener.
TODO: EXAMPLE
type CfnListener_FixedResponseConfigProperty ¶
type CfnListener_FixedResponseConfigProperty struct { // The HTTP response code (2XX, 4XX, or 5XX). StatusCode *string `json:"statusCode" yaml:"statusCode"` // The content type. // // Valid Values: text/plain | text/css | text/html | application/javascript | application/json ContentType *string `json:"contentType" yaml:"contentType"` // The message. MessageBody *string `json:"messageBody" yaml:"messageBody"` }
Specifies information required when returning a custom HTTP response.
TODO: EXAMPLE
type CfnListener_ForwardConfigProperty ¶
type CfnListener_ForwardConfigProperty struct { // Information about how traffic will be distributed between multiple target groups in a forward rule. TargetGroups interface{} `json:"targetGroups" yaml:"targetGroups"` // Information about the target group stickiness for a rule. TargetGroupStickinessConfig interface{} `json:"targetGroupStickinessConfig" yaml:"targetGroupStickinessConfig"` }
Information for creating an action that distributes requests among one or more target groups.
For Network Load Balancers, you can specify a single target group. Specify only when `Type` is `forward` . If you specify both `ForwardConfig` and `TargetGroupArn` , you can specify only one target group using `ForwardConfig` and it must be the same target group specified in `TargetGroupArn` .
TODO: EXAMPLE
type CfnListener_RedirectConfigProperty ¶
type CfnListener_RedirectConfigProperty struct { // The HTTP redirect code. // // The redirect is either permanent (HTTP 301) or temporary (HTTP 302). StatusCode *string `json:"statusCode" yaml:"statusCode"` // The hostname. // // This component is not percent-encoded. The hostname can contain #{host}. Host *string `json:"host" yaml:"host"` // The absolute path, starting with the leading "/". // // This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}. Path *string `json:"path" yaml:"path"` // The port. // // You can specify a value from 1 to 65535 or #{port}. Port *string `json:"port" yaml:"port"` // The protocol. // // You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP. Protocol *string `json:"protocol" yaml:"protocol"` // The query parameters, URL-encoded when necessary, but not percent-encoded. // // Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords. Query *string `json:"query" yaml:"query"` }
Information about a redirect action.
A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values.
You can reuse URI components using the following reserved keywords:
- #{protocol} - #{host} - #{port} - #{path} (the leading "/" is removed) - #{query}
For example, you can change the path to "/new/#{path}", the hostname to "example.#{host}", or the query to "#{query}&value=xyz".
TODO: EXAMPLE
type CfnListener_TargetGroupStickinessConfigProperty ¶
type CfnListener_TargetGroupStickinessConfigProperty struct { // The time period, in seconds, during which requests from a client should be routed to the same target group. // // The range is 1-604800 seconds (7 days). DurationSeconds *float64 `json:"durationSeconds" yaml:"durationSeconds"` // Indicates whether target group stickiness is enabled. Enabled interface{} `json:"enabled" yaml:"enabled"` }
Information about the target group stickiness for a rule.
TODO: EXAMPLE
type CfnListener_TargetGroupTupleProperty ¶
type CfnListener_TargetGroupTupleProperty struct { // The Amazon Resource Name (ARN) of the target group. TargetGroupArn *string `json:"targetGroupArn" yaml:"targetGroupArn"` // The weight. // // The range is 0 to 999. Weight *float64 `json:"weight" yaml:"weight"` }
Information about how traffic will be distributed between multiple target groups in a forward rule.
TODO: EXAMPLE
type CfnLoadBalancer ¶
type CfnLoadBalancer interface { awscdk.CfnResource awscdk.IInspectable AttrCanonicalHostedZoneId() *string AttrDnsName() *string AttrLoadBalancerFullName() *string AttrLoadBalancerName() *string AttrSecurityGroups() *[]*string CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string IpAddressType() *string SetIpAddressType(val *string) LoadBalancerAttributes() interface{} SetLoadBalancerAttributes(val interface{}) LogicalId() *string Name() *string SetName(val *string) Node() constructs.Node Ref() *string Scheme() *string SetScheme(val *string) SecurityGroups() *[]*string SetSecurityGroups(val *[]*string) Stack() awscdk.Stack SubnetMappings() interface{} SetSubnetMappings(val interface{}) Subnets() *[]*string SetSubnets(val *[]*string) Tags() awscdk.TagManager Type() *string SetType(val *string) UpdatedProperites() *map[string]interface{} AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::ElasticLoadBalancingV2::LoadBalancer`.
Specifies an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.
TODO: EXAMPLE
func NewCfnLoadBalancer ¶
func NewCfnLoadBalancer(scope constructs.Construct, id *string, props *CfnLoadBalancerProps) CfnLoadBalancer
Create a new `AWS::ElasticLoadBalancingV2::LoadBalancer`.
type CfnLoadBalancerProps ¶
type CfnLoadBalancerProps struct { // The IP address type. // // The possible values are `ipv4` (for IPv4 addresses) and `dualstack` (for IPv4 and IPv6 addresses). You can’t specify `dualstack` for a load balancer with a UDP or TCP_UDP listener. IpAddressType *string `json:"ipAddressType" yaml:"ipAddressType"` // The load balancer attributes. LoadBalancerAttributes interface{} `json:"loadBalancerAttributes" yaml:"loadBalancerAttributes"` // The name of the load balancer. // // This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-". // // If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name. Name *string `json:"name" yaml:"name"` // The nodes of an Internet-facing load balancer have public IP addresses. // // The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. // // The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer. // // The default is an Internet-facing load balancer. // // You cannot specify a scheme for a Gateway Load Balancer. Scheme *string `json:"scheme" yaml:"scheme"` // [Application Load Balancers] The IDs of the security groups for the load balancer. SecurityGroups *[]*string `json:"securityGroups" yaml:"securityGroups"` // The IDs of the public subnets. // // You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. // // [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. // // [Application Load Balancers on Outposts] You must specify one Outpost subnet. // // [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. // // [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. // // [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets. SubnetMappings interface{} `json:"subnetMappings" yaml:"subnetMappings"` // The IDs of the public subnets. // // You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets. // // [Application Load Balancers] You must specify subnets from at least two Availability Zones. // // [Application Load Balancers on Outposts] You must specify one Outpost subnet. // // [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. // // [Network Load Balancers] You can specify subnets from one or more Availability Zones. // // [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. Subnets *[]*string `json:"subnets" yaml:"subnets"` // The tags to assign to the load balancer. Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` // The type of load balancer. // // The default is `application` . Type *string `json:"type" yaml:"type"` }
Properties for defining a `CfnLoadBalancer`.
TODO: EXAMPLE
type CfnLoadBalancer_LoadBalancerAttributeProperty ¶
type CfnLoadBalancer_LoadBalancerAttributeProperty struct { // The name of the attribute. // // The following attribute is supported by all load balancers: // // - `deletion_protection.enabled` - Indicates whether deletion protection is enabled. The value is `true` or `false` . The default is `false` . // // The following attributes are supported by both Application Load Balancers and Network Load Balancers: // // - `access_logs.s3.enabled` - Indicates whether access logs are enabled. The value is `true` or `false` . The default is `false` . // - `access_logs.s3.bucket` - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. // - `access_logs.s3.prefix` - The prefix for the location in the S3 bucket for the access logs. // - `ipv6.deny_all_igw_traffic` - Blocks internet gateway (IGW) access to the load balancer. It is set to `false` for internet-facing load balancers and `true` for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway. // // The following attributes are supported by only Application Load Balancers: // // - `idle_timeout.timeout_seconds` - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds. // - `routing.http.desync_mitigation_mode` - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are `monitor` , `defensive` , and `strictest` . The default is `defensive` . // - `routing.http.drop_invalid_header_fields.enabled` - Indicates whether HTTP headers with invalid header fields are removed by the load balancer ( `true` ) or routed to targets ( `false` ). The default is `false` . // - `routing.http.x_amzn_tls_version_and_cipher_suite.enabled` - Indicates whether the two headers ( `x-amzn-tls-version` and `x-amzn-tls-cipher-suite` ), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The `x-amzn-tls-version` header has information about the TLS protocol version negotiated with the client, and the `x-amzn-tls-cipher-suite` header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are `true` and `false` . The default is `false` . // - `routing.http.xff_client_port.enabled` - Indicates whether the `X-Forwarded-For` header should preserve the source port that the client used to connect to the load balancer. The possible values are `true` and `false` . The default is `false` . // - `routing.http2.enabled` - Indicates whether HTTP/2 is enabled. The possible values are `true` and `false` . The default is `true` . Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens. // - `waf.fail_open.enabled` - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF. The possible values are `true` and `false` . The default is `false` . // // The following attribute is supported by Network Load Balancers and Gateway Load Balancers: // // - `load_balancing.cross_zone.enabled` - Indicates whether cross-zone load balancing is enabled. The possible values are `true` and `false` . The default is `false` . Key *string `json:"key" yaml:"key"` // The value of the attribute. Value *string `json:"value" yaml:"value"` }
Specifies an attribute for an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.
TODO: EXAMPLE
type CfnLoadBalancer_SubnetMappingProperty ¶
type CfnLoadBalancer_SubnetMappingProperty struct { // The ID of the subnet. SubnetId *string `json:"subnetId" yaml:"subnetId"` // [Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer. AllocationId *string `json:"allocationId" yaml:"allocationId"` // [Network Load Balancers] The IPv6 address. IPv6Address *string `json:"iPv6Address" yaml:"iPv6Address"` // [Network Load Balancers] The private IPv4 address for an internal load balancer. PrivateIPv4Address *string `json:"privateIPv4Address" yaml:"privateIPv4Address"` }
Specifies a subnet for a load balancer.
TODO: EXAMPLE
type CfnTargetGroup ¶
type CfnTargetGroup interface { awscdk.CfnResource awscdk.IInspectable AttrLoadBalancerArns() *[]*string AttrTargetGroupFullName() *string AttrTargetGroupName() *string CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string HealthCheckEnabled() interface{} SetHealthCheckEnabled(val interface{}) HealthCheckIntervalSeconds() *float64 SetHealthCheckIntervalSeconds(val *float64) HealthCheckPath() *string SetHealthCheckPath(val *string) HealthCheckPort() *string SetHealthCheckPort(val *string) HealthCheckProtocol() *string SetHealthCheckProtocol(val *string) HealthCheckTimeoutSeconds() *float64 SetHealthCheckTimeoutSeconds(val *float64) HealthyThresholdCount() *float64 SetHealthyThresholdCount(val *float64) IpAddressType() *string SetIpAddressType(val *string) LogicalId() *string Matcher() interface{} SetMatcher(val interface{}) Name() *string SetName(val *string) Node() constructs.Node Port() *float64 SetPort(val *float64) Protocol() *string SetProtocol(val *string) ProtocolVersion() *string SetProtocolVersion(val *string) Ref() *string Stack() awscdk.Stack Tags() awscdk.TagManager TargetGroupAttributes() interface{} SetTargetGroupAttributes(val interface{}) Targets() interface{} SetTargets(val interface{}) TargetType() *string SetTargetType(val *string) UnhealthyThresholdCount() *float64 SetUnhealthyThresholdCount(val *float64) UpdatedProperites() *map[string]interface{} VpcId() *string SetVpcId(val *string) AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::ElasticLoadBalancingV2::TargetGroup`.
Specifies a target group for a load balancer.
Before you register a Lambda function as a target, you must create a `AWS::Lambda::Permission` resource that grants the Elastic Load Balancing service principal permission to invoke the Lambda function.
TODO: EXAMPLE
func NewCfnTargetGroup ¶
func NewCfnTargetGroup(scope constructs.Construct, id *string, props *CfnTargetGroupProps) CfnTargetGroup
Create a new `AWS::ElasticLoadBalancingV2::TargetGroup`.
type CfnTargetGroupProps ¶
type CfnTargetGroupProps struct { // Indicates whether health checks are enabled. // // If the target type is `lambda` , health checks are disabled by default but can be enabled. If the target type is `instance` , `ip` , or `alb` , health checks are always enabled and cannot be disabled. HealthCheckEnabled interface{} `json:"healthCheckEnabled" yaml:"healthCheckEnabled"` // The approximate amount of time, in seconds, between health checks of an individual target. // // If the target group protocol is HTTP or HTTPS, the default is 30 seconds. If the target group protocol is TCP, TLS, UDP, or TCP_UDP, the supported values are 10 and 30 seconds and the default is 30 seconds. If the target group protocol is GENEVE, the default is 10 seconds. If the target type is `lambda` , the default is 35 seconds. HealthCheckIntervalSeconds *float64 `json:"healthCheckIntervalSeconds" yaml:"healthCheckIntervalSeconds"` // [HTTP/HTTPS health checks] The destination for health checks on the targets. // // [HTTP1 or HTTP2 protocol version] The ping path. The default is /. // // [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is / AWS .ALB/healthcheck. HealthCheckPath *string `json:"healthCheckPath" yaml:"healthCheckPath"` // The port the load balancer uses when performing health checks on targets. // // If the protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, the default is `traffic-port` , which is the port on which each target receives traffic from the load balancer. If the protocol is GENEVE, the default is port 80. HealthCheckPort *string `json:"healthCheckPort" yaml:"healthCheckPort"` // The protocol the load balancer uses when performing health checks on targets. // // For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks. HealthCheckProtocol *string `json:"healthCheckProtocol" yaml:"healthCheckProtocol"` // The amount of time, in seconds, during which no response from a target means a failed health check. // // For target groups with a protocol of HTTP, HTTPS, or GENEVE, the default is 5 seconds. For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks and 10 seconds for TCP and HTTPS health checks. If the target type is `lambda` , the default is 30 seconds. HealthCheckTimeoutSeconds *float64 `json:"healthCheckTimeoutSeconds" yaml:"healthCheckTimeoutSeconds"` // The number of consecutive health checks successes required before considering an unhealthy target healthy. // // For target groups with a protocol of HTTP or HTTPS, the default is 5. For target groups with a protocol of TCP, TLS, or GENEVE, the default is 3. If the target type is `lambda` , the default is 5. HealthyThresholdCount *float64 `json:"healthyThresholdCount" yaml:"healthyThresholdCount"` // The type of IP address used for this target group. // // The possible values are `ipv4` and `ipv6` . This is an optional parameter. If not specified, the IP address type defaults to `ipv4` . IpAddressType *string `json:"ipAddressType" yaml:"ipAddressType"` // [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target. Matcher interface{} `json:"matcher" yaml:"matcher"` // The name of the target group. // // This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen. Name *string `json:"name" yaml:"name"` // The port on which the targets receive traffic. // // This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081. Port *float64 `json:"port" yaml:"port"` // The protocol to use for routing traffic to the targets. // // For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, or TCP_UDP. For Gateway Load Balancers, the supported protocol is GENEVE. A TCP_UDP listener must be associated with a TCP_UDP target group. If the target is a Lambda function, this parameter does not apply. Protocol *string `json:"protocol" yaml:"protocol"` // [HTTP/HTTPS protocol] The protocol version. // // The possible values are `GRPC` , `HTTP1` , and `HTTP2` . ProtocolVersion *string `json:"protocolVersion" yaml:"protocolVersion"` // The tags. Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` // The attributes. TargetGroupAttributes interface{} `json:"targetGroupAttributes" yaml:"targetGroupAttributes"` // The targets. Targets interface{} `json:"targets" yaml:"targets"` // The type of target that you must specify when registering targets with this target group. // // You can't specify targets for a target group using more than one target type. // // - `instance` - Register targets by instance ID. This is the default value. // - `ip` - Register targets by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses. // - `lambda` - Register a single Lambda function as a target. // - `alb` - Register a single Application Load Balancer as a target. TargetType *string `json:"targetType" yaml:"targetType"` // The number of consecutive health check failures required before considering a target unhealthy. // // If the target group protocol is HTTP or HTTPS, the default is 2. If the target group protocol is TCP or TLS, this value must be the same as the healthy threshold count. If the target group protocol is GENEVE, the default is 3. If the target type is `lambda` , the default is 2. UnhealthyThresholdCount *float64 `json:"unhealthyThresholdCount" yaml:"unhealthyThresholdCount"` // The identifier of the virtual private cloud (VPC). // // If the target is a Lambda function, this parameter does not apply. Otherwise, this parameter is required. VpcId *string `json:"vpcId" yaml:"vpcId"` }
Properties for defining a `CfnTargetGroup`.
TODO: EXAMPLE
type CfnTargetGroup_MatcherProperty ¶
type CfnTargetGroup_MatcherProperty struct { // You can specify values between 0 and 99. // // You can specify multiple values (for example, "0,1") or a range of values (for example, "0-5"). The default value is 12. GrpcCode *string `json:"grpcCode" yaml:"grpcCode"` // For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. // // You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299"). // // For Network Load Balancers and Gateway Load Balancers, this must be "200–399". // // Note that when using shorthand syntax, some values such as commas need to be escaped. HttpCode *string `json:"httpCode" yaml:"httpCode"` }
Specifies the HTTP codes that healthy targets must use when responding to an HTTP health check.
TODO: EXAMPLE
type CfnTargetGroup_TargetDescriptionProperty ¶
type CfnTargetGroup_TargetDescriptionProperty struct { // The ID of the target. // // If the target type of the target group is `instance` , specify an instance ID. If the target type is `ip` , specify an IP address. If the target type is `lambda` , specify the ARN of the Lambda function. If the target type is `alb` , specify the ARN of the Application Load Balancer target. Id *string `json:"id" yaml:"id"` // An Availability Zone or `all` . // // This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer. // // This parameter is not supported if the target type of the target group is `instance` or `alb` . // // If the target type is `ip` and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required. // // With an Application Load Balancer, if the target type is `ip` and the IP address is outside the VPC for the target group, the only supported value is `all` . // // If the target type is `lambda` , this parameter is optional and the only supported value is `all` . AvailabilityZone *string `json:"availabilityZone" yaml:"availabilityZone"` // The port on which the target is listening. // // If the target group protocol is GENEVE, the supported port is 6081. If the target type is `alb` , the targeted Application Load Balancer must have at least one listener whose port matches the target group port. Not used if the target is a Lambda function. Port *float64 `json:"port" yaml:"port"` }
Specifies a target to add to a target group.
TODO: EXAMPLE
type CfnTargetGroup_TargetGroupAttributeProperty ¶
type CfnTargetGroup_TargetGroupAttributeProperty struct { // The name of the attribute. // // The following attribute is supported by all load balancers: // // - `deregistration_delay.timeout_seconds` - The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from `draining` to `unused` . The range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is not supported. // // The following attributes are supported by both Application Load Balancers and Network Load Balancers: // // - `stickiness.enabled` - Indicates whether sticky sessions are enabled. The value is `true` or `false` . The default is `false` . // - `stickiness.type` - The type of sticky sessions. The possible values are `lb_cookie` and `app_cookie` for Application Load Balancers or `source_ip` for Network Load Balancers. // // The following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address: // // - `load_balancing.algorithm.type` - The load balancing algorithm determines how the load balancer selects targets when routing requests. The value is `round_robin` or `least_outstanding_requests` . The default is `round_robin` . // - `slow_start.duration_seconds` - The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). The default is 0 seconds (disabled). // - `stickiness.app_cookie.cookie_name` - Indicates the name of the application-based cookie. Names that start with the following prefixes are not allowed: `AWSALB` , `AWSALBAPP` , and `AWSALBTG` ; they're reserved for use by the load balancer. // - `stickiness.app_cookie.duration_seconds` - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the application-based cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). // - `stickiness.lb_cookie.duration_seconds` - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). // // The following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function: // // - `lambda.multi_value_headers.enabled` - Indicates whether the request and response headers that are exchanged between the load balancer and the Lambda function include arrays of values or strings. The value is `true` or `false` . The default is `false` . If the value is `false` and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client. // // The following attributes are supported only by Network Load Balancers: // // - `deregistration_delay.connection_termination.enabled` - Indicates whether the load balancer terminates connections at the end of the deregistration timeout. The value is `true` or `false` . The default is `false` . // - `preserve_client_ip.enabled` - Indicates whether client IP preservation is enabled. The value is `true` or `false` . The default is disabled if the target group type is IP address and the target group protocol is TCP or TLS. Otherwise, the default is enabled. Client IP preservation cannot be disabled for UDP and TCP_UDP target groups. // - `proxy_protocol_v2.enabled` - Indicates whether Proxy Protocol version 2 is enabled. The value is `true` or `false` . The default is `false` . Key *string `json:"key" yaml:"key"` // The value of the attribute. Value *string `json:"value" yaml:"value"` }
Specifies a target group attribute.
TODO: EXAMPLE
type FixedResponseOptions ¶
type FixedResponseOptions struct { // Content Type of the response. // // Valid Values: text/plain | text/css | text/html | application/javascript | application/json ContentType *string `json:"contentType" yaml:"contentType"` // The response body. MessageBody *string `json:"messageBody" yaml:"messageBody"` }
Options for `ListenerAction.fixedResponse()`.
TODO: EXAMPLE
type ForwardOptions ¶
type ForwardOptions struct { // For how long clients should be directed to the same target group. // // Range between 1 second and 7 days. StickinessDuration awscdk.Duration `json:"stickinessDuration" yaml:"stickinessDuration"` }
Options for `ListenerAction.forward()`.
TODO: EXAMPLE
type HealthCheck ¶
type HealthCheck struct { // Indicates whether health checks are enabled. // // If the target type is lambda, // health checks are disabled by default but can be enabled. If the target type // is instance or ip, health checks are always enabled and cannot be disabled. Enabled *bool `json:"enabled" yaml:"enabled"` // GRPC code to use when checking for a successful response from a target. // // You can specify values between 0 and 99. You can specify multiple values // (for example, "0,1") or a range of values (for example, "0-5"). HealthyGrpcCodes *string `json:"healthyGrpcCodes" yaml:"healthyGrpcCodes"` // HTTP code to use when checking for a successful response from a target. // // For Application Load Balancers, you can specify values between 200 and // 499, and the default value is 200. You can specify multiple values (for // example, "200,202") or a range of values (for example, "200-299"). HealthyHttpCodes *string `json:"healthyHttpCodes" yaml:"healthyHttpCodes"` // The number of consecutive health checks successes required before considering an unhealthy target healthy. // // For Application Load Balancers, the default is 5. For Network Load Balancers, the default is 3. HealthyThresholdCount *float64 `json:"healthyThresholdCount" yaml:"healthyThresholdCount"` // The approximate number of seconds between health checks for an individual target. Interval awscdk.Duration `json:"interval" yaml:"interval"` // The ping path destination where Elastic Load Balancing sends health check requests. Path *string `json:"path" yaml:"path"` // The port that the load balancer uses when performing health checks on the targets. Port *string `json:"port" yaml:"port"` // The protocol the load balancer uses when performing health checks on targets. // // The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. // The TLS, UDP, and TCP_UDP protocols are not supported for health checks. Protocol Protocol `json:"protocol" yaml:"protocol"` // The amount of time, in seconds, during which no response from a target means a failed health check. // // For Application Load Balancers, the range is 2-60 seconds and the // default is 5 seconds. For Network Load Balancers, this is 10 seconds for // TCP and HTTPS health checks and 6 seconds for HTTP health checks. Timeout awscdk.Duration `json:"timeout" yaml:"timeout"` // The number of consecutive health check failures required before considering a target unhealthy. // // For Application Load Balancers, the default is 2. For Network Load // Balancers, this value must be the same as the healthy threshold count. UnhealthyThresholdCount *float64 `json:"unhealthyThresholdCount" yaml:"unhealthyThresholdCount"` }
Properties for configuring a health check.
TODO: EXAMPLE
type HttpCodeElb ¶
type HttpCodeElb string
Count of HTTP status originating from the load balancer.
This count does not include any response codes generated by the targets.
const ( HttpCodeElb_ELB_3XX_COUNT HttpCodeElb = "ELB_3XX_COUNT" HttpCodeElb_ELB_4XX_COUNT HttpCodeElb = "ELB_4XX_COUNT" HttpCodeElb_ELB_5XX_COUNT HttpCodeElb = "ELB_5XX_COUNT" )
type HttpCodeTarget ¶
type HttpCodeTarget string
Count of HTTP status originating from the targets.
const ( HttpCodeTarget_TARGET_2XX_COUNT HttpCodeTarget = "TARGET_2XX_COUNT" HttpCodeTarget_TARGET_3XX_COUNT HttpCodeTarget = "TARGET_3XX_COUNT" HttpCodeTarget_TARGET_4XX_COUNT HttpCodeTarget = "TARGET_4XX_COUNT" HttpCodeTarget_TARGET_5XX_COUNT HttpCodeTarget = "TARGET_5XX_COUNT" )
type IApplicationListener ¶
type IApplicationListener interface { awsec2.IConnectable awscdk.IResource // Add one or more certificates to this listener. AddCertificates(id *string, certificates *[]IListenerCertificate) // Load balance incoming requests to the given target groups. // // It's possible to add conditions to the TargetGroups added in this way. // At least one TargetGroup must be added without conditions. AddTargetGroups(id *string, props *AddApplicationTargetGroupsProps) // Load balance incoming requests to the given load balancing targets. // // This method implicitly creates an ApplicationTargetGroup for the targets // involved. // // It's possible to add conditions to the targets added in this way. At least // one set of targets must be added without conditions. // // Returns: The newly created target group AddTargets(id *string, props *AddApplicationTargetsProps) ApplicationTargetGroup // Register that a connectable that has been added to this load balancer. // // Don't call this directly. It is called by ApplicationTargetGroup. RegisterConnectable(connectable awsec2.IConnectable, portRange awsec2.Port) // ARN of the listener. ListenerArn() *string }
Properties to reference an existing listener.
func ApplicationListener_FromApplicationListenerAttributes ¶
func ApplicationListener_FromApplicationListenerAttributes(scope constructs.Construct, id *string, attrs *ApplicationListenerAttributes) IApplicationListener
Import an existing listener.
func ApplicationListener_FromLookup ¶
func ApplicationListener_FromLookup(scope constructs.Construct, id *string, options *ApplicationListenerLookupOptions) IApplicationListener
Look up an ApplicationListener.
type IApplicationLoadBalancer ¶
type IApplicationLoadBalancer interface { awsec2.IConnectable ILoadBalancerV2 // Add a new listener to this load balancer. AddListener(id *string, props *BaseApplicationListenerProps) ApplicationListener // The IP Address Type for this load balancer. IpAddressType() IpAddressType // A list of listeners that have been added to the load balancer. // // This list is only valid for owned constructs. Listeners() *[]ApplicationListener // The ARN of this load balancer. LoadBalancerArn() *string // The VPC this load balancer has been created in (if available). // // If this interface is the result of an import call to fromApplicationLoadBalancerAttributes, // the vpc attribute will be undefined unless specified in the optional properties of that method. Vpc() awsec2.IVpc }
An application load balancer.
func ApplicationLoadBalancer_FromApplicationLoadBalancerAttributes ¶
func ApplicationLoadBalancer_FromApplicationLoadBalancerAttributes(scope constructs.Construct, id *string, attrs *ApplicationLoadBalancerAttributes) IApplicationLoadBalancer
Import an existing Application Load Balancer.
func ApplicationLoadBalancer_FromLookup ¶
func ApplicationLoadBalancer_FromLookup(scope constructs.Construct, id *string, options *ApplicationLoadBalancerLookupOptions) IApplicationLoadBalancer
Look up an application load balancer.
type IApplicationLoadBalancerTarget ¶
type IApplicationLoadBalancerTarget interface { // Attach load-balanced target to a TargetGroup. // // May return JSON to directly add to the [Targets] list, or return undefined // if the target will register itself with the load balancer. AttachToApplicationTargetGroup(targetGroup IApplicationTargetGroup) *LoadBalancerTargetProps }
Interface for constructs that can be targets of an application load balancer.
type IApplicationTargetGroup ¶
type IApplicationTargetGroup interface { ITargetGroup // Add a load balancing target to this target group. AddTarget(targets ...IApplicationLoadBalancerTarget) // Register a connectable as a member of this target group. // // Don't call this directly. It will be called by load balancing targets. RegisterConnectable(connectable awsec2.IConnectable, portRange awsec2.Port) // Register a listener that is load balancing to this target group. // // Don't call this directly. It will be called by listeners. RegisterListener(listener IApplicationListener, associatingConstruct constructs.IConstruct) }
A Target Group for Application Load Balancers.
func ApplicationTargetGroup_FromTargetGroupAttributes ¶
func ApplicationTargetGroup_FromTargetGroupAttributes(scope constructs.Construct, id *string, attrs *TargetGroupAttributes) IApplicationTargetGroup
Import an existing target group.
type IListenerAction ¶
type IListenerAction interface { // Render the actions in this chain. RenderActions() *[]*CfnListener_ActionProperty }
Interface for listener actions.
type IListenerCertificate ¶
type IListenerCertificate interface { // The ARN of the certificate to use. CertificateArn() *string }
A certificate source for an ELBv2 listener.
type ILoadBalancerV2 ¶
type ILoadBalancerV2 interface { awscdk.IResource // The canonical hosted zone ID of this load balancer. // // Example value: `Z2P70J7EXAMPLE` LoadBalancerCanonicalHostedZoneId() *string // The DNS name of this load balancer. // // Example value: `my-load-balancer-424835706.us-west-2.elb.amazonaws.com` LoadBalancerDnsName() *string }
type INetworkListener ¶
type INetworkListener interface { awscdk.IResource // ARN of the listener. ListenerArn() *string }
Properties to reference an existing listener.
func NetworkListener_FromLookup ¶
func NetworkListener_FromLookup(scope constructs.Construct, id *string, options *NetworkListenerLookupOptions) INetworkListener
Looks up a network listener.
func NetworkListener_FromNetworkListenerArn ¶
func NetworkListener_FromNetworkListenerArn(scope constructs.Construct, id *string, networkListenerArn *string) INetworkListener
Import an existing listener.
type INetworkLoadBalancer ¶
type INetworkLoadBalancer interface { ILoadBalancerV2 awsec2.IVpcEndpointServiceLoadBalancer // Add a listener to this load balancer. // // Returns: The newly created listener AddListener(id *string, props *BaseNetworkListenerProps) NetworkListener // The VPC this load balancer has been created in (if available). Vpc() awsec2.IVpc }
A network load balancer.
func NetworkLoadBalancer_FromLookup ¶
func NetworkLoadBalancer_FromLookup(scope constructs.Construct, id *string, options *NetworkLoadBalancerLookupOptions) INetworkLoadBalancer
Looks up the network load balancer.
func NetworkLoadBalancer_FromNetworkLoadBalancerAttributes ¶
func NetworkLoadBalancer_FromNetworkLoadBalancerAttributes(scope constructs.Construct, id *string, attrs *NetworkLoadBalancerAttributes) INetworkLoadBalancer
type INetworkLoadBalancerTarget ¶
type INetworkLoadBalancerTarget interface { // Attach load-balanced target to a TargetGroup. // // May return JSON to directly add to the [Targets] list, or return undefined // if the target will register itself with the load balancer. AttachToNetworkTargetGroup(targetGroup INetworkTargetGroup) *LoadBalancerTargetProps }
Interface for constructs that can be targets of an network load balancer.
type INetworkTargetGroup ¶
type INetworkTargetGroup interface { ITargetGroup // Add a load balancing target to this target group. AddTarget(targets ...INetworkLoadBalancerTarget) // Register a listener that is load balancing to this target group. // // Don't call this directly. It will be called by listeners. RegisterListener(listener INetworkListener) }
A network target group.
func NetworkTargetGroup_FromTargetGroupAttributes ¶
func NetworkTargetGroup_FromTargetGroupAttributes(scope constructs.Construct, id *string, attrs *TargetGroupAttributes) INetworkTargetGroup
Import an existing target group.
type ITargetGroup ¶
type ITargetGroup interface { constructs.IConstruct // A token representing a list of ARNs of the load balancers that route traffic to this target group. LoadBalancerArns() *string // Return an object to depend on the listeners added to this target group. LoadBalancerAttached() constructs.IDependable // ARN of the target group. TargetGroupArn() *string // The name of the target group. TargetGroupName() *string }
A target group.
type IpAddressType ¶
type IpAddressType string
What kind of addresses to allocate to the load balancer.
const ( IpAddressType_IPV4 IpAddressType = "IPV4" IpAddressType_DUAL_STACK IpAddressType = "DUAL_STACK" )
type ListenerAction ¶
type ListenerAction interface { IListenerAction Next() ListenerAction Bind(scope constructs.Construct, listener IApplicationListener, associatingConstruct constructs.IConstruct) RenderActions() *[]*CfnListener_ActionProperty Renumber(actions *[]*CfnListener_ActionProperty) *[]*CfnListener_ActionProperty }
What to do when a client makes a request to a listener.
Some actions can be combined with other ones (specifically, you can perform authentication before serving the request).
Multiple actions form a linked chain; the chain must always terminate in a *(weighted)forward*, *fixedResponse* or *redirect* action.
If an action supports chaining, the next action can be indicated by passing it in the `next` property.
(Called `ListenerAction` instead of the more strictly correct `ListenerAction` because this is the class most users interact with, and we want to make it not too visually overwhelming).
TODO: EXAMPLE
func ListenerAction_AuthenticateOidc ¶
func ListenerAction_AuthenticateOidc(options *AuthenticateOidcOptions) ListenerAction
Authenticate using an identity provider (IdP) that is compliant with OpenID Connect (OIDC). See: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/listener-authenticate-users.html#oidc-requirements
func ListenerAction_FixedResponse ¶
func ListenerAction_FixedResponse(statusCode *float64, options *FixedResponseOptions) ListenerAction
Return a fixed response. See: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#fixed-response-actions
func ListenerAction_Forward ¶
func ListenerAction_Forward(targetGroups *[]IApplicationTargetGroup, options *ForwardOptions) ListenerAction
Forward to one or more Target Groups. See: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#forward-actions
func ListenerAction_Redirect ¶
func ListenerAction_Redirect(options *RedirectOptions) ListenerAction
Redirect to a different URI.
A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values.
You can reuse URI components using the following reserved keywords:
- `#{protocol}` - `#{host}` - `#{port}` - `#{path}` (the leading "/" is removed) - `#{query}`
For example, you can change the path to "/new/#{path}", the hostname to "example.#{host}", or the query to "#{query}&value=xyz". See: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#redirect-actions
func ListenerAction_WeightedForward ¶
func ListenerAction_WeightedForward(targetGroups *[]*WeightedTargetGroup, options *ForwardOptions) ListenerAction
Forward to one or more Target Groups which are weighted differently. See: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#forward-actions
func NewListenerAction ¶
func NewListenerAction(actionJson *CfnListener_ActionProperty, next ListenerAction) ListenerAction
Create an instance of ListenerAction.
The default class should be good enough for most cases and should be created by using one of the static factory functions, but allow overriding to make sure we allow flexibility for the future.
type ListenerCertificate ¶
type ListenerCertificate interface { IListenerCertificate CertificateArn() *string }
A certificate source for an ELBv2 listener.
TODO: EXAMPLE
func ListenerCertificate_FromArn ¶
func ListenerCertificate_FromArn(certificateArn *string) ListenerCertificate
Use any certificate, identified by its ARN, as a listener certificate.
func ListenerCertificate_FromCertificateManager ¶
func ListenerCertificate_FromCertificateManager(acmCertificate awscertificatemanager.ICertificate) ListenerCertificate
Use an ACM certificate as a listener certificate.
func NewListenerCertificate ¶
func NewListenerCertificate(certificateArn *string) ListenerCertificate
type ListenerCondition ¶
type ListenerCondition interface {
RenderRawCondition() interface{}
}
ListenerCondition providers definition.
TODO: EXAMPLE
func ListenerCondition_HostHeaders ¶
func ListenerCondition_HostHeaders(values *[]*string) ListenerCondition
Create a host-header listener rule condition.
func ListenerCondition_HttpHeader ¶
func ListenerCondition_HttpHeader(name *string, values *[]*string) ListenerCondition
Create a http-header listener rule condition.
func ListenerCondition_HttpRequestMethods ¶
func ListenerCondition_HttpRequestMethods(values *[]*string) ListenerCondition
Create a http-request-method listener rule condition.
func ListenerCondition_PathPatterns ¶
func ListenerCondition_PathPatterns(values *[]*string) ListenerCondition
Create a path-pattern listener rule condition.
func ListenerCondition_QueryStrings ¶
func ListenerCondition_QueryStrings(values *[]*QueryStringCondition) ListenerCondition
Create a query-string listener rule condition.
func ListenerCondition_SourceIps ¶
func ListenerCondition_SourceIps(values *[]*string) ListenerCondition
Create a source-ip listener rule condition.
type LoadBalancerTargetProps ¶
type LoadBalancerTargetProps struct { // What kind of target this is. TargetType TargetType `json:"targetType" yaml:"targetType"` // JSON representing the target's direct addition to the TargetGroup list. // // May be omitted if the target is going to register itself later. TargetJson interface{} `json:"targetJson" yaml:"targetJson"` }
Result of attaching a target to load balancer.
TODO: EXAMPLE
type NetworkForwardOptions ¶
type NetworkForwardOptions struct { // For how long clients should be directed to the same target group. // // Range between 1 second and 7 days. StickinessDuration awscdk.Duration `json:"stickinessDuration" yaml:"stickinessDuration"` }
Options for `NetworkListenerAction.forward()`.
TODO: EXAMPLE
type NetworkListener ¶
type NetworkListener interface { BaseListener INetworkListener Env() *awscdk.ResourceEnvironment ListenerArn() *string LoadBalancer() INetworkLoadBalancer Node() constructs.Node PhysicalName() *string Stack() awscdk.Stack AddAction(_id *string, props *AddNetworkActionProps) AddTargetGroups(_id *string, targetGroups ...INetworkTargetGroup) AddTargets(id *string, props *AddNetworkTargetsProps) NetworkTargetGroup ApplyRemovalPolicy(policy awscdk.RemovalPolicy) GeneratePhysicalName() *string GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string GetResourceNameAttribute(nameAttr *string) *string ToString() *string ValidateListener() *[]*string }
Define a Network Listener.
TODO: EXAMPLE
func NewNetworkListener ¶
func NewNetworkListener(scope constructs.Construct, id *string, props *NetworkListenerProps) NetworkListener
type NetworkListenerAction ¶
type NetworkListenerAction interface { IListenerAction Next() NetworkListenerAction Bind(scope constructs.Construct, listener INetworkListener) RenderActions() *[]*CfnListener_ActionProperty Renumber(actions *[]*CfnListener_ActionProperty) *[]*CfnListener_ActionProperty }
What to do when a client makes a request to a listener.
Some actions can be combined with other ones (specifically, you can perform authentication before serving the request).
Multiple actions form a linked chain; the chain must always terminate in a *(weighted)forward*, *fixedResponse* or *redirect* action.
If an action supports chaining, the next action can be indicated by passing it in the `next` property.
TODO: EXAMPLE
func NetworkListenerAction_Forward ¶
func NetworkListenerAction_Forward(targetGroups *[]INetworkTargetGroup, options *NetworkForwardOptions) NetworkListenerAction
Forward to one or more Target Groups.
func NetworkListenerAction_WeightedForward ¶
func NetworkListenerAction_WeightedForward(targetGroups *[]*NetworkWeightedTargetGroup, options *NetworkForwardOptions) NetworkListenerAction
Forward to one or more Target Groups which are weighted differently.
func NewNetworkListenerAction ¶
func NewNetworkListenerAction(actionJson *CfnListener_ActionProperty, next NetworkListenerAction) NetworkListenerAction
Create an instance of NetworkListenerAction.
The default class should be good enough for most cases and should be created by using one of the static factory functions, but allow overriding to make sure we allow flexibility for the future.
type NetworkListenerLookupOptions ¶
type NetworkListenerLookupOptions struct { // Filter listeners by listener port. ListenerPort *float64 `json:"listenerPort" yaml:"listenerPort"` // Filter listeners by associated load balancer arn. LoadBalancerArn *string `json:"loadBalancerArn" yaml:"loadBalancerArn"` // Filter listeners by associated load balancer tags. LoadBalancerTags *map[string]*string `json:"loadBalancerTags" yaml:"loadBalancerTags"` // Protocol of the listener port. ListenerProtocol Protocol `json:"listenerProtocol" yaml:"listenerProtocol"` }
Options for looking up a network listener.
TODO: EXAMPLE
type NetworkListenerProps ¶
type NetworkListenerProps struct { // The port on which the listener listens for requests. Port *float64 `json:"port" yaml:"port"` // Application-Layer Protocol Negotiation (ALPN) is a TLS extension that is sent on the initial TLS handshake hello messages. // // ALPN enables the application layer to negotiate which protocols should be used over a secure connection, such as HTTP/1 and HTTP/2. // // Can only be specified together with Protocol TLS. AlpnPolicy AlpnPolicy `json:"alpnPolicy" yaml:"alpnPolicy"` // Certificate list of ACM cert ARNs. // // You must provide exactly one certificate if the listener protocol is HTTPS or TLS. Certificates *[]IListenerCertificate `json:"certificates" yaml:"certificates"` // Default action to take for requests to this listener. // // This allows full control of the default Action of the load balancer, // including weighted forwarding. See the `NetworkListenerAction` class for // all options. // // Cannot be specified together with `defaultTargetGroups`. DefaultAction NetworkListenerAction `json:"defaultAction" yaml:"defaultAction"` // Default target groups to load balance to. // // All target groups will be load balanced to with equal weight and without // stickiness. For a more complex configuration than that, use // either `defaultAction` or `addAction()`. // // Cannot be specified together with `defaultAction`. DefaultTargetGroups *[]INetworkTargetGroup `json:"defaultTargetGroups" yaml:"defaultTargetGroups"` // Protocol for listener, expects TCP, TLS, UDP, or TCP_UDP. Protocol Protocol `json:"protocol" yaml:"protocol"` // SSL Policy. SslPolicy SslPolicy `json:"sslPolicy" yaml:"sslPolicy"` // The load balancer to attach this listener to. LoadBalancer INetworkLoadBalancer `json:"loadBalancer" yaml:"loadBalancer"` }
Properties for a Network Listener attached to a Load Balancer.
TODO: EXAMPLE
type NetworkLoadBalancer ¶
type NetworkLoadBalancer interface { BaseLoadBalancer INetworkLoadBalancer Env() *awscdk.ResourceEnvironment LoadBalancerArn() *string LoadBalancerCanonicalHostedZoneId() *string LoadBalancerDnsName() *string LoadBalancerFullName() *string LoadBalancerName() *string LoadBalancerSecurityGroups() *[]*string Node() constructs.Node PhysicalName() *string Stack() awscdk.Stack Vpc() awsec2.IVpc AddListener(id *string, props *BaseNetworkListenerProps) NetworkListener ApplyRemovalPolicy(policy awscdk.RemovalPolicy) GeneratePhysicalName() *string GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string GetResourceNameAttribute(nameAttr *string) *string LogAccessLogs(bucket awss3.IBucket, prefix *string) Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricActiveFlowCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricConsumedLCUs(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricNewFlowCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricProcessedBytes(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricTcpClientResetCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricTcpElbResetCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricTcpTargetResetCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric RemoveAttribute(key *string) SetAttribute(key *string, value *string) ToString() *string }
Define a new network load balancer.
TODO: EXAMPLE
func NewNetworkLoadBalancer ¶
func NewNetworkLoadBalancer(scope constructs.Construct, id *string, props *NetworkLoadBalancerProps) NetworkLoadBalancer
type NetworkLoadBalancerAttributes ¶
type NetworkLoadBalancerAttributes struct { // ARN of the load balancer. LoadBalancerArn *string `json:"loadBalancerArn" yaml:"loadBalancerArn"` // The canonical hosted zone ID of this load balancer. LoadBalancerCanonicalHostedZoneId *string `json:"loadBalancerCanonicalHostedZoneId" yaml:"loadBalancerCanonicalHostedZoneId"` // The DNS name of this load balancer. LoadBalancerDnsName *string `json:"loadBalancerDnsName" yaml:"loadBalancerDnsName"` // The VPC to associate with the load balancer. Vpc awsec2.IVpc `json:"vpc" yaml:"vpc"` }
Properties to reference an existing load balancer.
TODO: EXAMPLE
type NetworkLoadBalancerLookupOptions ¶
type NetworkLoadBalancerLookupOptions struct { // Find by load balancer's ARN. LoadBalancerArn *string `json:"loadBalancerArn" yaml:"loadBalancerArn"` // Match load balancer tags. LoadBalancerTags *map[string]*string `json:"loadBalancerTags" yaml:"loadBalancerTags"` }
Options for looking up an NetworkLoadBalancer.
TODO: EXAMPLE
type NetworkLoadBalancerProps ¶
type NetworkLoadBalancerProps struct { // The VPC network to place the load balancer in. Vpc awsec2.IVpc `json:"vpc" yaml:"vpc"` // Indicates whether deletion protection is enabled. DeletionProtection *bool `json:"deletionProtection" yaml:"deletionProtection"` // Whether the load balancer has an internet-routable address. InternetFacing *bool `json:"internetFacing" yaml:"internetFacing"` // Name of the load balancer. LoadBalancerName *string `json:"loadBalancerName" yaml:"loadBalancerName"` // Which subnets place the load balancer in. VpcSubnets *awsec2.SubnetSelection `json:"vpcSubnets" yaml:"vpcSubnets"` // Indicates whether cross-zone load balancing is enabled. CrossZoneEnabled *bool `json:"crossZoneEnabled" yaml:"crossZoneEnabled"` }
Properties for a network load balancer.
TODO: EXAMPLE
type NetworkTargetGroup ¶
type NetworkTargetGroup interface { TargetGroupBase INetworkTargetGroup DefaultPort() *float64 FirstLoadBalancerFullName() *string HealthCheck() *HealthCheck SetHealthCheck(val *HealthCheck) LoadBalancerArns() *string LoadBalancerAttached() constructs.IDependable LoadBalancerAttachedDependencies() constructs.DependencyGroup Node() constructs.Node TargetGroupArn() *string TargetGroupFullName() *string TargetGroupLoadBalancerArns() *[]*string TargetGroupName() *string TargetType() TargetType SetTargetType(val TargetType) AddLoadBalancerTarget(props *LoadBalancerTargetProps) AddTarget(targets ...INetworkLoadBalancerTarget) ConfigureHealthCheck(healthCheck *HealthCheck) MetricHealthyHostCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricUnHealthyHostCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric RegisterListener(listener INetworkListener) SetAttribute(key *string, value *string) ToString() *string ValidateTargetGroup() *[]*string }
Define a Network Target Group.
TODO: EXAMPLE
func NewNetworkTargetGroup ¶
func NewNetworkTargetGroup(scope constructs.Construct, id *string, props *NetworkTargetGroupProps) NetworkTargetGroup
type NetworkTargetGroupProps ¶
type NetworkTargetGroupProps struct { // The amount of time for Elastic Load Balancing to wait before deregistering a target. // // The range is 0-3600 seconds. DeregistrationDelay awscdk.Duration `json:"deregistrationDelay" yaml:"deregistrationDelay"` // Health check configuration. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#aws-resource-elasticloadbalancingv2-targetgroup-properties // HealthCheck *HealthCheck `json:"healthCheck" yaml:"healthCheck"` // The name of the target group. // // This name must be unique per region per account, can have a maximum of // 32 characters, must contain only alphanumeric characters or hyphens, and // must not begin or end with a hyphen. TargetGroupName *string `json:"targetGroupName" yaml:"targetGroupName"` // The type of targets registered to this TargetGroup, either IP or Instance. // // All targets registered into the group must be of this type. If you // register targets to the TargetGroup in the CDK app, the TargetType is // determined automatically. TargetType TargetType `json:"targetType" yaml:"targetType"` // The virtual private cloud (VPC). // // only if `TargetType` is `Ip` or `InstanceId` Vpc awsec2.IVpc `json:"vpc" yaml:"vpc"` // The port on which the listener listens for requests. Port *float64 `json:"port" yaml:"port"` // Indicates whether client IP preservation is enabled. PreserveClientIp *bool `json:"preserveClientIp" yaml:"preserveClientIp"` // Protocol for target group, expects TCP, TLS, UDP, or TCP_UDP. Protocol Protocol `json:"protocol" yaml:"protocol"` // Indicates whether Proxy Protocol version 2 is enabled. ProxyProtocolV2 *bool `json:"proxyProtocolV2" yaml:"proxyProtocolV2"` // The targets to add to this target group. // // Can be `Instance`, `IPAddress`, or any self-registering load balancing // target. If you use either `Instance` or `IPAddress` as targets, all // target must be of the same type. Targets *[]INetworkLoadBalancerTarget `json:"targets" yaml:"targets"` }
Properties for a new Network Target Group.
TODO: EXAMPLE
type NetworkWeightedTargetGroup ¶
type NetworkWeightedTargetGroup struct { // The target group. TargetGroup INetworkTargetGroup `json:"targetGroup" yaml:"targetGroup"` // The target group's weight. // // Range is [0..1000). Weight *float64 `json:"weight" yaml:"weight"` }
A Target Group and weight combination.
TODO: EXAMPLE
type Protocol ¶
type Protocol string
Backend protocol for network load balancers and health checks.
TODO: EXAMPLE
type QueryStringCondition ¶
type QueryStringCondition struct { // The query string value for the condition. Value *string `json:"value" yaml:"value"` // The query string key for the condition. Key *string `json:"key" yaml:"key"` }
Properties for the key/value pair of the query string.
TODO: EXAMPLE
type RedirectOptions ¶
type RedirectOptions struct { // The hostname. // // This component is not percent-encoded. The hostname can contain #{host}. Host *string `json:"host" yaml:"host"` // The absolute path, starting with the leading "/". // // This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}. Path *string `json:"path" yaml:"path"` // The HTTP redirect code. // // The redirect is either permanent (HTTP 301) or temporary (HTTP 302). Permanent *bool `json:"permanent" yaml:"permanent"` // The port. // // You can specify a value from 1 to 65535 or #{port}. Port *string `json:"port" yaml:"port"` // The protocol. // // You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP. Protocol *string `json:"protocol" yaml:"protocol"` // The query parameters, URL-encoded when necessary, but not percent-encoded. // // Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords. Query *string `json:"query" yaml:"query"` }
Options for `ListenerAction.redirect()`.
A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values.
You can reuse URI components using the following reserved keywords:
- `#{protocol}` - `#{host}` - `#{port}` - `#{path}` (the leading "/" is removed) - `#{query}`
For example, you can change the path to "/new/#{path}", the hostname to "example.#{host}", or the query to "#{query}&value=xyz".
TODO: EXAMPLE
type SslPolicy ¶
type SslPolicy string
Elastic Load Balancing provides the following security policies for Application Load Balancers.
We recommend the Recommended policy for general use. You can use the ForwardSecrecy policy if you require Forward Secrecy (FS).
You can use one of the TLS policies to meet compliance and security standards that require disabling certain TLS protocol versions, or to support legacy clients that require deprecated ciphers.
TODO: EXAMPLE
See: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html
const ( SslPolicy_RECOMMENDED SslPolicy = "RECOMMENDED" SslPolicy_FORWARD_SECRECY_TLS12_RES_GCM SslPolicy = "FORWARD_SECRECY_TLS12_RES_GCM" SslPolicy_FORWARD_SECRECY_TLS12_RES SslPolicy = "FORWARD_SECRECY_TLS12_RES" SslPolicy_FORWARD_SECRECY_TLS12 SslPolicy = "FORWARD_SECRECY_TLS12" SslPolicy_FORWARD_SECRECY_TLS11 SslPolicy = "FORWARD_SECRECY_TLS11" SslPolicy_FORWARD_SECRECY SslPolicy = "FORWARD_SECRECY" SslPolicy_TLS12 SslPolicy = "TLS12" SslPolicy_TLS12_EXT SslPolicy = "TLS12_EXT" SslPolicy_TLS11 SslPolicy = "TLS11" SslPolicy_LEGACY SslPolicy = "LEGACY" )
type TargetGroupAttributes ¶
type TargetGroupAttributes struct { // ARN of the target group. TargetGroupArn *string `json:"targetGroupArn" yaml:"targetGroupArn"` // A Token representing the list of ARNs for the load balancer routing to this target group. LoadBalancerArns *string `json:"loadBalancerArns" yaml:"loadBalancerArns"` }
Properties to reference an existing target group.
TODO: EXAMPLE
type TargetGroupBase ¶
type TargetGroupBase interface { constructs.Construct ITargetGroup DefaultPort() *float64 FirstLoadBalancerFullName() *string HealthCheck() *HealthCheck SetHealthCheck(val *HealthCheck) LoadBalancerArns() *string LoadBalancerAttached() constructs.IDependable LoadBalancerAttachedDependencies() constructs.DependencyGroup Node() constructs.Node TargetGroupArn() *string TargetGroupFullName() *string TargetGroupLoadBalancerArns() *[]*string TargetGroupName() *string TargetType() TargetType SetTargetType(val TargetType) AddLoadBalancerTarget(props *LoadBalancerTargetProps) ConfigureHealthCheck(healthCheck *HealthCheck) SetAttribute(key *string, value *string) ToString() *string ValidateTargetGroup() *[]*string }
Define the target of a load balancer.
type TargetGroupLoadBalancingAlgorithmType ¶
type TargetGroupLoadBalancingAlgorithmType string
Load balancing algorithmm type for target groups.
const ( TargetGroupLoadBalancingAlgorithmType_ROUND_ROBIN TargetGroupLoadBalancingAlgorithmType = "ROUND_ROBIN" TargetGroupLoadBalancingAlgorithmType_LEAST_OUTSTANDING_REQUESTS TargetGroupLoadBalancingAlgorithmType = "LEAST_OUTSTANDING_REQUESTS" )
type TargetType ¶
type TargetType string
How to interpret the load balancing target identifiers.
TODO: EXAMPLE
const ( TargetType_INSTANCE TargetType = "INSTANCE" TargetType_IP TargetType = "IP" TargetType_LAMBDA TargetType = "LAMBDA" TargetType_ALB TargetType = "ALB" )
type UnauthenticatedAction ¶
type UnauthenticatedAction string
What to do with unauthenticated requests.
const ( UnauthenticatedAction_DENY UnauthenticatedAction = "DENY" UnauthenticatedAction_ALLOW UnauthenticatedAction = "ALLOW" UnauthenticatedAction_AUTHENTICATE UnauthenticatedAction = "AUTHENTICATE" )
type WeightedTargetGroup ¶
type WeightedTargetGroup struct { // The target group. TargetGroup IApplicationTargetGroup `json:"targetGroup" yaml:"targetGroup"` // The target group's weight. // // Range is [0..1000). Weight *float64 `json:"weight" yaml:"weight"` }
A Target Group and weight combination.
TODO: EXAMPLE