CfnRoute
- class aws_cdk.aws_ec2.CfnRoute(scope, id, *, route_table_id, carrier_gateway_id=None, destination_cidr_block=None, destination_ipv6_cidr_block=None, egress_only_internet_gateway_id=None, gateway_id=None, instance_id=None, local_gateway_id=None, nat_gateway_id=None, network_interface_id=None, transit_gateway_id=None, vpc_endpoint_id=None, vpc_peering_connection_id=None)
Bases:
CfnResourceA CloudFormation
AWS::EC2::Route.Specifies a route in a route table.
You must specify either
DestinationCidrBlockorDestinationIpv6CidrBlock, plus the ID of one of the target resources.If you create a route that references a transit gateway in the same template where you create the transit gateway, you must declare a dependency on the transit gateway attachment. The route table cannot use the transit gateway until it has successfully attached to the VPC. Add a DependsOn Attribute in the
AWS::EC2::Routeresource to explicitly declare a dependency on theAWS::EC2::TransitGatewayAttachmentresource.- CloudformationResource:
AWS::EC2::Route
- Link:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.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_ec2 as ec2 cfn_route = ec2.CfnRoute(self, "MyCfnRoute", route_table_id="routeTableId", # the properties below are optional carrier_gateway_id="carrierGatewayId", destination_cidr_block="destinationCidrBlock", destination_ipv6_cidr_block="destinationIpv6CidrBlock", egress_only_internet_gateway_id="egressOnlyInternetGatewayId", gateway_id="gatewayId", instance_id="instanceId", local_gateway_id="localGatewayId", nat_gateway_id="natGatewayId", network_interface_id="networkInterfaceId", transit_gateway_id="transitGatewayId", vpc_endpoint_id="vpcEndpointId", vpc_peering_connection_id="vpcPeeringConnectionId" )
Create a new
AWS::EC2::Route.- Parameters:
scope (
Construct) –scope in which this resource is defined.
id (
str) –scoped id of the resource.
route_table_id (
str) – The ID of the route table for the route.carrier_gateway_id (
Optional[str]) – The ID of the carrier gateway. You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.destination_cidr_block (
Optional[str]) – The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify100.68.0.18/18, we modify it to100.68.0.0/18.destination_ipv6_cidr_block (
Optional[str]) – The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.egress_only_internet_gateway_id (
Optional[str]) – [IPv6 traffic only] The ID of an egress-only internet gateway.gateway_id (
Optional[str]) – The ID of an internet gateway or virtual private gateway attached to your VPC.instance_id (
Optional[str]) – The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.local_gateway_id (
Optional[str]) – The ID of the local gateway.nat_gateway_id (
Optional[str]) – [IPv4 traffic only] The ID of a NAT gateway.network_interface_id (
Optional[str]) – The ID of a network interface.transit_gateway_id (
Optional[str]) – The ID of a transit gateway.vpc_endpoint_id (
Optional[str]) – The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.vpc_peering_connection_id (
Optional[str]) – The ID of a VPC peering connection.
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
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
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::EC2::Route'
- carrier_gateway_id
The ID of the carrier gateway.
You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.
- 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.
- destination_cidr_block
The IPv4 CIDR address block used for the destination match.
Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify
100.68.0.18/18, we modify it to100.68.0.0/18.
- destination_ipv6_cidr_block
The IPv6 CIDR block used for the destination match.
Routing decisions are based on the most specific match.
- egress_only_internet_gateway_id
[IPv6 traffic only] The ID of an egress-only internet gateway.
- gateway_id
The ID of an internet gateway or virtual private gateway attached to your VPC.
- instance_id
The ID of a NAT instance in your VPC.
The operation fails if you specify an instance ID unless exactly one network interface is attached.
- local_gateway_id
The ID of the local gateway.
- 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.
- nat_gateway_id
[IPv4 traffic only] The ID of a NAT gateway.
- network_interface_id
The ID of a network interface.
- node
The construct tree node associated with this construct.
- 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 }).
- route_table_id
The ID of the route table for the route.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- transit_gateway_id
The ID of a transit gateway.
- vpc_endpoint_id
The ID of a VPC endpoint.
Supported for Gateway Load Balancer endpoints only.
- vpc_peering_connection_id
The ID of a VPC peering connection.
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