class CfnRoutePropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.EC2.Mixins.CfnRoutePropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsec2/mixins#CfnRoutePropsMixin
Java	software.amazon.awscdk.mixins.preview.services.ec2.mixins.CfnRoutePropsMixin
Python	aws_cdk.mixins_preview.aws_ec2.mixins.CfnRoutePropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_ec2 » mixins » CfnRoutePropsMixin

Implements IMixin

Extends Mixin

Specifies a route in a route table. For more information, see Routes in the Amazon VPC User Guide .

You must specify either a destination CIDR block or prefix list ID. You must also specify exactly one of the resources as the target.

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::Route resource to explicitly declare a dependency on the AWS::EC2::TransitGatewayAttachment resource.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as ec2_mixins } from '@aws-cdk/mixins-preview/aws-ec2';
const cfnRoutePropsMixin = new ec2_mixins.CfnRoutePropsMixin({
  carrierGatewayId: 'carrierGatewayId',
  coreNetworkArn: 'coreNetworkArn',
  destinationCidrBlock: 'destinationCidrBlock',
  destinationIpv6CidrBlock: 'destinationIpv6CidrBlock',
  destinationPrefixListId: 'destinationPrefixListId',
  egressOnlyInternetGatewayId: 'egressOnlyInternetGatewayId',
  gatewayId: 'gatewayId',
  instanceId: 'instanceId',
  localGatewayId: 'localGatewayId',
  natGatewayId: 'natGatewayId',
  networkInterfaceId: 'networkInterfaceId',
  routeTableId: 'routeTableId',
  transitGatewayId: 'transitGatewayId',
  vpcEndpointId: 'vpcEndpointId',
  vpcPeeringConnectionId: 'vpcPeeringConnectionId',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnRoutePropsMixin(props: CfnRouteMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnRouteMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::EC2::Route.

Properties

Name	Type	Description
props	CfnRouteMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnRouteMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.