CfnListener

class aws_cdk.aws_elasticloadbalancingv2.CfnListener(scope, id, *, default_actions, load_balancer_arn, alpn_policy=None, certificates=None, port=None, protocol=None, ssl_policy=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::ElasticLoadBalancingV2::Listener.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html

CloudformationResource

AWS::ElasticLoadBalancingV2::Listener

Create a new AWS::ElasticLoadBalancingV2::Listener.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • default_actions (Union[IResolvable, List[Union[ActionProperty, IResolvable]]]) – AWS::ElasticLoadBalancingV2::Listener.DefaultActions.

  • load_balancer_arn (str) – AWS::ElasticLoadBalancingV2::Listener.LoadBalancerArn.

  • alpn_policy (Optional[List[str]]) – AWS::ElasticLoadBalancingV2::Listener.AlpnPolicy.

  • certificates (Union[IResolvable, List[Union[IResolvable, CertificateProperty]], None]) – AWS::ElasticLoadBalancingV2::Listener.Certificates.

  • port (Union[int, float, None]) – AWS::ElasticLoadBalancingV2::Listener.Port.

  • protocol (Optional[str]) – AWS::ElasticLoadBalancingV2::Listener.Protocol.

  • ssl_policy (Optional[str]) – AWS::ElasticLoadBalancingV2::Listener.SslPolicy.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

(experimental) Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Stability

experimental

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::ElasticLoadBalancingV2::Listener'
alpn_policy

AWS::ElasticLoadBalancingV2::Listener.AlpnPolicy.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-alpnpolicy

Return type

Optional[List[str]]

attr_listener_arn

ListenerArn

Type

cloudformationAttribute

Return type

str

certificates

AWS::ElasticLoadBalancingV2::Listener.Certificates.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-certificates

Return type

Union[IResolvable, List[Union[IResolvable, CertificateProperty]], None]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

default_actions

AWS::ElasticLoadBalancingV2::Listener.DefaultActions.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-defaultactions

Return type

Union[IResolvable, List[Union[ActionProperty, IResolvable]]]

load_balancer_arn

AWS::ElasticLoadBalancingV2::Listener.LoadBalancerArn.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-loadbalancerarn

Return type

str

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

port

AWS::ElasticLoadBalancingV2::Listener.Port.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-port

Return type

Union[int, float, None]

protocol

AWS::ElasticLoadBalancingV2::Listener.Protocol.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-protocol

Return type

Optional[str]

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

ssl_policy

AWS::ElasticLoadBalancingV2::Listener.SslPolicy.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-sslpolicy

Return type

Optional[str]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

Static Methods

classmethod is_cfn_element(x)

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.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

ActionProperty

class CfnListener.ActionProperty(*, type, authenticate_cognito_config=None, authenticate_oidc_config=None, fixed_response_config=None, forward_config=None, order=None, redirect_config=None, target_group_arn=None)

Bases: object

Parameters
See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html

Attributes

authenticate_cognito_config

CfnListener.ActionProperty.AuthenticateCognitoConfig.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-authenticatecognitoconfig

Return type

Union[IResolvable, AuthenticateCognitoConfigProperty, None]

authenticate_oidc_config

CfnListener.ActionProperty.AuthenticateOidcConfig.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-authenticateoidcconfig

Return type

Union[IResolvable, AuthenticateOidcConfigProperty, None]

fixed_response_config

CfnListener.ActionProperty.FixedResponseConfig.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-fixedresponseconfig

Return type

Union[IResolvable, FixedResponseConfigProperty, None]

forward_config

CfnListener.ActionProperty.ForwardConfig.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-forwardconfig

Return type

Union[IResolvable, ForwardConfigProperty, None]

order

CfnListener.ActionProperty.Order.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-order

Return type

Union[int, float, None]

redirect_config

CfnListener.ActionProperty.RedirectConfig.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-redirectconfig

Return type

Union[IResolvable, RedirectConfigProperty, None]

target_group_arn

CfnListener.ActionProperty.TargetGroupArn.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-targetgrouparn

Return type

Optional[str]

type

CfnListener.ActionProperty.Type.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-type

Return type

str

AuthenticateCognitoConfigProperty

class CfnListener.AuthenticateCognitoConfigProperty(*, user_pool_arn, user_pool_client_id, user_pool_domain, authentication_request_extra_params=None, on_unauthenticated_request=None, scope=None, session_cookie_name=None, session_timeout=None)

Bases: object

Parameters
  • user_pool_arn (str) – CfnListener.AuthenticateCognitoConfigProperty.UserPoolArn.

  • user_pool_client_id (str) – CfnListener.AuthenticateCognitoConfigProperty.UserPoolClientId.

  • user_pool_domain (str) – CfnListener.AuthenticateCognitoConfigProperty.UserPoolDomain.

  • authentication_request_extra_params (Union[IResolvable, Mapping[str, str], None]) – CfnListener.AuthenticateCognitoConfigProperty.AuthenticationRequestExtraParams.

  • on_unauthenticated_request (Optional[str]) – CfnListener.AuthenticateCognitoConfigProperty.OnUnauthenticatedRequest.

  • scope (Optional[str]) – CfnListener.AuthenticateCognitoConfigProperty.Scope.

  • session_cookie_name (Optional[str]) – CfnListener.AuthenticateCognitoConfigProperty.SessionCookieName.

  • session_timeout (Optional[str]) – CfnListener.AuthenticateCognitoConfigProperty.SessionTimeout.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html

Attributes

authentication_request_extra_params

CfnListener.AuthenticateCognitoConfigProperty.AuthenticationRequestExtraParams.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-authenticationrequestextraparams

Return type

Union[IResolvable, Mapping[str, str], None]

on_unauthenticated_request

CfnListener.AuthenticateCognitoConfigProperty.OnUnauthenticatedRequest.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-onunauthenticatedrequest

Return type

Optional[str]

scope

CfnListener.AuthenticateCognitoConfigProperty.Scope.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-scope

Return type

Optional[str]

CfnListener.AuthenticateCognitoConfigProperty.SessionCookieName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-sessioncookiename

Return type

Optional[str]

session_timeout

CfnListener.AuthenticateCognitoConfigProperty.SessionTimeout.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-sessiontimeout

Return type

Optional[str]

user_pool_arn

CfnListener.AuthenticateCognitoConfigProperty.UserPoolArn.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-userpoolarn

Return type

str

user_pool_client_id

CfnListener.AuthenticateCognitoConfigProperty.UserPoolClientId.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-userpoolclientid

Return type

str

user_pool_domain

CfnListener.AuthenticateCognitoConfigProperty.UserPoolDomain.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-userpooldomain

Return type

str

AuthenticateOidcConfigProperty

class CfnListener.AuthenticateOidcConfigProperty(*, authorization_endpoint, client_id, client_secret, issuer, token_endpoint, user_info_endpoint, authentication_request_extra_params=None, on_unauthenticated_request=None, scope=None, session_cookie_name=None, session_timeout=None)

Bases: object

Parameters
  • authorization_endpoint (str) – CfnListener.AuthenticateOidcConfigProperty.AuthorizationEndpoint.

  • client_id (str) – CfnListener.AuthenticateOidcConfigProperty.ClientId.

  • client_secret (str) – CfnListener.AuthenticateOidcConfigProperty.ClientSecret.

  • issuer (str) – CfnListener.AuthenticateOidcConfigProperty.Issuer.

  • token_endpoint (str) – CfnListener.AuthenticateOidcConfigProperty.TokenEndpoint.

  • user_info_endpoint (str) – CfnListener.AuthenticateOidcConfigProperty.UserInfoEndpoint.

  • authentication_request_extra_params (Union[IResolvable, Mapping[str, str], None]) – CfnListener.AuthenticateOidcConfigProperty.AuthenticationRequestExtraParams.

  • on_unauthenticated_request (Optional[str]) – CfnListener.AuthenticateOidcConfigProperty.OnUnauthenticatedRequest.

  • scope (Optional[str]) – CfnListener.AuthenticateOidcConfigProperty.Scope.

  • session_cookie_name (Optional[str]) – CfnListener.AuthenticateOidcConfigProperty.SessionCookieName.

  • session_timeout (Optional[str]) – CfnListener.AuthenticateOidcConfigProperty.SessionTimeout.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html

Attributes

authentication_request_extra_params

CfnListener.AuthenticateOidcConfigProperty.AuthenticationRequestExtraParams.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-authenticationrequestextraparams

Return type

Union[IResolvable, Mapping[str, str], None]

authorization_endpoint

CfnListener.AuthenticateOidcConfigProperty.AuthorizationEndpoint.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-authorizationendpoint

Return type

str

client_id

CfnListener.AuthenticateOidcConfigProperty.ClientId.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-clientid

Return type

str

client_secret

CfnListener.AuthenticateOidcConfigProperty.ClientSecret.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-clientsecret

Return type

str

issuer

CfnListener.AuthenticateOidcConfigProperty.Issuer.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-issuer

Return type

str

on_unauthenticated_request

CfnListener.AuthenticateOidcConfigProperty.OnUnauthenticatedRequest.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-onunauthenticatedrequest

Return type

Optional[str]

scope

CfnListener.AuthenticateOidcConfigProperty.Scope.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-scope

Return type

Optional[str]

CfnListener.AuthenticateOidcConfigProperty.SessionCookieName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-sessioncookiename

Return type

Optional[str]

session_timeout

CfnListener.AuthenticateOidcConfigProperty.SessionTimeout.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-sessiontimeout

Return type

Optional[str]

token_endpoint

CfnListener.AuthenticateOidcConfigProperty.TokenEndpoint.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-tokenendpoint

Return type

str

user_info_endpoint

CfnListener.AuthenticateOidcConfigProperty.UserInfoEndpoint.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-userinfoendpoint

Return type

str

CertificateProperty

class CfnListener.CertificateProperty(*, certificate_arn=None)

Bases: object

Parameters

certificate_arn (Optional[str]) – CfnListener.CertificateProperty.CertificateArn.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-certificate.html

Attributes

certificate_arn

CfnListener.CertificateProperty.CertificateArn.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-certificate.html#cfn-elasticloadbalancingv2-listener-certificate-certificatearn

Return type

Optional[str]

FixedResponseConfigProperty

class CfnListener.FixedResponseConfigProperty(*, status_code, content_type=None, message_body=None)

Bases: object

Parameters
  • status_code (str) – CfnListener.FixedResponseConfigProperty.StatusCode.

  • content_type (Optional[str]) – CfnListener.FixedResponseConfigProperty.ContentType.

  • message_body (Optional[str]) – CfnListener.FixedResponseConfigProperty.MessageBody.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-fixedresponseconfig.html

Attributes

content_type

CfnListener.FixedResponseConfigProperty.ContentType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listener-fixedresponseconfig-contenttype

Return type

Optional[str]

message_body

CfnListener.FixedResponseConfigProperty.MessageBody.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listener-fixedresponseconfig-messagebody

Return type

Optional[str]

status_code

CfnListener.FixedResponseConfigProperty.StatusCode.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listener-fixedresponseconfig-statuscode

Return type

str

ForwardConfigProperty

class CfnListener.ForwardConfigProperty(*, target_groups=None, target_group_stickiness_config=None)

Bases: object

Parameters
See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-forwardconfig.html

Attributes

target_group_stickiness_config

CfnListener.ForwardConfigProperty.TargetGroupStickinessConfig.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-forwardconfig.html#cfn-elasticloadbalancingv2-listener-forwardconfig-targetgroupstickinessconfig

Return type

Union[IResolvable, TargetGroupStickinessConfigProperty, None]

target_groups

CfnListener.ForwardConfigProperty.TargetGroups.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-forwardconfig.html#cfn-elasticloadbalancingv2-listener-forwardconfig-targetgroups

Return type

Union[IResolvable, List[Union[IResolvable, TargetGroupTupleProperty]], None]

RedirectConfigProperty

class CfnListener.RedirectConfigProperty(*, status_code, host=None, path=None, port=None, protocol=None, query=None)

Bases: object

Parameters
  • status_code (str) – CfnListener.RedirectConfigProperty.StatusCode.

  • host (Optional[str]) – CfnListener.RedirectConfigProperty.Host.

  • path (Optional[str]) – CfnListener.RedirectConfigProperty.Path.

  • port (Optional[str]) – CfnListener.RedirectConfigProperty.Port.

  • protocol (Optional[str]) – CfnListener.RedirectConfigProperty.Protocol.

  • query (Optional[str]) – CfnListener.RedirectConfigProperty.Query.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html

Attributes

host

CfnListener.RedirectConfigProperty.Host.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-host

Return type

Optional[str]

path

CfnListener.RedirectConfigProperty.Path.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-path

Return type

Optional[str]

port

CfnListener.RedirectConfigProperty.Port.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-port

Return type

Optional[str]

protocol

CfnListener.RedirectConfigProperty.Protocol.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-protocol

Return type

Optional[str]

query

CfnListener.RedirectConfigProperty.Query.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-query

Return type

Optional[str]

status_code

CfnListener.RedirectConfigProperty.StatusCode.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-statuscode

Return type

str

TargetGroupStickinessConfigProperty

class CfnListener.TargetGroupStickinessConfigProperty(*, duration_seconds=None, enabled=None)

Bases: object

Parameters
  • duration_seconds (Union[int, float, None]) – CfnListener.TargetGroupStickinessConfigProperty.DurationSeconds.

  • enabled (Union[bool, IResolvable, None]) – CfnListener.TargetGroupStickinessConfigProperty.Enabled.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-targetgroupstickinessconfig.html

Attributes

duration_seconds

CfnListener.TargetGroupStickinessConfigProperty.DurationSeconds.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-targetgroupstickinessconfig.html#cfn-elasticloadbalancingv2-listener-targetgroupstickinessconfig-durationseconds

Return type

Union[int, float, None]

enabled

CfnListener.TargetGroupStickinessConfigProperty.Enabled.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-targetgroupstickinessconfig.html#cfn-elasticloadbalancingv2-listener-targetgroupstickinessconfig-enabled

Return type

Union[bool, IResolvable, None]

TargetGroupTupleProperty

class CfnListener.TargetGroupTupleProperty(*, target_group_arn=None, weight=None)

Bases: object

Parameters
  • target_group_arn (Optional[str]) – CfnListener.TargetGroupTupleProperty.TargetGroupArn.

  • weight (Union[int, float, None]) – CfnListener.TargetGroupTupleProperty.Weight.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-targetgrouptuple.html

Attributes

target_group_arn

CfnListener.TargetGroupTupleProperty.TargetGroupArn.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-targetgrouptuple.html#cfn-elasticloadbalancingv2-listener-targetgrouptuple-targetgrouparn

Return type

Optional[str]

weight

CfnListener.TargetGroupTupleProperty.Weight.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-targetgrouptuple.html#cfn-elasticloadbalancingv2-listener-targetgrouptuple-weight

Return type

Union[int, float, None]