CfnListener
- class aws_cdk.aws_vpclattice.CfnListener(scope, id, *, default_action, protocol, name=None, port=None, service_identifier=None, tags=None)
Bases:
CfnResourceA CloudFormation
AWS::VpcLattice::Listener.Creates a listener for a service. Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide .
- CloudformationResource:
AWS::VpcLattice::Listener
- Link:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_vpclattice as vpclattice cfn_listener = vpclattice.CfnListener(self, "MyCfnListener", default_action=vpclattice.CfnListener.DefaultActionProperty( fixed_response=vpclattice.CfnListener.FixedResponseProperty( status_code=123 ), forward=vpclattice.CfnListener.ForwardProperty( target_groups=[vpclattice.CfnListener.WeightedTargetGroupProperty( target_group_identifier="targetGroupIdentifier", # the properties below are optional weight=123 )] ) ), protocol="protocol", # the properties below are optional name="name", port=123, service_identifier="serviceIdentifier", tags=[CfnTag( key="key", value="value" )] )
Create a new
AWS::VpcLattice::Listener.- Parameters:
scope (
Construct) –scope in which this resource is defined.
id (
str) –scoped id of the resource.
default_action (
Union[IResolvable,DefaultActionProperty,Dict[str,Any]]) – The action for the default rule. Each listener has a default rule. Each rule consists of a priority, one or more actions, and one or more conditions. The default rule is the rule that’s used if no other rules match. Each rule must include exactly one of the following types of actions:forwardorfixed-response, and it must be the last action to be performed.protocol (
str) – The listener protocol HTTP or HTTPS.name (
Optional[str]) – The name of the listener. A listener name must be unique within a service. The valid characters are a-z, 0-9, and hyphens (-). You can’t use a hyphen as the first or last character, or immediately after another hyphen. If you don’t specify a name, CloudFormation generates one. However, if you specify a name, and later want to replace the resource, you must specify a new name.port (
Union[int,float,None]) – The listener port. You can specify a value from1to65535. For HTTP, the default is80. For HTTPS, the default is443.service_identifier (
Optional[str]) – The ID or Amazon Resource Name (ARN) of the service.tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – The tags for the listener.
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:
- Return type:
None
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.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “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:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
valueargument toaddOverridewill not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- 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.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).- Parameters:
policy (
Optional[RemovalPolicy]) –apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
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:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str) –- See:
- Return type:
Any
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.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) –tree inspector to collect and process attributes.
- 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::VpcLattice::Listener'
- attr_arn
The Amazon Resource Name (ARN) of the listener.
- CloudformationAttribute:
Arn
- attr_id
The ID of the listener.
- CloudformationAttribute:
Id
- attr_service_arn
The Amazon Resource Name (ARN) of the service.
- CloudformationAttribute:
ServiceArn
- attr_service_id
The ID of the service.
- CloudformationAttribute:
ServiceId
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- 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.
- default_action
The action for the default rule.
Each listener has a default rule. Each rule consists of a priority, one or more actions, and one or more conditions. The default rule is the rule that’s used if no other rules match. Each rule must include exactly one of the following types of actions:
forwardorfixed-response, and it must be the last action to be performed.
- 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).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
The name of the listener.
A listener name must be unique within a service. The valid characters are a-z, 0-9, and hyphens (-). You can’t use a hyphen as the first or last character, or immediately after another hyphen.
If you don’t specify a name, CloudFormation generates one. However, if you specify a name, and later want to replace the resource, you must specify a new name.
- node
The construct tree node associated with this construct.
- port
The listener port.
You can specify a value from
1to65535. For HTTP, the default is80. For HTTPS, the default is443.
- protocol
The listener protocol HTTP or HTTPS.
- 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 }).
- service_identifier
The ID or Amazon Resource Name (ARN) of the service.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
The tags for the listener.
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto 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
DefaultActionProperty
- class CfnListener.DefaultActionProperty(*, fixed_response=None, forward=None)
Bases:
objectThe action for the default rule.
Each listener has a default rule. Each rule consists of a priority, one or more actions, and one or more conditions. The default rule is the rule that’s used if no other rules match. Each rule must include exactly one of the following types of actions:
forwardorfixed-response, and it must be the last action to be performed.- Parameters:
fixed_response (
Union[IResolvable,FixedResponseProperty,Dict[str,Any],None]) – Information about an action that returns a custom HTTP response.forward (
Union[IResolvable,ForwardProperty,Dict[str,Any],None]) – Describes a forward action. You can use forward actions to route requests to one or more target groups.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_vpclattice as vpclattice default_action_property = vpclattice.CfnListener.DefaultActionProperty( fixed_response=vpclattice.CfnListener.FixedResponseProperty( status_code=123 ), forward=vpclattice.CfnListener.ForwardProperty( target_groups=[vpclattice.CfnListener.WeightedTargetGroupProperty( target_group_identifier="targetGroupIdentifier", # the properties below are optional weight=123 )] ) )
Attributes
- fixed_response
Information about an action that returns a custom HTTP response.
- forward
Describes a forward action.
You can use forward actions to route requests to one or more target groups.
FixedResponseProperty
- class CfnListener.FixedResponseProperty(*, status_code)
Bases:
objectInformation about an action that returns a custom HTTP response.
- Parameters:
status_code (
Union[int,float]) – The HTTP response code.- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_vpclattice as vpclattice fixed_response_property = vpclattice.CfnListener.FixedResponseProperty( status_code=123 )
Attributes
- status_code
The HTTP response code.
ForwardProperty
- class CfnListener.ForwardProperty(*, target_groups)
Bases:
objectThe forward action.
Traffic that matches the rule is forwarded to the specified target groups.
- Parameters:
target_groups (
Union[IResolvable,Sequence[Union[IResolvable,WeightedTargetGroupProperty,Dict[str,Any]]]]) – The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic. The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of traffic will go to that target group.- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_vpclattice as vpclattice forward_property = vpclattice.CfnListener.ForwardProperty( target_groups=[vpclattice.CfnListener.WeightedTargetGroupProperty( target_group_identifier="targetGroupIdentifier", # the properties below are optional weight=123 )] )
Attributes
- target_groups
The target groups.
Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.
The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of traffic will go to that target group.
WeightedTargetGroupProperty
- class CfnListener.WeightedTargetGroupProperty(*, target_group_identifier, weight=None)
Bases:
objectDescribes the weight of a target group.
- Parameters:
target_group_identifier (
str) – The ID of the target group.weight (
Union[int,float,None]) – Only required if you specify multiple target groups for a forward action. The “weight” determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there’s only one target group specified, then the default value is 100.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_vpclattice as vpclattice weighted_target_group_property = vpclattice.CfnListener.WeightedTargetGroupProperty( target_group_identifier="targetGroupIdentifier", # the properties below are optional weight=123 )
Attributes
- target_group_identifier
The ID of the target group.
- weight
Only required if you specify multiple target groups for a forward action.
The “weight” determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there’s only one target group specified, then the default value is 100.