@aws-cdk/aws-ec2

@aws-cdk/aws-ec2

Version 1.204.0
Published 2 years ago
15.4 MB
12 dependencies
Apache-2.0 license

Install

npm i @aws-cdk/aws-ec2

yarn add @aws-cdk/aws-ec2

pnpm add @aws-cdk/aws-ec2

Overview

The CDK Construct Library for AWS::EC2

Index

Variables

variable RESERVED_TUNNEL_INSIDE_CIDR

const RESERVED_TUNNEL_INSIDE_CIDR: string[];

Classes

class AclCidr

abstract class AclCidr {}

Either an IPv4 or an IPv6 CIDR

method anyIpv4

static anyIpv4: () => AclCidr;

The CIDR containing all IPv4 addresses (i.e., 0.0.0.0/0)

method anyIpv6

static anyIpv6: () => AclCidr;

The CIDR containing all IPv6 addresses (i.e., ::/0)

method ipv4

static ipv4: (ipv4Cidr: string) => AclCidr;

An IP network range in CIDR notation (for example, 172.16.0.0/24).

method ipv6

static ipv6: (ipv6Cidr: string) => AclCidr;

An IPv6 network range in CIDR notation (for example, 2001:db8::/48)

method toCidrConfig

abstract toCidrConfig: () => AclCidrConfig;

class AclTraffic

abstract class AclTraffic {}

The traffic that is configured using a Network ACL entry

method allTraffic

static allTraffic: () => AclTraffic;

Apply the ACL entry to all traffic

method icmp

static icmp: (props: AclIcmp) => AclTraffic;

Apply the ACL entry to ICMP traffic of given type and code

method icmpv6

static icmpv6: (props: AclIcmp) => AclTraffic;

Apply the ACL entry to ICMPv6 traffic of given type and code
Requires an IPv6 CIDR block.

method tcpPort

static tcpPort: (port: number) => AclTraffic;

Apply the ACL entry to TCP traffic on a given port

method tcpPortRange

static tcpPortRange: (startPort: number, endPort: number) => AclTraffic;

Apply the ACL entry to TCP traffic on a given port range

method toTrafficConfig

abstract toTrafficConfig: () => AclTrafficConfig;

method udpPort

static udpPort: (port: number) => AclTraffic;

Apply the ACL entry to UDP traffic on a given port

method udpPortRange

static udpPortRange: (startPort: number, endPort: number) => AclTraffic;

Apply the ACL entry to UDP traffic on a given port range

class AmazonLinuxImage

class AmazonLinuxImage extends GenericSSMParameterImage {}

Selects the latest version of Amazon Linux
This Machine Image automatically updates to the latest version on every deployment. Be aware this will cause your instances to be replaced when a new version of the image becomes available. Do not store stateful information on the instance if you are using this image.
The AMI ID is selected using the values published to the SSM parameter store.

constructor

constructor(props?: AmazonLinuxImageProps);

method getImage

getImage: (scope: Construct) => MachineImageConfig;

Return the image to use in the given context

method ssmParameterName

static ssmParameterName: (props?: AmazonLinuxImageProps) => string;

Return the SSM parameter name that will contain the Amazon Linux image with the given attributes

class BastionHostLinux

class BastionHostLinux extends Resource implements IInstance {}

This creates a linux bastion host you can use to connect to other instances or services in your VPC. The recommended way to connect to the bastion host is by using AWS Systems Manager Session Manager.
The operating system is Amazon Linux 2 with the latest SSM agent installed
You can also configure this bastion host to allow connections via SSH
AWS::EC2::Instance

constructor

constructor(scope: Construct, id: string, props: BastionHostLinuxProps);

property connections

readonly connections: Connections;

Allows specify security group connections for the instance.

property grantPrincipal

readonly grantPrincipal: IPrincipal;

The principal to grant permissions to

property instance

readonly instance: Instance;

The underlying instance resource

property instanceAvailabilityZone

readonly instanceAvailabilityZone: string;

property instanceId

readonly instanceId: string;

property instancePrivateDnsName

readonly instancePrivateDnsName: string;

property instancePrivateIp

readonly instancePrivateIp: string;

property instancePublicDnsName

readonly instancePublicDnsName: string;

property instancePublicIp

readonly instancePublicIp: string;

property role

readonly role: IRole;

The IAM role assumed by the instance.

property stack

readonly stack: Stack;

method allowSshAccessFrom

allowSshAccessFrom: (...peer: IPeer[]) => void;

Allow SSH access from the given peer or peers
Necessary if you want to connect to the instance using ssh. If not called, you should use SSM Session Manager to connect to the instance.

class BlockDeviceVolume

class BlockDeviceVolume {}

Describes a block device mapping for an EC2 instance or Auto Scaling group.

constructor

protected constructor(ebsDevice?: EbsDeviceProps, virtualName?: string);

Parameter ebsDevice
EBS device info
Parameter virtualName
Virtual device name

property ebsDevice

readonly ebsDevice?: EbsDeviceProps;

property virtualName

readonly virtualName?: string;

method ebs

static ebs: (
    volumeSize: number,
    options?: EbsDeviceOptions
) => BlockDeviceVolume;

Creates a new Elastic Block Storage device
Parameter volumeSize
The volume size, in Gibibytes (GiB)
Parameter options
additional device options

method ebsFromSnapshot

static ebsFromSnapshot: (
    snapshotId: string,
    options?: EbsDeviceSnapshotOptions
) => BlockDeviceVolume;

Creates a new Elastic Block Storage device from an existing snapshot
Parameter snapshotId
The snapshot ID of the volume to use
Parameter options
additional device options

method ephemeral

static ephemeral: (volumeIndex: number) => BlockDeviceVolume;

Creates a virtual, ephemeral device. The name will be in the form ephemeral{volumeIndex}.
Parameter volumeIndex
the volume index. Must be equal or greater than 0

class CfnCapacityReservation

class CfnCapacityReservation extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::CapacityReservation
Creates a new Capacity Reservation with the specified attributes. For more information, see [Capacity Reservations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html) in the *Amazon EC2 User Guide* .
AWS::EC2::CapacityReservation external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnCapacityReservationProps
);

Create a new AWS::EC2::CapacityReservation.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrAvailabilityZone

readonly attrAvailabilityZone: string;

Returns the Availability Zone in which the capacity is reserved. For example: us-east-1a . AvailabilityZone

property attrAvailableInstanceCount

readonly attrAvailableInstanceCount: number;

Returns the remaining capacity, which indicates the number of instances that can be launched in the Capacity Reservation. For example: 9 . AvailableInstanceCount

property attrId

readonly attrId: string;

The ID of the Capacity Reservation. Id

property attrInstanceType

readonly attrInstanceType: string;

Returns the type of instance for which the capacity is reserved. For example: m4.large . InstanceType

property attrTenancy

readonly attrTenancy: string;

Returns the tenancy of the Capacity Reservation. For example: dedicated . Tenancy

property attrTotalInstanceCount

readonly attrTotalInstanceCount: number;

Returns the total number of instances for which the Capacity Reservation reserves capacity. For example: 15 . TotalInstanceCount

property availabilityZone

availabilityZone: string;

The Availability Zone in which to create the Capacity Reservation.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-availabilityzone

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property ebsOptimized

ebsOptimized: any;

Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-ebsoptimized

property endDate

endDate: string;

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
You must provide an EndDate value if EndDateType is limited . Omit EndDate if EndDateType is unlimited .
If the EndDateType is limited , the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-enddate

property endDateType

endDateType: string;

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
- unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited . - limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-enddatetype

property ephemeralStorage

ephemeralStorage: any;

*Deprecated.*
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-ephemeralstorage

property instanceCount

instanceCount: number;

The number of instances for which to reserve capacity.
Valid range: 1 - 1000
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-instancecount

property instanceMatchCriteria

instanceMatchCriteria: string;

Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
- open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters. - targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
Default: open
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-instancematchcriteria

property instancePlatform

instancePlatform: string;

The type of operating system for which to reserve capacity.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-instanceplatform

property instanceType

instanceType: string;

The instance type for which to reserve capacity. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-instancetype

property outPostArn

outPostArn: string;

The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-outpostarn

property placementGroupArn

placementGroupArn: string;

The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation. For more information, see [Capacity Reservations for cluster placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-cpg.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-placementgrouparn

property tagSpecifications

tagSpecifications: any;

The tags to apply to the Capacity Reservation during launch.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-tagspecifications

property tenancy

tenancy: string;

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
- default - The Capacity Reservation is created on hardware that is shared with other AWS accounts . - dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-tenancy

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnCapacityReservationFleet

class CfnCapacityReservationFleet
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::CapacityReservationFleet
Creates a new Capacity Reservation Fleet with the specified attributes. For more information, see [Capacity Reservation Fleets](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-fleets.html) in the *Amazon EC2 User Guide* .
AWS::EC2::CapacityReservationFleet external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props?: CfnCapacityReservationFleetProps
);

Create a new AWS::EC2::CapacityReservationFleet.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property allocationStrategy

allocationStrategy: string;

The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use. Currently, only the prioritized allocation strategy is supported. For more information, see [Allocation strategy](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#allocation-strategy) in the Amazon EC2 User Guide.
Valid values: prioritized
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-allocationstrategy

property attrCapacityReservationFleetId

readonly attrCapacityReservationFleetId: string;

The ID of the Capacity Reservation Fleet. CapacityReservationFleetId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property endDate

endDate: string;

The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes to expired and all of the Capacity Reservations in the Fleet expire.
The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify 5/31/2019 , 13:30:55 , the Capacity Reservation Fleet is guaranteed to expire between 13:30:55 and 14:30:55 on 5/31/2019 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-enddate

property instanceMatchCriteria

instanceMatchCriteria: string;

Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.
Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-instancematchcriteria

property instanceTypeSpecifications

instanceTypeSpecifications: any;

Information about the instance types for which to reserve the capacity.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-instancetypespecifications

property noRemoveEndDate

noRemoveEndDate: any;

Used to add an end date to a Capacity Reservation Fleet that has no end date and time. To add an end date to a Capacity Reservation Fleet, specify true for this paramater and specify the end date and time (in UTC time format) for the *EndDate* parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-noremoveenddate

property removeEndDate

removeEndDate: any;

Used to remove an end date from a Capacity Reservation Fleet that is configured to end automatically at a specific date and time. To remove the end date from a Capacity Reservation Fleet, specify true for this paramater and omit the *EndDate* parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-removeenddate

property tagSpecifications

tagSpecifications: any;

The tags to assign to the Capacity Reservation Fleet. The tags are automatically assigned to the Capacity Reservations in the Fleet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-tagspecifications

property tenancy

tenancy: string;

Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings:
- default - The Capacity Reservation Fleet is created on hardware that is shared with other AWS accounts . - dedicated - The Capacity Reservations are created on single-tenant hardware that is dedicated to a single AWS account .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-tenancy

property totalTargetCapacity

totalTargetCapacity: number;

The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, together with the instance type weights that you assign to each instance type used by the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see [Total target capacity](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity) in the Amazon EC2 User Guide.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-totaltargetcapacity

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnCarrierGateway

class CfnCarrierGateway extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::CarrierGateway
Creates a carrier gateway. For more information about carrier gateways, see [Carrier gateways](https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#wavelength-carrier-gateway) in the *AWS Wavelength Developer Guide* .
AWS::EC2::CarrierGateway external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-carriergateway.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnCarrierGatewayProps);

Create a new AWS::EC2::CarrierGateway.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrCarrierGatewayId

readonly attrCarrierGatewayId: string;

The ID of the carrier gateway. CarrierGatewayId

property attrOwnerId

readonly attrOwnerId: string;

The AWS account ID of the owner of the carrier gateway. OwnerId

property attrState

readonly attrState: string;

The state of the carrier gateway. State

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property tags

readonly tags: cdk.TagManager;

The tags assigned to the carrier gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-carriergateway.html#cfn-ec2-carriergateway-tags

property vpcId

vpcId: string;

The ID of the VPC associated with the carrier gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-carriergateway.html#cfn-ec2-carriergateway-vpcid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnClientVpnAuthorizationRule

class CfnClientVpnAuthorizationRule
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::ClientVpnAuthorizationRule
Specifies an ingress authorization rule to add to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in AWS or on-premises networks.
AWS::EC2::ClientVpnAuthorizationRule external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnClientVpnAuthorizationRuleProps
);

Create a new AWS::EC2::ClientVpnAuthorizationRule.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property accessGroupId

accessGroupId: string;

The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group. Required if AuthorizeAllGroups is false or not specified.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-accessgroupid

property authorizeAllGroups

authorizeAllGroups: any;

Indicates whether to grant access to all clients. Specify true to grant all clients who successfully establish a VPN connection access to the network. Must be set to true if AccessGroupId is not specified.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-authorizeallgroups

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property clientVpnEndpointId

clientVpnEndpointId: string;

The ID of the Client VPN endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-clientvpnendpointid

property description

description: string;

A brief description of the authorization rule.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-description

property targetNetworkCidr

targetNetworkCidr: string;

The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-targetnetworkcidr

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnClientVpnEndpoint

class CfnClientVpnEndpoint extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::ClientVpnEndpoint
Specifies a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.
AWS::EC2::ClientVpnEndpoint external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnClientVpnEndpointProps);

Create a new AWS::EC2::ClientVpnEndpoint.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property authenticationOptions

authenticationOptions: any;

Information about the authentication method to be used to authenticate clients.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-authenticationoptions

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property clientCidrBlock

clientCidrBlock: string;

The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. Client CIDR range must have a size of at least /22 and must not be greater than /12.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientcidrblock

property clientConnectOptions

clientConnectOptions: any;

The options for managing connection authorization for new client connections.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientconnectoptions

property clientLoginBannerOptions

clientLoginBannerOptions: any;

Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientloginbanneroptions

property connectionLogOptions

connectionLogOptions: any;

Information about the client connection logging options.
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
- Client connection requests - Client connection results (successful and unsuccessful) - Reasons for unsuccessful client connection requests - Client connection termination time
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-connectionlogoptions

property description

description: string;

A brief description of the Client VPN endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-description

property dnsServers

dnsServers: string[];

Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-dnsservers

property securityGroupIds

securityGroupIds: string[];

The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-securitygroupids

property selfServicePortal

selfServicePortal: string;

Specify whether to enable the self-service portal for the Client VPN endpoint.
Default Value: enabled
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-selfserviceportal

property serverCertificateArn

serverCertificateArn: string;

The ARN of the server certificate. For more information, see the [AWS Certificate Manager User Guide](https://docs.aws.amazon.com/acm/latest/userguide/) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-servercertificatearn

property sessionTimeoutHours

sessionTimeoutHours: number;

The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-sessiontimeouthours

property splitTunnel

splitTunnel: any;

Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
By default, split-tunnel on a VPN endpoint is disabled.
For information about split-tunnel VPN endpoints, see [Split-tunnel AWS Client VPN endpoint](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html) in the *AWS Client VPN Administrator Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-splittunnel

property tagSpecifications

tagSpecifications: any;

The tags to apply to the Client VPN endpoint during creation.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-tagspecifications

property transportProtocol

transportProtocol: string;

The transport protocol to be used by the VPN session.
Default value: udp
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-transportprotocol

property vpcId

vpcId: string;

The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-vpcid

property vpnPort

vpnPort: number;

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 | 1194
Default Value: 443
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-vpnport

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnClientVpnRoute

class CfnClientVpnRoute extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::ClientVpnRoute
Specifies a network route to add to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.
A target network association must be created before you can specify a route. If you're setting up all the components of a Client VPN endpoint at the same time, you must use the [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the AWS::EC2::ClientVpnTargetNetworkAssociation resource.
AWS::EC2::ClientVpnRoute external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnClientVpnRouteProps);

Create a new AWS::EC2::ClientVpnRoute.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property clientVpnEndpointId

clientVpnEndpointId: string;

The ID of the Client VPN endpoint to which to add the route.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html#cfn-ec2-clientvpnroute-clientvpnendpointid

property description

description: string;

A brief description of the route.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html#cfn-ec2-clientvpnroute-description

property destinationCidrBlock

destinationCidrBlock: string;

The IPv4 address range, in CIDR notation, of the route destination. For example:
- To add a route for Internet access, enter 0.0.0.0/0 - To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range - To add a route for an on-premises network, enter the AWS Site-to-Site VPN connection's IPv4 CIDR range - To add a route for the local network, enter the client CIDR range
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html#cfn-ec2-clientvpnroute-destinationcidrblock

property targetVpcSubnetId

targetVpcSubnetId: string;

The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target network of the Client VPN endpoint.
Alternatively, if you're adding a route for the local network, specify local .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html#cfn-ec2-clientvpnroute-targetvpcsubnetid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnClientVpnTargetNetworkAssociation

class CfnClientVpnTargetNetworkAssociation
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::ClientVpnTargetNetworkAssociation
Specifies a target network to associate with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.
AWS::EC2::ClientVpnTargetNetworkAssociation external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpntargetnetworkassociation.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnClientVpnTargetNetworkAssociationProps
);

Create a new AWS::EC2::ClientVpnTargetNetworkAssociation.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property clientVpnEndpointId

clientVpnEndpointId: string;

The ID of the Client VPN endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpntargetnetworkassociation.html#cfn-ec2-clientvpntargetnetworkassociation-clientvpnendpointid

property subnetId

subnetId: string;

The ID of the subnet to associate with the Client VPN endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpntargetnetworkassociation.html#cfn-ec2-clientvpntargetnetworkassociation-subnetid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnCustomerGateway

class CfnCustomerGateway extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::CustomerGateway
Specifies a customer gateway.
AWS::EC2::CustomerGateway external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnCustomerGatewayProps);

Create a new AWS::EC2::CustomerGateway.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrCustomerGatewayId

readonly attrCustomerGatewayId: string;

The ID of the customer gateway. CustomerGatewayId

property bgpAsn

bgpAsn: number;

For devices that support BGP, the customer gateway's BGP ASN.
Default: 65000
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-bgpasn

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property deviceName

deviceName: string;

The name of customer gateway device.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-devicename

property ipAddress

ipAddress: string;

IPv4 address for the customer gateway device's outside interface. The address must be static.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-ipaddress

property tags

readonly tags: cdk.TagManager;

One or more tags for the customer gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-tags

property type

type: string;

The type of VPN connection that this customer gateway supports ( ipsec.1 ).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-type

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnDHCPOptions

class CfnDHCPOptions extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::DHCPOptions
Specifies a set of DHCP options for your VPC.
You must specify at least one of the following properties: DomainNameServers , NetbiosNameServers , NtpServers . If you specify NetbiosNameServers , you must specify NetbiosNodeType .
AWS::EC2::DHCPOptions external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html

constructor

constructor(scope: cdk.Construct, id: string, props?: CfnDHCPOptionsProps);

Create a new AWS::EC2::DHCPOptions.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrDhcpOptionsId

readonly attrDhcpOptionsId: string;

The ID of the DHCP options set. DhcpOptionsId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property domainName

domainName: string;

This value is used to complete unqualified DNS hostnames. If you're using AmazonProvidedDNS in us-east-1 , specify ec2.internal . If you're using AmazonProvidedDNS in another Region, specify *region* . compute.internal (for example, ap-northeast-1.compute.internal ). Otherwise, specify a domain name (for example, *MyCompany.com* ).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-domainname

property domainNameServers

domainNameServers: string[];

The IPv4 addresses of up to four domain name servers, or AmazonProvidedDNS . The default is AmazonProvidedDNS . To have your instance receive a custom DNS hostname as specified in DomainName , you must set this property to a custom DNS server.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-domainnameservers

property netbiosNameServers

netbiosNameServers: string[];

The IPv4 addresses of up to four NetBIOS name servers.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-netbiosnameservers

property netbiosNodeType

netbiosNodeType: number;

The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-netbiosnodetype

property ntpServers

ntpServers: string[];

The IPv4 addresses of up to four Network Time Protocol (NTP) servers.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-ntpservers

property tags

readonly tags: cdk.TagManager;

Any tags assigned to the DHCP options set.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnEC2Fleet

class CfnEC2Fleet extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::EC2Fleet
Specifies the configuration information to launch a fleet--or group--of instances. An EC2 Fleet can launch multiple instance types across multiple Availability Zones, using the On-Demand Instance, Reserved Instance, and Spot Instance purchasing models together. Using EC2 Fleet, you can define separate On-Demand and Spot capacity targets, specify the instance types that work best for your applications, and specify how Amazon EC2 should distribute your fleet capacity within each purchasing model. For more information, see [Launching an EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet.html) in the *Amazon EC2 User Guide for Linux Instances* .
AWS::EC2::EC2Fleet external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnEC2FleetProps);

Create a new AWS::EC2::EC2Fleet.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrFleetId

readonly attrFleetId: string;

The ID of the EC2 Fleet. FleetId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property context

context: string;

Reserved.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-context

property excessCapacityTerminationPolicy

excessCapacityTerminationPolicy: string;

Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
Supported only for fleets of type maintain .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-excesscapacityterminationpolicy

property launchTemplateConfigs

launchTemplateConfigs: any;

The configuration for the EC2 Fleet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-launchtemplateconfigs

property onDemandOptions

onDemandOptions: any;

Describes the configuration of On-Demand Instances in an EC2 Fleet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-ondemandoptions

property replaceUnhealthyInstances

replaceUnhealthyInstances: any;

Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type maintain . For more information, see [EC2 Fleet health checks](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#ec2-fleet-health-checks) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-replaceunhealthyinstances

property spotOptions

spotOptions: any;

Describes the configuration of Spot Instances in an EC2 Fleet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-spotoptions

property tagSpecifications

tagSpecifications: any;

The key-value pair for tagging the EC2 Fleet request on creation. For more information, see [Tagging your resources](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources) .
If the fleet type is instant , specify a resource type of fleet to tag the fleet or instance to tag the instances at launch.
If the fleet type is maintain or request , specify a resource type of fleet to tag the fleet. You cannot specify a resource type of instance . To tag instances at launch, specify the tags in a [launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-tagspecifications

property targetCapacitySpecification

targetCapacitySpecification: any;

The number of units to request.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-targetcapacityspecification

property terminateInstancesWithExpiration

terminateInstancesWithExpiration: any;

Indicates whether running instances should be terminated when the EC2 Fleet expires.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-terminateinstanceswithexpiration

property type

type: string;

The fleet type. The default value is maintain .
- maintain - The EC2 Fleet places an asynchronous request for your desired capacity, and continues to maintain your desired Spot capacity by replenishing interrupted Spot Instances. - request - The EC2 Fleet places an asynchronous one-time request for your desired capacity, but does submit Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not maintain Spot capacity if Spot Instances are interrupted. - instant - The EC2 Fleet places a synchronous one-time request for your desired capacity, and returns errors for any instances that could not be launched.
For more information, see [EC2 Fleet request types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-request-type.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-type

property validFrom

validFrom: string;

The start date and time of the request, in UTC format (for example, *YYYY* - *MM* - *DD* T *HH* : *MM* : *SS* Z). The default is to start fulfilling the request immediately.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-validfrom

property validUntil

validUntil: string;

The end date and time of the request, in UTC format (for example, *YYYY* - *MM* - *DD* T *HH* : *MM* : *SS* Z). At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-validuntil

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnEgressOnlyInternetGateway

class CfnEgressOnlyInternetGateway
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::EgressOnlyInternetGateway
[IPv6 only] Specifies an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance.
AWS::EC2::EgressOnlyInternetGateway external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-egressonlyinternetgateway.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnEgressOnlyInternetGatewayProps
);

Create a new AWS::EC2::EgressOnlyInternetGateway.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrId

readonly attrId: string;

The ID of the egress-only internet gateway. Id

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property vpcId

vpcId: string;

The ID of the VPC for which to create the egress-only internet gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-egressonlyinternetgateway.html#cfn-ec2-egressonlyinternetgateway-vpcid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnEIP

class CfnEIP extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::EIP
Specifies an Elastic IP (EIP) address and can, optionally, associate it with an Amazon EC2 instance.
You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see [Bring Your Own IP Addresses (BYOIP)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) in the *Amazon EC2 User Guide* .
For more information, see [Elastic IP Addresses](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) in the *Amazon EC2 User Guide* .
AWS::EC2::EIP external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html

constructor

constructor(scope: cdk.Construct, id: string, props?: CfnEIPProps);

Create a new AWS::EC2::EIP.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrAllocationId

readonly attrAllocationId: string;

The ID that AWS assigns to represent the allocation of the address for use with Amazon VPC. This is returned only for VPC elastic IP addresses. For example, eipalloc-5723d13e . AllocationId

property attrPublicIp

readonly attrPublicIp: string;

The Elastic IP address. PublicIp

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property domain

domain: string;

The network ( vpc ).
If you define an Elastic IP address and associate it with a VPC that is defined in the same template, you must declare a dependency on the VPC-gateway attachment by using the [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) on this resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-domain

property instanceId

instanceId: string;

The ID of the instance.
> Updates to the InstanceId property may require *some interruptions* . Updates on an EIP reassociates the address on its associated resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-instanceid

property networkBorderGroup

networkBorderGroup: string;

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.
Use [DescribeAvailabilityZones](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) to view the network border groups.
You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, you receive an InvalidParameterCombination error.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-networkbordergroup

property publicIpv4Pool

publicIpv4Pool: string;

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool.
> Updates to the PublicIpv4Pool property may require *some interruptions* . Updates on an EIP reassociates the address on its associated resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-publicipv4pool

property tags

readonly tags: cdk.TagManager;

Any tags assigned to the Elastic IP address.
> Updates to the Tags property may require *some interruptions* . Updates on an EIP reassociates the address on its associated resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-tags

property transferAddress

transferAddress: string;

The Elastic IP address you are accepting for transfer. You can only accept one transferred address. For more information on Elastic IP address transfers, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon Virtual Private Cloud User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-transferaddress

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnEIPAssociation

class CfnEIPAssociation extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::EIPAssociation
Associates an Elastic IP address with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account. For more information about working with Elastic IP addresses, see [Elastic IP address concepts and rules](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#vpc-eip-overview) .
You must specify AllocationId and either InstanceId , NetworkInterfaceId , or PrivateIpAddress .
AWS::EC2::EIPAssociation external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html

constructor

constructor(scope: cdk.Construct, id: string, props?: CfnEIPAssociationProps);

Create a new AWS::EC2::EIPAssociation.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property allocationId

allocationId: string;

The allocation ID. This is required.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-allocationid

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property eip

eip: string;

Deprecated.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-eip

property instanceId

instanceId: string;

The ID of the instance. The instance must have exactly one attached network interface. You can specify either the instance ID or the network interface ID, but not both.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-instanceid

property networkInterfaceId

networkInterfaceId: string;

The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
You can specify either the instance ID or the network interface ID, but not both.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-networkinterfaceid

property privateIpAddress

privateIpAddress: string;

The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-PrivateIpAddress

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnEnclaveCertificateIamRoleAssociation

class CfnEnclaveCertificateIamRoleAssociation
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::EnclaveCertificateIamRoleAssociation
Associates an AWS Identity and Access Management (IAM) role with an AWS Certificate Manager (ACM) certificate. This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more information, see [AWS Certificate Manager for Nitro Enclaves](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-refapp.html) in the *AWS Nitro Enclaves User Guide* .
When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted private key are placed in an Amazon S3 location that only the associated IAM role can access. The private key of the certificate is encrypted with an AWS managed key that has an attached attestation-based key policy.
To enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject on the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key, you must grant it permission to call kms:Decrypt on the KMS key returned by the command. For more information, see [Grant the role permission to access the certificate and encryption key](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-refapp.html#add-policy) in the *AWS Nitro Enclaves User Guide* .
AWS::EC2::EnclaveCertificateIamRoleAssociation external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-enclavecertificateiamroleassociation.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnEnclaveCertificateIamRoleAssociationProps
);

Create a new AWS::EC2::EnclaveCertificateIamRoleAssociation.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrCertificateS3BucketName

readonly attrCertificateS3BucketName: string;

The name of the Amazon S3 bucket to which the certificate was uploaded. CertificateS3BucketName

property attrCertificateS3ObjectKey

readonly attrCertificateS3ObjectKey: string;

The Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored. The object key is formatted as follows: role_arn / certificate_arn . CertificateS3ObjectKey

property attrEncryptionKmsKeyId

readonly attrEncryptionKmsKeyId: string;

The ID of the AWS KMS key used to encrypt the private key of the certificate. EncryptionKmsKeyId

property certificateArn

certificateArn: string;

The ARN of the ACM certificate with which to associate the IAM role.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-enclavecertificateiamroleassociation.html#cfn-ec2-enclavecertificateiamroleassociation-certificatearn

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property roleArn

roleArn: string;

The ARN of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM certificate.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-enclavecertificateiamroleassociation.html#cfn-ec2-enclavecertificateiamroleassociation-rolearn

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnFlowLog

class CfnFlowLog extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::FlowLog
Specifies a VPC flow log that captures IP traffic for a specified network interface, subnet, or VPC. To view the log data, use Amazon CloudWatch Logs (CloudWatch Logs) to help troubleshoot connection issues. For example, you can use a flow log to investigate why certain traffic isn't reaching an instance, which can help you diagnose overly restrictive security group rules. For more information, see [VPC Flow Logs](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html) in the *Amazon VPC User Guide* .
AWS::EC2::FlowLog external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnFlowLogProps);

Create a new AWS::EC2::FlowLog.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrId

readonly attrId: string;

The ID of the flow log. For example, fl-123456abc123abc1 . Id

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property deliverLogsPermissionArn

deliverLogsPermissionArn: string;

The ARN of the IAM role that allows Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.
This parameter is required if the destination type is cloud-watch-logs and unsupported otherwise.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-deliverlogspermissionarn

property destinationOptions

destinationOptions: any;

The destination options. The following options are supported:
- FileFormat - The format for the flow log ( plain-text | parquet ). The default is plain-text . - HiveCompatiblePartitions - Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3 ( true | false ). The default is false . - PerHourPartition - Indicates whether to partition the flow log per hour ( true | false ). The default is false .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-destinationoptions

property logDestination

logDestination: string;

The destination for the flow log data. The meaning of this parameter depends on the destination type.
- If the destination type is cloud-watch-logs , specify the ARN of a CloudWatch Logs log group. For example:
arn:aws:logs: *region* : *account_id* :log-group: *my_group*
Alternatively, use the LogGroupName parameter. - If the destination type is s3 , specify the ARN of an S3 bucket. For example:
arn:aws:s3::: *my_bucket* / *my_subfolder* /
The subfolder is optional. Note that you can't use AWSLogs as a subfolder name. - If the destination type is kinesis-data-firehose , specify the ARN of a Kinesis Data Firehose delivery stream. For example:
arn:aws:firehose: *region* : *account_id* :deliverystream: *my_stream*
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logdestination

property logDestinationType

logDestinationType: string;

The type of destination for the flow log data.
Default: cloud-watch-logs
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logdestinationtype

property logFormat

logFormat: string;

The fields to include in the flow log record, in the order in which they should appear. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must include at least one field. For more information about the available fields, see [Flow log records](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records) in the *Amazon VPC User Guide* or [Transit Gateway Flow Log records](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-flow-logs.html#flow-log-records) in the *AWS Transit Gateway Guide* .
Specify the fields using the ${field-id} format, separated by spaces.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logformat

property logGroupName

logGroupName: string;

The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
This parameter is valid only if the destination type is cloud-watch-logs .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-loggroupname

property maxAggregationInterval

maxAggregationInterval: number;

The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes). This parameter must be 60 seconds for transit gateway resource types.
When a network interface is attached to a [Nitro-based instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) , the aggregation interval is always 60 seconds or less, regardless of the value that you specify.
Default: 600
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-maxaggregationinterval

property resourceId

resourceId: string;

The ID of the resource to monitor. For example, if the resource type is VPC , specify the ID of the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-resourceid

property resourceType

resourceType: string;

The type of resource to monitor.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-resourcetype

property tags

readonly tags: cdk.TagManager;

The tags to apply to the flow logs.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-tags

property trafficType

trafficType: string;

The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic). This parameter is not supported for transit gateway resource types. It is required for the other resource types.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-traffictype

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnGatewayRouteTableAssociation

class CfnGatewayRouteTableAssociation
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::GatewayRouteTableAssociation
Associates a virtual private gateway or internet gateway with a route table. The gateway and route table must be in the same VPC. This association causes the incoming traffic to the gateway to be routed according to the routes in the route table.
AWS::EC2::GatewayRouteTableAssociation external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-gatewayroutetableassociation.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnGatewayRouteTableAssociationProps
);

Create a new AWS::EC2::GatewayRouteTableAssociation.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrAssociationId

readonly attrAssociationId: string;

The ID of the route table association. AssociationId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property gatewayId

gatewayId: string;

The ID of the gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-gatewayroutetableassociation.html#cfn-ec2-gatewayroutetableassociation-gatewayid

property routeTableId

routeTableId: string;

The ID of the route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-gatewayroutetableassociation.html#cfn-ec2-gatewayroutetableassociation-routetableid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnHost

class CfnHost extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::Host
Allocates a fully dedicated physical server for launching EC2 instances. Because the host is fully dedicated for your use, it can help you address compliance requirements and reduce costs by allowing you to use your existing server-bound software licenses. For more information, see [Dedicated Hosts](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-overview.html) in the *Amazon EC2 User Guide for Linux Instances* .
AWS::EC2::Host external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnHostProps);

Create a new AWS::EC2::Host.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrHostId

readonly attrHostId: string;

The ID of the host. HostId

property autoPlacement

autoPlacement: string;

Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see [Understanding auto-placement and affinity](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-understanding) in the *Amazon EC2 User Guide* .
Default: on
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-autoplacement

property availabilityZone

availabilityZone: string;

The Availability Zone in which to allocate the Dedicated Host.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-availabilityzone

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property hostMaintenance

hostMaintenance: string;

Indicates whether host maintenance is enabled or disabled for the Dedicated Host.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-hostmaintenance

property hostRecovery

hostRecovery: string;

Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see [Host recovery](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-recovery.html) in the *Amazon EC2 User Guide* .
Default: off
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-hostrecovery

property instanceFamily

instanceFamily: string;

The instance family supported by the Dedicated Host. For example, m5 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-instancefamily

property instanceType

instanceType: string;

Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-instancetype

property outpostArn

outpostArn: string;

The Amazon Resource Name (ARN) of the AWS Outpost on which the Dedicated Host is allocated.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-outpostarn

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnInstance

class CfnInstance extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::Instance
Specifies an EC2 instance.
If an Elastic IP address is attached to your instance, AWS CloudFormation reattaches the Elastic IP address after it updates the instance. For more information about updating stacks, see [AWS CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html) .
AWS::EC2::Instance external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html

constructor

constructor(scope: cdk.Construct, id: string, props?: CfnInstanceProps);

Create a new AWS::EC2::Instance.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property additionalInfo

additionalInfo: string;

This property is reserved for internal use. If you use it, the stack fails with this error: Bad property set: [Testing this property] (Service: AmazonEC2; Status Code: 400; Error Code: InvalidParameterCombination; Request ID: 0XXXXXX-49c7-4b40-8bcc-76885dcXXXXX) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-additionalinfo

property affinity

affinity: string;

Indicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host . If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-affinity

property attrAvailabilityZone

readonly attrAvailabilityZone: string;

The Availability Zone where the specified instance is launched. For example: us-east-1b .
You can retrieve a list of all Availability Zones for a Region by using the [Fn::GetAZs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getavailabilityzones.html) intrinsic function. AvailabilityZone

property attrPrivateDnsName

readonly attrPrivateDnsName: string;

The private DNS name of the specified instance. For example: ip-10-24-34-0.ec2.internal . PrivateDnsName

property attrPrivateIp

readonly attrPrivateIp: string;

The private IP address of the specified instance. For example: 10.24.34.0 . PrivateIp

property attrPublicDnsName

readonly attrPublicDnsName: string;

The public DNS name of the specified instance. For example: ec2-107-20-50-45.compute-1.amazonaws.com . PublicDnsName

property attrPublicIp

readonly attrPublicIp: string;

The public IP address of the specified instance. For example: 192.0.2.0 . PublicIp

property availabilityZone

availabilityZone: string;

The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported by [DescribeImageAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImageAttribute.html) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-availabilityzone

property blockDeviceMappings

blockDeviceMappings: any;

The block device mapping entries that defines the block devices to attach to the instance at launch.
By default, the block devices specified in the block device mapping for the AMI are used. You can override the AMI block device mapping using the instance block device mapping. For the root volume, you can override only the volume size, volume type, volume encryption settings, and the DeleteOnTermination setting.
> After the instance is running, you can modify only the DeleteOnTermination parameter for the attached volumes without interrupting the instance. Modifying any other parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-blockdevicemappings

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property cpuOptions

cpuOptions: any;

The CPU options for the instance. For more information, see [Optimize CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *Amazon Elastic Compute Cloud User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-cpuoptions

property creditSpecification

creditSpecification: any;

The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited . To change this attribute after launch, use [ModifyInstanceCreditSpecification](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceCreditSpecification.html) . For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide* .
Default: standard (T2 instances) or unlimited (T3/T3a/T4g instances)
For T3 instances with host tenancy, only standard is supported.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-creditspecification

property disableApiTermination

disableApiTermination: any;

If you set this parameter to true , you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use [ModifyInstanceAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html) . Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate , you can terminate the instance by running the shutdown command from the instance.
Default: false
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-disableapitermination

property ebsOptimized

ebsOptimized: any;

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ebsoptimized

property elasticGpuSpecifications

elasticGpuSpecifications: any;

An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see [Amazon EC2 Elastic GPUs](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-elasticgpuspecifications

property elasticInferenceAccelerators

elasticInferenceAccelerators: any;

An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
You cannot specify accelerators from different generations in the same request.
> Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-elasticinferenceaccelerators

property enclaveOptions

enclaveOptions: any;

Indicates whether the instance is enabled for AWS Nitro Enclaves.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-enclaveoptions

property hibernationOptions

hibernationOptions: any;

Indicates whether an instance is enabled for hibernation. For more information, see [Hibernate your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon EC2 User Guide* .
You can't enable hibernation and AWS Nitro Enclaves on the same instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-hibernationoptions

property hostId

hostId: string;

If you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account. This type of launch is called an untargeted launch. Note that for untargeted launches, you must have a compatible, dedicated host available to successfully launch instances.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-hostid

property hostResourceGroupArn

hostResourceGroupArn: string;

The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the *Tenancy* parameter or set it to host .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-hostresourcegrouparn

property iamInstanceProfile

iamInstanceProfile: string;

The name of an IAM instance profile. To create a new IAM instance profile, use the [AWS::IAM::InstanceProfile](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html) resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-iaminstanceprofile

property imageId

imageId: string;

The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-imageid

property instanceInitiatedShutdownBehavior

instanceInitiatedShutdownBehavior: string;

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-instanceinitiatedshutdownbehavior

property instanceType

instanceType: string;

The instance type. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide* .
Default: m1.small
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-instancetype

property ipv6AddressCount

ipv6AddressCount: number;

The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ipv6addresscount

property ipv6Addresses

ipv6Addresses: any;

The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ipv6addresses

property kernelId

kernelId: string;

The ID of the kernel.
> We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [PV-GRUB](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-kernelid

property keyName

keyName: string;

The name of the key pair. You can create a key pair using [CreateKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) or [ImportKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html) .
> If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-keyname

property launchTemplate

launchTemplate: any;

The launch template to use to launch the instances. Any parameters that you specify in the AWS CloudFormation template override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-launchtemplate

property licenseSpecifications

licenseSpecifications: any;

The license configurations.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-licensespecifications

property monitoring

monitoring: any;

Specifies whether detailed monitoring is enabled for the instance. Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled. For more information about detailed monitoring, see [Enable or turn off detailed monitoring for your instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-monitoring

property networkInterfaces

networkInterfaces: any;

The network interfaces to associate with the instance.
> If you use this property to point to a network interface, you must terminate the original interface before attaching a new one to allow the update of the instance to succeed. > > If this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the VPC-gateway attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-networkinterfaces

property placementGroupName

placementGroupName: string;

The name of an existing placement group that you want to launch the instance into (cluster | partition | spread).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-placementgroupname

property privateDnsNameOptions

privateDnsNameOptions: any;

The options for the instance hostname.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-privatednsnameoptions

property privateIpAddress

privateIpAddress: string;

The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.
You cannot specify this option and the network interfaces option in the same request.
If you make an update to an instance that requires replacement, you must assign a new private IP address. During a replacement, AWS CloudFormation creates a new instance but doesn't delete the old instance until the stack has successfully updated. If the stack update fails, AWS CloudFormation uses the old instance to roll back the stack to the previous working state. The old and new instances cannot have the same private IP address.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-privateipaddress

property propagateTagsToVolumeOnCreation

propagateTagsToVolumeOnCreation: any;

Indicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch. If you specify true and you assign tags to the instance, those tags are automatically assigned to all of the volumes that you attach to the instance at launch. If you specify false , those tags are not assigned to the attached volumes.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-propagatetagstovolumeoncreation

property ramdiskId

ramdiskId: string;

The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the AWS Resource Center and search for the kernel ID.
> We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [PV-GRUB](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ramdiskid

property securityGroupIds

securityGroupIds: string[];

The IDs of the security groups. You can specify the IDs of existing security groups and references to resources created by the stack template.
If you specify a network interface, you must specify any security groups as part of the network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-securitygroupids

property securityGroups

securityGroups: string[];

[Default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.
You cannot specify this option and the network interfaces option in the same request. The list can contain both the name of existing Amazon EC2 security groups or references to AWS::EC2::SecurityGroup resources created in the template.
Default: Amazon EC2 uses the default security group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-securitygroups

property sourceDestCheck

sourceDestCheck: any;

Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true , source/destination checks are enabled; otherwise, they are disabled. The default value is true . You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-sourcedestcheck

property ssmAssociations

ssmAssociations: any;

The SSM [document](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html) and parameter values in AWS Systems Manager to associate with this instance. To use this property, you must specify an IAM instance profile role for the instance. For more information, see [Create an IAM instance profile for Systems Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-configuring-access-role.html) in the *AWS Systems Manager User Guide* .
> You can currently associate only one document with an instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ssmassociations

property subnetId

subnetId: string;

The ID of the subnet to launch the instance into.
If you specify a network interface, you must specify any subnets as part of the network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-subnetid

property tags

readonly tags: cdk.TagManager;

The tags to add to the instance. These tags are not applied to the EBS volumes, such as the root volume, unless [PropagateTagsToVolumeOnCreation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-propagatetagstovolumeoncreation) is true .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-tags

property tenancy

tenancy: string;

The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-tenancy

property userData

userData: string;

The user data script to make available to the instance. User data is limited to 16 KB. You must provide base64-encoded text. For more information, see [Fn::Base64](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-base64.html) .
User data runs only at instance launch. For more information, see [Run commands on your Linux instance at launch](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) and [Run commands on your Windows instance at launch](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-windows-user-data.html) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-userdata

property volumes

volumes: any;

The volumes to attach to the instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-volumes

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnInternetGateway

class CfnInternetGateway extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::InternetGateway
Allocates an internet gateway for use with a VPC. After creating the Internet gateway, you then attach it to a VPC.
AWS::EC2::InternetGateway external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-internetgateway.html

constructor

constructor(scope: cdk.Construct, id: string, props?: CfnInternetGatewayProps);

Create a new AWS::EC2::InternetGateway.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrInternetGatewayId

readonly attrInternetGatewayId: string;

The ID of the internet gateway. InternetGatewayId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property tags

readonly tags: cdk.TagManager;

Any tags to assign to the internet gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-internetgateway.html#cfn-ec2-internetgateway-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnIPAM

class CfnIPAM extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::IPAM
IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts throughout your AWS Organization. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .
AWS::EC2::IPAM external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html

constructor

constructor(scope: cdk.Construct, id: string, props?: CfnIPAMProps);

Create a new AWS::EC2::IPAM.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrArn

readonly attrArn: string;

The ARN of the IPAM. Arn

property attrIpamId

readonly attrIpamId: string;

The ID of the IPAM. IpamId

property attrPrivateDefaultScopeId

readonly attrPrivateDefaultScopeId: string;

The ID of the default private scope. PrivateDefaultScopeId

property attrPublicDefaultScopeId

readonly attrPublicDefaultScopeId: string;

The ID of the default public scope. PublicDefaultScopeId

property attrResourceDiscoveryAssociationCount

readonly attrResourceDiscoveryAssociationCount: number;

The number of resource discovery associations. ResourceDiscoveryAssociationCount

property attrScopeCount

readonly attrScopeCount: number;

The number of scopes. ScopeCount

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property defaultResourceDiscoveryAssociationId

defaultResourceDiscoveryAssociationId: string;

The IPAM's default resource discovery association ID.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-defaultresourcediscoveryassociationid

property defaultResourceDiscoveryId

defaultResourceDiscoveryId: string;

The IPAM's default resource discovery ID.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-defaultresourcediscoveryid

property description

description: string;

The description for the IPAM.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-description

property operatingRegions

operatingRegions: any;

The operating Regions for an IPAM. Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions.
For more information about operating Regions, see [Create an IPAM](https://docs.aws.amazon.com//vpc/latest/ipam/create-ipam.html) in the *Amazon VPC IPAM User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-operatingregions

property tags

readonly tags: cdk.TagManager;

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA , specify tag:Owner for the filter name and TeamA for the filter value.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnIPAMAllocation

class CfnIPAMAllocation extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::IPAMAllocation
In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource.
AWS::EC2::IPAMAllocation external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnIPAMAllocationProps);

Create a new AWS::EC2::IPAMAllocation.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrIpamPoolAllocationId

readonly attrIpamPoolAllocationId: string;

The ID of an allocation. IpamPoolAllocationId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property cidr

cidr: string;

The CIDR you would like to allocate from the IPAM pool. Note the following:
- If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR. - If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
Possible values: Any available IPv4 or IPv6 CIDR.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html#cfn-ec2-ipamallocation-cidr

property description

description: string;

A description for the allocation.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html#cfn-ec2-ipamallocation-description

property ipamPoolId

ipamPoolId: string;

The ID of the IPAM pool from which you would like to allocate a CIDR.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html#cfn-ec2-ipamallocation-ipampoolid

property netmaskLength

netmaskLength: number;

The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:
- If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR. - If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html#cfn-ec2-ipamallocation-netmasklength

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnIPAMPool

class CfnIPAMPool extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::IPAMPool
In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.
AWS::EC2::IPAMPool external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnIPAMPoolProps);

Create a new AWS::EC2::IPAMPool.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property addressFamily

addressFamily: string;

The address family of the pool.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-addressfamily

property allocationDefaultNetmaskLength

allocationDefaultNetmaskLength: number;

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-allocationdefaultnetmasklength

property allocationMaxNetmaskLength

allocationMaxNetmaskLength: number;

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-allocationmaxnetmasklength

property allocationMinNetmaskLength

allocationMinNetmaskLength: number;

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-allocationminnetmasklength

property allocationResourceTags

allocationResourceTags: any;

Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-allocationresourcetags

property attrArn

readonly attrArn: string;

The ARN of the IPAM pool. Arn

property attrIpamArn

readonly attrIpamArn: string;

The ARN of the IPAM. IpamArn

property attrIpamPoolId

readonly attrIpamPoolId: string;

The ID of the IPAM pool. IpamPoolId

property attrIpamScopeArn

readonly attrIpamScopeArn: string;

The ARN of the scope of the IPAM pool. IpamScopeArn

property attrIpamScopeType

readonly attrIpamScopeType: string;

The scope of the IPAM. IpamScopeType

property attrPoolDepth

readonly attrPoolDepth: number;

The depth of pools in your IPAM pool. The pool depth quota is 10. PoolDepth

property attrState

readonly attrState: string;

The state of the IPAM pool. State

property attrStateMessage

readonly attrStateMessage: string;

A message related to the failed creation of an IPAM pool. StateMessage

property autoImport

autoImport: any;

If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-autoimport

property awsService

awsService: string;

Limits which service in AWS that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-awsservice

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property description

description: string;

The description of the IPAM pool.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-description

property ipamScopeId

ipamScopeId: string;

The ID of the scope in which you would like to create the IPAM pool.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-ipamscopeid

property locale

locale: string;

The locale of the IPAM pool. In IPAM, the locale is the AWS Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an AWS Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-locale

property provisionedCidrs

provisionedCidrs: any;

Information about the CIDRs provisioned to an IPAM pool.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-provisionedcidrs

property publicIpSource

publicIpSource: string;

The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP . For more information, see [Create IPv6 pools](https://docs.aws.amazon.com//vpc/latest/ipam/intro-create-ipv6-pools.html) in the *Amazon VPC IPAM User Guide* . By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see [Quotas for your IPAM](https://docs.aws.amazon.com//vpc/latest/ipam/quotas-ipam.html) in the *Amazon VPC IPAM User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-publicipsource

property publiclyAdvertisable

publiclyAdvertisable: any;

Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-publiclyadvertisable

property sourceIpamPoolId

sourceIpamPoolId: string;

The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-sourceipampoolid

property tags

readonly tags: cdk.TagManager;

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA , specify tag:Owner for the filter name and TeamA for the filter value.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnIPAMPoolCidr

class CfnIPAMPoolCidr extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::IPAMPoolCidr
A CIDR provisioned to an IPAM pool.
AWS::EC2::IPAMPoolCidr external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnIPAMPoolCidrProps);

Create a new AWS::EC2::IPAMPoolCidr.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrIpamPoolCidrId

readonly attrIpamPoolCidrId: string;

The IPAM pool CIDR ID. IpamPoolCidrId

property attrState

readonly attrState: string;

The state of the CIDR. State

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property cidr

cidr: string;

The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23 . An IPv6 CIDR example is 2001:DB8::/32 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html#cfn-ec2-ipampoolcidr-cidr

property ipamPoolId

ipamPoolId: string;

The ID of the IPAM pool.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html#cfn-ec2-ipampoolcidr-ipampoolid

property netmaskLength

netmaskLength: number;

The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. "NetmaskLength" or "Cidr" is required.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html#cfn-ec2-ipampoolcidr-netmasklength

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnIPAMResourceDiscovery

class CfnIPAMResourceDiscovery extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::IPAMResourceDiscovery
A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
AWS::EC2::IPAMResourceDiscovery external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscovery.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props?: CfnIPAMResourceDiscoveryProps
);

Create a new AWS::EC2::IPAMResourceDiscovery.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrIpamResourceDiscoveryArn

readonly attrIpamResourceDiscoveryArn: string;

The resource discovery ARN. IpamResourceDiscoveryArn

property attrIpamResourceDiscoveryId

readonly attrIpamResourceDiscoveryId: string;

The resource discovery ID. IpamResourceDiscoveryId

property attrIpamResourceDiscoveryRegion

readonly attrIpamResourceDiscoveryRegion: string;

The resource discovery Region. IpamResourceDiscoveryRegion

property attrIsDefault

readonly attrIsDefault: cdk.IResolvable;

Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM. IsDefault

property attrOwnerId

readonly attrOwnerId: string;

The owner ID. OwnerId

property attrState

readonly attrState: string;

The resource discovery's state.
- create-in-progress - Resource discovery is being created. - create-complete - Resource discovery creation is complete. - create-failed - Resource discovery creation has failed. - modify-in-progress - Resource discovery is being modified. - modify-complete - Resource discovery modification is complete. - modify-failed - Resource discovery modification has failed. - delete-in-progress - Resource discovery is being deleted. - delete-complete - Resource discovery deletion is complete. - delete-failed - Resource discovery deletion has failed. - isolate-in-progress - AWS account that created the resource discovery has been removed and the resource discovery is being isolated. - isolate-complete - Resource discovery isolation is complete. - restore-in-progress - AWS account that created the resource discovery and was isolated has been restored. State

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property description

description: string;

The resource discovery description.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscovery.html#cfn-ec2-ipamresourcediscovery-description

property operatingRegions

operatingRegions: any;

The operating Regions for the resource discovery. Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscovery.html#cfn-ec2-ipamresourcediscovery-operatingregions

property tags

readonly tags: cdk.TagManager;

A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscovery.html#cfn-ec2-ipamresourcediscovery-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnIPAMResourceDiscoveryAssociation

class CfnIPAMResourceDiscoveryAssociation
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::IPAMResourceDiscoveryAssociation
An IPAM resource discovery association. An associated resource discovery is a resource discovery that has been associated with an IPAM. IPAM aggregates the resource CIDRs discovered by the associated resource discovery.
AWS::EC2::IPAMResourceDiscoveryAssociation external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscoveryassociation.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnIPAMResourceDiscoveryAssociationProps
);

Create a new AWS::EC2::IPAMResourceDiscoveryAssociation.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrIpamArn

readonly attrIpamArn: string;

The IPAM ARN. IpamArn

property attrIpamRegion

readonly attrIpamRegion: string;

The IPAM home Region. IpamRegion

property attrIpamResourceDiscoveryAssociationArn

readonly attrIpamResourceDiscoveryAssociationArn: string;

The resource discovery association ARN. IpamResourceDiscoveryAssociationArn

property attrIpamResourceDiscoveryAssociationId

readonly attrIpamResourceDiscoveryAssociationId: string;

The resource discovery association ID. IpamResourceDiscoveryAssociationId

property attrIsDefault

readonly attrIsDefault: cdk.IResolvable;

Defines if the resource discovery is the default. When you create an IPAM, a default resource discovery is created for your IPAM and it's associated with your IPAM. IsDefault

property attrOwnerId

readonly attrOwnerId: string;

The owner ID. OwnerId

property attrResourceDiscoveryStatus

readonly attrResourceDiscoveryStatus: string;

The resource discovery status.
- active - Connection or permissions required to read the results of the resource discovery are intact. - not-found - Connection or permissions required to read the results of the resource discovery are broken. This may happen if the owner of the resource discovery stopped sharing it or deleted the resource discovery. Verify the resource discovery still exists and the AWS RAM resource share is still intact. ResourceDiscoveryStatus

property attrState

readonly attrState: string;

The lifecycle state of the association when you associate or disassociate a resource discovery.
- associate-in-progress - Resource discovery is being associated. - associate-complete - Resource discovery association is complete. - associate-failed - Resource discovery association has failed. - disassociate-in-progress - Resource discovery is being disassociated. - disassociate-complete - Resource discovery disassociation is complete. - disassociate-failed - Resource discovery disassociation has failed. - isolate-in-progress - AWS account that created the resource discovery association has been removed and the resource discovery associatation is being isolated. - isolate-complete - Resource discovery isolation is complete.. - restore-in-progress - Resource discovery is being restored. State

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property ipamId

ipamId: string;

The IPAM ID.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscoveryassociation.html#cfn-ec2-ipamresourcediscoveryassociation-ipamid

property ipamResourceDiscoveryId

ipamResourceDiscoveryId: string;

The resource discovery ID.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscoveryassociation.html#cfn-ec2-ipamresourcediscoveryassociation-ipamresourcediscoveryid

property tags

readonly tags: cdk.TagManager;

A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscoveryassociation.html#cfn-ec2-ipamresourcediscoveryassociation-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnIPAMScope

class CfnIPAMScope extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::IPAMScope
In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
For more information, see [How IPAM works](https://docs.aws.amazon.com//vpc/latest/ipam/how-it-works-ipam.html) in the *Amazon VPC IPAM User Guide* .
AWS::EC2::IPAMScope external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnIPAMScopeProps);

Create a new AWS::EC2::IPAMScope.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrArn

readonly attrArn: string;

The ARN of the scope. Arn

property attrIpamArn

readonly attrIpamArn: string;

The ARN of an IPAM. IpamArn

property attrIpamScopeId

readonly attrIpamScopeId: string;

The ID of an IPAM scope. IpamScopeId

property attrIpamScopeType

readonly attrIpamScopeType: string;

The type of the scope. IpamScopeType

property attrIsDefault

readonly attrIsDefault: cdk.IResolvable;

Defines if the scope is the default scope or not. IsDefault

property attrPoolCount

readonly attrPoolCount: number;

The number of pools in a scope. PoolCount

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property description

description: string;

The description of the scope.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html#cfn-ec2-ipamscope-description

property ipamId

ipamId: string;

The ID of the IPAM for which you're creating this scope.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html#cfn-ec2-ipamscope-ipamid

property tags

readonly tags: cdk.TagManager;

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA , specify tag:Owner for the filter name and TeamA for the filter value.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html#cfn-ec2-ipamscope-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnKeyPair

class CfnKeyPair extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::KeyPair
Specifies a key pair for use with an Amazon Elastic Compute Cloud instance as follows:
- To import an existing key pair, include the PublicKeyMaterial property. - To create a new key pair, omit the PublicKeyMaterial property.
When you import an existing key pair, you specify the public key material for the key. We assume that you have the private key material for the key. AWS CloudFormation does not create or return the private key material when you import a key pair.
When you create a new key pair, the private key is saved to AWS Systems Manager Parameter Store, using a parameter with the following name: /ec2/keypair/{key_pair_id} . For more information about retrieving private key, and the required permissions, see [Create a key pair using AWS CloudFormation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html#create-key-pair-cloudformation) in the *Amazon EC2 User Guide* .
When AWS CloudFormation deletes a key pair that was created or imported by a stack, it also deletes the parameter that was used to store the private key material in Parameter Store.
AWS::EC2::KeyPair external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnKeyPairProps);

Create a new AWS::EC2::KeyPair.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrKeyFingerprint

readonly attrKeyFingerprint: string;

If you created the key pair using Amazon EC2:
- For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key. - For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with [OpenSSH 6.8](https://docs.aws.amazon.com/http://www.openssh.com/txt/release-6.8) .
If you imported the key pair to Amazon EC2:
- For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC 4716. - For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with [OpenSSH 6.8](https://docs.aws.amazon.com/http://www.openssh.com/txt/release-6.8) . KeyFingerprint

property attrKeyPairId

readonly attrKeyPairId: string;

The ID of the key pair. KeyPairId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property keyName

keyName: string;

A unique name for the key pair.
Constraints: Up to 255 ASCII characters
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-keyname

property keyType

keyType: string;

The type of key pair. Note that ED25519 keys are not supported for Windows instances.
If the PublicKeyMaterial property is specified, the KeyType property is ignored, and the key type is inferred from the PublicKeyMaterial value.
Default: rsa
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-keytype

property publicKeyMaterial

publicKeyMaterial: string;

The public key material. The PublicKeyMaterial property is used to import a key pair. If this property is not specified, then a new key pair will be created.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-publickeymaterial

property tags

readonly tags: cdk.TagManager;

The tags to apply to the key pair.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnLaunchTemplate

class CfnLaunchTemplate extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::LaunchTemplate
Specifies the properties for creating a launch template.
The minimum required properties for specifying a launch template are as follows:
- You must specify at least one property for the launch template data. - You do not need to specify a name for the launch template. If you do not specify a name, AWS CloudFormation creates the name for you.
A launch template can contain some or all of the configuration information to launch an instance. When you launch an instance using a launch template, instance properties that are not specified in the launch template use default values, except the ImageId property, which has no default value. If you do not specify an AMI ID for the launch template ImageId property, you must specify an AMI ID for the instance ImageId property.
For more information, see [Launch an instance from a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User Guide* .
AWS::EC2::LaunchTemplate external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnLaunchTemplateProps);

Create a new AWS::EC2::LaunchTemplate.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrDefaultVersionNumber

readonly attrDefaultVersionNumber: string;

The default version of the launch template, such as 2.
The default version of a launch template cannot be specified in AWS CloudFormation . The default version can be set in the Amazon EC2 console or by using the modify-launch-template AWS CLI command. DefaultVersionNumber

property attrLatestVersionNumber

readonly attrLatestVersionNumber: string;

The latest version of the launch template, such as 5 . LatestVersionNumber

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property launchTemplateData

launchTemplateData: any;

The information for the launch template.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-launchtemplatedata

property launchTemplateName

launchTemplateName: string;

A name for the launch template.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-launchtemplatename

property tagSpecifications

tagSpecifications: any;

The tags to apply to the launch template on creation. To tag the launch template, the resource type must be launch-template .
> To specify the tags for the resources that are created when an instance is launched, you must use the TagSpecifications parameter in the [launch template data](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestLaunchTemplateData.html) structure.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications

property versionDescription

versionDescription: string;

A description for the first version of the launch template.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-versiondescription

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnLocalGatewayRoute

class CfnLocalGatewayRoute extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::LocalGatewayRoute
Creates a static route for the specified local gateway route table. You must specify one of the following targets:
- LocalGatewayVirtualInterfaceGroupId - NetworkInterfaceId
AWS::EC2::LocalGatewayRoute external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnLocalGatewayRouteProps);

Create a new AWS::EC2::LocalGatewayRoute.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrState

readonly attrState: string;

The state of the local gateway route table. State

property attrType

readonly attrType: string;

The type of local gateway route. Type

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property destinationCidrBlock

destinationCidrBlock: string;

The CIDR block used for destination matches.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html#cfn-ec2-localgatewayroute-destinationcidrblock

property localGatewayRouteTableId

localGatewayRouteTableId: string;

The ID of the local gateway route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html#cfn-ec2-localgatewayroute-localgatewayroutetableid

property localGatewayVirtualInterfaceGroupId

localGatewayVirtualInterfaceGroupId: string;

The ID of the virtual interface group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html#cfn-ec2-localgatewayroute-localgatewayvirtualinterfacegroupid

property networkInterfaceId

networkInterfaceId: string;

The ID of the network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html#cfn-ec2-localgatewayroute-networkinterfaceid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnLocalGatewayRouteTable

class CfnLocalGatewayRouteTable
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::LocalGatewayRouteTable
Describes a local gateway route table.
AWS::EC2::LocalGatewayRouteTable external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetable.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnLocalGatewayRouteTableProps
);

Create a new AWS::EC2::LocalGatewayRouteTable.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrLocalGatewayRouteTableArn

readonly attrLocalGatewayRouteTableArn: string;

The Amazon Resource Name (ARN) of the local gateway route table. LocalGatewayRouteTableArn

property attrLocalGatewayRouteTableId

readonly attrLocalGatewayRouteTableId: string;

The ID of the local gateway route table. LocalGatewayRouteTableId

property attrOutpostArn

readonly attrOutpostArn: string;

The Amazon Resource Name (ARN) of the Outpost. OutpostArn

property attrOwnerId

readonly attrOwnerId: string;

The ID of the AWS account that owns the local gateway route table. OwnerId

property attrState

readonly attrState: string;

The state of the local gateway route table. State

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property localGatewayId

localGatewayId: string;

The ID of the local gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetable.html#cfn-ec2-localgatewayroutetable-localgatewayid

property mode

mode: string;

The mode of the local gateway route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetable.html#cfn-ec2-localgatewayroutetable-mode

property tags

readonly tags: cdk.TagManager;

The tags assigned to the local gateway route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetable.html#cfn-ec2-localgatewayroutetable-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation

class CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation
Describes an association between a local gateway route table and a virtual interface group.
AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevirtualinterfacegroupassociation.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociationProps
);

Create a new AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrLocalGatewayId

readonly attrLocalGatewayId: string;

The ID of the local gateway. LocalGatewayId

property attrLocalGatewayRouteTableArn

readonly attrLocalGatewayRouteTableArn: string;

The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group. LocalGatewayRouteTableArn

property attrLocalGatewayRouteTableVirtualInterfaceGroupAssociationId

readonly attrLocalGatewayRouteTableVirtualInterfaceGroupAssociationId: string;

The ID of the association. LocalGatewayRouteTableVirtualInterfaceGroupAssociationId

property attrOwnerId

readonly attrOwnerId: string;

The ID of the AWS account that owns the local gateway virtual interface group association. OwnerId

property attrState

readonly attrState: string;

The state of the association. State

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property localGatewayRouteTableId

localGatewayRouteTableId: string;

The ID of the local gateway route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevirtualinterfacegroupassociation.html#cfn-ec2-localgatewayroutetablevirtualinterfacegroupassociation-localgatewayroutetableid

property localGatewayVirtualInterfaceGroupId

localGatewayVirtualInterfaceGroupId: string;

The ID of the virtual interface group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevirtualinterfacegroupassociation.html#cfn-ec2-localgatewayroutetablevirtualinterfacegroupassociation-localgatewayvirtualinterfacegroupid

property tags

readonly tags: cdk.TagManager;

The tags assigned to the association.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevirtualinterfacegroupassociation.html#cfn-ec2-localgatewayroutetablevirtualinterfacegroupassociation-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnLocalGatewayRouteTableVPCAssociation

class CfnLocalGatewayRouteTableVPCAssociation
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::LocalGatewayRouteTableVPCAssociation
Associates the specified VPC with the specified local gateway route table.
AWS::EC2::LocalGatewayRouteTableVPCAssociation external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevpcassociation.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnLocalGatewayRouteTableVPCAssociationProps
);

Create a new AWS::EC2::LocalGatewayRouteTableVPCAssociation.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrLocalGatewayId

readonly attrLocalGatewayId: string;

The ID of the local gateway. LocalGatewayId

property attrLocalGatewayRouteTableVpcAssociationId

readonly attrLocalGatewayRouteTableVpcAssociationId: string;

The ID of the association. LocalGatewayRouteTableVpcAssociationId

property attrState

readonly attrState: string;

The state of the association. State

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property localGatewayRouteTableId

localGatewayRouteTableId: string;

The ID of the local gateway route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevpcassociation.html#cfn-ec2-localgatewayroutetablevpcassociation-localgatewayroutetableid

property tags

readonly tags: cdk.TagManager;

The tags assigned to the association.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevpcassociation.html#cfn-ec2-localgatewayroutetablevpcassociation-tags

property vpcId

vpcId: string;

The ID of the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevpcassociation.html#cfn-ec2-localgatewayroutetablevpcassociation-vpcid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnNatGateway

class CfnNatGateway extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::NatGateway
Specifies a network address translation (NAT) gateway in the specified subnet. You can create either a public NAT gateway or a private NAT gateway. The default is a public NAT gateway. If you create a public NAT gateway, you must specify an elastic IP address.
With a NAT gateway, instances in a private subnet can connect to the internet, other AWS services, or an on-premises network using the IP address of the NAT gateway.
If you add a default route ( AWS::EC2::Route resource) that points to a NAT gateway, specify the NAT gateway ID for the route's NatGatewayId property.
For more information, see [NAT Gateways](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) in the *Amazon VPC User Guide* .
AWS::EC2::NatGateway external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnNatGatewayProps);

Create a new AWS::EC2::NatGateway.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property allocationId

allocationId: string;

[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway. This property is required for a public NAT gateway and cannot be specified with a private NAT gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-allocationid

property attrNatGatewayId

readonly attrNatGatewayId: string;

The ID of the NAT gateway. NatGatewayId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property connectivityType

connectivityType: string;

Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-connectivitytype

property maxDrainDurationSeconds

maxDrainDurationSeconds: number;

The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-maxdraindurationseconds

property privateIpAddress

privateIpAddress: string;

The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-privateipaddress

property secondaryAllocationIds

secondaryAllocationIds: string[];

Secondary EIP allocation IDs. For more information, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon VPC User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-secondaryallocationids

property secondaryPrivateIpAddressCount

secondaryPrivateIpAddressCount: number;

[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide* .
> SecondaryPrivateIpAddressCount and SecondaryPrivateIpAddresses cannot be set at the same time.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-secondaryprivateipaddresscount

property secondaryPrivateIpAddresses

secondaryPrivateIpAddresses: string[];

Secondary private IPv4 addresses. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide* .
> SecondaryPrivateIpAddressCount and SecondaryPrivateIpAddresses cannot be set at the same time.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-secondaryprivateipaddresses

property subnetId

subnetId: string;

The ID of the subnet in which the NAT gateway is located.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-subnetid

property tags

readonly tags: cdk.TagManager;

The tags for the NAT gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnNetworkAcl

class CfnNetworkAcl extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::NetworkAcl
Specifies a network ACL for your VPC.
AWS::EC2::NetworkAcl external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkacl.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnNetworkAclProps);

Create a new AWS::EC2::NetworkAcl.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrId

readonly attrId: string;

The ID of the network ACL. Id

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property tags

readonly tags: cdk.TagManager;

The tags for the network ACL.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkacl.html#cfn-ec2-networkacl-tags

property vpcId

vpcId: string;

The ID of the VPC for the network ACL.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkacl.html#cfn-ec2-networkacl-vpcid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnNetworkAclEntry

class CfnNetworkAclEntry extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::NetworkAclEntry
Specifies an entry, known as a rule, in a network ACL with a rule number you specify. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules.
For information about the protocol value, see [Protocol Numbers](https://docs.aws.amazon.com/https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) on the Internet Assigned Numbers Authority (IANA) website.
AWS::EC2::NetworkAclEntry external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnNetworkAclEntryProps);

Create a new AWS::EC2::NetworkAclEntry.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrId

readonly attrId: string;

The ID of the network ACL entry. Id

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property cidrBlock

cidrBlock: string;

The IPv4 CIDR range to allow or deny, in CIDR notation (for example, 172.16.0.0/24). Requirement is conditional: You must specify the CidrBlock or Ipv6CidrBlock property.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-cidrblock

property egress

egress: any;

Whether this rule applies to egress traffic from the subnet ( true ) or ingress traffic to the subnet ( false ). By default, AWS CloudFormation specifies false .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-egress

property icmp

icmp: any;

The Internet Control Message Protocol (ICMP) code and type. Requirement is conditional: Required if specifying 1 (ICMP) for the protocol parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-icmp

property ipv6CidrBlock

ipv6CidrBlock: string;

The IPv6 network range to allow or deny, in CIDR notation. Requirement is conditional: You must specify the CidrBlock or Ipv6CidrBlock property.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-ipv6cidrblock

property networkAclId

networkAclId: string;

The ID of the ACL for the entry.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-networkaclid

property portRange

portRange: any;

The range of port numbers for the UDP/TCP protocol. Conditional required if specifying 6 (TCP) or 17 (UDP) for the protocol parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-portrange

property protocol

protocol: number;

The IP protocol that the rule applies to. You must specify -1 or a protocol number. You can specify -1 for all protocols.
> If you specify -1, all ports are opened and the PortRange property is ignored.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-protocol

property ruleAction

ruleAction: string;

Whether to allow or deny traffic that matches the rule; valid values are "allow" or "deny".
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-ruleaction

property ruleNumber

ruleNumber: number;

Rule number to assign to the entry, such as 100. ACL entries are processed in ascending order by rule number. Entries can't use the same rule number unless one is an egress rule and the other is an ingress rule.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-rulenumber

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnNetworkInsightsAccessScope

class CfnNetworkInsightsAccessScope
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::NetworkInsightsAccessScope
Describes a Network Access Scope. A Network Access Scope defines outbound (egress) and inbound (ingress) traffic patterns, including sources, destinations, paths, and traffic types.
Network Access Analyzer identifies unintended network access to your resources on AWS . When you start an analysis on a Network Access Scope, Network Access Analyzer produces findings. For more information, see the [Network Access Analyzer User Guide](https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/) .
AWS::EC2::NetworkInsightsAccessScope external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscope.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props?: CfnNetworkInsightsAccessScopeProps
);

Create a new AWS::EC2::NetworkInsightsAccessScope.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrCreatedDate

readonly attrCreatedDate: string;

The creation date. CreatedDate

property attrNetworkInsightsAccessScopeArn

readonly attrNetworkInsightsAccessScopeArn: string;

The ARN of the Network Access Scope. NetworkInsightsAccessScopeArn

property attrNetworkInsightsAccessScopeId

readonly attrNetworkInsightsAccessScopeId: string;

The ID of the Network Access Scope. NetworkInsightsAccessScopeId

property attrUpdatedDate

readonly attrUpdatedDate: string;

The last updated date. UpdatedDate

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property excludePaths

excludePaths: any;

The paths to exclude.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscope.html#cfn-ec2-networkinsightsaccessscope-excludepaths

property matchPaths

matchPaths: any;

The paths to match.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscope.html#cfn-ec2-networkinsightsaccessscope-matchpaths

property tags

readonly tags: cdk.TagManager;

The tags.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscope.html#cfn-ec2-networkinsightsaccessscope-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnNetworkInsightsAccessScopeAnalysis

class CfnNetworkInsightsAccessScopeAnalysis
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::NetworkInsightsAccessScopeAnalysis
Describes a Network Access Scope analysis.
AWS::EC2::NetworkInsightsAccessScopeAnalysis external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscopeanalysis.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnNetworkInsightsAccessScopeAnalysisProps
);

Create a new AWS::EC2::NetworkInsightsAccessScopeAnalysis.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrAnalyzedEniCount

readonly attrAnalyzedEniCount: number;

The number of network interfaces analyzed. AnalyzedEniCount

property attrEndDate

readonly attrEndDate: string;

The end date of the analysis. EndDate

property attrFindingsFound

readonly attrFindingsFound: string;

Indicates whether there are findings (true | false | unknown). FindingsFound

property attrNetworkInsightsAccessScopeAnalysisArn

readonly attrNetworkInsightsAccessScopeAnalysisArn: string;

The ARN of the Network Access Scope analysis. NetworkInsightsAccessScopeAnalysisArn

property attrNetworkInsightsAccessScopeAnalysisId

readonly attrNetworkInsightsAccessScopeAnalysisId: string;

The ID of the Network Access Scope analysis. NetworkInsightsAccessScopeAnalysisId

property attrStartDate

readonly attrStartDate: string;

The start date of the analysis. StartDate

property attrStatus

readonly attrStatus: string;

The status of the analysis (running | succeeded | failed). Status

property attrStatusMessage

readonly attrStatusMessage: string;

The status message. StatusMessage

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property networkInsightsAccessScopeId

networkInsightsAccessScopeId: string;

The ID of the Network Access Scope.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscopeanalysis.html#cfn-ec2-networkinsightsaccessscopeanalysis-networkinsightsaccessscopeid

property tags

readonly tags: cdk.TagManager;

The tags.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscopeanalysis.html#cfn-ec2-networkinsightsaccessscopeanalysis-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnNetworkInsightsAnalysis

class CfnNetworkInsightsAnalysis
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::NetworkInsightsAnalysis
Specifies a network insights analysis.
AWS::EC2::NetworkInsightsAnalysis external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnNetworkInsightsAnalysisProps
);

Create a new AWS::EC2::NetworkInsightsAnalysis.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property additionalAccounts

additionalAccounts: string[];

The member accounts that contain resources that the path can traverse.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#cfn-ec2-networkinsightsanalysis-additionalaccounts

property attrAlternatePathHints

readonly attrAlternatePathHints: cdk.IResolvable;

Potential intermediate components. AlternatePathHints

property attrExplanations

readonly attrExplanations: cdk.IResolvable;

The explanations. For more information, see [Reachability Analyzer explanation codes](https://docs.aws.amazon.com/vpc/latest/reachability/explanation-codes.html) . Explanations

property attrForwardPathComponents

readonly attrForwardPathComponents: cdk.IResolvable;

The components in the path from source to destination. ForwardPathComponents

property attrNetworkInsightsAnalysisArn

readonly attrNetworkInsightsAnalysisArn: string;

The Amazon Resource Name (ARN) of the network insights analysis. NetworkInsightsAnalysisArn

property attrNetworkInsightsAnalysisId

readonly attrNetworkInsightsAnalysisId: string;

The ID of the network insights analysis. NetworkInsightsAnalysisId

property attrNetworkPathFound

readonly attrNetworkPathFound: cdk.IResolvable;

Indicates whether the destination is reachable from the source. NetworkPathFound

property attrReturnPathComponents

readonly attrReturnPathComponents: cdk.IResolvable;

The components in the path from destination to source. ReturnPathComponents

property attrStartDate

readonly attrStartDate: string;

The time the analysis started. StartDate

property attrStatus

readonly attrStatus: string;

The status of the network insights analysis. Status

property attrStatusMessage

readonly attrStatusMessage: string;

The status message, if the status is failed . StatusMessage

property attrSuggestedAccounts

readonly attrSuggestedAccounts: string[];

The IDs of potential intermediate accounts. SuggestedAccounts

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property filterInArns

filterInArns: string[];

The Amazon Resource Names (ARN) of the resources that the path must traverse.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#cfn-ec2-networkinsightsanalysis-filterinarns

property networkInsightsPathId

networkInsightsPathId: string;

The ID of the path.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#cfn-ec2-networkinsightsanalysis-networkinsightspathid

property tags

readonly tags: cdk.TagManager;

The tags to apply.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#cfn-ec2-networkinsightsanalysis-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnNetworkInsightsPath

class CfnNetworkInsightsPath extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::NetworkInsightsPath
Specifies a path to analyze for reachability.
VPC Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see the [Reachability Analyzer User Guide](https://docs.aws.amazon.com/vpc/latest/reachability/what-is-reachability-analyzer.html) .
AWS::EC2::NetworkInsightsPath external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnNetworkInsightsPathProps
);

Create a new AWS::EC2::NetworkInsightsPath.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrCreatedDate

readonly attrCreatedDate: string;

The time stamp when the path was created. CreatedDate

property attrDestinationArn

readonly attrDestinationArn: string;

The Amazon Resource Name (ARN) of the destination. DestinationArn

property attrNetworkInsightsPathArn

readonly attrNetworkInsightsPathArn: string;

The Amazon Resource Name (ARN) of the path. NetworkInsightsPathArn

property attrNetworkInsightsPathId

readonly attrNetworkInsightsPathId: string;

The ID of the path. NetworkInsightsPathId

property attrSourceArn

readonly attrSourceArn: string;

The Amazon Resource Name (ARN) of the source. SourceArn

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property destination

destination: string;

The ID or ARN of the destination. If the resource is in another account, you must specify an ARN.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-destination

property destinationIp

destinationIp: string;

The IP address of the destination.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-destinationip

property destinationPort

destinationPort: number;

The destination port.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-destinationport

property filterAtDestination

filterAtDestination: any;

Scopes the analysis to network paths that match specific filters at the destination. If you specify this parameter, you can't specify the parameter for the destination IP address.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-filteratdestination

property filterAtSource

filterAtSource: any;

Scopes the analysis to network paths that match specific filters at the source. If you specify this parameter, you can't specify the parameters for the source IP address or the destination port.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-filteratsource

property protocol

protocol: string;

The protocol.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-protocol

property source

source: string;

The ID or ARN of the source. If the resource is in another account, you must specify an ARN.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-source

property sourceIp

sourceIp: string;

The IP address of the source.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-sourceip

property tags

readonly tags: cdk.TagManager;

The tags to add to the path.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnNetworkInterface

class CfnNetworkInterface extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::NetworkInterface
Describes a network interface in an Amazon EC2 instance for AWS CloudFormation .
AWS::EC2::NetworkInterface external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnNetworkInterfaceProps);

Create a new AWS::EC2::NetworkInterface.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrId

readonly attrId: string;

The ID of the network interface. Id

property attrPrimaryPrivateIpAddress

readonly attrPrimaryPrivateIpAddress: string;

The primary private IP address of the network interface. For example, 10.0.0.192 . PrimaryPrivateIpAddress

property attrSecondaryPrivateIpAddresses

readonly attrSecondaryPrivateIpAddresses: string[];

The secondary private IP addresses of the network interface. For example, ["10.0.0.161", "10.0.0.162", "10.0.0.163"] . SecondaryPrivateIpAddresses

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property description

description: string;

A description for the network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-description

property groupSet

groupSet: string[];

The security group IDs associated with this network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-groupset

property interfaceType

interfaceType: string;

The type of network interface. The default is interface . The supported values are efa and trunk .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-interfacetype

property ipv6AddressCount

ipv6AddressCount: number;

The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-ipv6addresscount

property ipv6Addresses

ipv6Addresses: any;

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-ipv6addresses

property privateIpAddress

privateIpAddress: string;

Assigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-privateipaddress

property privateIpAddresses

privateIpAddresses: any;

Assigns private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-privateipaddresses

property secondaryPrivateIpAddressCount

secondaryPrivateIpAddressCount: number;

The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses .
You can't specify a count of private IPv4 addresses if you've specified one of the following: specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-secondaryprivateipaddresscount

property sourceDestCheck

sourceDestCheck: any;

Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true , source/destination checks are enabled; otherwise, they are disabled. The default value is true . You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-sourcedestcheck

property subnetId

subnetId: string;

The ID of the subnet to associate with the network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-subnetid

property tags

readonly tags: cdk.TagManager;

An arbitrary set of tags (key-value pairs) for this network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnNetworkInterfaceAttachment

class CfnNetworkInterfaceAttachment
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::NetworkInterfaceAttachment
Attaches an elastic network interface (ENI) to an Amazon EC2 instance. You can use this resource type to attach additional network interfaces to an instance without interruption.
AWS::EC2::NetworkInterfaceAttachment external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnNetworkInterfaceAttachmentProps
);

Create a new AWS::EC2::NetworkInterfaceAttachment.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property deleteOnTermination

deleteOnTermination: any;

Whether to delete the network interface when the instance terminates. By default, this value is set to true .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html#cfn-ec2-network-interface-attachment-deleteonterm

property deviceIndex

deviceIndex: string;

The network interface's position in the attachment order. For example, the first attached network interface has a DeviceIndex of 0.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html#cfn-ec2-network-interface-attachment-deviceindex

property instanceId

instanceId: string;

The ID of the instance to which you will attach the ENI.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html#cfn-ec2-network-interface-attachment-instanceid

property networkInterfaceId

networkInterfaceId: string;

The ID of the ENI that you want to attach.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html#cfn-ec2-network-interface-attachment-networkinterfaceid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnNetworkInterfacePermission

class CfnNetworkInterfacePermission
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::NetworkInterfacePermission
Specifies a permission for an Amazon EC2 network interface. For example, you can grant an AWS authorized partner account permission to attach the specified network interface to an instance in their account.
AWS::EC2::NetworkInterfacePermission external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnNetworkInterfacePermissionProps
);

Create a new AWS::EC2::NetworkInterfacePermission.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property awsAccountId

awsAccountId: string;

The AWS account ID.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html#cfn-ec2-networkinterfacepermission-awsaccountid

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property networkInterfaceId

networkInterfaceId: string;

The ID of the network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html#cfn-ec2-networkinterfacepermission-networkinterfaceid

property permission

permission: string;

The type of permission to grant: INSTANCE-ATTACH or EIP-ASSOCIATE .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html#cfn-ec2-networkinterfacepermission-permission

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnNetworkPerformanceMetricSubscription

class CfnNetworkPerformanceMetricSubscription
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::NetworkPerformanceMetricSubscription
Describes Infrastructure Performance subscriptions.
AWS::EC2::NetworkPerformanceMetricSubscription external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkperformancemetricsubscription.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnNetworkPerformanceMetricSubscriptionProps
);

Create a new AWS::EC2::NetworkPerformanceMetricSubscription.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property destination

destination: string;

The Region or Availability Zone that's the target for the subscription. For example, eu-west-1 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkperformancemetricsubscription.html#cfn-ec2-networkperformancemetricsubscription-destination

property metric

metric: string;

The metric used for the subscription.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkperformancemetricsubscription.html#cfn-ec2-networkperformancemetricsubscription-metric

property source

source: string;

The Region or Availability Zone that's the source for the subscription. For example, us-east-1 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkperformancemetricsubscription.html#cfn-ec2-networkperformancemetricsubscription-source

property statistic

statistic: string;

The statistic used for the subscription.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkperformancemetricsubscription.html#cfn-ec2-networkperformancemetricsubscription-statistic

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnPlacementGroup

class CfnPlacementGroup extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::PlacementGroup
Specifies a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.
A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.
For more information, see [Placement Groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide* .
AWS::EC2::PlacementGroup external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html

constructor

constructor(scope: cdk.Construct, id: string, props?: CfnPlacementGroupProps);

Create a new AWS::EC2::PlacementGroup.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrGroupName

readonly attrGroupName: string;

The name of the placement group. GroupName

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property partitionCount

partitionCount: number;

The number of partitions. Valid only when *Strategy* is set to partition .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html#cfn-ec2-placementgroup-partitioncount

property spreadLevel

spreadLevel: string;

Determines how placement groups spread instances.
- Host – You can use host only with Outpost placement groups. - Rack – No usage restrictions.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html#cfn-ec2-placementgroup-spreadlevel

property strategy

strategy: string;

The placement strategy.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html#cfn-ec2-placementgroup-strategy

property tags

readonly tags: cdk.TagManager;

The tags to apply to the new placement group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html#cfn-ec2-placementgroup-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnPrefixList

class CfnPrefixList extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::PrefixList
Specifies a managed prefix list. You can add one or more entries to the prefix list. Each entry consists of a CIDR block and an optional description.
AWS::EC2::PrefixList external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnPrefixListProps);

Create a new AWS::EC2::PrefixList.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property addressFamily

addressFamily: string;

The IP address type.
Valid Values: IPv4 | IPv6
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-addressfamily

property attrArn

readonly attrArn: string;

The ARN of the prefix list. For example, arn:aws:ec2:us-east-1:123456789012:prefix-list/pl-0123123123123abcd . Arn

property attrOwnerId

readonly attrOwnerId: string;

The ID of the owner of the prefix list. For example, 123456789012 . OwnerId

property attrPrefixListId

readonly attrPrefixListId: string;

The ID of the prefix list. For example, pl-0123123123123abcd . PrefixListId

property attrVersion

readonly attrVersion: number;

The version of the prefix list. For example, 1 . Version

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property entries

entries: any;

One or more entries for the prefix list.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-entries

property maxEntries

maxEntries: number;

The maximum number of entries for the prefix list.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-maxentries

property prefixListName

prefixListName: string;

A name for the prefix list.
Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-prefixlistname

property tags

readonly tags: cdk.TagManager;

The tags for the prefix list.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnRoute

class CfnRoute extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::Route
Specifies a route in a route table.
You must specify either DestinationCidrBlock or DestinationIpv6CidrBlock , 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) in the AWS::EC2::Route resource to explicitly declare a dependency on the AWS::EC2::TransitGatewayAttachment resource.
AWS::EC2::Route external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnRouteProps);

Create a new AWS::EC2::Route.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property carrierGatewayId

carrierGatewayId: string;

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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-carriergatewayid

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property destinationCidrBlock

destinationCidrBlock: string;

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 to 100.68.0.0/18 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-destinationcidrblock

property destinationIpv6CidrBlock

destinationIpv6CidrBlock: string;

The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-destinationipv6cidrblock

property egressOnlyInternetGatewayId

egressOnlyInternetGatewayId: string;

[IPv6 traffic only] The ID of an egress-only internet gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-egressonlyinternetgatewayid

property gatewayId

gatewayId: string;

The ID of an internet gateway or virtual private gateway attached to your VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-gatewayid

property instanceId

instanceId: string;

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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-instanceid

property localGatewayId

localGatewayId: string;

The ID of the local gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-localgatewayid

property natGatewayId

natGatewayId: string;

[IPv4 traffic only] The ID of a NAT gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-natgatewayid

property networkInterfaceId

networkInterfaceId: string;

The ID of a network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-networkinterfaceid

property routeTableId

routeTableId: string;

The ID of the route table for the route.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-routetableid

property transitGatewayId

transitGatewayId: string;

The ID of a transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-transitgatewayid

property vpcEndpointId

vpcEndpointId: string;

The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-vpcendpointid

property vpcPeeringConnectionId

vpcPeeringConnectionId: string;

The ID of a VPC peering connection.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-vpcpeeringconnectionid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnRouteTable

class CfnRouteTable extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::RouteTable
Specifies a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.
For more information, see [Route Tables](https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html) in the *Amazon VPC User Guide* .
AWS::EC2::RouteTable external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnRouteTableProps);

Create a new AWS::EC2::RouteTable.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrRouteTableId

readonly attrRouteTableId: string;

The ID of the route table. RouteTableId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property tags

readonly tags: cdk.TagManager;

Any tags assigned to the route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html#cfn-ec2-routetable-tags

property vpcId

vpcId: string;

The ID of the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html#cfn-ec2-routetable-vpcid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnSecurityGroup

class CfnSecurityGroup extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::SecurityGroup
Specifies a security group. To create a security group, use the [VpcId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-vpcid) property to specify the VPC for which to create the security group.
If you do not specify an egress rule, we add egress rules that allow IPv4 and IPv6 traffic on all ports and protocols to any destination. We do not add these rules if you specify your own egress rules. If you later remove your egress rules, we restore the default egress rules.
This type supports updates. For more information about updating stacks, see [AWS CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html) .
> To cross-reference two security groups in the ingress and egress rules of those security groups, use the [AWS::EC2::SecurityGroupEgress](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html) and [AWS::EC2::SecurityGroupIngress](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-ingress.html) resources to define your rules. Do not use the embedded ingress and egress rules in the AWS::EC2::SecurityGroup . Doing so creates a circular dependency, which AWS CloudFormation doesn't allow.
AWS::EC2::SecurityGroup external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnSecurityGroupProps);

Create a new AWS::EC2::SecurityGroup.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrGroupId

readonly attrGroupId: string;

The group ID of the specified security group, such as sg-94b3a1f6 . GroupId

property attrVpcId

readonly attrVpcId: string;

The physical ID of the VPC. You can obtain the physical ID by using a reference to an [AWS::EC2::VPC](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html) , such as: { "Ref" : "myVPC" } . VpcId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property groupDescription

groupDescription: string;

A description for the security group.
Constraints: Up to 255 characters in length
Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-groupdescription

property groupName

groupName: string;

The name of the security group.
Constraints: Up to 255 characters in length. Cannot start with sg- .
Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-groupname

property securityGroupEgress

securityGroupEgress: any;

The outbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-securitygroupegress

property securityGroupIngress

securityGroupIngress: any;

The inbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-securitygroupingress

property tags

readonly tags: cdk.TagManager;

Any tags assigned to the security group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-tags

property vpcId

vpcId: string;

The ID of the VPC for the security group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-vpcid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnSecurityGroupEgress

class CfnSecurityGroupEgress extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::SecurityGroupEgress
Adds the specified egress rules to a security group.
An outbound rule permits instances to send traffic to the specified destination IPv4 or IPv6 CIDR address ranges, or to the specified destination security groups for the same VPC.
You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.
You must specify only one of the following properties: CidrIp , CidrIpv6 , DestinationPrefixListId , or DestinationSecurityGroupId .
You must specify a destination security group ( DestinationPrefixListId or DestinationSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ). If you do not specify one of these parameters, the stack will launch successfully but the rule will not be added to the security group.
Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.
For more information about VPC security group limits, see [Amazon VPC Limits](https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html) .
Use AWS::EC2::SecurityGroupIngress and AWS::EC2::SecurityGroupEgress only when necessary, typically to allow security groups to reference each other in ingress and egress rules. Otherwise, use the embedded ingress and egress rules of the security group. For more information, see [Amazon EC2 Security Groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html) .
AWS::EC2::SecurityGroupEgress external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnSecurityGroupEgressProps
);

Create a new AWS::EC2::SecurityGroupEgress.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property cidrIp

cidrIp: string;

The IPv4 address range, in CIDR format.
You must specify a destination security group ( DestinationPrefixListId or DestinationSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ).
For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-cidrip

property cidrIpv6

cidrIpv6: string;

The IPv6 address range, in CIDR format.
You must specify a destination security group ( DestinationPrefixListId or DestinationSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ).
For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-cidripv6

property description

description: string;

The description of an egress (outbound) security group rule.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-description

property destinationPrefixListId

destinationPrefixListId: string;

The prefix list IDs for an AWS service. This is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.
You must specify a destination security group ( DestinationPrefixListId or DestinationSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-destinationprefixlistid

property destinationSecurityGroupId

destinationSecurityGroupId: string;

The ID of the security group.
You must specify a destination security group ( DestinationPrefixListId or DestinationSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-destinationsecuritygroupid

property fromPort

fromPort: number;

If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-fromport

property groupId

groupId: string;

The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-groupid

property ipProtocol

ipProtocol: string;

The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) ).
Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-ipprotocol

property toPort

toPort: number;

If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-toport

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnSecurityGroupIngress

class CfnSecurityGroupIngress extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::SecurityGroupIngress
Adds an inbound rule to a security group.
An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address range, or from the instances associated with the specified security group.
You must specify only one of the following properties: CidrIp , CidrIpv6 , SourcePrefixListId , SourceSecurityGroupId , or SourceSecurityGroupName .
You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify a port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.
You must specify a source security group ( SourcePrefixListId , SourceSecurityGroupId , or SourceSecurityGroupName ) or a CIDR range ( CidrIp or CidrIpv6 ). If you do not specify one of these parameters, the stack will launch successfully but the rule will not be added to the security group.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
AWS::EC2::SecurityGroupIngress external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnSecurityGroupIngressProps
);

Create a new AWS::EC2::SecurityGroupIngress.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property cidrIp

cidrIp: string;

The IPv4 address range, in CIDR format.
You must specify a source security group ( SourcePrefixListId or SourceSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ).
For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-cidrip

property cidrIpv6

cidrIpv6: string;

The IPv6 address range, in CIDR format.
You must specify a source security group ( SourcePrefixListId or SourceSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ).
For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-cidripv6

property description

description: string;

Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-description

property fromPort

fromPort: number;

The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
Use this for ICMP and any protocol that uses ports.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-fromport

property groupId

groupId: string;

The ID of the security group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-groupid

property groupName

groupName: string;

The name of the security group.
Constraints: Up to 255 characters in length. Cannot start with sg- .
Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-groupname

property ipProtocol

ipProtocol: string;

The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) ).
Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-ipprotocol

property sourcePrefixListId

sourcePrefixListId: string;

The ID of a prefix list.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-securitygroupingress-sourceprefixlistid

property sourceSecurityGroupId

sourceSecurityGroupId: string;

The ID of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-sourcesecuritygroupid

property sourceSecurityGroupName

sourceSecurityGroupName: string;

[Default VPC] The name of the source security group. You must specify either the security group ID or the security group name. You can't specify the group name in combination with an IP address range. Creates rules that grant full ICMP, UDP, and TCP access.
For security groups in a nondefault VPC, you must specify the group ID.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-sourcesecuritygroupname

property sourceSecurityGroupOwnerId

sourceSecurityGroupOwnerId: string;

[nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account. You can't specify this property with an IP address range. Creates rules that grant full ICMP, UDP, and TCP access.
If you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify SourceSecurityGroupOwnerId ; otherwise, this property is optional.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-sourcesecuritygroupownerid

property toPort

toPort: number;

The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.
Use this for ICMP and any protocol that uses ports.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-toport

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnSpotFleet

class CfnSpotFleet extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::SpotFleet
Specifies a Spot Fleet request.
The Spot Fleet request specifies the total target capacity and the On-Demand target capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity.
You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.
Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet.
You can specify tags for the Spot Fleet request and instances launched by the fleet. You cannot tag other resource types in a Spot Fleet request because only the spot-fleet-request and instance resource types are supported.
For more information, see [Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet.html) in the *Amazon EC2 User Guide for Linux Instances* .
> We strongly discourage using the RequestSpotFleet API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see [Which is the best Spot request method to use?](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-best-practices.html#which-spot-request-method-to-use) in the *Amazon EC2 User Guide for Linux Instances* .
AWS::EC2::SpotFleet external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-spotfleet.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnSpotFleetProps);

Create a new AWS::EC2::SpotFleet.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrId

readonly attrId: string;

The ID of the Spot Fleet. Id

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property spotFleetRequestConfigData

spotFleetRequestConfigData: any;

Describes the configuration of a Spot Fleet request.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-spotfleet.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnSubnet

class CfnSubnet extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::Subnet
Specifies a subnet for the specified VPC.
For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.
For more information, see [Subnets for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) in the *Amazon VPC User Guide* .
AWS::EC2::Subnet external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnSubnetProps);

Create a new AWS::EC2::Subnet.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property assignIpv6AddressOnCreation

assignIpv6AddressOnCreation: any;

Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is false .
If you specify AssignIpv6AddressOnCreation , you must also specify Ipv6CidrBlock .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-assignipv6addressoncreation

property attrAvailabilityZone

readonly attrAvailabilityZone: string;

The Availability Zone of this subnet. For example:
{ "Fn::GetAtt" : [ "mySubnet", "AvailabilityZone" ] } AvailabilityZone

property attrIpv6CidrBlocks

readonly attrIpv6CidrBlocks: string[];

The IPv6 CIDR blocks that are associated with the subnet, such as [ 2001:db8:1234:1a00::/64 ] . Ipv6CidrBlocks

property attrNetworkAclAssociationId

readonly attrNetworkAclAssociationId: string;

The ID of the network ACL that is associated with the subnet's VPC, such as acl-5fb85d36 . NetworkAclAssociationId

property attrOutpostArn

readonly attrOutpostArn: string;

The Amazon Resource Name (ARN) of the Outpost. OutpostArn

property attrSubnetId

readonly attrSubnetId: string;

The ID of the subnet. SubnetId

property attrVpcId

readonly attrVpcId: string;

The ID of the subnet's VPC, such as vpc-11ad4878 . VpcId

property availabilityZone

availabilityZone: string;

The Availability Zone of the subnet.
If you update this property, you must also update the CidrBlock property.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-availabilityzone

property availabilityZoneId

availabilityZoneId: string;

The AZ ID of the subnet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-availabilityzoneid

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property cidrBlock

cidrBlock: string;

The IPv4 CIDR block assigned to the subnet.
If you update this property, we create a new subnet, and then delete the existing one.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-cidrblock

property enableDns64

enableDns64: any;

Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. For more information, see [DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-nat64-dns64) in the *Amazon Virtual Private Cloud User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-enabledns64

property ipv6CidrBlock

ipv6CidrBlock: string;

The IPv6 CIDR block.
If you specify AssignIpv6AddressOnCreation , you must also specify Ipv6CidrBlock .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv6cidrblock

property ipv6Native

ipv6Native: any;

Indicates whether this is an IPv6 only subnet. For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *Amazon Virtual Private Cloud User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv6native

property mapPublicIpOnLaunch

mapPublicIpOnLaunch: any;

Indicates whether instances launched in this subnet receive a public IPv4 address. The default value is false .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-mappubliciponlaunch

property outpostArn

outpostArn: string;

The Amazon Resource Name (ARN) of the Outpost.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-outpostarn

property privateDnsNameOptionsOnLaunch

privateDnsNameOptionsOnLaunch: any;

The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide* .
Available options:
- EnableResourceNameDnsAAAARecord (true | false) - EnableResourceNameDnsARecord (true | false) - HostnameType (ip-name | resource-name)
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-privatednsnameoptionsonlaunch

property tags

readonly tags: cdk.TagManager;

Any tags assigned to the subnet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-tags

property vpcId

vpcId: string;

The ID of the VPC the subnet is in.
If you update this property, you must also update the CidrBlock property.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-vpcid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnSubnetCidrBlock

class CfnSubnetCidrBlock extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::SubnetCidrBlock
Associates a CIDR block with your subnet. You can associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64.
AWS::EC2::SubnetCidrBlock external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnSubnetCidrBlockProps);

Create a new AWS::EC2::SubnetCidrBlock.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrId

readonly attrId: string;

The ID of the association. Id

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property ipv6CidrBlock

ipv6CidrBlock: string;

The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length.
This parameter is required for an IPv6 only subnet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-ipv6cidrblock

property subnetId

subnetId: string;

The ID of the subnet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-subnetid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnSubnetNetworkAclAssociation

class CfnSubnetNetworkAclAssociation
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::SubnetNetworkAclAssociation
Associates a subnet with a network ACL. For more information, see [ReplaceNetworkAclAssociation](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-ReplaceNetworkAclAssociation.html) in the *Amazon EC2 API Reference* .
When AWS::EC2::SubnetNetworkAclAssociation resources are created during create or update operations, AWS CloudFormation adopts existing resources that share the same key properties (the properties that contribute to uniquely identify the resource). However, if the operation fails and rolls back, AWS CloudFormation deletes the previously out-of-band resources. You can protect against this behavior by using Retain deletion policies. For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) .
AWS::EC2::SubnetNetworkAclAssociation external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet-network-acl-assoc.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnSubnetNetworkAclAssociationProps
);

Create a new AWS::EC2::SubnetNetworkAclAssociation.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrAssociationId

readonly attrAssociationId: string;

Returns the value of this object's [SubnetId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet-network-acl-assoc.html) property. AssociationId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property networkAclId

networkAclId: string;

The ID of the network ACL.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet-network-acl-assoc.html#cfn-ec2-subnetnetworkaclassociation-networkaclid

property subnetId

subnetId: string;

The ID of the subnet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet-network-acl-assoc.html#cfn-ec2-subnetnetworkaclassociation-associationid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnSubnetRouteTableAssociation

class CfnSubnetRouteTableAssociation
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::SubnetRouteTableAssociation
Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. A route table can be associated with multiple subnets. To create a route table, see [AWS::EC2::RouteTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html) .
AWS::EC2::SubnetRouteTableAssociation external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetroutetableassociation.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnSubnetRouteTableAssociationProps
);

Create a new AWS::EC2::SubnetRouteTableAssociation.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrId

readonly attrId: string;

The ID of the subnet route table association. Id

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property routeTableId

routeTableId: string;

The ID of the route table.
The physical ID changes when the route table ID is changed.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetroutetableassociation.html#cfn-ec2-subnetroutetableassociation-routetableid

property subnetId

subnetId: string;

The ID of the subnet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetroutetableassociation.html#cfn-ec2-subnetroutetableassociation-subnetid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnTrafficMirrorFilter

class CfnTrafficMirrorFilter extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::TrafficMirrorFilter
Specifies a Traffic Mirror filter.
A Traffic Mirror filter is a set of rules that defines the traffic to mirror.
By default, no traffic is mirrored. To mirror traffic, use [AWS::EC2::TrafficMirrorFilterRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html) to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored.
AWS::EC2::TrafficMirrorFilter external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props?: CfnTrafficMirrorFilterProps
);

Create a new AWS::EC2::TrafficMirrorFilter.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property description

description: string;

The description of the Traffic Mirror filter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html#cfn-ec2-trafficmirrorfilter-description

property networkServices

networkServices: string[];

The network service traffic that is associated with the Traffic Mirror filter.
Valid values are amazon-dns .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html#cfn-ec2-trafficmirrorfilter-networkservices

property tags

readonly tags: cdk.TagManager;

The tags to assign to a Traffic Mirror filter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html#cfn-ec2-trafficmirrorfilter-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnTrafficMirrorFilterRule

class CfnTrafficMirrorFilterRule
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::TrafficMirrorFilterRule
Creates a Traffic Mirror filter rule.
A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.
You need the Traffic Mirror filter ID when you create the rule.
AWS::EC2::TrafficMirrorFilterRule external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnTrafficMirrorFilterRuleProps
);

Create a new AWS::EC2::TrafficMirrorFilterRule.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property description

description: string;

The description of the Traffic Mirror rule.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-description

property destinationCidrBlock

destinationCidrBlock: string;

The destination CIDR block to assign to the Traffic Mirror rule.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-destinationcidrblock

property destinationPortRange

destinationPortRange: any;

The destination port range.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-destinationportrange

property protocol

protocol: number;

The protocol, for example UDP, to assign to the Traffic Mirror rule.
For information about the protocol value, see [Protocol Numbers](https://docs.aws.amazon.com/https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) on the Internet Assigned Numbers Authority (IANA) website.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-protocol

property ruleAction

ruleAction: string;

The action to take on the filtered traffic.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-ruleaction

property ruleNumber

ruleNumber: number;

The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-rulenumber

property sourceCidrBlock

sourceCidrBlock: string;

The source CIDR block to assign to the Traffic Mirror rule.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-sourcecidrblock

property sourcePortRange

sourcePortRange: any;

The source port range.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-sourceportrange

property trafficDirection

trafficDirection: string;

The type of traffic.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-trafficdirection

property trafficMirrorFilterId

trafficMirrorFilterId: string;

The ID of the filter that this rule is associated with.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-trafficmirrorfilterid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnTrafficMirrorSession

class CfnTrafficMirrorSession extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::TrafficMirrorSession
Creates a Traffic Mirror session.
A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic.
The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.
By default, no traffic is mirrored. Use [AWS::EC2::TrafficMirrorFilterRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html) to specify filter rules that specify the traffic to mirror.
AWS::EC2::TrafficMirrorSession external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnTrafficMirrorSessionProps
);

Create a new AWS::EC2::TrafficMirrorSession.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property description

description: string;

The description of the Traffic Mirror session.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-description

property networkInterfaceId

networkInterfaceId: string;

The ID of the source network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-networkinterfaceid

property packetLength

packetLength: number;

The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do not specify this parameter when you want to mirror the entire packet. To mirror a subset of the packet, set this to the length (in bytes) that you want to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target.
If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-packetlength

property sessionNumber

sessionNumber: number;

The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-sessionnumber

property tags

readonly tags: cdk.TagManager;

The tags to assign to a Traffic Mirror session.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-tags

property trafficMirrorFilterId

trafficMirrorFilterId: string;

The ID of the Traffic Mirror filter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-trafficmirrorfilterid

property trafficMirrorTargetId

trafficMirrorTargetId: string;

The ID of the Traffic Mirror target.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-trafficmirrortargetid

property virtualNetworkId

virtualNetworkId: number;

The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN protocol, see [RFC 7348](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc7348) . If you do not specify a VirtualNetworkId , an account-wide unique id is chosen at random.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-virtualnetworkid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnTrafficMirrorTarget

class CfnTrafficMirrorTarget extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::TrafficMirrorTarget
Specifies a target for your Traffic Mirror session.
A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.
A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.
To use the target in a Traffic Mirror session, use [AWS::EC2::TrafficMirrorSession](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html) .
AWS::EC2::TrafficMirrorTarget external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props?: CfnTrafficMirrorTargetProps
);

Create a new AWS::EC2::TrafficMirrorTarget.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property description

description: string;

The description of the Traffic Mirror target.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-description

property gatewayLoadBalancerEndpointId

gatewayLoadBalancerEndpointId: string;

The ID of the Gateway Load Balancer endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-gatewayloadbalancerendpointid

property networkInterfaceId

networkInterfaceId: string;

The network interface ID that is associated with the target.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-networkinterfaceid

property networkLoadBalancerArn

networkLoadBalancerArn: string;

The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-networkloadbalancerarn

property tags

readonly tags: cdk.TagManager;

The tags to assign to the Traffic Mirror target.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnTransitGateway

class CfnTransitGateway extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::TransitGateway
Specifies a transit gateway.
You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After the transit gateway enters the available state, you can attach your VPCs and VPN connections to the transit gateway.
To attach your VPCs, use [AWS::EC2::TransitGatewayAttachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html) .
To attach a VPN connection, use [AWS::EC2::CustomerGateway](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customer-gateway.html) to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to [AWS::EC2::VPNConnection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html) .
When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use [AWS::EC2::TransitGatewayRouteTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetable.html) to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use [AWS::EC2::TransitGatewayRouteTablePropagation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetablepropagation.html) to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use [AWS::EC2::TransitGatewayRouteTableAssociation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetableassociation.html) to associate a resource attachment with a transit gateway route table.
AWS::EC2::TransitGateway external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html

constructor

constructor(scope: cdk.Construct, id: string, props?: CfnTransitGatewayProps);

Create a new AWS::EC2::TransitGateway.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property amazonSideAsn

amazonSideAsn: number;

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs. The default is 64512.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-amazonsideasn

property associationDefaultRouteTableId

associationDefaultRouteTableId: string;

The ID of the default association route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-associationdefaultroutetableid

property attrId

readonly attrId: string;

The ID of the transit gateway. Id

property autoAcceptSharedAttachments

autoAcceptSharedAttachments: string;

Enable or disable automatic acceptance of attachment requests. Disabled by default.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-autoacceptsharedattachments

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property defaultRouteTableAssociation

defaultRouteTableAssociation: string;

Enable or disable automatic association with the default association route table. Enabled by default.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-defaultroutetableassociation

property defaultRouteTablePropagation

defaultRouteTablePropagation: string;

Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-defaultroutetablepropagation

property description

description: string;

The description of the transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-description

property dnsSupport

dnsSupport: string;

Enable or disable DNS support. Enabled by default.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-dnssupport

property multicastSupport

multicastSupport: string;

Indicates whether multicast is enabled on the transit gateway
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-multicastsupport

property propagationDefaultRouteTableId

propagationDefaultRouteTableId: string;

The ID of the default propagation route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-propagationdefaultroutetableid

property tags

readonly tags: cdk.TagManager;

The tags for the transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-tags

property transitGatewayCidrBlocks

transitGatewayCidrBlocks: string[];

The transit gateway CIDR blocks.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-transitgatewaycidrblocks

property vpnEcmpSupport

vpnEcmpSupport: string;

Enable or disable Equal Cost Multipath Protocol support. Enabled by default.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-vpnecmpsupport

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnTransitGatewayAttachment

class CfnTransitGatewayAttachment
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::TransitGatewayAttachment
Attaches a VPC to a transit gateway.
If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table.
To send VPC traffic to an attached transit gateway, add a route to the VPC route table using [AWS::EC2::Route](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html) .
To update tags for a VPC attachment after creation without replacing the attachment, use [AWS::EC2::TransitGatewayVpcAttachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html) instead.
AWS::EC2::TransitGatewayAttachment external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnTransitGatewayAttachmentProps
);

Create a new AWS::EC2::TransitGatewayAttachment.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrId

readonly attrId: string;

The ID of the attachment. Id

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property options

options: any;

The VPC attachment options, in JSON or YAML.
- ApplianceModeSupport - Set to enable or disable . The default is disable . - DnsSupport - Set to enable or disable . The default is enable . - Ipv6Support - Set to enable or disable . The default is disable .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#cfn-ec2-transitgatewayattachment-options

property subnetIds

subnetIds: string[];

The IDs of one or more subnets. You can specify only one subnet per Availability Zone. You must specify at least one subnet, but we recommend that you specify two subnets for better availability. The transit gateway uses one IP address from each specified subnet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#cfn-ec2-transitgatewayattachment-subnetids

property tags

readonly tags: cdk.TagManager;

The tags for the attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#cfn-ec2-transitgatewayattachment-tags

property transitGatewayId

transitGatewayId: string;

The ID of the transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#cfn-ec2-transitgatewayattachment-transitgatewayid

property vpcId

vpcId: string;

The ID of the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#cfn-ec2-transitgatewayattachment-vpcid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnTransitGatewayConnect

class CfnTransitGatewayConnect extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::TransitGatewayConnect
Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.
A Connect attachment uses an existing VPC or AWS Direct Connect attachment as the underlying transport mechanism.
AWS::EC2::TransitGatewayConnect external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnect.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnTransitGatewayConnectProps
);

Create a new AWS::EC2::TransitGatewayConnect.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrCreationTime

readonly attrCreationTime: string;

The creation time. CreationTime

property attrState

readonly attrState: string;

The state of the attachment. State

property attrTransitGatewayAttachmentId

readonly attrTransitGatewayAttachmentId: string;

The ID of the transit gateway attachment. TransitGatewayAttachmentId

property attrTransitGatewayId

readonly attrTransitGatewayId: string;

The ID of the transit gateway. TransitGatewayId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property options

options: any;

The Connect attachment options.
- protocol (gre)
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnect.html#cfn-ec2-transitgatewayconnect-options

property tags

readonly tags: cdk.TagManager;

The tags for the attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnect.html#cfn-ec2-transitgatewayconnect-tags

property transportTransitGatewayAttachmentId

transportTransitGatewayAttachmentId: string;

The ID of the attachment from which the Connect attachment was created.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnect.html#cfn-ec2-transitgatewayconnect-transporttransitgatewayattachmentid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnTransitGatewayMulticastDomain

class CfnTransitGatewayMulticastDomain
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::TransitGatewayMulticastDomain
Creates a multicast domain using the specified transit gateway.
The transit gateway must be in the available state before you create a domain.
AWS::EC2::TransitGatewayMulticastDomain external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomain.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnTransitGatewayMulticastDomainProps
);

Create a new AWS::EC2::TransitGatewayMulticastDomain.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrCreationTime

readonly attrCreationTime: string;

The time the multicast domain was created. CreationTime

property attrState

readonly attrState: string;

The state of the multicast domain. State

property attrTransitGatewayMulticastDomainArn

readonly attrTransitGatewayMulticastDomainArn: string;

The Amazon Resource Name (ARN) of the multicast domain. TransitGatewayMulticastDomainArn

property attrTransitGatewayMulticastDomainId

readonly attrTransitGatewayMulticastDomainId: string;

The ID of the multicast domain. TransitGatewayMulticastDomainId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property options

options: any;

The options for the transit gateway multicast domain.
- AutoAcceptSharedAssociations (enable | disable) - Igmpv2Support (enable | disable) - StaticSourcesSupport (enable | disable)
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomain.html#cfn-ec2-transitgatewaymulticastdomain-options

property tags

readonly tags: cdk.TagManager;

The tags for the transit gateway multicast domain.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomain.html#cfn-ec2-transitgatewaymulticastdomain-tags

property transitGatewayId

transitGatewayId: string;

The ID of the transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomain.html#cfn-ec2-transitgatewaymulticastdomain-transitgatewayid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnTransitGatewayMulticastDomainAssociation

class CfnTransitGatewayMulticastDomainAssociation
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::TransitGatewayMulticastDomainAssociation
Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
The transit gateway attachment must be in the available state before you can add a resource.
AWS::EC2::TransitGatewayMulticastDomainAssociation external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomainassociation.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnTransitGatewayMulticastDomainAssociationProps
);

Create a new AWS::EC2::TransitGatewayMulticastDomainAssociation.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrResourceId

readonly attrResourceId: string;

The ID of the resource. ResourceId

property attrResourceType

readonly attrResourceType: string;

The type of resource, for example a VPC attachment. ResourceType

property attrState

readonly attrState: string;

The state of the resource. State

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property subnetId

subnetId: string;

The IDs of the subnets to associate with the transit gateway multicast domain.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomainassociation.html#cfn-ec2-transitgatewaymulticastdomainassociation-subnetid

property transitGatewayAttachmentId

transitGatewayAttachmentId: string;

The ID of the transit gateway attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomainassociation.html#cfn-ec2-transitgatewaymulticastdomainassociation-transitgatewayattachmentid

property transitGatewayMulticastDomainId

transitGatewayMulticastDomainId: string;

The ID of the transit gateway multicast domain.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomainassociation.html#cfn-ec2-transitgatewaymulticastdomainassociation-transitgatewaymulticastdomainid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnTransitGatewayMulticastGroupMember

class CfnTransitGatewayMulticastGroupMember
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::TransitGatewayMulticastGroupMember
Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated with a supported EC2 instance that receives multicast traffic. For information about supported instances, see [Multicast Consideration](https://docs.aws.amazon.com/vpc/latest/tgw/transit-gateway-limits.html#multicast-limits) in *Amazon VPC Transit Gateways* .
AWS::EC2::TransitGatewayMulticastGroupMember external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupmember.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnTransitGatewayMulticastGroupMemberProps
);

Create a new AWS::EC2::TransitGatewayMulticastGroupMember.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrGroupMember

readonly attrGroupMember: cdk.IResolvable;

Information about the registered transit gateway multicast domain group members. GroupMember

property attrGroupSource

readonly attrGroupSource: cdk.IResolvable;

Indicates that the resource is a transit gateway multicast domain group member. GroupSource

property attrMemberType

readonly attrMemberType: string;

The type of group member, for example static. MemberType

property attrResourceId

readonly attrResourceId: string;

The ID of the resource. ResourceId

property attrResourceType

readonly attrResourceType: string;

The type of resource, for example a VPC attachment. ResourceType

property attrSourceType

readonly attrSourceType: string;

The type of source. SourceType

property attrSubnetId

readonly attrSubnetId: string;

The ID of the subnet. SubnetId

property attrTransitGatewayAttachmentId

readonly attrTransitGatewayAttachmentId: string;

The ID of the transit gateway attachment. TransitGatewayAttachmentId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property groupIpAddress

groupIpAddress: string;

The IP address assigned to the transit gateway multicast group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupmember.html#cfn-ec2-transitgatewaymulticastgroupmember-groupipaddress

property networkInterfaceId

networkInterfaceId: string;

The group members' network interface IDs to register with the transit gateway multicast group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupmember.html#cfn-ec2-transitgatewaymulticastgroupmember-networkinterfaceid

property transitGatewayMulticastDomainId

transitGatewayMulticastDomainId: string;

The ID of the transit gateway multicast domain.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupmember.html#cfn-ec2-transitgatewaymulticastgroupmember-transitgatewaymulticastdomainid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnTransitGatewayMulticastGroupSource

class CfnTransitGatewayMulticastGroupSource
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::TransitGatewayMulticastGroupSource
Registers sources (network interfaces) with the specified transit gateway multicast domain.
A multicast source is a network interface attached to a supported instance that sends multicast traffic. For information about supported instances, see [Multicast Considerations](https://docs.aws.amazon.com/vpc/latest/tgw/transit-gateway-limits.html#multicast-limits) in *Amazon VPC Transit Gateways* .
AWS::EC2::TransitGatewayMulticastGroupSource external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupsource.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnTransitGatewayMulticastGroupSourceProps
);

Create a new AWS::EC2::TransitGatewayMulticastGroupSource.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrGroupMember

readonly attrGroupMember: cdk.IResolvable;

Information about the registered transit gateway multicast domain group members. GroupMember

property attrGroupSource

readonly attrGroupSource: cdk.IResolvable;

Indicates that the resource is a transit gateway group member. GroupSource

property attrMemberType

readonly attrMemberType: string;

The type of group member, for example static. MemberType

property attrResourceId

readonly attrResourceId: string;

The ID of the resource. ResourceId

property attrResourceType

readonly attrResourceType: string;

The type of resource, for example a VPC attachment. ResourceType

property attrSourceType

readonly attrSourceType: string;

The type of source. SourceType

property attrSubnetId

readonly attrSubnetId: string;

The ID of the subnet. SubnetId

property attrTransitGatewayAttachmentId

readonly attrTransitGatewayAttachmentId: string;

The ID of the transit gateway attachment. TransitGatewayAttachmentId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property groupIpAddress

groupIpAddress: string;

The IP address assigned to the transit gateway multicast group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupsource.html#cfn-ec2-transitgatewaymulticastgroupsource-groupipaddress

property networkInterfaceId

networkInterfaceId: string;

The group sources' network interface IDs to register with the transit gateway multicast group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupsource.html#cfn-ec2-transitgatewaymulticastgroupsource-networkinterfaceid

property transitGatewayMulticastDomainId

transitGatewayMulticastDomainId: string;

The ID of the transit gateway multicast domain.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupsource.html#cfn-ec2-transitgatewaymulticastgroupsource-transitgatewaymulticastdomainid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnTransitGatewayPeeringAttachment

class CfnTransitGatewayPeeringAttachment
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::TransitGatewayPeeringAttachment
Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The peer transit gateway can be in your account or a different AWS account .
After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.
AWS::EC2::TransitGatewayPeeringAttachment external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnTransitGatewayPeeringAttachmentProps
);

Create a new AWS::EC2::TransitGatewayPeeringAttachment.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrCreationTime

readonly attrCreationTime: string;

The time the transit gateway peering attachment was created. CreationTime

property attrState

readonly attrState: string;

The state of the transit gateway peering attachment. Note that the initiating state has been deprecated. State

property attrStatusCode

readonly attrStatusCode: string;

The status code. Status.Code

property attrStatusMessage

readonly attrStatusMessage: string;

The status message. Status.Message

property attrTransitGatewayAttachmentId

readonly attrTransitGatewayAttachmentId: string;

The ID of the transit gateway peering attachment. TransitGatewayAttachmentId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property peerAccountId

peerAccountId: string;

The ID of the AWS account that owns the transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#cfn-ec2-transitgatewaypeeringattachment-peeraccountid

property peerRegion

peerRegion: string;

The Region of the transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#cfn-ec2-transitgatewaypeeringattachment-peerregion

property peerTransitGatewayId

peerTransitGatewayId: string;

The ID of the transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#cfn-ec2-transitgatewaypeeringattachment-peertransitgatewayid

property tags

readonly tags: cdk.TagManager;

The tags for the transit gateway peering attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#cfn-ec2-transitgatewaypeeringattachment-tags

property transitGatewayId

transitGatewayId: string;

The ID of the transit gateway peering attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#cfn-ec2-transitgatewaypeeringattachment-transitgatewayid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnTransitGatewayRoute

class CfnTransitGatewayRoute extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::TransitGatewayRoute
Specifies a static route for a transit gateway route table.
AWS::EC2::TransitGatewayRoute external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnTransitGatewayRouteProps
);

Create a new AWS::EC2::TransitGatewayRoute.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property blackhole

blackhole: any;

Indicates whether to drop traffic that matches this route.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html#cfn-ec2-transitgatewayroute-blackhole

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property destinationCidrBlock

destinationCidrBlock: string;

The CIDR block used for destination matches.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html#cfn-ec2-transitgatewayroute-destinationcidrblock

property transitGatewayAttachmentId

transitGatewayAttachmentId: string;

The ID of the attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html#cfn-ec2-transitgatewayroute-transitgatewayattachmentid

property transitGatewayRouteTableId

transitGatewayRouteTableId: string;

The ID of the transit gateway route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html#cfn-ec2-transitgatewayroute-transitgatewayroutetableid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnTransitGatewayRouteTable

class CfnTransitGatewayRouteTable
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::TransitGatewayRouteTable
Specifies a route table for a transit gateway.
AWS::EC2::TransitGatewayRouteTable external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetable.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnTransitGatewayRouteTableProps
);

Create a new AWS::EC2::TransitGatewayRouteTable.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property tags

readonly tags: cdk.TagManager;

Any tags assigned to the route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetable.html#cfn-ec2-transitgatewayroutetable-tags

property transitGatewayId

transitGatewayId: string;

The ID of the transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetable.html#cfn-ec2-transitgatewayroutetable-transitgatewayid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnTransitGatewayRouteTableAssociation

class CfnTransitGatewayRouteTableAssociation
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::TransitGatewayRouteTableAssociation
Associates the specified attachment with the specified transit gateway route table. You can associate one route table with an attachment.
Before you can update the route table associated with an attachment, you must disassociate the transit gateway route table that is currently associated with the attachment. First update the stack to remove the associated transit gateway route table, and then update the stack with the ID of the new transit gateway route table to associate.
AWS::EC2::TransitGatewayRouteTableAssociation external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetableassociation.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnTransitGatewayRouteTableAssociationProps
);

Create a new AWS::EC2::TransitGatewayRouteTableAssociation.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property transitGatewayAttachmentId

transitGatewayAttachmentId: string;

The ID of the attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetableassociation.html#cfn-ec2-transitgatewayroutetableassociation-transitgatewayattachmentid

property transitGatewayRouteTableId

transitGatewayRouteTableId: string;

The ID of the route table for the transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetableassociation.html#cfn-ec2-transitgatewayroutetableassociation-transitgatewayroutetableid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnTransitGatewayRouteTablePropagation

class CfnTransitGatewayRouteTablePropagation
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::TransitGatewayRouteTablePropagation
Enables the specified attachment to propagate routes to the specified propagation route table.
For more information about enabling transit gateway route propagation, see [EnableTransitGatewayRouteTablePropagation](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EnableTransitGatewayRouteTablePropagation.html) in the *Amazon EC2 API Reference* .
AWS::EC2::TransitGatewayRouteTablePropagation external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetablepropagation.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnTransitGatewayRouteTablePropagationProps
);

Create a new AWS::EC2::TransitGatewayRouteTablePropagation.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property transitGatewayAttachmentId

transitGatewayAttachmentId: string;

The ID of the attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetablepropagation.html#cfn-ec2-transitgatewayroutetablepropagation-transitgatewayattachmentid

property transitGatewayRouteTableId

transitGatewayRouteTableId: string;

The ID of the propagation route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetablepropagation.html#cfn-ec2-transitgatewayroutetablepropagation-transitgatewayroutetableid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnTransitGatewayVpcAttachment

class CfnTransitGatewayVpcAttachment
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::TransitGatewayVpcAttachment
Specifies a VPC attachment.
AWS::EC2::TransitGatewayVpcAttachment external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnTransitGatewayVpcAttachmentProps
);

Create a new AWS::EC2::TransitGatewayVpcAttachment.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property addSubnetIds

addSubnetIds: string[];

The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-addsubnetids

property attrId

readonly attrId: string;

The ID of the attachment. Id

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property options

options: any;

The VPC attachment options, in JSON or YAML.
- ApplianceModeSupport - Set to enable or disable . The default is disable . - DnsSupport - Set to enable or disable . The default is enable . - Ipv6Support - Set to enable or disable . The default is disable .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-options

property removeSubnetIds

removeSubnetIds: string[];

The IDs of one or more subnets to remove.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-removesubnetids

property subnetIds

subnetIds: string[];

The IDs of the subnets.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-subnetids

property tags

readonly tags: cdk.TagManager;

The tags for the VPC attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-tags

property transitGatewayId

transitGatewayId: string;

The ID of the transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-transitgatewayid

property vpcId

vpcId: string;

The ID of the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-vpcid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnVerifiedAccessEndpoint

class CfnVerifiedAccessEndpoint
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::VerifiedAccessEndpoint
An AWS Verified Access endpoint specifies the application that AWS Verified Access provides access to. It must be attached to an AWS Verified Access group. An AWS Verified Access endpoint must also have an attached access policy before you attached it to a group.
AWS::EC2::VerifiedAccessEndpoint external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnVerifiedAccessEndpointProps
);

Create a new AWS::EC2::VerifiedAccessEndpoint.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property applicationDomain

applicationDomain: string;

The DNS name for users to reach your application.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-applicationdomain

property attachmentType

attachmentType: string;

The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-attachmenttype

property attrCreationTime

readonly attrCreationTime: string;

The creation time. CreationTime

property attrDeviceValidationDomain

readonly attrDeviceValidationDomain: string;

Use this to construct the redirect URI to add to your OIDC provider's allow list. DeviceValidationDomain

property attrEndpointDomain

readonly attrEndpointDomain: string;

The DNS name generated for the endpoint. EndpointDomain

property attrLastUpdatedTime

readonly attrLastUpdatedTime: string;

The last updated time. LastUpdatedTime

property attrStatus

readonly attrStatus: string;

The endpoint status. Status

property attrVerifiedAccessEndpointId

readonly attrVerifiedAccessEndpointId: string;

The ID of the Verified Access endpoint. VerifiedAccessEndpointId

property attrVerifiedAccessInstanceId

readonly attrVerifiedAccessInstanceId: string;

The instance identifier. VerifiedAccessInstanceId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property description

description: string;

A description for the AWS Verified Access endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-description

property domainCertificateArn

domainCertificateArn: string;

The ARN of a public TLS/SSL certificate imported into or created with ACM.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-domaincertificatearn

property endpointDomainPrefix

endpointDomainPrefix: string;

A custom identifier that is prepended to the DNS name that is generated for the endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-endpointdomainprefix

property endpointType

endpointType: string;

The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-endpointtype

property loadBalancerOptions

loadBalancerOptions: any;

The load balancer details if creating the AWS Verified Access endpoint as load-balancer type.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-loadbalanceroptions

property networkInterfaceOptions

networkInterfaceOptions: any;

The options for network-interface type endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-networkinterfaceoptions

property policyDocument

policyDocument: string;

The Verified Access policy document.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-policydocument

property policyEnabled

policyEnabled: any;

The status of the Verified Access policy.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-policyenabled

property securityGroupIds

securityGroupIds: string[];

The IDs of the security groups for the endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-securitygroupids

property tags

readonly tags: cdk.TagManager;

The tags.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-tags

property verifiedAccessGroupId

verifiedAccessGroupId: string;

The ID of the AWS Verified Access group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-verifiedaccessgroupid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnVerifiedAccessGroup

class CfnVerifiedAccessGroup extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::VerifiedAccessGroup
Describes a Verified Access group.
AWS::EC2::VerifiedAccessGroup external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnVerifiedAccessGroupProps
);

Create a new AWS::EC2::VerifiedAccessGroup.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrCreationTime

readonly attrCreationTime: string;

The creation time. CreationTime

property attrLastUpdatedTime

readonly attrLastUpdatedTime: string;

The last updated time. LastUpdatedTime

property attrOwner

readonly attrOwner: string;

The ID of the AWS account that owns the group. Owner

property attrVerifiedAccessGroupArn

readonly attrVerifiedAccessGroupArn: string;

The ARN of the Verified Access group. VerifiedAccessGroupArn

property attrVerifiedAccessGroupId

readonly attrVerifiedAccessGroupId: string;

The ID of the Verified Access group. VerifiedAccessGroupId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property description

description: string;

A description for the AWS Verified Access group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#cfn-ec2-verifiedaccessgroup-description

property policyDocument

policyDocument: string;

The Verified Access policy document.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#cfn-ec2-verifiedaccessgroup-policydocument

property policyEnabled

policyEnabled: any;

The status of the Verified Access policy.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#cfn-ec2-verifiedaccessgroup-policyenabled

property tags

readonly tags: cdk.TagManager;

The tags.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#cfn-ec2-verifiedaccessgroup-tags

property verifiedAccessInstanceId

verifiedAccessInstanceId: string;

The ID of the AWS Verified Access instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#cfn-ec2-verifiedaccessgroup-verifiedaccessinstanceid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnVerifiedAccessInstance

class CfnVerifiedAccessInstance
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::VerifiedAccessInstance
Describes a Verified Access instance.
AWS::EC2::VerifiedAccessInstance external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props?: CfnVerifiedAccessInstanceProps
);

Create a new AWS::EC2::VerifiedAccessInstance.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrCreationTime

readonly attrCreationTime: string;

The creation time. CreationTime

property attrLastUpdatedTime

readonly attrLastUpdatedTime: string;

The last updated time. LastUpdatedTime

property attrVerifiedAccessInstanceId

readonly attrVerifiedAccessInstanceId: string;

The ID of the Verified Access instance. VerifiedAccessInstanceId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property description

description: string;

A description for the AWS Verified Access instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#cfn-ec2-verifiedaccessinstance-description

property loggingConfigurations

loggingConfigurations: any;

The current logging configuration for the Verified Access instances.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#cfn-ec2-verifiedaccessinstance-loggingconfigurations

property tags

readonly tags: cdk.TagManager;

The tags.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#cfn-ec2-verifiedaccessinstance-tags

property verifiedAccessTrustProviderIds

verifiedAccessTrustProviderIds: string[];

The IDs of the AWS Verified Access trust providers.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#cfn-ec2-verifiedaccessinstance-verifiedaccesstrustproviderids

property verifiedAccessTrustProviders

verifiedAccessTrustProviders: any;

The IDs of the AWS Verified Access trust providers.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#cfn-ec2-verifiedaccessinstance-verifiedaccesstrustproviders

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnVerifiedAccessTrustProvider

class CfnVerifiedAccessTrustProvider
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::VerifiedAccessTrustProvider
Describes a Verified Access trust provider.
AWS::EC2::VerifiedAccessTrustProvider external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnVerifiedAccessTrustProviderProps
);

Create a new AWS::EC2::VerifiedAccessTrustProvider.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrCreationTime

readonly attrCreationTime: string;

The creation time. CreationTime

property attrLastUpdatedTime

readonly attrLastUpdatedTime: string;

The last updated time. LastUpdatedTime

property attrVerifiedAccessTrustProviderId

readonly attrVerifiedAccessTrustProviderId: string;

The ID of the Verified Access trust provider. VerifiedAccessTrustProviderId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property description

description: string;

A description for the AWS Verified Access trust provider.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-description

property deviceOptions

deviceOptions: any;

The options for device-identity trust provider.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-deviceoptions

property deviceTrustProviderType

deviceTrustProviderType: string;

The type of device-based trust provider.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-devicetrustprovidertype

property oidcOptions

oidcOptions: any;

The options for an OpenID Connect-compatible user-identity trust provider.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions

property policyReferenceName

policyReferenceName: string;

The identifier to be used when working with policy rules.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-policyreferencename

property tags

readonly tags: cdk.TagManager;

The tags.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-tags

property trustProviderType

trustProviderType: string;

The type of Verified Access trust provider.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-trustprovidertype

property userTrustProviderType

userTrustProviderType: string;

The type of user-based trust provider.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-usertrustprovidertype

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnVolume

class CfnVolume extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::Volume
Specifies an Amazon Elastic Block Store (Amazon EBS) volume. You can attach the volume to an instance in the same Availability Zone using [AWS::EC2::VolumeAttachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volumeattachment.html) .
When you use AWS CloudFormation to update an Amazon EBS volume that modifies Iops , Size , or VolumeType , there is a cooldown period before another operation can occur. This can cause your stack to report being in UPDATE_IN_PROGRESS or UPDATE_ROLLBACK_IN_PROGRESS for long periods of time.
Amazon EBS does not support sizing down an Amazon EBS volume. AWS CloudFormation does not attempt to modify an Amazon EBS volume to a smaller size on rollback.
Some common scenarios when you might encounter a cooldown period for Amazon EBS include:
- You successfully update an Amazon EBS volume and the update succeeds. When you attempt another update within the cooldown window, that update will be subject to a cooldown period. - You successfully update an Amazon EBS volume and the update succeeds but another change in your update-stack call fails. The rollback will be subject to a cooldown period.
For more information on the cooldown period, see [Requirements when modifying volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/modify-volume-requirements.html) .
*DeletionPolicy attribute*
To control how AWS CloudFormation handles the volume when the stack is deleted, set a deletion policy for your volume. You can choose to retain the volume, to delete the volume, or to create a snapshot of the volume. For more information, see [DeletionPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) .
> If you set a deletion policy that creates a snapshot, all tags on the volume are included in the snapshot.
AWS::EC2::Volume external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnVolumeProps);

Create a new AWS::EC2::Volume.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrVolumeId

readonly attrVolumeId: string;

The ID of the volume. VolumeId

property autoEnableIo

autoEnableIo: any;

Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-autoenableio

property availabilityZone

availabilityZone: string;

The ID of the Availability Zone in which to create the volume. For example, us-east-1a .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-availabilityzone

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property encrypted

encrypted: any;

Indicates whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) in the *Amazon Elastic Compute Cloud User Guide* .
Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-encrypted

property iops

iops: number;

The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
- gp3 : 3,000-16,000 IOPS - io1 : 100-64,000 IOPS - io2 : 100-64,000 IOPS
io1 and io2 volumes support up to 64,000 IOPS only on [Instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) . Other instance families support performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-iops

property kmsKeyId

kmsKeyId: string;

The identifier of the AWS KMS key to use for Amazon EBS encryption. If KmsKeyId is specified, the encrypted state must be true .
If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to true , then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the AWS managed key .
Alternatively, if you want to specify a different key, you can specify one of the following:
- Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. - Key alias. Specify the alias for the key, prefixed with alias/ . For example, for a key with the alias my_cmk , use alias/my_cmk . Or to specify the AWS managed key , use alias/aws/ebs . - Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. - Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-kmskeyid

property multiAttachEnabled

multiAttachEnabled: any;

Indicates whether Amazon EBS Multi-Attach is enabled.
AWS CloudFormation does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-multiattachenabled

property outpostArn

outpostArn: string;

The Amazon Resource Name (ARN) of the Outpost.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-outpostarn

property size

size: number;

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
- gp2 and gp3 : 1-16,384 - io1 and io2 : 4-16,384 - st1 and sc1 : 125-16,384 - standard : 1-1,024
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-size

property snapshotId

snapshotId: string;

The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-snapshotid

property tags

readonly tags: cdk.TagManager;

The tags to apply to the volume during creation.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-tags

property throughput

throughput: number;

The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
This parameter is valid only for gp3 volumes. The default value is 125.
Valid Range: Minimum value of 125. Maximum value of 1000.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-throughput

property volumeType

volumeType: string;

The volume type. This parameter can be one of the following values:
- General Purpose SSD: gp2 | gp3 - Provisioned IOPS SSD: io1 | io2 - Throughput Optimized HDD: st1 - Cold HDD: sc1 - Magnetic: standard
For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide* .
Default: gp2
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-volumetype

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnVolumeAttachment

class CfnVolumeAttachment extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::VolumeAttachment
Attaches an Amazon EBS volume to a running instance and exposes it to the instance with the specified device name.
Before this resource can be deleted (and therefore the volume detached), you must first unmount the volume in the instance. Failure to do so results in the volume being stuck in the busy state while it is trying to detach, which could possibly damage the file system or the data it contains.
If an Amazon EBS volume is the root device of an instance, it cannot be detached while the instance is in the "running" state. To detach the root volume, stop the instance first.
If the root volume is detached from an instance with an AWS Marketplace product code, then the product codes from that volume are no longer associated with the instance.
AWS::EC2::VolumeAttachment external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volumeattachment.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnVolumeAttachmentProps);

Create a new AWS::EC2::VolumeAttachment.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property device

device: string;

The device name (for example, /dev/sdh or xvdh ).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volumeattachment.html#cfn-ec2-ebs-volumeattachment-device

property instanceId

instanceId: string;

The ID of the instance to which the volume attaches. This value can be a reference to an [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource, or it can be the physical ID of an existing EC2 instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volumeattachment.html#cfn-ec2-ebs-volumeattachment-instanceid

property volumeId

volumeId: string;

The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone. This value can be a reference to an [AWS::EC2::Volume](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html) resource, or it can be the volume ID of an existing Amazon EBS volume.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volumeattachment.html#cfn-ec2-ebs-volumeattachment-volumeid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnVPC

class CfnVPC extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::VPC
Specifies a virtual private cloud (VPC).
You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).
For more information, see [Virtual private clouds (VPC)](https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/configure-your-vpc.html) in the *Amazon VPC User Guide* .
AWS::EC2::VPC external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html

constructor

constructor(scope: cdk.Construct, id: string, props?: CfnVPCProps);

Create a new AWS::EC2::VPC.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrCidrBlock

readonly attrCidrBlock: string;

The primary IPv4 CIDR block for the VPC. For example, 10.0.0.0/16. CidrBlock

property attrCidrBlockAssociations

readonly attrCidrBlockAssociations: string[];

The association IDs of the IPv4 CIDR blocks for the VPC. For example, [ vpc-cidr-assoc-0280ab6b ]. CidrBlockAssociations

property attrDefaultNetworkAcl

readonly attrDefaultNetworkAcl: string;

The ID of the default network ACL for the VPC. For example, acl-814dafe3. DefaultNetworkAcl

property attrDefaultSecurityGroup

readonly attrDefaultSecurityGroup: string;

The ID of the default security group for the VPC. For example, sg-b178e0d3. DefaultSecurityGroup

property attrIpv6CidrBlocks

readonly attrIpv6CidrBlocks: string[];

The IPv6 CIDR blocks for the VPC. For example, [ 2001:db8:1234:1a00::/56 ]. Ipv6CidrBlocks

property attrVpcId

readonly attrVpcId: string;

The ID of the VPC. VpcId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property cidrBlock

cidrBlock: string;

The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16 . We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18 , we modify it to 100.68.0.0/18 .
You must specify either CidrBlock or Ipv4IpamPoolId .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-cidrblock

property enableDnsHostnames

enableDnsHostnames: any;

Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support) .
You can only enable DNS hostnames if you've enabled DNS support.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-enablednshostnames

property enableDnsSupport

enableDnsSupport: any;

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-enablednssupport

property instanceTenancy

instanceTenancy: string;

The allowed tenancy of instances launched into the VPC.
- default : An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch. - dedicated : An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of host during instance launch. You cannot specify a tenancy of default during instance launch.
Updating InstanceTenancy requires no replacement only if you are updating its value from dedicated to default . Updating InstanceTenancy from default to dedicated requires replacement.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-instancetenancy

property ipv4IpamPoolId

ipv4IpamPoolId: string;

The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .
You must specify either CidrBlock or Ipv4IpamPoolId .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-ipv4ipampoolid

property ipv4NetmaskLength

ipv4NetmaskLength: number;

The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-ipv4netmasklength

property tags

readonly tags: cdk.TagManager;

The tags for the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnVPCCidrBlock

class CfnVPCCidrBlock extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::VPCCidrBlock
Associates a CIDR block with your VPC. You can only associate a single IPv6 CIDR block with your VPC. The IPv6 CIDR block size is fixed at /56.
For more information about associating CIDR blocks with your VPC and applicable restrictions, see [VPC and Subnet Sizing](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#VPC_Sizing) in the *Amazon VPC User Guide* .
AWS::EC2::VPCCidrBlock external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnVPCCidrBlockProps);

Create a new AWS::EC2::VPCCidrBlock.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property amazonProvidedIpv6CidrBlock

amazonProvidedIpv6CidrBlock: any;

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-amazonprovidedipv6cidrblock

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property cidrBlock

cidrBlock: string;

An IPv4 CIDR block to associate with the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-cidrblock

property ipv4IpamPoolId

ipv4IpamPoolId: string;

Associate a CIDR allocated from an IPv4 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv4ipampoolid

property ipv4NetmaskLength

ipv4NetmaskLength: number;

The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv4netmasklength

property ipv6CidrBlock

ipv6CidrBlock: string;

An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv6cidrblock

property ipv6IpamPoolId

ipv6IpamPoolId: string;

Associates a CIDR allocated from an IPv6 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv6ipampoolid

property ipv6NetmaskLength

ipv6NetmaskLength: number;

The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv6netmasklength

property ipv6Pool

ipv6Pool: string;

The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv6pool

property vpcId

vpcId: string;

The ID of the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-vpcid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnVPCDHCPOptionsAssociation

class CfnVPCDHCPOptionsAssociation
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::VPCDHCPOptionsAssociation
Associates a set of DHCP options with a VPC, or associates no DHCP options with the VPC.
After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.
AWS::EC2::VPCDHCPOptionsAssociation external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcdhcpoptionsassociation.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnVPCDHCPOptionsAssociationProps
);

Create a new AWS::EC2::VPCDHCPOptionsAssociation.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property dhcpOptionsId

dhcpOptionsId: string;

The ID of the DHCP options set, or default to associate no DHCP options with the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcdhcpoptionsassociation.html#cfn-ec2-vpcdhcpoptionsassociation-dhcpoptionsid

property vpcId

vpcId: string;

The ID of the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcdhcpoptionsassociation.html#cfn-ec2-vpcdhcpoptionsassociation-vpcid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnVPCEndpoint

class CfnVPCEndpoint extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::VPCEndpoint
Specifies a VPC endpoint. A VPC endpoint provides a private connection between your VPC and an endpoint service. You can use an endpoint service provided by AWS , an AWS Marketplace Partner, or another AWS accounts in your organization. For more information, see the [AWS PrivateLink User Guide](https://docs.aws.amazon.com/vpc/latest/privatelink/) .
An endpoint of type Interface establishes connections between the subnets in your VPC and an AWS service , your own service, or a service hosted by another AWS account . With an interface VPC endpoint, you specify the subnets in which to create the endpoint and the security groups to associate with the endpoint network interfaces.
An endpoint of type gateway serves as a target for a route in your route table for traffic destined for Amazon S3 or DynamoDB . You can specify an endpoint policy for the endpoint, which controls access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. For more information about connectivity to Amazon S3 , see [Why can't I connect to an S3 bucket using a gateway VPC endpoint?](https://docs.aws.amazon.com/premiumsupport/knowledge-center/connect-s3-vpc-endpoint)
An endpoint of type GatewayLoadBalancer provides private connectivity between your VPC and virtual appliances from a service provider.
AWS::EC2::VPCEndpoint external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnVPCEndpointProps);

Create a new AWS::EC2::VPCEndpoint.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrCreationTimestamp

readonly attrCreationTimestamp: string;

The date and time the VPC endpoint was created. For example: Fri Sep 28 23:34:36 UTC 2018. CreationTimestamp

property attrDnsEntries

readonly attrDnsEntries: string[];

(Interface endpoints) The DNS entries for the endpoint. Each entry is a combination of the hosted zone ID and the DNS name. The entries are ordered as follows: regional public DNS, zonal public DNS, private DNS, and wildcard DNS. This order is not enforced for AWS Marketplace services.
The following is an example. In the first entry, the hosted zone ID is Z1HUB23UULQXV and the DNS name is vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com.
["Z1HUB23UULQXV:vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com", "Z1HUB23UULQXV:vpce-01abc23456de78f9g-12abccd3-us-east-1a.ec2.us-east-1.vpce.amazonaws.com", "Z1C12344VYDITB0:ec2.us-east-1.amazonaws.com"]
If you update the PrivateDnsEnabled or SubnetIds properties, the DNS entries in the list will change. DnsEntries

property attrId

readonly attrId: string;

The ID of the VPC endpoint. Id

property attrNetworkInterfaceIds

readonly attrNetworkInterfaceIds: string[];

(Interface endpoints) The network interface IDs. If you update the PrivateDnsEnabled or SubnetIds properties, the items in this list might change. NetworkInterfaceIds

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property policyDocument

policyDocument: any;

An endpoint policy, which controls access to the service from the VPC. The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints.
For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-policydocument

property privateDnsEnabled

privateDnsEnabled: any;

Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com ), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to true : enableDnsHostnames and enableDnsSupport .
This property is supported only for interface endpoints.
Default: false
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-privatednsenabled

property routeTableIds

routeTableIds: string[];

The IDs of the route tables. Routing is supported only for gateway endpoints.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-routetableids

property securityGroupIds

securityGroupIds: string[];

The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-securitygroupids

property serviceName

serviceName: string;

The name of the endpoint service.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-servicename

property subnetIds

subnetIds: string[];

The IDs of the subnets in which to create endpoint network interfaces. You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-subnetids

property vpcEndpointType

vpcEndpointType: string;

The type of endpoint.
Default: Gateway
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-vpcendpointtype

property vpcId

vpcId: string;

The ID of the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-vpcid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnVPCEndpointConnectionNotification

class CfnVPCEndpointConnectionNotification
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::VPCEndpointConnectionNotification
Specifies a connection notification for a VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see [Create a Topic](https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html) in the *Amazon Simple Notification Service Developer Guide* .
You can create a connection notification for interface endpoints only.
AWS::EC2::VPCEndpointConnectionNotification external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnVPCEndpointConnectionNotificationProps
);

Create a new AWS::EC2::VPCEndpointConnectionNotification.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property connectionEvents

connectionEvents: string[];

The endpoint events for which to receive notifications. Valid values are Accept , Connect , Delete , and Reject .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#cfn-ec2-vpcendpointconnectionnotification-connectionevents

property connectionNotificationArn

connectionNotificationArn: string;

The ARN of the SNS topic for the notifications.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#cfn-ec2-vpcendpointconnectionnotification-connectionnotificationarn

property serviceId

serviceId: string;

The ID of the endpoint service.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#cfn-ec2-vpcendpointconnectionnotification-serviceid

property vpcEndpointId

vpcEndpointId: string;

The ID of the endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#cfn-ec2-vpcendpointconnectionnotification-vpcendpointid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnVPCEndpointService

class CfnVPCEndpointService extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::VPCEndpointService
Creates a VPC endpoint service configuration to which service consumers ( AWS accounts, users, and IAM roles) can connect.
To create an endpoint service configuration, you must first create one of the following for your service:
- A [Network Load Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/introduction.html) . Service consumers connect to your service using an interface endpoint. - A [Gateway Load Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/introduction.html) . Service consumers connect to your service using a Gateway Load Balancer endpoint.
For more information, see the [AWS PrivateLink User Guide](https://docs.aws.amazon.com/vpc/latest/privatelink/) .
AWS::EC2::VPCEndpointService external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props?: CfnVPCEndpointServiceProps
);

Create a new AWS::EC2::VPCEndpointService.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property acceptanceRequired

acceptanceRequired: any;

Indicates whether requests from service consumers to create an endpoint to your service must be accepted.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-acceptancerequired

property attrServiceId

readonly attrServiceId: string;

The ID of the endpoint service. ServiceId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property contributorInsightsEnabled

contributorInsightsEnabled: any;

Indicates whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-contributorinsightsenabled

property gatewayLoadBalancerArns

gatewayLoadBalancerArns: string[];

The Amazon Resource Names (ARNs) of the Gateway Load Balancers.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-gatewayloadbalancerarns

property networkLoadBalancerArns

networkLoadBalancerArns: string[];

The Amazon Resource Names (ARNs) of the Network Load Balancers.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-networkloadbalancerarns

property payerResponsibility

payerResponsibility: string;

The entity that is responsible for the endpoint costs. The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-payerresponsibility

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnVPCEndpointServicePermissions

class CfnVPCEndpointServicePermissions
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::VPCEndpointServicePermissions
Grant or revoke permissions for service consumers (users, IAM roles, and AWS accounts) to connect to a VPC endpoint service.
If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.
AWS::EC2::VPCEndpointServicePermissions external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservicepermissions.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnVPCEndpointServicePermissionsProps
);

Create a new AWS::EC2::VPCEndpointServicePermissions.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property allowedPrincipals

allowedPrincipals: string[];

The Amazon Resource Names (ARN) of one or more principals (for example, users, IAM roles, and AWS accounts ). Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*). Permissions are revoked for principals not in this list. If the list is empty, then all permissions are revoked.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservicepermissions.html#cfn-ec2-vpcendpointservicepermissions-allowedprincipals

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property serviceId

serviceId: string;

The ID of the service.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservicepermissions.html#cfn-ec2-vpcendpointservicepermissions-serviceid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnVPCGatewayAttachment

class CfnVPCGatewayAttachment extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::VPCGatewayAttachment
Attaches an internet gateway, or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC.
AWS::EC2::VPCGatewayAttachment external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnVPCGatewayAttachmentProps
);

Create a new AWS::EC2::VPCGatewayAttachment.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property internetGatewayId

internetGatewayId: string;

The ID of the internet gateway.
You must specify either InternetGatewayId or VpnGatewayId , but not both.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html#cfn-ec2-vpcgatewayattachment-internetgatewayid

property vpcId

vpcId: string;

The ID of the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html#cfn-ec2-vpcgatewayattachment-vpcid

property vpnGatewayId

vpnGatewayId: string;

The ID of the virtual private gateway.
You must specify either InternetGatewayId or VpnGatewayId , but not both.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html#cfn-ec2-vpcgatewayattachment-vpngatewayid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnVPCPeeringConnection

class CfnVPCPeeringConnection extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::VPCPeeringConnection
Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to a different AWS account and can be in a different Region than the requester VPC.
The requester VPC and accepter VPC cannot have overlapping CIDR blocks. If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of failed .
If the VPCs belong to different accounts, the acceptor account must have a role that allows the requester account to accept the VPC peering connection. For more information, see [Walkthough: Peer with a VPC in another AWS account](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/peer-with-vpc-in-another-account.html) .
If the requester and acceptor VPCs are in the same account, the peering request is accepted without a peering role.
AWS::EC2::VPCPeeringConnection external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnVPCPeeringConnectionProps
);

Create a new AWS::EC2::VPCPeeringConnection.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrId

readonly attrId: string;

The ID of the peering connection. Id

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property peerOwnerId

peerOwnerId: string;

The AWS account ID of the owner of the accepter VPC.
Default: Your AWS account ID
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peerownerid

property peerRegion

peerRegion: string;

The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
Default: The Region in which you make the request.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peerregion

property peerRoleArn

peerRoleArn: string;

The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.
This is required when you are peering a VPC in a different AWS account.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peerrolearn

property peerVpcId

peerVpcId: string;

The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peervpcid

property tags

readonly tags: cdk.TagManager;

Any tags assigned to the resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-tags

property vpcId

vpcId: string;

The ID of the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-vpcid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnVPNConnection

class CfnVPNConnection extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::VPNConnection
Specifies a VPN connection between a virtual private gateway and a VPN customer gateway or a transit gateway and a VPN customer gateway.
To specify a VPN connection between a transit gateway and customer gateway, use the TransitGatewayId and CustomerGatewayId properties.
To specify a VPN connection between a virtual private gateway and customer gateway, use the VpnGatewayId and CustomerGatewayId properties.
For more information, see [AWS Site-to-Site VPN](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *AWS Site-to-Site VPN User Guide* .
AWS::EC2::VPNConnection external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnVPNConnectionProps);

Create a new AWS::EC2::VPNConnection.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrVpnConnectionId

readonly attrVpnConnectionId: string;

The ID of the VPN connection. VpnConnectionId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property customerGatewayId

customerGatewayId: string;

The ID of the customer gateway at your end of the VPN connection.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-customergatewayid

property staticRoutesOnly

staticRoutesOnly: any;

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
If you are creating a VPN connection for a device that does not support Border Gateway Protocol (BGP), you must specify true .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-staticroutesonly

property tags

readonly tags: cdk.TagManager;

Any tags assigned to the VPN connection.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-tags

property transitGatewayId

transitGatewayId: string;

The ID of the transit gateway associated with the VPN connection.
You must specify either TransitGatewayId or VpnGatewayId , but not both.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-transitgatewayid

property type

type: string;

The type of VPN connection.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-type

property vpnGatewayId

vpnGatewayId: string;

The ID of the virtual private gateway at the AWS side of the VPN connection.
You must specify either TransitGatewayId or VpnGatewayId , but not both.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-vpngatewayid

property vpnTunnelOptionsSpecifications

vpnTunnelOptionsSpecifications: any;

The tunnel options for the VPN connection.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-vpntunneloptionsspecifications

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnVPNConnectionRoute

class CfnVPNConnectionRoute extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::VPNConnectionRoute
Specifies a static route for a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
For more information, see [AWS Site-to-Site VPN](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *AWS Site-to-Site VPN User Guide* .
AWS::EC2::VPNConnectionRoute external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnectionroute.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnVPNConnectionRouteProps);

Create a new AWS::EC2::VPNConnectionRoute.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property destinationCidrBlock

destinationCidrBlock: string;

The CIDR block associated with the local subnet of the customer network.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnectionroute.html#cfn-ec2-vpnconnectionroute-destinationcidrblock

property vpnConnectionId

vpnConnectionId: string;

The ID of the VPN connection.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnectionroute.html#cfn-ec2-vpnconnectionroute-vpnconnectionid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnVPNGateway

class CfnVPNGateway extends cdk.CfnResource implements cdk.IInspectable {}

A CloudFormation AWS::EC2::VPNGateway
Specifies a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.
For more information, see [AWS Site-to-Site VPN](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *AWS Site-to-Site VPN User Guide* .
AWS::EC2::VPNGateway external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngateway.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnVPNGatewayProps);

Create a new AWS::EC2::VPNGateway.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property amazonSideAsn

amazonSideAsn: number;

The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngateway.html#cfn-ec2-vpngateway-amazonsideasn

property attrVpnGatewayId

readonly attrVpnGatewayId: string;

The ID of the VPN gateway. VPNGatewayId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property tags

readonly tags: cdk.TagManager;

Any tags assigned to the virtual private gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngateway.html#cfn-ec2-vpngateway-tags

property type

type: string;

The type of VPN connection the virtual private gateway supports.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngateway.html#cfn-ec2-vpngateway-type

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class CfnVPNGatewayRoutePropagation

class CfnVPNGatewayRoutePropagation
    extends cdk.CfnResource
    implements cdk.IInspectable {}

A CloudFormation AWS::EC2::VPNGatewayRoutePropagation
Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
If you reference a VPN gateway that is in the same template as your VPN gateway route propagation, you must explicitly declare a dependency on the VPN gateway attachment. The AWS::EC2::VPNGatewayRoutePropagation resource cannot use the VPN gateway until it has successfully attached to the VPC. Add a [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) in the AWS::EC2::VPNGatewayRoutePropagation resource to explicitly declare a dependency on the VPN gateway attachment.
AWS::EC2::VPNGatewayRoutePropagation external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngatewayroutepropagation.html

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnVPNGatewayRoutePropagationProps
);

Create a new AWS::EC2::VPNGatewayRoutePropagation.
Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties

property attrId

readonly attrId: string;

The ID of the VPN gateway. Id

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property routeTableIds

routeTableIds: string[];

The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngatewayroutepropagation.html#cfn-ec2-vpngatewayroutepropagation-routetableids

property vpnGatewayId

vpnGatewayId: string;

The ID of the virtual private gateway that is attached to a VPC. The virtual private gateway must be attached to the same VPC that the routing tables are associated with.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngatewayroutepropagation.html#cfn-ec2-vpngatewayroutepropagation-vpngatewayid

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

class ClientVpnAuthorizationRule

class ClientVpnAuthorizationRule extends Resource {}

A client VPN authorization rule

constructor

constructor(
    scope: Construct,
    id: string,
    props: ClientVpnAuthorizationRuleProps
);

class ClientVpnEndpoint

class ClientVpnEndpoint extends Resource implements IClientVpnEndpoint {}

A client VPN connnection

constructor

constructor(scope: Construct, id: string, props: ClientVpnEndpointProps);

property connections

readonly connections: Connections;

Allows specify security group connections for the endpoint.

property endpointId

readonly endpointId: string;

property targetNetworksAssociated

readonly targetNetworksAssociated: IDependable;

method addAuthorizationRule

addAuthorizationRule: (
    id: string,
    props: ClientVpnAuthorizationRuleOptions
) => ClientVpnAuthorizationRule;

Adds an authorization rule to this endpoint

method addRoute

addRoute: (id: string, props: ClientVpnRouteOptions) => ClientVpnRoute;

Adds a route to this endpoint

method fromEndpointAttributes

static fromEndpointAttributes: (
    scope: Construct,
    id: string,
    attrs: ClientVpnEndpointAttributes
) => IClientVpnEndpoint;

Import an existing client VPN endpoint

class ClientVpnRoute

class ClientVpnRoute extends Resource {}

A client VPN route

constructor

constructor(scope: Construct, id: string, props: ClientVpnRouteProps);

class ClientVpnRouteTarget

abstract class ClientVpnRouteTarget {}

Target for a client VPN route

property subnetId

abstract readonly subnetId: string;

The subnet ID

method local

static local: () => ClientVpnRouteTarget;

Local network

method subnet

static subnet: (subnet: ISubnet) => ClientVpnRouteTarget;

Subnet
The specified subnet must be an existing target network of the client VPN endpoint.

class ClientVpnUserBasedAuthentication

abstract class ClientVpnUserBasedAuthentication {}

User-based authentication for a client VPN endpoint

method activeDirectory

static activeDirectory: (
    directoryId: string
) => ClientVpnUserBasedAuthentication;

Active Directory authentication

method federated

static federated: (
    samlProvider: ISamlProvider,
    selfServiceSamlProvider?: ISamlProvider
) => ClientVpnUserBasedAuthentication;

Federated authentication

method render

abstract render: () => any;

Renders the user based authentication

class CloudFormationInit

class CloudFormationInit {}

A CloudFormation-init configuration

method addConfig

addConfig: (configName: string, config: InitConfig) => void;

Add a config with the given name to this CloudFormationInit object

method addConfigSet

addConfigSet: (configSetName: string, configNames?: string[]) => void;

Add a config set with the given name to this CloudFormationInit object
The new configset will reference the given configs in the given order.

method attach

attach: (
    attachedResource: CfnResource,
    attachOptions: AttachInitOptions
) => void;

Attach the CloudFormation Init config to the given resource
As an app builder, use instance.applyCloudFormationInit() or autoScalingGroup.applyCloudFormationInit() to trigger this method.
This method does the following:
- Renders the AWS::CloudFormation::Init object to the given resource's metadata, potentially adding a AWS::CloudFormation::Authentication object next to it if required. - Updates the instance role policy to be able to call the APIs required for cfn-init and cfn-signal to work, and potentially add permissions to download referenced asset and bucket resources. - Updates the given UserData with commands to execute the cfn-init script.

method fromConfig

static fromConfig: (config: InitConfig) => CloudFormationInit;

Use an existing InitConfig object as the default and only config

method fromConfigSets

static fromConfigSets: (props: ConfigSetProps) => CloudFormationInit;

Build a CloudFormationInit from config sets

method fromElements

static fromElements: (...elements: InitElement[]) => CloudFormationInit;

Build a new config from a set of Init Elements

class Connections

class Connections implements IConnectable {}

Manage the allowed network connections for constructs with Security Groups.
Security Groups can be thought of as a firewall for network-connected devices. This class makes it easy to allow network connections to and from security groups, and between security groups individually. When establishing connectivity between security groups, it will automatically add rules in both security groups
This object can manage one or more security groups.

constructor

constructor(props?: ConnectionsProps);

property connections

readonly connections: Connections;

property defaultPort

readonly defaultPort?: Port;

The default port configured for this connection peer, if available

property securityGroups

readonly securityGroups: ISecurityGroup[];

method addSecurityGroup

addSecurityGroup: (...securityGroups: ISecurityGroup[]) => void;

Add a security group to the list of security groups managed by this object

method allowDefaultPortFrom

allowDefaultPortFrom: (other: IConnectable, description?: string) => void;

Allow connections from the peer on our default port
Even if the peer has a default port, we will always use our default port.

method allowDefaultPortFromAnyIpv4

allowDefaultPortFromAnyIpv4: (description?: string) => void;

Allow default connections from all IPv4 ranges

method allowDefaultPortInternally

allowDefaultPortInternally: (description?: string) => void;

Allow hosts inside the security group to connect to each other

method allowDefaultPortTo

allowDefaultPortTo: (other: IConnectable, description?: string) => void;

Allow connections from the peer on our default port
Even if the peer has a default port, we will always use our default port.

method allowFrom

allowFrom: (other: IConnectable, portRange: Port, description?: string) => void;

Allow connections from the peer on the given port

method allowFromAnyIpv4

allowFromAnyIpv4: (portRange: Port, description?: string) => void;

Allow from any IPv4 ranges

method allowInternally

allowInternally: (portRange: Port, description?: string) => void;

Allow hosts inside the security group to connect to each other on the given port

method allowTo

allowTo: (other: IConnectable, portRange: Port, description?: string) => void;

Allow connections to the peer on the given port

method allowToAnyIpv4

allowToAnyIpv4: (portRange: Port, description?: string) => void;

Allow to all IPv4 ranges

method allowToDefaultPort

allowToDefaultPort: (other: IConnectable, description?: string) => void;

Allow connections to the security group on their default port

class FlowLog

class FlowLog extends FlowLogBase {}

A VPC flow log. AWS::EC2::FlowLog

constructor

constructor(scope: Construct, id: string, props: FlowLogProps);

property bucket

readonly bucket?: s3.IBucket;

The S3 bucket to publish flow logs to

property flowLogId

readonly flowLogId: string;

The Id of the VPC Flow Log

property iamRole

readonly iamRole?: iam.IRole;

The iam role used to publish logs to CloudWatch

property keyPrefix

readonly keyPrefix?: string;

S3 bucket key prefix to publish the flow logs under

property logGroup

readonly logGroup?: logs.ILogGroup;

The CloudWatch Logs LogGroup to publish flow logs to

method fromFlowLogId

static fromFlowLogId: (
    scope: Construct,
    id: string,
    flowLogId: string
) => IFlowLog;

Import a Flow Log by it's Id

class FlowLogDestination

abstract class FlowLogDestination {}

The destination type for the flow log

method bind

abstract bind: (
    scope: CoreConstruct,
    flowLog: FlowLog
) => FlowLogDestinationConfig;

Generates a flow log destination configuration

method toCloudWatchLogs

static toCloudWatchLogs: (
    logGroup?: logs.ILogGroup,
    iamRole?: iam.IRole
) => FlowLogDestination;

Use CloudWatch logs as the destination

method toS3

static toS3: (bucket?: s3.IBucket, keyPrefix?: string) => FlowLogDestination;

Use S3 as the destination

class FlowLogResourceType

abstract class FlowLogResourceType {}

The type of resource to create the flow log for

property resourceId

abstract resourceId: string;

The Id of the resource that the flow log should be attached to.

property resourceType

abstract resourceType: string;

The type of resource to attach a flow log to.

method fromNetworkInterfaceId

static fromNetworkInterfaceId: (id: string) => FlowLogResourceType;

The Network Interface to attach the Flow Log to

method fromSubnet

static fromSubnet: (subnet: ISubnet) => FlowLogResourceType;

The subnet to attach the Flow Log to

method fromVpc

static fromVpc: (vpc: IVpc) => FlowLogResourceType;

The VPC to attach the Flow Log to

class GatewayVpcEndpoint

class GatewayVpcEndpoint extends VpcEndpoint implements IGatewayVpcEndpoint {}

A gateway VPC endpoint. AWS::EC2::VPCEndpoint

constructor

constructor(scope: Construct, id: string, props: GatewayVpcEndpointProps);

property vpcEndpointCreationTimestamp

readonly vpcEndpointCreationTimestamp: string;

The date and time the gateway VPC endpoint was created.

property vpcEndpointDnsEntries

readonly vpcEndpointDnsEntries: string[];

property vpcEndpointId

readonly vpcEndpointId: string;

The gateway VPC endpoint identifier.

property vpcEndpointNetworkInterfaceIds

readonly vpcEndpointNetworkInterfaceIds: string[];

method fromGatewayVpcEndpointId

static fromGatewayVpcEndpointId: (
    scope: Construct,
    id: string,
    gatewayVpcEndpointId: string
) => IGatewayVpcEndpoint;

class GatewayVpcEndpointAwsService

class GatewayVpcEndpointAwsService implements IGatewayVpcEndpointService {}

An AWS service for a gateway VPC endpoint.

constructor

constructor(name: string, prefix?: string);

property DYNAMODB

static readonly DYNAMODB: GatewayVpcEndpointAwsService;

property name

readonly name: string;

The name of the service.

property S3

static readonly S3: GatewayVpcEndpointAwsService;

class GenericLinuxImage

class GenericLinuxImage implements IMachineImage {}

Construct a Linux machine image from an AMI map
Linux images IDs are not published to SSM parameter store yet, so you'll have to manually specify an AMI map.

constructor

constructor(
    amiMap: { [region: string]: string },
    props?: GenericLinuxImageProps
);

method getImage

getImage: (scope: Construct) => MachineImageConfig;

class GenericSSMParameterImage

class GenericSSMParameterImage implements IMachineImage {}

Select the image based on a given SSM parameter
This Machine Image automatically updates to the latest version on every deployment. Be aware this will cause your instances to be replaced when a new version of the image becomes available. Do not store stateful information on the instance if you are using this image.
The AMI ID is selected using the values published to the SSM parameter store.

constructor

constructor(parameterName: string, os: OperatingSystemType, userData?: UserData);

property parameterName

readonly parameterName: string;

Name of the SSM parameter we're looking up

method getImage

getImage: (scope: Construct) => MachineImageConfig;

Return the image to use in the given context

class GenericWindowsImage

class GenericWindowsImage implements IMachineImage {}

Construct a Windows machine image from an AMI map
Allows you to create a generic Windows EC2 , manually specify an AMI map.

constructor

constructor(
    amiMap: { [region: string]: string },
    props?: GenericWindowsImageProps
);

method getImage

getImage: (scope: Construct) => MachineImageConfig;

class InitCommand

class InitCommand extends InitElement {}

Command to execute on the instance

property elementType

readonly elementType: string;

method argvCommand

static argvCommand: (
    argv: string[],
    options?: InitCommandOptions
) => InitCommand;

Run a command from an argv array
You do not need to escape space characters or enclose command parameters in quotes.

method shellCommand

static shellCommand: (
    shellCommand: string,
    options?: InitCommandOptions
) => InitCommand;

Run a shell command
Remember that some characters like &, |, ;, > etc. have special meaning in a shell and need to be preceded by a \ if you want to treat them as part of a filename.

class InitCommandWaitDuration

abstract class InitCommandWaitDuration {}

Represents a duration to wait after a command has finished, in case of a reboot (Windows only).

method forever

static forever: () => InitCommandWaitDuration;

cfn-init will exit and resume only after a reboot.

method none

static none: () => InitCommandWaitDuration;

Do not wait for this command.

method of

static of: (duration: Duration) => InitCommandWaitDuration;

Wait for a specified duration after a command.

class InitConfig

class InitConfig {}

A collection of configuration elements

constructor

constructor(elements: InitElement[]);

method add

add: (...elements: InitElement[]) => void;

Add one or more elements to the config

method isEmpty

isEmpty: () => boolean;

Whether this configset has elements or not

class InitElement

abstract class InitElement {}

Base class for all CloudFormation Init elements

property elementType

abstract readonly elementType: string;

Returns the init element type for this element.

class InitFile

abstract class InitFile extends InitElement {}

Create files on the EC2 instance.

constructor

protected constructor(fileName: string, options: InitFileOptions);

property elementType

readonly elementType: string;

method fromAsset

static fromAsset: (
    targetFileName: string,
    path: string,
    options?: InitFileAssetOptions
) => InitFile;

Create an asset from the given file
This is appropriate for files that are too large to embed into the template.

method fromExistingAsset

static fromExistingAsset: (
    targetFileName: string,
    asset: s3_assets.Asset,
    options?: InitFileOptions
) => InitFile;

Use a file from an asset at instance startup time

method fromFileInline

static fromFileInline: (
    targetFileName: string,
    sourceFileName: string,
    options?: InitFileOptions
) => InitFile;

Read a file from disk and use its contents
The file will be embedded in the template, so care should be taken to not exceed the template size.
If options.base64encoded is set to true, this will base64-encode the file's contents.

method fromObject

static fromObject: (
    fileName: string,
    obj: Record<string, any>,
    options?: InitFileOptions
) => InitFile;

Use a JSON-compatible object as the file content, write it to a JSON file.
May contain tokens.

method fromS3Object

static fromS3Object: (
    fileName: string,
    bucket: s3.IBucket,
    key: string,
    options?: InitFileOptions
) => InitFile;

Download a file from an S3 bucket at instance startup time

method fromString

static fromString: (
    fileName: string,
    content: string,
    options?: InitFileOptions
) => InitFile;

Use a literal string as the file content

method fromUrl

static fromUrl: (
    fileName: string,
    url: string,
    options?: InitFileOptions
) => InitFile;

Download from a URL at instance startup time

method symlink

static symlink: (
    fileName: string,
    target: string,
    options?: InitFileOptions
) => InitFile;

Write a symlink with the given symlink target

class InitGroup

class InitGroup extends InitElement {}

Create Linux/UNIX groups and assign group IDs.
Not supported for Windows systems.

constructor

protected constructor(groupName: string, groupId?: number);

property elementType

readonly elementType: string;

method fromName

static fromName: (groupName: string, groupId?: number) => InitGroup;

Create a group from its name, and optionally, group id

class InitPackage

class InitPackage extends InitElement {}

A package to be installed during cfn-init time

constructor

protected constructor(
    type: string,
    versions: string[],
    packageName?: string,
    serviceHandles?: InitServiceRestartHandle[]
);

property elementType

readonly elementType: string;

method apt

static apt: (packageName: string, options?: NamedPackageOptions) => InitPackage;

Install a package using APT

method msi

static msi: (location: string, options?: LocationPackageOptions) => InitPackage;

Install an MSI package from an HTTP URL or a location on disk

method python

static python: (
    packageName: string,
    options?: NamedPackageOptions
) => InitPackage;

Install a package from PyPI

method renderPackageVersions

protected renderPackageVersions: () => any;

method rpm

static rpm: (location: string, options?: LocationPackageOptions) => InitPackage;

Install an RPM from an HTTP URL or a location on disk

method rubyGem

static rubyGem: (gemName: string, options?: NamedPackageOptions) => InitPackage;

Install a package from RubyGems

method yum

static yum: (packageName: string, options?: NamedPackageOptions) => InitPackage;

Install a package using Yum

class InitService

class InitService extends InitElement {}

A services that be enabled, disabled or restarted when the instance is launched.

property elementType

readonly elementType: string;

method disable

static disable: (serviceName: string) => InitService;

Disable and stop the given service

method enable

static enable: (
    serviceName: string,
    options?: InitServiceOptions
) => InitService;

Enable and start the given service, optionally restarting it

class InitServiceRestartHandle

class InitServiceRestartHandle {}

An object that represents reasons to restart an InitService
Pass an instance of this object to the InitFile, InitCommand, InitSource and InitPackage objects, and finally to an InitService itself to cause the actions (files, commands, sources, and packages) to trigger a restart of the service.
For example, the following will run a custom command to install Nginx, and trigger the nginx service to be restarted after the command has run.
const handle = new ec2.InitServiceRestartHandle(); ec2.CloudFormationInit.fromElements( ec2.InitCommand.shellCommand('/usr/bin/custom-nginx-install.sh', { serviceRestartHandles: [handle] }), ec2.InitService.enable('nginx', { serviceRestartHandle: handle }), );

class InitSource

abstract class InitSource extends InitElement {}

Extract an archive into a directory

constructor

protected constructor(
    targetDirectory: string,
    serviceHandles?: InitServiceRestartHandle[]
);

property elementType

readonly elementType: string;

method fromAsset

static fromAsset: (
    targetDirectory: string,
    path: string,
    options?: InitSourceAssetOptions
) => InitSource;

Create an InitSource from an asset created from the given path.

method fromExistingAsset

static fromExistingAsset: (
    targetDirectory: string,
    asset: s3_assets.Asset,
    options?: InitSourceOptions
) => InitSource;

Extract a directory from an existing directory asset.

method fromGitHub

static fromGitHub: (
    targetDirectory: string,
    owner: string,
    repo: string,
    refSpec?: string,
    options?: InitSourceOptions
) => InitSource;

Extract a GitHub branch into a given directory

method fromS3Object

static fromS3Object: (
    targetDirectory: string,
    bucket: s3.IBucket,
    key: string,
    options?: InitSourceOptions
) => InitSource;

Extract an archive stored in an S3 bucket into the given directory

method fromUrl

static fromUrl: (
    targetDirectory: string,
    url: string,
    options?: InitSourceOptions
) => InitSource;

Retrieve a URL and extract it into the given directory

class InitUser

class InitUser extends InitElement {}

Create Linux/UNIX users and to assign user IDs.
Users are created as non-interactive system users with a shell of /sbin/nologin. This is by design and cannot be modified.
Not supported for Windows systems.

constructor

protected constructor(userName: string, userOptions: InitUserOptions);

property elementType

readonly elementType: string;

method fromName

static fromName: (userName: string, options?: InitUserOptions) => InitUser;

Create a user from user name.

class Instance

class Instance extends Resource implements IInstance {}

This represents a single EC2 instance

constructor

constructor(scope: Construct, id: string, props: InstanceProps);

property connections

readonly connections: Connections;

Allows specify security group connections for the instance.

property grantPrincipal

readonly grantPrincipal: iam.IPrincipal;

The principal to grant permissions to

property instance

readonly instance: CfnInstance;

the underlying instance resource

property instanceAvailabilityZone

readonly instanceAvailabilityZone: string;

property instanceId

readonly instanceId: string;

property instancePrivateDnsName

readonly instancePrivateDnsName: string;

property instancePrivateIp

readonly instancePrivateIp: string;

property instancePublicDnsName

readonly instancePublicDnsName: string;

property instancePublicIp

readonly instancePublicIp: string;

property osType

readonly osType: OperatingSystemType;

The type of OS the instance is running.

property role

readonly role: iam.IRole;

The IAM role assumed by the instance.

property userData

readonly userData: UserData;

UserData for the instance

method addSecurityGroup

addSecurityGroup: (securityGroup: ISecurityGroup) => void;

Add the security group to the instance.
Parameter securityGroup
: The security group to add

method addToRolePolicy

addToRolePolicy: (statement: iam.PolicyStatement) => void;

Adds a statement to the IAM role assumed by the instance.

method addUserData

addUserData: (...commands: string[]) => void;

Add command to the startup script of the instance. The command must be in the scripting language supported by the instance's OS (i.e. Linux/Windows).

class InstanceRequireImdsv2Aspect

class InstanceRequireImdsv2Aspect extends RequireImdsv2Aspect {}

Aspect that applies IMDS configuration on EC2 Instance constructs.
This aspect configures IMDS on an EC2 instance by creating a Launch Template with the IMDS configuration and associating that Launch Template with the instance. If an Instance is already associated with a Launch Template, a warning will (optionally) be added to the construct node and it will be skipped.
To cover Instances already associated with Launch Templates, use LaunchTemplateImdsAspect.

constructor

constructor(props?: InstanceRequireImdsv2AspectProps);

method visit

visit: (node: cdk.IConstruct) => void;

method warn

protected warn: (node: cdk.IConstruct, message: string) => void;

class InstanceType

class InstanceType {}

Instance type for EC2 instances
This class takes a literal string, good if you already know the identifier of the type you want.

constructor

constructor(instanceTypeIdentifier: string);

property architecture

readonly architecture: InstanceArchitecture;

The instance's CPU architecture

method of

static of: (
    instanceClass: InstanceClass,
    instanceSize: InstanceSize
) => InstanceType;

Instance type for EC2 instances
This class takes a combination of a class and size.
Be aware that not all combinations of class and size are available, and not all classes are available in all regions.

method toString

toString: () => string;

Return the instance type as a dotted string

class InterfaceVpcEndpoint

class InterfaceVpcEndpoint extends VpcEndpoint implements IInterfaceVpcEndpoint {}

A interface VPC endpoint. AWS::EC2::VPCEndpoint

constructor

constructor(scope: Construct, id: string, props: InterfaceVpcEndpointProps);

property connections

readonly connections: Connections;

Access to network connections.

property securityGroupId

readonly securityGroupId: string;

The identifier of the first security group associated with this interface VPC endpoint.
Deprecated
use the connections object

property vpcEndpointCreationTimestamp

readonly vpcEndpointCreationTimestamp: string;

The date and time the interface VPC endpoint was created.

property vpcEndpointDnsEntries

readonly vpcEndpointDnsEntries: string[];

The DNS entries for the interface VPC endpoint.

property vpcEndpointId

readonly vpcEndpointId: string;

The interface VPC endpoint identifier.

property vpcEndpointNetworkInterfaceIds

readonly vpcEndpointNetworkInterfaceIds: string[];

One or more network interfaces for the interface VPC endpoint.

method fromInterfaceVpcEndpointAttributes

static fromInterfaceVpcEndpointAttributes: (
    scope: Construct,
    id: string,
    attrs: InterfaceVpcEndpointAttributes
) => IInterfaceVpcEndpoint;

Imports an existing interface VPC endpoint.

class InterfaceVpcEndpointAwsService

class InterfaceVpcEndpointAwsService implements IInterfaceVpcEndpointService {}

An AWS service for an interface VPC endpoint.

constructor

constructor(name: string, prefix?: string, port?: number);

property APIGATEWAY

static readonly APIGATEWAY: InterfaceVpcEndpointAwsService;

property ATHENA

static readonly ATHENA: InterfaceVpcEndpointAwsService;

property CLOUDFORMATION

static readonly CLOUDFORMATION: InterfaceVpcEndpointAwsService;

property CLOUDTRAIL

static readonly CLOUDTRAIL: InterfaceVpcEndpointAwsService;

property CLOUDWATCH

static readonly CLOUDWATCH: InterfaceVpcEndpointAwsService;

property CLOUDWATCH_EVENTS

static readonly CLOUDWATCH_EVENTS: InterfaceVpcEndpointAwsService;

property CLOUDWATCH_LOGS

static readonly CLOUDWATCH_LOGS: InterfaceVpcEndpointAwsService;

property CODEBUILD

static readonly CODEBUILD: InterfaceVpcEndpointAwsService;

property CODEBUILD_FIPS

static readonly CODEBUILD_FIPS: InterfaceVpcEndpointAwsService;

property CODECOMMIT

static readonly CODECOMMIT: InterfaceVpcEndpointAwsService;

property CODECOMMIT_FIPS

static readonly CODECOMMIT_FIPS: InterfaceVpcEndpointAwsService;

property CODECOMMIT_GIT

static readonly CODECOMMIT_GIT: InterfaceVpcEndpointAwsService;

property CODECOMMIT_GIT_FIPS

static readonly CODECOMMIT_GIT_FIPS: InterfaceVpcEndpointAwsService;

property CODEGURU_PROFILER

static readonly CODEGURU_PROFILER: InterfaceVpcEndpointAwsService;

property CODEGURU_REVIEWER

static readonly CODEGURU_REVIEWER: InterfaceVpcEndpointAwsService;

property CODEPIPELINE

static readonly CODEPIPELINE: InterfaceVpcEndpointAwsService;

property CONFIG

static readonly CONFIG: InterfaceVpcEndpointAwsService;

property EC2

static readonly EC2: InterfaceVpcEndpointAwsService;

property EC2_MESSAGES

static readonly EC2_MESSAGES: InterfaceVpcEndpointAwsService;

property ECR

static readonly ECR: InterfaceVpcEndpointAwsService;

property ECR_DOCKER

static readonly ECR_DOCKER: InterfaceVpcEndpointAwsService;

property ECS

static readonly ECS: InterfaceVpcEndpointAwsService;

property ECS_AGENT

static readonly ECS_AGENT: InterfaceVpcEndpointAwsService;

property ECS_TELEMETRY

static readonly ECS_TELEMETRY: InterfaceVpcEndpointAwsService;

property ELASTIC_FILESYSTEM

static readonly ELASTIC_FILESYSTEM: InterfaceVpcEndpointAwsService;

property ELASTIC_FILESYSTEM_FIPS

static readonly ELASTIC_FILESYSTEM_FIPS: InterfaceVpcEndpointAwsService;

property ELASTIC_INFERENCE_RUNTIME

static readonly ELASTIC_INFERENCE_RUNTIME: InterfaceVpcEndpointAwsService;

property ELASTIC_LOAD_BALANCING

static readonly ELASTIC_LOAD_BALANCING: InterfaceVpcEndpointAwsService;

property GLUE

static readonly GLUE: InterfaceVpcEndpointAwsService;

property KEYSPACES

static readonly KEYSPACES: InterfaceVpcEndpointAwsService;

property KINESIS_FIREHOSE

static readonly KINESIS_FIREHOSE: InterfaceVpcEndpointAwsService;

property KINESIS_STREAMS

static readonly KINESIS_STREAMS: InterfaceVpcEndpointAwsService;

property KMS

static readonly KMS: InterfaceVpcEndpointAwsService;

property LAMBDA

static readonly LAMBDA: InterfaceVpcEndpointAwsService;

property name

readonly name: string;

The name of the service.

property port

readonly port: number;

The port of the service.

property privateDnsDefault

readonly privateDnsDefault?: boolean;

Whether Private DNS is supported by default.

property RDS

static readonly RDS: InterfaceVpcEndpointAwsService;

property RDS_DATA

static readonly RDS_DATA: InterfaceVpcEndpointAwsService;

property REKOGNITION

static readonly REKOGNITION: InterfaceVpcEndpointAwsService;

property REKOGNITION_FIPS

static readonly REKOGNITION_FIPS: InterfaceVpcEndpointAwsService;

property SAGEMAKER_API

static readonly SAGEMAKER_API: InterfaceVpcEndpointAwsService;

property SAGEMAKER_NOTEBOOK

static readonly SAGEMAKER_NOTEBOOK: InterfaceVpcEndpointAwsService;

property SAGEMAKER_RUNTIME

static readonly SAGEMAKER_RUNTIME: InterfaceVpcEndpointAwsService;

property SAGEMAKER_RUNTIME_FIPS

static readonly SAGEMAKER_RUNTIME_FIPS: InterfaceVpcEndpointAwsService;

property SECRETS_MANAGER

static readonly SECRETS_MANAGER: InterfaceVpcEndpointAwsService;

property SERVICE_CATALOG

static readonly SERVICE_CATALOG: InterfaceVpcEndpointAwsService;

property SNS

static readonly SNS: InterfaceVpcEndpointAwsService;

property SQS

static readonly SQS: InterfaceVpcEndpointAwsService;

property SSM

static readonly SSM: InterfaceVpcEndpointAwsService;

property SSM_MESSAGES

static readonly SSM_MESSAGES: InterfaceVpcEndpointAwsService;

property STEP_FUNCTIONS

static readonly STEP_FUNCTIONS: InterfaceVpcEndpointAwsService;

property STORAGE_GATEWAY

static readonly STORAGE_GATEWAY: InterfaceVpcEndpointAwsService;

property STS

static readonly STS: InterfaceVpcEndpointAwsService;

property TRANSCRIBE

static readonly TRANSCRIBE: InterfaceVpcEndpointAwsService;

property TRANSFER

static readonly TRANSFER: InterfaceVpcEndpointAwsService;

property XRAY

static readonly XRAY: InterfaceVpcEndpointAwsService;

class InterfaceVpcEndpointService

class InterfaceVpcEndpointService implements IInterfaceVpcEndpointService {}

A custom-hosted service for an interface VPC endpoint.

constructor

constructor(name: string, port?: number);

property name

readonly name: string;

The name of the service.

property port

readonly port: number;

The port of the service.

property privateDnsDefault

readonly privateDnsDefault?: boolean;

Whether Private DNS is supported by default.

class LaunchTemplate

class LaunchTemplate
    extends Resource
    implements ILaunchTemplate, iam.IGrantable, IConnectable {}

This represents an EC2 LaunchTemplate.
See Also
- https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html

constructor

constructor(scope: Construct, id: string, props?: LaunchTemplateProps);

property connections

readonly connections: Connections;

Allows specifying security group connections for the instance.
Only available if you provide a securityGroup when constructing the LaunchTemplate.

property defaultVersionNumber

readonly defaultVersionNumber: string;

The default version for the launch template.

property grantPrincipal

readonly grantPrincipal: iam.IPrincipal;

Principal to grant permissions to.
Only available if you provide a role when constructing the LaunchTemplate.

property imageId

readonly imageId?: string;

The AMI ID of the image to use

property instanceType

readonly instanceType?: InstanceType;

Type of instance to launch.

property latestVersionNumber

readonly latestVersionNumber: string;

The latest version of the launch template.

property launchTemplateId

readonly launchTemplateId?: string;

property launchTemplateName

readonly launchTemplateName?: string;

property osType

readonly osType?: OperatingSystemType;

The type of OS the instance is running.

property role

readonly role?: iam.IRole;

IAM Role assumed by instances that are launched from this template.

property tags

protected readonly tags: TagManager;

TagManager for tagging support.

property userData

readonly userData?: UserData;

UserData executed by instances that are launched from this template.

property versionNumber

readonly versionNumber: string;

method fromLaunchTemplateAttributes

static fromLaunchTemplateAttributes: (
    scope: Construct,
    id: string,
    attrs: LaunchTemplateAttributes
) => ILaunchTemplate;

Import an existing LaunchTemplate.

class LaunchTemplateRequireImdsv2Aspect

class LaunchTemplateRequireImdsv2Aspect extends RequireImdsv2Aspect {}

Aspect that applies IMDS configuration on EC2 Launch Template constructs.
See Also
- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html

constructor

constructor(props?: LaunchTemplateRequireImdsv2AspectProps);

method visit

visit: (node: cdk.IConstruct) => void;

class LaunchTemplateSpecialVersions

class LaunchTemplateSpecialVersions {}

A class that provides convenient access to special version tokens for LaunchTemplate versions.

property DEFAULT_VERSION

static readonly DEFAULT_VERSION: string;

The special value that denotes that users of a Launch Template should reference the DEFAULT version of the template.

property LATEST_VERSION

static readonly LATEST_VERSION: string;

The special value that denotes that users of a Launch Template should reference the LATEST version of the template.

class LookupMachineImage

class LookupMachineImage implements IMachineImage {}

A machine image whose AMI ID will be searched using DescribeImages.
The most recent, available, launchable image matching the given filter criteria will be used. Looking up AMIs may take a long time; specify as many filter criteria as possible to narrow down the search.
The AMI selected will be cached in cdk.context.json and the same value will be used on future runs. To refresh the AMI lookup, you will have to evict the value from the cache using the cdk context command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for more information.

constructor

constructor(props: LookupMachineImageProps);

method getImage

getImage: (scope: Construct) => MachineImageConfig;

class MachineImage

abstract class MachineImage {}

Factory functions for standard Amazon Machine Image objects.

method fromSsmParameter

static fromSsmParameter: (
    parameterName: string,
    options?: SsmParameterImageOptions
) => IMachineImage;

An image specified in SSM parameter store
By default, the SSM parameter is refreshed at every deployment, causing your instances to be replaced whenever a new version of the AMI is released.
Pass { cachedInContext: true } to keep the AMI ID stable. If you do, you will have to remember to periodically invalidate the context to refresh to the newest AMI ID.

method fromSSMParameter

static fromSSMParameter: (
    parameterName: string,
    os: OperatingSystemType,
    userData?: UserData
) => IMachineImage;

An image specified in SSM parameter store that is automatically kept up-to-date
This Machine Image automatically updates to the latest version on every deployment. Be aware this will cause your instances to be replaced when a new version of the image becomes available. Do not store stateful information on the instance if you are using this image.
Parameter parameterName
The name of SSM parameter containing the AMi id
Parameter os
The operating system type of the AMI
Parameter userData
optional user data for the given image
Deprecated
Use MachineImage.fromSsmParameter() instead

method genericLinux

static genericLinux: (
    amiMap: Record<string, string>,
    props?: GenericLinuxImageProps
) => IMachineImage;

A Linux image where you specify the AMI ID for every region
Parameter amiMap
For every region where you are deploying the stack, specify the AMI ID for that region.
Parameter props
Customize the image by supplying additional props

method genericWindows

static genericWindows: (
    amiMap: Record<string, string>,
    props?: GenericWindowsImageProps
) => IMachineImage;

A Windows image where you specify the AMI ID for every region
Parameter amiMap
For every region where you are deploying the stack, specify the AMI ID for that region.
Parameter props
Customize the image by supplying additional props

method latestAmazonLinux

static latestAmazonLinux: (props?: AmazonLinuxImageProps) => IMachineImage;

An Amazon Linux image that is automatically kept up-to-date
This Machine Image automatically updates to the latest version on every deployment. Be aware this will cause your instances to be replaced when a new version of the image becomes available. Do not store stateful information on the instance if you are using this image.

method latestWindows

static latestWindows: (
    version: WindowsVersion,
    props?: WindowsImageProps
) => IMachineImage;

A Windows image that is automatically kept up-to-date
This Machine Image automatically updates to the latest version on every deployment. Be aware this will cause your instances to be replaced when a new version of the image becomes available. Do not store stateful information on the instance if you are using this image.

method lookup

static lookup: (props: LookupMachineImageProps) => IMachineImage;

Look up a shared Machine Image using DescribeImages
The most recent, available, launchable image matching the given filter criteria will be used. Looking up AMIs may take a long time; specify as many filter criteria as possible to narrow down the search.
The AMI selected will be cached in cdk.context.json and the same value will be used on future runs. To refresh the AMI lookup, you will have to evict the value from the cache using the cdk context command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for more information.
This function can not be used in environment-agnostic stacks.

class MultipartBody

abstract class MultipartBody {}

The base class for all classes which can be used as MultipartUserData.

constructor

constructor();

property CLOUD_BOOTHOOK

static readonly CLOUD_BOOTHOOK: string;

Content type for boot hooks

property SHELL_SCRIPT

static readonly SHELL_SCRIPT: string;

Content type for shell scripts

method fromRawBody

static fromRawBody: (opts: MultipartBodyOptions) => MultipartBody;

Constructs the raw MultipartBody using specified body, content type and transfer encoding.
When transfer encoding is specified (typically as Base64), it's caller responsibility to convert body to Base64 either by wrapping with Fn.base64 or by converting it by other converters.

method fromUserData

static fromUserData: (userData: UserData, contentType?: string) => MultipartBody;

Constructs the new MultipartBody wrapping existing UserData. Modification to UserData are reflected in subsequent renders of the part.
For more information about content types see MultipartBodyOptions.contentType.
Parameter userData
user data to wrap into body part
Parameter contentType
optional content type, if default one should not be used

method renderBodyPart

abstract renderBodyPart: () => string[];

Render body part as the string.
Subclasses should not add leading nor trailing new line characters (\r \n)

class MultipartUserData

class MultipartUserData extends UserData {}

Mime multipart user data.
This class represents MIME multipart user data, as described in. [Specifying Multiple User Data Blocks Using a MIME Multi Part Archive](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bootstrap_container_instance.html#multi-part_user_data)

constructor

constructor(opts?: MultipartUserDataOptions);

method addCommands

addCommands: (...commands: string[]) => void;

method addExecuteFileCommand

addExecuteFileCommand: (params: ExecuteFileOptions) => void;

method addOnExitCommands

addOnExitCommands: (...commands: string[]) => void;

method addPart

addPart: (part: MultipartBody) => void;

Adds a part to the list of parts.

method addS3DownloadCommand

addS3DownloadCommand: (params: S3DownloadOptions) => string;

method addSignalOnExitCommand

addSignalOnExitCommand: (resource: Resource) => void;

method addUserDataPart

addUserDataPart: (
    userData: UserData,
    contentType?: string,
    makeDefault?: boolean
) => void;

Adds a multipart part based on a UserData object.
If makeDefault is true, then the UserData added by this method will also be the target of calls to the add*Command methods on this MultipartUserData object.
If makeDefault is false, then this is the same as calling:
declare const multiPart: ec2.MultipartUserData; declare const userData: ec2.UserData; declare const contentType: string; multiPart.addPart(ec2.MultipartBody.fromUserData(userData, contentType));
An undefined makeDefault defaults to either: - true if no default UserData has been set yet; or - false if there is no default UserData set.

method render

render: () => string;

class NatInstanceImage

class NatInstanceImage extends LookupMachineImage {}

Machine image representing the latest NAT instance image

constructor

constructor();

class NatInstanceProvider

class NatInstanceProvider extends NatProvider implements IConnectable {}

NAT provider which uses NAT Instances

constructor

constructor(props: NatInstanceProps);

property configuredGateways

readonly configuredGateways: GatewayConfig[];

property connections

readonly connections: Connections;

Manage the Security Groups associated with the NAT instances

property securityGroup

readonly securityGroup: ISecurityGroup;

The Security Group associated with the NAT instances

method configureNat

configureNat: (options: ConfigureNatOptions) => void;

method configureSubnet

configureSubnet: (subnet: PrivateSubnet) => void;

class NatProvider

abstract class NatProvider {}

NAT providers
Determines what type of NAT provider to create, either NAT gateways or NAT instance.

property configuredGateways

abstract readonly configuredGateways: GatewayConfig[];

Return list of gateways spawned by the provider

method configureNat

abstract configureNat: (options: ConfigureNatOptions) => void;

Called by the VPC to configure NAT
Don't call this directly, the VPC will call it automatically.

method configureSubnet

abstract configureSubnet: (subnet: PrivateSubnet) => void;

Configures subnet with the gateway
Don't call this directly, the VPC will call it automatically.

method gateway

static gateway: (props?: NatGatewayProps) => NatProvider;

Use NAT Gateways to provide NAT services for your VPC
NAT gateways are managed by AWS.
See Also
- https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html

method instance

static instance: (props: NatInstanceProps) => NatInstanceProvider;

Use NAT instances to provide NAT services for your VPC
NAT instances are managed by you, but in return allow more configuration.
Be aware that instances created using this provider will not be automatically replaced if they are stopped for any reason. You should implement your own NatProvider based on AutoScaling groups if you need that.
See Also
- https://docs.aws.amazon.com/vpc/latest/userguide/VPC_NAT_Instance.html

class NetworkAcl

class NetworkAcl extends NetworkAclBase {}

Define a new custom network ACL
By default, will deny all inbound and outbound traffic unless entries are added explicitly allowing it.

constructor

constructor(scope: Construct, id: string, props: NetworkAclProps);

property networkAclId

readonly networkAclId: string;

The ID of the NetworkACL

property networkAclVpcId

readonly networkAclVpcId: string;

The VPC ID for this NetworkACL

method associateWithSubnet

associateWithSubnet: (id: string, selection: SubnetSelection) => void;

Associate the ACL with a given set of subnets

method fromNetworkAclId

static fromNetworkAclId: (
    scope: Construct,
    id: string,
    networkAclId: string
) => INetworkAcl;

Import an existing NetworkAcl into this app.

class NetworkAclEntry

class NetworkAclEntry extends NetworkAclEntryBase {}

Define an entry in a Network ACL table

constructor

constructor(scope: Construct, id: string, props: NetworkAclEntryProps);

property networkAcl

readonly networkAcl: INetworkAcl;

class Peer

class Peer {}

Peer object factories (to be used in Security Group management)
The static methods on this object can be used to create peer objects which represent a connection partner in Security Group rules.
Use this object if you need to represent connection partners using plain IP addresses, or a prefix list ID.
If you want to address a connection partner by Security Group, you can just use the Security Group (or the construct that contains a Security Group) directly, as it already implements IPeer.

constructor

protected constructor();

method anyIpv4

static anyIpv4: () => IPeer;

Any IPv4 address

method anyIpv6

static anyIpv6: () => IPeer;

Any IPv6 address

method ipv4

static ipv4: (cidrIp: string) => IPeer;

Create an IPv4 peer from a CIDR

method ipv6

static ipv6: (cidrIp: string) => IPeer;

Create an IPv6 peer from a CIDR

method prefixList

static prefixList: (prefixListId: string) => IPeer;

A prefix list

method securityGroupId

static securityGroupId: (
    securityGroupId: string,
    sourceSecurityGroupOwnerId?: string
) => IPeer;

A security group ID

class Port

class Port {}

Interface for classes that provide the connection-specification parts of a security group rule

constructor

constructor(props: PortProps);

property canInlineRule

readonly canInlineRule: boolean;

Whether the rule containing this port range can be inlined into a securitygroup or not.

method ah

static ah: () => Port;

A single AH port

method allIcmp

static allIcmp: () => Port;

All ICMP traffic

method allTcp

static allTcp: () => Port;

Any TCP traffic

method allTraffic

static allTraffic: () => Port;

All traffic

method allUdp

static allUdp: () => Port;

Any UDP traffic

method esp

static esp: () => Port;

A single ESP port

method icmpPing

static icmpPing: () => Port;

ICMP ping (echo) traffic

method icmpType

static icmpType: (type: number) => Port;

All codes for a single ICMP type

method icmpTypeAndCode

static icmpTypeAndCode: (type: number, code: number) => Port;

A specific combination of ICMP type and code
See Also
- https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml

method tcp

static tcp: (port: number) => Port;

A single TCP port

method tcpRange

static tcpRange: (startPort: number, endPort: number) => Port;

A TCP port range

method toRuleJson

toRuleJson: () => any;

Produce the ingress/egress rule JSON for the given connection

method toString

toString: () => string;

method udp

static udp: (port: number) => Port;

A single UDP port

method udpRange

static udpRange: (startPort: number, endPort: number) => Port;

A UDP port range

class PrivateSubnet

class PrivateSubnet extends Subnet implements IPrivateSubnet {}

Represents a private VPC subnet resource

constructor

constructor(scope: Construct, id: string, props: PrivateSubnetProps);

method fromPrivateSubnetAttributes

static fromPrivateSubnetAttributes: (
    scope: Construct,
    id: string,
    attrs: PrivateSubnetAttributes
) => IPrivateSubnet;

class PublicSubnet

class PublicSubnet extends Subnet implements IPublicSubnet {}

Represents a public VPC subnet resource

constructor

constructor(scope: Construct, id: string, props: PublicSubnetProps);

method addNatGateway

addNatGateway: (eipAllocationId?: string) => CfnNatGateway;

Creates a new managed NAT gateway attached to this public subnet. Also adds the EIP for the managed NAT.
Returns
A ref to the the NAT Gateway ID

method fromPublicSubnetAttributes

static fromPublicSubnetAttributes: (
    scope: Construct,
    id: string,
    attrs: PublicSubnetAttributes
) => IPublicSubnet;

class SecurityGroup

class SecurityGroup extends SecurityGroupBase {}

Creates an Amazon EC2 security group within a VPC.
Security Groups act like a firewall with a set of rules, and are associated with any AWS resource that has or creates Elastic Network Interfaces (ENIs). A typical example of a resource that has a security group is an Instance (or Auto Scaling Group of instances)
If you are defining new infrastructure in CDK, there is a good chance you won't have to interact with this class at all. Like IAM Roles, Security Groups need to exist to control access between AWS resources, but CDK will automatically generate and populate them with least-privilege permissions for you so you can concentrate on your business logic.
All Constructs that require Security Groups will create one for you if you don't specify one at construction. After construction, you can selectively allow connections to and between constructs via--for example-- the instance.connections object. Think of it as "allowing connections to your instance", rather than "adding ingress rules a security group". See the [Allowing Connections](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-ec2-readme.html#allowing-connections) section in the library documentation for examples.
Direct manipulation of the Security Group through addIngressRule and addEgressRule is possible, but mutation through the .connections object is recommended. If you peer two constructs with security groups this way, appropriate rules will be created in both.
If you have an existing security group you want to use in your CDK application, you would import it like this:
const securityGroup = ec2.SecurityGroup.fromSecurityGroupId(this, 'SG', 'sg-12345', { mutable: false });

constructor

constructor(scope: Construct, id: string, props: SecurityGroupProps);

property allowAllOutbound

readonly allowAllOutbound: boolean;

Whether the SecurityGroup has been configured to allow all outbound traffic

property securityGroupId

readonly securityGroupId: string;

The ID of the security group

property securityGroupName

readonly securityGroupName: string;

An attribute that represents the security group name.
Deprecated
returns the security group ID, rather than the name.

property securityGroupVpcId

readonly securityGroupVpcId: string;

The VPC ID this security group is part of.

method addEgressRule

addEgressRule: (
    peer: IPeer,
    connection: Port,
    description?: string,
    remoteRule?: boolean
) => void;

method addIngressRule

addIngressRule: (
    peer: IPeer,
    connection: Port,
    description?: string,
    remoteRule?: boolean
) => void;

method fromLookup

static fromLookup: (
    scope: Construct,
    id: string,
    securityGroupId: string
) => ISecurityGroup;

Look up a security group by id.
Deprecated
Use fromLookupById() instead

method fromLookupById

static fromLookupById: (
    scope: Construct,
    id: string,
    securityGroupId: string
) => ISecurityGroup;

Look up a security group by id.

method fromLookupByName

static fromLookupByName: (
    scope: Construct,
    id: string,
    securityGroupName: string,
    vpc: IVpc
) => ISecurityGroup;

Look up a security group by name.

method fromSecurityGroupId

static fromSecurityGroupId: (
    scope: Construct,
    id: string,
    securityGroupId: string,
    options?: SecurityGroupImportOptions
) => ISecurityGroup;

Import an existing security group into this app.
This method will assume that the Security Group has a rule in it which allows all outbound traffic, and so will not add egress rules to the imported Security Group (only ingress rules).
If your existing Security Group needs to have egress rules added, pass the allowAllOutbound: false option on import.

class Subnet

class Subnet extends Resource implements ISubnet {}

Represents a new VPC subnet resource
AWS::EC2::Subnet

constructor

constructor(scope: Construct, id: string, props: SubnetProps);

property availabilityZone

readonly availabilityZone: string;

The Availability Zone the subnet is located in

property dependencyElements

readonly dependencyElements: IDependable[];

Parts of this VPC subnet

property internetConnectivityEstablished

readonly internetConnectivityEstablished: IDependable;

property ipv4CidrBlock

readonly ipv4CidrBlock: string;

property networkAcl

readonly networkAcl: INetworkAcl;

Network ACL associated with this Subnet
Upon creation, this is the default ACL which allows all traffic, except explicit DENY entries that you add.
You can replace it with a custom ACL which denies all traffic except the explicit ALLOW entries that you add by creating a NetworkAcl object and calling associateNetworkAcl().

property routeTable

readonly routeTable: IRouteTable;

The routeTableId attached to this subnet.

property subnetAvailabilityZone

readonly subnetAvailabilityZone: string;

property subnetId

readonly subnetId: string;

The subnetId for this particular subnet

property subnetIpv6CidrBlocks

readonly subnetIpv6CidrBlocks: string[];

property subnetNetworkAclAssociationId

readonly subnetNetworkAclAssociationId: string;

property subnetOutpostArn

readonly subnetOutpostArn: string;

The Amazon Resource Name (ARN) of the Outpost for this subnet (if one exists).

property subnetVpcId

readonly subnetVpcId: string;

method addDefaultInternetRoute

addDefaultInternetRoute: (
    gatewayId: string,
    gatewayAttachment: IDependable
) => void;

Create a default route that points to a passed IGW, with a dependency on the IGW's attachment to the VPC.
Parameter gatewayId
the logical ID (ref) of the gateway attached to your VPC
Parameter gatewayAttachment
the gateway attachment construct to be added as a dependency

method addDefaultNatRoute

addDefaultNatRoute: (natGatewayId: string) => void;

Adds an entry to this subnets route table that points to the passed NATGatewayId
Parameter natGatewayId
The ID of the NAT gateway

method addRoute

addRoute: (id: string, options: AddRouteOptions) => void;

Adds an entry to this subnets route table

method associateNetworkAcl

associateNetworkAcl: (id: string, networkAcl: INetworkAcl) => void;

method fromSubnetAttributes

static fromSubnetAttributes: (
    scope: Construct,
    id: string,
    attrs: SubnetAttributes
) => ISubnet;

method fromSubnetId

static fromSubnetId: (scope: Construct, id: string, subnetId: string) => ISubnet;

Import existing subnet from id.

method isVpcSubnet

static isVpcSubnet: (x: any) => x is Subnet;

class SubnetFilter

abstract class SubnetFilter {}

Contains logic which chooses a set of subnets from a larger list, in conjunction with SubnetSelection, to determine where to place AWS resources such as VPC endpoints, EC2 instances, etc.

method availabilityZones

static availabilityZones: (availabilityZones: string[]) => SubnetFilter;

Chooses subnets which are in one of the given availability zones.

method byCidrMask

static byCidrMask: (mask: number) => SubnetFilter;

Chooses subnets which have the provided CIDR netmask.

method byIds

static byIds: (subnetIds: string[]) => SubnetFilter;

Chooses subnets by id.

method containsIpAddresses

static containsIpAddresses: (ipv4addrs: string[]) => SubnetFilter;

Chooses subnets which contain any of the specified IP addresses.

method onePerAz

static onePerAz: () => SubnetFilter;

Chooses subnets such that there is at most one per availability zone.

method selectSubnets

selectSubnets: (_subnets: ISubnet[]) => ISubnet[];

Executes the subnet filtering logic, returning a filtered set of subnets.

class SubnetNetworkAclAssociation

class SubnetNetworkAclAssociation extends SubnetNetworkAclAssociationBase {}

constructor

constructor(
    scope: Construct,
    id: string,
    props: SubnetNetworkAclAssociationProps
);

property networkAcl

readonly networkAcl: INetworkAcl;

ID for the current Network ACL

property subnet

readonly subnet: ISubnet;

ID of the Subnet

property subnetNetworkAclAssociationAssociationId

readonly subnetNetworkAclAssociationAssociationId: string;

ID for the current SubnetNetworkAclAssociation

method fromSubnetNetworkAclAssociationAssociationId

static fromSubnetNetworkAclAssociationAssociationId: (
    scope: Construct,
    id: string,
    subnetNetworkAclAssociationAssociationId: string
) => ISubnetNetworkAclAssociation;

class UserData

abstract class UserData {}

Instance User Data

method addCommands

abstract addCommands: (...commands: string[]) => void;

Add one or more commands to the user data

method addExecuteFileCommand

abstract addExecuteFileCommand: (params: ExecuteFileOptions) => void;

Adds commands to execute a file

method addOnExitCommands

abstract addOnExitCommands: (...commands: string[]) => void;

Add one or more commands to the user data that will run when the script exits.

method addS3DownloadCommand

abstract addS3DownloadCommand: (params: S3DownloadOptions) => string;

Adds commands to download a file from S3
@returns: The local path that the file will be downloaded to

method addSignalOnExitCommand

abstract addSignalOnExitCommand: (resource: Resource) => void;

Adds a command which will send a cfn-signal when the user data script ends

method custom

static custom: (content: string) => UserData;

Create a userdata object with custom content

method forLinux

static forLinux: (options?: LinuxUserDataOptions) => UserData;

Create a userdata object for Linux hosts

method forOperatingSystem

static forOperatingSystem: (os: OperatingSystemType) => UserData;

method forWindows

static forWindows: () => UserData;

Create a userdata object for Windows hosts

method render

abstract render: () => string;

Render the UserData for use in a construct

class Volume

class Volume extends VolumeBase {}

Creates a new EBS Volume in AWS EC2.

constructor

constructor(scope: Construct, id: string, props: VolumeProps);

property availabilityZone

readonly availabilityZone: string;

property encryptionKey

readonly encryptionKey?: IKey;

property volumeId

readonly volumeId: string;

method fromVolumeAttributes

static fromVolumeAttributes: (
    scope: Construct,
    id: string,
    attrs: VolumeAttributes
) => IVolume;

Import an existing EBS Volume into the Stack.
Parameter scope
the scope of the import.
Parameter id
the ID of the imported Volume in the construct tree.
Parameter attrs
the attributes of the imported Volume

method validateProps

protected validateProps: (props: VolumeProps) => void;

class Vpc

class Vpc extends VpcBase {}

Define an AWS Virtual Private Cloud

See the package-level documentation of this package for an overview of the various dimensions in which you can configure your VPC.

For example:

const vpc = new ec2.Vpc(this, 'TheVPC', {
  cidr: "10.0.0.0/16"
})

// Iterate the private subnets
const selection = vpc.selectSubnets({
  subnetType: ec2.SubnetType.PRIVATE_WITH_NAT
});

for (const subnet of selection.subnets) {
  // ...
}

AWS::EC2::VPC

constructor

constructor(scope: Construct, id: string, props?: VpcProps);

Vpc creates a VPC that spans a whole region. It will automatically divide the provided VPC CIDR range, and create public and private subnets per Availability Zone. Network routing for the public subnets will be configured to allow outbound access directly via an Internet Gateway. Network routing for the private subnets will be configured to allow outbound access via a set of resilient NAT Gateways (one per AZ).

property availabilityZones

readonly availabilityZones: string[];

AZs for this VPC

property DEFAULT_CIDR_RANGE

static readonly DEFAULT_CIDR_RANGE: string;

The default CIDR range used when creating VPCs. This can be overridden using VpcProps when creating a VPCNetwork resource. e.g. new VpcResource(this, { cidr: '192.168.0.0./16' })

property DEFAULT_SUBNETS

static readonly DEFAULT_SUBNETS: SubnetConfiguration[];

The default subnet configuration
1 Public and 1 Private subnet per AZ evenly split

property DEFAULT_SUBNETS_NO_NAT

static readonly DEFAULT_SUBNETS_NO_NAT: SubnetConfiguration[];

The default subnet configuration if natGateways specified to be 0
1 Public and 1 Isolated Subnet per AZ evenly split

property dnsHostnamesEnabled

readonly dnsHostnamesEnabled: boolean;

Indicates if instances launched in this VPC will have public DNS hostnames.

property dnsSupportEnabled

readonly dnsSupportEnabled: boolean;

Indicates if DNS support is enabled for this VPC.

property internetConnectivityEstablished

readonly internetConnectivityEstablished: IDependable;

property internetGatewayId

readonly internetGatewayId?: string;

Internet Gateway for the VPC. Note that in case the VPC is configured only with ISOLATED subnets, this attribute will be undefined.

property isolatedSubnets

readonly isolatedSubnets: ISubnet[];

List of isolated subnets in this VPC

property privateSubnets

readonly privateSubnets: ISubnet[];

List of private subnets in this VPC

property publicSubnets

readonly publicSubnets: ISubnet[];

List of public subnets in this VPC

property vpcArn

readonly vpcArn: string;

property vpcCidrBlock

readonly vpcCidrBlock: string;

property vpcCidrBlockAssociations

readonly vpcCidrBlockAssociations: string[];

property vpcDefaultNetworkAcl

readonly vpcDefaultNetworkAcl: string;

property vpcDefaultSecurityGroup

readonly vpcDefaultSecurityGroup: string;

property vpcId

readonly vpcId: string;

Identifier for this VPC

property vpcIpv6CidrBlocks

readonly vpcIpv6CidrBlocks: string[];

method addDynamoDbEndpoint

addDynamoDbEndpoint: (
    id: string,
    subnets?: SubnetSelection[]
) => GatewayVpcEndpoint;

Adds a new DynamoDB gateway endpoint to this VPC
Deprecated
use addGatewayEndpoint() instead

method addS3Endpoint

addS3Endpoint: (id: string, subnets?: SubnetSelection[]) => GatewayVpcEndpoint;

Adds a new S3 gateway endpoint to this VPC
Deprecated
use addGatewayEndpoint() instead

method fromLookup

static fromLookup: (
    scope: Construct,
    id: string,
    options: VpcLookupOptions
) => IVpc;

Import an existing VPC from by querying the AWS environment this stack is deployed to.
This function only needs to be used to use VPCs not defined in your CDK application. If you are looking to share a VPC between stacks, you can pass the Vpc object between stacks and use it as normal.
Calling this method will lead to a lookup when the CDK CLI is executed. You can therefore not use any values that will only be available at CloudFormation execution time (i.e., Tokens).
The VPC information will be cached in cdk.context.json and the same VPC will be used on future runs. To refresh the lookup, you will have to evict the value from the cache using the cdk context command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for more information.

method fromVpcAttributes

static fromVpcAttributes: (
    scope: Construct,
    id: string,
    attrs: VpcAttributes
) => IVpc;

Import a VPC by supplying all attributes directly
NOTE: using fromVpcAttributes() with deploy-time parameters (like a Fn.importValue() or CfnParameter to represent a list of subnet IDs) sometimes accidentally works. It happens to work for constructs that need a list of subnets (like AutoScalingGroup and eks.Cluster) but it does not work for constructs that need individual subnets (like Instance). See https://github.com/aws/aws-cdk/issues/4118 for more information.
Prefer to use Vpc.fromLookup() instead.

class VpcEndpoint

abstract class VpcEndpoint extends Resource implements IVpcEndpoint {}

property policyDocument

protected policyDocument?: iam.PolicyDocument;

property vpcEndpointId

abstract readonly vpcEndpointId: string;

method addToPolicy

addToPolicy: (statement: iam.PolicyStatement) => void;

Adds a statement to the policy document of the VPC endpoint. The statement must have a Principal.
Not all interface VPC endpoints support policy. For more information see https://docs.aws.amazon.com/vpc/latest/userguide/vpce-interface.html
Parameter statement
the IAM statement to add

class VpcEndpointService

class VpcEndpointService extends Resource implements IVpcEndpointService {}

A VPC endpoint service AWS::EC2::VPCEndpointService

constructor

constructor(scope: Construct, id: string, props: VpcEndpointServiceProps);

property acceptanceRequired

readonly acceptanceRequired: boolean;

Whether to require manual acceptance of new connections to the service.

property allowedPrincipals

readonly allowedPrincipals: ArnPrincipal[];

One or more Principal ARNs to allow inbound connections to.

property vpcEndpointServiceId

readonly vpcEndpointServiceId: string;

The id of the VPC Endpoint Service, like vpce-svc-xxxxxxxxxxxxxxxx.

property vpcEndpointServiceLoadBalancers

readonly vpcEndpointServiceLoadBalancers: IVpcEndpointServiceLoadBalancer[];

One or more network load balancers to host the service.

property vpcEndpointServiceName

readonly vpcEndpointServiceName: string;

The service name of the VPC Endpoint Service that clients use to connect to, like com.amazonaws.vpce..vpce-svc-xxxxxxxxxxxxxxxx

property whitelistedPrincipals

readonly whitelistedPrincipals: ArnPrincipal[];

One or more Principal ARNs to allow inbound connections to.
Deprecated
use allowedPrincipals

class VpnConnection

class VpnConnection extends VpnConnectionBase {}

Define a VPN Connection
AWS::EC2::VPNConnection

constructor

constructor(scope: Construct, id: string, props: VpnConnectionProps);

property customerGatewayAsn

readonly customerGatewayAsn: number;

property customerGatewayId

readonly customerGatewayId: string;

property customerGatewayIp

readonly customerGatewayIp: string;

property vpnId

readonly vpnId: string;

method fromVpnConnectionAttributes

static fromVpnConnectionAttributes: (
    scope: Construct,
    id: string,
    attrs: VpnConnectionAttributes
) => IVpnConnection;

Import a VPN connection by supplying all attributes directly

method metricAll

static metricAll: (
    metricName: string,
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

Return the given named metric for all VPN connections in the account/region.

method metricAllTunnelDataIn

static metricAllTunnelDataIn: (
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

Metric for the tunnel data in of all VPN connections in the account/region.
sum over 5 minutes

method metricAllTunnelDataOut

static metricAllTunnelDataOut: (
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

Metric for the tunnel data out of all VPN connections.
sum over 5 minutes

method metricAllTunnelState

static metricAllTunnelState: (
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

Metric for the tunnel state of all VPN connections in the account/region.
average over 5 minutes

class VpnConnectionBase

abstract class VpnConnectionBase extends Resource implements IVpnConnection {}

Base class for Vpn connections.

property customerGatewayAsn

abstract readonly customerGatewayAsn: number;

property customerGatewayId

abstract readonly customerGatewayId: string;

property customerGatewayIp

abstract readonly customerGatewayIp: string;

property vpnId

abstract readonly vpnId: string;

class VpnGateway

class VpnGateway extends Resource implements IVpnGateway {}

The VPN Gateway that shall be added to the VPC
AWS::EC2::VPNGateway

constructor

constructor(scope: Construct, id: string, props: VpnGatewayProps);

property gatewayId

readonly gatewayId: string;

The virtual private gateway Id

class WindowsImage

class WindowsImage extends GenericSSMParameterImage {}

Select the latest version of the indicated Windows version
This Machine Image automatically updates to the latest version on every deployment. Be aware this will cause your instances to be replaced when a new version of the image becomes available. Do not store stateful information on the instance if you are using this image.
The AMI ID is selected using the values published to the SSM parameter store.
https://aws.amazon.com/blogs/mt/query-for-the-latest-windows-ami-using-systems-manager-parameter-store/

constructor

constructor(version: WindowsVersion, props?: WindowsImageProps);

Interfaces

interface AclCidrConfig

interface AclCidrConfig {}

Acl Configuration for CIDR

property cidrBlock

readonly cidrBlock?: string;

Ipv4 CIDR

property ipv6CidrBlock

readonly ipv6CidrBlock?: string;

Ipv6 CIDR

interface AclIcmp

interface AclIcmp {}

Properties to create Icmp

property code

readonly code?: number;

The Internet Control Message Protocol (ICMP) code. You can use -1 to specify all ICMP codes for the given ICMP type. Requirement is conditional: Required if you specify 1 (ICMP) for the protocol parameter.

property type

readonly type?: number;

The Internet Control Message Protocol (ICMP) type. You can use -1 to specify all ICMP types. Conditional requirement: Required if you specify 1 (ICMP) for the CreateNetworkAclEntry protocol parameter.

interface AclPortRange

interface AclPortRange {}

Properties to create PortRange

property from

readonly from?: number;

The first port in the range. Required if you specify 6 (TCP) or 17 (UDP) for the protocol parameter.

property to

readonly to?: number;

The last port in the range. Required if you specify 6 (TCP) or 17 (UDP) for the protocol parameter.

interface AclTrafficConfig

interface AclTrafficConfig {}

Acl Configuration for traffic

property icmp

readonly icmp?: AclIcmp;

The Internet Control Message Protocol (ICMP) code and type.
- Required if specifying 1 (ICMP) for the protocol parameter.

property portRange

readonly portRange?: AclPortRange;

The range of port numbers for the UDP/TCP protocol.
- Required if specifying 6 (TCP) or 17 (UDP) for the protocol parameter

property protocol

readonly protocol: number;

The protocol number.
A value of "-1" means all protocols.
If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify.
If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.
17

interface AddRouteOptions

interface AddRouteOptions {}

Options for adding a new route to a subnet

property destinationCidrBlock

readonly destinationCidrBlock?: string;

IPv4 range this route applies to
'0.0.0.0/0'

property destinationIpv6CidrBlock

readonly destinationIpv6CidrBlock?: string;

IPv6 range this route applies to
- Uses IPv6

property enablesInternetConnectivity

readonly enablesInternetConnectivity?: boolean;

Whether this route will enable internet connectivity
If true, this route will be added before any AWS resources that depend on internet connectivity in the VPC will be created.
false

property routerId

readonly routerId: string;

The ID of the router
Can be an instance ID, gateway ID, etc, depending on the router type.

property routerType

readonly routerType: RouterType;

What type of router to route this traffic to

interface AmazonLinuxImageProps

interface AmazonLinuxImageProps {}

Amazon Linux image properties

property cachedInContext

readonly cachedInContext?: boolean;

Whether the AMI ID is cached to be stable between deployments
By default, the newest image is used on each deployment. This will cause instances to be replaced whenever a new version is released, and may cause downtime if there aren't enough running instances in the AutoScalingGroup to reschedule the tasks on.
If set to true, the AMI ID will be cached in cdk.context.json and the same value will be used on future runs. Your instances will not be replaced but your AMI version will grow old over time. To refresh the AMI lookup, you will have to evict the value from the cache using the cdk context command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for more information.
Can not be set to true in environment-agnostic stacks.
false

property cpuType

readonly cpuType?: AmazonLinuxCpuType;

CPU Type
X86_64

property edition

readonly edition?: AmazonLinuxEdition;

What edition of Amazon Linux to use
Standard

property generation

readonly generation?: AmazonLinuxGeneration;

What generation of Amazon Linux to use
AmazonLinux

property kernel

readonly kernel?: AmazonLinuxKernel;

What kernel version of Amazon Linux to use
-

property storage

readonly storage?: AmazonLinuxStorage;

What storage backed image to use
GeneralPurpose

property userData

readonly userData?: UserData;

Initial user data
- Empty UserData for Linux machines

property virtualization

readonly virtualization?: AmazonLinuxVirt;

Virtualization type
HVM

interface ApplyCloudFormationInitOptions

interface ApplyCloudFormationInitOptions {}

Options for applying CloudFormation init to an instance or instance group

property configSets

readonly configSets?: string[];

ConfigSet to activate
['default']

property embedFingerprint

readonly embedFingerprint?: boolean;

Force instance replacement by embedding a config fingerprint
If true (the default), a hash of the config will be embedded into the UserData, so that if the config changes, the UserData changes.
- If the EC2 instance is instance-store backed or userDataCausesReplacement is set, this will cause the instance to be replaced and the new configuration to be applied. - If the instance is EBS-backed and userDataCausesReplacement is not set, the change of UserData will make the instance restart but not be replaced, and the configuration will not be applied automatically.
If false, no hash will be embedded, and if the CloudFormation Init config changes nothing will happen to the running instance. If a config update introduces errors, you will not notice until after the CloudFormation deployment successfully finishes and the next instance fails to launch.
true

property ignoreFailures

readonly ignoreFailures?: boolean;

Don't fail the instance creation when cfn-init fails
You can use this to prevent CloudFormation from rolling back when instances fail to start up, to help in debugging.
false

property includeRole

readonly includeRole?: boolean;

Include --role argument when running cfn-init and cfn-signal commands
This will be the IAM instance profile attached to the EC2 instance
false

property includeUrl

readonly includeUrl?: boolean;

Include --url argument when running cfn-init and cfn-signal commands
This will be the cloudformation endpoint in the deployed region e.g. https://cloudformation.us-east-1.amazonaws.com
false

property printLog

readonly printLog?: boolean;

Print the results of running cfn-init to the Instance System Log
By default, the output of running cfn-init is written to a log file on the instance. Set this to true to print it to the System Log (visible from the EC2 Console), false to not print it.
(Be aware that the system log is refreshed at certain points in time of the instance life cycle, and successful execution may not always show up).
true

property timeout

readonly timeout?: Duration;

Timeout waiting for the configuration to be applied
Duration.minutes(5)

interface AttachInitOptions

interface AttachInitOptions {}

Options for attaching a CloudFormationInit to a resource

property configSets

readonly configSets?: string[];

ConfigSet to activate
['default']

property embedFingerprint

readonly embedFingerprint?: boolean;

Whether to embed a hash into the userData
If true (the default), a hash of the config will be embedded into the UserData, so that if the config changes, the UserData changes and the instance will be replaced.
If false, no such hash will be embedded, and if the CloudFormation Init config changes nothing will happen to the running instance.
true

property ignoreFailures

readonly ignoreFailures?: boolean;

Don't fail the instance creation when cfn-init fails
You can use this to prevent CloudFormation from rolling back when instances fail to start up, to help in debugging.
false

property includeRole

readonly includeRole?: boolean;

Include --role argument when running cfn-init and cfn-signal commands
This will be the IAM instance profile attached to the EC2 instance
false

property includeUrl

readonly includeUrl?: boolean;

Include --url argument when running cfn-init and cfn-signal commands
This will be the cloudformation endpoint in the deployed region e.g. https://cloudformation.us-east-1.amazonaws.com
false

property instanceRole

readonly instanceRole: iam.IRole;

Instance role of the consuming instance or fleet

property platform

readonly platform: OperatingSystemType;

OS Platform the init config will be used for

property printLog

readonly printLog?: boolean;

Print the results of running cfn-init to the Instance System Log
By default, the output of running cfn-init is written to a log file on the instance. Set this to true to print it to the System Log (visible from the EC2 Console), false to not print it.
(Be aware that the system log is refreshed at certain points in time of the instance life cycle, and successful execution may not always show up).
true

property signalResource

readonly signalResource?: CfnResource;

When provided, signals this resource instead of the attached resource
You can use this to support signaling LaunchTemplate while attaching AutoScalingGroup
- if this property is undefined cfn-signal signals the attached resource

property userData

readonly userData: UserData;

UserData to add commands to

interface BastionHostLinuxProps

interface BastionHostLinuxProps {}

Properties of the bastion host

property availabilityZone

readonly availabilityZone?: string;

In which AZ to place the instance within the VPC
- Random zone.

property blockDevices

readonly blockDevices?: BlockDevice[];

Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.
Each instance that is launched has an associated root device volume, either an Amazon EBS volume or an instance store volume. You can use block device mappings to specify additional EBS volumes or instance store volumes to attach to an instance when it is launched.
See Also
- https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
  - Uses the block device mapping of the AMI

property init

readonly init?: CloudFormationInit;

Apply the given CloudFormation Init configuration to the instance at startup
- no CloudFormation init

property initOptions

readonly initOptions?: ApplyCloudFormationInitOptions;

Use the given options for applying CloudFormation Init
Describes the configsets to use and the timeout to wait
- default options

property instanceName

readonly instanceName?: string;

The name of the instance
'BastionHost'

property instanceType

readonly instanceType?: InstanceType;

Type of instance to launch 't3.nano'

property machineImage

readonly machineImage?: IMachineImage;

The machine image to use, assumed to have SSM Agent preinstalled.
- An Amazon Linux 2 image which is kept up-to-date automatically (the instance may be replaced on every deployment) and already has SSM Agent installed.

property requireImdsv2

readonly requireImdsv2?: boolean;

Whether IMDSv2 should be required on this instance
- false

property securityGroup

readonly securityGroup?: ISecurityGroup;

Security Group to assign to this instance
- create new security group with no inbound and all outbound traffic allowed

property subnetSelection

readonly subnetSelection?: SubnetSelection;

Select the subnets to run the bastion host in. Set this to PUBLIC if you need to connect to this instance via the internet and cannot use SSM. You have to allow port 22 manually by using the connections field
- private subnets of the supplied VPC

property vpc

readonly vpc: IVpc;

VPC to launch the instance in.

interface BlockDevice

interface BlockDevice {}

Block device

property deviceName

readonly deviceName: string;

The device name exposed to the EC2 instance
For example, a value like /dev/sdh, xvdh.
See Also
- https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html

property mappingEnabled

readonly mappingEnabled?: boolean;

If false, the device mapping will be suppressed. If set to false for the root device, the instance might fail the Amazon EC2 health check. Amazon EC2 Auto Scaling launches a replacement instance if the instance fails the health check.
true - device mapping is left untouched

property volume

readonly volume: BlockDeviceVolume;

Defines the block device volume, to be either an Amazon EBS volume or an ephemeral instance store volume
For example, a value like BlockDeviceVolume.ebs(15), BlockDeviceVolume.ephemeral(0).

interface CfnCapacityReservationFleetProps

interface CfnCapacityReservationFleetProps {}

Properties for defining a CfnCapacityReservationFleet
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html

property allocationStrategy

readonly allocationStrategy?: string;

The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use. Currently, only the prioritized allocation strategy is supported. For more information, see [Allocation strategy](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#allocation-strategy) in the Amazon EC2 User Guide.
Valid values: prioritized
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-allocationstrategy

property endDate

readonly endDate?: string;

The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes to expired and all of the Capacity Reservations in the Fleet expire.
The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify 5/31/2019 , 13:30:55 , the Capacity Reservation Fleet is guaranteed to expire between 13:30:55 and 14:30:55 on 5/31/2019 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-enddate

property instanceMatchCriteria

readonly instanceMatchCriteria?: string;

Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.
Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-instancematchcriteria

property instanceTypeSpecifications

readonly instanceTypeSpecifications?:
    | Array<
          | CfnCapacityReservationFleet.InstanceTypeSpecificationProperty
          | cdk.IResolvable
      >
    | cdk.IResolvable;

Information about the instance types for which to reserve the capacity.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-instancetypespecifications

property noRemoveEndDate

readonly noRemoveEndDate?: boolean | cdk.IResolvable;

Used to add an end date to a Capacity Reservation Fleet that has no end date and time. To add an end date to a Capacity Reservation Fleet, specify true for this paramater and specify the end date and time (in UTC time format) for the *EndDate* parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-noremoveenddate

property removeEndDate

readonly removeEndDate?: boolean | cdk.IResolvable;

Used to remove an end date from a Capacity Reservation Fleet that is configured to end automatically at a specific date and time. To remove the end date from a Capacity Reservation Fleet, specify true for this paramater and omit the *EndDate* parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-removeenddate

property tagSpecifications

readonly tagSpecifications?:
    | Array<
          CfnCapacityReservationFleet.TagSpecificationProperty | cdk.IResolvable
      >
    | cdk.IResolvable;

The tags to assign to the Capacity Reservation Fleet. The tags are automatically assigned to the Capacity Reservations in the Fleet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-tagspecifications

property tenancy

readonly tenancy?: string;

Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings:
- default - The Capacity Reservation Fleet is created on hardware that is shared with other AWS accounts . - dedicated - The Capacity Reservations are created on single-tenant hardware that is dedicated to a single AWS account .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-tenancy

property totalTargetCapacity

readonly totalTargetCapacity?: number;

The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, together with the instance type weights that you assign to each instance type used by the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see [Total target capacity](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity) in the Amazon EC2 User Guide.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-totaltargetcapacity

interface CfnCapacityReservationProps

interface CfnCapacityReservationProps {}

Properties for defining a CfnCapacityReservation
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html

property availabilityZone

readonly availabilityZone: string;

The Availability Zone in which to create the Capacity Reservation.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-availabilityzone

property ebsOptimized

readonly ebsOptimized?: boolean | cdk.IResolvable;

Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-ebsoptimized

property endDate

readonly endDate?: string;

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
You must provide an EndDate value if EndDateType is limited . Omit EndDate if EndDateType is unlimited .
If the EndDateType is limited , the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-enddate

property endDateType

readonly endDateType?: string;

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
- unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited . - limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-enddatetype

property ephemeralStorage

readonly ephemeralStorage?: boolean | cdk.IResolvable;

*Deprecated.*
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-ephemeralstorage

property instanceCount

readonly instanceCount: number;

The number of instances for which to reserve capacity.
Valid range: 1 - 1000
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-instancecount

property instanceMatchCriteria

readonly instanceMatchCriteria?: string;

Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
- open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters. - targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
Default: open
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-instancematchcriteria

property instancePlatform

readonly instancePlatform: string;

The type of operating system for which to reserve capacity.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-instanceplatform

property instanceType

readonly instanceType: string;

The instance type for which to reserve capacity. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-instancetype

property outPostArn

readonly outPostArn?: string;

The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-outpostarn

property placementGroupArn

readonly placementGroupArn?: string;

The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation. For more information, see [Capacity Reservations for cluster placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-cpg.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-placementgrouparn

property tagSpecifications

readonly tagSpecifications?:
    | Array<CfnCapacityReservation.TagSpecificationProperty | cdk.IResolvable>
    | cdk.IResolvable;

The tags to apply to the Capacity Reservation during launch.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-tagspecifications

property tenancy

readonly tenancy?: string;

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
- default - The Capacity Reservation is created on hardware that is shared with other AWS accounts . - dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-tenancy

interface CfnCarrierGatewayProps

interface CfnCarrierGatewayProps {}

Properties for defining a CfnCarrierGateway
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-carriergateway.html

property tags

readonly tags?: cdk.CfnTag[];

The tags assigned to the carrier gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-carriergateway.html#cfn-ec2-carriergateway-tags

property vpcId

readonly vpcId: string;

The ID of the VPC associated with the carrier gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-carriergateway.html#cfn-ec2-carriergateway-vpcid

interface CfnClientVpnAuthorizationRuleProps

interface CfnClientVpnAuthorizationRuleProps {}

Properties for defining a CfnClientVpnAuthorizationRule
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html

property accessGroupId

readonly accessGroupId?: string;

The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group. Required if AuthorizeAllGroups is false or not specified.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-accessgroupid

property authorizeAllGroups

readonly authorizeAllGroups?: boolean | cdk.IResolvable;

Indicates whether to grant access to all clients. Specify true to grant all clients who successfully establish a VPN connection access to the network. Must be set to true if AccessGroupId is not specified.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-authorizeallgroups

property clientVpnEndpointId

readonly clientVpnEndpointId: string;

The ID of the Client VPN endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-clientvpnendpointid

property description

readonly description?: string;

A brief description of the authorization rule.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-description

property targetNetworkCidr

readonly targetNetworkCidr: string;

The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-targetnetworkcidr

interface CfnClientVpnEndpointProps

interface CfnClientVpnEndpointProps {}

Properties for defining a CfnClientVpnEndpoint
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html

property authenticationOptions

readonly authenticationOptions:
    | Array<
          | CfnClientVpnEndpoint.ClientAuthenticationRequestProperty
          | cdk.IResolvable
      >
    | cdk.IResolvable;

Information about the authentication method to be used to authenticate clients.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-authenticationoptions

property clientCidrBlock

readonly clientCidrBlock: string;

The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. Client CIDR range must have a size of at least /22 and must not be greater than /12.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientcidrblock

property clientConnectOptions

readonly clientConnectOptions?:
    | CfnClientVpnEndpoint.ClientConnectOptionsProperty
    | cdk.IResolvable;

The options for managing connection authorization for new client connections.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientconnectoptions

property clientLoginBannerOptions

readonly clientLoginBannerOptions?:
    | CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty
    | cdk.IResolvable;

Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientloginbanneroptions

property connectionLogOptions

readonly connectionLogOptions:
    | CfnClientVpnEndpoint.ConnectionLogOptionsProperty
    | cdk.IResolvable;

Information about the client connection logging options.
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
- Client connection requests - Client connection results (successful and unsuccessful) - Reasons for unsuccessful client connection requests - Client connection termination time
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-connectionlogoptions

property description

readonly description?: string;

A brief description of the Client VPN endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-description

property dnsServers

readonly dnsServers?: string[];

Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-dnsservers

property securityGroupIds

readonly securityGroupIds?: string[];

The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-securitygroupids

property selfServicePortal

readonly selfServicePortal?: string;

Specify whether to enable the self-service portal for the Client VPN endpoint.
Default Value: enabled
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-selfserviceportal

property serverCertificateArn

readonly serverCertificateArn: string;

The ARN of the server certificate. For more information, see the [AWS Certificate Manager User Guide](https://docs.aws.amazon.com/acm/latest/userguide/) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-servercertificatearn

property sessionTimeoutHours

readonly sessionTimeoutHours?: number;

The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-sessiontimeouthours

property splitTunnel

readonly splitTunnel?: boolean | cdk.IResolvable;

Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
By default, split-tunnel on a VPN endpoint is disabled.
For information about split-tunnel VPN endpoints, see [Split-tunnel AWS Client VPN endpoint](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html) in the *AWS Client VPN Administrator Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-splittunnel

property tagSpecifications

readonly tagSpecifications?:
    | Array<CfnClientVpnEndpoint.TagSpecificationProperty | cdk.IResolvable>
    | cdk.IResolvable;

The tags to apply to the Client VPN endpoint during creation.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-tagspecifications

property transportProtocol

readonly transportProtocol?: string;

The transport protocol to be used by the VPN session.
Default value: udp
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-transportprotocol

property vpcId

readonly vpcId?: string;

The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-vpcid

property vpnPort

readonly vpnPort?: number;

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 | 1194
Default Value: 443
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-vpnport

interface CfnClientVpnRouteProps

interface CfnClientVpnRouteProps {}

Properties for defining a CfnClientVpnRoute
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html

property clientVpnEndpointId

readonly clientVpnEndpointId: string;

The ID of the Client VPN endpoint to which to add the route.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html#cfn-ec2-clientvpnroute-clientvpnendpointid

property description

readonly description?: string;

A brief description of the route.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html#cfn-ec2-clientvpnroute-description

property destinationCidrBlock

readonly destinationCidrBlock: string;

The IPv4 address range, in CIDR notation, of the route destination. For example:
- To add a route for Internet access, enter 0.0.0.0/0 - To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range - To add a route for an on-premises network, enter the AWS Site-to-Site VPN connection's IPv4 CIDR range - To add a route for the local network, enter the client CIDR range
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html#cfn-ec2-clientvpnroute-destinationcidrblock

property targetVpcSubnetId

readonly targetVpcSubnetId: string;

The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target network of the Client VPN endpoint.
Alternatively, if you're adding a route for the local network, specify local .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html#cfn-ec2-clientvpnroute-targetvpcsubnetid

interface CfnClientVpnTargetNetworkAssociationProps

interface CfnClientVpnTargetNetworkAssociationProps {}

Properties for defining a CfnClientVpnTargetNetworkAssociation
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpntargetnetworkassociation.html

property clientVpnEndpointId

readonly clientVpnEndpointId: string;

The ID of the Client VPN endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpntargetnetworkassociation.html#cfn-ec2-clientvpntargetnetworkassociation-clientvpnendpointid

property subnetId

readonly subnetId: string;

The ID of the subnet to associate with the Client VPN endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpntargetnetworkassociation.html#cfn-ec2-clientvpntargetnetworkassociation-subnetid

interface CfnCustomerGatewayProps

interface CfnCustomerGatewayProps {}

Properties for defining a CfnCustomerGateway
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html

property bgpAsn

readonly bgpAsn: number;

For devices that support BGP, the customer gateway's BGP ASN.
Default: 65000
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-bgpasn

property deviceName

readonly deviceName?: string;

The name of customer gateway device.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-devicename

property ipAddress

readonly ipAddress: string;

IPv4 address for the customer gateway device's outside interface. The address must be static.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-ipaddress

property tags

readonly tags?: cdk.CfnTag[];

One or more tags for the customer gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-tags

property type

readonly type: string;

The type of VPN connection that this customer gateway supports ( ipsec.1 ).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-type

interface CfnDHCPOptionsProps

interface CfnDHCPOptionsProps {}

Properties for defining a CfnDHCPOptions
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html

property domainName

readonly domainName?: string;

This value is used to complete unqualified DNS hostnames. If you're using AmazonProvidedDNS in us-east-1 , specify ec2.internal . If you're using AmazonProvidedDNS in another Region, specify *region* . compute.internal (for example, ap-northeast-1.compute.internal ). Otherwise, specify a domain name (for example, *MyCompany.com* ).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-domainname

property domainNameServers

readonly domainNameServers?: string[];

The IPv4 addresses of up to four domain name servers, or AmazonProvidedDNS . The default is AmazonProvidedDNS . To have your instance receive a custom DNS hostname as specified in DomainName , you must set this property to a custom DNS server.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-domainnameservers

property netbiosNameServers

readonly netbiosNameServers?: string[];

The IPv4 addresses of up to four NetBIOS name servers.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-netbiosnameservers

property netbiosNodeType

readonly netbiosNodeType?: number;

The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-netbiosnodetype

property ntpServers

readonly ntpServers?: string[];

The IPv4 addresses of up to four Network Time Protocol (NTP) servers.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-ntpservers

property tags

readonly tags?: cdk.CfnTag[];

Any tags assigned to the DHCP options set.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-tags

interface CfnEC2FleetProps

interface CfnEC2FleetProps {}

Properties for defining a CfnEC2Fleet
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html

property context

readonly context?: string;

Reserved.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-context

property excessCapacityTerminationPolicy

readonly excessCapacityTerminationPolicy?: string;

Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
Supported only for fleets of type maintain .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-excesscapacityterminationpolicy

property launchTemplateConfigs

readonly launchTemplateConfigs:
    | Array<
          CfnEC2Fleet.FleetLaunchTemplateConfigRequestProperty | cdk.IResolvable
      >
    | cdk.IResolvable;

The configuration for the EC2 Fleet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-launchtemplateconfigs

property onDemandOptions

readonly onDemandOptions?:
    | CfnEC2Fleet.OnDemandOptionsRequestProperty
    | cdk.IResolvable;

Describes the configuration of On-Demand Instances in an EC2 Fleet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-ondemandoptions

property replaceUnhealthyInstances

readonly replaceUnhealthyInstances?: boolean | cdk.IResolvable;

Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type maintain . For more information, see [EC2 Fleet health checks](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#ec2-fleet-health-checks) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-replaceunhealthyinstances

property spotOptions

readonly spotOptions?: CfnEC2Fleet.SpotOptionsRequestProperty | cdk.IResolvable;

Describes the configuration of Spot Instances in an EC2 Fleet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-spotoptions

property tagSpecifications

readonly tagSpecifications?:
    | Array<CfnEC2Fleet.TagSpecificationProperty | cdk.IResolvable>
    | cdk.IResolvable;

The key-value pair for tagging the EC2 Fleet request on creation. For more information, see [Tagging your resources](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources) .
If the fleet type is instant , specify a resource type of fleet to tag the fleet or instance to tag the instances at launch.
If the fleet type is maintain or request , specify a resource type of fleet to tag the fleet. You cannot specify a resource type of instance . To tag instances at launch, specify the tags in a [launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-tagspecifications

property targetCapacitySpecification

readonly targetCapacitySpecification:
    | CfnEC2Fleet.TargetCapacitySpecificationRequestProperty
    | cdk.IResolvable;

The number of units to request.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-targetcapacityspecification

property terminateInstancesWithExpiration

readonly terminateInstancesWithExpiration?: boolean | cdk.IResolvable;

Indicates whether running instances should be terminated when the EC2 Fleet expires.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-terminateinstanceswithexpiration

property type

readonly type?: string;

The fleet type. The default value is maintain .
- maintain - The EC2 Fleet places an asynchronous request for your desired capacity, and continues to maintain your desired Spot capacity by replenishing interrupted Spot Instances. - request - The EC2 Fleet places an asynchronous one-time request for your desired capacity, but does submit Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not maintain Spot capacity if Spot Instances are interrupted. - instant - The EC2 Fleet places a synchronous one-time request for your desired capacity, and returns errors for any instances that could not be launched.
For more information, see [EC2 Fleet request types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-request-type.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-type

property validFrom

readonly validFrom?: string;

The start date and time of the request, in UTC format (for example, *YYYY* - *MM* - *DD* T *HH* : *MM* : *SS* Z). The default is to start fulfilling the request immediately.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-validfrom

property validUntil

readonly validUntil?: string;

The end date and time of the request, in UTC format (for example, *YYYY* - *MM* - *DD* T *HH* : *MM* : *SS* Z). At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-validuntil

interface CfnEgressOnlyInternetGatewayProps

interface CfnEgressOnlyInternetGatewayProps {}

Properties for defining a CfnEgressOnlyInternetGateway
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-egressonlyinternetgateway.html

property vpcId

readonly vpcId: string;

The ID of the VPC for which to create the egress-only internet gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-egressonlyinternetgateway.html#cfn-ec2-egressonlyinternetgateway-vpcid

interface CfnEIPAssociationProps

interface CfnEIPAssociationProps {}

Properties for defining a CfnEIPAssociation
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html

property allocationId

readonly allocationId?: string;

The allocation ID. This is required.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-allocationid

property eip

readonly eip?: string;

Deprecated.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-eip

property instanceId

readonly instanceId?: string;

The ID of the instance. The instance must have exactly one attached network interface. You can specify either the instance ID or the network interface ID, but not both.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-instanceid

property networkInterfaceId

readonly networkInterfaceId?: string;

The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
You can specify either the instance ID or the network interface ID, but not both.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-networkinterfaceid

property privateIpAddress

readonly privateIpAddress?: string;

The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-PrivateIpAddress

interface CfnEIPProps

interface CfnEIPProps {}

Properties for defining a CfnEIP
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html

property domain

readonly domain?: string;

The network ( vpc ).
If you define an Elastic IP address and associate it with a VPC that is defined in the same template, you must declare a dependency on the VPC-gateway attachment by using the [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) on this resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-domain

property instanceId

readonly instanceId?: string;

The ID of the instance.
> Updates to the InstanceId property may require *some interruptions* . Updates on an EIP reassociates the address on its associated resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-instanceid

property networkBorderGroup

readonly networkBorderGroup?: string;

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.
Use [DescribeAvailabilityZones](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) to view the network border groups.
You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, you receive an InvalidParameterCombination error.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-networkbordergroup

property publicIpv4Pool

readonly publicIpv4Pool?: string;

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool.
> Updates to the PublicIpv4Pool property may require *some interruptions* . Updates on an EIP reassociates the address on its associated resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-publicipv4pool

property tags

readonly tags?: cdk.CfnTag[];

Any tags assigned to the Elastic IP address.
> Updates to the Tags property may require *some interruptions* . Updates on an EIP reassociates the address on its associated resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-tags

property transferAddress

readonly transferAddress?: string;

The Elastic IP address you are accepting for transfer. You can only accept one transferred address. For more information on Elastic IP address transfers, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon Virtual Private Cloud User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-transferaddress

interface CfnEnclaveCertificateIamRoleAssociationProps

interface CfnEnclaveCertificateIamRoleAssociationProps {}

Properties for defining a CfnEnclaveCertificateIamRoleAssociation
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-enclavecertificateiamroleassociation.html

property certificateArn

readonly certificateArn: string;

The ARN of the ACM certificate with which to associate the IAM role.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-enclavecertificateiamroleassociation.html#cfn-ec2-enclavecertificateiamroleassociation-certificatearn

property roleArn

readonly roleArn: string;

The ARN of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM certificate.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-enclavecertificateiamroleassociation.html#cfn-ec2-enclavecertificateiamroleassociation-rolearn

interface CfnFlowLogProps

interface CfnFlowLogProps {}

Properties for defining a CfnFlowLog
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html

property deliverLogsPermissionArn

readonly deliverLogsPermissionArn?: string;

The ARN of the IAM role that allows Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.
This parameter is required if the destination type is cloud-watch-logs and unsupported otherwise.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-deliverlogspermissionarn

property destinationOptions

readonly destinationOptions?: any | cdk.IResolvable;

The destination options. The following options are supported:
- FileFormat - The format for the flow log ( plain-text | parquet ). The default is plain-text . - HiveCompatiblePartitions - Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3 ( true | false ). The default is false . - PerHourPartition - Indicates whether to partition the flow log per hour ( true | false ). The default is false .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-destinationoptions

property logDestination

readonly logDestination?: string;

The destination for the flow log data. The meaning of this parameter depends on the destination type.
- If the destination type is cloud-watch-logs , specify the ARN of a CloudWatch Logs log group. For example:
arn:aws:logs: *region* : *account_id* :log-group: *my_group*
Alternatively, use the LogGroupName parameter. - If the destination type is s3 , specify the ARN of an S3 bucket. For example:
arn:aws:s3::: *my_bucket* / *my_subfolder* /
The subfolder is optional. Note that you can't use AWSLogs as a subfolder name. - If the destination type is kinesis-data-firehose , specify the ARN of a Kinesis Data Firehose delivery stream. For example:
arn:aws:firehose: *region* : *account_id* :deliverystream: *my_stream*
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logdestination

property logDestinationType

readonly logDestinationType?: string;

The type of destination for the flow log data.
Default: cloud-watch-logs
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logdestinationtype

property logFormat

readonly logFormat?: string;

The fields to include in the flow log record, in the order in which they should appear. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must include at least one field. For more information about the available fields, see [Flow log records](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records) in the *Amazon VPC User Guide* or [Transit Gateway Flow Log records](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-flow-logs.html#flow-log-records) in the *AWS Transit Gateway Guide* .
Specify the fields using the ${field-id} format, separated by spaces.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logformat

property logGroupName

readonly logGroupName?: string;

The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
This parameter is valid only if the destination type is cloud-watch-logs .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-loggroupname

property maxAggregationInterval

readonly maxAggregationInterval?: number;

The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes). This parameter must be 60 seconds for transit gateway resource types.
When a network interface is attached to a [Nitro-based instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) , the aggregation interval is always 60 seconds or less, regardless of the value that you specify.
Default: 600
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-maxaggregationinterval

property resourceId

readonly resourceId: string;

The ID of the resource to monitor. For example, if the resource type is VPC , specify the ID of the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-resourceid

property resourceType

readonly resourceType: string;

The type of resource to monitor.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-resourcetype

property tags

readonly tags?: cdk.CfnTag[];

The tags to apply to the flow logs.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-tags

property trafficType

readonly trafficType?: string;

The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic). This parameter is not supported for transit gateway resource types. It is required for the other resource types.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-traffictype

interface CfnGatewayRouteTableAssociationProps

interface CfnGatewayRouteTableAssociationProps {}

Properties for defining a CfnGatewayRouteTableAssociation
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-gatewayroutetableassociation.html

property gatewayId

readonly gatewayId: string;

The ID of the gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-gatewayroutetableassociation.html#cfn-ec2-gatewayroutetableassociation-gatewayid

property routeTableId

readonly routeTableId: string;

The ID of the route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-gatewayroutetableassociation.html#cfn-ec2-gatewayroutetableassociation-routetableid

interface CfnHostProps

interface CfnHostProps {}

Properties for defining a CfnHost
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html

property autoPlacement

readonly autoPlacement?: string;

Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see [Understanding auto-placement and affinity](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-understanding) in the *Amazon EC2 User Guide* .
Default: on
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-autoplacement

property availabilityZone

readonly availabilityZone: string;

The Availability Zone in which to allocate the Dedicated Host.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-availabilityzone

property hostMaintenance

readonly hostMaintenance?: string;

Indicates whether host maintenance is enabled or disabled for the Dedicated Host.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-hostmaintenance

property hostRecovery

readonly hostRecovery?: string;

Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see [Host recovery](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-recovery.html) in the *Amazon EC2 User Guide* .
Default: off
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-hostrecovery

property instanceFamily

readonly instanceFamily?: string;

The instance family supported by the Dedicated Host. For example, m5 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-instancefamily

property instanceType

readonly instanceType?: string;

Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-instancetype

property outpostArn

readonly outpostArn?: string;

The Amazon Resource Name (ARN) of the AWS Outpost on which the Dedicated Host is allocated.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-outpostarn

interface CfnInstanceProps

interface CfnInstanceProps {}

Properties for defining a CfnInstance
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html

property additionalInfo

readonly additionalInfo?: string;

This property is reserved for internal use. If you use it, the stack fails with this error: Bad property set: [Testing this property] (Service: AmazonEC2; Status Code: 400; Error Code: InvalidParameterCombination; Request ID: 0XXXXXX-49c7-4b40-8bcc-76885dcXXXXX) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-additionalinfo

property affinity

readonly affinity?: string;

Indicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host . If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-affinity

property availabilityZone

readonly availabilityZone?: string;

The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported by [DescribeImageAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImageAttribute.html) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-availabilityzone

property blockDeviceMappings

readonly blockDeviceMappings?:
    | Array<CfnInstance.BlockDeviceMappingProperty | cdk.IResolvable>
    | cdk.IResolvable;

The block device mapping entries that defines the block devices to attach to the instance at launch.
By default, the block devices specified in the block device mapping for the AMI are used. You can override the AMI block device mapping using the instance block device mapping. For the root volume, you can override only the volume size, volume type, volume encryption settings, and the DeleteOnTermination setting.
> After the instance is running, you can modify only the DeleteOnTermination parameter for the attached volumes without interrupting the instance. Modifying any other parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-blockdevicemappings

property cpuOptions

readonly cpuOptions?: CfnInstance.CpuOptionsProperty | cdk.IResolvable;

The CPU options for the instance. For more information, see [Optimize CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *Amazon Elastic Compute Cloud User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-cpuoptions

property creditSpecification

readonly creditSpecification?:
    | CfnInstance.CreditSpecificationProperty
    | cdk.IResolvable;

The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited . To change this attribute after launch, use [ModifyInstanceCreditSpecification](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceCreditSpecification.html) . For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide* .
Default: standard (T2 instances) or unlimited (T3/T3a/T4g instances)
For T3 instances with host tenancy, only standard is supported.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-creditspecification

property disableApiTermination

readonly disableApiTermination?: boolean | cdk.IResolvable;

If you set this parameter to true , you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use [ModifyInstanceAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html) . Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate , you can terminate the instance by running the shutdown command from the instance.
Default: false
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-disableapitermination

property ebsOptimized

readonly ebsOptimized?: boolean | cdk.IResolvable;

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ebsoptimized

property elasticGpuSpecifications

readonly elasticGpuSpecifications?:
    | Array<CfnInstance.ElasticGpuSpecificationProperty | cdk.IResolvable>
    | cdk.IResolvable;

An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see [Amazon EC2 Elastic GPUs](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-elasticgpuspecifications

property elasticInferenceAccelerators

readonly elasticInferenceAccelerators?:
    | Array<CfnInstance.ElasticInferenceAcceleratorProperty | cdk.IResolvable>
    | cdk.IResolvable;

An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
You cannot specify accelerators from different generations in the same request.
> Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-elasticinferenceaccelerators

property enclaveOptions

readonly enclaveOptions?: CfnInstance.EnclaveOptionsProperty | cdk.IResolvable;

Indicates whether the instance is enabled for AWS Nitro Enclaves.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-enclaveoptions

property hibernationOptions

readonly hibernationOptions?:
    | CfnInstance.HibernationOptionsProperty
    | cdk.IResolvable;

Indicates whether an instance is enabled for hibernation. For more information, see [Hibernate your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon EC2 User Guide* .
You can't enable hibernation and AWS Nitro Enclaves on the same instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-hibernationoptions

property hostId

readonly hostId?: string;

If you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account. This type of launch is called an untargeted launch. Note that for untargeted launches, you must have a compatible, dedicated host available to successfully launch instances.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-hostid

property hostResourceGroupArn

readonly hostResourceGroupArn?: string;

The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the *Tenancy* parameter or set it to host .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-hostresourcegrouparn

property iamInstanceProfile

readonly iamInstanceProfile?: string;

The name of an IAM instance profile. To create a new IAM instance profile, use the [AWS::IAM::InstanceProfile](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html) resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-iaminstanceprofile

property imageId

readonly imageId?: string;

The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-imageid

property instanceInitiatedShutdownBehavior

readonly instanceInitiatedShutdownBehavior?: string;

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-instanceinitiatedshutdownbehavior

property instanceType

readonly instanceType?: string;

The instance type. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide* .
Default: m1.small
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-instancetype

property ipv6AddressCount

readonly ipv6AddressCount?: number;

The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ipv6addresscount

property ipv6Addresses

readonly ipv6Addresses?:
    | Array<CfnInstance.InstanceIpv6AddressProperty | cdk.IResolvable>
    | cdk.IResolvable;

The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ipv6addresses

property kernelId

readonly kernelId?: string;

The ID of the kernel.
> We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [PV-GRUB](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-kernelid

property keyName

readonly keyName?: string;

The name of the key pair. You can create a key pair using [CreateKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) or [ImportKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html) .
> If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-keyname

property launchTemplate

readonly launchTemplate?:
    | CfnInstance.LaunchTemplateSpecificationProperty
    | cdk.IResolvable;

The launch template to use to launch the instances. Any parameters that you specify in the AWS CloudFormation template override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-launchtemplate

property licenseSpecifications

readonly licenseSpecifications?:
    | Array<CfnInstance.LicenseSpecificationProperty | cdk.IResolvable>
    | cdk.IResolvable;

The license configurations.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-licensespecifications

property monitoring

readonly monitoring?: boolean | cdk.IResolvable;

Specifies whether detailed monitoring is enabled for the instance. Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled. For more information about detailed monitoring, see [Enable or turn off detailed monitoring for your instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-monitoring

property networkInterfaces

readonly networkInterfaces?:
    | Array<CfnInstance.NetworkInterfaceProperty | cdk.IResolvable>
    | cdk.IResolvable;

The network interfaces to associate with the instance.
> If you use this property to point to a network interface, you must terminate the original interface before attaching a new one to allow the update of the instance to succeed. > > If this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the VPC-gateway attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-networkinterfaces

property placementGroupName

readonly placementGroupName?: string;

The name of an existing placement group that you want to launch the instance into (cluster | partition | spread).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-placementgroupname

property privateDnsNameOptions

readonly privateDnsNameOptions?:
    | CfnInstance.PrivateDnsNameOptionsProperty
    | cdk.IResolvable;

The options for the instance hostname.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-privatednsnameoptions

property privateIpAddress

readonly privateIpAddress?: string;

The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.
You cannot specify this option and the network interfaces option in the same request.
If you make an update to an instance that requires replacement, you must assign a new private IP address. During a replacement, AWS CloudFormation creates a new instance but doesn't delete the old instance until the stack has successfully updated. If the stack update fails, AWS CloudFormation uses the old instance to roll back the stack to the previous working state. The old and new instances cannot have the same private IP address.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-privateipaddress

property propagateTagsToVolumeOnCreation

readonly propagateTagsToVolumeOnCreation?: boolean | cdk.IResolvable;

Indicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch. If you specify true and you assign tags to the instance, those tags are automatically assigned to all of the volumes that you attach to the instance at launch. If you specify false , those tags are not assigned to the attached volumes.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-propagatetagstovolumeoncreation

property ramdiskId

readonly ramdiskId?: string;

The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the AWS Resource Center and search for the kernel ID.
> We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [PV-GRUB](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ramdiskid

property securityGroupIds

readonly securityGroupIds?: string[];

The IDs of the security groups. You can specify the IDs of existing security groups and references to resources created by the stack template.
If you specify a network interface, you must specify any security groups as part of the network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-securitygroupids

property securityGroups

readonly securityGroups?: string[];

[Default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.
You cannot specify this option and the network interfaces option in the same request. The list can contain both the name of existing Amazon EC2 security groups or references to AWS::EC2::SecurityGroup resources created in the template.
Default: Amazon EC2 uses the default security group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-securitygroups

property sourceDestCheck

readonly sourceDestCheck?: boolean | cdk.IResolvable;

Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true , source/destination checks are enabled; otherwise, they are disabled. The default value is true . You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-sourcedestcheck

property ssmAssociations

readonly ssmAssociations?:
    | Array<CfnInstance.SsmAssociationProperty | cdk.IResolvable>
    | cdk.IResolvable;

The SSM [document](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html) and parameter values in AWS Systems Manager to associate with this instance. To use this property, you must specify an IAM instance profile role for the instance. For more information, see [Create an IAM instance profile for Systems Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-configuring-access-role.html) in the *AWS Systems Manager User Guide* .
> You can currently associate only one document with an instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ssmassociations

property subnetId

readonly subnetId?: string;

The ID of the subnet to launch the instance into.
If you specify a network interface, you must specify any subnets as part of the network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-subnetid

property tags

readonly tags?: cdk.CfnTag[];

The tags to add to the instance. These tags are not applied to the EBS volumes, such as the root volume, unless [PropagateTagsToVolumeOnCreation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-propagatetagstovolumeoncreation) is true .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-tags

property tenancy

readonly tenancy?: string;

The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-tenancy

property userData

readonly userData?: string;

The user data script to make available to the instance. User data is limited to 16 KB. You must provide base64-encoded text. For more information, see [Fn::Base64](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-base64.html) .
User data runs only at instance launch. For more information, see [Run commands on your Linux instance at launch](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) and [Run commands on your Windows instance at launch](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-windows-user-data.html) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-userdata

property volumes

readonly volumes?:
    | Array<CfnInstance.VolumeProperty | cdk.IResolvable>
    | cdk.IResolvable;

The volumes to attach to the instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-volumes

interface CfnInternetGatewayProps

interface CfnInternetGatewayProps {}

Properties for defining a CfnInternetGateway
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-internetgateway.html

property tags

readonly tags?: cdk.CfnTag[];

Any tags to assign to the internet gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-internetgateway.html#cfn-ec2-internetgateway-tags

interface CfnIPAMAllocationProps

interface CfnIPAMAllocationProps {}

Properties for defining a CfnIPAMAllocation
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html

property cidr

readonly cidr?: string;

The CIDR you would like to allocate from the IPAM pool. Note the following:
- If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR. - If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
Possible values: Any available IPv4 or IPv6 CIDR.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html#cfn-ec2-ipamallocation-cidr

property description

readonly description?: string;

A description for the allocation.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html#cfn-ec2-ipamallocation-description

property ipamPoolId

readonly ipamPoolId: string;

The ID of the IPAM pool from which you would like to allocate a CIDR.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html#cfn-ec2-ipamallocation-ipampoolid

property netmaskLength

readonly netmaskLength?: number;

The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:
- If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR. - If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html#cfn-ec2-ipamallocation-netmasklength

interface CfnIPAMPoolCidrProps

interface CfnIPAMPoolCidrProps {}

Properties for defining a CfnIPAMPoolCidr
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html

property cidr

readonly cidr?: string;

The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23 . An IPv6 CIDR example is 2001:DB8::/32 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html#cfn-ec2-ipampoolcidr-cidr

property ipamPoolId

readonly ipamPoolId: string;

The ID of the IPAM pool.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html#cfn-ec2-ipampoolcidr-ipampoolid

property netmaskLength

readonly netmaskLength?: number;

The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. "NetmaskLength" or "Cidr" is required.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html#cfn-ec2-ipampoolcidr-netmasklength

interface CfnIPAMPoolProps

interface CfnIPAMPoolProps {}

Properties for defining a CfnIPAMPool
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html

property addressFamily

readonly addressFamily: string;

The address family of the pool.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-addressfamily

property allocationDefaultNetmaskLength

readonly allocationDefaultNetmaskLength?: number;

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-allocationdefaultnetmasklength

property allocationMaxNetmaskLength

readonly allocationMaxNetmaskLength?: number;

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-allocationmaxnetmasklength

property allocationMinNetmaskLength

readonly allocationMinNetmaskLength?: number;

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-allocationminnetmasklength

property allocationResourceTags

readonly allocationResourceTags?:
    | Array<cdk.CfnTag | cdk.IResolvable>
    | cdk.IResolvable;

Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-allocationresourcetags

property autoImport

readonly autoImport?: boolean | cdk.IResolvable;

If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-autoimport

property awsService

readonly awsService?: string;

Limits which service in AWS that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-awsservice

property description

readonly description?: string;

The description of the IPAM pool.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-description

property ipamScopeId

readonly ipamScopeId: string;

The ID of the scope in which you would like to create the IPAM pool.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-ipamscopeid

property locale

readonly locale?: string;

The locale of the IPAM pool. In IPAM, the locale is the AWS Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an AWS Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-locale

property provisionedCidrs

readonly provisionedCidrs?:
    | Array<CfnIPAMPool.ProvisionedCidrProperty | cdk.IResolvable>
    | cdk.IResolvable;

Information about the CIDRs provisioned to an IPAM pool.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-provisionedcidrs

property publicIpSource

readonly publicIpSource?: string;

The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP . For more information, see [Create IPv6 pools](https://docs.aws.amazon.com//vpc/latest/ipam/intro-create-ipv6-pools.html) in the *Amazon VPC IPAM User Guide* . By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see [Quotas for your IPAM](https://docs.aws.amazon.com//vpc/latest/ipam/quotas-ipam.html) in the *Amazon VPC IPAM User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-publicipsource

property publiclyAdvertisable

readonly publiclyAdvertisable?: boolean | cdk.IResolvable;

Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-publiclyadvertisable

property sourceIpamPoolId

readonly sourceIpamPoolId?: string;

The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-sourceipampoolid

property tags

readonly tags?: cdk.CfnTag[];

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA , specify tag:Owner for the filter name and TeamA for the filter value.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-tags

interface CfnIPAMProps

interface CfnIPAMProps {}

Properties for defining a CfnIPAM
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html

property defaultResourceDiscoveryAssociationId

readonly defaultResourceDiscoveryAssociationId?: string;

The IPAM's default resource discovery association ID.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-defaultresourcediscoveryassociationid

property defaultResourceDiscoveryId

readonly defaultResourceDiscoveryId?: string;

The IPAM's default resource discovery ID.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-defaultresourcediscoveryid

property description

readonly description?: string;

The description for the IPAM.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-description

property operatingRegions

readonly operatingRegions?:
    | Array<CfnIPAM.IpamOperatingRegionProperty | cdk.IResolvable>
    | cdk.IResolvable;

The operating Regions for an IPAM. Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions.
For more information about operating Regions, see [Create an IPAM](https://docs.aws.amazon.com//vpc/latest/ipam/create-ipam.html) in the *Amazon VPC IPAM User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-operatingregions

property tags

readonly tags?: cdk.CfnTag[];

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA , specify tag:Owner for the filter name and TeamA for the filter value.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-tags

interface CfnIPAMResourceDiscoveryAssociationProps

interface CfnIPAMResourceDiscoveryAssociationProps {}

Properties for defining a CfnIPAMResourceDiscoveryAssociation
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscoveryassociation.html

property ipamId

readonly ipamId: string;

The IPAM ID.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscoveryassociation.html#cfn-ec2-ipamresourcediscoveryassociation-ipamid

property ipamResourceDiscoveryId

readonly ipamResourceDiscoveryId: string;

The resource discovery ID.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscoveryassociation.html#cfn-ec2-ipamresourcediscoveryassociation-ipamresourcediscoveryid

property tags

readonly tags?: cdk.CfnTag[];

A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscoveryassociation.html#cfn-ec2-ipamresourcediscoveryassociation-tags

interface CfnIPAMResourceDiscoveryProps

interface CfnIPAMResourceDiscoveryProps {}

Properties for defining a CfnIPAMResourceDiscovery
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscovery.html

property description

readonly description?: string;

The resource discovery description.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscovery.html#cfn-ec2-ipamresourcediscovery-description

property operatingRegions

readonly operatingRegions?:
    | Array<
          CfnIPAMResourceDiscovery.IpamOperatingRegionProperty | cdk.IResolvable
      >
    | cdk.IResolvable;

The operating Regions for the resource discovery. Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscovery.html#cfn-ec2-ipamresourcediscovery-operatingregions

property tags

readonly tags?: cdk.CfnTag[];

A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscovery.html#cfn-ec2-ipamresourcediscovery-tags

interface CfnIPAMScopeProps

interface CfnIPAMScopeProps {}

Properties for defining a CfnIPAMScope
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html

property description

readonly description?: string;

The description of the scope.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html#cfn-ec2-ipamscope-description

property ipamId

readonly ipamId: string;

The ID of the IPAM for which you're creating this scope.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html#cfn-ec2-ipamscope-ipamid

property tags

readonly tags?: cdk.CfnTag[];

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA , specify tag:Owner for the filter name and TeamA for the filter value.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html#cfn-ec2-ipamscope-tags

interface CfnKeyPairProps

interface CfnKeyPairProps {}

Properties for defining a CfnKeyPair
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html

property keyName

readonly keyName: string;

A unique name for the key pair.
Constraints: Up to 255 ASCII characters
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-keyname

property keyType

readonly keyType?: string;

The type of key pair. Note that ED25519 keys are not supported for Windows instances.
If the PublicKeyMaterial property is specified, the KeyType property is ignored, and the key type is inferred from the PublicKeyMaterial value.
Default: rsa
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-keytype

property publicKeyMaterial

readonly publicKeyMaterial?: string;

The public key material. The PublicKeyMaterial property is used to import a key pair. If this property is not specified, then a new key pair will be created.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-publickeymaterial

property tags

readonly tags?: cdk.CfnTag[];

The tags to apply to the key pair.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-tags

interface CfnLaunchTemplateProps

interface CfnLaunchTemplateProps {}

Properties for defining a CfnLaunchTemplate
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html

property launchTemplateData

readonly launchTemplateData:
    | CfnLaunchTemplate.LaunchTemplateDataProperty
    | cdk.IResolvable;

The information for the launch template.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-launchtemplatedata

property launchTemplateName

readonly launchTemplateName?: string;

A name for the launch template.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-launchtemplatename

property tagSpecifications

readonly tagSpecifications?:
    | Array<
          | CfnLaunchTemplate.LaunchTemplateTagSpecificationProperty
          | cdk.IResolvable
      >
    | cdk.IResolvable;

The tags to apply to the launch template on creation. To tag the launch template, the resource type must be launch-template .
> To specify the tags for the resources that are created when an instance is launched, you must use the TagSpecifications parameter in the [launch template data](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestLaunchTemplateData.html) structure.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications

property versionDescription

readonly versionDescription?: string;

A description for the first version of the launch template.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-versiondescription

interface CfnLocalGatewayRouteProps

interface CfnLocalGatewayRouteProps {}

Properties for defining a CfnLocalGatewayRoute
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html

property destinationCidrBlock

readonly destinationCidrBlock: string;

The CIDR block used for destination matches.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html#cfn-ec2-localgatewayroute-destinationcidrblock

property localGatewayRouteTableId

readonly localGatewayRouteTableId: string;

The ID of the local gateway route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html#cfn-ec2-localgatewayroute-localgatewayroutetableid

property localGatewayVirtualInterfaceGroupId

readonly localGatewayVirtualInterfaceGroupId?: string;

The ID of the virtual interface group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html#cfn-ec2-localgatewayroute-localgatewayvirtualinterfacegroupid

property networkInterfaceId

readonly networkInterfaceId?: string;

The ID of the network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html#cfn-ec2-localgatewayroute-networkinterfaceid

interface CfnLocalGatewayRouteTableProps

interface CfnLocalGatewayRouteTableProps {}

Properties for defining a CfnLocalGatewayRouteTable
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetable.html

property localGatewayId

readonly localGatewayId: string;

The ID of the local gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetable.html#cfn-ec2-localgatewayroutetable-localgatewayid

property mode

readonly mode?: string;

The mode of the local gateway route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetable.html#cfn-ec2-localgatewayroutetable-mode

property tags

readonly tags?: cdk.CfnTag[];

The tags assigned to the local gateway route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetable.html#cfn-ec2-localgatewayroutetable-tags

interface CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociationProps

interface CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociationProps {}

Properties for defining a CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevirtualinterfacegroupassociation.html

property localGatewayRouteTableId

readonly localGatewayRouteTableId: string;

The ID of the local gateway route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevirtualinterfacegroupassociation.html#cfn-ec2-localgatewayroutetablevirtualinterfacegroupassociation-localgatewayroutetableid

property localGatewayVirtualInterfaceGroupId

readonly localGatewayVirtualInterfaceGroupId: string;

The ID of the virtual interface group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevirtualinterfacegroupassociation.html#cfn-ec2-localgatewayroutetablevirtualinterfacegroupassociation-localgatewayvirtualinterfacegroupid

property tags

readonly tags?: cdk.CfnTag[];

The tags assigned to the association.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevirtualinterfacegroupassociation.html#cfn-ec2-localgatewayroutetablevirtualinterfacegroupassociation-tags

interface CfnLocalGatewayRouteTableVPCAssociationProps

interface CfnLocalGatewayRouteTableVPCAssociationProps {}

Properties for defining a CfnLocalGatewayRouteTableVPCAssociation
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevpcassociation.html

property localGatewayRouteTableId

readonly localGatewayRouteTableId: string;

The ID of the local gateway route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevpcassociation.html#cfn-ec2-localgatewayroutetablevpcassociation-localgatewayroutetableid

property tags

readonly tags?: cdk.CfnTag[];

The tags assigned to the association.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevpcassociation.html#cfn-ec2-localgatewayroutetablevpcassociation-tags

property vpcId

readonly vpcId: string;

The ID of the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevpcassociation.html#cfn-ec2-localgatewayroutetablevpcassociation-vpcid

interface CfnNatGatewayProps

interface CfnNatGatewayProps {}

Properties for defining a CfnNatGateway
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html

property allocationId

readonly allocationId?: string;

[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway. This property is required for a public NAT gateway and cannot be specified with a private NAT gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-allocationid

property connectivityType

readonly connectivityType?: string;

Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-connectivitytype

property maxDrainDurationSeconds

readonly maxDrainDurationSeconds?: number;

The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-maxdraindurationseconds

property privateIpAddress

readonly privateIpAddress?: string;

The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-privateipaddress

property secondaryAllocationIds

readonly secondaryAllocationIds?: string[];

Secondary EIP allocation IDs. For more information, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon VPC User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-secondaryallocationids

property secondaryPrivateIpAddressCount

readonly secondaryPrivateIpAddressCount?: number;

[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide* .
> SecondaryPrivateIpAddressCount and SecondaryPrivateIpAddresses cannot be set at the same time.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-secondaryprivateipaddresscount

property secondaryPrivateIpAddresses

readonly secondaryPrivateIpAddresses?: string[];

Secondary private IPv4 addresses. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide* .
> SecondaryPrivateIpAddressCount and SecondaryPrivateIpAddresses cannot be set at the same time.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-secondaryprivateipaddresses

property subnetId

readonly subnetId: string;

The ID of the subnet in which the NAT gateway is located.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-subnetid

property tags

readonly tags?: cdk.CfnTag[];

The tags for the NAT gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-tags

interface CfnNetworkAclEntryProps

interface CfnNetworkAclEntryProps {}

Properties for defining a CfnNetworkAclEntry
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html

property cidrBlock

readonly cidrBlock?: string;

The IPv4 CIDR range to allow or deny, in CIDR notation (for example, 172.16.0.0/24). Requirement is conditional: You must specify the CidrBlock or Ipv6CidrBlock property.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-cidrblock

property egress

readonly egress?: boolean | cdk.IResolvable;

Whether this rule applies to egress traffic from the subnet ( true ) or ingress traffic to the subnet ( false ). By default, AWS CloudFormation specifies false .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-egress

property icmp

readonly icmp?: CfnNetworkAclEntry.IcmpProperty | cdk.IResolvable;

The Internet Control Message Protocol (ICMP) code and type. Requirement is conditional: Required if specifying 1 (ICMP) for the protocol parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-icmp

property ipv6CidrBlock

readonly ipv6CidrBlock?: string;

The IPv6 network range to allow or deny, in CIDR notation. Requirement is conditional: You must specify the CidrBlock or Ipv6CidrBlock property.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-ipv6cidrblock

property networkAclId

readonly networkAclId: string;

The ID of the ACL for the entry.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-networkaclid

property portRange

readonly portRange?: CfnNetworkAclEntry.PortRangeProperty | cdk.IResolvable;

The range of port numbers for the UDP/TCP protocol. Conditional required if specifying 6 (TCP) or 17 (UDP) for the protocol parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-portrange

property protocol

readonly protocol: number;

The IP protocol that the rule applies to. You must specify -1 or a protocol number. You can specify -1 for all protocols.
> If you specify -1, all ports are opened and the PortRange property is ignored.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-protocol

property ruleAction

readonly ruleAction: string;

Whether to allow or deny traffic that matches the rule; valid values are "allow" or "deny".
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-ruleaction

property ruleNumber

readonly ruleNumber: number;

Rule number to assign to the entry, such as 100. ACL entries are processed in ascending order by rule number. Entries can't use the same rule number unless one is an egress rule and the other is an ingress rule.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-rulenumber

interface CfnNetworkAclProps

interface CfnNetworkAclProps {}

Properties for defining a CfnNetworkAcl
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkacl.html

property tags

readonly tags?: cdk.CfnTag[];

The tags for the network ACL.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkacl.html#cfn-ec2-networkacl-tags

property vpcId

readonly vpcId: string;

The ID of the VPC for the network ACL.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkacl.html#cfn-ec2-networkacl-vpcid

interface CfnNetworkInsightsAccessScopeAnalysisProps

interface CfnNetworkInsightsAccessScopeAnalysisProps {}

Properties for defining a CfnNetworkInsightsAccessScopeAnalysis
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscopeanalysis.html

property networkInsightsAccessScopeId

readonly networkInsightsAccessScopeId: string;

The ID of the Network Access Scope.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscopeanalysis.html#cfn-ec2-networkinsightsaccessscopeanalysis-networkinsightsaccessscopeid

property tags

readonly tags?: cdk.CfnTag[];

The tags.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscopeanalysis.html#cfn-ec2-networkinsightsaccessscopeanalysis-tags

interface CfnNetworkInsightsAccessScopeProps

interface CfnNetworkInsightsAccessScopeProps {}

Properties for defining a CfnNetworkInsightsAccessScope
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscope.html

property excludePaths

readonly excludePaths?:
    | Array<
          | CfnNetworkInsightsAccessScope.AccessScopePathRequestProperty
          | cdk.IResolvable
      >
    | cdk.IResolvable;

The paths to exclude.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscope.html#cfn-ec2-networkinsightsaccessscope-excludepaths

property matchPaths

readonly matchPaths?:
    | Array<
          | CfnNetworkInsightsAccessScope.AccessScopePathRequestProperty
          | cdk.IResolvable
      >
    | cdk.IResolvable;

The paths to match.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscope.html#cfn-ec2-networkinsightsaccessscope-matchpaths

property tags

readonly tags?: cdk.CfnTag[];

The tags.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscope.html#cfn-ec2-networkinsightsaccessscope-tags

interface CfnNetworkInsightsAnalysisProps

interface CfnNetworkInsightsAnalysisProps {}

Properties for defining a CfnNetworkInsightsAnalysis
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html

property additionalAccounts

readonly additionalAccounts?: string[];

The member accounts that contain resources that the path can traverse.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#cfn-ec2-networkinsightsanalysis-additionalaccounts

property filterInArns

readonly filterInArns?: string[];

The Amazon Resource Names (ARN) of the resources that the path must traverse.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#cfn-ec2-networkinsightsanalysis-filterinarns

property networkInsightsPathId

readonly networkInsightsPathId: string;

The ID of the path.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#cfn-ec2-networkinsightsanalysis-networkinsightspathid

property tags

readonly tags?: cdk.CfnTag[];

The tags to apply.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#cfn-ec2-networkinsightsanalysis-tags

interface CfnNetworkInsightsPathProps

interface CfnNetworkInsightsPathProps {}

Properties for defining a CfnNetworkInsightsPath
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html

property destination

readonly destination?: string;

The ID or ARN of the destination. If the resource is in another account, you must specify an ARN.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-destination

property destinationIp

readonly destinationIp?: string;

The IP address of the destination.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-destinationip

property destinationPort

readonly destinationPort?: number;

The destination port.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-destinationport

property filterAtDestination

readonly filterAtDestination?:
    | CfnNetworkInsightsPath.PathFilterProperty
    | cdk.IResolvable;

Scopes the analysis to network paths that match specific filters at the destination. If you specify this parameter, you can't specify the parameter for the destination IP address.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-filteratdestination

property filterAtSource

readonly filterAtSource?:
    | CfnNetworkInsightsPath.PathFilterProperty
    | cdk.IResolvable;

Scopes the analysis to network paths that match specific filters at the source. If you specify this parameter, you can't specify the parameters for the source IP address or the destination port.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-filteratsource

property protocol

readonly protocol: string;

The protocol.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-protocol

property source

readonly source: string;

The ID or ARN of the source. If the resource is in another account, you must specify an ARN.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-source

property sourceIp

readonly sourceIp?: string;

The IP address of the source.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-sourceip

property tags

readonly tags?: cdk.CfnTag[];

The tags to add to the path.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-tags

interface CfnNetworkInterfaceAttachmentProps

interface CfnNetworkInterfaceAttachmentProps {}

Properties for defining a CfnNetworkInterfaceAttachment
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html

property deleteOnTermination

readonly deleteOnTermination?: boolean | cdk.IResolvable;

Whether to delete the network interface when the instance terminates. By default, this value is set to true .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html#cfn-ec2-network-interface-attachment-deleteonterm

property deviceIndex

readonly deviceIndex: string;

The network interface's position in the attachment order. For example, the first attached network interface has a DeviceIndex of 0.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html#cfn-ec2-network-interface-attachment-deviceindex

property instanceId

readonly instanceId: string;

The ID of the instance to which you will attach the ENI.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html#cfn-ec2-network-interface-attachment-instanceid

property networkInterfaceId

readonly networkInterfaceId: string;

The ID of the ENI that you want to attach.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html#cfn-ec2-network-interface-attachment-networkinterfaceid

interface CfnNetworkInterfacePermissionProps

interface CfnNetworkInterfacePermissionProps {}

Properties for defining a CfnNetworkInterfacePermission
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html

property awsAccountId

readonly awsAccountId: string;

The AWS account ID.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html#cfn-ec2-networkinterfacepermission-awsaccountid

property networkInterfaceId

readonly networkInterfaceId: string;

The ID of the network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html#cfn-ec2-networkinterfacepermission-networkinterfaceid

property permission

readonly permission: string;

The type of permission to grant: INSTANCE-ATTACH or EIP-ASSOCIATE .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html#cfn-ec2-networkinterfacepermission-permission

interface CfnNetworkInterfaceProps

interface CfnNetworkInterfaceProps {}

Properties for defining a CfnNetworkInterface
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html

property description

readonly description?: string;

A description for the network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-description

property groupSet

readonly groupSet?: string[];

The security group IDs associated with this network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-groupset

property interfaceType

readonly interfaceType?: string;

The type of network interface. The default is interface . The supported values are efa and trunk .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-interfacetype

property ipv6AddressCount

readonly ipv6AddressCount?: number;

The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-ipv6addresscount

property ipv6Addresses

readonly ipv6Addresses?:
    | Array<CfnNetworkInterface.InstanceIpv6AddressProperty | cdk.IResolvable>
    | cdk.IResolvable;

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-ipv6addresses

property privateIpAddress

readonly privateIpAddress?: string;

Assigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-privateipaddress

property privateIpAddresses

readonly privateIpAddresses?:
    | Array<
          | CfnNetworkInterface.PrivateIpAddressSpecificationProperty
          | cdk.IResolvable
      >
    | cdk.IResolvable;

Assigns private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-privateipaddresses

property secondaryPrivateIpAddressCount

readonly secondaryPrivateIpAddressCount?: number;

The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses .
You can't specify a count of private IPv4 addresses if you've specified one of the following: specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-secondaryprivateipaddresscount

property sourceDestCheck

readonly sourceDestCheck?: boolean | cdk.IResolvable;

Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true , source/destination checks are enabled; otherwise, they are disabled. The default value is true . You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-sourcedestcheck

property subnetId

readonly subnetId: string;

The ID of the subnet to associate with the network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-subnetid

property tags

readonly tags?: cdk.CfnTag[];

An arbitrary set of tags (key-value pairs) for this network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-tags

interface CfnNetworkPerformanceMetricSubscriptionProps

interface CfnNetworkPerformanceMetricSubscriptionProps {}

Properties for defining a CfnNetworkPerformanceMetricSubscription
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkperformancemetricsubscription.html

property destination

readonly destination: string;

The Region or Availability Zone that's the target for the subscription. For example, eu-west-1 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkperformancemetricsubscription.html#cfn-ec2-networkperformancemetricsubscription-destination

property metric

readonly metric: string;

The metric used for the subscription.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkperformancemetricsubscription.html#cfn-ec2-networkperformancemetricsubscription-metric

property source

readonly source: string;

The Region or Availability Zone that's the source for the subscription. For example, us-east-1 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkperformancemetricsubscription.html#cfn-ec2-networkperformancemetricsubscription-source

property statistic

readonly statistic: string;

The statistic used for the subscription.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkperformancemetricsubscription.html#cfn-ec2-networkperformancemetricsubscription-statistic

interface CfnPlacementGroupProps

interface CfnPlacementGroupProps {}

Properties for defining a CfnPlacementGroup
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html

property partitionCount

readonly partitionCount?: number;

The number of partitions. Valid only when *Strategy* is set to partition .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html#cfn-ec2-placementgroup-partitioncount

property spreadLevel

readonly spreadLevel?: string;

Determines how placement groups spread instances.
- Host – You can use host only with Outpost placement groups. - Rack – No usage restrictions.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html#cfn-ec2-placementgroup-spreadlevel

property strategy

readonly strategy?: string;

The placement strategy.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html#cfn-ec2-placementgroup-strategy

property tags

readonly tags?: cdk.CfnTag[];

The tags to apply to the new placement group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html#cfn-ec2-placementgroup-tags

interface CfnPrefixListProps

interface CfnPrefixListProps {}

Properties for defining a CfnPrefixList
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html

property addressFamily

readonly addressFamily: string;

The IP address type.
Valid Values: IPv4 | IPv6
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-addressfamily

property entries

readonly entries?:
    | Array<CfnPrefixList.EntryProperty | cdk.IResolvable>
    | cdk.IResolvable;

One or more entries for the prefix list.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-entries

property maxEntries

readonly maxEntries: number;

The maximum number of entries for the prefix list.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-maxentries

property prefixListName

readonly prefixListName: string;

A name for the prefix list.
Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-prefixlistname

property tags

readonly tags?: cdk.CfnTag[];

The tags for the prefix list.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-tags

interface CfnRouteProps

interface CfnRouteProps {}

Properties for defining a CfnRoute
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html

property carrierGatewayId

readonly carrierGatewayId?: string;

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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-carriergatewayid

property destinationCidrBlock

readonly destinationCidrBlock?: string;

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 to 100.68.0.0/18 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-destinationcidrblock

property destinationIpv6CidrBlock

readonly destinationIpv6CidrBlock?: string;

The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-destinationipv6cidrblock

property egressOnlyInternetGatewayId

readonly egressOnlyInternetGatewayId?: string;

[IPv6 traffic only] The ID of an egress-only internet gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-egressonlyinternetgatewayid

property gatewayId

readonly gatewayId?: string;

The ID of an internet gateway or virtual private gateway attached to your VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-gatewayid

property instanceId

readonly instanceId?: string;

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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-instanceid

property localGatewayId

readonly localGatewayId?: string;

The ID of the local gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-localgatewayid

property natGatewayId

readonly natGatewayId?: string;

[IPv4 traffic only] The ID of a NAT gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-natgatewayid

property networkInterfaceId

readonly networkInterfaceId?: string;

The ID of a network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-networkinterfaceid

property routeTableId

readonly routeTableId: string;

The ID of the route table for the route.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-routetableid

property transitGatewayId

readonly transitGatewayId?: string;

The ID of a transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-transitgatewayid

property vpcEndpointId

readonly vpcEndpointId?: string;

The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-vpcendpointid

property vpcPeeringConnectionId

readonly vpcPeeringConnectionId?: string;

The ID of a VPC peering connection.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-vpcpeeringconnectionid

interface CfnRouteTableProps

interface CfnRouteTableProps {}

Properties for defining a CfnRouteTable
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html

property tags

readonly tags?: cdk.CfnTag[];

Any tags assigned to the route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html#cfn-ec2-routetable-tags

property vpcId

readonly vpcId: string;

The ID of the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html#cfn-ec2-routetable-vpcid

interface CfnSecurityGroupEgressProps

interface CfnSecurityGroupEgressProps {}

Properties for defining a CfnSecurityGroupEgress
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html

property cidrIp

readonly cidrIp?: string;

The IPv4 address range, in CIDR format.
You must specify a destination security group ( DestinationPrefixListId or DestinationSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ).
For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-cidrip

property cidrIpv6

readonly cidrIpv6?: string;

The IPv6 address range, in CIDR format.
You must specify a destination security group ( DestinationPrefixListId or DestinationSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ).
For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-cidripv6

property description

readonly description?: string;

The description of an egress (outbound) security group rule.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-description

property destinationPrefixListId

readonly destinationPrefixListId?: string;

The prefix list IDs for an AWS service. This is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.
You must specify a destination security group ( DestinationPrefixListId or DestinationSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-destinationprefixlistid

property destinationSecurityGroupId

readonly destinationSecurityGroupId?: string;

The ID of the security group.
You must specify a destination security group ( DestinationPrefixListId or DestinationSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-destinationsecuritygroupid

property fromPort

readonly fromPort?: number;

If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-fromport

property groupId

readonly groupId: string;

The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-groupid

property ipProtocol

readonly ipProtocol: string;

The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) ).
Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-ipprotocol

property toPort

readonly toPort?: number;

If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-toport

interface CfnSecurityGroupIngressProps

interface CfnSecurityGroupIngressProps {}

Properties for defining a CfnSecurityGroupIngress
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html

property cidrIp

readonly cidrIp?: string;

The IPv4 address range, in CIDR format.
You must specify a source security group ( SourcePrefixListId or SourceSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ).
For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-cidrip

property cidrIpv6

readonly cidrIpv6?: string;

The IPv6 address range, in CIDR format.
You must specify a source security group ( SourcePrefixListId or SourceSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ).
For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-cidripv6

property description

readonly description?: string;

Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-description

property fromPort

readonly fromPort?: number;

The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
Use this for ICMP and any protocol that uses ports.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-fromport

property groupId

readonly groupId?: string;

The ID of the security group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-groupid

property groupName

readonly groupName?: string;

The name of the security group.
Constraints: Up to 255 characters in length. Cannot start with sg- .
Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-groupname

property ipProtocol

readonly ipProtocol: string;

The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) ).
Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-ipprotocol

property sourcePrefixListId

readonly sourcePrefixListId?: string;

The ID of a prefix list.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-securitygroupingress-sourceprefixlistid

property sourceSecurityGroupId

readonly sourceSecurityGroupId?: string;

The ID of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-sourcesecuritygroupid

property sourceSecurityGroupName

readonly sourceSecurityGroupName?: string;

[Default VPC] The name of the source security group. You must specify either the security group ID or the security group name. You can't specify the group name in combination with an IP address range. Creates rules that grant full ICMP, UDP, and TCP access.
For security groups in a nondefault VPC, you must specify the group ID.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-sourcesecuritygroupname

property sourceSecurityGroupOwnerId

readonly sourceSecurityGroupOwnerId?: string;

[nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account. You can't specify this property with an IP address range. Creates rules that grant full ICMP, UDP, and TCP access.
If you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify SourceSecurityGroupOwnerId ; otherwise, this property is optional.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-sourcesecuritygroupownerid

property toPort

readonly toPort?: number;

The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.
Use this for ICMP and any protocol that uses ports.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-toport

interface CfnSecurityGroupProps

interface CfnSecurityGroupProps {}

Properties for defining a CfnSecurityGroup
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html

property groupDescription

readonly groupDescription: string;

A description for the security group.
Constraints: Up to 255 characters in length
Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-groupdescription

property groupName

readonly groupName?: string;

The name of the security group.
Constraints: Up to 255 characters in length. Cannot start with sg- .
Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-groupname

property securityGroupEgress

readonly securityGroupEgress?:
    | Array<CfnSecurityGroup.EgressProperty | cdk.IResolvable>
    | cdk.IResolvable;

The outbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-securitygroupegress

property securityGroupIngress

readonly securityGroupIngress?:
    | Array<CfnSecurityGroup.IngressProperty | cdk.IResolvable>
    | cdk.IResolvable;

The inbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-securitygroupingress

property tags

readonly tags?: cdk.CfnTag[];

Any tags assigned to the security group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-tags

property vpcId

readonly vpcId?: string;

The ID of the VPC for the security group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-vpcid

interface CfnSpotFleetProps

interface CfnSpotFleetProps {}

Properties for defining a CfnSpotFleet
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-spotfleet.html

property spotFleetRequestConfigData

readonly spotFleetRequestConfigData:
    | CfnSpotFleet.SpotFleetRequestConfigDataProperty
    | cdk.IResolvable;

Describes the configuration of a Spot Fleet request.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-spotfleet.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata

interface CfnSubnetCidrBlockProps

interface CfnSubnetCidrBlockProps {}

Properties for defining a CfnSubnetCidrBlock
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html

property ipv6CidrBlock

readonly ipv6CidrBlock: string;

The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length.
This parameter is required for an IPv6 only subnet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-ipv6cidrblock

property subnetId

readonly subnetId: string;

The ID of the subnet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-subnetid

interface CfnSubnetNetworkAclAssociationProps

interface CfnSubnetNetworkAclAssociationProps {}

Properties for defining a CfnSubnetNetworkAclAssociation
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet-network-acl-assoc.html

property networkAclId

readonly networkAclId: string;

The ID of the network ACL.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet-network-acl-assoc.html#cfn-ec2-subnetnetworkaclassociation-networkaclid

property subnetId

readonly subnetId: string;

The ID of the subnet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet-network-acl-assoc.html#cfn-ec2-subnetnetworkaclassociation-associationid

interface CfnSubnetProps

interface CfnSubnetProps {}

Properties for defining a CfnSubnet
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html

property assignIpv6AddressOnCreation

readonly assignIpv6AddressOnCreation?: boolean | cdk.IResolvable;

Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is false .
If you specify AssignIpv6AddressOnCreation , you must also specify Ipv6CidrBlock .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-assignipv6addressoncreation

property availabilityZone

readonly availabilityZone?: string;

The Availability Zone of the subnet.
If you update this property, you must also update the CidrBlock property.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-availabilityzone

property availabilityZoneId

readonly availabilityZoneId?: string;

The AZ ID of the subnet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-availabilityzoneid

property cidrBlock

readonly cidrBlock?: string;

The IPv4 CIDR block assigned to the subnet.
If you update this property, we create a new subnet, and then delete the existing one.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-cidrblock

property enableDns64

readonly enableDns64?: boolean | cdk.IResolvable;

Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. For more information, see [DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-nat64-dns64) in the *Amazon Virtual Private Cloud User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-enabledns64

property ipv6CidrBlock

readonly ipv6CidrBlock?: string;

The IPv6 CIDR block.
If you specify AssignIpv6AddressOnCreation , you must also specify Ipv6CidrBlock .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv6cidrblock

property ipv6Native

readonly ipv6Native?: boolean | cdk.IResolvable;

Indicates whether this is an IPv6 only subnet. For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *Amazon Virtual Private Cloud User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv6native

property mapPublicIpOnLaunch

readonly mapPublicIpOnLaunch?: boolean | cdk.IResolvable;

Indicates whether instances launched in this subnet receive a public IPv4 address. The default value is false .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-mappubliciponlaunch

property outpostArn

readonly outpostArn?: string;

The Amazon Resource Name (ARN) of the Outpost.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-outpostarn

property privateDnsNameOptionsOnLaunch

readonly privateDnsNameOptionsOnLaunch?: any | cdk.IResolvable;

The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide* .
Available options:
- EnableResourceNameDnsAAAARecord (true | false) - EnableResourceNameDnsARecord (true | false) - HostnameType (ip-name | resource-name)
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-privatednsnameoptionsonlaunch

property tags

readonly tags?: cdk.CfnTag[];

Any tags assigned to the subnet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-tags

property vpcId

readonly vpcId: string;

The ID of the VPC the subnet is in.
If you update this property, you must also update the CidrBlock property.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-vpcid

interface CfnSubnetRouteTableAssociationProps

interface CfnSubnetRouteTableAssociationProps {}

Properties for defining a CfnSubnetRouteTableAssociation
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetroutetableassociation.html

property routeTableId

readonly routeTableId: string;

The ID of the route table.
The physical ID changes when the route table ID is changed.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetroutetableassociation.html#cfn-ec2-subnetroutetableassociation-routetableid

property subnetId

readonly subnetId: string;

The ID of the subnet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetroutetableassociation.html#cfn-ec2-subnetroutetableassociation-subnetid

interface CfnTrafficMirrorFilterProps

interface CfnTrafficMirrorFilterProps {}

Properties for defining a CfnTrafficMirrorFilter
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html

property description

readonly description?: string;

The description of the Traffic Mirror filter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html#cfn-ec2-trafficmirrorfilter-description

property networkServices

readonly networkServices?: string[];

The network service traffic that is associated with the Traffic Mirror filter.
Valid values are amazon-dns .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html#cfn-ec2-trafficmirrorfilter-networkservices

property tags

readonly tags?: cdk.CfnTag[];

The tags to assign to a Traffic Mirror filter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html#cfn-ec2-trafficmirrorfilter-tags

interface CfnTrafficMirrorFilterRuleProps

interface CfnTrafficMirrorFilterRuleProps {}

Properties for defining a CfnTrafficMirrorFilterRule
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html

property description

readonly description?: string;

The description of the Traffic Mirror rule.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-description

property destinationCidrBlock

readonly destinationCidrBlock: string;

The destination CIDR block to assign to the Traffic Mirror rule.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-destinationcidrblock

property destinationPortRange

readonly destinationPortRange?:
    | CfnTrafficMirrorFilterRule.TrafficMirrorPortRangeProperty
    | cdk.IResolvable;

The destination port range.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-destinationportrange

property protocol

readonly protocol?: number;

The protocol, for example UDP, to assign to the Traffic Mirror rule.
For information about the protocol value, see [Protocol Numbers](https://docs.aws.amazon.com/https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) on the Internet Assigned Numbers Authority (IANA) website.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-protocol

property ruleAction

readonly ruleAction: string;

The action to take on the filtered traffic.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-ruleaction

property ruleNumber

readonly ruleNumber: number;

The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-rulenumber

property sourceCidrBlock

readonly sourceCidrBlock: string;

The source CIDR block to assign to the Traffic Mirror rule.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-sourcecidrblock

property sourcePortRange

readonly sourcePortRange?:
    | CfnTrafficMirrorFilterRule.TrafficMirrorPortRangeProperty
    | cdk.IResolvable;

The source port range.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-sourceportrange

property trafficDirection

readonly trafficDirection: string;

The type of traffic.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-trafficdirection

property trafficMirrorFilterId

readonly trafficMirrorFilterId: string;

The ID of the filter that this rule is associated with.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-trafficmirrorfilterid

interface CfnTrafficMirrorSessionProps

interface CfnTrafficMirrorSessionProps {}

Properties for defining a CfnTrafficMirrorSession
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html

property description

readonly description?: string;

The description of the Traffic Mirror session.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-description

property networkInterfaceId

readonly networkInterfaceId: string;

The ID of the source network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-networkinterfaceid

property packetLength

readonly packetLength?: number;

The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do not specify this parameter when you want to mirror the entire packet. To mirror a subset of the packet, set this to the length (in bytes) that you want to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target.
If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-packetlength

property sessionNumber

readonly sessionNumber: number;

The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-sessionnumber

property tags

readonly tags?: cdk.CfnTag[];

The tags to assign to a Traffic Mirror session.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-tags

property trafficMirrorFilterId

readonly trafficMirrorFilterId: string;

The ID of the Traffic Mirror filter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-trafficmirrorfilterid

property trafficMirrorTargetId

readonly trafficMirrorTargetId: string;

The ID of the Traffic Mirror target.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-trafficmirrortargetid

property virtualNetworkId

readonly virtualNetworkId?: number;

The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN protocol, see [RFC 7348](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc7348) . If you do not specify a VirtualNetworkId , an account-wide unique id is chosen at random.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-virtualnetworkid

interface CfnTrafficMirrorTargetProps

interface CfnTrafficMirrorTargetProps {}

Properties for defining a CfnTrafficMirrorTarget
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html

property description

readonly description?: string;

The description of the Traffic Mirror target.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-description

property gatewayLoadBalancerEndpointId

readonly gatewayLoadBalancerEndpointId?: string;

The ID of the Gateway Load Balancer endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-gatewayloadbalancerendpointid

property networkInterfaceId

readonly networkInterfaceId?: string;

The network interface ID that is associated with the target.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-networkinterfaceid

property networkLoadBalancerArn

readonly networkLoadBalancerArn?: string;

The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-networkloadbalancerarn

property tags

readonly tags?: cdk.CfnTag[];

The tags to assign to the Traffic Mirror target.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-tags

interface CfnTransitGatewayAttachmentProps

interface CfnTransitGatewayAttachmentProps {}

Properties for defining a CfnTransitGatewayAttachment
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html

property options

readonly options?: any | cdk.IResolvable;

The VPC attachment options, in JSON or YAML.
- ApplianceModeSupport - Set to enable or disable . The default is disable . - DnsSupport - Set to enable or disable . The default is enable . - Ipv6Support - Set to enable or disable . The default is disable .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#cfn-ec2-transitgatewayattachment-options

property subnetIds

readonly subnetIds: string[];

The IDs of one or more subnets. You can specify only one subnet per Availability Zone. You must specify at least one subnet, but we recommend that you specify two subnets for better availability. The transit gateway uses one IP address from each specified subnet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#cfn-ec2-transitgatewayattachment-subnetids

property tags

readonly tags?: cdk.CfnTag[];

The tags for the attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#cfn-ec2-transitgatewayattachment-tags

property transitGatewayId

readonly transitGatewayId: string;

The ID of the transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#cfn-ec2-transitgatewayattachment-transitgatewayid

property vpcId

readonly vpcId: string;

The ID of the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#cfn-ec2-transitgatewayattachment-vpcid

interface CfnTransitGatewayConnectProps

interface CfnTransitGatewayConnectProps {}

Properties for defining a CfnTransitGatewayConnect
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnect.html

property options

readonly options:
    | CfnTransitGatewayConnect.TransitGatewayConnectOptionsProperty
    | cdk.IResolvable;

The Connect attachment options.
- protocol (gre)
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnect.html#cfn-ec2-transitgatewayconnect-options

property tags

readonly tags?: cdk.CfnTag[];

The tags for the attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnect.html#cfn-ec2-transitgatewayconnect-tags

property transportTransitGatewayAttachmentId

readonly transportTransitGatewayAttachmentId: string;

The ID of the attachment from which the Connect attachment was created.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnect.html#cfn-ec2-transitgatewayconnect-transporttransitgatewayattachmentid

interface CfnTransitGatewayMulticastDomainAssociationProps

interface CfnTransitGatewayMulticastDomainAssociationProps {}

Properties for defining a CfnTransitGatewayMulticastDomainAssociation
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomainassociation.html

property subnetId

readonly subnetId: string;

The IDs of the subnets to associate with the transit gateway multicast domain.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomainassociation.html#cfn-ec2-transitgatewaymulticastdomainassociation-subnetid

property transitGatewayAttachmentId

readonly transitGatewayAttachmentId: string;

The ID of the transit gateway attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomainassociation.html#cfn-ec2-transitgatewaymulticastdomainassociation-transitgatewayattachmentid

property transitGatewayMulticastDomainId

readonly transitGatewayMulticastDomainId: string;

The ID of the transit gateway multicast domain.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomainassociation.html#cfn-ec2-transitgatewaymulticastdomainassociation-transitgatewaymulticastdomainid

interface CfnTransitGatewayMulticastDomainProps

interface CfnTransitGatewayMulticastDomainProps {}

Properties for defining a CfnTransitGatewayMulticastDomain
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomain.html

property options

readonly options?: any | cdk.IResolvable;

The options for the transit gateway multicast domain.
- AutoAcceptSharedAssociations (enable | disable) - Igmpv2Support (enable | disable) - StaticSourcesSupport (enable | disable)
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomain.html#cfn-ec2-transitgatewaymulticastdomain-options

property tags

readonly tags?: cdk.CfnTag[];

The tags for the transit gateway multicast domain.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomain.html#cfn-ec2-transitgatewaymulticastdomain-tags

property transitGatewayId

readonly transitGatewayId: string;

The ID of the transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomain.html#cfn-ec2-transitgatewaymulticastdomain-transitgatewayid

interface CfnTransitGatewayMulticastGroupMemberProps

interface CfnTransitGatewayMulticastGroupMemberProps {}

Properties for defining a CfnTransitGatewayMulticastGroupMember
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupmember.html

property groupIpAddress

readonly groupIpAddress: string;

The IP address assigned to the transit gateway multicast group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupmember.html#cfn-ec2-transitgatewaymulticastgroupmember-groupipaddress

property networkInterfaceId

readonly networkInterfaceId: string;

The group members' network interface IDs to register with the transit gateway multicast group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupmember.html#cfn-ec2-transitgatewaymulticastgroupmember-networkinterfaceid

property transitGatewayMulticastDomainId

readonly transitGatewayMulticastDomainId: string;

The ID of the transit gateway multicast domain.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupmember.html#cfn-ec2-transitgatewaymulticastgroupmember-transitgatewaymulticastdomainid

interface CfnTransitGatewayMulticastGroupSourceProps

interface CfnTransitGatewayMulticastGroupSourceProps {}

Properties for defining a CfnTransitGatewayMulticastGroupSource
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupsource.html

property groupIpAddress

readonly groupIpAddress: string;

The IP address assigned to the transit gateway multicast group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupsource.html#cfn-ec2-transitgatewaymulticastgroupsource-groupipaddress

property networkInterfaceId

readonly networkInterfaceId: string;

The group sources' network interface IDs to register with the transit gateway multicast group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupsource.html#cfn-ec2-transitgatewaymulticastgroupsource-networkinterfaceid

property transitGatewayMulticastDomainId

readonly transitGatewayMulticastDomainId: string;

The ID of the transit gateway multicast domain.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupsource.html#cfn-ec2-transitgatewaymulticastgroupsource-transitgatewaymulticastdomainid

interface CfnTransitGatewayPeeringAttachmentProps

interface CfnTransitGatewayPeeringAttachmentProps {}

Properties for defining a CfnTransitGatewayPeeringAttachment
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html

property peerAccountId

readonly peerAccountId: string;

The ID of the AWS account that owns the transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#cfn-ec2-transitgatewaypeeringattachment-peeraccountid

property peerRegion

readonly peerRegion: string;

The Region of the transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#cfn-ec2-transitgatewaypeeringattachment-peerregion

property peerTransitGatewayId

readonly peerTransitGatewayId: string;

The ID of the transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#cfn-ec2-transitgatewaypeeringattachment-peertransitgatewayid

property tags

readonly tags?: cdk.CfnTag[];

The tags for the transit gateway peering attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#cfn-ec2-transitgatewaypeeringattachment-tags

property transitGatewayId

readonly transitGatewayId: string;

The ID of the transit gateway peering attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#cfn-ec2-transitgatewaypeeringattachment-transitgatewayid

interface CfnTransitGatewayProps

interface CfnTransitGatewayProps {}

Properties for defining a CfnTransitGateway
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html

property amazonSideAsn

readonly amazonSideAsn?: number;

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs. The default is 64512.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-amazonsideasn

property associationDefaultRouteTableId

readonly associationDefaultRouteTableId?: string;

The ID of the default association route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-associationdefaultroutetableid

property autoAcceptSharedAttachments

readonly autoAcceptSharedAttachments?: string;

Enable or disable automatic acceptance of attachment requests. Disabled by default.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-autoacceptsharedattachments

property defaultRouteTableAssociation

readonly defaultRouteTableAssociation?: string;

Enable or disable automatic association with the default association route table. Enabled by default.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-defaultroutetableassociation

property defaultRouteTablePropagation

readonly defaultRouteTablePropagation?: string;

Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-defaultroutetablepropagation

property description

readonly description?: string;

The description of the transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-description

property dnsSupport

readonly dnsSupport?: string;

Enable or disable DNS support. Enabled by default.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-dnssupport

property multicastSupport

readonly multicastSupport?: string;

Indicates whether multicast is enabled on the transit gateway
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-multicastsupport

property propagationDefaultRouteTableId

readonly propagationDefaultRouteTableId?: string;

The ID of the default propagation route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-propagationdefaultroutetableid

property tags

readonly tags?: cdk.CfnTag[];

The tags for the transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-tags

property transitGatewayCidrBlocks

readonly transitGatewayCidrBlocks?: string[];

The transit gateway CIDR blocks.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-transitgatewaycidrblocks

property vpnEcmpSupport

readonly vpnEcmpSupport?: string;

Enable or disable Equal Cost Multipath Protocol support. Enabled by default.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-vpnecmpsupport

interface CfnTransitGatewayRouteProps

interface CfnTransitGatewayRouteProps {}

Properties for defining a CfnTransitGatewayRoute
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html

property blackhole

readonly blackhole?: boolean | cdk.IResolvable;

Indicates whether to drop traffic that matches this route.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html#cfn-ec2-transitgatewayroute-blackhole

property destinationCidrBlock

readonly destinationCidrBlock?: string;

The CIDR block used for destination matches.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html#cfn-ec2-transitgatewayroute-destinationcidrblock

property transitGatewayAttachmentId

readonly transitGatewayAttachmentId?: string;

The ID of the attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html#cfn-ec2-transitgatewayroute-transitgatewayattachmentid

property transitGatewayRouteTableId

readonly transitGatewayRouteTableId: string;

The ID of the transit gateway route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html#cfn-ec2-transitgatewayroute-transitgatewayroutetableid

interface CfnTransitGatewayRouteTableAssociationProps

interface CfnTransitGatewayRouteTableAssociationProps {}

Properties for defining a CfnTransitGatewayRouteTableAssociation
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetableassociation.html

property transitGatewayAttachmentId

readonly transitGatewayAttachmentId: string;

The ID of the attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetableassociation.html#cfn-ec2-transitgatewayroutetableassociation-transitgatewayattachmentid

property transitGatewayRouteTableId

readonly transitGatewayRouteTableId: string;

The ID of the route table for the transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetableassociation.html#cfn-ec2-transitgatewayroutetableassociation-transitgatewayroutetableid

interface CfnTransitGatewayRouteTablePropagationProps

interface CfnTransitGatewayRouteTablePropagationProps {}

Properties for defining a CfnTransitGatewayRouteTablePropagation
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetablepropagation.html

property transitGatewayAttachmentId

readonly transitGatewayAttachmentId: string;

The ID of the attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetablepropagation.html#cfn-ec2-transitgatewayroutetablepropagation-transitgatewayattachmentid

property transitGatewayRouteTableId

readonly transitGatewayRouteTableId: string;

The ID of the propagation route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetablepropagation.html#cfn-ec2-transitgatewayroutetablepropagation-transitgatewayroutetableid

interface CfnTransitGatewayRouteTableProps

interface CfnTransitGatewayRouteTableProps {}

Properties for defining a CfnTransitGatewayRouteTable
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetable.html

property tags

readonly tags?: cdk.CfnTag[];

Any tags assigned to the route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetable.html#cfn-ec2-transitgatewayroutetable-tags

property transitGatewayId

readonly transitGatewayId: string;

The ID of the transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetable.html#cfn-ec2-transitgatewayroutetable-transitgatewayid

interface CfnTransitGatewayVpcAttachmentProps

interface CfnTransitGatewayVpcAttachmentProps {}

Properties for defining a CfnTransitGatewayVpcAttachment
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html

property addSubnetIds

readonly addSubnetIds?: string[];

The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-addsubnetids

property options

readonly options?: any | cdk.IResolvable;

The VPC attachment options, in JSON or YAML.
- ApplianceModeSupport - Set to enable or disable . The default is disable . - DnsSupport - Set to enable or disable . The default is enable . - Ipv6Support - Set to enable or disable . The default is disable .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-options

property removeSubnetIds

readonly removeSubnetIds?: string[];

The IDs of one or more subnets to remove.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-removesubnetids

property subnetIds

readonly subnetIds: string[];

The IDs of the subnets.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-subnetids

property tags

readonly tags?: cdk.CfnTag[];

The tags for the VPC attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-tags

property transitGatewayId

readonly transitGatewayId: string;

The ID of the transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-transitgatewayid

property vpcId

readonly vpcId: string;

The ID of the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-vpcid

interface CfnVerifiedAccessEndpointProps

interface CfnVerifiedAccessEndpointProps {}

Properties for defining a CfnVerifiedAccessEndpoint
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html

property applicationDomain

readonly applicationDomain: string;

The DNS name for users to reach your application.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-applicationdomain

property attachmentType

readonly attachmentType: string;

The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-attachmenttype

property description

readonly description?: string;

A description for the AWS Verified Access endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-description

property domainCertificateArn

readonly domainCertificateArn: string;

The ARN of a public TLS/SSL certificate imported into or created with ACM.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-domaincertificatearn

property endpointDomainPrefix

readonly endpointDomainPrefix: string;

A custom identifier that is prepended to the DNS name that is generated for the endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-endpointdomainprefix

property endpointType

readonly endpointType: string;

The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-endpointtype

property loadBalancerOptions

readonly loadBalancerOptions?:
    | CfnVerifiedAccessEndpoint.LoadBalancerOptionsProperty
    | cdk.IResolvable;

The load balancer details if creating the AWS Verified Access endpoint as load-balancer type.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-loadbalanceroptions

property networkInterfaceOptions

readonly networkInterfaceOptions?:
    | CfnVerifiedAccessEndpoint.NetworkInterfaceOptionsProperty
    | cdk.IResolvable;

The options for network-interface type endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-networkinterfaceoptions

property policyDocument

readonly policyDocument?: string;

The Verified Access policy document.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-policydocument

property policyEnabled

readonly policyEnabled?: boolean | cdk.IResolvable;

The status of the Verified Access policy.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-policyenabled

property securityGroupIds

readonly securityGroupIds?: string[];

The IDs of the security groups for the endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-securitygroupids

property tags

readonly tags?: cdk.CfnTag[];

The tags.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-tags

property verifiedAccessGroupId

readonly verifiedAccessGroupId: string;

The ID of the AWS Verified Access group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-verifiedaccessgroupid

interface CfnVerifiedAccessGroupProps

interface CfnVerifiedAccessGroupProps {}

Properties for defining a CfnVerifiedAccessGroup
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html

property description

readonly description?: string;

A description for the AWS Verified Access group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#cfn-ec2-verifiedaccessgroup-description

property policyDocument

readonly policyDocument?: string;

The Verified Access policy document.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#cfn-ec2-verifiedaccessgroup-policydocument

property policyEnabled

readonly policyEnabled?: boolean | cdk.IResolvable;

The status of the Verified Access policy.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#cfn-ec2-verifiedaccessgroup-policyenabled

property tags

readonly tags?: cdk.CfnTag[];

The tags.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#cfn-ec2-verifiedaccessgroup-tags

property verifiedAccessInstanceId

readonly verifiedAccessInstanceId: string;

The ID of the AWS Verified Access instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#cfn-ec2-verifiedaccessgroup-verifiedaccessinstanceid

interface CfnVerifiedAccessInstanceProps

interface CfnVerifiedAccessInstanceProps {}

Properties for defining a CfnVerifiedAccessInstance
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html

property description

readonly description?: string;

A description for the AWS Verified Access instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#cfn-ec2-verifiedaccessinstance-description

property loggingConfigurations

readonly loggingConfigurations?:
    | CfnVerifiedAccessInstance.VerifiedAccessLogsProperty
    | cdk.IResolvable;

The current logging configuration for the Verified Access instances.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#cfn-ec2-verifiedaccessinstance-loggingconfigurations

property tags

readonly tags?: cdk.CfnTag[];

The tags.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#cfn-ec2-verifiedaccessinstance-tags

property verifiedAccessTrustProviderIds

readonly verifiedAccessTrustProviderIds?: string[];

The IDs of the AWS Verified Access trust providers.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#cfn-ec2-verifiedaccessinstance-verifiedaccesstrustproviderids

property verifiedAccessTrustProviders

readonly verifiedAccessTrustProviders?:
    | Array<
          | CfnVerifiedAccessInstance.VerifiedAccessTrustProviderProperty
          | cdk.IResolvable
      >
    | cdk.IResolvable;

The IDs of the AWS Verified Access trust providers.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#cfn-ec2-verifiedaccessinstance-verifiedaccesstrustproviders

interface CfnVerifiedAccessTrustProviderProps

interface CfnVerifiedAccessTrustProviderProps {}

Properties for defining a CfnVerifiedAccessTrustProvider
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html

property description

readonly description?: string;

A description for the AWS Verified Access trust provider.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-description

property deviceOptions

readonly deviceOptions?:
    | CfnVerifiedAccessTrustProvider.DeviceOptionsProperty
    | cdk.IResolvable;

The options for device-identity trust provider.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-deviceoptions

property deviceTrustProviderType

readonly deviceTrustProviderType?: string;

The type of device-based trust provider.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-devicetrustprovidertype

property oidcOptions

readonly oidcOptions?:
    | CfnVerifiedAccessTrustProvider.OidcOptionsProperty
    | cdk.IResolvable;

The options for an OpenID Connect-compatible user-identity trust provider.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions

property policyReferenceName

readonly policyReferenceName: string;

The identifier to be used when working with policy rules.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-policyreferencename

property tags

readonly tags?: cdk.CfnTag[];

The tags.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-tags

property trustProviderType

readonly trustProviderType: string;

The type of Verified Access trust provider.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-trustprovidertype

property userTrustProviderType

readonly userTrustProviderType?: string;

The type of user-based trust provider.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-usertrustprovidertype

interface CfnVolumeAttachmentProps

interface CfnVolumeAttachmentProps {}

Properties for defining a CfnVolumeAttachment
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volumeattachment.html

property device

readonly device: string;

The device name (for example, /dev/sdh or xvdh ).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volumeattachment.html#cfn-ec2-ebs-volumeattachment-device

property instanceId

readonly instanceId: string;

The ID of the instance to which the volume attaches. This value can be a reference to an [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource, or it can be the physical ID of an existing EC2 instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volumeattachment.html#cfn-ec2-ebs-volumeattachment-instanceid

property volumeId

readonly volumeId: string;

The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone. This value can be a reference to an [AWS::EC2::Volume](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html) resource, or it can be the volume ID of an existing Amazon EBS volume.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volumeattachment.html#cfn-ec2-ebs-volumeattachment-volumeid

interface CfnVolumeProps

interface CfnVolumeProps {}

Properties for defining a CfnVolume
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html

property autoEnableIo

readonly autoEnableIo?: boolean | cdk.IResolvable;

Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-autoenableio

property availabilityZone

readonly availabilityZone: string;

The ID of the Availability Zone in which to create the volume. For example, us-east-1a .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-availabilityzone

property encrypted

readonly encrypted?: boolean | cdk.IResolvable;

Indicates whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) in the *Amazon Elastic Compute Cloud User Guide* .
Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-encrypted

property iops

readonly iops?: number;

The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
- gp3 : 3,000-16,000 IOPS - io1 : 100-64,000 IOPS - io2 : 100-64,000 IOPS
io1 and io2 volumes support up to 64,000 IOPS only on [Instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) . Other instance families support performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-iops

property kmsKeyId

readonly kmsKeyId?: string;

The identifier of the AWS KMS key to use for Amazon EBS encryption. If KmsKeyId is specified, the encrypted state must be true .
If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to true , then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the AWS managed key .
Alternatively, if you want to specify a different key, you can specify one of the following:
- Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. - Key alias. Specify the alias for the key, prefixed with alias/ . For example, for a key with the alias my_cmk , use alias/my_cmk . Or to specify the AWS managed key , use alias/aws/ebs . - Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. - Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-kmskeyid

property multiAttachEnabled

readonly multiAttachEnabled?: boolean | cdk.IResolvable;

Indicates whether Amazon EBS Multi-Attach is enabled.
AWS CloudFormation does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-multiattachenabled

property outpostArn

readonly outpostArn?: string;

The Amazon Resource Name (ARN) of the Outpost.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-outpostarn

property size

readonly size?: number;

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
- gp2 and gp3 : 1-16,384 - io1 and io2 : 4-16,384 - st1 and sc1 : 125-16,384 - standard : 1-1,024
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-size

property snapshotId

readonly snapshotId?: string;

The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-snapshotid

property tags

readonly tags?: cdk.CfnTag[];

The tags to apply to the volume during creation.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-tags

property throughput

readonly throughput?: number;

The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
This parameter is valid only for gp3 volumes. The default value is 125.
Valid Range: Minimum value of 125. Maximum value of 1000.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-throughput

property volumeType

readonly volumeType?: string;

The volume type. This parameter can be one of the following values:
- General Purpose SSD: gp2 | gp3 - Provisioned IOPS SSD: io1 | io2 - Throughput Optimized HDD: st1 - Cold HDD: sc1 - Magnetic: standard
For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide* .
Default: gp2
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-volumetype

interface CfnVPCCidrBlockProps

interface CfnVPCCidrBlockProps {}

Properties for defining a CfnVPCCidrBlock
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html

property amazonProvidedIpv6CidrBlock

readonly amazonProvidedIpv6CidrBlock?: boolean | cdk.IResolvable;

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-amazonprovidedipv6cidrblock

property cidrBlock

readonly cidrBlock?: string;

An IPv4 CIDR block to associate with the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-cidrblock

property ipv4IpamPoolId

readonly ipv4IpamPoolId?: string;

Associate a CIDR allocated from an IPv4 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv4ipampoolid

property ipv4NetmaskLength

readonly ipv4NetmaskLength?: number;

The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv4netmasklength

property ipv6CidrBlock

readonly ipv6CidrBlock?: string;

An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv6cidrblock

property ipv6IpamPoolId

readonly ipv6IpamPoolId?: string;

Associates a CIDR allocated from an IPv6 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv6ipampoolid

property ipv6NetmaskLength

readonly ipv6NetmaskLength?: number;

The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv6netmasklength

property ipv6Pool

readonly ipv6Pool?: string;

The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv6pool

property vpcId

readonly vpcId: string;

The ID of the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-vpcid

interface CfnVPCDHCPOptionsAssociationProps

interface CfnVPCDHCPOptionsAssociationProps {}

Properties for defining a CfnVPCDHCPOptionsAssociation
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcdhcpoptionsassociation.html

property dhcpOptionsId

readonly dhcpOptionsId: string;

The ID of the DHCP options set, or default to associate no DHCP options with the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcdhcpoptionsassociation.html#cfn-ec2-vpcdhcpoptionsassociation-dhcpoptionsid

property vpcId

readonly vpcId: string;

The ID of the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcdhcpoptionsassociation.html#cfn-ec2-vpcdhcpoptionsassociation-vpcid

interface CfnVPCEndpointConnectionNotificationProps

interface CfnVPCEndpointConnectionNotificationProps {}

Properties for defining a CfnVPCEndpointConnectionNotification
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html

property connectionEvents

readonly connectionEvents: string[];

The endpoint events for which to receive notifications. Valid values are Accept , Connect , Delete , and Reject .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#cfn-ec2-vpcendpointconnectionnotification-connectionevents

property connectionNotificationArn

readonly connectionNotificationArn: string;

The ARN of the SNS topic for the notifications.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#cfn-ec2-vpcendpointconnectionnotification-connectionnotificationarn

property serviceId

readonly serviceId?: string;

The ID of the endpoint service.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#cfn-ec2-vpcendpointconnectionnotification-serviceid

property vpcEndpointId

readonly vpcEndpointId?: string;

The ID of the endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#cfn-ec2-vpcendpointconnectionnotification-vpcendpointid

interface CfnVPCEndpointProps

interface CfnVPCEndpointProps {}

Properties for defining a CfnVPCEndpoint
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html

property policyDocument

readonly policyDocument?: any | cdk.IResolvable;

An endpoint policy, which controls access to the service from the VPC. The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints.
For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-policydocument

property privateDnsEnabled

readonly privateDnsEnabled?: boolean | cdk.IResolvable;

Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com ), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to true : enableDnsHostnames and enableDnsSupport .
This property is supported only for interface endpoints.
Default: false
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-privatednsenabled

property routeTableIds

readonly routeTableIds?: string[];

The IDs of the route tables. Routing is supported only for gateway endpoints.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-routetableids

property securityGroupIds

readonly securityGroupIds?: string[];

The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-securitygroupids

property serviceName

readonly serviceName: string;

The name of the endpoint service.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-servicename

property subnetIds

readonly subnetIds?: string[];

The IDs of the subnets in which to create endpoint network interfaces. You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-subnetids

property vpcEndpointType

readonly vpcEndpointType?: string;

The type of endpoint.
Default: Gateway
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-vpcendpointtype

property vpcId

readonly vpcId: string;

The ID of the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-vpcid

interface CfnVPCEndpointServicePermissionsProps

interface CfnVPCEndpointServicePermissionsProps {}

Properties for defining a CfnVPCEndpointServicePermissions
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservicepermissions.html

property allowedPrincipals

readonly allowedPrincipals?: string[];

The Amazon Resource Names (ARN) of one or more principals (for example, users, IAM roles, and AWS accounts ). Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*). Permissions are revoked for principals not in this list. If the list is empty, then all permissions are revoked.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservicepermissions.html#cfn-ec2-vpcendpointservicepermissions-allowedprincipals

property serviceId

readonly serviceId: string;

The ID of the service.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservicepermissions.html#cfn-ec2-vpcendpointservicepermissions-serviceid

interface CfnVPCEndpointServiceProps

interface CfnVPCEndpointServiceProps {}

Properties for defining a CfnVPCEndpointService
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html

property acceptanceRequired

readonly acceptanceRequired?: boolean | cdk.IResolvable;

Indicates whether requests from service consumers to create an endpoint to your service must be accepted.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-acceptancerequired

property contributorInsightsEnabled

readonly contributorInsightsEnabled?: boolean | cdk.IResolvable;

Indicates whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-contributorinsightsenabled

property gatewayLoadBalancerArns

readonly gatewayLoadBalancerArns?: string[];

The Amazon Resource Names (ARNs) of the Gateway Load Balancers.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-gatewayloadbalancerarns

property networkLoadBalancerArns

readonly networkLoadBalancerArns?: string[];

The Amazon Resource Names (ARNs) of the Network Load Balancers.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-networkloadbalancerarns

property payerResponsibility

readonly payerResponsibility?: string;

The entity that is responsible for the endpoint costs. The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-payerresponsibility

interface CfnVPCGatewayAttachmentProps

interface CfnVPCGatewayAttachmentProps {}

Properties for defining a CfnVPCGatewayAttachment
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html

property internetGatewayId

readonly internetGatewayId?: string;

The ID of the internet gateway.
You must specify either InternetGatewayId or VpnGatewayId , but not both.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html#cfn-ec2-vpcgatewayattachment-internetgatewayid

property vpcId

readonly vpcId: string;

The ID of the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html#cfn-ec2-vpcgatewayattachment-vpcid

property vpnGatewayId

readonly vpnGatewayId?: string;

The ID of the virtual private gateway.
You must specify either InternetGatewayId or VpnGatewayId , but not both.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html#cfn-ec2-vpcgatewayattachment-vpngatewayid

interface CfnVPCPeeringConnectionProps

interface CfnVPCPeeringConnectionProps {}

Properties for defining a CfnVPCPeeringConnection
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html

property peerOwnerId

readonly peerOwnerId?: string;

The AWS account ID of the owner of the accepter VPC.
Default: Your AWS account ID
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peerownerid

property peerRegion

readonly peerRegion?: string;

The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
Default: The Region in which you make the request.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peerregion

property peerRoleArn

readonly peerRoleArn?: string;

The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.
This is required when you are peering a VPC in a different AWS account.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peerrolearn

property peerVpcId

readonly peerVpcId: string;

The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peervpcid

property tags

readonly tags?: cdk.CfnTag[];

Any tags assigned to the resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-tags

property vpcId

readonly vpcId: string;

The ID of the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-vpcid

interface CfnVPCProps

interface CfnVPCProps {}

Properties for defining a CfnVPC
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html

property cidrBlock

readonly cidrBlock?: string;

The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16 . We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18 , we modify it to 100.68.0.0/18 .
You must specify either CidrBlock or Ipv4IpamPoolId .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-cidrblock

property enableDnsHostnames

readonly enableDnsHostnames?: boolean | cdk.IResolvable;

Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support) .
You can only enable DNS hostnames if you've enabled DNS support.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-enablednshostnames

property enableDnsSupport

readonly enableDnsSupport?: boolean | cdk.IResolvable;

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-enablednssupport

property instanceTenancy

readonly instanceTenancy?: string;

The allowed tenancy of instances launched into the VPC.
- default : An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch. - dedicated : An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of host during instance launch. You cannot specify a tenancy of default during instance launch.
Updating InstanceTenancy requires no replacement only if you are updating its value from dedicated to default . Updating InstanceTenancy from default to dedicated requires replacement.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-instancetenancy

property ipv4IpamPoolId

readonly ipv4IpamPoolId?: string;

The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .
You must specify either CidrBlock or Ipv4IpamPoolId .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-ipv4ipampoolid

property ipv4NetmaskLength

readonly ipv4NetmaskLength?: number;

The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-ipv4netmasklength

property tags

readonly tags?: cdk.CfnTag[];

The tags for the VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-tags

interface CfnVPNConnectionProps

interface CfnVPNConnectionProps {}

Properties for defining a CfnVPNConnection
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html

property customerGatewayId

readonly customerGatewayId: string;

The ID of the customer gateway at your end of the VPN connection.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-customergatewayid

property staticRoutesOnly

readonly staticRoutesOnly?: boolean | cdk.IResolvable;

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
If you are creating a VPN connection for a device that does not support Border Gateway Protocol (BGP), you must specify true .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-staticroutesonly

property tags

readonly tags?: cdk.CfnTag[];

Any tags assigned to the VPN connection.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-tags

property transitGatewayId

readonly transitGatewayId?: string;

The ID of the transit gateway associated with the VPN connection.
You must specify either TransitGatewayId or VpnGatewayId , but not both.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-transitgatewayid

property type

readonly type: string;

The type of VPN connection.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-type

property vpnGatewayId

readonly vpnGatewayId?: string;

The ID of the virtual private gateway at the AWS side of the VPN connection.
You must specify either TransitGatewayId or VpnGatewayId , but not both.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-vpngatewayid

property vpnTunnelOptionsSpecifications

readonly vpnTunnelOptionsSpecifications?:
    | Array<
          | CfnVPNConnection.VpnTunnelOptionsSpecificationProperty
          | cdk.IResolvable
      >
    | cdk.IResolvable;

The tunnel options for the VPN connection.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-vpntunneloptionsspecifications

interface CfnVPNConnectionRouteProps

interface CfnVPNConnectionRouteProps {}

Properties for defining a CfnVPNConnectionRoute
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnectionroute.html

property destinationCidrBlock

readonly destinationCidrBlock: string;

The CIDR block associated with the local subnet of the customer network.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnectionroute.html#cfn-ec2-vpnconnectionroute-destinationcidrblock

property vpnConnectionId

readonly vpnConnectionId: string;

The ID of the VPN connection.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnectionroute.html#cfn-ec2-vpnconnectionroute-vpnconnectionid

interface CfnVPNGatewayProps

interface CfnVPNGatewayProps {}

Properties for defining a CfnVPNGateway
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngateway.html

property amazonSideAsn

readonly amazonSideAsn?: number;

The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngateway.html#cfn-ec2-vpngateway-amazonsideasn

property tags

readonly tags?: cdk.CfnTag[];

Any tags assigned to the virtual private gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngateway.html#cfn-ec2-vpngateway-tags

property type

readonly type: string;

The type of VPN connection the virtual private gateway supports.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngateway.html#cfn-ec2-vpngateway-type

interface CfnVPNGatewayRoutePropagationProps

interface CfnVPNGatewayRoutePropagationProps {}

Properties for defining a CfnVPNGatewayRoutePropagation
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngatewayroutepropagation.html

property routeTableIds

readonly routeTableIds: string[];

The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngatewayroutepropagation.html#cfn-ec2-vpngatewayroutepropagation-routetableids

property vpnGatewayId

readonly vpnGatewayId: string;

The ID of the virtual private gateway that is attached to a VPC. The virtual private gateway must be attached to the same VPC that the routing tables are associated with.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngatewayroutepropagation.html#cfn-ec2-vpngatewayroutepropagation-vpngatewayid

interface ClientVpnAuthorizationRuleOptions

interface ClientVpnAuthorizationRuleOptions {}

Options for a ClientVpnAuthorizationRule

property cidr

readonly cidr: string;

The IPv4 address range, in CIDR notation, of the network for which access is being authorized.

property description

readonly description?: string;

A brief description of the authorization rule.
- no description

property groupId

readonly groupId?: string;

The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.
- authorize all groups

interface ClientVpnAuthorizationRuleProps

interface ClientVpnAuthorizationRuleProps
    extends ClientVpnAuthorizationRuleOptions {}

Properties for a ClientVpnAuthorizationRule

property clientVpnEndoint

readonly clientVpnEndoint?: IClientVpnEndpoint;

The client VPN endpoint to which to add the rule.
Deprecated
Use clientVpnEndpoint instead clientVpnEndpoint is required

property clientVpnEndpoint

readonly clientVpnEndpoint?: IClientVpnEndpoint;

The client VPN endpoint to which to add the rule. clientVpnEndpoint is required

interface ClientVpnEndpointAttributes

interface ClientVpnEndpointAttributes {}

Attributes when importing an existing client VPN endpoint

property endpointId

readonly endpointId: string;

The endpoint ID

property securityGroups

readonly securityGroups: ISecurityGroup[];

The security groups associated with the endpoint

interface ClientVpnEndpointOptions

interface ClientVpnEndpointOptions {}

Options for a client VPN endpoint

property authorizeAllUsersToVpcCidr

readonly authorizeAllUsersToVpcCidr?: boolean;

Whether to authorize all users to the VPC CIDR
This automatically creates an authorization rule. Set this to false and use addAuthorizationRule() to create your own rules instead.
true

property cidr

readonly cidr: string;

The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually.
Changing the address range will replace the Client VPN endpoint.
The CIDR block should be /22 or greater.

property clientCertificateArn

readonly clientCertificateArn?: string;

The ARN of the client certificate for mutual authentication.
The certificate must be signed by a certificate authority (CA) and it must be provisioned in AWS Certificate Manager (ACM).
- use user-based authentication

property clientConnectionHandler

readonly clientConnectionHandler?: IClientVpnConnectionHandler;

The AWS Lambda function used for connection authorization
The name of the Lambda function must begin with the AWSClientVPN- prefix
- no connection handler

property clientLoginBanner

readonly clientLoginBanner?: string;

Customizable text that will be displayed in a banner on AWS provided clients when a VPN session is established.
UTF-8 encoded characters only. Maximum of 1400 characters.
- no banner is presented to the client

property description

readonly description?: string;

A brief description of the Client VPN endpoint.
- no description

property dnsServers

readonly dnsServers?: string[];

Information about the DNS servers to be used for DNS resolution.
A Client VPN endpoint can have up to two DNS servers.
- use the DNS address configured on the device

property logging

readonly logging?: boolean;

Whether to enable connections logging
true

property logGroup

readonly logGroup?: logs.ILogGroup;

A CloudWatch Logs log group for connection logging
- a new group is created

property logStream

readonly logStream?: logs.ILogStream;

A CloudWatch Logs log stream for connection logging
- a new stream is created

property port

readonly port?: VpnPort;

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
VpnPort.HTTPS

property securityGroups

readonly securityGroups?: ISecurityGroup[];

The security groups to apply to the target network.
- a new security group is created

property selfServicePortal

readonly selfServicePortal?: boolean;

Specify whether to enable the self-service portal for the Client VPN endpoint.
true

property serverCertificateArn

readonly serverCertificateArn: string;

The ARN of the server certificate

property sessionTimeout

readonly sessionTimeout?: ClientVpnSessionTimeout;

The maximum VPN session duration time.
ClientVpnSessionTimeout.TWENTY_FOUR_HOURS

property splitTunnel

readonly splitTunnel?: boolean;

Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
See Also
- https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html
  false

property transportProtocol

readonly transportProtocol?: TransportProtocol;

The transport protocol to be used by the VPN session.
TransportProtocol.UDP

property userBasedAuthentication

readonly userBasedAuthentication?: ClientVpnUserBasedAuthentication;

The type of user-based authentication to use.
See Also
- https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/client-authentication.html
  - use mutual authentication

property vpcSubnets

readonly vpcSubnets?: SubnetSelection;

Subnets to associate to the client VPN endpoint.
- the VPC default strategy

interface ClientVpnEndpointProps

interface ClientVpnEndpointProps extends ClientVpnEndpointOptions {}

Properties for a client VPN endpoint

property vpc

readonly vpc: IVpc;

The VPC to connect to.

interface ClientVpnRouteOptions

interface ClientVpnRouteOptions {}

Options for a ClientVpnRoute

property cidr

readonly cidr: string;

The IPv4 address range, in CIDR notation, of the route destination.
For example: - To add a route for Internet access, enter 0.0.0.0/0 - To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range - To add a route for an on-premises network, enter the AWS Site-to-Site VPN connection's IPv4 CIDR range - To add a route for the local network, enter the client CIDR range

property description

readonly description?: string;

A brief description of the authorization rule.
- no description

property target

readonly target: ClientVpnRouteTarget;

The target for the route

interface ClientVpnRouteProps

interface ClientVpnRouteProps extends ClientVpnRouteOptions {}

Properties for a ClientVpnRoute

property clientVpnEndoint

readonly clientVpnEndoint?: IClientVpnEndpoint;

The client VPN endpoint to which to add the route.
Deprecated
Use clientVpnEndpoint instead clientVpnEndpoint is required

property clientVpnEndpoint

readonly clientVpnEndpoint?: IClientVpnEndpoint;

The client VPN endpoint to which to add the route. clientVpnEndpoint is required

interface CommonNetworkAclEntryOptions

interface CommonNetworkAclEntryOptions {}

Basic NetworkACL entry props

property cidr

readonly cidr: AclCidr;

The CIDR range to allow or deny.

property direction

readonly direction?: TrafficDirection;

Traffic direction, with respect to the subnet, this rule applies to
TrafficDirection.INGRESS

property networkAclEntryName

readonly networkAclEntryName?: string;

The name of the NetworkAclEntry.
It is not recommended to use an explicit group name.
If you don't specify a NetworkAclName, AWS CloudFormation generates a unique physical ID and uses that ID for the group name.

property ruleAction

readonly ruleAction?: Action;

Whether to allow or deny traffic that matches the rule; valid values are "allow" or "deny".
Any traffic that is not explicitly allowed is automatically denied in a custom ACL, all traffic is automatically allowed in a default ACL.
ALLOW

property ruleNumber

readonly ruleNumber: number;

Rule number to assign to the entry, such as 100. ACL entries are processed in ascending order by rule number. Entries can't use the same rule number unless one is an egress rule and the other is an ingress rule.

property traffic

readonly traffic: AclTraffic;

What kind of traffic this ACL rule applies to

interface ConfigSetProps

interface ConfigSetProps {}

Options for CloudFormationInit.withConfigSets

property configs

readonly configs: Record<string, InitConfig>;

The sets of configs to pick from

property configSets

readonly configSets: Record<string, string[]>;

The definitions of each config set

interface ConfigureNatOptions

interface ConfigureNatOptions {}

Options passed by the VPC when NAT needs to be configured

property natSubnets

readonly natSubnets: PublicSubnet[];

The public subnets where the NAT providers need to be placed

property privateSubnets

readonly privateSubnets: PrivateSubnet[];

The private subnets that need to route through the NAT providers.
There may be more private subnets than public subnets with NAT providers.

property vpc

readonly vpc: Vpc;

The VPC we're configuring NAT for

interface ConnectionRule

interface ConnectionRule {}

property description

readonly description?: string;

Description of this connection. It is applied to both the ingress rule and the egress rule.
No description

property fromPort

readonly fromPort: number;

Start of port range for the TCP and UDP protocols, or an ICMP type number.
If you specify icmp for the IpProtocol property, you can specify -1 as a wildcard (i.e., any ICMP type number).

property protocol

readonly protocol?: string;

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all protocols. If you specify -1, or a protocol number other than tcp, udp, icmp, or 58 (ICMPv6), traffic on all ports is allowed, regardless of any ports you specify. For tcp, udp, and icmp, you must specify a port range. For protocol 58 (ICMPv6), you can optionally specify a port range; if you don't, traffic for all types and codes is allowed.
tcp

property toPort

readonly toPort?: number;

End of port range for the TCP and UDP protocols, or an ICMP code.
If you specify icmp for the IpProtocol property, you can specify -1 as a wildcard (i.e., any ICMP code).
If toPort is not specified, it will be the same as fromPort.

interface ConnectionsProps

interface ConnectionsProps {}

Properties to intialize a new Connections object

property defaultPort

readonly defaultPort?: Port;

Default port range for initiating connections to and from this object
- No default port

property peer

readonly peer?: IPeer;

Class that represents the rule by which others can connect to this connectable
This object is required, but will be derived from securityGroup if that is passed.
Derived from securityGroup if set.

property securityGroups

readonly securityGroups?: ISecurityGroup[];

What securityGroup(s) this object is managing connections for
No security groups

interface EbsDeviceOptions

interface EbsDeviceOptions extends EbsDeviceOptionsBase {}

Block device options for an EBS volume

property encrypted

readonly encrypted?: boolean;

Specifies whether the EBS volume is encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption
See Also
- https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances
  false

property kmsKey

readonly kmsKey?: IKey;

The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.
You have to ensure that the KMS CMK has the correct permissions to be used by the service launching the ec2 instances.
See Also
- https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#ebs-encryption-requirements
  - If encrypted is true, the default aws/ebs KMS key will be used.

interface EbsDeviceOptionsBase

interface EbsDeviceOptionsBase {}

Base block device options for an EBS volume

property deleteOnTermination

readonly deleteOnTermination?: boolean;

Indicates whether to delete the volume when the instance is terminated.
- true for Amazon EC2 Auto Scaling, false otherwise (e.g. EBS)

property iops

readonly iops?: number;

The number of I/O operations per second (IOPS) to provision for the volume.
Must only be set for volumeType: EbsDeviceVolumeType.IO1
The maximum ratio of IOPS to volume size (in GiB) is 50:1, so for 5,000 provisioned IOPS, you need at least 100 GiB storage on the volume.
See Also
- https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
  - none, required for EbsDeviceVolumeType.IO1

property volumeType

readonly volumeType?: EbsDeviceVolumeType;

The EBS volume type
See Also
- https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
  EbsDeviceVolumeType.GP2

interface EbsDeviceProps

interface EbsDeviceProps extends EbsDeviceSnapshotOptions, EbsDeviceOptions {}

Properties of an EBS block device

property snapshotId

readonly snapshotId?: string;

The snapshot ID of the volume to use
- No snapshot will be used

interface EbsDeviceSnapshotOptions

interface EbsDeviceSnapshotOptions extends EbsDeviceOptionsBase {}

Block device options for an EBS volume created from a snapshot

property volumeSize

readonly volumeSize?: number;

The volume size, in Gibibytes (GiB)
If you specify volumeSize, it must be equal or greater than the size of the snapshot.
- The snapshot size

interface EnableVpnGatewayOptions

interface EnableVpnGatewayOptions extends VpnGatewayProps {}

Options for the Vpc.enableVpnGateway() method

property vpnRoutePropagation

readonly vpnRoutePropagation?: SubnetSelection[];

Provide an array of subnets where the route propagation should be added. noPropagation

interface ExecuteFileOptions

interface ExecuteFileOptions {}

Options when executing a file.

property arguments

readonly arguments?: string;

The arguments to be passed to the file.
No arguments are passed to the file.

property filePath

readonly filePath: string;

The path to the file.

interface FlowLogDestinationConfig

interface FlowLogDestinationConfig {}

Flow Log Destination configuration

property iamRole

readonly iamRole?: iam.IRole;

The IAM Role that has access to publish to CloudWatch logs
- default IAM role is created for you

property keyPrefix

readonly keyPrefix?: string;

S3 bucket key prefix to publish the flow logs to
- undefined

property logDestinationType

readonly logDestinationType: FlowLogDestinationType;

The type of destination to publish the flow logs to.
- CLOUD_WATCH_LOGS

property logGroup

readonly logGroup?: logs.ILogGroup;

The CloudWatch Logs Log Group to publish the flow logs to
- default log group is created for you

property s3Bucket

readonly s3Bucket?: s3.IBucket;

S3 bucket to publish the flow logs to
- undefined

interface FlowLogOptions

interface FlowLogOptions {}

Options to add a flow log to a VPC

property destination

readonly destination?: FlowLogDestination;

Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3
FlowLogDestinationType.toCloudWatchLogs()

property trafficType

readonly trafficType?: FlowLogTrafficType;

The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.
ALL

interface FlowLogProps

interface FlowLogProps extends FlowLogOptions {}

Properties of a VPC Flow Log

property flowLogName

readonly flowLogName?: string;

The name of the FlowLog
It is not recommended to use an explicit name.
If you don't specify a flowLogName, AWS CloudFormation generates a unique physical ID and uses that ID for the group name.

property resourceType

readonly resourceType: FlowLogResourceType;

The type of resource for which to create the flow log

interface GatewayConfig

interface GatewayConfig {}

Pair represents a gateway created by NAT Provider

property az

readonly az: string;

Availability Zone

property gatewayId

readonly gatewayId: string;

Identity of gateway spawned by the provider

interface GatewayVpcEndpointOptions

interface GatewayVpcEndpointOptions {}

Options to add a gateway endpoint to a VPC.

property service

readonly service: IGatewayVpcEndpointService;

The service to use for this gateway VPC endpoint.

property subnets

readonly subnets?: SubnetSelection[];

Where to add endpoint routing.
By default, this endpoint will be routable from all subnets in the VPC. Specify a list of subnet selection objects here to be more specific.
- All subnets in the VPC
Example 1
declare const vpc: ec2.Vpc;
vpc.addGatewayEndpoint('DynamoDbEndpoint', { service: ec2.GatewayVpcEndpointAwsService.DYNAMODB, // Add only to ISOLATED subnets subnets: [ { subnetType: ec2.SubnetType.PRIVATE_ISOLATED } ] });

interface GatewayVpcEndpointProps

interface GatewayVpcEndpointProps extends GatewayVpcEndpointOptions {}

Construction properties for a GatewayVpcEndpoint.

property vpc

readonly vpc: IVpc;

The VPC network in which the gateway endpoint will be used.

interface GenericLinuxImageProps

interface GenericLinuxImageProps {}

Configuration options for GenericLinuxImage

property userData

readonly userData?: UserData;

Initial user data
- Empty UserData for Linux machines

interface GenericWindowsImageProps

interface GenericWindowsImageProps {}

Configuration options for GenericWindowsImage

property userData

readonly userData?: UserData;

Initial user data
- Empty UserData for Windows machines

interface IClientVpnConnectionHandler

interface IClientVpnConnectionHandler {}

A connection handler for client VPN endpoints

property functionArn

readonly functionArn: string;

The ARN of the function.

property functionName

readonly functionName: string;

The name of the function

interface IClientVpnEndpoint

interface IClientVpnEndpoint extends IResource, IConnectable {}

A client VPN endpoint

property endpointId

readonly endpointId: string;

The endpoint ID

property targetNetworksAssociated

readonly targetNetworksAssociated: IDependable;

Dependable that can be depended upon to force target networks associations

interface IConnectable

interface IConnectable {}

An object that has a Connections object

property connections

readonly connections: Connections;

The network connections associated with this resource.

interface IFlowLog

interface IFlowLog extends IResource {}

A FlowLog

property flowLogId

readonly flowLogId: string;

The Id of the VPC Flow Log

interface IGatewayVpcEndpoint

interface IGatewayVpcEndpoint extends IVpcEndpoint {}

A gateway VPC endpoint.

interface IGatewayVpcEndpointService

interface IGatewayVpcEndpointService {}

A service for a gateway VPC endpoint.

property name

readonly name: string;

The name of the service.

interface IInstance

interface IInstance extends IResource, IConnectable, iam.IGrantable {}

property instanceAvailabilityZone

readonly instanceAvailabilityZone: string;

The availability zone the instance was launched in

property instanceId

readonly instanceId: string;

The instance's ID

property instancePrivateDnsName

readonly instancePrivateDnsName: string;

Private DNS name for this instance

property instancePrivateIp

readonly instancePrivateIp: string;

Private IP for this instance

property instancePublicDnsName

readonly instancePublicDnsName: string;

Publicly-routable DNS name for this instance.
(May be an empty string if the instance does not have a public name).

property instancePublicIp

readonly instancePublicIp: string;

Publicly-routable IP address for this instance.
(May be an empty string if the instance does not have a public IP).

interface IInterfaceVpcEndpoint

interface IInterfaceVpcEndpoint extends IVpcEndpoint, IConnectable {}

An interface VPC endpoint.

interface IInterfaceVpcEndpointService

interface IInterfaceVpcEndpointService {}

A service for an interface VPC endpoint.

property name

readonly name: string;

The name of the service.

property port

readonly port: number;

The port of the service.

property privateDnsDefault

readonly privateDnsDefault?: boolean;

Whether Private DNS is supported by default.

interface ILaunchTemplate

interface ILaunchTemplate extends IResource {}

Interface for LaunchTemplate-like objects.

property launchTemplateId

readonly launchTemplateId?: string;

The identifier of the Launch Template
Exactly one of launchTemplateId and launchTemplateName will be set.

property launchTemplateName

readonly launchTemplateName?: string;

The name of the Launch Template
Exactly one of launchTemplateId and launchTemplateName will be set.

property versionNumber

readonly versionNumber: string;

The version number of this launch template to use

interface IMachineImage

interface IMachineImage {}

Interface for classes that can select an appropriate machine image to use

method getImage

getImage: (scope: Construct) => MachineImageConfig;

Return the image to use in the given context

interface INetworkAcl

interface INetworkAcl extends IResource {}

A NetworkAcl

property networkAclId

readonly networkAclId: string;

ID for the current Network ACL

method addEntry

addEntry: (id: string, options: CommonNetworkAclEntryOptions) => NetworkAclEntry;

Add a new entry to the ACL

interface INetworkAclEntry

interface INetworkAclEntry extends IResource {}

A NetworkAclEntry

property networkAcl

readonly networkAcl: INetworkAcl;

The network ACL.

interface InitCommandOptions

interface InitCommandOptions {}

Options for InitCommand

property cwd

readonly cwd?: string;

The working directory
- Use default working directory

property env

readonly env?: Record<string, string>;

Sets environment variables for the command.
This property overwrites, rather than appends, the existing environment.
- Use current environment

property ignoreErrors

readonly ignoreErrors?: boolean;

Continue running if this command fails
false

property key

readonly key?: string;

Identifier key for this command
Commands are executed in lexicographical order of their key names.
- Automatically generated based on index

property serviceRestartHandles

readonly serviceRestartHandles?: InitServiceRestartHandle[];

Restart the given service(s) after this command has run
- Do not restart any service

property testCmd

readonly testCmd?: string;

Command to determine whether this command should be run
If the test passes (exits with error code of 0), the command is run.
- Always run the command

property waitAfterCompletion

readonly waitAfterCompletion?: InitCommandWaitDuration;

The duration to wait after a command has finished in case the command causes a reboot.
Set this value to InitCommandWaitDuration.none() if you do not want to wait for every command; InitCommandWaitDuration.forever() directs cfn-init to exit and resume only after the reboot is complete.
For Windows systems only.
- 60 seconds

interface InitFileAssetOptions

interface InitFileAssetOptions extends InitFileOptions, s3_assets.AssetOptions {}

Additional options for creating an InitFile from an asset.

interface InitFileOptions

interface InitFileOptions {}

Options for InitFile

property base64Encoded

readonly base64Encoded?: boolean;

True if the inlined content (from a string or file) should be treated as base64 encoded. Only applicable for inlined string and file content.
false

property group

readonly group?: string;

The name of the owning group for this file.
Not supported for Windows systems.
'root'

property mode

readonly mode?: string;

A six-digit octal value representing the mode for this file.
Use the first three digits for symlinks and the last three digits for setting permissions. To create a symlink, specify 120xxx, where xxx defines the permissions of the target file. To specify permissions for a file, use the last three digits, such as 000644.
Not supported for Windows systems.
'000644'

property owner

readonly owner?: string;

The name of the owning user for this file.
Not supported for Windows systems.
'root'

property serviceRestartHandles

readonly serviceRestartHandles?: InitServiceRestartHandle[];

Restart the given service after this file has been written
- Do not restart any service

interface InitServiceOptions

interface InitServiceOptions {}

Options for an InitService

property enabled

readonly enabled?: boolean;

Enable or disable this service
Set to true to ensure that the service will be started automatically upon boot.
Set to false to ensure that the service will not be started automatically upon boot.
- true if used in InitService.enable(), no change to service state if used in InitService.fromOptions().

property ensureRunning

readonly ensureRunning?: boolean;

Make sure this service is running or not running after cfn-init finishes.
Set to true to ensure that the service is running after cfn-init finishes.
Set to false to ensure that the service is not running after cfn-init finishes.
- same value as enabled.

property serviceRestartHandle

readonly serviceRestartHandle?: InitServiceRestartHandle;

Restart service when the actions registered into the restartHandle have been performed
Register actions into the restartHandle by passing it to InitFile, InitCommand, InitPackage and InitSource objects.
- No files trigger restart

interface InitSourceAssetOptions

interface InitSourceAssetOptions extends InitSourceOptions, s3_assets.AssetOptions {}

Additional options for an InitSource that builds an asset from local files.

interface InitSourceOptions

interface InitSourceOptions {}

Additional options for an InitSource

property serviceRestartHandles

readonly serviceRestartHandles?: InitServiceRestartHandle[];

Restart the given services after this archive has been extracted
- Do not restart any service

interface InitUserOptions

interface InitUserOptions {}

Optional parameters used when creating a user

property groups

readonly groups?: string[];

A list of group names. The user will be added to each group in the list.
the user is not associated with any groups.

property homeDir

readonly homeDir?: string;

The user's home directory.
assigned by the OS

property userId

readonly userId?: number;

A user ID. The creation process fails if the user name exists with a different user ID. If the user ID is already assigned to an existing user the operating system may reject the creation request.
assigned by the OS

interface InstanceProps

interface InstanceProps {}

Properties of an EC2 Instance

property allowAllOutbound

readonly allowAllOutbound?: boolean;

Whether the instance could initiate connections to anywhere by default. This property is only used when you do not provide a security group.
true

property availabilityZone

readonly availabilityZone?: string;

In which AZ to place the instance within the VPC
- Random zone.

property blockDevices

readonly blockDevices?: BlockDevice[];

Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.
Each instance that is launched has an associated root device volume, either an Amazon EBS volume or an instance store volume. You can use block device mappings to specify additional EBS volumes or instance store volumes to attach to an instance when it is launched.
See Also
- https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
  - Uses the block device mapping of the AMI

property detailedMonitoring

readonly detailedMonitoring?: boolean;

Whether "Detailed Monitoring" is enabled for this instance Keep in mind that Detailed Monitoring results in extra charges
See Also
- http://aws.amazon.com/cloudwatch/pricing/ - false

property init

readonly init?: CloudFormationInit;

Apply the given CloudFormation Init configuration to the instance at startup
- no CloudFormation init

property initOptions

readonly initOptions?: ApplyCloudFormationInitOptions;

Use the given options for applying CloudFormation Init
Describes the configsets to use and the timeout to wait
- default options

property instanceName

readonly instanceName?: string;

The name of the instance
- CDK generated name

property instanceType

readonly instanceType: InstanceType;

Type of instance to launch

property keyName

readonly keyName?: string;

Name of SSH keypair to grant access to instance
- No SSH access will be possible.

property machineImage

readonly machineImage: IMachineImage;

AMI to launch

property privateIpAddress

readonly privateIpAddress?: string;

Defines a private IP address to associate with an instance.
Private IP should be available within the VPC that the instance is build within.
- no association

property propagateTagsToVolumeOnCreation

readonly propagateTagsToVolumeOnCreation?: boolean;

Propagate the EC2 instance tags to the EBS volumes.
- false

property requireImdsv2

readonly requireImdsv2?: boolean;

Whether IMDSv2 should be required on this instance.
- false

property resourceSignalTimeout

readonly resourceSignalTimeout?: Duration;

The length of time to wait for the resourceSignalCount
The maximum value is 43200 (12 hours).
Duration.minutes(5)

property role

readonly role?: iam.IRole;

An IAM role to associate with the instance profile assigned to this Auto Scaling Group.
The role must be assumable by the service principal ec2.amazonaws.com:
Example 1
const role = new iam.Role(this, 'MyRole', { assumedBy: new iam.ServicePrincipal('ec2.amazonaws.com') });
- A role will automatically be created, it can be accessed via the role property

property securityGroup

readonly securityGroup?: ISecurityGroup;

Security Group to assign to this instance
- create new security group

property sourceDestCheck

readonly sourceDestCheck?: boolean;

Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform NAT.
true

property userData

readonly userData?: UserData;

Specific UserData to use
The UserData may still be mutated after creation.
- A UserData object appropriate for the MachineImage's Operating System is created.

property userDataCausesReplacement

readonly userDataCausesReplacement?: boolean;

Changes to the UserData force replacement
Depending the EC2 instance type, changing UserData either restarts the instance or replaces the instance.
- Instance store-backed instances are replaced. - EBS-backed instances are restarted.
By default, restarting does not execute the new UserData so you will need a different mechanism to ensure the instance is restarted.
Setting this to true will make the instance's Logical ID depend on the UserData, which will cause CloudFormation to replace it if the UserData changes.
- true iff initOptions is specified, false otherwise.

property vpc

readonly vpc: IVpc;

VPC to launch the instance in.

property vpcSubnets

readonly vpcSubnets?: SubnetSelection;

Where to place the instance within the VPC
- Private subnets.

interface InstanceRequireImdsv2AspectProps

interface InstanceRequireImdsv2AspectProps extends RequireImdsv2AspectProps {}

Properties for InstanceRequireImdsv2Aspect.

property suppressLaunchTemplateWarning

readonly suppressLaunchTemplateWarning?: boolean;

Whether warnings that would be raised when an Instance is associated with an existing Launch Template should be suppressed or not.
You can set this to true if LaunchTemplateImdsAspect is being used alongside this Aspect to suppress false-positive warnings because any Launch Templates associated with Instances will still be covered.
- false

interface InterfaceVpcEndpointAttributes

interface InterfaceVpcEndpointAttributes {}

Construction properties for an ImportedInterfaceVpcEndpoint.

property port

readonly port: number;

The port of the service of the interface VPC endpoint.

property securityGroupId

readonly securityGroupId?: string;

The identifier of the security group associated with the interface VPC endpoint.
Deprecated
use securityGroups instead

property securityGroups

readonly securityGroups?: ISecurityGroup[];

The security groups associated with the interface VPC endpoint.

property vpcEndpointId

readonly vpcEndpointId: string;

The interface VPC endpoint identifier.

interface InterfaceVpcEndpointOptions

interface InterfaceVpcEndpointOptions {}

Options to add an interface endpoint to a VPC.

property lookupSupportedAzs

readonly lookupSupportedAzs?: boolean;

Limit to only those availability zones where the endpoint service can be created
Setting this to 'true' requires a lookup to be performed at synthesis time. Account and region must be set on the containing stack for this to work.
false

property open

readonly open?: boolean;

Whether to automatically allow VPC traffic to the endpoint
If enabled, all traffic to the endpoint from within the VPC will be automatically allowed. This is done based on the VPC's CIDR range.
true

property privateDnsEnabled

readonly privateDnsEnabled?: boolean;

Whether to associate a private hosted zone with the specified VPC. This allows you to make requests to the service using its default DNS hostname.
set by the instance of IInterfaceVpcEndpointService, or true if not defined by the instance of IInterfaceVpcEndpointService

property securityGroups

readonly securityGroups?: ISecurityGroup[];

The security groups to associate with this interface VPC endpoint.
- a new security group is created

property service

readonly service: IInterfaceVpcEndpointService;

The service to use for this interface VPC endpoint.

property subnets

readonly subnets?: SubnetSelection;

The subnets in which to create an endpoint network interface. At most one per availability zone.
- private subnets

interface InterfaceVpcEndpointProps

interface InterfaceVpcEndpointProps extends InterfaceVpcEndpointOptions {}

Construction properties for an InterfaceVpcEndpoint.

property vpc

readonly vpc: IVpc;

The VPC network in which the interface endpoint will be used.

interface IPeer

interface IPeer extends IConnectable {}

Interface for classes that provide the peer-specification parts of a security group rule

property canInlineRule

readonly canInlineRule: boolean;

Whether the rule can be inlined into a SecurityGroup or not

property uniqueId

readonly uniqueId: string;

A unique identifier for this connection peer

method toEgressRuleConfig

toEgressRuleConfig: () => any;

Produce the egress rule JSON for the given connection

method toIngressRuleConfig

toIngressRuleConfig: () => any;

Produce the ingress rule JSON for the given connection

interface IPrivateSubnet

interface IPrivateSubnet extends ISubnet {}

interface IPublicSubnet

interface IPublicSubnet extends ISubnet {}

interface IRouteTable

interface IRouteTable {}

An abstract route table

property routeTableId

readonly routeTableId: string;

Route table ID

interface ISecurityGroup

interface ISecurityGroup extends IResource, IPeer {}

Interface for security group-like objects

property allowAllOutbound

readonly allowAllOutbound: boolean;

Whether the SecurityGroup has been configured to allow all outbound traffic

property securityGroupId

readonly securityGroupId: string;

ID for the current security group

method addEgressRule

addEgressRule: (
    peer: IPeer,
    connection: Port,
    description?: string,
    remoteRule?: boolean
) => void;

Add an egress rule for the current security group
remoteRule controls where the Rule object is created if the peer is also a securityGroup and they are in different stack. If false (default) the rule object is created under the current SecurityGroup object. If true and the peer is also a SecurityGroup, the rule object is created under the remote SecurityGroup object.

method addIngressRule

addIngressRule: (
    peer: IPeer,
    connection: Port,
    description?: string,
    remoteRule?: boolean
) => void;

Add an ingress rule for the current security group
remoteRule controls where the Rule object is created if the peer is also a securityGroup and they are in different stack. If false (default) the rule object is created under the current SecurityGroup object. If true and the peer is also a SecurityGroup, the rule object is created under the remote SecurityGroup object.

interface ISubnet

interface ISubnet extends IResource {}

property availabilityZone

readonly availabilityZone: string;

The Availability Zone the subnet is located in

property internetConnectivityEstablished

readonly internetConnectivityEstablished: IDependable;

Dependable that can be depended upon to force internet connectivity established on the VPC

property ipv4CidrBlock

readonly ipv4CidrBlock: string;

The IPv4 CIDR block for this subnet

property routeTable

readonly routeTable: IRouteTable;

The route table for this subnet

property subnetId

readonly subnetId: string;

The subnetId for this particular subnet

method associateNetworkAcl

associateNetworkAcl: (id: string, acl: INetworkAcl) => void;

Associate a Network ACL with this subnet
Parameter acl
The Network ACL to associate

interface ISubnetNetworkAclAssociation

interface ISubnetNetworkAclAssociation extends IResource {}

A SubnetNetworkAclAssociation

property subnetNetworkAclAssociationAssociationId

readonly subnetNetworkAclAssociationAssociationId: string;

ID for the current SubnetNetworkAclAssociation

interface IVolume

interface IVolume extends IResource {}

An EBS Volume in AWS EC2.

property availabilityZone

readonly availabilityZone: string;

The availability zone that the EBS Volume is contained within (ex: us-west-2a)

property encryptionKey

readonly encryptionKey?: IKey;

The customer-managed encryption key that is used to encrypt the Volume.

property volumeId

readonly volumeId: string;

The EBS Volume's ID

method grantAttachVolume

grantAttachVolume: (grantee: IGrantable, instances?: IInstance[]) => Grant;

Grants permission to attach this Volume to an instance. CAUTION: Granting an instance permission to attach to itself using this method will lead to an unresolvable circular reference between the instance role and the instance. Use IVolume.grantAttachVolumeToSelf to grant an instance permission to attach this volume to itself.
Parameter grantee
the principal being granted permission.
Parameter instances
the instances to which permission is being granted to attach this volume to. If not specified, then permission is granted to attach to all instances in this account.

method grantAttachVolumeByResourceTag

grantAttachVolumeByResourceTag: (
    grantee: IGrantable,
    constructs: Construct[],
    tagKeySuffix?: string
) => Grant;

Grants permission to attach the Volume by a ResourceTag condition. If you are looking to grant an Instance, AutoScalingGroup, EC2-Fleet, SpotFleet, ECS host, etc the ability to attach this volume to **itself** then this is the method you want to use.
This is implemented by adding a Tag with key VolumeGrantAttach-<suffix> to the given constructs and this Volume, and then conditioning the Grant such that the grantee is only given the ability to AttachVolume if both the Volume and the destination Instance have that tag applied to them.
Parameter grantee
the principal being granted permission.
Parameter constructs
The list of constructs that will have the generated resource tag applied to them.
Parameter tagKeySuffix
A suffix to use on the generated Tag key in place of the generated hash value. Defaults to a hash calculated from this volume and list of constructs. (DEPRECATED)

method grantDetachVolume

grantDetachVolume: (grantee: IGrantable, instances?: IInstance[]) => Grant;

Grants permission to detach this Volume from an instance CAUTION: Granting an instance permission to detach from itself using this method will lead to an unresolvable circular reference between the instance role and the instance. Use IVolume.grantDetachVolumeFromSelf to grant an instance permission to detach this volume from itself.
Parameter grantee
the principal being granted permission.
Parameter instances
the instances to which permission is being granted to detach this volume from. If not specified, then permission is granted to detach from all instances in this account.

method grantDetachVolumeByResourceTag

grantDetachVolumeByResourceTag: (
    grantee: IGrantable,
    constructs: Construct[],
    tagKeySuffix?: string
) => Grant;

Grants permission to detach the Volume by a ResourceTag condition.
This is implemented via the same mechanism as IVolume.grantAttachVolumeByResourceTag, and is subject to the same conditions.
Parameter grantee
the principal being granted permission.
Parameter constructs
The list of constructs that will have the generated resource tag applied to them.
Parameter tagKeySuffix
A suffix to use on the generated Tag key in place of the generated hash value. Defaults to a hash calculated from this volume and list of constructs. (DEPRECATED)

interface IVpc

interface IVpc extends IResource {}

property availabilityZones

readonly availabilityZones: string[];

AZs for this VPC

property internetConnectivityEstablished

readonly internetConnectivityEstablished: IDependable;

Dependable that can be depended upon to force internet connectivity established on the VPC

property isolatedSubnets

readonly isolatedSubnets: ISubnet[];

List of isolated subnets in this VPC

property privateSubnets

readonly privateSubnets: ISubnet[];

List of private subnets in this VPC

property publicSubnets

readonly publicSubnets: ISubnet[];

List of public subnets in this VPC

property vpcArn

readonly vpcArn: string;

ARN for this VPC

property vpcCidrBlock

readonly vpcCidrBlock: string;

CIDR range for this VPC

property vpcId

readonly vpcId: string;

Identifier for this VPC

property vpnGatewayId

readonly vpnGatewayId?: string;

Identifier for the VPN gateway

method addClientVpnEndpoint

addClientVpnEndpoint: (
    id: string,
    options: ClientVpnEndpointOptions
) => ClientVpnEndpoint;

Adds a new client VPN endpoint to this VPC

method addFlowLog

addFlowLog: (id: string, options?: FlowLogOptions) => FlowLog;

Adds a new Flow Log to this VPC

method addGatewayEndpoint

addGatewayEndpoint: (
    id: string,
    options: GatewayVpcEndpointOptions
) => GatewayVpcEndpoint;

Adds a new gateway endpoint to this VPC

method addInterfaceEndpoint

addInterfaceEndpoint: (
    id: string,
    options: InterfaceVpcEndpointOptions
) => InterfaceVpcEndpoint;

Adds a new interface endpoint to this VPC

method addVpnConnection

addVpnConnection: (id: string, options: VpnConnectionOptions) => VpnConnection;

Adds a new VPN connection to this VPC

method enableVpnGateway

enableVpnGateway: (options: EnableVpnGatewayOptions) => void;

Adds a VPN Gateway to this VPC

method selectSubnets

selectSubnets: (selection?: SubnetSelection) => SelectedSubnets;

Return information on the subnets appropriate for the given selection strategy
Requires that at least one subnet is matched, throws a descriptive error message otherwise.

interface IVpcEndpoint

interface IVpcEndpoint extends IResource {}

A VPC endpoint.

property vpcEndpointId

readonly vpcEndpointId: string;

The VPC endpoint identifier.

interface IVpcEndpointService

interface IVpcEndpointService extends IResource {}

A VPC endpoint service.

property vpcEndpointServiceId

readonly vpcEndpointServiceId: string;

The id of the VPC Endpoint Service that clients use to connect to, like vpce-svc-xxxxxxxxxxxxxxxx

property vpcEndpointServiceName

readonly vpcEndpointServiceName: string;

The service name of the VPC Endpoint Service that clients use to connect to, like com.amazonaws.vpce..vpce-svc-xxxxxxxxxxxxxxxx

interface IVpcEndpointServiceLoadBalancer

interface IVpcEndpointServiceLoadBalancer {}

A load balancer that can host a VPC Endpoint Service

property loadBalancerArn

readonly loadBalancerArn: string;

The ARN of the load balancer that hosts the VPC Endpoint Service

interface IVpnConnection

interface IVpnConnection extends IResource {}

property customerGatewayAsn

readonly customerGatewayAsn: number;

The ASN of the customer gateway.

property customerGatewayId

readonly customerGatewayId: string;

The id of the customer gateway.

property customerGatewayIp

readonly customerGatewayIp: string;

The ip address of the customer gateway.

property vpnId

readonly vpnId: string;

The id of the VPN connection. VpnConnectionId

interface IVpnConnection

interface IVpnConnection {}

method metric

metric: (
    metricName: string,
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

Return the given named metric for this VPNConnection

method metricTunnelDataIn

metricTunnelDataIn: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;

The bytes received through the VPN tunnel.
Sum over 5 minutes

method metricTunnelDataOut

metricTunnelDataOut: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;

The bytes sent through the VPN tunnel.
Sum over 5 minutes

method metricTunnelState

metricTunnelState: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;

The state of the tunnel. 0 indicates DOWN and 1 indicates UP.
Average over 5 minutes

interface IVpnGateway

interface IVpnGateway extends IResource {}

The virtual private gateway interface

property gatewayId

readonly gatewayId: string;

The virtual private gateway Id

interface LaunchTemplateAttributes

interface LaunchTemplateAttributes {}

Attributes for an imported LaunchTemplate.

property launchTemplateId

readonly launchTemplateId?: string;

The identifier of the Launch Template
Exactly one of launchTemplateId and launchTemplateName may be set.
None

property launchTemplateName

readonly launchTemplateName?: string;

The name of the Launch Template
Exactly one of launchTemplateId and launchTemplateName may be set.
None

property versionNumber

readonly versionNumber?: string;

The version number of this launch template to use
Version: "$Default"

interface LaunchTemplateProps

interface LaunchTemplateProps {}

Properties of a LaunchTemplate.

property blockDevices

readonly blockDevices?: BlockDevice[];

Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.
Each instance that is launched has an associated root device volume, either an Amazon EBS volume or an instance store volume. You can use block device mappings to specify additional EBS volumes or instance store volumes to attach to an instance when it is launched.
See Also
- https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
  - Uses the block device mapping of the AMI

property cpuCredits

readonly cpuCredits?: CpuCredits;

CPU credit type for burstable EC2 instance types.
See Also
- https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html
  - No credit type is specified in the Launch Template.

property detailedMonitoring

readonly detailedMonitoring?: boolean;

If set to true, then detailed monitoring will be enabled on instances created with this launch template.
See Also
- https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html
  False - Detailed monitoring is disabled.

property disableApiTermination

readonly disableApiTermination?: boolean;

If you set this parameter to true, you cannot terminate the instances launched with this launch template using the Amazon EC2 console, CLI, or API; otherwise, you can.
- The API termination setting is not specified in the Launch Template.

property ebsOptimized

readonly ebsOptimized?: boolean;

Indicates whether the instances are optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
- EBS optimization is not specified in the launch template.

property hibernationConfigured

readonly hibernationConfigured?: boolean;

If you set this parameter to true, the instance is enabled for hibernation.
- Hibernation configuration is not specified in the launch template; defaulting to false.

property instanceInitiatedShutdownBehavior

readonly instanceInitiatedShutdownBehavior?: InstanceInitiatedShutdownBehavior;

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
See Also
- https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#Using_ChangingInstanceInitiatedShutdownBehavior
  - Shutdown behavior is not specified in the launch template; defaults to STOP.

property instanceType

readonly instanceType?: InstanceType;

Type of instance to launch.
- This Launch Template does not specify a default Instance Type.

property keyName

readonly keyName?: string;

Name of SSH keypair to grant access to instance
- No SSH access will be possible.

property launchTemplateName

readonly launchTemplateName?: string;

Name for this launch template.
Automatically generated name

property machineImage

readonly machineImage?: IMachineImage;

The AMI that will be used by instances.
- This Launch Template does not specify a default AMI.

property nitroEnclaveEnabled

readonly nitroEnclaveEnabled?: boolean;

If this parameter is set to true, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves.
- Enablement of Nitro enclaves is not specified in the launch template; defaulting to false.

property requireImdsv2

readonly requireImdsv2?: boolean;

Whether IMDSv2 should be required on launched instances.
- false

property role

readonly role?: iam.IRole;

An IAM role to associate with the instance profile that is used by instances.
The role must be assumable by the service principal ec2.amazonaws.com:
Example 1
const role = new iam.Role(this, 'MyRole', { assumedBy: new iam.ServicePrincipal('ec2.amazonaws.com') });
- No new role is created.

property securityGroup

readonly securityGroup?: ISecurityGroup;

Security group to assign to instances created with the launch template.
No security group is assigned.

property spotOptions

readonly spotOptions?: LaunchTemplateSpotOptions;

If this property is defined, then the Launch Template's InstanceMarketOptions will be set to use Spot instances, and the options for the Spot instances will be as defined.
- Instance launched with this template will not be spot instances.

property userData

readonly userData?: UserData;

The AMI that will be used by instances.
- This Launch Template creates a UserData based on the type of provided machineImage; no UserData is created if a machineImage is not provided

interface LaunchTemplateRequireImdsv2AspectProps

interface LaunchTemplateRequireImdsv2AspectProps extends RequireImdsv2AspectProps {}

Properties for LaunchTemplateRequireImdsv2Aspect.

interface LaunchTemplateSpotOptions

interface LaunchTemplateSpotOptions {}

Interface for the Spot market instance options provided in a LaunchTemplate.

property blockDuration

readonly blockDuration?: Duration;

Spot Instances with a defined duration (also known as Spot blocks) are designed not to be interrupted and will run continuously for the duration you select. You can use a duration of 1, 2, 3, 4, 5, or 6 hours.
See Also
- https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html#fixed-duration-spot-instances
  Requested spot instances do not have a pre-defined duration.

property interruptionBehavior

readonly interruptionBehavior?: SpotInstanceInterruption;

The behavior when a Spot Instance is interrupted.
Spot instances will terminate when interrupted.

property maxPrice

readonly maxPrice?: number;

Maximum hourly price you're willing to pay for each Spot instance. The value is given in dollars. ex: 0.01 for 1 cent per hour, or 0.001 for one-tenth of a cent per hour.
Maximum hourly price will default to the on-demand price for the instance type.

property requestType

readonly requestType?: SpotRequestType;

The Spot Instance request type.
If you are using Spot Instances with an Auto Scaling group, use one-time requests, as the Amazon EC2 Auto Scaling service handles requesting new Spot Instances whenever the group is below its desired capacity.
One-time spot request.

property validUntil

readonly validUntil?: Expiration;

The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
The default end date is 7 days from the current date.

interface LinuxUserDataOptions

interface LinuxUserDataOptions {}

Options when constructing UserData for Linux

property shebang

readonly shebang?: string;

Shebang for the UserData script
"#!/bin/bash"

interface LocationPackageOptions

interface LocationPackageOptions {}

Options for InitPackage.rpm/InitPackage.msi

property key

readonly key?: string;

Identifier key for this package
You can use this to order package installs.
- Automatically generated

property serviceRestartHandles

readonly serviceRestartHandles?: InitServiceRestartHandle[];

Restart the given service after this command has run
- Do not restart any service

interface LookupMachineImageProps

interface LookupMachineImageProps {}

Properties for looking up an image

property filters

readonly filters?: {
    [key: string]: string[];
};

Additional filters on the AMI
See Also
- https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html - No additional filters

property name

readonly name: string;

Name of the image (may contain wildcards)

property owners

readonly owners?: string[];

Owner account IDs or aliases
- All owners

property userData

readonly userData?: UserData;

Custom userdata for this image
- Empty user data appropriate for the platform type

property windows

readonly windows?: boolean;

Look for Windows images
false

interface MachineImageConfig

interface MachineImageConfig {}

Configuration for a machine image

property imageId

readonly imageId: string;

The AMI ID of the image to use

property osType

readonly osType: OperatingSystemType;

Operating system type for this image

property userData

readonly userData: UserData;

Initial UserData for this image

interface MultipartBodyOptions

interface MultipartBodyOptions {}

Options when creating MultipartBody.

property body

readonly body?: string;

The body of message.
undefined - body will not be added to part

property contentType

readonly contentType: string;

Content-Type header of this part.
Some examples of content types: * text/x-shellscript; charset="utf-8" (shell script) * text/cloud-boothook; charset="utf-8" (shell script executed during boot phase)
For Linux shell scripts use text/x-shellscript.

property transferEncoding

readonly transferEncoding?: string;

Content-Transfer-Encoding header specifying part encoding.
undefined - body is not encoded

interface MultipartUserDataOptions

interface MultipartUserDataOptions {}

Options for creating MultipartUserData

property partsSeparator

readonly partsSeparator?: string;

The string used to separate parts in multipart user data archive (it's like MIME boundary).
This string should contain [a-zA-Z0-9()+,-./:=?] characters only, and should not be present in any part, or in text content of archive.
+AWS+CDK+User+Data+Separator==

interface NamedPackageOptions

interface NamedPackageOptions {}

Options for InitPackage.yum/apt/rubyGem/python

property serviceRestartHandles

readonly serviceRestartHandles?: InitServiceRestartHandle[];

Restart the given services after this command has run
- Do not restart any service

property version

readonly version?: string[];

Specify the versions to install
- Install the latest version

interface NatGatewayProps

interface NatGatewayProps {}

Properties for a NAT gateway

property eipAllocationIds

readonly eipAllocationIds?: string[];

EIP allocation IDs for the NAT gateways
- No fixed EIPs allocated for the NAT gateways

interface NatInstanceProps

interface NatInstanceProps {}

Properties for a NAT instance

property allowAllTraffic

readonly allowAllTraffic?: boolean;

Allow all inbound traffic through the NAT instance
If you set this to false, you must configure the NAT instance's security groups in another way, either by passing in a fully configured Security Group using the securityGroup property, or by configuring it using the .securityGroup or .connections members after passing the NAT Instance Provider to a Vpc.
true
Deprecated
- Use defaultAllowedTraffic.

property defaultAllowedTraffic

readonly defaultAllowedTraffic?: NatTrafficDirection;

Direction to allow all traffic through the NAT instance by default.
By default, inbound and outbound traffic is allowed.
If you set this to another value than INBOUND_AND_OUTBOUND, you must configure the NAT instance's security groups in another way, either by passing in a fully configured Security Group using the securityGroup property, or by configuring it using the .securityGroup or .connections members after passing the NAT Instance Provider to a Vpc.
NatTrafficDirection.INBOUND_AND_OUTBOUND

property instanceType

readonly instanceType: InstanceType;

Instance type of the NAT instance

property keyName

readonly keyName?: string;

Name of SSH keypair to grant access to instance
- No SSH access will be possible.

property machineImage

readonly machineImage?: IMachineImage;

The machine image (AMI) to use
By default, will do an AMI lookup for the latest NAT instance image.
If you have a specific AMI ID you want to use, pass a GenericLinuxImage. For example:
ec2.NatProvider.instance({ instanceType: new ec2.InstanceType('t3.micro'), machineImage: new ec2.GenericLinuxImage({ 'us-east-2': 'ami-0f9c61b5a562a16af' }) })
- Latest NAT instance image

property securityGroup

readonly securityGroup?: ISecurityGroup;

Security Group for NAT instances
- A new security group will be created

interface NetworkAclEntryProps

interface NetworkAclEntryProps extends CommonNetworkAclEntryOptions {}

Properties to create NetworkAclEntry

property networkAcl

readonly networkAcl: INetworkAcl;

The network ACL this entry applies to.

interface NetworkAclProps

interface NetworkAclProps {}

Properties to create NetworkAcl

property networkAclName

readonly networkAclName?: string;

The name of the NetworkAcl.
It is not recommended to use an explicit name.
If you don't specify a networkAclName, AWS CloudFormation generates a unique physical ID and uses that ID for the group name.

property subnetSelection

readonly subnetSelection?: SubnetSelection;

Subnets in the given VPC to associate the ACL with
More subnets can always be added later by calling associateWithSubnets().
- No subnets associated

property vpc

readonly vpc: IVpc;

The VPC in which to create the NetworkACL.

interface PortProps

interface PortProps {}

Properties to create a port range

property fromPort

readonly fromPort?: number;

The starting port for the range
- Not included in the rule

property protocol

readonly protocol: Protocol;

The protocol for the range

property stringRepresentation

readonly stringRepresentation: string;

String representation for this object

property toPort

readonly toPort?: number;

The ending port for the range
- Not included in the rule

interface PrivateSubnetAttributes

interface PrivateSubnetAttributes extends SubnetAttributes {}

interface PrivateSubnetProps

interface PrivateSubnetProps extends SubnetProps {}

interface PublicSubnetAttributes

interface PublicSubnetAttributes extends SubnetAttributes {}

interface PublicSubnetProps

interface PublicSubnetProps extends SubnetProps {}

interface S3DownloadOptions

interface S3DownloadOptions {}

Options when downloading files from S3

property bucket

readonly bucket: IBucket;

Name of the S3 bucket to download from

property bucketKey

readonly bucketKey: string;

The key of the file to download

property localFile

readonly localFile?: string;

The name of the local file.
Linux - /tmp/bucketKey Windows - %TEMP%/bucketKey

property region

readonly region?: string;

The region of the S3 Bucket (needed for access via VPC Gateway) none

interface SecurityGroupImportOptions

interface SecurityGroupImportOptions {}

Additional options for imported security groups

property allowAllOutbound

readonly allowAllOutbound?: boolean;

Mark the SecurityGroup as having been created allowing all outbound traffic
Only if this is set to false will egress rules be added to this security group. Be aware, this would undo any potential "all outbound traffic" default.
true

property mutable

readonly mutable?: boolean;

If a SecurityGroup is mutable CDK can add rules to existing groups
Beware that making a SecurityGroup immutable might lead to issue due to missing ingress/egress rules for new resources.
true

interface SecurityGroupProps

interface SecurityGroupProps {}

property allowAllOutbound

readonly allowAllOutbound?: boolean;

Whether to allow all outbound traffic by default.
If this is set to true, there will only be a single egress rule which allows all outbound traffic. If this is set to false, no outbound traffic will be allowed by default and all egress traffic must be explicitly authorized.
true

property description

readonly description?: string;

A description of the security group.
The default name will be the construct's CDK path.

property disableInlineRules

readonly disableInlineRules?: boolean;

Whether to disable inline ingress and egress rule optimization.
If this is set to true, ingress and egress rules will not be declared under the SecurityGroup in cloudformation, but will be separate elements.
Inlining rules is an optimization for producing smaller stack templates. Sometimes this is not desirable, for example when security group access is managed via tags.
The default value can be overriden globally by setting the context variable '@aws-cdk/aws-ec2.securityGroupDisableInlineRules'.
false

property securityGroupName

readonly securityGroupName?: string;

The name of the security group. For valid values, see the GroupName parameter of the CreateSecurityGroup action in the Amazon EC2 API Reference.
It is not recommended to use an explicit group name.
If you don't specify a GroupName, AWS CloudFormation generates a unique physical ID and uses that ID for the group name.

property vpc

readonly vpc: IVpc;

The VPC in which to create the security group.

interface SelectedSubnets

interface SelectedSubnets {}

Result of selecting a subset of subnets from a VPC

property availabilityZones

readonly availabilityZones: string[];

The respective AZs of each subnet

property hasPublic

readonly hasPublic: boolean;

Whether any of the given subnets are from the VPC's public subnets.

property internetConnectivityEstablished

readonly internetConnectivityEstablished: IDependable;

Dependency representing internet connectivity for these subnets

property isPendingLookup

readonly isPendingLookup?: boolean;

The subnet selection is not actually real yet
If this value is true, don't validate anything about the subnets. The count or identities are not known yet, and the validation will most likely fail which will prevent a successful lookup.
false

property subnetIds

readonly subnetIds: string[];

The subnet IDs

property subnets

readonly subnets: ISubnet[];

Selected subnet objects

interface SsmParameterImageOptions

interface SsmParameterImageOptions {}

Properties for GenericSsmParameterImage

property cachedInContext

readonly cachedInContext?: boolean;

Whether the AMI ID is cached to be stable between deployments
By default, the newest image is used on each deployment. This will cause instances to be replaced whenever a new version is released, and may cause downtime if there aren't enough running instances in the AutoScalingGroup to reschedule the tasks on.
If set to true, the AMI ID will be cached in cdk.context.json and the same value will be used on future runs. Your instances will not be replaced but your AMI version will grow old over time. To refresh the AMI lookup, you will have to evict the value from the cache using the cdk context command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for more information.
Can not be set to true in environment-agnostic stacks.
false

property os

readonly os?: OperatingSystemType;

Operating system
OperatingSystemType.LINUX

property userData

readonly userData?: UserData;

Custom UserData
- UserData appropriate for the OS

interface SubnetAttributes

interface SubnetAttributes {}

property availabilityZone

readonly availabilityZone?: string;

The Availability Zone the subnet is located in
- No AZ information, cannot use AZ selection features

property ipv4CidrBlock

readonly ipv4CidrBlock?: string;

The IPv4 CIDR block associated with the subnet
- No CIDR information, cannot use CIDR filter features

property routeTableId

readonly routeTableId?: string;

The ID of the route table for this particular subnet
- No route table information, cannot create VPC endpoints

property subnetId

readonly subnetId: string;

The subnetId for this particular subnet

interface SubnetConfiguration

interface SubnetConfiguration {}

Specify configuration parameters for a single subnet group in a VPC.

property cidrMask

readonly cidrMask?: number;

The number of leading 1 bits in the routing mask.
The number of available IP addresses in each subnet of this group will be equal to 2^(32 - cidrMask) - 2.
Valid values are 16--28.
- Available IP space is evenly divided across subnets.

property mapPublicIpOnLaunch

readonly mapPublicIpOnLaunch?: boolean;

Controls if a public IP is associated to an instance at launch
true in Subnet.Public, false in Subnet.Private or Subnet.Isolated.

property name

readonly name: string;

Logical name for the subnet group.
This name can be used when selecting VPC subnets to distinguish between different subnet groups of the same type.

property reserved

readonly reserved?: boolean;

Controls if subnet IP space needs to be reserved.
When true, the IP space for the subnet is reserved but no actual resources are provisioned. This space is only dependent on the number of availability zones and on cidrMask - all other subnet properties are ignored.
false

property subnetType

readonly subnetType: SubnetType;

The type of Subnet to configure.
The Subnet type will control the ability to route and connect to the Internet.

interface SubnetNetworkAclAssociationProps

interface SubnetNetworkAclAssociationProps {}

Properties to create a SubnetNetworkAclAssociation

property networkAcl

readonly networkAcl: INetworkAcl;

The Network ACL this association is defined for

property subnet

readonly subnet: ISubnet;

ID of the Subnet

property subnetNetworkAclAssociationName

readonly subnetNetworkAclAssociationName?: string;

The name of the SubnetNetworkAclAssociation.
It is not recommended to use an explicit name.
If you don't specify a SubnetNetworkAclAssociationName, AWS CloudFormation generates a unique physical ID and uses that ID for the group name.

interface SubnetProps

interface SubnetProps {}

Specify configuration parameters for a VPC subnet

property availabilityZone

readonly availabilityZone: string;

The availability zone for the subnet

property cidrBlock

readonly cidrBlock: string;

The CIDR notation for this subnet

property mapPublicIpOnLaunch

readonly mapPublicIpOnLaunch?: boolean;

Controls if a public IP is associated to an instance at launch
true in Subnet.Public, false in Subnet.Private or Subnet.Isolated.

property vpcId

readonly vpcId: string;

The VPC which this subnet is part of

interface SubnetSelection

interface SubnetSelection {}

Customize subnets that are selected for placement of ENIs
Constructs that allow customization of VPC placement use parameters of this type to provide placement settings.
By default, the instances are placed in the private subnets.

property availabilityZones

readonly availabilityZones?: string[];

Select subnets only in the given AZs.
no filtering on AZs is done

property onePerAz

readonly onePerAz?: boolean;

If true, return at most one subnet per AZ
false

property subnetFilters

readonly subnetFilters?: SubnetFilter[];

List of provided subnet filters.
- none

property subnetGroupName

readonly subnetGroupName?: string;

Select the subnet group with the given name
Select the subnet group with the given name. This only needs to be used if you have multiple subnet groups of the same type and you need to distinguish between them. Otherwise, prefer subnetType.
This field does not select individual subnets, it selects all subnets that share the given subnet group name. This is the name supplied in subnetConfiguration.
At most one of subnetType and subnetGroupName can be supplied.
- Selection by type instead of by name

property subnetName

readonly subnetName?: string;

Alias for subnetGroupName
Select the subnet group with the given name. This only needs to be used if you have multiple subnet groups of the same type and you need to distinguish between them.
Deprecated
Use subnetGroupName instead

property subnets

readonly subnets?: ISubnet[];

Explicitly select individual subnets
Use this if you don't want to automatically use all subnets in a group, but have a need to control selection down to individual subnets.
Cannot be specified together with subnetType or subnetGroupName.
- Use all subnets in a selected group (all private subnets by default)

property subnetType

readonly subnetType?: SubnetType;

Select all subnets of the given type
At most one of subnetType and subnetGroupName can be supplied.
SubnetType.PRIVATE_WITH_NAT (or ISOLATED or PUBLIC if there are no PRIVATE_WITH_NAT subnets)

interface VolumeAttributes

interface VolumeAttributes {}

Attributes required to import an existing EBS Volume into the Stack.

property availabilityZone

readonly availabilityZone: string;

The availability zone that the EBS Volume is contained within (ex: us-west-2a)

property encryptionKey

readonly encryptionKey?: IKey;

The customer-managed encryption key that is used to encrypt the Volume.
None -- The EBS Volume is not using a customer-managed KMS key for encryption.

property volumeId

readonly volumeId: string;

The EBS Volume's ID

interface VolumeProps

interface VolumeProps {}

Properties of an EBS Volume

property autoEnableIo

readonly autoEnableIo?: boolean;

Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.
false

property availabilityZone

readonly availabilityZone: string;

The Availability Zone in which to create the volume.

property enableMultiAttach

readonly enableMultiAttach?: boolean;

Indicates whether Amazon EBS Multi-Attach is enabled. See Considerations and limitations for the constraints of multi-attach.
false

property encrypted

readonly encrypted?: boolean;

Specifies whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by Default in the Amazon Elastic Compute Cloud User Guide.
Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types.
false

property encryptionKey

readonly encryptionKey?: IKey;

The customer-managed encryption key that is used to encrypt the Volume. The encrypted property must be true if this is provided.
Note: If using an created from a here, then the KMS key **must** have the following in its Key policy; otherwise, the Volume will fail to create.
{ "Effect": "Allow", "Principal": { "AWS": "<arn for your account-user> ex: arn:aws:iam::00000000000:root" }, "Resource": "*", "Action": [ "kms:DescribeKey", "kms:GenerateDataKeyWithoutPlainText", ], "Condition": { "StringEquals": { "kms:ViaService": "ec2..amazonaws.com", (eg: ec2.us-east-1.amazonaws.com) "kms:CallerAccount": "0000000000" (your account ID) } } }
The default KMS key for the account, region, and EC2 service is used.

property iops

readonly iops?: number;

The number of I/O operations per second (IOPS) to provision for the volume. The maximum ratio is 50 IOPS/GiB for PROVISIONED_IOPS_SSD, and 500 IOPS/GiB for both PROVISIONED_IOPS_SSD_IO2 and GENERAL_PURPOSE_SSD_GP3. See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html for more information.
This parameter is valid only for PROVISIONED_IOPS_SSD, PROVISIONED_IOPS_SSD_IO2 and GENERAL_PURPOSE_SSD_GP3 volumes.
None -- Required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS if omitted.

property removalPolicy

readonly removalPolicy?: RemovalPolicy;

Policy to apply when the volume is removed from the stack
RemovalPolicy.RETAIN

property size

readonly size?: Size;

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html for details on the allowable size for each type of volume.
If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

property snapshotId

readonly snapshotId?: string;

The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
The EBS volume is not created from a snapshot.

property volumeName

readonly volumeName?: string;

The value of the physicalName property of this resource.
The physical name will be allocated by CloudFormation at deployment time

property volumeType

readonly volumeType?: EbsDeviceVolumeType;

The type of the volume; what type of storage to use to form the EBS Volume.
EbsDeviceVolumeType.GENERAL_PURPOSE_SSD

interface VpcAttributes

interface VpcAttributes {}

Properties that reference an external Vpc

property availabilityZones

readonly availabilityZones: string[];

List of availability zones for the subnets in this VPC.

property isolatedSubnetIds

readonly isolatedSubnetIds?: string[];

List of isolated subnet IDs
Must be undefined or match the availability zones in length and order.

property isolatedSubnetNames

readonly isolatedSubnetNames?: string[];

List of names for the isolated subnets
Must be undefined or have a name for every isolated subnet group.

property isolatedSubnetRouteTableIds

readonly isolatedSubnetRouteTableIds?: string[];

List of IDs of routing tables for the isolated subnets.
Must be undefined or have a name for every isolated subnet group.

property privateSubnetIds

readonly privateSubnetIds?: string[];

List of private subnet IDs
Must be undefined or match the availability zones in length and order.

property privateSubnetNames

readonly privateSubnetNames?: string[];

List of names for the private subnets
Must be undefined or have a name for every private subnet group.

property privateSubnetRouteTableIds

readonly privateSubnetRouteTableIds?: string[];

List of IDs of routing tables for the private subnets.
Must be undefined or have a name for every private subnet group.

property publicSubnetIds

readonly publicSubnetIds?: string[];

List of public subnet IDs
Must be undefined or match the availability zones in length and order.

property publicSubnetNames

readonly publicSubnetNames?: string[];

List of names for the public subnets
Must be undefined or have a name for every public subnet group.

property publicSubnetRouteTableIds

readonly publicSubnetRouteTableIds?: string[];

List of IDs of routing tables for the public subnets.
Must be undefined or have a name for every public subnet group.

property vpcCidrBlock

readonly vpcCidrBlock?: string;

VPC's CIDR range
- Retrieving the CIDR from the VPC will fail

property vpcId

readonly vpcId: string;

VPC's identifier

property vpnGatewayId

readonly vpnGatewayId?: string;

VPN gateway's identifier

interface VpcEndpointServiceProps

interface VpcEndpointServiceProps {}

Construction properties for a VpcEndpointService.

property acceptanceRequired

readonly acceptanceRequired?: boolean;

Whether requests from service consumers to connect to the service through an endpoint must be accepted. true

property allowedPrincipals

readonly allowedPrincipals?: ArnPrincipal[];

IAM users, IAM roles, or AWS accounts to allow inbound connections from. These principals can connect to your service using VPC endpoints. Takes a list of one or more ArnPrincipal. - no principals

property vpcEndpointServiceLoadBalancers

readonly vpcEndpointServiceLoadBalancers: IVpcEndpointServiceLoadBalancer[];

One or more load balancers to host the VPC Endpoint Service.

property vpcEndpointServiceName

readonly vpcEndpointServiceName?: string;

Name of the Vpc Endpoint Service
Deprecated
This property is not used - CDK generated name

property whitelistedPrincipals

readonly whitelistedPrincipals?: ArnPrincipal[];

IAM users, IAM roles, or AWS accounts to allow inbound connections from. These principals can connect to your service using VPC endpoints. Takes a list of one or more ArnPrincipal. - no principals
Deprecated
use allowedPrincipals

interface VpcLookupOptions

interface VpcLookupOptions {}

Properties for looking up an existing VPC.
The combination of properties must specify filter down to exactly one non-default VPC, otherwise an error is raised.

property isDefault

readonly isDefault?: boolean;

Whether to match the default VPC
Don't care whether we return the default VPC

property region

readonly region?: string;

Optional to override inferred region
Current stack's environment region

property subnetGroupNameTag

readonly subnetGroupNameTag?: string;

Optional tag for subnet group name. If not provided, we'll look at the aws-cdk:subnet-name tag. If the subnet does not have the specified tag, we'll use its type as the name.
aws-cdk:subnet-name

property tags

readonly tags?: {
    [key: string]: string;
};

Tags on the VPC
The VPC must have all of these tags
Don't filter on tags

property vpcId

readonly vpcId?: string;

The ID of the VPC
If given, will import exactly this VPC.
Don't filter on vpcId

property vpcName

readonly vpcName?: string;

The name of the VPC
If given, will import the VPC with this name.
Don't filter on vpcName

interface VpcProps

interface VpcProps {}

Configuration for Vpc

property cidr

readonly cidr?: string;

The CIDR range to use for the VPC, e.g. '10.0.0.0/16'.
Should be a minimum of /28 and maximum size of /16. The range will be split across all subnets per Availability Zone.
Vpc.DEFAULT_CIDR_RANGE

property defaultInstanceTenancy

readonly defaultInstanceTenancy?: DefaultInstanceTenancy;

The default tenancy of instances launched into the VPC.
By setting this to dedicated tenancy, instances will be launched on hardware dedicated to a single AWS customer, unless specifically specified at instance launch time. Please note, not all instance types are usable with Dedicated tenancy.
DefaultInstanceTenancy.Default (shared) tenancy

property enableDnsHostnames

readonly enableDnsHostnames?: boolean;

Indicates whether the instances launched in the VPC get public DNS hostnames.
If this attribute is true, instances in the VPC get public DNS hostnames, but only if the enableDnsSupport attribute is also set to true.
true

property enableDnsSupport

readonly enableDnsSupport?: boolean;

Indicates whether the DNS resolution is supported for the VPC.
If this attribute is false, the Amazon-provided DNS server in the VPC that resolves public DNS hostnames to IP addresses is not enabled. If this attribute is true, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC IPv4 network range plus two will succeed.
true

property flowLogs

readonly flowLogs?: {
    [id: string]: FlowLogOptions;
};

Flow logs to add to this VPC.
- No flow logs.

property gatewayEndpoints

readonly gatewayEndpoints?: {
    [id: string]: GatewayVpcEndpointOptions;
};

Gateway endpoints to add to this VPC.
- None.

property maxAzs

readonly maxAzs?: number;

Define the maximum number of AZs to use in this region
If the region has more AZs than you want to use (for example, because of EIP limits), pick a lower number here. The AZs will be sorted and picked from the start of the list.
If you pick a higher number than the number of AZs in the region, all AZs in the region will be selected. To use "all AZs" available to your account, use a high number (such as 99).
Be aware that environment-agnostic stacks will be created with access to only 2 AZs, so to use more than 2 AZs, be sure to specify the account and region on your stack.
3

property natGatewayProvider

readonly natGatewayProvider?: NatProvider;

What type of NAT provider to use
Select between NAT gateways or NAT instances. NAT gateways may not be available in all AWS regions.
NatProvider.gateway()

property natGateways

readonly natGateways?: number;

The number of NAT Gateways/Instances to create.
The type of NAT gateway or instance will be determined by the natGatewayProvider parameter.
You can set this number lower than the number of Availability Zones in your VPC in order to save on NAT cost. Be aware you may be charged for cross-AZ data traffic instead.
- One NAT gateway/instance per Availability Zone

property natGatewaySubnets

readonly natGatewaySubnets?: SubnetSelection;

Configures the subnets which will have NAT Gateways/Instances
You can pick a specific group of subnets by specifying the group name; the picked subnets must be public subnets.
Only necessary if you have more than one public subnet group.
- All public subnets.

property subnetConfiguration

readonly subnetConfiguration?: SubnetConfiguration[];

Configure the subnets to build for each AZ

Each entry in this list configures a Subnet Group; each group will contain a subnet for each Availability Zone.

For example, if you want 1 public subnet, 1 private subnet, and 1 isolated subnet in each AZ provide the following:

new ec2.Vpc(this, 'VPC', {
  subnetConfiguration: [
     {
       cidrMask: 24,
       name: 'ingress',
       subnetType: ec2.SubnetType.PUBLIC,
     },
     {
       cidrMask: 24,
       name: 'application',
       subnetType: ec2.SubnetType.PRIVATE_WITH_NAT,
     },
     {
       cidrMask: 28,
       name: 'rds',
       subnetType: ec2.SubnetType.PRIVATE_ISOLATED,
     }
  ]
});

- The VPC CIDR will be evenly divided between 1 public and 1 private subnet per AZ.

property vpcName

readonly vpcName?: string;

The VPC name.
Since the VPC resource doesn't support providing a physical name, the value provided here will be recorded in the Name tag
this.node.path

property vpnConnections

readonly vpnConnections?: {
    [id: string]: VpnConnectionOptions;
};

VPN connections to this VPC.
- No connections.

property vpnGateway

readonly vpnGateway?: boolean;

Indicates whether a VPN gateway should be created and attached to this VPC.
- true when vpnGatewayAsn or vpnConnections is specified

property vpnGatewayAsn

readonly vpnGatewayAsn?: number;

The private Autonomous System Number (ASN) for the VPN gateway.
- Amazon default ASN.

property vpnRoutePropagation

readonly vpnRoutePropagation?: SubnetSelection[];

Where to propagate VPN routes.
- On the route tables associated with private subnets. If no private subnets exists, isolated subnets are used. If no isolated subnets exists, public subnets are used.

interface VpnConnectionAttributes

interface VpnConnectionAttributes {}

Attributes of an imported VpnConnection.

property customerGatewayAsn

readonly customerGatewayAsn: number;

The ASN of the customer gateway.

property customerGatewayId

readonly customerGatewayId: string;

The id of the customer gateway.

property customerGatewayIp

readonly customerGatewayIp: string;

The ip address of the customer gateway.

property vpnId

readonly vpnId: string;

The id of the VPN connection.

interface VpnConnectionBase

interface VpnConnectionBase {}

method metric

metric: (
    metricName: string,
    props?: cloudwatch.MetricOptions
) => cloudwatch.Metric;

Return the given named metric for this VPNConnection

method metricTunnelDataIn

metricTunnelDataIn: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;

The bytes received through the VPN tunnel.
Sum over 5 minutes

method metricTunnelDataOut

metricTunnelDataOut: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;

The bytes sent through the VPN tunnel.
Sum over 5 minutes

method metricTunnelState

metricTunnelState: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;

The state of the tunnel. 0 indicates DOWN and 1 indicates UP.
Average over 5 minutes

interface VpnConnectionOptions

interface VpnConnectionOptions {}

property asn

readonly asn?: number;

The ASN of the customer gateway.
65000

property ip

readonly ip: string;

The ip address of the customer gateway.

property staticRoutes

readonly staticRoutes?: string[];

The static routes to be routed from the VPN gateway to the customer gateway.
Dynamic routing (BGP)

property tunnelOptions

readonly tunnelOptions?: VpnTunnelOption[];

The tunnel options for the VPN connection. At most two elements (one per tunnel). Duplicates not allowed.
Amazon generated tunnel options

interface VpnConnectionProps

interface VpnConnectionProps extends VpnConnectionOptions {}

property vpc

readonly vpc: IVpc;

The VPC to connect to.

interface VpnGatewayProps

interface VpnGatewayProps {}

The VpnGateway Properties

property amazonSideAsn

readonly amazonSideAsn?: number;

Explicitly specify an Asn or let aws pick an Asn for you. 65000

property type

readonly type: string;

Default type ipsec.1

interface VpnTunnelOption

interface VpnTunnelOption {}

property preSharedKey

readonly preSharedKey?: string;

The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway. Allowed characters are alphanumeric characters period . and underscores _. Must be between 8 and 64 characters in length and cannot start with zero (0).
an Amazon generated pre-shared key
Deprecated
Use preSharedKeySecret instead

property preSharedKeySecret

readonly preSharedKeySecret?: SecretValue;

The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway. Allowed characters are alphanumeric characters period . and underscores _. Must be between 8 and 64 characters in length and cannot start with zero (0).
an Amazon generated pre-shared key

property tunnelInsideCidr

readonly tunnelInsideCidr?: string;

The range of inside IP addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway. A size /30 CIDR block from the 169.254.0.0/16 range.
an Amazon generated inside IP CIDR

interface WindowsImageProps

interface WindowsImageProps {}

Configuration options for WindowsImage

property userData

readonly userData?: UserData;

Initial user data
- Empty UserData for Windows machines

Enums

enum Action

enum Action {
    ALLOW = 'allow',
    DENY = 'deny',
}

What action to apply to traffic matching the ACL

member ALLOW

ALLOW = 'allow'

Allow the traffic

member DENY

DENY = 'deny'

Deny the traffic

enum AmazonLinuxCpuType

enum AmazonLinuxCpuType {
    ARM_64 = 'arm64',
    X86_64 = 'x86_64',
}

CPU type

member ARM_64

ARM_64 = 'arm64'

arm64 CPU type

member X86_64

X86_64 = 'x86_64'

x86_64 CPU type

enum AmazonLinuxEdition

enum AmazonLinuxEdition {
    STANDARD = 'standard',
    MINIMAL = 'minimal',
}

Amazon Linux edition

member MINIMAL

MINIMAL = 'minimal'

Minimal edition

member STANDARD

STANDARD = 'standard'

Standard edition

enum AmazonLinuxGeneration

enum AmazonLinuxGeneration {
    AMAZON_LINUX = 'amzn',
    AMAZON_LINUX_2 = 'amzn2',
    AMAZON_LINUX_2022 = 'al2022',
}

What generation of Amazon Linux to use

member AMAZON_LINUX

AMAZON_LINUX = 'amzn'

Amazon Linux

member AMAZON_LINUX_2

AMAZON_LINUX_2 = 'amzn2'

Amazon Linux 2

member AMAZON_LINUX_2022

AMAZON_LINUX_2022 = 'al2022'

Amazon Linux 2022

enum AmazonLinuxKernel

enum AmazonLinuxKernel {
    KERNEL5_X = 'kernel-5.10',
}

Amazon Linux Kernel

member KERNEL5_X

KERNEL5_X = 'kernel-5.10'

Standard edition

enum AmazonLinuxStorage

enum AmazonLinuxStorage {
    EBS = 'ebs',
    S3 = 's3',
    GENERAL_PURPOSE = 'gp2',
}

member EBS

EBS = 'ebs'

EBS-backed storage

member GENERAL_PURPOSE

GENERAL_PURPOSE = 'gp2'

General Purpose-based storage (recommended)

member S3

S3 = 's3'

S3-backed storage

enum AmazonLinuxVirt

enum AmazonLinuxVirt {
    HVM = 'hvm',
    PV = 'pv',
}

Virtualization type for Amazon Linux

member HVM

HVM = 'hvm'

HVM virtualization (recommended)

member PV

PV = 'pv'

PV virtualization

enum ClientVpnSessionTimeout

enum ClientVpnSessionTimeout {
    EIGHT_HOURS = 8,
    TEN_HOURS = 10,
    TWELVE_HOURS = 12,
    TWENTY_FOUR_HOURS = 24,
}

Maximum VPN session duration time

member EIGHT_HOURS

EIGHT_HOURS = 8

8 hours

member TEN_HOURS

TEN_HOURS = 10

10 hours

member TWELVE_HOURS

TWELVE_HOURS = 12

12 hours

member TWENTY_FOUR_HOURS

TWENTY_FOUR_HOURS = 24

24 hours

enum CpuCredits

enum CpuCredits {
    STANDARD = 'standard',
    UNLIMITED = 'unlimited',
}

Provides the options for specifying the CPU credit type for burstable EC2 instance types (T2, T3, T3a, etc).
See Also
- https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-how-to.html

member STANDARD

STANDARD = 'standard'

Standard bursting mode.
See Also
- https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-standard-mode.html

member UNLIMITED

UNLIMITED = 'unlimited'

Unlimited bursting mode.
See Also
- https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode.html

enum DefaultInstanceTenancy

enum DefaultInstanceTenancy {
    DEFAULT = 'default',
    DEDICATED = 'dedicated',
}

The default tenancy of instances launched into the VPC.

member DEDICATED

DEDICATED = 'dedicated'

Any instance launched into the VPC automatically has dedicated tenancy, unless you launch it with the default tenancy.

member DEFAULT

DEFAULT = 'default'

Instances can be launched with any tenancy.

enum EbsDeviceVolumeType

enum EbsDeviceVolumeType {
    STANDARD = 'standard',
    IO1 = 'io1',
    IO2 = 'io2',
    GP2 = 'gp2',
    GP3 = 'gp3',
    ST1 = 'st1',
    SC1 = 'sc1',
    GENERAL_PURPOSE_SSD = 'gp2',
    GENERAL_PURPOSE_SSD_GP3 = 'gp3',
    PROVISIONED_IOPS_SSD = 'io1',
    PROVISIONED_IOPS_SSD_IO2 = 'io2',
    THROUGHPUT_OPTIMIZED_HDD = 'st1',
    COLD_HDD = 'sc1',
    MAGNETIC = 'standard',
}

Supported EBS volume types for blockDevices

member COLD_HDD

COLD_HDD = 'sc1'

Lowest cost HDD volume designed for less frequently accessed workloads.

member GENERAL_PURPOSE_SSD

GENERAL_PURPOSE_SSD = 'gp2'

General purpose SSD volume (GP2) that balances price and performance for a wide variety of workloads.

member GENERAL_PURPOSE_SSD_GP3

GENERAL_PURPOSE_SSD_GP3 = 'gp3'

General purpose SSD volume (GP3) that balances price and performance for a wide variety of workloads.

member GP2

GP2 = 'gp2'

General Purpose SSD - GP2

member GP3

GP3 = 'gp3'

General Purpose SSD - GP3

member IO1

IO1 = 'io1'

Provisioned IOPS SSD - IO1

member IO2

IO2 = 'io2'

Provisioned IOPS SSD - IO2

member MAGNETIC

MAGNETIC = 'standard'

Magnetic volumes are backed by magnetic drives and are suited for workloads where data is accessed infrequently, and scenarios where low-cost storage for small volume sizes is important.

member PROVISIONED_IOPS_SSD

PROVISIONED_IOPS_SSD = 'io1'

Highest-performance SSD volume (IO1) for mission-critical low-latency or high-throughput workloads.

member PROVISIONED_IOPS_SSD_IO2

PROVISIONED_IOPS_SSD_IO2 = 'io2'

Highest-performance SSD volume (IO2) for mission-critical low-latency or high-throughput workloads.

member SC1

SC1 = 'sc1'

Cold HDD

member ST1

ST1 = 'st1'

Throughput Optimized HDD

member STANDARD

STANDARD = 'standard'

Magnetic

member THROUGHPUT_OPTIMIZED_HDD

THROUGHPUT_OPTIMIZED_HDD = 'st1'

Low-cost HDD volume designed for frequently accessed, throughput-intensive workloads.

enum FlowLogDestinationType

enum FlowLogDestinationType {
    CLOUD_WATCH_LOGS = 'cloud-watch-logs',
    S3 = 's3',
}

The available destination types for Flow Logs

member CLOUD_WATCH_LOGS

CLOUD_WATCH_LOGS = 'cloud-watch-logs'

Send flow logs to CloudWatch Logs Group

member S3

S3 = 's3'

Send flow logs to S3 Bucket

enum FlowLogTrafficType

enum FlowLogTrafficType {
    ACCEPT = 'ACCEPT',
    ALL = 'ALL',
    REJECT = 'REJECT',
}

The type of VPC traffic to log

member ACCEPT

ACCEPT = 'ACCEPT'

Only log accepts

member ALL

ALL = 'ALL'

Log all requests

member REJECT

REJECT = 'REJECT'

Only log rejects

enum InstanceArchitecture

enum InstanceArchitecture {
    ARM_64 = 'arm64',
    X86_64 = 'x86_64',
}

Identifies an instance's CPU architecture

member ARM_64

ARM_64 = 'arm64'

ARM64 architecture

member X86_64

X86_64 = 'x86_64'

x86-64 architecture

enum InstanceClass

enum InstanceClass {
    STANDARD3 = 'standard3',
    M3 = 'm3',
    STANDARD4 = 'standard4',
    M4 = 'm4',
    STANDARD5 = 'standard5',
    M5 = 'm5',
    STANDARD5_NVME_DRIVE = 'standard5-nvme-drive',
    M5D = 'm5d',
    STANDARD5_AMD = 'standard5-amd',
    M5A = 'm5a',
    STANDARD5_AMD_NVME_DRIVE = 'standard5-amd-nvme-drive',
    M5AD = 'm5ad',
    STANDARD5_HIGH_PERFORMANCE = 'standard5-high-performance',
    M5N = 'm5n',
    STANDARD5_NVME_DRIVE_HIGH_PERFORMANCE = 'standard5-nvme-drive-high-performance',
    M5DN = 'm5dn',
    STANDARD5_HIGH_COMPUTE = 'standard5-high-compute',
    M5ZN = 'm5zn',
    MEMORY3 = 'memory3',
    R3 = 'r3',
    MEMORY4 = 'memory4',
    R4 = 'r4',
    MEMORY5 = 'memory5',
    R5 = 'r5',
    MEMORY6_INTEL = 'memory6-intel',
    R6I = 'r6i',
    MEMORY5_HIGH_PERFORMANCE = 'memory5-high-performance',
    R5N = 'r5n',
    MEMORY5_NVME_DRIVE = 'memory5-nvme-drive',
    R5D = 'r5d',
    MEMORY5_NVME_DRIVE_HIGH_PERFORMANCE = 'memory5-nvme-drive-high-performance',
    R5DN = 'r5dn',
    MEMORY5_AMD = 'memory5-amd',
    R5A = 'r5a',
    MEMORY5_AMD_NVME_DRIVE = 'memory5-amd-nvme-drive',
    HIGH_MEMORY_6TB_1 = 'high-memory-6tb-1',
    U_6TB1 = 'u-6tb1',
    HIGH_MEMORY_9TB_1 = 'high-memory-9tb-1',
    U_9TB1 = 'u-9tb1',
    HIGH_MEMORY_12TB_1 = 'high-memory-12tb-1',
    U_12TB1 = 'u-12tb1',
    HIGH_MEMORY_18TB_1 = 'high-memory-18tb-1',
    U_18TB1 = 'u-18tb1',
    HIGH_MEMORY_24TB_1 = 'high-memory-24tb-1',
    U_24TB1 = 'u-24tb1',
    R5AD = 'r5ad',
    MEMORY5_EBS_OPTIMIZED = 'memory5-ebs-optimized',
    R5B = 'r5b',
    MEMORY6_GRAVITON = 'memory6-graviton',
    R6G = 'r6g',
    MEMORY6_GRAVITON2_NVME_DRIVE = 'memory6-graviton2-nvme-drive',
    R6GD = 'r6gd',
    COMPUTE3 = 'compute3',
    C3 = 'c3',
    COMPUTE4 = 'compute4',
    C4 = 'c4',
    COMPUTE5 = 'compute5',
    C5 = 'c5',
    COMPUTE5_NVME_DRIVE = 'compute5-nvme-drive',
    C5D = 'c5d',
    COMPUTE5_AMD = 'compute5-amd',
    C5A = 'c5a',
    COMPUTE5_AMD_NVME_DRIVE = 'compute5-amd-nvme-drive',
    C5AD = 'c5ad',
    COMPUTE5_HIGH_PERFORMANCE = 'compute5-high-performance',
    C5N = 'c5n',
    COMPUTE6_INTEL = 'compute6-intel',
    C6I = 'c6i',
    COMPUTE6_AMD = 'compute6-amd',
    C6A = 'c6a',
    COMPUTE6_GRAVITON2 = 'compute6-graviton2',
    C6G = 'c6g',
    COMPUTE6_GRAVITON2_NVME_DRIVE = 'compute6-graviton2-nvme-drive',
    C6GD = 'c6gd',
    COMPUTE6_GRAVITON2_HIGH_NETWORK_BANDWITH = 'compute6-graviton2-high-network-banwidth',
    COMPUTE6_GRAVITON2_HIGH_NETWORK_BANDWIDTH = 'compute6-graviton2-high-network-bandwidth',
    C6GN = 'c6gn',
    STORAGE2 = 'storage2',
    D2 = 'd2',
    STORAGE3 = 'storage3',
    D3 = 'd3',
    STORAGE3_ENHANCED_NETWORK = 'storage3-enhanced-network',
    D3EN = 'd3en',
    STORAGE_COMPUTE_1 = 'storage-compute-1',
    H1 = 'h1',
    IO3 = 'io3',
    I3 = 'i3',
    IO3_DENSE_NVME_DRIVE = 'io3-dense-nvme-drive',
    I3EN = 'i3en',
    IO4_INTEL = 'io4_intel',
    I4I = 'i4i',
    STORAGE4_GRAVITON_NETWORK_OPTIMIZED = 'storage4-graviton-network-optimized',
    IM4GN = 'im4gn',
    STORAGE4_GRAVITON_NETWORK_STORAGE_OPTIMIZED = 'storage4-graviton-network-storage-optimized',
    IS4GEN = 'is4gen',
    BURSTABLE2 = 'burstable2',
    T2 = 't2',
    BURSTABLE3 = 'burstable3',
    T3 = 't3',
    BURSTABLE3_AMD = 'burstable3-amd',
    T3A = 't3a',
    BURSTABLE4_GRAVITON = 'burstable4-graviton',
    T4G = 't4g',
    MEMORY_INTENSIVE_1 = 'memory-intensive-1',
    X1 = 'x1',
    MEMORY_INTENSIVE_1_EXTENDED = 'memory-intensive-1-extended',
    X1E = 'x1e',
    MEMORY_INTENSIVE_2_GRAVITON2 = 'memory-intensive-2-graviton2',
    X2G = 'x2g',
    MEMORY_INTENSIVE_2_GRAVITON2_NVME_DRIVE = 'memory-intensive-2-graviton2-nvme-drive',
    X2GD = 'x2gd',
    MEMORY_INTENSIVE_2_XT_INTEL = 'memory_intensive_2_xt_intel',
    X2IEDN = 'x2iedn',
    MEMORY_INTENSIVE_2_INTEL = 'memory_intensive_2_intel',
    X2IDN = 'x2idn',
    MEMORY_INTENSIVE_2_XTZ_INTEL = 'memory_intensive_2_xtz_intel',
    X2IEZN = 'x2iezn',
    FPGA1 = 'fpga1',
    F1 = 'f1',
    GRAPHICS3 = 'graphics3',
    G3 = 'g3',
    GRAPHICS4_NVME_DRIVE_HIGH_PERFORMANCE = 'graphics4-nvme-drive-high-performance',
    G4DN = 'g4dn',
    GRAPHICS4_AMD_NVME_DRIVE = 'graphics4-amd-nvme-drive',
    G4AD = 'g4ad',
    GRAPHICS5 = 'graphics5',
    G5 = 'g5',
    GRAPHICS5_GRAVITON2 = 'graphics5-graviton2',
    G5G = 'g5g',
    PARALLEL2 = 'parallel2',
    P2 = 'p2',
    PARALLEL3 = 'parallel3',
    P3 = 'p3',
    PARALLEL4 = 'parallel4',
    P4D = 'p4d',
    ARM1 = 'arm1',
    A1 = 'a1',
    STANDARD6_GRAVITON = 'standard6-graviton',
    M6G = 'm6g',
    STANDARD6_INTEL = 'standard6-intel',
    M6I = 'm6i',
    STANDARD6_AMD = 'standard6-amd',
    M6A = 'm6a',
    STANDARD6_GRAVITON2_NVME_DRIVE = 'standard6-graviton2-nvme-drive',
    M6GD = 'm6gd',
    HIGH_COMPUTE_MEMORY1 = 'high-compute-memory1',
    Z1D = 'z1d',
    INFERENCE1 = 'inference1',
    INF1 = 'inf1',
    MACINTOSH1_INTEL = 'macintosh1-intel',
    MAC1 = 'mac1',
    VIDEO_TRANSCODING1 = 'video-transcoding1',
    VT1 = 'vt1',
    HIGH_PERFORMANCE_COMPUTING6_AMD = 'high-performance-computing6-amd',
    HPC6A = 'hpc6a',
}

What class and generation of instance to use
We have both symbolic and concrete enums for every type.
The first are for people that want to specify by purpose, the second one are for people who already know exactly what 'R4' means.

member A1

A1 = 'a1'

Arm processor based instances, 1st generation

member ARM1

ARM1 = 'arm1'

Arm processor based instances, 1st generation

member BURSTABLE2

BURSTABLE2 = 'burstable2'

Burstable instances, 2nd generation

member BURSTABLE3

BURSTABLE3 = 'burstable3'

Burstable instances, 3rd generation

member BURSTABLE3_AMD

BURSTABLE3_AMD = 'burstable3-amd'

Burstable instances based on AMD EPYC, 3rd generation

member BURSTABLE4_GRAVITON

BURSTABLE4_GRAVITON = 'burstable4-graviton'

Burstable instances, 4th generation with Graviton2 processors

member C3

C3 = 'c3'

Compute optimized instances, 3rd generation

member C4

C4 = 'c4'

Compute optimized instances, 4th generation

member C5

C5 = 'c5'

Compute optimized instances, 5th generation

member C5A

C5A = 'c5a'

Compute optimized instances based on AMD EPYC, 5th generation

member C5AD

C5AD = 'c5ad'

Compute optimized instances with local NVME drive based on AMD EPYC, 5th generation

member C5D

C5D = 'c5d'

Compute optimized instances with local NVME drive, 5th generation

member C5N

C5N = 'c5n'

Compute optimized instances for high performance computing, 5th generation

member C6A

C6A = 'c6a'

Compute optimized instances based on AMD EPYC (codename Milan), 6th generation

member C6G

C6G = 'c6g'

Compute optimized instances for high performance computing, 6th generation with Graviton2 processors

member C6GD

C6GD = 'c6gd'

Compute optimized instances for high performance computing, 6th generation with Graviton2 processors and local NVME drive

member C6GN

C6GN = 'c6gn'

Compute optimized instances for high performance computing, 6th generation with Graviton2 processors and high network bandwidth capabilities

member C6I

C6I = 'c6i'

Compute optimized instances, 6th generation

member COMPUTE3

COMPUTE3 = 'compute3'

Compute optimized instances, 3rd generation

member COMPUTE4

COMPUTE4 = 'compute4'

Compute optimized instances, 4th generation

member COMPUTE5

COMPUTE5 = 'compute5'

Compute optimized instances, 5th generation

member COMPUTE5_AMD

COMPUTE5_AMD = 'compute5-amd'

Compute optimized instances based on AMD EPYC, 5th generation

member COMPUTE5_AMD_NVME_DRIVE

COMPUTE5_AMD_NVME_DRIVE = 'compute5-amd-nvme-drive'

Compute optimized instances with local NVME drive based on AMD EPYC, 5th generation

member COMPUTE5_HIGH_PERFORMANCE

COMPUTE5_HIGH_PERFORMANCE = 'compute5-high-performance'

Compute optimized instances for high performance computing, 5th generation

member COMPUTE5_NVME_DRIVE

COMPUTE5_NVME_DRIVE = 'compute5-nvme-drive'

Compute optimized instances with local NVME drive, 5th generation

member COMPUTE6_AMD

COMPUTE6_AMD = 'compute6-amd'

Compute optimized instances based on AMD EPYC (codename Milan), 6th generation

member COMPUTE6_GRAVITON2

COMPUTE6_GRAVITON2 = 'compute6-graviton2'

Compute optimized instances for high performance computing, 6th generation with Graviton2 processors

member COMPUTE6_GRAVITON2_HIGH_NETWORK_BANDWIDTH

COMPUTE6_GRAVITON2_HIGH_NETWORK_BANDWIDTH = 'compute6-graviton2-high-network-bandwidth'

Compute optimized instances for high performance computing, 6th generation with Graviton2 processors and high network bandwidth capabilities

member COMPUTE6_GRAVITON2_HIGH_NETWORK_BANDWITH

COMPUTE6_GRAVITON2_HIGH_NETWORK_BANDWITH = 'compute6-graviton2-high-network-banwidth'

Compute optimized instances for high performance computing, 6th generation with Graviton2 processors and high network bandwidth capabilities

member COMPUTE6_GRAVITON2_NVME_DRIVE

COMPUTE6_GRAVITON2_NVME_DRIVE = 'compute6-graviton2-nvme-drive'

Compute optimized instances for high performance computing, 6th generation with Graviton2 processors and local NVME drive

member COMPUTE6_INTEL

COMPUTE6_INTEL = 'compute6-intel'

Compute optimized instances, 6th generation

member D2

D2 = 'd2'

Storage-optimized instances, 2nd generation

member D3

D3 = 'd3'

Storage-optimized instances, 3rd generation

member D3EN

D3EN = 'd3en'

Storage-optimized instances, 3rd generation

member F1

F1 = 'f1'

Instances with customizable hardware acceleration, 1st generation

member FPGA1

FPGA1 = 'fpga1'

Instances with customizable hardware acceleration, 1st generation

member G3

G3 = 'g3'

Graphics-optimized instances, 3rd generation

member G4AD

G4AD = 'g4ad'

Graphics-optimized instances based on AMD EPYC And Radeon Pro GPU (NAVI) with local NVME drive, 4th generation

member G4DN

G4DN = 'g4dn'

Graphics-optimized instances with NVME drive for high performance computing, 4th generation

member G5

G5 = 'g5'

Graphics-optimized instances, 5th generation

member G5G

G5G = 'g5g'

Graphics-optimized instances powered by AWS Graviton2 Processors and NVIDIA T4G Tensor Core GPUs, 5th generation

member GRAPHICS3

GRAPHICS3 = 'graphics3'

Graphics-optimized instances, 3rd generation

member GRAPHICS4_AMD_NVME_DRIVE

GRAPHICS4_AMD_NVME_DRIVE = 'graphics4-amd-nvme-drive'

Graphics-optimized instances based on AMD EPYC And Radeon Pro GPU (NAVI) with local NVME drive, 4th generation

member GRAPHICS4_NVME_DRIVE_HIGH_PERFORMANCE

GRAPHICS4_NVME_DRIVE_HIGH_PERFORMANCE = 'graphics4-nvme-drive-high-performance'

Graphics-optimized instances with NVME drive for high performance computing, 4th generation

member GRAPHICS5

GRAPHICS5 = 'graphics5'

Graphics-optimized instances, 5th generation

member GRAPHICS5_GRAVITON2

GRAPHICS5_GRAVITON2 = 'graphics5-graviton2'

Graphics-optimized instances powered by AWS Graviton2 Processors and NVIDIA T4G Tensor Core GPUs, 5th generation

member H1

H1 = 'h1'

Storage/compute balanced instances, 1st generation

member HIGH_COMPUTE_MEMORY1

HIGH_COMPUTE_MEMORY1 = 'high-compute-memory1'

High memory and compute capacity instances, 1st generation

member HIGH_MEMORY_12TB_1

HIGH_MEMORY_12TB_1 = 'high-memory-12tb-1'

High memory instances (12TB) based on Intel Xeon Platinum 8176M (Skylake) processors, 1st generation

member HIGH_MEMORY_18TB_1

HIGH_MEMORY_18TB_1 = 'high-memory-18tb-1'

High memory instances (18TB) based on Intel Xeon Scalable (Cascade Lake) processors, 1st generation

member HIGH_MEMORY_24TB_1

HIGH_MEMORY_24TB_1 = 'high-memory-24tb-1'

High memory instances (24TB) based on Intel Xeon Scalable (Cascade Lake) processors, 1st generation

member HIGH_MEMORY_6TB_1

HIGH_MEMORY_6TB_1 = 'high-memory-6tb-1'

High memory instances (6TB) based on Intel Xeon Platinum 8176M (Skylake) processors, 1st generation

member HIGH_MEMORY_9TB_1

HIGH_MEMORY_9TB_1 = 'high-memory-9tb-1'

High memory instances (9TB) based on Intel Xeon Platinum 8176M (Skylake) processors, 1st generation

member HIGH_PERFORMANCE_COMPUTING6_AMD

HIGH_PERFORMANCE_COMPUTING6_AMD = 'high-performance-computing6-amd'

High performance computing based on AMD EPYC, 6th generation

member HPC6A

HPC6A = 'hpc6a'

High performance computing based on AMD EPYC, 6th generation

member I3

I3 = 'i3'

I/O-optimized instances, 3rd generation

member I3EN

I3EN = 'i3en'

I/O-optimized instances with local NVME drive, 3rd generation

member I4I

I4I = 'i4i'

I/O-optimized instances with local NVME drive powered by Intel Xeon Scalable processors (code named Ice Lake), 4th generation

member IM4GN

IM4GN = 'im4gn'

Storage optimized instances powered by Graviton2 processor, 4th generation

member INF1

INF1 = 'inf1'

Inferentia Chips based instances for machine learning inference applications, 1st generation

member INFERENCE1

INFERENCE1 = 'inference1'

Inferentia Chips based instances for machine learning inference applications, 1st generation

member IO3

IO3 = 'io3'

I/O-optimized instances, 3rd generation

member IO3_DENSE_NVME_DRIVE

IO3_DENSE_NVME_DRIVE = 'io3-dense-nvme-drive'

I/O-optimized instances with local NVME drive, 3rd generation

member IO4_INTEL

IO4_INTEL = 'io4_intel'

I/O-optimized instances with local NVME drive powered by Intel Xeon Scalable processors (code named Ice Lake), 4th generation

member IS4GEN

IS4GEN = 'is4gen'

Storage optimized instances powered by Graviton2 processor, 4th generation

member M3

M3 = 'm3'

Standard instances, 3rd generation

member M4

M4 = 'm4'

Standard instances, 4th generation

member M5

M5 = 'm5'

Standard instances, 5th generation

member M5A

M5A = 'm5a'

Standard instances based on AMD EPYC, 5th generation

member M5AD

M5AD = 'm5ad'

Standard instances based on AMD EPYC with local NVME drive, 5th generation

member M5D

M5D = 'm5d'

Standard instances with local NVME drive, 5th generation

member M5DN

M5DN = 'm5dn'

Standard instances with local NVME drive for high performance computing, 5th generation

member M5N

M5N = 'm5n'

Standard instances for high performance computing, 5th generation

member M5ZN

M5ZN = 'm5zn'

Standard instances with high memory and compute capacity based on Intel Xeon Scalable (Cascade Lake) processors, 5nd generation

member M6A

M6A = 'm6a'

Standard instances based on 3rd Gen AMD EPYC processors, 6th generation.

member M6G

M6G = 'm6g'

Arm processor based instances, 2nd generation

member M6GD

M6GD = 'm6gd'

Standard instances, 6th generation with Graviton2 processors and local NVME drive

member M6I

M6I = 'm6i'

Standard instances based on Intel (Ice Lake), 6th generation.

member MAC1

MAC1 = 'mac1'

Macintosh instances built on Apple Mac mini computers, 1st generation with Intel procesors

member MACINTOSH1_INTEL

MACINTOSH1_INTEL = 'macintosh1-intel'

Macintosh instances built on Apple Mac mini computers, 1st generation with Intel procesors

member MEMORY_INTENSIVE_1

MEMORY_INTENSIVE_1 = 'memory-intensive-1'

Memory-intensive instances, 1st generation

member MEMORY_INTENSIVE_1_EXTENDED

MEMORY_INTENSIVE_1_EXTENDED = 'memory-intensive-1-extended'

Memory-intensive instances, extended, 1st generation

member MEMORY_INTENSIVE_2_GRAVITON2

MEMORY_INTENSIVE_2_GRAVITON2 = 'memory-intensive-2-graviton2'

Memory-intensive instances, 2nd generation with Graviton2 processors
This instance type can be used only in RDS. It is not supported in EC2.

member MEMORY_INTENSIVE_2_GRAVITON2_NVME_DRIVE

MEMORY_INTENSIVE_2_GRAVITON2_NVME_DRIVE = 'memory-intensive-2-graviton2-nvme-drive'

Memory-intensive instances, 2nd generation with Graviton2 processors and local NVME drive

member MEMORY_INTENSIVE_2_INTEL

MEMORY_INTENSIVE_2_INTEL = 'memory_intensive_2_intel'

Memory-intensive instances with higher network bandwith and local NVME drive, Intel Xeon Scalable (Ice Lake) processors

member MEMORY_INTENSIVE_2_XT_INTEL

MEMORY_INTENSIVE_2_XT_INTEL = 'memory_intensive_2_xt_intel'

Memory-intensive instances with higher network bandwith, local NVME drive, and extended memory. Intel Xeon Scalable (Ice Lake) processors

member MEMORY_INTENSIVE_2_XTZ_INTEL

MEMORY_INTENSIVE_2_XTZ_INTEL = 'memory_intensive_2_xtz_intel'

Memory-intensive instances with higher network bandwith and single-threaded performance, Intel Xeon Scalable (Cascade Lake) processors

member MEMORY3

MEMORY3 = 'memory3'

Memory optimized instances, 3rd generation

member MEMORY4

MEMORY4 = 'memory4'

Memory optimized instances, 4th generation

member MEMORY5

MEMORY5 = 'memory5'

Memory optimized instances, 5th generation

member MEMORY5_AMD

MEMORY5_AMD = 'memory5-amd'

Memory optimized instances based on AMD EPYC, 5th generation

member MEMORY5_AMD_NVME_DRIVE

MEMORY5_AMD_NVME_DRIVE = 'memory5-amd-nvme-drive'

Memory optimized instances based on AMD EPYC with local NVME drive, 5th generation

member MEMORY5_EBS_OPTIMIZED

MEMORY5_EBS_OPTIMIZED = 'memory5-ebs-optimized'

Memory optimized instances that are also EBS-optimized, 5th generation

member MEMORY5_HIGH_PERFORMANCE

MEMORY5_HIGH_PERFORMANCE = 'memory5-high-performance'

Memory optimized instances for high performance computing, 5th generation

member MEMORY5_NVME_DRIVE

MEMORY5_NVME_DRIVE = 'memory5-nvme-drive'

Memory optimized instances with local NVME drive, 5th generation

member MEMORY5_NVME_DRIVE_HIGH_PERFORMANCE

MEMORY5_NVME_DRIVE_HIGH_PERFORMANCE = 'memory5-nvme-drive-high-performance'

Memory optimized instances with local NVME drive for high performance computing, 5th generation

member MEMORY6_GRAVITON

MEMORY6_GRAVITON = 'memory6-graviton'

Memory optimized instances, 6th generation with Graviton2 processors

member MEMORY6_GRAVITON2_NVME_DRIVE

MEMORY6_GRAVITON2_NVME_DRIVE = 'memory6-graviton2-nvme-drive'

Memory optimized instances, 6th generation with Graviton2 processors and local NVME drive

member MEMORY6_INTEL

MEMORY6_INTEL = 'memory6-intel'

Memory optimized instances, 6th generation with Intel Xeon Scalable processors (3rd generation processors code named Ice Lake)

member P2

P2 = 'p2'

Parallel-processing optimized instances, 2nd generation

member P3

P3 = 'p3'

Parallel-processing optimized instances, 3rd generation

member P4D

P4D = 'p4d'

Parallel-processing optimized instances, 4th generation

member PARALLEL2

PARALLEL2 = 'parallel2'

Parallel-processing optimized instances, 2nd generation

member PARALLEL3

PARALLEL3 = 'parallel3'

Parallel-processing optimized instances, 3nd generation

member PARALLEL4

PARALLEL4 = 'parallel4'

Parallel-processing optimized instances, 4th generation

member R3

R3 = 'r3'

Memory optimized instances, 3rd generation

member R4

R4 = 'r4'

Memory optimized instances, 4th generation

member R5

R5 = 'r5'

Memory optimized instances, 5th generation

member R5A

R5A = 'r5a'

Memory optimized instances based on AMD EPYC, 5th generation

member R5AD

R5AD = 'r5ad'

Memory optimized instances based on AMD EPYC with local NVME drive, 5th generation

member R5B

R5B = 'r5b'

Memory optimized instances that are also EBS-optimized, 5th generation

member R5D

R5D = 'r5d'

Memory optimized instances with local NVME drive, 5th generation

member R5DN

R5DN = 'r5dn'

Memory optimized instances with local NVME drive for high performance computing, 5th generation

member R5N

R5N = 'r5n'

Memory optimized instances for high performance computing, 5th generation

member R6G

R6G = 'r6g'

Memory optimized instances, 6th generation with Graviton2 processors

member R6GD

R6GD = 'r6gd'

Memory optimized instances, 6th generation with Graviton2 processors and local NVME drive

member R6I

R6I = 'r6i'

Memory optimized instances, 6th generation with Intel Xeon Scalable processors (3rd generation processors code named Ice Lake)

member STANDARD3

STANDARD3 = 'standard3'

Standard instances, 3rd generation

member STANDARD4

STANDARD4 = 'standard4'

Standard instances, 4th generation

member STANDARD5

STANDARD5 = 'standard5'

Standard instances, 5th generation

member STANDARD5_AMD

STANDARD5_AMD = 'standard5-amd'

Standard instances based on AMD EPYC, 5th generation

member STANDARD5_AMD_NVME_DRIVE

STANDARD5_AMD_NVME_DRIVE = 'standard5-amd-nvme-drive'

Standard instances based on AMD EPYC with local NVME drive, 5th generation

member STANDARD5_HIGH_COMPUTE

STANDARD5_HIGH_COMPUTE = 'standard5-high-compute'

Standard instances with high memory and compute capacity based on Intel Xeon Scalable (Cascade Lake) processors, 5nd generation

member STANDARD5_HIGH_PERFORMANCE

STANDARD5_HIGH_PERFORMANCE = 'standard5-high-performance'

Standard instances for high performance computing, 5th generation

member STANDARD5_NVME_DRIVE

STANDARD5_NVME_DRIVE = 'standard5-nvme-drive'

Standard instances with local NVME drive, 5th generation

member STANDARD5_NVME_DRIVE_HIGH_PERFORMANCE

STANDARD5_NVME_DRIVE_HIGH_PERFORMANCE = 'standard5-nvme-drive-high-performance'

Standard instances with local NVME drive for high performance computing, 5th generation

member STANDARD6_AMD

STANDARD6_AMD = 'standard6-amd'

Standard instances based on 3rd Gen AMD EPYC processors, 6th generation.

member STANDARD6_GRAVITON

STANDARD6_GRAVITON = 'standard6-graviton'

Arm processor based instances, 2nd generation

member STANDARD6_GRAVITON2_NVME_DRIVE

STANDARD6_GRAVITON2_NVME_DRIVE = 'standard6-graviton2-nvme-drive'

Standard instances, 6th generation with Graviton2 processors and local NVME drive

member STANDARD6_INTEL

STANDARD6_INTEL = 'standard6-intel'

Standard instances based on Intel (Ice Lake), 6th generation.

member STORAGE_COMPUTE_1

STORAGE_COMPUTE_1 = 'storage-compute-1'

Storage/compute balanced instances, 1st generation

member STORAGE2

STORAGE2 = 'storage2'

Storage-optimized instances, 2nd generation

member STORAGE3

STORAGE3 = 'storage3'

Storage-optimized instances, 3rd generation

member STORAGE3_ENHANCED_NETWORK

STORAGE3_ENHANCED_NETWORK = 'storage3-enhanced-network'

Storage-optimized instances, 3rd generation

member STORAGE4_GRAVITON_NETWORK_OPTIMIZED

STORAGE4_GRAVITON_NETWORK_OPTIMIZED = 'storage4-graviton-network-optimized'

Storage optimized instances powered by Graviton2 processor, 4th generation

member STORAGE4_GRAVITON_NETWORK_STORAGE_OPTIMIZED

STORAGE4_GRAVITON_NETWORK_STORAGE_OPTIMIZED = 'storage4-graviton-network-storage-optimized'

Storage optimized instances powered by Graviton2 processor, 4th generation

member T2

T2 = 't2'

Burstable instances, 2nd generation

member T3

T3 = 't3'

Burstable instances, 3rd generation

member T3A

T3A = 't3a'

Burstable instances based on AMD EPYC, 3rd generation

member T4G

T4G = 't4g'

Burstable instances, 4th generation with Graviton2 processors

member U_12TB1

U_12TB1 = 'u-12tb1'

High memory instances (12TB) based on Intel Xeon Platinum 8176M (Skylake) processors, 1st generation

member U_18TB1

U_18TB1 = 'u-18tb1'

High memory instances (18TB) based on Intel Xeon Scalable (Cascade Lake) processors, 1st generation

member U_24TB1

U_24TB1 = 'u-24tb1'

High memory instances (24TB) based on Intel Xeon Scalable (Cascade Lake) processors, 1st generation

member U_6TB1

U_6TB1 = 'u-6tb1'

High memory instances (6TB) based on Intel Xeon Platinum 8176M (Skylake) processors, 1st generation

member U_9TB1

U_9TB1 = 'u-9tb1'

High memory instances (9TB) based on Intel Xeon Platinum 8176M (Skylake) processors, 1st generation

member VIDEO_TRANSCODING1

VIDEO_TRANSCODING1 = 'video-transcoding1'

Multi-stream video transcoding instances for resolutions up to 4K UHD, 1st generation

member VT1

VT1 = 'vt1'

Multi-stream video transcoding instances for resolutions up to 4K UHD, 1st generation

member X1

X1 = 'x1'

Memory-intensive instances, 1st generation

member X1E

X1E = 'x1e'

Memory-intensive instances, 1st generation

member X2G

X2G = 'x2g'

Memory-intensive instances, 2nd generation with Graviton2 processors
This instance type can be used only in RDS. It is not supported in EC2.

member X2GD

X2GD = 'x2gd'

Memory-intensive instances, 2nd generation with Graviton2 processors and local NVME drive

member X2IDN

X2IDN = 'x2idn'

Memory-intensive instances with higher network bandwith and local NVME drive, Intel Xeon Scalable (Ice Lake) processors

member X2IEDN

X2IEDN = 'x2iedn'

Memory-intensive instances with higher network bandwith, local NVME drive, and extended memory. Intel Xeon Scalable (Ice Lake) processors

member X2IEZN

X2IEZN = 'x2iezn'

Memory-intensive instances with higher network bandwith and single-threaded performance, Intel Xeon Scalable (Cascade Lake) processors

member Z1D

Z1D = 'z1d'

High memory and compute capacity instances, 1st generation

enum InstanceInitiatedShutdownBehavior

enum InstanceInitiatedShutdownBehavior {
    STOP = 'stop',
    TERMINATE = 'terminate',
}

Provides the options for specifying the instance initiated shutdown behavior.
See Also
- https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#Using_ChangingInstanceInitiatedShutdownBehavior

member STOP

STOP = 'stop'

The instance will stop when it initiates a shutdown.

member TERMINATE

TERMINATE = 'terminate'

The instance will be terminated when it initiates a shutdown.

enum InstanceSize

enum InstanceSize {
    NANO = 'nano',
    MICRO = 'micro',
    SMALL = 'small',
    MEDIUM = 'medium',
    LARGE = 'large',
    XLARGE = 'xlarge',
    XLARGE2 = '2xlarge',
    XLARGE3 = '3xlarge',
    XLARGE4 = '4xlarge',
    XLARGE6 = '6xlarge',
    XLARGE8 = '8xlarge',
    XLARGE9 = '9xlarge',
    XLARGE10 = '10xlarge',
    XLARGE12 = '12xlarge',
    XLARGE16 = '16xlarge',
    XLARGE18 = '18xlarge',
    XLARGE24 = '24xlarge',
    XLARGE32 = '32xlarge',
    XLARGE48 = '48xlarge',
    XLARGE56 = '56xlarge',
    XLARGE112 = '112xlarge',
    METAL = 'metal',
}

What size of instance to use

member LARGE

LARGE = 'large'

Instance size LARGE (large)

member MEDIUM

MEDIUM = 'medium'

Instance size MEDIUM (medium)

member METAL

METAL = 'metal'

Instance size METAL (metal)

member MICRO

MICRO = 'micro'

Instance size MICRO (micro)

member NANO

NANO = 'nano'

Instance size NANO (nano)

member SMALL

SMALL = 'small'

Instance size SMALL (small)

member XLARGE

XLARGE = 'xlarge'

Instance size XLARGE (xlarge)

member XLARGE10

XLARGE10 = '10xlarge'

Instance size XLARGE10 (10xlarge)

member XLARGE112

XLARGE112 = '112xlarge'

Instance size XLARGE56 (112xlarge)

member XLARGE12

XLARGE12 = '12xlarge'

Instance size XLARGE12 (12xlarge)

member XLARGE16

XLARGE16 = '16xlarge'

Instance size XLARGE16 (16xlarge)

member XLARGE18

XLARGE18 = '18xlarge'

Instance size XLARGE18 (18xlarge)

member XLARGE2

XLARGE2 = '2xlarge'

Instance size XLARGE2 (2xlarge)

member XLARGE24

XLARGE24 = '24xlarge'

Instance size XLARGE24 (24xlarge)

member XLARGE3

XLARGE3 = '3xlarge'

Instance size XLARGE3 (3xlarge)

member XLARGE32

XLARGE32 = '32xlarge'

Instance size XLARGE32 (32xlarge)

member XLARGE4

XLARGE4 = '4xlarge'

Instance size XLARGE4 (4xlarge)

member XLARGE48

XLARGE48 = '48xlarge'

Instance size XLARGE48 (48xlarge)

member XLARGE56

XLARGE56 = '56xlarge'

Instance size XLARGE56 (56xlarge)

member XLARGE6

XLARGE6 = '6xlarge'

Instance size XLARGE6 (6xlarge)

member XLARGE8

XLARGE8 = '8xlarge'

Instance size XLARGE8 (8xlarge)

member XLARGE9

XLARGE9 = '9xlarge'

Instance size XLARGE9 (9xlarge)

enum NatTrafficDirection

enum NatTrafficDirection {
    OUTBOUND_ONLY = 'OUTBOUND_ONLY',
    INBOUND_AND_OUTBOUND = 'INBOUND_AND_OUTBOUND',
    NONE = 'NONE',
}

Direction of traffic to allow all by default.

member INBOUND_AND_OUTBOUND

INBOUND_AND_OUTBOUND = 'INBOUND_AND_OUTBOUND'

Allow all outbound and inbound traffic.

member NONE

NONE = 'NONE'

Disallow all outbound and inbound traffic.

member OUTBOUND_ONLY

OUTBOUND_ONLY = 'OUTBOUND_ONLY'

Allow all outbound traffic and disallow all inbound traffic.

enum OperatingSystemType

enum OperatingSystemType {
    LINUX = 0,
    WINDOWS = 1,
    UNKNOWN = 2,
}

The OS type of a particular image

member LINUX

LINUX = 0

member UNKNOWN

UNKNOWN = 2

Used when the type of the operating system is not known (for example, for imported Auto-Scaling Groups).

member WINDOWS

WINDOWS = 1

enum Protocol

enum Protocol {
    ALL = '-1',
    HOPOPT = '0',
    ICMP = 'icmp',
    IGMP = '2',
    GGP = '3',
    IPV4 = '4',
    ST = '5',
    TCP = 'tcp',
    CBT = '7',
    EGP = '8',
    IGP = '9',
    BBN_RCC_MON = '10',
    NVP_II = '11',
    PUP = '12',
    EMCON = '14',
    XNET = '15',
    CHAOS = '16',
    UDP = 'udp',
    MUX = '18',
    DCN_MEAS = '19',
    HMP = '20',
    PRM = '21',
    XNS_IDP = '22',
    TRUNK_1 = '23',
    TRUNK_2 = '24',
    LEAF_1 = '25',
    LEAF_2 = '26',
    RDP = '27',
    IRTP = '28',
    ISO_TP4 = '29',
    NETBLT = '30',
    MFE_NSP = '31',
    MERIT_INP = '32',
    DCCP = '33',
    THREEPC = '34',
    IDPR = '35',
    XTP = '36',
    DDP = '37',
    IDPR_CMTP = '38',
    TPPLUSPLUS = '39',
    IL = '40',
    IPV6 = '41',
    SDRP = '42',
    IPV6_ROUTE = '43',
    IPV6_FRAG = '44',
    IDRP = '45',
    RSVP = '46',
    GRE = '47',
    DSR = '48',
    BNA = '49',
    ESP = '50',
    AH = '51',
    I_NLSP = '52',
    SWIPE = '53',
    NARP = '54',
    MOBILE = '55',
    TLSP = '56',
    SKIP = '57',
    ICMPV6 = 'icmpv6',
    IPV6_NONXT = '59',
    IPV6_OPTS = '60',
    CFTP = '62',
    ANY_LOCAL = '63',
    SAT_EXPAK = '64',
    KRYPTOLAN = '65',
    RVD = '66',
    IPPC = '67',
    ANY_DFS = '68',
    SAT_MON = '69',
    VISA = '70',
    IPCV = '71',
    CPNX = '72',
    CPHB = '73',
    WSN = '74',
    PVP = '75',
    BR_SAT_MON = '76',
    SUN_ND = '77',
    WB_MON = '78',
    WB_EXPAK = '79',
    ISO_IP = '80',
    VMTP = '81',
    SECURE_VMTP = '82',
    VINES = '83',
    TTP = '84',
    IPTM = '84_',
    NSFNET_IGP = '85',
    DGP = '86',
    TCF = '87',
    EIGRP = '88',
    OSPFIGP = '89',
    SPRITE_RPC = '90',
    LARP = '91',
    MTP = '92',
    AX_25 = '93',
    IPIP = '94',
    MICP = '95',
    SCC_SP = '96',
    ETHERIP = '97',
    ENCAP = '98',
    ANY_ENC = '99',
    GMTP = '100',
    IFMP = '101',
    PNNI = '102',
    PIM = '103',
    ARIS = '104',
    SCPS = '105',
    QNX = '106',
    A_N = '107',
    IPCOMP = '108',
    SNP = '109',
    COMPAQ_PEER = '110',
    IPX_IN_IP = '111',
    VRRP = '112',
    PGM = '113',
    ANY_0_HOP = '114',
    L2_T_P = '115',
    DDX = '116',
    IATP = '117',
    STP = '118',
    SRP = '119',
    UTI = '120',
    SMP = '121',
    SM = '122',
    PTP = '123',
    ISIS_IPV4 = '124',
    FIRE = '125',
    CRTP = '126',
    CRUDP = '127',
    SSCOPMCE = '128',
    IPLT = '129',
    SPS = '130',
    PIPE = '131',
    SCTP = '132',
    FC = '133',
    RSVP_E2E_IGNORE = '134',
    MOBILITY_HEADER = '135',
    UDPLITE = '136',
    MPLS_IN_IP = '137',
    MANET = '138',
    HIP = '139',
    SHIM6 = '140',
    WESP = '141',
    ROHC = '142',
    ETHERNET = '143',
    EXPERIMENT_1 = '253',
    EXPERIMENT_2 = '254',
    RESERVED = '255',
}

Protocol for use in Connection Rules
https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml

member A_N

A_N = '107'

member AH

AH = '51'

member ALL

ALL = '-1'

member ANY_0_HOP

ANY_0_HOP = '114'

member ANY_DFS

ANY_DFS = '68'

member ANY_ENC

ANY_ENC = '99'

member ANY_LOCAL

ANY_LOCAL = '63'

member ARIS

ARIS = '104'

member AX_25

AX_25 = '93'

member BBN_RCC_MON

BBN_RCC_MON = '10'

member BNA

BNA = '49'

member BR_SAT_MON

BR_SAT_MON = '76'

member CBT

CBT = '7'

member CFTP

CFTP = '62'

member CHAOS

CHAOS = '16'

member COMPAQ_PEER

COMPAQ_PEER = '110'

member CPHB

CPHB = '73'

member CPNX

CPNX = '72'

member CRTP

CRTP = '126'

member CRUDP

CRUDP = '127'

member DCCP

DCCP = '33'

member DCN_MEAS

DCN_MEAS = '19'

member DDP

DDP = '37'

member DDX

DDX = '116'

member DGP

DGP = '86'

member DSR

DSR = '48'

member EGP

EGP = '8'

member EIGRP

EIGRP = '88'

member EMCON

EMCON = '14'

member ENCAP

ENCAP = '98'

member ESP

ESP = '50'

member ETHERIP

ETHERIP = '97'

member ETHERNET

ETHERNET = '143'

member EXPERIMENT_1

EXPERIMENT_1 = '253'

member EXPERIMENT_2

EXPERIMENT_2 = '254'

member FC

FC = '133'

member FIRE

FIRE = '125'

member GGP

GGP = '3'

member GMTP

GMTP = '100'

member GRE

GRE = '47'

member HIP

HIP = '139'

member HMP

HMP = '20'

member HOPOPT

HOPOPT = '0'

member I_NLSP

I_NLSP = '52'

member IATP

IATP = '117'

member ICMP

ICMP = 'icmp'

member ICMPV6

ICMPV6 = 'icmpv6'

member IDPR

IDPR = '35'

member IDPR_CMTP

IDPR_CMTP = '38'

member IDRP

IDRP = '45'

member IFMP

IFMP = '101'

member IGMP

IGMP = '2'

member IGP

IGP = '9'

member IL

IL = '40'

member IPCOMP

IPCOMP = '108'

member IPCV

IPCV = '71'

member IPIP

IPIP = '94'

member IPLT

IPLT = '129'

member IPPC

IPPC = '67'

member IPTM

IPTM = '84_'

member IPV4

IPV4 = '4'

member IPV6

IPV6 = '41'

member IPV6_FRAG

IPV6_FRAG = '44'

member IPV6_NONXT

IPV6_NONXT = '59'

member IPV6_OPTS

IPV6_OPTS = '60'

member IPV6_ROUTE

IPV6_ROUTE = '43'

member IPX_IN_IP

IPX_IN_IP = '111'

member IRTP

IRTP = '28'

member ISIS_IPV4

ISIS_IPV4 = '124'

member ISO_IP

ISO_IP = '80'

member ISO_TP4

ISO_TP4 = '29'

member KRYPTOLAN

KRYPTOLAN = '65'

member L2_T_P

L2_T_P = '115'

member LARP

LARP = '91'

member LEAF_1

LEAF_1 = '25'

member LEAF_2

LEAF_2 = '26'

member MANET

MANET = '138'

member MERIT_INP

MERIT_INP = '32'

member MFE_NSP

MFE_NSP = '31'

member MICP

MICP = '95'

member MOBILE

MOBILE = '55'

member MOBILITY_HEADER

MOBILITY_HEADER = '135'

member MPLS_IN_IP

MPLS_IN_IP = '137'

member MTP

MTP = '92'

member MUX

MUX = '18'

member NARP

NARP = '54'

member NETBLT

NETBLT = '30'

member NSFNET_IGP

NSFNET_IGP = '85'

member NVP_II

NVP_II = '11'

member OSPFIGP

OSPFIGP = '89'

member PGM

PGM = '113'

member PIM

PIM = '103'

member PIPE

PIPE = '131'

member PNNI

PNNI = '102'

member PRM

PRM = '21'

member PTP

PTP = '123'

member PUP

PUP = '12'

member PVP

PVP = '75'

member QNX

QNX = '106'

member RDP

RDP = '27'

member RESERVED

RESERVED = '255'

member ROHC

ROHC = '142'

member RSVP

RSVP = '46'

member RSVP_E2E_IGNORE

RSVP_E2E_IGNORE = '134'

member RVD

RVD = '66'

member SAT_EXPAK

SAT_EXPAK = '64'

member SAT_MON

SAT_MON = '69'

member SCC_SP

SCC_SP = '96'

member SCPS

SCPS = '105'

member SCTP

SCTP = '132'

member SDRP

SDRP = '42'

member SECURE_VMTP

SECURE_VMTP = '82'

member SHIM6

SHIM6 = '140'

member SKIP

SKIP = '57'

member SM

SM = '122'

member SMP

SMP = '121'

member SNP

SNP = '109'

member SPRITE_RPC

SPRITE_RPC = '90'

member SPS

SPS = '130'

member SRP

SRP = '119'

member SSCOPMCE

SSCOPMCE = '128'

member ST

ST = '5'

member STP

STP = '118'

member SUN_ND

SUN_ND = '77'

member SWIPE

SWIPE = '53'

member TCF

TCF = '87'

member TCP

TCP = 'tcp'

member THREEPC

THREEPC = '34'

member TLSP

TLSP = '56'

member TPPLUSPLUS

TPPLUSPLUS = '39'

member TRUNK_1

TRUNK_1 = '23'

member TRUNK_2

TRUNK_2 = '24'

member TTP

TTP = '84'

member UDP

UDP = 'udp'

member UDPLITE

UDPLITE = '136'

member UTI

UTI = '120'

member VINES

VINES = '83'

member VISA

VISA = '70'

member VMTP

VMTP = '81'

member VRRP

VRRP = '112'

member WB_EXPAK

WB_EXPAK = '79'

member WB_MON

WB_MON = '78'

member WESP

WESP = '141'

member WSN

WSN = '74'

member XNET

XNET = '15'

member XNS_IDP

XNS_IDP = '22'

member XTP

XTP = '36'

enum RouterType

enum RouterType {
    CARRIER_GATEWAY = 'CarrierGateway',
    EGRESS_ONLY_INTERNET_GATEWAY = 'EgressOnlyInternetGateway',
    GATEWAY = 'Gateway',
    INSTANCE = 'Instance',
    LOCAL_GATEWAY = 'LocalGateway',
    NAT_GATEWAY = 'NatGateway',
    NETWORK_INTERFACE = 'NetworkInterface',
    TRANSIT_GATEWAY = 'TransitGateway',
    VPC_PEERING_CONNECTION = 'VpcPeeringConnection',
    VPC_ENDPOINT = 'VpcEndpoint',
}

Type of router used in route

member CARRIER_GATEWAY

CARRIER_GATEWAY = 'CarrierGateway'

Carrier gateway

member EGRESS_ONLY_INTERNET_GATEWAY

EGRESS_ONLY_INTERNET_GATEWAY = 'EgressOnlyInternetGateway'

Egress-only Internet Gateway

member GATEWAY

GATEWAY = 'Gateway'

Internet Gateway

member INSTANCE

INSTANCE = 'Instance'

Instance

member LOCAL_GATEWAY

LOCAL_GATEWAY = 'LocalGateway'

Local Gateway

member NAT_GATEWAY

NAT_GATEWAY = 'NatGateway'

NAT Gateway

member NETWORK_INTERFACE

NETWORK_INTERFACE = 'NetworkInterface'

Network Interface

member TRANSIT_GATEWAY

TRANSIT_GATEWAY = 'TransitGateway'

Transit Gateway

member VPC_ENDPOINT

VPC_ENDPOINT = 'VpcEndpoint'

VPC Endpoint for gateway load balancers

member VPC_PEERING_CONNECTION

VPC_PEERING_CONNECTION = 'VpcPeeringConnection'

VPC peering connection

enum SpotInstanceInterruption

enum SpotInstanceInterruption {
    STOP = 'stop',
    TERMINATE = 'terminate',
    HIBERNATE = 'hibernate',
}

Provides the options for the types of interruption for spot instances.

member HIBERNATE

HIBERNATE = 'hibernate'

The instance will hibernate when interrupted.

member STOP

STOP = 'stop'

The instance will stop when interrupted.

member TERMINATE

TERMINATE = 'terminate'

The instance will be terminated when interrupted.

enum SpotRequestType

enum SpotRequestType {
    ONE_TIME = 'one-time',
    PERSISTENT = 'persistent',
}

The Spot Instance request type.
See Also
- https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html

member ONE_TIME

ONE_TIME = 'one-time'

A one-time Spot Instance request remains active until Amazon EC2 launches the Spot Instance, the request expires, or you cancel the request. If the Spot price exceeds your maximum price or capacity is not available, your Spot Instance is terminated and the Spot Instance request is closed.

member PERSISTENT

PERSISTENT = 'persistent'

A persistent Spot Instance request remains active until it expires or you cancel it, even if the request is fulfilled. If the Spot price exceeds your maximum price or capacity is not available, your Spot Instance is interrupted. After your instance is interrupted, when your maximum price exceeds the Spot price or capacity becomes available again, the Spot Instance is started if stopped or resumed if hibernated.

enum SubnetType

enum SubnetType {
    ISOLATED = 'Deprecated_Isolated',
    PRIVATE_ISOLATED = 'Isolated',
    PRIVATE = 'Deprecated_Private',
    PRIVATE_WITH_NAT = 'Private',
    PUBLIC = 'Public',
}

The type of Subnet

member ISOLATED

ISOLATED = 'Deprecated_Isolated'

Isolated Subnets do not route traffic to the Internet (in this VPC), and as such, do not require NAT gateways.
Isolated subnets can only connect to or be connected to from other instances in the same VPC. A default VPC configuration will not include isolated subnets.
This can be good for subnets with RDS or Elasticache instances, or which route Internet traffic through a peer VPC.
Deprecated
use SubnetType.PRIVATE_ISOLATED

member PRIVATE

PRIVATE = 'Deprecated_Private'

Subnet that routes to the internet, but not vice versa.
Instances in a private subnet can connect to the Internet, but will not allow connections to be initiated from the Internet. NAT Gateway(s) are required with this subnet type to route the Internet traffic through. If a NAT Gateway is not required or desired, use SubnetType.PRIVATE_ISOLATED instead.
By default, a NAT gateway is created in every public subnet for maximum availability. Be aware that you will be charged for NAT gateways.
Normally a Private subnet will use a NAT gateway in the same AZ, but if natGateways is used to reduce the number of NAT gateways, a NAT gateway from another AZ will be used instead.
Deprecated
use PRIVATE_WITH_NAT

member PRIVATE_ISOLATED

PRIVATE_ISOLATED = 'Isolated'

Isolated Subnets do not route traffic to the Internet (in this VPC), and as such, do not require NAT gateways.
Isolated subnets can only connect to or be connected to from other instances in the same VPC. A default VPC configuration will not include isolated subnets.
This can be good for subnets with RDS or Elasticache instances, or which route Internet traffic through a peer VPC.

member PRIVATE_WITH_NAT

PRIVATE_WITH_NAT = 'Private'

Subnet that routes to the internet (via a NAT gateway), but not vice versa.
Instances in a private subnet can connect to the Internet, but will not allow connections to be initiated from the Internet. NAT Gateway(s) are required with this subnet type to route the Internet traffic through. If a NAT Gateway is not required or desired, use SubnetType.PRIVATE_ISOLATED instead.
By default, a NAT gateway is created in every public subnet for maximum availability. Be aware that you will be charged for NAT gateways.
Normally a Private subnet will use a NAT gateway in the same AZ, but if natGateways is used to reduce the number of NAT gateways, a NAT gateway from another AZ will be used instead.

member PUBLIC

PUBLIC = 'Public'

Subnet connected to the Internet
Instances in a Public subnet can connect to the Internet and can be connected to from the Internet as long as they are launched with public IPs (controlled on the AutoScalingGroup or other constructs that launch instances).
Public subnets route outbound traffic via an Internet Gateway.

enum TrafficDirection

enum TrafficDirection {
    EGRESS = 0,
    INGRESS = 1,
}

Direction of traffic the AclEntry applies to

member EGRESS

EGRESS = 0

Traffic leaving the subnet

member INGRESS

INGRESS = 1

Traffic entering the subnet

enum TransportProtocol

enum TransportProtocol {
    TCP = 'tcp',
    UDP = 'udp',
}

Transport protocol for client VPN

member TCP

TCP = 'tcp'

Transmission Control Protocol (TCP)

member UDP

UDP = 'udp'

User Datagram Protocol (UDP)

enum VpcEndpointType

enum VpcEndpointType {
    INTERFACE = 'Interface',
    GATEWAY = 'Gateway',
}

The type of VPC endpoint.

member GATEWAY

GATEWAY = 'Gateway'

Gateway
A gateway endpoint is a gateway that is a target for a specified route in your route table, used for traffic destined to a supported AWS service.

member INTERFACE

INTERFACE = 'Interface'

Interface
An interface endpoint is an elastic network interface with a private IP address that serves as an entry point for traffic destined to a supported service.

enum VpnConnectionType

enum VpnConnectionType {
    IPSEC_1 = 'ipsec.1',
    DUMMY = 'dummy',
}

The VPN connection type.

member DUMMY

DUMMY = 'dummy'

Dummy member TODO: remove once https://github.com/aws/jsii/issues/231 is fixed

member IPSEC_1

IPSEC_1 = 'ipsec.1'

The IPsec 1 VPN connection type.

enum VpnPort

enum VpnPort {
    HTTPS = 443,
    OPENVPN = 1194,
}

Port for client VPN

member HTTPS

HTTPS = 443

HTTPS

member OPENVPN

OPENVPN = 1194

OpenVPN

enum WindowsVersion

enum WindowsVersion {
    WINDOWS_SERVER_2008_SP2_ENGLISH_64BIT_SQL_2008_SP4_EXPRESS = 'Windows_Server-2008-SP2-English-64Bit-SQL_2008_SP4_Express',
    WINDOWS_SERVER_2012_R2_RTM_CHINESE_SIMPLIFIED_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Chinese_Simplified-64Bit-Base',
    WINDOWS_SERVER_2012_R2_RTM_CHINESE_TRADITIONAL_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Chinese_Traditional-64Bit-Base',
    WINDOWS_SERVER_2012_R2_RTM_DUTCH_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Dutch-64Bit-Base',
    WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP2_ENTERPRISE = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2014_SP2_Enterprise',
    WINDOWS_SERVER_2012_R2_RTM_HUNGARIAN_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Hungarian-64Bit-Base',
    WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-Base',
    WINDOWS_SERVER_2016_ENGLISH_CORE_CONTAINERS = 'Windows_Server-2016-English-Core-Containers',
    WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP1_WEB = 'Windows_Server-2016-English-Core-SQL_2016_SP1_Web',
    WINDOWS_SERVER_2016_GERMAL_FULL_BASE = 'Windows_Server-2016-Germal-Full-Base',
    WINDOWS_SERVER_2016_GERMAN_FULL_BASE = 'Windows_Server-2016-German-Full-Base',
    WINDOWS_SERVER_2003_R2_SP2_LANGUAGE_PACKS_32BIT_BASE = 'Windows_Server-2003-R2_SP2-Language_Packs-32Bit-Base',
    WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2008_R2_SP3_WEB = 'Windows_Server-2008-R2_SP1-English-64Bit-SQL_2008_R2_SP3_Web',
    WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2012_SP4_EXPRESS = 'Windows_Server-2008-R2_SP1-English-64Bit-SQL_2012_SP4_Express',
    WINDOWS_SERVER_2012_R2_SP1_PORTUGESE_BRAZIL_64BIT_CORE = 'Windows_Server-2008-R2_SP1-Portugese_Brazil-64Bit-Core',
    WINDOWS_SERVER_2012_R2_SP1_PORTUGUESE_BRAZIL_64BIT_CORE = 'Windows_Server-2008-R2_SP1-Portuguese_Brazil-64Bit-Core',
    WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP2_STANDARD = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2016_SP2_Standard',
    WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP2_EXPRESS = 'Windows_Server-2012-RTM-English-64Bit-SQL_2014_SP2_Express',
    WINDOWS_SERVER_2012_RTM_ITALIAN_64BIT_BASE = 'Windows_Server-2012-RTM-Italian-64Bit-Base',
    WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP1_EXPRESS = 'Windows_Server-2016-English-Core-SQL_2016_SP1_Express',
    WINDOWS_SERVER_2016_ENGLISH_DEEP_LEARNING = 'Windows_Server-2016-English-Deep-Learning',
    WINDOWS_SERVER_2019_ITALIAN_FULL_BASE = 'Windows_Server-2019-Italian-Full-Base',
    WINDOWS_SERVER_2008_R2_SP1_KOREAN_64BIT_BASE = 'Windows_Server-2008-R2_SP1-Korean-64Bit-Base',
    WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP1_EXPRESS = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2016_SP1_Express',
    WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP2_WEB = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-SQL_2016_SP2_Web',
    WINDOWS_SERVER_2016_JAPANESE_FULL_FQL_2016_SP2_WEB = 'Windows_Server-2016-Japanese-Full-SQL_2016_SP2_Web',
    WINDOWS_SERVER_2016_KOREAN_FULL_BASE = 'Windows_Server-2016-Korean-Full-Base',
    WINDOWS_SERVER_2016_KOREAN_FULL_SQL_2016_SP2_STANDARD = 'Windows_Server-2016-Korean-Full-SQL_2016_SP2_Standard',
    WINDOWS_SERVER_2016_PORTUGESE_PORTUGAL_FULL_BASE = 'Windows_Server-2016-Portugese_Portugal-Full-Base',
    WINDOWS_SERVER_2016_PORTUGUESE_PORTUGAL_FULL_BASE = 'Windows_Server-2016-Portuguese_Portugal-Full-Base',
    WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2017_WEB = 'Windows_Server-2019-English-Full-SQL_2017_Web',
    WINDOWS_SERVER_2019_FRENCH_FULL_BASE = 'Windows_Server-2019-French-Full-Base',
    WINDOWS_SERVER_2019_KOREAN_FULL_BASE = 'Windows_Server-2019-Korean-Full-Base',
    WINDOWS_SERVER_2008_R2_SP1_CHINESE_HONG_KONG_SAR_64BIT_BASE = 'Windows_Server-2008-R2_SP1-Chinese_Hong_Kong_SAR-64Bit-Base',
    WINDOWS_SERVER_2008_R2_SP1_CHINESE_PRC_64BIT_BASE = 'Windows_Server-2008-R2_SP1-Chinese_PRC-64Bit-Base',
    WINDOWS_SERVER_2012_RTM_FRENCH_64BIT_BASE = 'Windows_Server-2012-RTM-French-64Bit-Base',
    WINDOWS_SERVER_2016_ENGLISH_FULL_CONTAINERS = 'Windows_Server-2016-English-Full-Containers',
    WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP1_STANDARD = 'Windows_Server-2016-English-Full-SQL_2016_SP1_Standard',
    WINDOWS_SERVER_2016_RUSSIAN_FULL_BASE = 'Windows_Server-2016-Russian-Full-Base',
    WINDOWS_SERVER_2019_CHINESE_SIMPLIFIED_FULL_BASE = 'Windows_Server-2019-Chinese_Simplified-Full-Base',
    WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP2_STANDARD = 'Windows_Server-2019-English-Full-SQL_2016_SP2_Standard',
    WINDOWS_SERVER_2019_HUNGARIAN_FULL_BASE = 'Windows_Server-2019-Hungarian-Full-Base',
    WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2008_R2_SP3_EXPRESS = 'Windows_Server-2008-R2_SP1-English-64Bit-SQL_2008_R2_SP3_Express',
    WINDOWS_SERVER_2007_R2_SP1_LANGUAGE_PACKS_64BIT_BASE = 'Windows_Server-2008-R2_SP1-Language_Packs-64Bit-Base',
    WINDOWS_SERVER_2008_SP2_ENGLISH_32BIT_BASE = 'Windows_Server-2008-SP2-English-32Bit-Base',
    WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2012_SP4_ENTERPRISE = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2012_SP4_Enterprise',
    WINDOWS_SERVER_2012_RTM_CHINESE_TRADITIONAL_64BIT_BASE = 'Windows_Server-2012-RTM-Chinese_Traditional-64Bit-Base',
    WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2008_R2_SP3_EXPRESS = 'Windows_Server-2012-RTM-English-64Bit-SQL_2008_R2_SP3_Express',
    WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP2_STANDARD = 'Windows_Server-2012-RTM-English-64Bit-SQL_2014_SP2_Standard',
    WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP2_EXPRESS = 'Windows_Server-2012-RTM-Japanese-64Bit-SQL_2014_SP2_Express',
    WINDOWS_SERVER_2016_POLISH_FULL_BASE = 'Windows_Server-2016-Polish-Full-Base',
    WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP2_WEB = 'Windows_Server-2019-English-Full-SQL_2016_SP2_Web',
    WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP3_STANDARD = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2014_SP3_Standard',
    WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP2_EXPRESS = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2016_SP2_Express',
    WINDOWS_SERVER_2012_R2_RTM_ENGLISH_DEEP_LEARNING = 'Windows_Server-2012-R2_RTM-English-Deep-Learning',
    WINDOWS_SERVER_2012_R2_RTM_GERMAN_64BIT_BASE = 'Windows_Server-2012-R2_RTM-German-64Bit-Base',
    WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP1_EXPRESS = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-SQL_2016_SP1_Express',
    WINDOWS_SERVER_2012_R2_RTM_RUSSIAN_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Russian-64Bit-Base',
    WINDOWS_SERVER_2012_RTM_CHINESE_TRADITIONAL_HONG_KONG_SAR_64BIT_BASE = 'Windows_Server-2012-RTM-Chinese_Traditional_Hong_Kong_SAR-64Bit-Base',
    WINDOWS_SERVER_2012_RTM_HUNGARIAN_64BIT_BASE = 'Windows_Server-2012-RTM-Hungarian-64Bit-Base',
    WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP3_STANDARD = 'Windows_Server-2012-RTM-Japanese-64Bit-SQL_2014_SP3_Standard',
    WINDOWS_SERVER_2019_ENGLISH_FULL_HYPERV = 'Windows_Server-2019-English-Full-HyperV',
    WINDOWS_SERVER_2003_R2_SP2_ENGLISH_64BIT_SQL_2005_SP4_EXPRESS = 'Windows_Server-2003-R2_SP2-English-64Bit-SQL_2005_SP4_Express',
    WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2012_SP4_EXPRESS = 'Windows_Server-2008-R2_SP1-Japanese-64Bit-SQL_2012_SP4_Express',
    WINDOWS_SERVER_2012_RTM_GERMAN_64BIT_BASE = 'Windows_Server-2012-RTM-German-64Bit-Base',
    WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2008_R2_SP3_STANDARD = 'Windows_Server-2012-RTM-Japanese-64Bit-SQL_2008_R2_SP3_Standard',
    WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP2_STANDARD = 'Windows_Server-2016-English-Full-SQL_2016_SP2_Standard',
    WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2017_EXPRESS = 'Windows_Server-2019-English-Full-SQL_2017_Express',
    WINDOWS_SERVER_2019_JAPANESE_FULL_BASE = 'Windows_Server-2019-Japanese-Full-Base',
    WINDOWS_SERVER_2019_RUSSIAN_FULL_BASE = 'Windows_Server-2019-Russian-Full-Base',
    WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP2_STANDARD = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2014_SP2_Standard',
    WINDOWS_SERVER_2012_R2_RTM_ITALIAN_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Italian-64Bit-Base',
    WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_BASE = 'Windows_Server-2012-RTM-English-64Bit-Base',
    WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2008_R2_SP3_STANDARD = 'Windows_Server-2012-RTM-English-64Bit-SQL_2008_R2_SP3_Standard',
    WINDOWS_SERVER_2016_ENGLISH_FULL_HYPERV = 'Windows_Server-2016-English-Full-HyperV',
    WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP2_ENTERPRISE = 'Windows_Server-2016-English-Full-SQL_2016_SP2_Enterprise',
    WINDOWS_SERVER_2019_CHINESE_TRADITIONAL_FULL_BASE = 'Windows_Server-2019-Chinese_Traditional-Full-Base',
    WINDOWS_SERVER_2019_ENGLISH_CORE_BASE = 'Windows_Server-2019-English-Core-Base',
    WINDOWS_SERVER_2019_ENGLISH_CORE_CONTAINERSLATEST = 'Windows_Server-2019-English-Core-ContainersLatest',
    WINDOWS_SERVER_2008_SP2_ENGLISH_64BIT_BASE = 'Windows_Server-2008-SP2-English-64Bit-Base',
    WINDOWS_SERVER_2012_R2_RTM_FRENCH_64BIT_BASE = 'Windows_Server-2012-R2_RTM-French-64Bit-Base',
    WINDOWS_SERVER_2012_R2_RTM_POLISH_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Polish-64Bit-Base',
    WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2012_SP4_EXPRESS = 'Windows_Server-2012-RTM-English-64Bit-SQL_2012_SP4_Express',
    WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP3_STANDARD = 'Windows_Server-2012-RTM-English-64Bit-SQL_2014_SP3_Standard',
    WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_2012_SP4_STANDARD = 'Windows_Server-2012-RTM-Japanese-64Bit-SQL_2012_SP4_Standard',
    WINDOWS_SERVER_2016_ENGLISH_CORE_CONTAINERSLATEST = 'Windows_Server-2016-English-Core-ContainersLatest',
    WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP2_EXPRESS = 'Windows_Server-2019-English-Full-SQL_2016_SP2_Express',
    WINDOWS_SERVER_2019_TURKISH_FULL_BASE = 'Windows_Server-2019-Turkish-Full-Base',
    WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP2_EXPRESS = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2014_SP2_Express',
    WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP3_WEB = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2014_SP3_Web',
    WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP1_WEB = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-SQL_2016_SP1_Web',
    WINDOWS_SERVER_2012_R2_RTM_PORTUGESE_BRAZIL_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Portugese_Brazil-64Bit-Base',
    WINDOWS_SERVER_2012_R2_RTM_PORTUGUESE_BRAZIL_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Portuguese_Brazil-64Bit-Base',
    WINDOWS_SERVER_2012_R2_RTM_PORTUGESE_PORTUGAL_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Portugese_Portugal-64Bit-Base',
    WINDOWS_SERVER_2012_R2_RTM_PORTUGUESE_PORTUGAL_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Portuguese_Portugal-64Bit-Base',
    WINDOWS_SERVER_2012_R2_RTM_SWEDISH_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Swedish-64Bit-Base',
    WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP1_EXPRESS = 'Windows_Server-2016-English-Full-SQL_2016_SP1_Express',
    WINDOWS_SERVER_2016_ITALIAN_FULL_BASE = 'Windows_Server-2016-Italian-Full-Base',
    WINDOWS_SERVER_2016_SPANISH_FULL_BASE = 'Windows_Server-2016-Spanish-Full-Base',
    WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2017_STANDARD = 'Windows_Server-2019-English-Full-SQL_2017_Standard',
    WINDOWS_SERVER_2003_R2_SP2_LANGUAGE_PACKS_64BIT_SQL_2005_SP4_STANDARD = 'Windows_Server-2003-R2_SP2-Language_Packs-64Bit-SQL_2005_SP4_Standard',
    WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2008_R2_SP3_STANDARD = 'Windows_Server-2008-R2_SP1-Japanese-64Bit-SQL_2008_R2_SP3_Standard',
    WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP1_STANDARD = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-SQL_2016_SP1_Standard',
    WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2007_R2_SP3_WEB = 'Windows_Server-2012-RTM-English-64Bit-SQL_2008_R2_SP3_Web',
    WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP2_WEB = 'Windows_Server-2012-RTM-Japanese-64Bit-SQL_2014_SP2_Web',
    WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP2_ENTERPRISE = 'Windows_Server-2016-English-Core-SQL_2016_SP2_Enterprise',
    WINDOWS_SERVER_2016_PORTUGESE_BRAZIL_FULL_BASE = 'Windows_Server-2016-Portugese_Brazil-Full-Base',
    WINDOWS_SERVER_2016_PORTUGUESE_BRAZIL_FULL_BASE = 'Windows_Server-2016-Portuguese_Brazil-Full-Base',
    WINDOWS_SERVER_2019_ENGLISH_FULL_BASE = 'Windows_Server-2019-English-Full-Base',
    WINDOWS_SERVER_2003_R2_SP2_ENGLISH_32BIT_BASE = 'Windows_Server-2003-R2_SP2-English-32Bit-Base',
    WINDOWS_SERVER_2012_R2_RTM_CZECH_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Czech-64Bit-Base',
    WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP1_STANDARD = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2016_SP1_Standard',
    WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2014_SP2_EXPRESS = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-SQL_2014_SP2_Express',
    WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2012_SP4_STANDARD = 'Windows_Server-2012-RTM-English-64Bit-SQL_2012_SP4_Standard',
    WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP1_ENTERPRISE = 'Windows_Server-2016-English-Core-SQL_2016_SP1_Enterprise',
    WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP1_WEB = 'Windows_Server-2016-Japanese-Full-SQL_2016_SP1_Web',
    WINDOWS_SERVER_2016_SWEDISH_FULL_BASE = 'Windows_Server-2016-Swedish-Full-Base',
    WINDOWS_SERVER_2016_TURKISH_FULL_BASE = 'Windows_Server-2016-Turkish-Full-Base',
    WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_CORE_SQL_2012_SP4_STANDARD = 'Windows_Server-2008-R2_SP1-English-64Bit-Core_SQL_2012_SP4_Standard',
    WINDOWS_SERVER_2008_R2_SP1_LANGUAGE_PACKS_64BIT_SQL_2008_R2_SP3_STANDARD = 'Windows_Server-2008-R2_SP1-Language_Packs-64Bit-SQL_2008_R2_SP3_Standard',
    WINDOWS_SERVER_2012_RTM_CZECH_64BIT_BASE = 'Windows_Server-2012-RTM-Czech-64Bit-Base',
    WINDOWS_SERVER_2012_RTM_TURKISH_64BIT_BASE = 'Windows_Server-2012-RTM-Turkish-64Bit-Base',
    WINDOWS_SERVER_2016_DUTCH_FULL_BASE = 'Windows_Server-2016-Dutch-Full-Base',
    WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP2_EXPRESS = 'Windows_Server-2016-English-Full-SQL_2016_SP2_Express',
    WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2017_ENTERPRISE = 'Windows_Server-2016-English-Full-SQL_2017_Enterprise',
    WINDOWS_SERVER_2016_HUNGARIAN_FULL_BASE = 'Windows_Server-2016-Hungarian-Full-Base',
    WINDOWS_SERVER_2016_KOREAN_FULL_SQL_2016_SP1_STANDARD = 'Windows_Server-2016-Korean-Full-SQL_2016_SP1_Standard',
    WINDOWS_SERVER_2019_SPANISH_FULL_BASE = 'Windows_Server-2019-Spanish-Full-Base',
    WINDOWS_SERVER_2003_R2_SP2_ENGLISH_64BIT_BASE = 'Windows_Server-2003-R2_SP2-English-64Bit-Base',
    WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_BASE = 'Windows_Server-2008-R2_SP1-English-64Bit-Base',
    WINDOWS_SERVER_2008_R2_SP1_LANGUAGE_PACKS_64BIT_SQL_2008_R2_SP3_EXPRESS = 'Windows_Server-2008-R2_SP1-Language_Packs-64Bit-SQL_2008_R2_SP3_Express',
    WINDOWS_SERVER_2012_SP2_PORTUGESE_BRAZIL_64BIT_BASE = 'Windows_Server-2008-SP2-Portugese_Brazil-64Bit-Base',
    WINDOWS_SERVER_2012_SP2_PORTUGUESE_BRAZIL_64BIT_BASE = 'Windows_Server-2008-SP2-Portuguese_Brazil-64Bit-Base',
    WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP1_WEB = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2016_SP1_Web',
    WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2014_SP3_EXPRESS = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-SQL_2014_SP3_Express',
    WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP2_ENTERPRISE = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-SQL_2016_SP2_Enterprise',
    WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_BASE = 'Windows_Server-2012-RTM-Japanese-64Bit-Base',
    WINDOWS_SERVER_2019_ENGLISH_FULL_CONTAINERSLATEST = 'Windows_Server-2019-English-Full-ContainersLatest',
    WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2017_ENTERPRISE = 'Windows_Server-2019-English-Full-SQL_2017_Enterprise',
    WINDOWS_SERVER_1709_ENGLISH_CORE_CONTAINERSLATEST = 'Windows_Server-1709-English-Core-ContainersLatest',
    WINDOWS_SERVER_1803_ENGLISH_CORE_BASE = 'Windows_Server-1803-English-Core-Base',
    WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2012_SP4_WEB = 'Windows_Server-2008-R2_SP1-English-64Bit-SQL_2012_SP4_Web',
    WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_BASE = 'Windows_Server-2008-R2_SP1-Japanese-64Bit-Base',
    WINDOWS_SERVER_2008_SP2_ENGLISH_64BIT_SQL_2008_SP4_STANDARD = 'Windows_Server-2008-SP2-English-64Bit-SQL_2008_SP4_Standard',
    WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_BASE = 'Windows_Server-2012-R2_RTM-English-64Bit-Base',
    WINDOWS_SERVER_2012_RTM_PORTUGESE_BRAZIL_64BIT_BASE = 'Windows_Server-2012-RTM-Portugese_Brazil-64Bit-Base',
    WINDOWS_SERVER_2012_RTM_PORTUGUESE_BRAZIL_64BIT_BASE = 'Windows_Server-2012-RTM-Portuguese_Brazil-64Bit-Base',
    WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP1_WEB = 'Windows_Server-2016-English-Full-SQL_2016_SP1_Web',
    WINDOWS_SERVER_2016_ENGLISH_P3 = 'Windows_Server-2016-English-P3',
    WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP1_ENTERPRISE = 'Windows_Server-2016-Japanese-Full-SQL_2016_SP1_Enterprise',
    WINDOWS_SERVER_2003_R2_SP2_LANGUAGE_PACKS_64BIT_BASE = 'Windows_Server-2003-R2_SP2-Language_Packs-64Bit-Base',
    WINDOWS_SERVER_2012_R2_RTM_CHINESE_TRADITIONAL_HONG_KONG_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Chinese_Traditional_Hong_Kong-64Bit-Base',
    WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP3_EXPRESS = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2014_SP3_Express',
    WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP2_ENTERPRISE = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2016_SP2_Enterprise',
    WINDOWS_SERVER_2012_RTM_CHINESE_SIMPLIFIED_64BIT_BASE = 'Windows_Server-2012-RTM-Chinese_Simplified-64Bit-Base',
    WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2012_SP4_WEB = 'Windows_Server-2012-RTM-English-64Bit-SQL_2012_SP4_Web',
    WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP3_WEB = 'Windows_Server-2012-RTM-Japanese-64Bit-SQL_2014_SP3_Web',
    WINDOWS_SERVER_2016_JAPANESE_FULL_BASE = 'Windows_Server-2016-Japanese-Full-Base',
    WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP1_EXPRESS = 'Windows_Server-2016-Japanese-Full-SQL_2016_SP1_Express',
    WINDOWS_SERVER_1803_ENGLISH_CORE_CONTAINERSLATEST = 'Windows_Server-1803-English-Core-ContainersLatest',
    WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2012_SP4_STANDARD = 'Windows_Server-2008-R2_SP1-Japanese-64Bit-SQL_2012_SP4_Standard',
    WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_CORE = 'Windows_Server-2012-R2_RTM-English-64Bit-Core',
    WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP2_WEB = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2014_SP2_Web',
    WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP3_ENTERPRISE = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2014_SP3_Enterprise',
    WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP2_STANDARD = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-SQL_2016_SP2_Standard',
    WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_2014_SP3_WEB = 'Windows_Server-2012-RTM-English-64Bit-SQL_2014_SP3_Web',
    WINDOWS_SERVER_2012_RTM_SWEDISH_64BIT_BASE = 'Windows_Server-2012-RTM-Swedish-64Bit-Base',
    WINDOWS_SERVER_2016_CHINESE_SIMPLIFIED_FULL_BASE = 'Windows_Server-2016-Chinese_Simplified-Full-Base',
    WINDOWS_SERVER_2019_POLISH_FULL_BASE = 'Windows_Server-2019-Polish-Full-Base',
    WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2008_R2_SP3_WEB = 'Windows_Server-2008-R2_SP1-Japanese-64Bit-SQL_2008_R2_SP3_Web',
    WINDOWS_SERVER_2008_R2_SP1_PORTUGESE_BRAZIL_64BIT_BASE = 'Windows_Server-2008-R2_SP1-Portugese_Brazil-64Bit-Base',
    WINDOWS_SERVER_2008_R2_SP1_PORTUGUESE_BRAZIL_64BIT_BASE = 'Windows_Server-2008-R2_SP1-Portuguese_Brazil-64Bit-Base',
    WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP1_ENTERPRISE = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-SQL_2016_SP1_Enterprise',
    WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2016_SP2_EXPRESS = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-SQL_2016_SP2_Express',
    WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP3_EXPRESS = 'Windows_Server-2012-RTM-English-64Bit-SQL_2014_SP3_Express',
    WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP2_STANDARD = 'Windows_Server-2012-RTM-Japanese-64Bit-SQL_2014_SP2_Standard',
    WINDOWS_SERVER_2016_ENGLISH_CORE_BASE = 'Windows_Server-2016-English-Core-Base',
    WINDOWS_SERVER_2016_ENGLISH_FULL_BASE = 'Windows_Server-2016-English-Full-Base',
    WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2017_WEB = 'Windows_Server-2016-English-Full-SQL_2017_Web',
    WINDOWS_SERVER_2019_GERMAN_FULL_BASE = 'Windows_Server-2019-German-Full-Base',
    WINDOWS_SERVER_2003_R2_SP2_ENGLISH_64BIT_SQL_2005_SP4_STANDARD = 'Windows_Server-2003-R2_SP2-English-64Bit-SQL_2005_SP4_Standard',
    WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2012_SP4_ENTERPRISE = 'Windows_Server-2008-R2_SP1-English-64Bit-SQL_2012_SP4_Enterprise',
    WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2008_R2_SP3_EXPRESS = 'Windows_Server-2008-R2_SP1-Japanese-64Bit-SQL_2008_R2_SP3_Express',
    WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP1_ENTERPRISE = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2016_SP1_Enterprise',
    WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP2_WEB = 'Windows_Server-2012-RTM-English-64Bit-SQL_2014_SP2_Web',
    WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2008_R2_SP3_EXPRESS = 'Windows_Server-2012-RTM-Japanese-64Bit-SQL_2008_R2_SP3_Express',
    WINDOWS_SERVER_2016_FRENCH_FULL_BASE = 'Windows_Server-2016-French-Full-Base',
    WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP2_ENTERPRISE = 'Windows_Server-2016-Japanese-Full-SQL_2016_SP2_Enterprise',
    WINDOWS_SERVER_2019_CZECH_FULL_BASE = 'Windows_Server-2019-Czech-Full-Base',
    WINDOWS_SERVER_1809_ENGLISH_CORE_BASE = 'Windows_Server-1809-English-Core-Base',
    WINDOWS_SERVER_1809_ENGLISH_CORE_CONTAINERSLATEST = 'Windows_Server-1809-English-Core-ContainersLatest',
    WINDOWS_SERVER_2003_R2_SP2_LANGUAGE_PACKS_64BIT_SQL_2005_SP4_EXPRESS = 'Windows_Server-2003-R2_SP2-Language_Packs-64Bit-SQL_2005_SP4_Express',
    WINDOWS_SERVER_2012_R2_RTM_TURKISH_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Turkish-64Bit-Base',
    WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2012_SP4_WEB = 'Windows_Server-2012-RTM-Japanese-64Bit-SQL_2012_SP4_Web',
    WINDOWS_SERVER_2012_RTM_POLISH_64BIT_BASE = 'Windows_Server-2012-RTM-Polish-64Bit-Base',
    WINDOWS_SERVER_2012_RTM_SPANISH_64BIT_BASE = 'Windows_Server-2012-RTM-Spanish-64Bit-Base',
    WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP1_ENTERPRISE = 'Windows_Server-2016-English-Full-SQL_2016_SP1_Enterprise',
    WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP2_EXPRESS = 'Windows_Server-2016-Japanese-Full-SQL_2016_SP2_Express',
    WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP2_ENTERPRISE = 'Windows_Server-2019-English-Full-SQL_2016_SP2_Enterprise',
    WINDOWS_SERVER_1709_ENGLISH_CORE_BASE = 'Windows_Server-1709-English-Core-Base',
    WINDOWS_SERVER_2008_R2_SP1_ENGLISH_61BIT_SQL_2012_RTM_SP2_ENTERPRISE = 'Windows_Server-2008-R2_SP1-English-64Bit-SQL_2012_RTM_SP2_Enterprise',
    WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2012_SP4_STANDARD = 'Windows_Server-2008-R2_SP1-English-64Bit-SQL_2012_SP4_Standard',
    WINDOWS_SERVER_2008_SP2_PORTUGESE_BRAZIL_32BIT_BASE = 'Windows_Server-2008-SP2-Portuguese_Brazil-32Bit-Base',
    WINDOWS_SERVER_2008_SP2_PORTUGUESE_BRAZIL_32BIT_BASE = 'Windows_Server-2008-SP2-Portugese_Brazil-32Bit-Base',
    WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2014_SP2_STANDARD = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-SQL_2014_SP2_Standard',
    WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2012_SP4_EXPRESS = 'Windows_Server-2012-RTM-Japanese-64Bit-SQL_2012_SP4_Express',
    WINDOWS_SERVER_2012_RTM_PORTUGESE_PORTUGAL_64BIT_BASE = 'Windows_Server-2012-RTM-Portugese_Portugal-64Bit-Base',
    WINDOWS_SERVER_2012_RTM_PORTUGUESE_PORTUGAL_64BIT_BASE = 'Windows_Server-2012-RTM-Portuguese_Portugal-64Bit-Base',
    WINDOWS_SERVER_2016_CZECH_FULL_BASE = 'Windows_Server-2016-Czech-Full-Base',
    WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP1_STANDARD = 'Windows_Server-2016-Japanese-Full-SQL_2016_SP1_Standard',
    WINDOWS_SERVER_2019_DUTCH_FULL_BASE = 'Windows_Server-2019-Dutch-Full-Base',
    WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_CORE = 'Windows_Server-2008-R2_SP1-English-64Bit-Core',
    WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP2_WEB = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2016_SP2_Web',
    WINDOWS_SERVER_2012_R2_RTM_KOREAN_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Korean-64Bit-Base',
    WINDOWS_SERVER_2012_RTM_DUTCH_64BIT_BASE = 'Windows_Server-2012-RTM-Dutch-64Bit-Base',
    WINDOWS_SERVER_2016_ENGLISH_64BIT_SQL_2012_SP4_ENTERPRISE = 'Windows_Server-2016-English-64Bit-SQL_2012_SP4_Enterprise',
    WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP1_STANDARD = 'Windows_Server-2016-English-Core-SQL_2016_SP1_Standard',
    WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP2_EXPRESS = 'Windows_Server-2016-English-Core-SQL_2016_SP2_Express',
    WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP2_WEB = 'Windows_Server-2016-English-Core-SQL_2016_SP2_Web',
    WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2017_STANDARD = 'Windows_Server-2016-English-Full-SQL_2017_Standard',
    WINDOWS_SERVER_2019_PORTUGESE_BRAZIL_FULL_BASE = 'Windows_Server-2019-Portugese_Brazil-Full-Base',
    WINDOWS_SERVER_2019_PORTUGUESE_BRAZIL_FULL_BASE = 'Windows_Server-2019-Portuguese_Brazil-Full-Base',
    WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2008_R2_SP3_STANDARD = 'Windows_Server-2008-R2_SP1-English-64Bit-SQL_2008_R2_SP3_Standard',
    WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SHAREPOINT_2010_SP2_FOUNDATION = 'Windows_Server-2008-R2_SP1-English-64Bit-SharePoint_2010_SP2_Foundation',
    WINDOWS_SERVER_2012_R2_RTM_ENGLISH_P3 = 'Windows_Server-2012-R2_RTM-English-P3',
    WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2014_SP3_STANDARD = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-SQL_2014_SP3_Standard',
    WINDOWS_SERVER_2012_R2_RTM_SPANISH_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Spanish-64Bit-Base',
    WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP3_EXPRESS = 'Windows_Server-2012-RTM-Japanese-64Bit-SQL_2014_SP3_Express',
    WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP2_STANDARD = 'Windows_Server-2016-English-Core-SQL_2016_SP2_Standard',
    WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP2_STANDARD = 'Windows_Server-2016-Japanese-Full-SQL_2016_SP2_Standard',
    WINDOWS_SERVER_2019_PORTUGESE_PORTUGAL_FULL_BASE = 'Windows_Server-2019-Portugese_Portugal-Full-Base',
    WINDOWS_SERVER_2019_PORTUGUESE_PORTUGAL_FULL_BASE = 'Windows_Server-2019-Portuguese_Portugal-Full-Base',
    WINDOWS_SERVER_2019_SWEDISH_FULL_BASE = 'Windows_Server-2019-Swedish-Full-Base',
    WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_HYPERV = 'Windows_Server-2012-R2_RTM-English-64Bit-HyperV',
    WINDOWS_SERVER_2012_RTM_KOREAN_64BIT_BASE = 'Windows_Server-2012-RTM-Korean-64Bit-Base',
    WINDOWS_SERVER_2012_RTM_RUSSIAN_64BIT_BASE = 'Windows_Server-2012-RTM-Russian-64Bit-Base',
    WINDOWS_SERVER_2016_CHINESE_TRADITIONAL_FULL_BASE = 'Windows_Server-2016-Chinese_Traditional-Full-Base',
    WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP2_WEB = 'Windows_Server-2016-English-Full-SQL_2016_SP2_Web',
    WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2017_EXPRESS = 'Windows_Server-2016-English-Full-SQL_2017_Express',
    WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2019_ENTERPRISE = 'Windows_Server-2022-Japanese-Full-SQL_2019_Enterprise',
    WINDOWS_SERVER_2022_PORTUGUESE_BRAZIL_FULL_BASE = 'Windows_Server-2022-Portuguese_Brazil-Full-Base',
    WINDOWS_SERVER_2022_ITALIAN_FULL_BASE = 'Windows_Server-2022-Italian-Full-Base',
    WINDOWS_SERVER_2022_ENGLISH_FULL_CONTAINERSLATEST = 'Windows_Server-2022-English-Full-ContainersLatest',
    WINDOWS_SERVER_2022_RUSSIAN_FULL_BASE = 'Windows_Server-2022-Russian-Full-Base',
    WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2019_EXPRESS = 'Windows_Server-2022-English-Full-SQL_2019_Express',
    WINDOWS_SERVER_2022_POLISH_FULL_BASE = 'Windows_Server-2022-Polish-Full-Base',
    WINDOWS_SERVER_2022_ENGLISH_CORE_BASE = 'Windows_Server-2022-English-Core-Base',
    WINDOWS_SERVER_2022_HUNGARIAN_FULL_BASE = 'Windows_Server-2022-Hungarian-Full-Base',
    WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2017_EXPRESS = 'Windows_Server-2022-English-Full-SQL_2017_Express',
    WINDOWS_SERVER_2022_GERMAN_FULL_BASE = 'Windows_Server-2022-German-Full-Base',
    WINDOWS_SERVER_2022_ENGLISH_CORE_CONTAINERSLATEST = 'Windows_Server-2022-English-Core-ContainersLatest',
    WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2019_STANDARD = 'Windows_Server-2022-English-Full-SQL_2019_Standard',
    WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2017_WEB = 'Windows_Server-2022-Japanese-Full-SQL_2017_Web',
    WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2017_WEB = 'Windows_Server-2022-English-Full-SQL_2017_Web',
    WINDOWS_SERVER_2022_JAPANESE_FULL_BASE = 'Windows_Server-2022-Japanese-Full-Base',
    WINDOWS_SERVER_2022_KOREAN_FULL_BASE = 'Windows_Server-2022-Korean-Full-Base',
    WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2017_ENTERPRISE = 'Windows_Server-2022-Japanese-Full-SQL_2017_Enterprise',
    WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2019_STANDARD = 'Windows_Server-2022-Japanese-Full-SQL_2019_Standard',
    WINDOWS_SERVER_2022_CHINESE_SIMPLIFIED_FULL_BASE = 'Windows_Server-2022-Chinese_Simplified-Full-Base',
    WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2019_WEB = 'Windows_Server-2022-English-Full-SQL_2019_Web',
    WINDOWS_SERVER_2022_SPANISH_FULL_BASE = 'Windows_Server-2022-Spanish-Full-Base',
    WINDOWS_SERVER_2022_ENGLISH_CORE_ECS_OPTIMIZED = 'Windows_Server-2022-English-Core-ECS_Optimized',
    WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2017_STANDARD = 'Windows_Server-2022-English-Full-SQL_2017_Standard',
    WINDOWS_SERVER_2022_CHINESE_TRADITIONAL_FULL_BASE = 'Windows_Server-2022-Chinese_Traditional-Full-Base',
    WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2019_ENTERPRISE = 'Windows_Server-2022-English-Full-SQL_2019_Enterprise',
    WINDOWS_SERVER_2022_FRENCH_FULL_BASE = 'Windows_Server-2022-French-Full-Base',
    WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2017_STANDARD = 'Windows_Server-2022-Japanese-Full-SQL_2017_Standard',
    WINDOWS_SERVER_2022_ENGLISH_FULL_BASE = 'Windows_Server-2022-English-Full-Base',
    WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2019_WEB = 'Windows_Server-2022-Japanese-Full-SQL_2019_Web',
    WINDOWS_SERVER_2022_TURKISH_FULL_BASE = 'Windows_Server-2022-Turkish-Full-Base',
    WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2017_ENTERPRISE = 'Windows_Server-2022-English-Full-SQL_2017_Enterprise',
    WINDOWS_SERVER_2022_PORTUGUESE_PORTUGAL_FULL_BASE = 'Windows_Server-2022-Portuguese_Portugal-Full-Base',
    WINDOWS_SERVER_2022_CZECH_FULL_BASE = 'Windows_Server-2022-Czech-Full-Base',
    WINDOWS_SERVER_2022_ENGLISH_FULL_ECS_OPTIMIZED = 'Windows_Server-2022-English-Full-ECS_Optimized',
    WINDOWS_SERVER_2022_DUTCH_FULL_BASE = 'Windows_Server-2022-Dutch-Full-Base',
    WINDOWS_SERVER_2022_SWEDISH_FULL_BASE = 'Windows_Server-2022-Swedish-Full-Base',
}

The Windows version to use for the WindowsImage

member WINDOWS_SERVER_1709_ENGLISH_CORE_BASE

WINDOWS_SERVER_1709_ENGLISH_CORE_BASE = 'Windows_Server-1709-English-Core-Base'

member WINDOWS_SERVER_1709_ENGLISH_CORE_CONTAINERSLATEST

WINDOWS_SERVER_1709_ENGLISH_CORE_CONTAINERSLATEST = 'Windows_Server-1709-English-Core-ContainersLatest'

member WINDOWS_SERVER_1803_ENGLISH_CORE_BASE

WINDOWS_SERVER_1803_ENGLISH_CORE_BASE = 'Windows_Server-1803-English-Core-Base'

member WINDOWS_SERVER_1803_ENGLISH_CORE_CONTAINERSLATEST

WINDOWS_SERVER_1803_ENGLISH_CORE_CONTAINERSLATEST = 'Windows_Server-1803-English-Core-ContainersLatest'

member WINDOWS_SERVER_1809_ENGLISH_CORE_BASE

WINDOWS_SERVER_1809_ENGLISH_CORE_BASE = 'Windows_Server-1809-English-Core-Base'

member WINDOWS_SERVER_1809_ENGLISH_CORE_CONTAINERSLATEST

WINDOWS_SERVER_1809_ENGLISH_CORE_CONTAINERSLATEST = 'Windows_Server-1809-English-Core-ContainersLatest'

member WINDOWS_SERVER_2003_R2_SP2_ENGLISH_32BIT_BASE

WINDOWS_SERVER_2003_R2_SP2_ENGLISH_32BIT_BASE = 'Windows_Server-2003-R2_SP2-English-32Bit-Base'

member WINDOWS_SERVER_2003_R2_SP2_ENGLISH_64BIT_BASE

WINDOWS_SERVER_2003_R2_SP2_ENGLISH_64BIT_BASE = 'Windows_Server-2003-R2_SP2-English-64Bit-Base'

member WINDOWS_SERVER_2003_R2_SP2_ENGLISH_64BIT_SQL_2005_SP4_EXPRESS

WINDOWS_SERVER_2003_R2_SP2_ENGLISH_64BIT_SQL_2005_SP4_EXPRESS = 'Windows_Server-2003-R2_SP2-English-64Bit-SQL_2005_SP4_Express'

member WINDOWS_SERVER_2003_R2_SP2_ENGLISH_64BIT_SQL_2005_SP4_STANDARD

WINDOWS_SERVER_2003_R2_SP2_ENGLISH_64BIT_SQL_2005_SP4_STANDARD = 'Windows_Server-2003-R2_SP2-English-64Bit-SQL_2005_SP4_Standard'

member WINDOWS_SERVER_2003_R2_SP2_LANGUAGE_PACKS_32BIT_BASE

WINDOWS_SERVER_2003_R2_SP2_LANGUAGE_PACKS_32BIT_BASE = 'Windows_Server-2003-R2_SP2-Language_Packs-32Bit-Base'

member WINDOWS_SERVER_2003_R2_SP2_LANGUAGE_PACKS_64BIT_BASE

WINDOWS_SERVER_2003_R2_SP2_LANGUAGE_PACKS_64BIT_BASE = 'Windows_Server-2003-R2_SP2-Language_Packs-64Bit-Base'

member WINDOWS_SERVER_2003_R2_SP2_LANGUAGE_PACKS_64BIT_SQL_2005_SP4_EXPRESS

WINDOWS_SERVER_2003_R2_SP2_LANGUAGE_PACKS_64BIT_SQL_2005_SP4_EXPRESS = 'Windows_Server-2003-R2_SP2-Language_Packs-64Bit-SQL_2005_SP4_Express'

member WINDOWS_SERVER_2003_R2_SP2_LANGUAGE_PACKS_64BIT_SQL_2005_SP4_STANDARD

WINDOWS_SERVER_2003_R2_SP2_LANGUAGE_PACKS_64BIT_SQL_2005_SP4_STANDARD = 'Windows_Server-2003-R2_SP2-Language_Packs-64Bit-SQL_2005_SP4_Standard'

member WINDOWS_SERVER_2007_R2_SP1_LANGUAGE_PACKS_64BIT_BASE

WINDOWS_SERVER_2007_R2_SP1_LANGUAGE_PACKS_64BIT_BASE = 'Windows_Server-2008-R2_SP1-Language_Packs-64Bit-Base'

member WINDOWS_SERVER_2008_R2_SP1_CHINESE_HONG_KONG_SAR_64BIT_BASE

WINDOWS_SERVER_2008_R2_SP1_CHINESE_HONG_KONG_SAR_64BIT_BASE = 'Windows_Server-2008-R2_SP1-Chinese_Hong_Kong_SAR-64Bit-Base'

member WINDOWS_SERVER_2008_R2_SP1_CHINESE_PRC_64BIT_BASE

WINDOWS_SERVER_2008_R2_SP1_CHINESE_PRC_64BIT_BASE = 'Windows_Server-2008-R2_SP1-Chinese_PRC-64Bit-Base'

member WINDOWS_SERVER_2008_R2_SP1_ENGLISH_61BIT_SQL_2012_RTM_SP2_ENTERPRISE

WINDOWS_SERVER_2008_R2_SP1_ENGLISH_61BIT_SQL_2012_RTM_SP2_ENTERPRISE = 'Windows_Server-2008-R2_SP1-English-64Bit-SQL_2012_RTM_SP2_Enterprise'

member WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_BASE

WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_BASE = 'Windows_Server-2008-R2_SP1-English-64Bit-Base'

member WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_CORE

WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_CORE = 'Windows_Server-2008-R2_SP1-English-64Bit-Core'

member WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_CORE_SQL_2012_SP4_STANDARD

WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_CORE_SQL_2012_SP4_STANDARD = 'Windows_Server-2008-R2_SP1-English-64Bit-Core_SQL_2012_SP4_Standard'

member WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SHAREPOINT_2010_SP2_FOUNDATION

WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SHAREPOINT_2010_SP2_FOUNDATION = 'Windows_Server-2008-R2_SP1-English-64Bit-SharePoint_2010_SP2_Foundation'

member WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2008_R2_SP3_EXPRESS

WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2008_R2_SP3_EXPRESS = 'Windows_Server-2008-R2_SP1-English-64Bit-SQL_2008_R2_SP3_Express'

member WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2008_R2_SP3_STANDARD

WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2008_R2_SP3_STANDARD = 'Windows_Server-2008-R2_SP1-English-64Bit-SQL_2008_R2_SP3_Standard'

member WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2008_R2_SP3_WEB

WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2008_R2_SP3_WEB = 'Windows_Server-2008-R2_SP1-English-64Bit-SQL_2008_R2_SP3_Web'

member WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2012_SP4_ENTERPRISE

WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2012_SP4_ENTERPRISE = 'Windows_Server-2008-R2_SP1-English-64Bit-SQL_2012_SP4_Enterprise'

member WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2012_SP4_EXPRESS

WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2012_SP4_EXPRESS = 'Windows_Server-2008-R2_SP1-English-64Bit-SQL_2012_SP4_Express'

member WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2012_SP4_STANDARD

WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2012_SP4_STANDARD = 'Windows_Server-2008-R2_SP1-English-64Bit-SQL_2012_SP4_Standard'

member WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2012_SP4_WEB

WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2012_SP4_WEB = 'Windows_Server-2008-R2_SP1-English-64Bit-SQL_2012_SP4_Web'

member WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_BASE

WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_BASE = 'Windows_Server-2008-R2_SP1-Japanese-64Bit-Base'

member WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2008_R2_SP3_EXPRESS

WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2008_R2_SP3_EXPRESS = 'Windows_Server-2008-R2_SP1-Japanese-64Bit-SQL_2008_R2_SP3_Express'

member WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2008_R2_SP3_STANDARD

WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2008_R2_SP3_STANDARD = 'Windows_Server-2008-R2_SP1-Japanese-64Bit-SQL_2008_R2_SP3_Standard'

member WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2008_R2_SP3_WEB

WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2008_R2_SP3_WEB = 'Windows_Server-2008-R2_SP1-Japanese-64Bit-SQL_2008_R2_SP3_Web'

member WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2012_SP4_EXPRESS

WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2012_SP4_EXPRESS = 'Windows_Server-2008-R2_SP1-Japanese-64Bit-SQL_2012_SP4_Express'

member WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2012_SP4_STANDARD

WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2012_SP4_STANDARD = 'Windows_Server-2008-R2_SP1-Japanese-64Bit-SQL_2012_SP4_Standard'

member WINDOWS_SERVER_2008_R2_SP1_KOREAN_64BIT_BASE

WINDOWS_SERVER_2008_R2_SP1_KOREAN_64BIT_BASE = 'Windows_Server-2008-R2_SP1-Korean-64Bit-Base'

member WINDOWS_SERVER_2008_R2_SP1_LANGUAGE_PACKS_64BIT_SQL_2008_R2_SP3_EXPRESS

WINDOWS_SERVER_2008_R2_SP1_LANGUAGE_PACKS_64BIT_SQL_2008_R2_SP3_EXPRESS = 'Windows_Server-2008-R2_SP1-Language_Packs-64Bit-SQL_2008_R2_SP3_Express'

member WINDOWS_SERVER_2008_R2_SP1_LANGUAGE_PACKS_64BIT_SQL_2008_R2_SP3_STANDARD

WINDOWS_SERVER_2008_R2_SP1_LANGUAGE_PACKS_64BIT_SQL_2008_R2_SP3_STANDARD = 'Windows_Server-2008-R2_SP1-Language_Packs-64Bit-SQL_2008_R2_SP3_Standard'

member WINDOWS_SERVER_2008_R2_SP1_PORTUGESE_BRAZIL_64BIT_BASE

WINDOWS_SERVER_2008_R2_SP1_PORTUGESE_BRAZIL_64BIT_BASE = 'Windows_Server-2008-R2_SP1-Portugese_Brazil-64Bit-Base'

Deprecated
- use WINDOWS_SERVER_2008_R2_SP1_PORTUGUESE_BRAZIL_64BIT_BASE

member WINDOWS_SERVER_2008_R2_SP1_PORTUGUESE_BRAZIL_64BIT_BASE

WINDOWS_SERVER_2008_R2_SP1_PORTUGUESE_BRAZIL_64BIT_BASE = 'Windows_Server-2008-R2_SP1-Portuguese_Brazil-64Bit-Base'

member WINDOWS_SERVER_2008_SP2_ENGLISH_32BIT_BASE

WINDOWS_SERVER_2008_SP2_ENGLISH_32BIT_BASE = 'Windows_Server-2008-SP2-English-32Bit-Base'

member WINDOWS_SERVER_2008_SP2_ENGLISH_64BIT_BASE

WINDOWS_SERVER_2008_SP2_ENGLISH_64BIT_BASE = 'Windows_Server-2008-SP2-English-64Bit-Base'

member WINDOWS_SERVER_2008_SP2_ENGLISH_64BIT_SQL_2008_SP4_EXPRESS

WINDOWS_SERVER_2008_SP2_ENGLISH_64BIT_SQL_2008_SP4_EXPRESS = 'Windows_Server-2008-SP2-English-64Bit-SQL_2008_SP4_Express'

member WINDOWS_SERVER_2008_SP2_ENGLISH_64BIT_SQL_2008_SP4_STANDARD

WINDOWS_SERVER_2008_SP2_ENGLISH_64BIT_SQL_2008_SP4_STANDARD = 'Windows_Server-2008-SP2-English-64Bit-SQL_2008_SP4_Standard'

member WINDOWS_SERVER_2008_SP2_PORTUGESE_BRAZIL_32BIT_BASE

WINDOWS_SERVER_2008_SP2_PORTUGESE_BRAZIL_32BIT_BASE = 'Windows_Server-2008-SP2-Portuguese_Brazil-32Bit-Base'

Deprecated
- use WINDOWS_SERVER_2008_SP2_PORTUGUESE_BRAZIL_32BIT_BASE

member WINDOWS_SERVER_2008_SP2_PORTUGUESE_BRAZIL_32BIT_BASE

WINDOWS_SERVER_2008_SP2_PORTUGUESE_BRAZIL_32BIT_BASE = 'Windows_Server-2008-SP2-Portugese_Brazil-32Bit-Base'

member WINDOWS_SERVER_2012_R2_RTM_CHINESE_SIMPLIFIED_64BIT_BASE

WINDOWS_SERVER_2012_R2_RTM_CHINESE_SIMPLIFIED_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Chinese_Simplified-64Bit-Base'

member WINDOWS_SERVER_2012_R2_RTM_CHINESE_TRADITIONAL_64BIT_BASE

WINDOWS_SERVER_2012_R2_RTM_CHINESE_TRADITIONAL_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Chinese_Traditional-64Bit-Base'

member WINDOWS_SERVER_2012_R2_RTM_CHINESE_TRADITIONAL_HONG_KONG_64BIT_BASE

WINDOWS_SERVER_2012_R2_RTM_CHINESE_TRADITIONAL_HONG_KONG_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Chinese_Traditional_Hong_Kong-64Bit-Base'

member WINDOWS_SERVER_2012_R2_RTM_CZECH_64BIT_BASE

WINDOWS_SERVER_2012_R2_RTM_CZECH_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Czech-64Bit-Base'

member WINDOWS_SERVER_2012_R2_RTM_DUTCH_64BIT_BASE

WINDOWS_SERVER_2012_R2_RTM_DUTCH_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Dutch-64Bit-Base'

member WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_BASE

WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_BASE = 'Windows_Server-2012-R2_RTM-English-64Bit-Base'

member WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_CORE

WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_CORE = 'Windows_Server-2012-R2_RTM-English-64Bit-Core'

member WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_HYPERV

WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_HYPERV = 'Windows_Server-2012-R2_RTM-English-64Bit-HyperV'

member WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2012_SP4_ENTERPRISE

WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2012_SP4_ENTERPRISE = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2012_SP4_Enterprise'

member WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP2_ENTERPRISE

WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP2_ENTERPRISE = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2014_SP2_Enterprise'

member WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP2_EXPRESS

WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP2_EXPRESS = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2014_SP2_Express'

member WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP2_STANDARD

WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP2_STANDARD = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2014_SP2_Standard'

member WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP2_WEB

WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP2_WEB = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2014_SP2_Web'

member WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP3_ENTERPRISE

WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP3_ENTERPRISE = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2014_SP3_Enterprise'

member WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP3_EXPRESS

WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP3_EXPRESS = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2014_SP3_Express'

member WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP3_STANDARD

WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP3_STANDARD = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2014_SP3_Standard'

member WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP3_WEB

WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP3_WEB = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2014_SP3_Web'

member WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP1_ENTERPRISE

WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP1_ENTERPRISE = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2016_SP1_Enterprise'

member WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP1_EXPRESS

WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP1_EXPRESS = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2016_SP1_Express'

member WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP1_STANDARD

WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP1_STANDARD = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2016_SP1_Standard'

member WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP1_WEB

WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP1_WEB = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2016_SP1_Web'

member WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP2_ENTERPRISE

WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP2_ENTERPRISE = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2016_SP2_Enterprise'

member WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP2_EXPRESS

WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP2_EXPRESS = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2016_SP2_Express'

member WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP2_STANDARD

WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP2_STANDARD = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2016_SP2_Standard'

member WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP2_WEB

WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP2_WEB = 'Windows_Server-2012-R2_RTM-English-64Bit-SQL_2016_SP2_Web'

member WINDOWS_SERVER_2012_R2_RTM_ENGLISH_DEEP_LEARNING

WINDOWS_SERVER_2012_R2_RTM_ENGLISH_DEEP_LEARNING = 'Windows_Server-2012-R2_RTM-English-Deep-Learning'

member WINDOWS_SERVER_2012_R2_RTM_ENGLISH_P3

WINDOWS_SERVER_2012_R2_RTM_ENGLISH_P3 = 'Windows_Server-2012-R2_RTM-English-P3'

member WINDOWS_SERVER_2012_R2_RTM_FRENCH_64BIT_BASE

WINDOWS_SERVER_2012_R2_RTM_FRENCH_64BIT_BASE = 'Windows_Server-2012-R2_RTM-French-64Bit-Base'

member WINDOWS_SERVER_2012_R2_RTM_GERMAN_64BIT_BASE

WINDOWS_SERVER_2012_R2_RTM_GERMAN_64BIT_BASE = 'Windows_Server-2012-R2_RTM-German-64Bit-Base'

member WINDOWS_SERVER_2012_R2_RTM_HUNGARIAN_64BIT_BASE

WINDOWS_SERVER_2012_R2_RTM_HUNGARIAN_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Hungarian-64Bit-Base'

member WINDOWS_SERVER_2012_R2_RTM_ITALIAN_64BIT_BASE

WINDOWS_SERVER_2012_R2_RTM_ITALIAN_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Italian-64Bit-Base'

member WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_BASE

WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-Base'

member WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2014_SP2_EXPRESS

WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2014_SP2_EXPRESS = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-SQL_2014_SP2_Express'

member WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2014_SP2_STANDARD

WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2014_SP2_STANDARD = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-SQL_2014_SP2_Standard'

member WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2014_SP3_EXPRESS

WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2014_SP3_EXPRESS = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-SQL_2014_SP3_Express'

member WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2014_SP3_STANDARD

WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2014_SP3_STANDARD = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-SQL_2014_SP3_Standard'

member WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP1_ENTERPRISE

WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP1_ENTERPRISE = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-SQL_2016_SP1_Enterprise'

member WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP1_EXPRESS

WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP1_EXPRESS = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-SQL_2016_SP1_Express'

member WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP1_STANDARD

WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP1_STANDARD = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-SQL_2016_SP1_Standard'

member WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP1_WEB

WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP1_WEB = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-SQL_2016_SP1_Web'

member WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP2_ENTERPRISE

WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP2_ENTERPRISE = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-SQL_2016_SP2_Enterprise'

member WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP2_STANDARD

WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP2_STANDARD = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-SQL_2016_SP2_Standard'

member WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP2_WEB

WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP2_WEB = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-SQL_2016_SP2_Web'

member WINDOWS_SERVER_2012_R2_RTM_KOREAN_64BIT_BASE

WINDOWS_SERVER_2012_R2_RTM_KOREAN_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Korean-64Bit-Base'

member WINDOWS_SERVER_2012_R2_RTM_POLISH_64BIT_BASE

WINDOWS_SERVER_2012_R2_RTM_POLISH_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Polish-64Bit-Base'

member WINDOWS_SERVER_2012_R2_RTM_PORTUGESE_BRAZIL_64BIT_BASE

WINDOWS_SERVER_2012_R2_RTM_PORTUGESE_BRAZIL_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Portugese_Brazil-64Bit-Base'

Deprecated
- use WINDOWS_SERVER_2012_R2_RTM_PORTUGUESE_BRAZIL_64BIT_BASE

member WINDOWS_SERVER_2012_R2_RTM_PORTUGESE_PORTUGAL_64BIT_BASE

WINDOWS_SERVER_2012_R2_RTM_PORTUGESE_PORTUGAL_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Portugese_Portugal-64Bit-Base'

Deprecated
- use WINDOWS_SERVER_2012_R2_RTM_PORTUGUESE_PORTUGAL_64BIT_BASE

member WINDOWS_SERVER_2012_R2_RTM_PORTUGUESE_BRAZIL_64BIT_BASE

WINDOWS_SERVER_2012_R2_RTM_PORTUGUESE_BRAZIL_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Portuguese_Brazil-64Bit-Base'

member WINDOWS_SERVER_2012_R2_RTM_PORTUGUESE_PORTUGAL_64BIT_BASE

WINDOWS_SERVER_2012_R2_RTM_PORTUGUESE_PORTUGAL_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Portuguese_Portugal-64Bit-Base'

member WINDOWS_SERVER_2012_R2_RTM_RUSSIAN_64BIT_BASE

WINDOWS_SERVER_2012_R2_RTM_RUSSIAN_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Russian-64Bit-Base'

member WINDOWS_SERVER_2012_R2_RTM_SPANISH_64BIT_BASE

WINDOWS_SERVER_2012_R2_RTM_SPANISH_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Spanish-64Bit-Base'

member WINDOWS_SERVER_2012_R2_RTM_SWEDISH_64BIT_BASE

WINDOWS_SERVER_2012_R2_RTM_SWEDISH_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Swedish-64Bit-Base'

member WINDOWS_SERVER_2012_R2_RTM_TURKISH_64BIT_BASE

WINDOWS_SERVER_2012_R2_RTM_TURKISH_64BIT_BASE = 'Windows_Server-2012-R2_RTM-Turkish-64Bit-Base'

member WINDOWS_SERVER_2012_R2_SP1_PORTUGESE_BRAZIL_64BIT_CORE

WINDOWS_SERVER_2012_R2_SP1_PORTUGESE_BRAZIL_64BIT_CORE = 'Windows_Server-2008-R2_SP1-Portugese_Brazil-64Bit-Core'

Deprecated
- use WINDOWS_SERVER_2012_R2_SP1_PORTUGUESE_BRAZIL_64BIT_CORE

member WINDOWS_SERVER_2012_R2_SP1_PORTUGUESE_BRAZIL_64BIT_CORE

WINDOWS_SERVER_2012_R2_SP1_PORTUGUESE_BRAZIL_64BIT_CORE = 'Windows_Server-2008-R2_SP1-Portuguese_Brazil-64Bit-Core'

member WINDOWS_SERVER_2012_RTM_CHINESE_SIMPLIFIED_64BIT_BASE

WINDOWS_SERVER_2012_RTM_CHINESE_SIMPLIFIED_64BIT_BASE = 'Windows_Server-2012-RTM-Chinese_Simplified-64Bit-Base'

member WINDOWS_SERVER_2012_RTM_CHINESE_TRADITIONAL_64BIT_BASE

WINDOWS_SERVER_2012_RTM_CHINESE_TRADITIONAL_64BIT_BASE = 'Windows_Server-2012-RTM-Chinese_Traditional-64Bit-Base'

member WINDOWS_SERVER_2012_RTM_CHINESE_TRADITIONAL_HONG_KONG_SAR_64BIT_BASE

WINDOWS_SERVER_2012_RTM_CHINESE_TRADITIONAL_HONG_KONG_SAR_64BIT_BASE = 'Windows_Server-2012-RTM-Chinese_Traditional_Hong_Kong_SAR-64Bit-Base'

member WINDOWS_SERVER_2012_RTM_CZECH_64BIT_BASE

WINDOWS_SERVER_2012_RTM_CZECH_64BIT_BASE = 'Windows_Server-2012-RTM-Czech-64Bit-Base'

member WINDOWS_SERVER_2012_RTM_DUTCH_64BIT_BASE

WINDOWS_SERVER_2012_RTM_DUTCH_64BIT_BASE = 'Windows_Server-2012-RTM-Dutch-64Bit-Base'

member WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_2014_SP3_WEB

WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_2014_SP3_WEB = 'Windows_Server-2012-RTM-English-64Bit-SQL_2014_SP3_Web'

member WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_BASE

WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_BASE = 'Windows_Server-2012-RTM-English-64Bit-Base'

member WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2007_R2_SP3_WEB

WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2007_R2_SP3_WEB = 'Windows_Server-2012-RTM-English-64Bit-SQL_2008_R2_SP3_Web'

member WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2008_R2_SP3_EXPRESS

WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2008_R2_SP3_EXPRESS = 'Windows_Server-2012-RTM-English-64Bit-SQL_2008_R2_SP3_Express'

member WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2008_R2_SP3_STANDARD

WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2008_R2_SP3_STANDARD = 'Windows_Server-2012-RTM-English-64Bit-SQL_2008_R2_SP3_Standard'

member WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2012_SP4_EXPRESS

WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2012_SP4_EXPRESS = 'Windows_Server-2012-RTM-English-64Bit-SQL_2012_SP4_Express'

member WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2012_SP4_STANDARD

WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2012_SP4_STANDARD = 'Windows_Server-2012-RTM-English-64Bit-SQL_2012_SP4_Standard'

member WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2012_SP4_WEB

WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2012_SP4_WEB = 'Windows_Server-2012-RTM-English-64Bit-SQL_2012_SP4_Web'

member WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP2_EXPRESS

WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP2_EXPRESS = 'Windows_Server-2012-RTM-English-64Bit-SQL_2014_SP2_Express'

member WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP2_STANDARD

WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP2_STANDARD = 'Windows_Server-2012-RTM-English-64Bit-SQL_2014_SP2_Standard'

member WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP2_WEB

WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP2_WEB = 'Windows_Server-2012-RTM-English-64Bit-SQL_2014_SP2_Web'

member WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP3_EXPRESS

WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP3_EXPRESS = 'Windows_Server-2012-RTM-English-64Bit-SQL_2014_SP3_Express'

member WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP3_STANDARD

WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP3_STANDARD = 'Windows_Server-2012-RTM-English-64Bit-SQL_2014_SP3_Standard'

member WINDOWS_SERVER_2012_RTM_FRENCH_64BIT_BASE

WINDOWS_SERVER_2012_RTM_FRENCH_64BIT_BASE = 'Windows_Server-2012-RTM-French-64Bit-Base'

member WINDOWS_SERVER_2012_RTM_GERMAN_64BIT_BASE

WINDOWS_SERVER_2012_RTM_GERMAN_64BIT_BASE = 'Windows_Server-2012-RTM-German-64Bit-Base'

member WINDOWS_SERVER_2012_RTM_HUNGARIAN_64BIT_BASE

WINDOWS_SERVER_2012_RTM_HUNGARIAN_64BIT_BASE = 'Windows_Server-2012-RTM-Hungarian-64Bit-Base'

member WINDOWS_SERVER_2012_RTM_ITALIAN_64BIT_BASE

WINDOWS_SERVER_2012_RTM_ITALIAN_64BIT_BASE = 'Windows_Server-2012-RTM-Italian-64Bit-Base'

member WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_2012_SP4_STANDARD

WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_2012_SP4_STANDARD = 'Windows_Server-2012-RTM-Japanese-64Bit-SQL_2012_SP4_Standard'

member WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_BASE

WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_BASE = 'Windows_Server-2012-RTM-Japanese-64Bit-Base'

member WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2008_R2_SP3_EXPRESS

WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2008_R2_SP3_EXPRESS = 'Windows_Server-2012-RTM-Japanese-64Bit-SQL_2008_R2_SP3_Express'

member WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2008_R2_SP3_STANDARD

WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2008_R2_SP3_STANDARD = 'Windows_Server-2012-RTM-Japanese-64Bit-SQL_2008_R2_SP3_Standard'

member WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2012_SP4_EXPRESS

WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2012_SP4_EXPRESS = 'Windows_Server-2012-RTM-Japanese-64Bit-SQL_2012_SP4_Express'

member WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2012_SP4_WEB

WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2012_SP4_WEB = 'Windows_Server-2012-RTM-Japanese-64Bit-SQL_2012_SP4_Web'

member WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP2_EXPRESS

WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP2_EXPRESS = 'Windows_Server-2012-RTM-Japanese-64Bit-SQL_2014_SP2_Express'

member WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP2_STANDARD

WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP2_STANDARD = 'Windows_Server-2012-RTM-Japanese-64Bit-SQL_2014_SP2_Standard'

member WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP2_WEB

WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP2_WEB = 'Windows_Server-2012-RTM-Japanese-64Bit-SQL_2014_SP2_Web'

member WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP3_EXPRESS

WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP3_EXPRESS = 'Windows_Server-2012-RTM-Japanese-64Bit-SQL_2014_SP3_Express'

member WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP3_STANDARD

WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP3_STANDARD = 'Windows_Server-2012-RTM-Japanese-64Bit-SQL_2014_SP3_Standard'

member WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP3_WEB

WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP3_WEB = 'Windows_Server-2012-RTM-Japanese-64Bit-SQL_2014_SP3_Web'

member WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2016_SP2_EXPRESS

WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2016_SP2_EXPRESS = 'Windows_Server-2012-R2_RTM-Japanese-64Bit-SQL_2016_SP2_Express'

member WINDOWS_SERVER_2012_RTM_KOREAN_64BIT_BASE

WINDOWS_SERVER_2012_RTM_KOREAN_64BIT_BASE = 'Windows_Server-2012-RTM-Korean-64Bit-Base'

member WINDOWS_SERVER_2012_RTM_POLISH_64BIT_BASE

WINDOWS_SERVER_2012_RTM_POLISH_64BIT_BASE = 'Windows_Server-2012-RTM-Polish-64Bit-Base'

member WINDOWS_SERVER_2012_RTM_PORTUGESE_BRAZIL_64BIT_BASE

WINDOWS_SERVER_2012_RTM_PORTUGESE_BRAZIL_64BIT_BASE = 'Windows_Server-2012-RTM-Portugese_Brazil-64Bit-Base'

Deprecated
- use WINDOWS_SERVER_2012_RTM_PORTUGUESE_BRAZIL_64BIT_BASE

member WINDOWS_SERVER_2012_RTM_PORTUGESE_PORTUGAL_64BIT_BASE

WINDOWS_SERVER_2012_RTM_PORTUGESE_PORTUGAL_64BIT_BASE = 'Windows_Server-2012-RTM-Portugese_Portugal-64Bit-Base'

Deprecated
- use WINDOWS_SERVER_2012_RTM_PORTUGUESE_PORTUGAL_64BIT_BASE

member WINDOWS_SERVER_2012_RTM_PORTUGUESE_BRAZIL_64BIT_BASE

WINDOWS_SERVER_2012_RTM_PORTUGUESE_BRAZIL_64BIT_BASE = 'Windows_Server-2012-RTM-Portuguese_Brazil-64Bit-Base'

member WINDOWS_SERVER_2012_RTM_PORTUGUESE_PORTUGAL_64BIT_BASE

WINDOWS_SERVER_2012_RTM_PORTUGUESE_PORTUGAL_64BIT_BASE = 'Windows_Server-2012-RTM-Portuguese_Portugal-64Bit-Base'

member WINDOWS_SERVER_2012_RTM_RUSSIAN_64BIT_BASE

WINDOWS_SERVER_2012_RTM_RUSSIAN_64BIT_BASE = 'Windows_Server-2012-RTM-Russian-64Bit-Base'

member WINDOWS_SERVER_2012_RTM_SPANISH_64BIT_BASE

WINDOWS_SERVER_2012_RTM_SPANISH_64BIT_BASE = 'Windows_Server-2012-RTM-Spanish-64Bit-Base'

member WINDOWS_SERVER_2012_RTM_SWEDISH_64BIT_BASE

WINDOWS_SERVER_2012_RTM_SWEDISH_64BIT_BASE = 'Windows_Server-2012-RTM-Swedish-64Bit-Base'

member WINDOWS_SERVER_2012_RTM_TURKISH_64BIT_BASE

WINDOWS_SERVER_2012_RTM_TURKISH_64BIT_BASE = 'Windows_Server-2012-RTM-Turkish-64Bit-Base'

member WINDOWS_SERVER_2012_SP2_PORTUGESE_BRAZIL_64BIT_BASE

WINDOWS_SERVER_2012_SP2_PORTUGESE_BRAZIL_64BIT_BASE = 'Windows_Server-2008-SP2-Portugese_Brazil-64Bit-Base'

Deprecated
- use WINDOWS_SERVER_2012_SP2_PORTUGUESE_BRAZIL_64BIT_BASE

member WINDOWS_SERVER_2012_SP2_PORTUGUESE_BRAZIL_64BIT_BASE

WINDOWS_SERVER_2012_SP2_PORTUGUESE_BRAZIL_64BIT_BASE = 'Windows_Server-2008-SP2-Portuguese_Brazil-64Bit-Base'

member WINDOWS_SERVER_2016_CHINESE_SIMPLIFIED_FULL_BASE

WINDOWS_SERVER_2016_CHINESE_SIMPLIFIED_FULL_BASE = 'Windows_Server-2016-Chinese_Simplified-Full-Base'

member WINDOWS_SERVER_2016_CHINESE_TRADITIONAL_FULL_BASE

WINDOWS_SERVER_2016_CHINESE_TRADITIONAL_FULL_BASE = 'Windows_Server-2016-Chinese_Traditional-Full-Base'

member WINDOWS_SERVER_2016_CZECH_FULL_BASE

WINDOWS_SERVER_2016_CZECH_FULL_BASE = 'Windows_Server-2016-Czech-Full-Base'

member WINDOWS_SERVER_2016_DUTCH_FULL_BASE

WINDOWS_SERVER_2016_DUTCH_FULL_BASE = 'Windows_Server-2016-Dutch-Full-Base'

member WINDOWS_SERVER_2016_ENGLISH_64BIT_SQL_2012_SP4_ENTERPRISE

WINDOWS_SERVER_2016_ENGLISH_64BIT_SQL_2012_SP4_ENTERPRISE = 'Windows_Server-2016-English-64Bit-SQL_2012_SP4_Enterprise'

member WINDOWS_SERVER_2016_ENGLISH_CORE_BASE

WINDOWS_SERVER_2016_ENGLISH_CORE_BASE = 'Windows_Server-2016-English-Core-Base'

member WINDOWS_SERVER_2016_ENGLISH_CORE_CONTAINERS

WINDOWS_SERVER_2016_ENGLISH_CORE_CONTAINERS = 'Windows_Server-2016-English-Core-Containers'

member WINDOWS_SERVER_2016_ENGLISH_CORE_CONTAINERSLATEST

WINDOWS_SERVER_2016_ENGLISH_CORE_CONTAINERSLATEST = 'Windows_Server-2016-English-Core-ContainersLatest'

member WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP1_ENTERPRISE

WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP1_ENTERPRISE = 'Windows_Server-2016-English-Core-SQL_2016_SP1_Enterprise'

member WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP1_EXPRESS

WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP1_EXPRESS = 'Windows_Server-2016-English-Core-SQL_2016_SP1_Express'

member WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP1_STANDARD

WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP1_STANDARD = 'Windows_Server-2016-English-Core-SQL_2016_SP1_Standard'

member WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP1_WEB

WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP1_WEB = 'Windows_Server-2016-English-Core-SQL_2016_SP1_Web'

member WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP2_ENTERPRISE

WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP2_ENTERPRISE = 'Windows_Server-2016-English-Core-SQL_2016_SP2_Enterprise'

member WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP2_EXPRESS

WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP2_EXPRESS = 'Windows_Server-2016-English-Core-SQL_2016_SP2_Express'

member WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP2_STANDARD

WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP2_STANDARD = 'Windows_Server-2016-English-Core-SQL_2016_SP2_Standard'

member WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP2_WEB

WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP2_WEB = 'Windows_Server-2016-English-Core-SQL_2016_SP2_Web'

member WINDOWS_SERVER_2016_ENGLISH_DEEP_LEARNING

WINDOWS_SERVER_2016_ENGLISH_DEEP_LEARNING = 'Windows_Server-2016-English-Deep-Learning'

member WINDOWS_SERVER_2016_ENGLISH_FULL_BASE

WINDOWS_SERVER_2016_ENGLISH_FULL_BASE = 'Windows_Server-2016-English-Full-Base'

member WINDOWS_SERVER_2016_ENGLISH_FULL_CONTAINERS

WINDOWS_SERVER_2016_ENGLISH_FULL_CONTAINERS = 'Windows_Server-2016-English-Full-Containers'

member WINDOWS_SERVER_2016_ENGLISH_FULL_HYPERV

WINDOWS_SERVER_2016_ENGLISH_FULL_HYPERV = 'Windows_Server-2016-English-Full-HyperV'

member WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP1_ENTERPRISE

WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP1_ENTERPRISE = 'Windows_Server-2016-English-Full-SQL_2016_SP1_Enterprise'

member WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP1_EXPRESS

WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP1_EXPRESS = 'Windows_Server-2016-English-Full-SQL_2016_SP1_Express'

member WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP1_STANDARD

WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP1_STANDARD = 'Windows_Server-2016-English-Full-SQL_2016_SP1_Standard'

member WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP1_WEB

WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP1_WEB = 'Windows_Server-2016-English-Full-SQL_2016_SP1_Web'

member WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP2_ENTERPRISE

WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP2_ENTERPRISE = 'Windows_Server-2016-English-Full-SQL_2016_SP2_Enterprise'

member WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP2_EXPRESS

WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP2_EXPRESS = 'Windows_Server-2016-English-Full-SQL_2016_SP2_Express'

member WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP2_STANDARD

WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP2_STANDARD = 'Windows_Server-2016-English-Full-SQL_2016_SP2_Standard'

member WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP2_WEB

WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP2_WEB = 'Windows_Server-2016-English-Full-SQL_2016_SP2_Web'

member WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2017_ENTERPRISE

WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2017_ENTERPRISE = 'Windows_Server-2016-English-Full-SQL_2017_Enterprise'

member WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2017_EXPRESS

WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2017_EXPRESS = 'Windows_Server-2016-English-Full-SQL_2017_Express'

member WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2017_STANDARD

WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2017_STANDARD = 'Windows_Server-2016-English-Full-SQL_2017_Standard'

member WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2017_WEB

WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2017_WEB = 'Windows_Server-2016-English-Full-SQL_2017_Web'

member WINDOWS_SERVER_2016_ENGLISH_P3

WINDOWS_SERVER_2016_ENGLISH_P3 = 'Windows_Server-2016-English-P3'

member WINDOWS_SERVER_2016_FRENCH_FULL_BASE

WINDOWS_SERVER_2016_FRENCH_FULL_BASE = 'Windows_Server-2016-French-Full-Base'

member WINDOWS_SERVER_2016_GERMAL_FULL_BASE

WINDOWS_SERVER_2016_GERMAL_FULL_BASE = 'Windows_Server-2016-Germal-Full-Base'

Deprecated
- use WINDOWS_SERVER_2016_GERMAN_FULL_BASE

member WINDOWS_SERVER_2016_GERMAN_FULL_BASE

WINDOWS_SERVER_2016_GERMAN_FULL_BASE = 'Windows_Server-2016-German-Full-Base'

member WINDOWS_SERVER_2016_HUNGARIAN_FULL_BASE

WINDOWS_SERVER_2016_HUNGARIAN_FULL_BASE = 'Windows_Server-2016-Hungarian-Full-Base'

member WINDOWS_SERVER_2016_ITALIAN_FULL_BASE

WINDOWS_SERVER_2016_ITALIAN_FULL_BASE = 'Windows_Server-2016-Italian-Full-Base'

member WINDOWS_SERVER_2016_JAPANESE_FULL_BASE

WINDOWS_SERVER_2016_JAPANESE_FULL_BASE = 'Windows_Server-2016-Japanese-Full-Base'

member WINDOWS_SERVER_2016_JAPANESE_FULL_FQL_2016_SP2_WEB

WINDOWS_SERVER_2016_JAPANESE_FULL_FQL_2016_SP2_WEB = 'Windows_Server-2016-Japanese-Full-SQL_2016_SP2_Web'

member WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP1_ENTERPRISE

WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP1_ENTERPRISE = 'Windows_Server-2016-Japanese-Full-SQL_2016_SP1_Enterprise'

member WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP1_EXPRESS

WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP1_EXPRESS = 'Windows_Server-2016-Japanese-Full-SQL_2016_SP1_Express'

member WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP1_STANDARD

WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP1_STANDARD = 'Windows_Server-2016-Japanese-Full-SQL_2016_SP1_Standard'

member WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP1_WEB

WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP1_WEB = 'Windows_Server-2016-Japanese-Full-SQL_2016_SP1_Web'

member WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP2_ENTERPRISE

WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP2_ENTERPRISE = 'Windows_Server-2016-Japanese-Full-SQL_2016_SP2_Enterprise'

member WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP2_EXPRESS

WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP2_EXPRESS = 'Windows_Server-2016-Japanese-Full-SQL_2016_SP2_Express'

member WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP2_STANDARD

WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP2_STANDARD = 'Windows_Server-2016-Japanese-Full-SQL_2016_SP2_Standard'

member WINDOWS_SERVER_2016_KOREAN_FULL_BASE

WINDOWS_SERVER_2016_KOREAN_FULL_BASE = 'Windows_Server-2016-Korean-Full-Base'

member WINDOWS_SERVER_2016_KOREAN_FULL_SQL_2016_SP1_STANDARD

WINDOWS_SERVER_2016_KOREAN_FULL_SQL_2016_SP1_STANDARD = 'Windows_Server-2016-Korean-Full-SQL_2016_SP1_Standard'

member WINDOWS_SERVER_2016_KOREAN_FULL_SQL_2016_SP2_STANDARD

WINDOWS_SERVER_2016_KOREAN_FULL_SQL_2016_SP2_STANDARD = 'Windows_Server-2016-Korean-Full-SQL_2016_SP2_Standard'

member WINDOWS_SERVER_2016_POLISH_FULL_BASE

WINDOWS_SERVER_2016_POLISH_FULL_BASE = 'Windows_Server-2016-Polish-Full-Base'

member WINDOWS_SERVER_2016_PORTUGESE_BRAZIL_FULL_BASE

WINDOWS_SERVER_2016_PORTUGESE_BRAZIL_FULL_BASE = 'Windows_Server-2016-Portugese_Brazil-Full-Base'

Deprecated
- use WINDOWS_SERVER_2016_PORTUGUESE_BRAZIL_FULL_BASE

member WINDOWS_SERVER_2016_PORTUGESE_PORTUGAL_FULL_BASE

WINDOWS_SERVER_2016_PORTUGESE_PORTUGAL_FULL_BASE = 'Windows_Server-2016-Portugese_Portugal-Full-Base'

Deprecated
- use WINDOWS_SERVER_2016_PORTUGUESE_PORTUGAL_FULL_BASE

member WINDOWS_SERVER_2016_PORTUGUESE_BRAZIL_FULL_BASE

WINDOWS_SERVER_2016_PORTUGUESE_BRAZIL_FULL_BASE = 'Windows_Server-2016-Portuguese_Brazil-Full-Base'

member WINDOWS_SERVER_2016_PORTUGUESE_PORTUGAL_FULL_BASE

WINDOWS_SERVER_2016_PORTUGUESE_PORTUGAL_FULL_BASE = 'Windows_Server-2016-Portuguese_Portugal-Full-Base'

member WINDOWS_SERVER_2016_RUSSIAN_FULL_BASE

WINDOWS_SERVER_2016_RUSSIAN_FULL_BASE = 'Windows_Server-2016-Russian-Full-Base'

member WINDOWS_SERVER_2016_SPANISH_FULL_BASE

WINDOWS_SERVER_2016_SPANISH_FULL_BASE = 'Windows_Server-2016-Spanish-Full-Base'

member WINDOWS_SERVER_2016_SWEDISH_FULL_BASE

WINDOWS_SERVER_2016_SWEDISH_FULL_BASE = 'Windows_Server-2016-Swedish-Full-Base'

member WINDOWS_SERVER_2016_TURKISH_FULL_BASE

WINDOWS_SERVER_2016_TURKISH_FULL_BASE = 'Windows_Server-2016-Turkish-Full-Base'

member WINDOWS_SERVER_2019_CHINESE_SIMPLIFIED_FULL_BASE

WINDOWS_SERVER_2019_CHINESE_SIMPLIFIED_FULL_BASE = 'Windows_Server-2019-Chinese_Simplified-Full-Base'

member WINDOWS_SERVER_2019_CHINESE_TRADITIONAL_FULL_BASE

WINDOWS_SERVER_2019_CHINESE_TRADITIONAL_FULL_BASE = 'Windows_Server-2019-Chinese_Traditional-Full-Base'

member WINDOWS_SERVER_2019_CZECH_FULL_BASE

WINDOWS_SERVER_2019_CZECH_FULL_BASE = 'Windows_Server-2019-Czech-Full-Base'

member WINDOWS_SERVER_2019_DUTCH_FULL_BASE

WINDOWS_SERVER_2019_DUTCH_FULL_BASE = 'Windows_Server-2019-Dutch-Full-Base'

member WINDOWS_SERVER_2019_ENGLISH_CORE_BASE

WINDOWS_SERVER_2019_ENGLISH_CORE_BASE = 'Windows_Server-2019-English-Core-Base'

member WINDOWS_SERVER_2019_ENGLISH_CORE_CONTAINERSLATEST

WINDOWS_SERVER_2019_ENGLISH_CORE_CONTAINERSLATEST = 'Windows_Server-2019-English-Core-ContainersLatest'

member WINDOWS_SERVER_2019_ENGLISH_FULL_BASE

WINDOWS_SERVER_2019_ENGLISH_FULL_BASE = 'Windows_Server-2019-English-Full-Base'

member WINDOWS_SERVER_2019_ENGLISH_FULL_CONTAINERSLATEST

WINDOWS_SERVER_2019_ENGLISH_FULL_CONTAINERSLATEST = 'Windows_Server-2019-English-Full-ContainersLatest'

member WINDOWS_SERVER_2019_ENGLISH_FULL_HYPERV

WINDOWS_SERVER_2019_ENGLISH_FULL_HYPERV = 'Windows_Server-2019-English-Full-HyperV'

member WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP2_ENTERPRISE

WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP2_ENTERPRISE = 'Windows_Server-2019-English-Full-SQL_2016_SP2_Enterprise'

member WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP2_EXPRESS

WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP2_EXPRESS = 'Windows_Server-2019-English-Full-SQL_2016_SP2_Express'

member WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP2_STANDARD

WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP2_STANDARD = 'Windows_Server-2019-English-Full-SQL_2016_SP2_Standard'

member WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP2_WEB

WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP2_WEB = 'Windows_Server-2019-English-Full-SQL_2016_SP2_Web'

member WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2017_ENTERPRISE

WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2017_ENTERPRISE = 'Windows_Server-2019-English-Full-SQL_2017_Enterprise'

member WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2017_EXPRESS

WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2017_EXPRESS = 'Windows_Server-2019-English-Full-SQL_2017_Express'

member WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2017_STANDARD

WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2017_STANDARD = 'Windows_Server-2019-English-Full-SQL_2017_Standard'

member WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2017_WEB

WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2017_WEB = 'Windows_Server-2019-English-Full-SQL_2017_Web'

member WINDOWS_SERVER_2019_FRENCH_FULL_BASE

WINDOWS_SERVER_2019_FRENCH_FULL_BASE = 'Windows_Server-2019-French-Full-Base'

member WINDOWS_SERVER_2019_GERMAN_FULL_BASE

WINDOWS_SERVER_2019_GERMAN_FULL_BASE = 'Windows_Server-2019-German-Full-Base'

member WINDOWS_SERVER_2019_HUNGARIAN_FULL_BASE

WINDOWS_SERVER_2019_HUNGARIAN_FULL_BASE = 'Windows_Server-2019-Hungarian-Full-Base'

member WINDOWS_SERVER_2019_ITALIAN_FULL_BASE

WINDOWS_SERVER_2019_ITALIAN_FULL_BASE = 'Windows_Server-2019-Italian-Full-Base'

member WINDOWS_SERVER_2019_JAPANESE_FULL_BASE

WINDOWS_SERVER_2019_JAPANESE_FULL_BASE = 'Windows_Server-2019-Japanese-Full-Base'

member WINDOWS_SERVER_2019_KOREAN_FULL_BASE

WINDOWS_SERVER_2019_KOREAN_FULL_BASE = 'Windows_Server-2019-Korean-Full-Base'

member WINDOWS_SERVER_2019_POLISH_FULL_BASE

WINDOWS_SERVER_2019_POLISH_FULL_BASE = 'Windows_Server-2019-Polish-Full-Base'

member WINDOWS_SERVER_2019_PORTUGESE_BRAZIL_FULL_BASE

WINDOWS_SERVER_2019_PORTUGESE_BRAZIL_FULL_BASE = 'Windows_Server-2019-Portugese_Brazil-Full-Base'

Deprecated
- use WINDOWS_SERVER_2019_PORTUGUESE_BRAZIL_FULL_BASE

member WINDOWS_SERVER_2019_PORTUGESE_PORTUGAL_FULL_BASE

WINDOWS_SERVER_2019_PORTUGESE_PORTUGAL_FULL_BASE = 'Windows_Server-2019-Portugese_Portugal-Full-Base'

Deprecated
- use WINDOWS_SERVER_2019_PORTUGUESE_PORTUGAL_FULL_BASE

member WINDOWS_SERVER_2019_PORTUGUESE_BRAZIL_FULL_BASE

WINDOWS_SERVER_2019_PORTUGUESE_BRAZIL_FULL_BASE = 'Windows_Server-2019-Portuguese_Brazil-Full-Base'

member WINDOWS_SERVER_2019_PORTUGUESE_PORTUGAL_FULL_BASE

WINDOWS_SERVER_2019_PORTUGUESE_PORTUGAL_FULL_BASE = 'Windows_Server-2019-Portuguese_Portugal-Full-Base'

member WINDOWS_SERVER_2019_RUSSIAN_FULL_BASE

WINDOWS_SERVER_2019_RUSSIAN_FULL_BASE = 'Windows_Server-2019-Russian-Full-Base'

member WINDOWS_SERVER_2019_SPANISH_FULL_BASE

WINDOWS_SERVER_2019_SPANISH_FULL_BASE = 'Windows_Server-2019-Spanish-Full-Base'

member WINDOWS_SERVER_2019_SWEDISH_FULL_BASE

WINDOWS_SERVER_2019_SWEDISH_FULL_BASE = 'Windows_Server-2019-Swedish-Full-Base'

member WINDOWS_SERVER_2019_TURKISH_FULL_BASE

WINDOWS_SERVER_2019_TURKISH_FULL_BASE = 'Windows_Server-2019-Turkish-Full-Base'

member WINDOWS_SERVER_2022_CHINESE_SIMPLIFIED_FULL_BASE

WINDOWS_SERVER_2022_CHINESE_SIMPLIFIED_FULL_BASE = 'Windows_Server-2022-Chinese_Simplified-Full-Base'

member WINDOWS_SERVER_2022_CHINESE_TRADITIONAL_FULL_BASE

WINDOWS_SERVER_2022_CHINESE_TRADITIONAL_FULL_BASE = 'Windows_Server-2022-Chinese_Traditional-Full-Base'

member WINDOWS_SERVER_2022_CZECH_FULL_BASE

WINDOWS_SERVER_2022_CZECH_FULL_BASE = 'Windows_Server-2022-Czech-Full-Base'

member WINDOWS_SERVER_2022_DUTCH_FULL_BASE

WINDOWS_SERVER_2022_DUTCH_FULL_BASE = 'Windows_Server-2022-Dutch-Full-Base'

member WINDOWS_SERVER_2022_ENGLISH_CORE_BASE

WINDOWS_SERVER_2022_ENGLISH_CORE_BASE = 'Windows_Server-2022-English-Core-Base'

member WINDOWS_SERVER_2022_ENGLISH_CORE_CONTAINERSLATEST

WINDOWS_SERVER_2022_ENGLISH_CORE_CONTAINERSLATEST = 'Windows_Server-2022-English-Core-ContainersLatest'

member WINDOWS_SERVER_2022_ENGLISH_CORE_ECS_OPTIMIZED

WINDOWS_SERVER_2022_ENGLISH_CORE_ECS_OPTIMIZED = 'Windows_Server-2022-English-Core-ECS_Optimized'

member WINDOWS_SERVER_2022_ENGLISH_FULL_BASE

WINDOWS_SERVER_2022_ENGLISH_FULL_BASE = 'Windows_Server-2022-English-Full-Base'

member WINDOWS_SERVER_2022_ENGLISH_FULL_CONTAINERSLATEST

WINDOWS_SERVER_2022_ENGLISH_FULL_CONTAINERSLATEST = 'Windows_Server-2022-English-Full-ContainersLatest'

member WINDOWS_SERVER_2022_ENGLISH_FULL_ECS_OPTIMIZED

WINDOWS_SERVER_2022_ENGLISH_FULL_ECS_OPTIMIZED = 'Windows_Server-2022-English-Full-ECS_Optimized'

member WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2017_ENTERPRISE

WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2017_ENTERPRISE = 'Windows_Server-2022-English-Full-SQL_2017_Enterprise'

member WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2017_EXPRESS

WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2017_EXPRESS = 'Windows_Server-2022-English-Full-SQL_2017_Express'

member WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2017_STANDARD

WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2017_STANDARD = 'Windows_Server-2022-English-Full-SQL_2017_Standard'

member WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2017_WEB

WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2017_WEB = 'Windows_Server-2022-English-Full-SQL_2017_Web'

member WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2019_ENTERPRISE

WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2019_ENTERPRISE = 'Windows_Server-2022-English-Full-SQL_2019_Enterprise'

member WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2019_EXPRESS

WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2019_EXPRESS = 'Windows_Server-2022-English-Full-SQL_2019_Express'

member WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2019_STANDARD

WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2019_STANDARD = 'Windows_Server-2022-English-Full-SQL_2019_Standard'

member WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2019_WEB

WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2019_WEB = 'Windows_Server-2022-English-Full-SQL_2019_Web'

member WINDOWS_SERVER_2022_FRENCH_FULL_BASE

WINDOWS_SERVER_2022_FRENCH_FULL_BASE = 'Windows_Server-2022-French-Full-Base'

member WINDOWS_SERVER_2022_GERMAN_FULL_BASE

WINDOWS_SERVER_2022_GERMAN_FULL_BASE = 'Windows_Server-2022-German-Full-Base'

member WINDOWS_SERVER_2022_HUNGARIAN_FULL_BASE

WINDOWS_SERVER_2022_HUNGARIAN_FULL_BASE = 'Windows_Server-2022-Hungarian-Full-Base'

member WINDOWS_SERVER_2022_ITALIAN_FULL_BASE

WINDOWS_SERVER_2022_ITALIAN_FULL_BASE = 'Windows_Server-2022-Italian-Full-Base'

member WINDOWS_SERVER_2022_JAPANESE_FULL_BASE

WINDOWS_SERVER_2022_JAPANESE_FULL_BASE = 'Windows_Server-2022-Japanese-Full-Base'

member WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2017_ENTERPRISE

WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2017_ENTERPRISE = 'Windows_Server-2022-Japanese-Full-SQL_2017_Enterprise'

member WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2017_STANDARD

WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2017_STANDARD = 'Windows_Server-2022-Japanese-Full-SQL_2017_Standard'

member WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2017_WEB

WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2017_WEB = 'Windows_Server-2022-Japanese-Full-SQL_2017_Web'

member WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2019_ENTERPRISE

WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2019_ENTERPRISE = 'Windows_Server-2022-Japanese-Full-SQL_2019_Enterprise'

member WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2019_STANDARD

WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2019_STANDARD = 'Windows_Server-2022-Japanese-Full-SQL_2019_Standard'

member WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2019_WEB

WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2019_WEB = 'Windows_Server-2022-Japanese-Full-SQL_2019_Web'

member WINDOWS_SERVER_2022_KOREAN_FULL_BASE

WINDOWS_SERVER_2022_KOREAN_FULL_BASE = 'Windows_Server-2022-Korean-Full-Base'

member WINDOWS_SERVER_2022_POLISH_FULL_BASE

WINDOWS_SERVER_2022_POLISH_FULL_BASE = 'Windows_Server-2022-Polish-Full-Base'

member WINDOWS_SERVER_2022_PORTUGUESE_BRAZIL_FULL_BASE

WINDOWS_SERVER_2022_PORTUGUESE_BRAZIL_FULL_BASE = 'Windows_Server-2022-Portuguese_Brazil-Full-Base'

member WINDOWS_SERVER_2022_PORTUGUESE_PORTUGAL_FULL_BASE

WINDOWS_SERVER_2022_PORTUGUESE_PORTUGAL_FULL_BASE = 'Windows_Server-2022-Portuguese_Portugal-Full-Base'

member WINDOWS_SERVER_2022_RUSSIAN_FULL_BASE

WINDOWS_SERVER_2022_RUSSIAN_FULL_BASE = 'Windows_Server-2022-Russian-Full-Base'

member WINDOWS_SERVER_2022_SPANISH_FULL_BASE

WINDOWS_SERVER_2022_SPANISH_FULL_BASE = 'Windows_Server-2022-Spanish-Full-Base'

member WINDOWS_SERVER_2022_SWEDISH_FULL_BASE

WINDOWS_SERVER_2022_SWEDISH_FULL_BASE = 'Windows_Server-2022-Swedish-Full-Base'

member WINDOWS_SERVER_2022_TURKISH_FULL_BASE

WINDOWS_SERVER_2022_TURKISH_FULL_BASE = 'Windows_Server-2022-Turkish-Full-Base'

Namespaces

namespace CfnCapacityReservation

namespace CfnCapacityReservation {}

interface TagSpecificationProperty

interface TagSpecificationProperty {}

An array of key-value pairs to apply to this resource.
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservation-tagspecification.html

property resourceType

readonly resourceType?: string;

The type of resource to tag. Specify capacity-reservation .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservation-tagspecification.html#cfn-ec2-capacityreservation-tagspecification-resourcetype

property tags

readonly tags?: cdk.CfnTag[];

The tags to apply to the resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservation-tagspecification.html#cfn-ec2-capacityreservation-tagspecification-tags

namespace CfnCapacityReservationFleet

namespace CfnCapacityReservationFleet {}

interface InstanceTypeSpecificationProperty

interface InstanceTypeSpecificationProperty {}

Specifies information about an instance type to use in a Capacity Reservation Fleet.
InstanceTypeSpecification is a property of the [AWS::EC2::CapacityReservationFleet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html) resource.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-instancetypespecification.html

property availabilityZone

readonly availabilityZone?: string;

The Availability Zone in which the Capacity Reservation Fleet reserves the capacity. A Capacity Reservation Fleet can't span Availability Zones. All instance type specifications that you specify for the Fleet must use the same Availability Zone.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-instancetypespecification.html#cfn-ec2-capacityreservationfleet-instancetypespecification-availabilityzone

property availabilityZoneId

readonly availabilityZoneId?: string;

The ID of the Availability Zone in which the Capacity Reservation Fleet reserves the capacity. A Capacity Reservation Fleet can't span Availability Zones. All instance type specifications that you specify for the Fleet must use the same Availability Zone.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-instancetypespecification.html#cfn-ec2-capacityreservationfleet-instancetypespecification-availabilityzoneid

property ebsOptimized

readonly ebsOptimized?: boolean | cdk.IResolvable;

Indicates whether the Capacity Reservation Fleet supports EBS-optimized instances types. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using EBS-optimized instance types.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-instancetypespecification.html#cfn-ec2-capacityreservationfleet-instancetypespecification-ebsoptimized

property instancePlatform

readonly instancePlatform?: string;

The type of operating system for which the Capacity Reservation Fleet reserves capacity.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-instancetypespecification.html#cfn-ec2-capacityreservationfleet-instancetypespecification-instanceplatform

property instanceType

readonly instanceType?: string;

The instance type for which the Capacity Reservation Fleet reserves capacity.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-instancetypespecification.html#cfn-ec2-capacityreservationfleet-instancetypespecification-instancetype

property priority

readonly priority?: number;

The priority to assign to the instance type. This value is used to determine which of the instance types specified for the Fleet should be prioritized for use. A lower value indicates a high priority. For more information, see [Instance type priority](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#instance-priority) in the Amazon EC2 User Guide.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-instancetypespecification.html#cfn-ec2-capacityreservationfleet-instancetypespecification-priority

property weight

readonly weight?: number;

The number of capacity units provided by the specified instance type. This value, together with the total target capacity that you specify for the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see [Total target capacity](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity) in the Amazon EC2 User Guide.
Valid Range: Minimum value of 0.001 . Maximum value of 99.999 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-instancetypespecification.html#cfn-ec2-capacityreservationfleet-instancetypespecification-weight

interface TagSpecificationProperty

interface TagSpecificationProperty {}

The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
> The Valid Values lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-tagspecification.html

property resourceType

readonly resourceType?: string;

The type of resource to tag on creation. Specify capacity-reservation-fleet .
To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-tagspecification.html#cfn-ec2-capacityreservationfleet-tagspecification-resourcetype

property tags

readonly tags?: cdk.CfnTag[];

The tags to apply to the resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-tagspecification.html#cfn-ec2-capacityreservationfleet-tagspecification-tags

namespace CfnClientVpnEndpoint

namespace CfnClientVpnEndpoint {}

interface CertificateAuthenticationRequestProperty

interface CertificateAuthenticationRequestProperty {}

Information about the client certificate to be used for authentication.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-certificateauthenticationrequest.html

property clientRootCertificateChainArn

readonly clientRootCertificateChainArn: string;

The ARN of the client certificate. The certificate must be signed by a certificate authority (CA) and it must be provisioned in AWS Certificate Manager (ACM).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-certificateauthenticationrequest.html#cfn-ec2-clientvpnendpoint-certificateauthenticationrequest-clientrootcertificatechainarn

interface ClientAuthenticationRequestProperty

interface ClientAuthenticationRequestProperty {}

Describes the authentication method to be used by a Client VPN endpoint. For more information, see [Authentication](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/authentication-authrization.html#client-authentication) in the *AWS Client VPN Administrator Guide* .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html

property activeDirectory

readonly activeDirectory?:
    | CfnClientVpnEndpoint.DirectoryServiceAuthenticationRequestProperty
    | cdk.IResolvable;

Information about the Active Directory to be used, if applicable. You must provide this information if *Type* is directory-service-authentication .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-activedirectory

property federatedAuthentication

readonly federatedAuthentication?:
    | CfnClientVpnEndpoint.FederatedAuthenticationRequestProperty
    | cdk.IResolvable;

Information about the IAM SAML identity provider, if applicable.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-federatedauthentication

property mutualAuthentication

readonly mutualAuthentication?:
    | CfnClientVpnEndpoint.CertificateAuthenticationRequestProperty
    | cdk.IResolvable;

Information about the authentication certificates to be used, if applicable. You must provide this information if *Type* is certificate-authentication .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-mutualauthentication

property type

readonly type: string;

The type of client authentication to be used.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-type

interface ClientConnectOptionsProperty

interface ClientConnectOptionsProperty {}

Indicates whether client connect options are enabled. The default is false (not enabled).
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientconnectoptions.html

property enabled

readonly enabled: boolean | cdk.IResolvable;

Indicates whether client connect options are enabled. The default is false (not enabled).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientconnectoptions.html#cfn-ec2-clientvpnendpoint-clientconnectoptions-enabled

property lambdaFunctionArn

readonly lambdaFunctionArn?: string;

The Amazon Resource Name (ARN) of the AWS Lambda function used for connection authorization.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientconnectoptions.html#cfn-ec2-clientvpnendpoint-clientconnectoptions-lambdafunctionarn

interface ClientLoginBannerOptionsProperty

interface ClientLoginBannerOptionsProperty {}

Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientloginbanneroptions.html

property bannerText

readonly bannerText?: string;

Customizable text that will be displayed in a banner on AWS provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientloginbanneroptions.html#cfn-ec2-clientvpnendpoint-clientloginbanneroptions-bannertext

property enabled

readonly enabled: boolean | cdk.IResolvable;

Enable or disable a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
Valid values: true | false
Default value: false
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientloginbanneroptions.html#cfn-ec2-clientvpnendpoint-clientloginbanneroptions-enabled

interface ConnectionLogOptionsProperty

interface ConnectionLogOptionsProperty {}

Describes the client connection logging options for the Client VPN endpoint.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-connectionlogoptions.html

property cloudwatchLogGroup

readonly cloudwatchLogGroup?: string;

The name of the CloudWatch Logs log group. Required if connection logging is enabled.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-connectionlogoptions.html#cfn-ec2-clientvpnendpoint-connectionlogoptions-cloudwatchloggroup

property cloudwatchLogStream

readonly cloudwatchLogStream?: string;

The name of the CloudWatch Logs log stream to which the connection data is published.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-connectionlogoptions.html#cfn-ec2-clientvpnendpoint-connectionlogoptions-cloudwatchlogstream

property enabled

readonly enabled: boolean | cdk.IResolvable;

Indicates whether connection logging is enabled.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-connectionlogoptions.html#cfn-ec2-clientvpnendpoint-connectionlogoptions-enabled

interface DirectoryServiceAuthenticationRequestProperty

interface DirectoryServiceAuthenticationRequestProperty {}

Describes the Active Directory to be used for client authentication.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-directoryserviceauthenticationrequest.html

property directoryId

readonly directoryId: string;

The ID of the Active Directory to be used for authentication.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-directoryserviceauthenticationrequest.html#cfn-ec2-clientvpnendpoint-directoryserviceauthenticationrequest-directoryid

interface FederatedAuthenticationRequestProperty

interface FederatedAuthenticationRequestProperty {}

The IAM SAML identity provider used for federated authentication.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-federatedauthenticationrequest.html

property samlProviderArn

readonly samlProviderArn: string;

The Amazon Resource Name (ARN) of the IAM SAML identity provider.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-federatedauthenticationrequest.html#cfn-ec2-clientvpnendpoint-federatedauthenticationrequest-samlproviderarn

property selfServiceSamlProviderArn

readonly selfServiceSamlProviderArn?: string;

The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-federatedauthenticationrequest.html#cfn-ec2-clientvpnendpoint-federatedauthenticationrequest-selfservicesamlproviderarn

interface TagSpecificationProperty

interface TagSpecificationProperty {}

The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
> The Valid Values lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-tagspecification.html

property resourceType

readonly resourceType: string;

The type of resource to tag.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-tagspecification.html#cfn-ec2-clientvpnendpoint-tagspecification-resourcetype

property tags

readonly tags: cdk.CfnTag[];

The tags to apply to the resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-tagspecification.html#cfn-ec2-clientvpnendpoint-tagspecification-tags

namespace CfnEC2Fleet

namespace CfnEC2Fleet {}

interface AcceleratorCountRequestProperty

interface AcceleratorCountRequestProperty {}

The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set Max to 0 .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-acceleratorcountrequest.html

property max

readonly max?: number;

The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set Max to 0 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-acceleratorcountrequest.html#cfn-ec2-ec2fleet-acceleratorcountrequest-max

property min

readonly min?: number;

The minimum number of accelerators. To specify no minimum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-acceleratorcountrequest.html#cfn-ec2-ec2fleet-acceleratorcountrequest-min

interface AcceleratorTotalMemoryMiBRequestProperty

interface AcceleratorTotalMemoryMiBRequestProperty {}

The minimum and maximum amount of total accelerator memory, in MiB.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-acceleratortotalmemorymibrequest.html

property max

readonly max?: number;

The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-acceleratortotalmemorymibrequest.html#cfn-ec2-ec2fleet-acceleratortotalmemorymibrequest-max

property min

readonly min?: number;

The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-acceleratortotalmemorymibrequest.html#cfn-ec2-ec2fleet-acceleratortotalmemorymibrequest-min

interface BaselineEbsBandwidthMbpsRequestProperty

interface BaselineEbsBandwidthMbpsRequestProperty {}

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide* .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-baselineebsbandwidthmbpsrequest.html

property max

readonly max?: number;

The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-baselineebsbandwidthmbpsrequest.html#cfn-ec2-ec2fleet-baselineebsbandwidthmbpsrequest-max

property min

readonly min?: number;

The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-baselineebsbandwidthmbpsrequest.html#cfn-ec2-ec2fleet-baselineebsbandwidthmbpsrequest-min

interface CapacityRebalanceProperty

interface CapacityRebalanceProperty {}

The Spot Instance replacement strategy to use when Amazon EC2 emits a rebalance notification signal that your Spot Instance is at an elevated risk of being interrupted. For more information, see [Capacity rebalancing](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-capacity-rebalance.html) in the *Amazon EC2 User Guide* .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-capacityrebalance.html

property replacementStrategy

readonly replacementStrategy?: string;

The replacement strategy to use. Only available for fleets of type maintain .
launch - EC2 Fleet launches a replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. EC2 Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running.
launch-before-terminate - EC2 Fleet launches a replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in TerminationDelay ), terminates the instances that received a rebalance notification.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-capacityrebalance.html#cfn-ec2-ec2fleet-capacityrebalance-replacementstrategy

property terminationDelay

readonly terminationDelay?: number;

The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.
Required when ReplacementStrategy is set to launch-before-terminate .
Not valid when ReplacementStrategy is set to launch .
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-capacityrebalance.html#cfn-ec2-ec2fleet-capacityrebalance-terminationdelay

interface CapacityReservationOptionsRequestProperty

interface CapacityReservationOptionsRequestProperty {}

Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
> This strategy can only be used if the EC2 Fleet is of type instant .
For more information about Capacity Reservations, see [On-Demand Capacity Reservations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html) in the *Amazon EC2 User Guide* . For examples of using Capacity Reservations in an EC2 Fleet, see [EC2 Fleet example configurations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-examples.html) in the *Amazon EC2 User Guide* .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-capacityreservationoptionsrequest.html

property usageStrategy

readonly usageStrategy?: string;

Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
If you specify use-capacity-reservations-first , the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy ( lowest-price or prioritized ) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy ( lowest-price or prioritized ).
If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-capacityreservationoptionsrequest.html#cfn-ec2-ec2fleet-capacityreservationoptionsrequest-usagestrategy

interface FleetLaunchTemplateConfigRequestProperty

interface FleetLaunchTemplateConfigRequestProperty {}

Specifies a launch template and overrides for an EC2 Fleet.
FleetLaunchTemplateConfigRequest is a property of the [AWS::EC2::EC2Fleet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html) resource.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateconfigrequest.html

property launchTemplateSpecification

readonly launchTemplateSpecification?:
    | CfnEC2Fleet.FleetLaunchTemplateSpecificationRequestProperty
    | cdk.IResolvable;

The launch template to use. You must specify either the launch template ID or launch template name in the request.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateconfigrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateconfigrequest-launchtemplatespecification

property overrides

readonly overrides?:
    | Array<
          | CfnEC2Fleet.FleetLaunchTemplateOverridesRequestProperty
          | cdk.IResolvable
      >
    | cdk.IResolvable;

Any parameters that you specify override the same parameters in the launch template.
For fleets of type request and maintain , a maximum of 300 items is allowed across all launch templates.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateconfigrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateconfigrequest-overrides

interface FleetLaunchTemplateOverridesRequestProperty

interface FleetLaunchTemplateOverridesRequestProperty {}

Specifies overrides for a launch template for an EC2 Fleet.
FleetLaunchTemplateOverridesRequest is a property of the [FleetLaunchTemplateConfigRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateconfigrequest.html) property type.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html

property availabilityZone

readonly availabilityZone?: string;

The Availability Zone in which to launch the instances.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-availabilityzone

property instanceRequirements

readonly instanceRequirements?:
    | CfnEC2Fleet.InstanceRequirementsRequestProperty
    | cdk.IResolvable;

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
> If you specify InstanceRequirements , you can't specify InstanceType .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-instancerequirements

property instanceType

readonly instanceType?: string;

The instance type.
mac1.metal is not supported as a launch template override.
> If you specify InstanceType , you can't specify InstanceRequirements .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-instancetype

property maxPrice

readonly maxPrice?: string;

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
> If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-maxprice

property placement

readonly placement?: CfnEC2Fleet.PlacementProperty | cdk.IResolvable;

The location where the instance launched, if applicable.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-placement

property priority

readonly priority?: number;

The priority for the launch template override. The highest priority is launched first.
If the On-Demand AllocationStrategy is set to prioritized , EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacity-optimized-prioritized , EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-priority

property subnetId

readonly subnetId?: string;

The IDs of the subnets in which to launch the instances. Separate multiple subnet IDs using commas (for example, subnet-1234abcdeexample1, subnet-0987cdef6example2 ). A request of type instant can have only one subnet ID.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-subnetid

property weightedCapacity

readonly weightedCapacity?: number;

The number of units provided by the specified instance type.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-weightedcapacity

interface FleetLaunchTemplateSpecificationRequestProperty

interface FleetLaunchTemplateSpecificationRequestProperty {}

Specifies the launch template to be used by the EC2 Fleet for configuring Amazon EC2 instances.
You must specify the following:
- The ID or the name of the launch template, but not both. - The version of the launch template.
FleetLaunchTemplateSpecificationRequest is a property of the [FleetLaunchTemplateConfigRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateconfigrequest.html) property type.
For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template) in the *Amazon EC2 User Guide* .
For examples of launch templates, see [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest.html

property launchTemplateId

readonly launchTemplateId?: string;

The ID of the launch template.
You must specify the LaunchTemplateId or the LaunchTemplateName , but not both.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest-launchtemplateid

property launchTemplateName

readonly launchTemplateName?: string;

The name of the launch template.
You must specify the LaunchTemplateName or the LaunchTemplateId , but not both.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest-launchtemplatename

property version

readonly version: string;

The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.
If the value is $Latest , Amazon EC2 uses the latest version of the launch template.
If the value is $Default , Amazon EC2 uses the default version of the launch template.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest-version

interface InstanceRequirementsRequestProperty

interface InstanceRequirementsRequestProperty {}

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
- AllowedInstanceTypes - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes. - ExcludedInstanceTypes - The instance types to exclude from the list, even if they match your specified attributes.
> You must specify VCpuCount and MemoryMiB . All other attributes are optional. Any unspecified optional attribute is set to its default.
For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) , [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html) , and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide* .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html

property acceleratorCount

readonly acceleratorCount?:
    | CfnEC2Fleet.AcceleratorCountRequestProperty
    | cdk.IResolvable;

The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.
To exclude accelerator-enabled instance types, set Max to 0 .
Default: No minimum or maximum limits
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-acceleratorcount

property acceleratorManufacturers

readonly acceleratorManufacturers?: string[];

Indicates whether instance types must have accelerators by specific manufacturers.
- For instance types with NVIDIA devices, specify nvidia . - For instance types with AMD devices, specify amd . - For instance types with AWS devices, specify amazon-web-services . - For instance types with Xilinx devices, specify xilinx .
Default: Any manufacturer
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-acceleratormanufacturers

property acceleratorNames

readonly acceleratorNames?: string[];

The accelerators that must be on the instance type.
- For instance types with NVIDIA A100 GPUs, specify a100 . - For instance types with NVIDIA V100 GPUs, specify v100 . - For instance types with NVIDIA K80 GPUs, specify k80 . - For instance types with NVIDIA T4 GPUs, specify t4 . - For instance types with NVIDIA M60 GPUs, specify m60 . - For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520 . - For instance types with Xilinx VU9P FPGAs, specify vu9p . - For instance types with AWS Inferentia chips, specify inferentia . - For instance types with NVIDIA GRID K520 GPUs, specify k520 .
Default: Any accelerator
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-acceleratornames

property acceleratorTotalMemoryMiB

readonly acceleratorTotalMemoryMiB?:
    | CfnEC2Fleet.AcceleratorTotalMemoryMiBRequestProperty
    | cdk.IResolvable;

The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limits
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-acceleratortotalmemorymib

property acceleratorTypes

readonly acceleratorTypes?: string[];

The accelerator types that must be on the instance type.
- To include instance types with GPU hardware, specify gpu . - To include instance types with FPGA hardware, specify fpga . - To include instance types with inference hardware, specify inference .
Default: Any accelerator type
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-acceleratortypes

property allowedInstanceTypes

readonly allowedInstanceTypes?: string[];

The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.
You can use strings with one or more wild cards, represented by an asterisk ( * ), to allow an instance type, size, or generation. The following are examples: m5.8xlarge , c5*.* , m5a.* , r* , *3* .
For example, if you specify c5* ,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.* , Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.
> If you specify AllowedInstanceTypes , you can't specify ExcludedInstanceTypes .
Default: All instance types
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-allowedinstancetypes

property bareMetal

readonly bareMetal?: string;

Indicates whether bare metal instance types must be included, excluded, or required.
- To include bare metal instance types, specify included . - To require only bare metal instance types, specify required . - To exclude bare metal instance types, specify excluded .
Default: excluded
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-baremetal

property baselineEbsBandwidthMbps

readonly baselineEbsBandwidthMbps?:
    | CfnEC2Fleet.BaselineEbsBandwidthMbpsRequestProperty
    | cdk.IResolvable;

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide* .
Default: No minimum or maximum limits
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-baselineebsbandwidthmbps

property burstablePerformance

readonly burstablePerformance?: string;

Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) .
- To include burstable performance instance types, specify included . - To require only burstable performance instance types, specify required . - To exclude burstable performance instance types, specify excluded .
Default: excluded
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-burstableperformance

property cpuManufacturers

readonly cpuManufacturers?: string[];

The CPU manufacturers to include.
- For instance types with Intel CPUs, specify intel . - For instance types with AMD CPUs, specify amd . - For instance types with AWS CPUs, specify amazon-web-services .
> Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-cpumanufacturers

property excludedInstanceTypes

readonly excludedInstanceTypes?: string[];

The instance types to exclude.
You can use strings with one or more wild cards, represented by an asterisk ( * ), to exclude an instance family, type, size, or generation. The following are examples: m5.8xlarge , c5*.* , m5a.* , r* , *3* .
For example, if you specify c5* ,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.* , Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.
> If you specify ExcludedInstanceTypes , you can't specify AllowedInstanceTypes .
Default: No excluded instance types
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-excludedinstancetypes

property instanceGenerations

readonly instanceGenerations?: string[];

Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide* .
For current generation instance types, specify current .
For previous generation instance types, specify previous .
Default: Current and previous generation instance types
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-instancegenerations

property localStorage

readonly localStorage?: string;

Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide* .
- To include instance types with instance store volumes, specify included . - To require only instance types with instance store volumes, specify required . - To exclude instance types with instance store volumes, specify excluded .
Default: included
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-localstorage

property localStorageTypes

readonly localStorageTypes?: string[];

The type of local storage that is required.
- For instance types with hard disk drive (HDD) storage, specify hdd . - For instance types with solid state drive (SSD) storage, specify ssd .
Default: hdd and ssd
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-localstoragetypes

property memoryGiBPerVCpu

readonly memoryGiBPerVCpu?:
    | CfnEC2Fleet.MemoryGiBPerVCpuRequestProperty
    | cdk.IResolvable;

The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limits
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-memorygibpervcpu

property memoryMiB

readonly memoryMiB?: CfnEC2Fleet.MemoryMiBRequestProperty | cdk.IResolvable;

The minimum and maximum amount of memory, in MiB.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-memorymib

property networkBandwidthGbps

readonly networkBandwidthGbps?:
    | CfnEC2Fleet.NetworkBandwidthGbpsRequestProperty
    | cdk.IResolvable;

The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Default: No minimum or maximum limits
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-networkbandwidthgbps

property networkInterfaceCount

readonly networkInterfaceCount?:
    | CfnEC2Fleet.NetworkInterfaceCountRequestProperty
    | cdk.IResolvable;

The minimum and maximum number of network interfaces.
Default: No minimum or maximum limits
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-networkinterfacecount

property onDemandMaxPricePercentageOverLowestPrice

readonly onDemandMaxPricePercentageOverLowestPrice?: number;

The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as 999999 .
This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html) .
> If you set TargetCapacityUnitType to vcpu or memory-mib , the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: 20
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-ondemandmaxpricepercentageoverlowestprice

property requireHibernateSupport

readonly requireHibernateSupport?: boolean | cdk.IResolvable;

Indicates whether instance types must support hibernation for On-Demand Instances.
This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) .
Default: false
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-requirehibernatesupport

property spotMaxPricePercentageOverLowestPrice

readonly spotMaxPricePercentageOverLowestPrice?: number;

The price protection threshold for Spot Instance. This is the maximum you’ll pay for an Spot Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as 999999 .
This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html) .
> If you set TargetCapacityUnitType to vcpu or memory-mib , the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: 100
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-spotmaxpricepercentageoverlowestprice

property totalLocalStorageGb

readonly totalLocalStorageGb?:
    | CfnEC2Fleet.TotalLocalStorageGBRequestProperty
    | cdk.IResolvable;

The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limits
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-totallocalstoragegb

property vCpuCount

readonly vCpuCount?: CfnEC2Fleet.VCpuCountRangeRequestProperty | cdk.IResolvable;

The minimum and maximum number of vCPUs.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-vcpucount

interface MaintenanceStrategiesProperty

interface MaintenanceStrategiesProperty {}

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-maintenancestrategies.html

property capacityRebalance

readonly capacityRebalance?:
    | CfnEC2Fleet.CapacityRebalanceProperty
    | cdk.IResolvable;

The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-maintenancestrategies.html#cfn-ec2-ec2fleet-maintenancestrategies-capacityrebalance

interface MemoryGiBPerVCpuRequestProperty

interface MemoryGiBPerVCpuRequestProperty {}

The minimum and maximum amount of memory per vCPU, in GiB.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-memorygibpervcpurequest.html

property max

readonly max?: number;

The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-memorygibpervcpurequest.html#cfn-ec2-ec2fleet-memorygibpervcpurequest-max

property min

readonly min?: number;

The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-memorygibpervcpurequest.html#cfn-ec2-ec2fleet-memorygibpervcpurequest-min

interface MemoryMiBRequestProperty

interface MemoryMiBRequestProperty {}

The minimum and maximum amount of memory, in MiB.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-memorymibrequest.html

property max

readonly max?: number;

The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-memorymibrequest.html#cfn-ec2-ec2fleet-memorymibrequest-max

property min

readonly min?: number;

The minimum amount of memory, in MiB. To specify no minimum limit, specify 0 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-memorymibrequest.html#cfn-ec2-ec2fleet-memorymibrequest-min

interface NetworkBandwidthGbpsRequestProperty

interface NetworkBandwidthGbpsRequestProperty {}

The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
> Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the *Amazon EC2 User Guide* .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-networkbandwidthgbpsrequest.html

property max

readonly max?: number;

The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-networkbandwidthgbpsrequest.html#cfn-ec2-ec2fleet-networkbandwidthgbpsrequest-max

property min

readonly min?: number;

The minimum amount of network bandwidth, in Gbps. To specify no minimum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-networkbandwidthgbpsrequest.html#cfn-ec2-ec2fleet-networkbandwidthgbpsrequest-min

interface NetworkInterfaceCountRequestProperty

interface NetworkInterfaceCountRequestProperty {}

The minimum and maximum number of network interfaces.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-networkinterfacecountrequest.html

property max

readonly max?: number;

The maximum number of network interfaces. To specify no maximum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-networkinterfacecountrequest.html#cfn-ec2-ec2fleet-networkinterfacecountrequest-max

property min

readonly min?: number;

The minimum number of network interfaces. To specify no minimum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-networkinterfacecountrequest.html#cfn-ec2-ec2fleet-networkinterfacecountrequest-min

interface OnDemandOptionsRequestProperty

interface OnDemandOptionsRequestProperty {}

Specifies the allocation strategy of On-Demand Instances in an EC2 Fleet.
OnDemandOptionsRequest is a property of the [AWS::EC2::EC2Fleet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html) resource.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ondemandoptionsrequest.html

property allocationStrategy

readonly allocationStrategy?: string;

The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.
lowest-price - EC2 Fleet uses price to determine the order, launching the lowest price first.
prioritized - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.
Default: lowest-price
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ondemandoptionsrequest.html#cfn-ec2-ec2fleet-ondemandoptionsrequest-allocationstrategy

property capacityReservationOptions

readonly capacityReservationOptions?:
    | CfnEC2Fleet.CapacityReservationOptionsRequestProperty
    | cdk.IResolvable;

The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
Supported only for fleets of type instant .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ondemandoptionsrequest.html#cfn-ec2-ec2fleet-ondemandoptionsrequest-capacityreservationoptions

property maxTotalPrice

readonly maxTotalPrice?: string;

The maximum amount per hour for On-Demand Instances that you're willing to pay.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ondemandoptionsrequest.html#cfn-ec2-ec2fleet-ondemandoptionsrequest-maxtotalprice

property minTargetCapacity

readonly minTargetCapacity?: number;

The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
Supported only for fleets of type instant .
At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ondemandoptionsrequest.html#cfn-ec2-ec2fleet-ondemandoptionsrequest-mintargetcapacity

property singleAvailabilityZone

readonly singleAvailabilityZone?: boolean | cdk.IResolvable;

Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.
Supported only for fleets of type instant .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ondemandoptionsrequest.html#cfn-ec2-ec2fleet-ondemandoptionsrequest-singleavailabilityzone

property singleInstanceType

readonly singleInstanceType?: boolean | cdk.IResolvable;

Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.
Supported only for fleets of type instant .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ondemandoptionsrequest.html#cfn-ec2-ec2fleet-ondemandoptionsrequest-singleinstancetype

interface PlacementProperty

interface PlacementProperty {}

Describes the placement of an instance.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html

property affinity

readonly affinity?: string;

The affinity setting for the instance on the Dedicated Host.
This parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) or [ImportInstance](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-affinity

property availabilityZone

readonly availabilityZone?: string;

The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-availabilityzone

property groupName

readonly groupName?: string;

The name of the placement group that the instance is in. If you specify GroupName , you can't specify GroupId .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-groupname

property hostId

readonly hostId?: string;

The ID of the Dedicated Host on which the instance resides.
This parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) or [ImportInstance](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-hostid

property hostResourceGroupArn

readonly hostResourceGroupArn?: string;

The ARN of the host resource group in which to launch the instances.
If you specify this parameter, either omit the *Tenancy* parameter or set it to host .
This parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-hostresourcegrouparn

property partitionNumber

readonly partitionNumber?: number;

The number of the partition that the instance is in. Valid only if the placement group strategy is set to partition .
This parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-partitionnumber

property spreadDomain

readonly spreadDomain?: string;

Reserved for future use.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-spreaddomain

property tenancy

readonly tenancy?: string;

The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.
This parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) . The host tenancy is not supported for [ImportInstance](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html) or for T3 instances that are configured for the unlimited CPU credit option.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-tenancy

interface SpotOptionsRequestProperty

interface SpotOptionsRequestProperty {}

Specifies the configuration of Spot Instances for an EC2 Fleet.
SpotOptionsRequest is a property of the [AWS::EC2::EC2Fleet](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html) resource.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html

property allocationStrategy

readonly allocationStrategy?: string;

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.
If the allocation strategy is lowestPrice , EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified , EC2 Fleet launches instances from all the Spot Instance pools that you specify.
If the allocation strategy is capacityOptimized , EC2 Fleet launches instances from Spot Instance pools that are optimally chosen based on the available Spot Instance capacity.
*Allowed Values* : lowestPrice | diversified | capacityOptimized | capacityOptimizedPrioritized
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-allocationstrategy

property instanceInterruptionBehavior

readonly instanceInterruptionBehavior?: string;

The behavior when a Spot Instance is interrupted.
Default: terminate
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-instanceinterruptionbehavior

property instancePoolsToUseCount

readonly instancePoolsToUseCount?: number;

The number of Spot pools across which to allocate your target Spot capacity. Supported only when Spot AllocationStrategy is set to lowest-price . EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-instancepoolstousecount

property maintenanceStrategies

readonly maintenanceStrategies?:
    | CfnEC2Fleet.MaintenanceStrategiesProperty
    | cdk.IResolvable;

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-maintenancestrategies

property maxTotalPrice

readonly maxTotalPrice?: string;

The maximum amount per hour for Spot Instances that you're willing to pay. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
> If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-maxtotalprice

property minTargetCapacity

readonly minTargetCapacity?: number;

The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
Supported only for fleets of type instant .
At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-mintargetcapacity

property singleAvailabilityZone

readonly singleAvailabilityZone?: boolean | cdk.IResolvable;

Indicates that the fleet launches all Spot Instances into a single Availability Zone.
Supported only for fleets of type instant .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-singleavailabilityzone

property singleInstanceType

readonly singleInstanceType?: boolean | cdk.IResolvable;

Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
Supported only for fleets of type instant .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-singleinstancetype

interface TagSpecificationProperty

interface TagSpecificationProperty {}

Specifies the tags to apply to a resource when the resource is being created for an EC2 Fleet.
TagSpecification is a property of the [AWS::EC2::EC2Fleet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html) resource.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-tagspecification.html

property resourceType

readonly resourceType?: string;

The type of resource to tag. ResourceType must be fleet .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-tagspecification.html#cfn-ec2-ec2fleet-tagspecification-resourcetype

property tags

readonly tags?: cdk.CfnTag[];

The tags to apply to the resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-tagspecification.html#cfn-ec2-ec2fleet-tagspecification-tags

interface TargetCapacitySpecificationRequestProperty

interface TargetCapacitySpecificationRequestProperty {}

Specifies the number of units to request for an EC2 Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain , you can specify a target capacity of 0 and add capacity later.
TargetCapacitySpecificationRequest is a property of the [AWS::EC2::EC2Fleet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html) resource.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-targetcapacityspecificationrequest.html

property defaultTargetCapacityType

readonly defaultTargetCapacityType?: string;

The default TotalTargetCapacity , which is either Spot or On-Demand .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-targetcapacityspecificationrequest.html#cfn-ec2-ec2fleet-targetcapacityspecificationrequest-defaulttargetcapacitytype

property onDemandTargetCapacity

readonly onDemandTargetCapacity?: number;

The number of On-Demand units to request.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-targetcapacityspecificationrequest.html#cfn-ec2-ec2fleet-targetcapacityspecificationrequest-ondemandtargetcapacity

property spotTargetCapacity

readonly spotTargetCapacity?: number;

The number of Spot units to request.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-targetcapacityspecificationrequest.html#cfn-ec2-ec2fleet-targetcapacityspecificationrequest-spottargetcapacity

property targetCapacityUnitType

readonly targetCapacityUnitType?: string;

The unit for the target capacity. TargetCapacityUnitType can only be specified when InstanceRequirements is specified.
Default: units (translates to number of instances)
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-targetcapacityspecificationrequest.html#cfn-ec2-ec2fleet-targetcapacityspecificationrequest-targetcapacityunittype

property totalTargetCapacity

readonly totalTargetCapacity: number;

The number of units to request, filled using DefaultTargetCapacityType .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-targetcapacityspecificationrequest.html#cfn-ec2-ec2fleet-targetcapacityspecificationrequest-totaltargetcapacity

interface TotalLocalStorageGBRequestProperty

interface TotalLocalStorageGBRequestProperty {}

The minimum and maximum amount of total local storage, in GB.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-totallocalstoragegbrequest.html

property max

readonly max?: number;

The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-totallocalstoragegbrequest.html#cfn-ec2-ec2fleet-totallocalstoragegbrequest-max

property min

readonly min?: number;

The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-totallocalstoragegbrequest.html#cfn-ec2-ec2fleet-totallocalstoragegbrequest-min

interface VCpuCountRangeRequestProperty

interface VCpuCountRangeRequestProperty {}

The minimum and maximum number of vCPUs.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-vcpucountrangerequest.html

property max

readonly max?: number;

The maximum number of vCPUs. To specify no maximum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-vcpucountrangerequest.html#cfn-ec2-ec2fleet-vcpucountrangerequest-max

property min

readonly min?: number;

The minimum number of vCPUs. To specify no minimum limit, specify 0 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-vcpucountrangerequest.html#cfn-ec2-ec2fleet-vcpucountrangerequest-min

namespace CfnFlowLog

namespace CfnFlowLog {}

interface DestinationOptionsProperty

interface DestinationOptionsProperty {}

Describes the destination options for a flow log.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-flowlog-destinationoptions.html

property fileFormat

readonly fileFormat: string;

The format for the flow log. The default is plain-text .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-flowlog-destinationoptions.html#cfn-ec2-flowlog-destinationoptions-fileformat

property hiveCompatiblePartitions

readonly hiveCompatiblePartitions: boolean | cdk.IResolvable;

Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3. The default is false .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-flowlog-destinationoptions.html#cfn-ec2-flowlog-destinationoptions-hivecompatiblepartitions

property perHourPartition

readonly perHourPartition: boolean | cdk.IResolvable;

Indicates whether to partition the flow log per hour. This reduces the cost and response time for queries. The default is false .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-flowlog-destinationoptions.html#cfn-ec2-flowlog-destinationoptions-perhourpartition

namespace CfnInstance

namespace CfnInstance {}

interface AssociationParameterProperty

interface AssociationParameterProperty {}

Specifies input parameter values for an SSM document in AWS Systems Manager .
AssociationParameter is a property of the [Amazon EC2 Instance SsmAssociation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociations.html) property.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociations-associationparameters.html

property key

readonly key: string;

The name of an input parameter that is in the associated SSM document.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociations-associationparameters.html#cfn-ec2-instance-ssmassociations-associationparameters-key

property value

readonly value: string[];

The value of an input parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociations-associationparameters.html#cfn-ec2-instance-ssmassociations-associationparameters-value

interface BlockDeviceMappingProperty

interface BlockDeviceMappingProperty {}

Specifies a block device mapping for an instance. You must specify exactly one of the following properties: VirtualName , Ebs , or NoDevice .
BlockDeviceMapping is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.
> After the instance is running, you can modify only the DeleteOnTermination parameter for the attached volumes without interrupting the instance. Modifying any other parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-mapping.html

property deviceName

readonly deviceName: string;

The device name (for example, /dev/sdh or xvdh ).
> After the instance is running, this parameter is used to specify the device name of the block device mapping to update.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-mapping.html#cfn-ec2-blockdev-mapping-devicename

property ebs

readonly ebs?: CfnInstance.EbsProperty | cdk.IResolvable;

Parameters used to automatically set up EBS volumes when the instance is launched.
> After the instance is running, you can modify only the DeleteOnTermination parameter for the attached volumes without interrupting the instance. Modifying any other parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-mapping.html#cfn-ec2-blockdev-mapping-ebs

property noDevice

readonly noDevice?: CfnInstance.NoDeviceProperty | cdk.IResolvable;

To omit the device from the block device mapping, specify an empty string.
> After the instance is running, modifying this parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-mapping.html#cfn-ec2-blockdev-mapping-nodevice

property virtualName

readonly virtualName?: string;

The virtual device name ( ephemeral N). The name must be in the form ephemeral *X* where *X* is a number starting from zero (0). For example, an instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
*Constraints* : For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
> After the instance is running, modifying this parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-mapping.html#cfn-ec2-blockdev-mapping-virtualname

interface CpuOptionsProperty

interface CpuOptionsProperty {}

Specifies the CPU options for the instance. When you specify CPU options, you must specify both the number of CPU cores and threads per core.
For more information, see [Optimize CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *Amazon Elastic Compute Cloud User Guide* .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-cpuoptions.html

property coreCount

readonly coreCount?: number;

The number of CPU cores for the instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-cpuoptions.html#cfn-ec2-instance-cpuoptions-corecount

property threadsPerCore

readonly threadsPerCore?: number;

The number of threads per CPU core.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-cpuoptions.html#cfn-ec2-instance-cpuoptions-threadspercore

interface CreditSpecificationProperty

interface CreditSpecificationProperty {}

Specifies the credit option for CPU usage of a T instance.
CreditSpecification is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.
For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide* .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-creditspecification.html

property cpuCredits

readonly cpuCredits?: string;

The credit option for CPU usage of the instance.
Valid values: standard | unlimited
T3 instances with host tenancy do not support the unlimited CPU credit option.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-creditspecification.html#cfn-ec2-instance-creditspecification-cpucredits

interface EbsProperty

interface EbsProperty {}

Specifies a block device for an EBS volume.
Ebs is a property of the [Amazon EC2 BlockDeviceMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-mapping.html) property.
> After the instance is running, you can modify only the DeleteOnTermination parameters for the attached volumes without interrupting the instance. Modifying any other parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html

property deleteOnTermination

readonly deleteOnTermination?: boolean | cdk.IResolvable;

Indicates whether the EBS volume is deleted on instance termination. For more information, see [Preserving Amazon EBS volumes on instance termination](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-deleteontermination

property encrypted

readonly encrypted?: boolean | cdk.IResolvable;

Indicates whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) in the *Amazon Elastic Compute Cloud User Guide* .
Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances) .
> After the instance is running, modifying this parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-encrypted

property iops

readonly iops?: number;

The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
- gp3 : 3,000-16,000 IOPS - io1 : 100-64,000 IOPS - io2 : 100-64,000 IOPS
For io1 and io2 volumes, we guarantee 64,000 IOPS only for [Instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
> After the instance is running, modifying this parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-iops

property kmsKeyId

readonly kmsKeyId?: string;

The identifier of the AWS KMS key to use for Amazon EBS encryption. If KmsKeyId is specified, the encrypted state must be true . If the encrypted state is true but you do not specify KmsKeyId , your KMS key for EBS is used.
You can specify the KMS key using any of the following:
- Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. - Key alias. For example, alias/ExampleAlias. - Key ARN. For example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. - Alias ARN. For example, arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias.
> After the instance is running, modifying this parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-instance-ebs-kmskeyid

property snapshotId

readonly snapshotId?: string;

The ID of the snapshot.
If you specify both SnapshotId and VolumeSize , VolumeSize must be equal or greater than the size of the snapshot.
> After the instance is running, modifying this parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-snapshotid

property volumeSize

readonly volumeSize?: number;

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
- gp2 and gp3 :1-16,384 - io1 and io2 : 4-16,384 - st1 and sc1 : 125-16,384 - standard : 1-1,024
> After the instance is running, modifying this parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-volumesize

property volumeType

readonly volumeType?: string;

The volume type. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon EC2 User Guide* . If the volume type is io1 or io2 , you must specify the IOPS that the volume supports.
> After the instance is running, modifying this parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-volumetype

interface ElasticGpuSpecificationProperty

interface ElasticGpuSpecificationProperty {}

Specifies the type of Elastic GPU. An Elastic GPU is a GPU resource that you can attach to your Amazon EC2 instance to accelerate the graphics performance of your applications. For more information, see [Amazon EC2 Elastic GPUs](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html) in the *Amazon EC2 User Guide for Windows Instances* .
ElasticGpuSpecification is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticgpuspecification.html

property type

readonly type: string;

The type of Elastic Graphics accelerator. For more information about the values to specify for Type , see [Elastic Graphics Basics](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html#elastic-graphics-basics) , specifically the Elastic Graphics accelerator column, in the *Amazon Elastic Compute Cloud User Guide for Windows Instances* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticgpuspecification.html#cfn-ec2-instance-elasticgpuspecification-type

interface ElasticInferenceAcceleratorProperty

interface ElasticInferenceAcceleratorProperty {}

Specifies the Elastic Inference Accelerator for the instance.
ElasticInferenceAccelerator is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticinferenceaccelerator.html

property count

readonly count?: number;

The number of elastic inference accelerators to attach to the instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticinferenceaccelerator.html#cfn-ec2-instance-elasticinferenceaccelerator-count

property type

readonly type: string;

The type of elastic inference accelerator. The possible values are eia1.medium , eia1.large , eia1.xlarge , eia2.medium , eia2.large , and eia2.xlarge .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticinferenceaccelerator.html#cfn-ec2-instance-elasticinferenceaccelerator-type

interface EnclaveOptionsProperty

interface EnclaveOptionsProperty {}

Indicates whether the instance is enabled for AWS Nitro Enclaves.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-enclaveoptions.html

property enabled

readonly enabled?: boolean | cdk.IResolvable;

If this parameter is set to true , the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-enclaveoptions.html#cfn-ec2-instance-enclaveoptions-enabled

interface HibernationOptionsProperty

interface HibernationOptionsProperty {}

Specifies the hibernation options for the instance.
HibernationOptions is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-hibernationoptions.html

property configured

readonly configured?: boolean | cdk.IResolvable;

If you set this parameter to true , your instance is enabled for hibernation.
Default: false
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-hibernationoptions.html#cfn-ec2-instance-hibernationoptions-configured

interface InstanceIpv6AddressProperty

interface InstanceIpv6AddressProperty {}

Specifies the IPv6 address for the instance.
InstanceIpv6Address is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-instanceipv6address.html

property ipv6Address

readonly ipv6Address: string;

The IPv6 address.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-instanceipv6address.html#cfn-ec2-instance-instanceipv6address-ipv6address

interface LaunchTemplateSpecificationProperty

interface LaunchTemplateSpecificationProperty {}

Specifies a launch template to use when launching an Amazon EC2 instance.
You must specify the following:
- The ID or the name of the launch template, but not both. - The version of the launch template.
LaunchTemplateSpecification is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.
For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template) in the *Amazon EC2 User Guide* .
For examples of launch templates, see [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-launchtemplatespecification.html

property launchTemplateId

readonly launchTemplateId?: string;

The ID of the launch template.
You must specify the LaunchTemplateId or the LaunchTemplateName , but not both.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-launchtemplatespecification.html#cfn-ec2-instance-launchtemplatespecification-launchtemplateid

property launchTemplateName

readonly launchTemplateName?: string;

The name of the launch template.
You must specify the LaunchTemplateName or the LaunchTemplateId , but not both.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-launchtemplatespecification.html#cfn-ec2-instance-launchtemplatespecification-launchtemplatename

property version

readonly version: string;

The version number of the launch template.
Specifying $Latest or $Default for the template version number is not supported. However, you can specify LatestVersionNumber or DefaultVersionNumber using the Fn::GetAtt intrinsic function. For more information, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate-return-values-fn--getatt) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-launchtemplatespecification.html#cfn-ec2-instance-launchtemplatespecification-version

interface LicenseSpecificationProperty

interface LicenseSpecificationProperty {}

Specifies the license configuration to use.
LicenseSpecification is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-licensespecification.html

property licenseConfigurationArn

readonly licenseConfigurationArn: string;

The Amazon Resource Name (ARN) of the license configuration.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-licensespecification.html#cfn-ec2-instance-licensespecification-licenseconfigurationarn

interface NetworkInterfaceProperty

interface NetworkInterfaceProperty {}

Specifies a network interface that is to be attached to an instance.
You can create a network interface when launching an instance. For an example, see the [AWS::EC2::Instance examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#aws-properties-ec2-instance--examples--Automatically_assign_a_public_IP_address) .
Alternatively, you can attach an existing network interface when launching an instance. For an example, see the [AWS::EC2:NetworkInterface examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#aws-resource-ec2-networkinterface--examples) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html

property associateCarrierIpAddress

readonly associateCarrierIpAddress?: boolean | cdk.IResolvable;

Indicates whether to assign a carrier IP address to the network interface.
You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see [Carrier IP address](https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip) in the *AWS Wavelength Developer Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#cfn-ec2-instance-networkinterface-associatecarrieripaddress

property associatePublicIpAddress

readonly associatePublicIpAddress?: boolean | cdk.IResolvable;

Indicates whether to assign a public IPv4 address to an instance. Applies only if creating a network interface when launching an instance. The network interface must be the primary network interface. If launching into a default subnet, the default value is true .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-associatepubip

property deleteOnTermination

readonly deleteOnTermination?: boolean | cdk.IResolvable;

Indicates whether the network interface is deleted when the instance is terminated. Applies only if creating a network interface when launching an instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-delete

property description

readonly description?: string;

The description of the network interface. Applies only if creating a network interface when launching an instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-description

property deviceIndex

readonly deviceIndex: string;

The position of the network interface in the attachment order. A primary network interface has a device index of 0.
If you create a network interface when launching an instance, you must specify the device index.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-deviceindex

property groupSet

readonly groupSet?: string[];

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-groupset

property ipv6AddressCount

readonly ipv6AddressCount?: number;

A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#cfn-ec2-instance-networkinterface-ipv6addresscount

property ipv6Addresses

readonly ipv6Addresses?:
    | Array<CfnInstance.InstanceIpv6AddressProperty | cdk.IResolvable>
    | cdk.IResolvable;

The IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#cfn-ec2-instance-networkinterface-ipv6addresses

property networkInterfaceId

readonly networkInterfaceId?: string;

The ID of the network interface, when attaching an existing network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-network-iface

property privateIpAddress

readonly privateIpAddress?: string;

The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-privateipaddress

property privateIpAddresses

readonly privateIpAddresses?:
    | Array<CfnInstance.PrivateIpAddressSpecificationProperty | cdk.IResolvable>
    | cdk.IResolvable;

One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-privateipaddresses

property secondaryPrivateIpAddressCount

readonly secondaryPrivateIpAddressCount?: number;

The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-secondprivateip

property subnetId

readonly subnetId?: string;

The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-subnetid

interface NoDeviceProperty

interface NoDeviceProperty {}

Suppresses the specified device included in the block device mapping of the AMI. To suppress a device, specify an empty string.
NoDevice is a property of the [Amazon EC2 BlockDeviceMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-mapping.html) property.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-nodevice.html

interface PrivateDnsNameOptionsProperty

interface PrivateDnsNameOptionsProperty {}

The type of hostnames to assign to instances in the subnet at launch. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide* .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-privatednsnameoptions.html

property enableResourceNameDnsAaaaRecord

readonly enableResourceNameDnsAaaaRecord?: boolean | cdk.IResolvable;

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-privatednsnameoptions.html#cfn-ec2-instance-privatednsnameoptions-enableresourcenamednsaaaarecord

property enableResourceNameDnsARecord

readonly enableResourceNameDnsARecord?: boolean | cdk.IResolvable;

Indicates whether to respond to DNS queries for instance hostnames with DNS A records. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-privatednsnameoptions.html#cfn-ec2-instance-privatednsnameoptions-enableresourcenamednsarecord

property hostnameType

readonly hostnameType?: string;

The type of hostnames to assign to instances in the subnet at launch. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-privatednsnameoptions.html#cfn-ec2-instance-privatednsnameoptions-hostnametype

interface PrivateIpAddressSpecificationProperty

interface PrivateIpAddressSpecificationProperty {}

Specifies a secondary private IPv4 address for a network interface.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-interface-privateipspec.html

property primary

readonly primary: boolean | cdk.IResolvable;

Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-interface-privateipspec.html#cfn-ec2-networkinterface-privateipspecification-primary

property privateIpAddress

readonly privateIpAddress: string;

The private IPv4 address.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-interface-privateipspec.html#cfn-ec2-networkinterface-privateipspecification-privateipaddress

interface SsmAssociationProperty

interface SsmAssociationProperty {}

Specifies the SSM document and parameter values in AWS Systems Manager to associate with an instance.
SsmAssociations is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociations.html

property associationParameters

readonly associationParameters?:
    | Array<CfnInstance.AssociationParameterProperty | cdk.IResolvable>
    | cdk.IResolvable;

The input parameter values to use with the associated SSM document.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociations.html#cfn-ec2-instance-ssmassociations-associationparameters

property documentName

readonly documentName: string;

The name of an SSM document to associate with the instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociations.html#cfn-ec2-instance-ssmassociations-documentname

interface VolumeProperty

interface VolumeProperty {}

Specifies a volume to attach to an instance.
Volume is an embedded property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-mount-point.html

property device

readonly device: string;

The device name (for example, /dev/sdh or xvdh ).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-mount-point.html#cfn-ec2-mountpoint-device

property volumeId

readonly volumeId: string;

The ID of the EBS volume. The volume and instance must be within the same Availability Zone.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-mount-point.html#cfn-ec2-mountpoint-volumeid

namespace CfnIPAM

namespace CfnIPAM {}

interface IpamOperatingRegionProperty

interface IpamOperatingRegionProperty {}

The operating Regions for an IPAM. Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions.
For more information about operating Regions, see [Create an IPAM](https://docs.aws.amazon.com//vpc/latest/ipam/create-ipam.html) in the *Amazon VPC IPAM User Guide* .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipam-ipamoperatingregion.html

property regionName

readonly regionName: string;

The name of the operating Region.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipam-ipamoperatingregion.html#cfn-ec2-ipam-ipamoperatingregion-regionname

namespace CfnIPAMPool

namespace CfnIPAMPool {}

interface ProvisionedCidrProperty

interface ProvisionedCidrProperty {}

The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23 . An IPv6 CIDR example is 2001:DB8::/32 .
> This resource type does not allow you to provision a CIDR using the netmask length. To provision a CIDR using netmask length, use [AWS::EC2::IPAMPoolCidr](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipampool-provisionedcidr.html

property cidr

readonly cidr: string;

The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23 . An IPv6 CIDR example is 2001:DB8::/32 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipampool-provisionedcidr.html#cfn-ec2-ipampool-provisionedcidr-cidr

namespace CfnIPAMResourceDiscovery

namespace CfnIPAMResourceDiscovery {}

interface IpamOperatingRegionProperty

interface IpamOperatingRegionProperty {}

The operating Regions for an IPAM. Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions.
For more information about operating Regions, see [Create an IPAM](https://docs.aws.amazon.com//vpc/latest/ipam/create-ipam.html) in the *Amazon VPC IPAM User Guide* .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamresourcediscovery-ipamoperatingregion.html

property regionName

readonly regionName: string;

The name of the operating Region.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamresourcediscovery-ipamoperatingregion.html#cfn-ec2-ipamresourcediscovery-ipamoperatingregion-regionname

namespace CfnLaunchTemplate

namespace CfnLaunchTemplate {}

interface AcceleratorCountProperty

interface AcceleratorCountProperty {}

The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-acceleratorcount.html

property max

readonly max?: number;

The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set Max to 0 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-acceleratorcount.html#cfn-ec2-launchtemplate-acceleratorcount-max

property min

readonly min?: number;

The minimum number of accelerators. To specify no minimum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-acceleratorcount.html#cfn-ec2-launchtemplate-acceleratorcount-min

interface AcceleratorTotalMemoryMiBProperty

interface AcceleratorTotalMemoryMiBProperty {}

The minimum and maximum amount of total accelerator memory, in MiB.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-acceleratortotalmemorymib.html

property max

readonly max?: number;

The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-acceleratortotalmemorymib.html#cfn-ec2-launchtemplate-acceleratortotalmemorymib-max

property min

readonly min?: number;

The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-acceleratortotalmemorymib.html#cfn-ec2-launchtemplate-acceleratortotalmemorymib-min

interface BaselineEbsBandwidthMbpsProperty

interface BaselineEbsBandwidthMbpsProperty {}

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide* .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-baselineebsbandwidthmbps.html

property max

readonly max?: number;

The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-baselineebsbandwidthmbps.html#cfn-ec2-launchtemplate-baselineebsbandwidthmbps-max

property min

readonly min?: number;

The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-baselineebsbandwidthmbps.html#cfn-ec2-launchtemplate-baselineebsbandwidthmbps-min

interface BlockDeviceMappingProperty

interface BlockDeviceMappingProperty {}

Information about a block device mapping for an Amazon EC2 launch template.
BlockDeviceMapping is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html

property deviceName

readonly deviceName?: string;

The device name (for example, /dev/sdh or xvdh).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-devicename

property ebs

readonly ebs?: CfnLaunchTemplate.EbsProperty | cdk.IResolvable;

Parameters used to automatically set up EBS volumes when the instance is launched.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs

property noDevice

readonly noDevice?: string;

To omit the device from the block device mapping, specify an empty string.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-nodevice

property virtualName

readonly virtualName?: string;

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-virtualname

interface CapacityReservationSpecificationProperty

interface CapacityReservationSpecificationProperty {}

Specifies an instance's Capacity Reservation targeting option. You can specify only one option at a time.
CapacityReservationSpecification is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-capacityreservationspecification.html

property capacityReservationPreference

readonly capacityReservationPreference?: string;

Indicates the instance's Capacity Reservation preferences. Possible preferences include:
- open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). - none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-capacityreservationspecification.html#cfn-ec2-launchtemplate-launchtemplatedata-capacityreservationspecification-capacityreservationpreference

property capacityReservationTarget

readonly capacityReservationTarget?:
    | CfnLaunchTemplate.CapacityReservationTargetProperty
    | cdk.IResolvable;

Information about the target Capacity Reservation or Capacity Reservation group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-capacityreservationspecification.html#cfn-ec2-launchtemplate-launchtemplatedata-capacityreservationspecification-capacityreservationtarget

interface CapacityReservationTargetProperty

interface CapacityReservationTargetProperty {}

Specifies a target Capacity Reservation.
CapacityReservationTarget is a property of the [Amazon EC2 LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) property type.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-capacityreservationtarget.html

property capacityReservationId

readonly capacityReservationId?: string;

The ID of the Capacity Reservation in which to run the instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-capacityreservationtarget.html#cfn-ec2-launchtemplate-capacityreservationtarget-capacityreservationid

property capacityReservationResourceGroupArn

readonly capacityReservationResourceGroupArn?: string;

The ARN of the Capacity Reservation resource group in which to run the instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-capacityreservationtarget.html#cfn-ec2-launchtemplate-capacityreservationtarget-capacityreservationresourcegrouparn

interface CpuOptionsProperty

interface CpuOptionsProperty {}

Specifies the CPU options for an instance. For more information, see [Optimize CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *Amazon Elastic Compute Cloud User Guide* .
CpuOptions is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-cpuoptions.html

property amdSevSnp

readonly amdSevSnp?: string;

Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported with M6a, R6a, and C6a instance types only. For more information, see [AMD SEV-SNP](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-cpuoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-cpuoptions-amdsevsnp

property coreCount

readonly coreCount?: number;

The number of CPU cores for the instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-cpuoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-cpuoptions-corecount

property threadsPerCore

readonly threadsPerCore?: number;

The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1 . Otherwise, specify the default value of 2 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-cpuoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-cpuoptions-threadspercore

interface CreditSpecificationProperty

interface CreditSpecificationProperty {}

Specifies the credit option for CPU usage of a T2, T3, or T3a instance.
CreditSpecification is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-creditspecification.html

property cpuCredits

readonly cpuCredits?: string;

The credit option for CPU usage of a T instance.
Valid values: standard | unlimited
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-creditspecification.html#cfn-ec2-launchtemplate-launchtemplatedata-creditspecification-cpucredits

interface EbsProperty

interface EbsProperty {}

Parameters for a block device for an EBS volume in an Amazon EC2 launch template.
Ebs is a property of [AWS::EC2::LaunchTemplate BlockDeviceMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html

property deleteOnTermination

readonly deleteOnTermination?: boolean | cdk.IResolvable;

Indicates whether the EBS volume is deleted on instance termination.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-deleteontermination

property encrypted

readonly encrypted?: boolean | cdk.IResolvable;

Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-encrypted

property iops

readonly iops?: number;

The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
- gp3 : 3,000-16,000 IOPS - io1 : 100-64,000 IOPS - io2 : 100-64,000 IOPS
For io1 and io2 volumes, we guarantee 64,000 IOPS only for [Instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is supported for io1 , io2 , and gp3 volumes only. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-iops

property kmsKeyId

readonly kmsKeyId?: string;

The ARN of the symmetric AWS Key Management Service ( AWS KMS ) CMK used for encryption.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-kmskeyid

property snapshotId

readonly snapshotId?: string;

The ID of the snapshot.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-snapshotid

property throughput

readonly throughput?: number;

The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
Valid Range: Minimum value of 125. Maximum value of 1000.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-throughput

property volumeSize

readonly volumeSize?: number;

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:
- gp2 and gp3 : 1-16,384 - io1 and io2 : 4-16,384 - st1 and sc1 : 125-16,384 - standard : 1-1,024
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-volumesize

property volumeType

readonly volumeType?: string;

The volume type. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-volumetype

interface ElasticGpuSpecificationProperty

interface ElasticGpuSpecificationProperty {}

Specifies a specification for an Elastic GPU for an Amazon EC2 launch template.
ElasticGpuSpecification is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-elasticgpuspecification.html

property type

readonly type?: string;

The type of Elastic Graphics accelerator. For more information about the values to specify for Type , see [Elastic Graphics Basics](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html#elastic-graphics-basics) , specifically the Elastic Graphics accelerator column, in the *Amazon Elastic Compute Cloud User Guide for Windows Instances* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-elasticgpuspecification.html#cfn-ec2-launchtemplate-elasticgpuspecification-type

interface EnclaveOptionsProperty

interface EnclaveOptionsProperty {}

Indicates whether the instance is enabled for AWS Nitro Enclaves.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-enclaveoptions.html

property enabled

readonly enabled?: boolean | cdk.IResolvable;

If this parameter is set to true , the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-enclaveoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-enclaveoptions-enabled

interface HibernationOptionsProperty

interface HibernationOptionsProperty {}

Specifies whether your instance is configured for hibernation. This parameter is valid only if the instance meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites) . For more information, see [Hibernate Your Instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon EC2 User Guide* .
HibernationOptions is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-hibernationoptions.html

property configured

readonly configured?: boolean | cdk.IResolvable;

If you set this parameter to true , the instance is enabled for hibernation.
Default: false
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-hibernationoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-hibernationoptions-configured

interface IamInstanceProfileProperty

interface IamInstanceProfileProperty {}

Specifies an IAM instance profile, which is a container for an IAM role for your instance. You can use an IAM role to distribute your AWS credentials to your instances.
If you are creating the launch template for use with an Amazon EC2 Auto Scaling group, you can specify either the name or the ARN of the instance profile, but not both.
IamInstanceProfile is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-iaminstanceprofile.html

property arn

readonly arn?: string;

The Amazon Resource Name (ARN) of the instance profile.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-iaminstanceprofile.html#cfn-ec2-launchtemplate-launchtemplatedata-iaminstanceprofile-arn

property name

readonly name?: string;

The name of the instance profile.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-iaminstanceprofile.html#cfn-ec2-launchtemplate-launchtemplatedata-iaminstanceprofile-name

interface InstanceMarketOptionsProperty

interface InstanceMarketOptionsProperty {}

Specifies the market (purchasing) option for an instance.
InstanceMarketOptions is a property of the [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions.html

property marketType

readonly marketType?: string;

The market type.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-markettype

property spotOptions

readonly spotOptions?: CfnLaunchTemplate.SpotOptionsProperty | cdk.IResolvable;

The options for Spot Instances.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions

interface InstanceRequirementsProperty

interface InstanceRequirementsProperty {}

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
- AllowedInstanceTypes - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes. - ExcludedInstanceTypes - The instance types to exclude from the list, even if they match your specified attributes.
> You must specify VCpuCount and MemoryMiB . All other attributes are optional. Any unspecified optional attribute is set to its default.
For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) , [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html) , and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide* .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html

property acceleratorCount

readonly acceleratorCount?:
    | CfnLaunchTemplate.AcceleratorCountProperty
    | cdk.IResolvable;

The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.
To exclude accelerator-enabled instance types, set Max to 0 .
Default: No minimum or maximum limits
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements-acceleratorcount

property acceleratorManufacturers

readonly acceleratorManufacturers?: string[];

Indicates whether instance types must have accelerators by specific manufacturers.
- For instance types with NVIDIA devices, specify nvidia . - For instance types with AMD devices, specify amd . - For instance types with AWS devices, specify amazon-web-services . - For instance types with Xilinx devices, specify xilinx .
Default: Any manufacturer
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements-acceleratormanufacturers

property acceleratorNames

readonly acceleratorNames?: string[];

The accelerators that must be on the instance type.
- For instance types with NVIDIA A100 GPUs, specify a100 . - For instance types with NVIDIA V100 GPUs, specify v100 . - For instance types with NVIDIA K80 GPUs, specify k80 . - For instance types with NVIDIA T4 GPUs, specify t4 . - For instance types with NVIDIA M60 GPUs, specify m60 . - For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520 . - For instance types with Xilinx VU9P FPGAs, specify vu9p . - For instance types with AWS Inferentia chips, specify inferentia . - For instance types with NVIDIA GRID K520 GPUs, specify k520 .
Default: Any accelerator
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements-acceleratornames

property acceleratorTotalMemoryMiB

readonly acceleratorTotalMemoryMiB?:
    | CfnLaunchTemplate.AcceleratorTotalMemoryMiBProperty
    | cdk.IResolvable;

The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limits
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements-acceleratortotalmemorymib

property acceleratorTypes

readonly acceleratorTypes?: string[];

The accelerator types that must be on the instance type.
- For instance types with GPU accelerators, specify gpu . - For instance types with FPGA accelerators, specify fpga . - For instance types with inference accelerators, specify inference .
Default: Any accelerator type
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements-acceleratortypes

property allowedInstanceTypes

readonly allowedInstanceTypes?: string[];

The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.
You can use strings with one or more wild cards, represented by an asterisk ( * ), to allow an instance type, size, or generation. The following are examples: m5.8xlarge , c5*.* , m5a.* , r* , *3* .
For example, if you specify c5* ,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.* , Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.
> If you specify AllowedInstanceTypes , you can't specify ExcludedInstanceTypes .
Default: All instance types
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements-allowedinstancetypes

property bareMetal

readonly bareMetal?: string;

Indicates whether bare metal instance types must be included, excluded, or required.
- To include bare metal instance types, specify included . - To require only bare metal instance types, specify required . - To exclude bare metal instance types, specify excluded .
Default: excluded
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements-baremetal

property baselineEbsBandwidthMbps

readonly baselineEbsBandwidthMbps?:
    | CfnLaunchTemplate.BaselineEbsBandwidthMbpsProperty
    | cdk.IResolvable;

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide* .
Default: No minimum or maximum limits
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements-baselineebsbandwidthmbps

property burstablePerformance

readonly burstablePerformance?: string;

Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) .
- To include burstable performance instance types, specify included . - To require only burstable performance instance types, specify required . - To exclude burstable performance instance types, specify excluded .
Default: excluded
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements-burstableperformance

property cpuManufacturers

readonly cpuManufacturers?: string[];

The CPU manufacturers to include.
- For instance types with Intel CPUs, specify intel . - For instance types with AMD CPUs, specify amd . - For instance types with AWS CPUs, specify amazon-web-services .
> Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements-cpumanufacturers

property excludedInstanceTypes

readonly excludedInstanceTypes?: string[];

The instance types to exclude.
You can use strings with one or more wild cards, represented by an asterisk ( * ), to exclude an instance type, size, or generation. The following are examples: m5.8xlarge , c5*.* , m5a.* , r* , *3* .
For example, if you specify c5* ,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.* , Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.
> If you specify ExcludedInstanceTypes , you can't specify AllowedInstanceTypes .
Default: No excluded instance types
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements-excludedinstancetypes

property instanceGenerations

readonly instanceGenerations?: string[];

Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide* .
For current generation instance types, specify current .
For previous generation instance types, specify previous .
Default: Current and previous generation instance types
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements-instancegenerations

property localStorage

readonly localStorage?: string;

Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide* .
- To include instance types with instance store volumes, specify included . - To require only instance types with instance store volumes, specify required . - To exclude instance types with instance store volumes, specify excluded .
Default: included
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements-localstorage

property localStorageTypes

readonly localStorageTypes?: string[];

The type of local storage that is required.
- For instance types with hard disk drive (HDD) storage, specify hdd . - For instance types with solid state drive (SSD) storage, specify ssd .
Default: hdd and ssd
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements-localstoragetypes

property memoryGiBPerVCpu

readonly memoryGiBPerVCpu?:
    | CfnLaunchTemplate.MemoryGiBPerVCpuProperty
    | cdk.IResolvable;

The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limits
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements-memorygibpervcpu

property memoryMiB

readonly memoryMiB?: CfnLaunchTemplate.MemoryMiBProperty | cdk.IResolvable;

The minimum and maximum amount of memory, in MiB.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements-memorymib

property networkBandwidthGbps

readonly networkBandwidthGbps?:
    | CfnLaunchTemplate.NetworkBandwidthGbpsProperty
    | cdk.IResolvable;

The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Default: No minimum or maximum limits
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements-networkbandwidthgbps

property networkInterfaceCount

readonly networkInterfaceCount?:
    | CfnLaunchTemplate.NetworkInterfaceCountProperty
    | cdk.IResolvable;

The minimum and maximum number of network interfaces.
Default: No minimum or maximum limits
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements-networkinterfacecount

property onDemandMaxPricePercentageOverLowestPrice

readonly onDemandMaxPricePercentageOverLowestPrice?: number;

The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as 999999 .
This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html) .
> If you set TargetCapacityUnitType to vcpu or memory-mib , the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: 20
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements-ondemandmaxpricepercentageoverlowestprice

property requireHibernateSupport

readonly requireHibernateSupport?: boolean | cdk.IResolvable;

Indicates whether instance types must support hibernation for On-Demand Instances.
This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) .
Default: false
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements-requirehibernatesupport

property spotMaxPricePercentageOverLowestPrice

readonly spotMaxPricePercentageOverLowestPrice?: number;

The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as 999999 .
This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html) .
> If you set TargetCapacityUnitType to vcpu or memory-mib , the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: 100
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements-spotmaxpricepercentageoverlowestprice

property totalLocalStorageGb

readonly totalLocalStorageGb?:
    | CfnLaunchTemplate.TotalLocalStorageGBProperty
    | cdk.IResolvable;

The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limits
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements-totallocalstoragegb

property vCpuCount

readonly vCpuCount?: CfnLaunchTemplate.VCpuCountProperty | cdk.IResolvable;

The minimum and maximum number of vCPUs.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements-vcpucount

interface Ipv4PrefixSpecificationProperty

interface Ipv4PrefixSpecificationProperty {}

Specifies an IPv4 prefix for a network interface.
Ipv4PrefixSpecification is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ipv4prefixspecification.html

property ipv4Prefix

readonly ipv4Prefix?: string;

The IPv4 prefix. For information, see [Assigning prefixes to Amazon EC2 network interfaces](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) in the *Amazon Elastic Compute Cloud User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ipv4prefixspecification.html#cfn-ec2-launchtemplate-ipv4prefixspecification-ipv4prefix

interface Ipv6AddProperty

interface Ipv6AddProperty {}

Specifies an IPv6 address in an Amazon EC2 launch template.
Ipv6Add is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ipv6add.html

property ipv6Address

readonly ipv6Address?: string;

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ipv6add.html#cfn-ec2-launchtemplate-ipv6add-ipv6address

interface Ipv6PrefixSpecificationProperty

interface Ipv6PrefixSpecificationProperty {}

Specifies an IPv6 prefix for a network interface.
Ipv6PrefixSpecification is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ipv6prefixspecification.html

property ipv6Prefix

readonly ipv6Prefix?: string;

The IPv6 prefix.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ipv6prefixspecification.html#cfn-ec2-launchtemplate-ipv6prefixspecification-ipv6prefix

interface LaunchTemplateDataProperty

interface LaunchTemplateDataProperty {}

The information to include in the launch template.
> You must specify at least one parameter for the launch template data.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html

property blockDeviceMappings

readonly blockDeviceMappings?:
    | Array<CfnLaunchTemplate.BlockDeviceMappingProperty | cdk.IResolvable>
    | cdk.IResolvable;

The block device mapping.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-blockdevicemappings

property capacityReservationSpecification

readonly capacityReservationSpecification?:
    | CfnLaunchTemplate.CapacityReservationSpecificationProperty
    | cdk.IResolvable;

The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open , which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-capacityreservationspecification

property cpuOptions

readonly cpuOptions?: CfnLaunchTemplate.CpuOptionsProperty | cdk.IResolvable;

The CPU options for the instance. For more information, see [Optimizing CPU Options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *Amazon Elastic Compute Cloud User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-cpuoptions

property creditSpecification

readonly creditSpecification?:
    | CfnLaunchTemplate.CreditSpecificationProperty
    | cdk.IResolvable;

The credit option for CPU usage of the instance. Valid only for T instances.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-creditspecification

property disableApiStop

readonly disableApiStop?: boolean | cdk.IResolvable;

Indicates whether to enable the instance for stop protection. For more information, see [Stop protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection) in the *Amazon Elastic Compute Cloud User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-disableapistop

property disableApiTermination

readonly disableApiTermination?: boolean | cdk.IResolvable;

If you set this parameter to true , you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use [ModifyInstanceAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html) . Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate , you can terminate the instance by running the shutdown command from the instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-disableapitermination

property ebsOptimized

readonly ebsOptimized?: boolean | cdk.IResolvable;

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-ebsoptimized

property elasticGpuSpecifications

readonly elasticGpuSpecifications?:
    | Array<CfnLaunchTemplate.ElasticGpuSpecificationProperty | cdk.IResolvable>
    | cdk.IResolvable;

An elastic GPU to associate with the instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-elasticgpuspecifications

property elasticInferenceAccelerators

readonly elasticInferenceAccelerators?:
    | Array<
          | CfnLaunchTemplate.LaunchTemplateElasticInferenceAcceleratorProperty
          | cdk.IResolvable
      >
    | cdk.IResolvable;

The elastic inference accelerator for the instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-elasticinferenceaccelerators

property enclaveOptions

readonly enclaveOptions?:
    | CfnLaunchTemplate.EnclaveOptionsProperty
    | cdk.IResolvable;

Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see [What is AWS Nitro Enclaves?](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) in the *AWS Nitro Enclaves User Guide* .
You can't enable AWS Nitro Enclaves and hibernation on the same instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-enclaveoptions

property hibernationOptions

readonly hibernationOptions?:
    | CfnLaunchTemplate.HibernationOptionsProperty
    | cdk.IResolvable;

Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html) . For more information, see [Hibernate your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon Elastic Compute Cloud User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-hibernationoptions

property iamInstanceProfile

readonly iamInstanceProfile?:
    | CfnLaunchTemplate.IamInstanceProfileProperty
    | cdk.IResolvable;

The name or Amazon Resource Name (ARN) of an IAM instance profile.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-iaminstanceprofile

property imageId

readonly imageId?: string;

The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch.
Valid formats:
- ami-17characters00000 - resolve:ssm:parameter-name - resolve:ssm:parameter-name:version-number - resolve:ssm:parameter-name:label
For more information, see [Use a Systems Manager parameter to find an AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html#using-systems-manager-parameter-to-find-AMI) in the *Amazon Elastic Compute Cloud User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-imageid

property instanceInitiatedShutdownBehavior

readonly instanceInitiatedShutdownBehavior?: string;

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-instanceinitiatedshutdownbehavior

property instanceMarketOptions

readonly instanceMarketOptions?:
    | CfnLaunchTemplate.InstanceMarketOptionsProperty
    | cdk.IResolvable;

The market (purchasing) option for the instances.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions

property instanceRequirements

readonly instanceRequirements?:
    | CfnLaunchTemplate.InstanceRequirementsProperty
    | cdk.IResolvable;

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
If you specify InstanceRequirements , you can't specify InstanceType .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements

property instanceType

readonly instanceType?: string;

The instance type. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon Elastic Compute Cloud User Guide* .
If you specify InstanceType , you can't specify InstanceRequirements .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-instancetype

property kernelId

readonly kernelId?: string;

The ID of the kernel.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User Provided Kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-kernelid

property keyName

readonly keyName?: string;

The name of the key pair. You can create a key pair using [CreateKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) or [ImportKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html) .
> If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-keyname

property licenseSpecifications

readonly licenseSpecifications?:
    | Array<CfnLaunchTemplate.LicenseSpecificationProperty | cdk.IResolvable>
    | cdk.IResolvable;

The license configurations.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-licensespecifications

property maintenanceOptions

readonly maintenanceOptions?:
    | CfnLaunchTemplate.MaintenanceOptionsProperty
    | cdk.IResolvable;

The maintenance options of your instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-maintenanceoptions

property metadataOptions

readonly metadataOptions?:
    | CfnLaunchTemplate.MetadataOptionsProperty
    | cdk.IResolvable;

The metadata options for the instance. For more information, see [Instance metadata and user data](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) in the *Amazon Elastic Compute Cloud User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions

property monitoring

readonly monitoring?: CfnLaunchTemplate.MonitoringProperty | cdk.IResolvable;

The monitoring for the instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-monitoring

property networkInterfaces

readonly networkInterfaces?:
    | Array<CfnLaunchTemplate.NetworkInterfaceProperty | cdk.IResolvable>
    | cdk.IResolvable;

One or more network interfaces. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-networkinterfaces

property placement

readonly placement?: CfnLaunchTemplate.PlacementProperty | cdk.IResolvable;

The placement for the instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-placement

property privateDnsNameOptions

readonly privateDnsNameOptions?:
    | CfnLaunchTemplate.PrivateDnsNameOptionsProperty
    | cdk.IResolvable;

The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-privatednsnameoptions

property ramDiskId

readonly ramDiskId?: string;

The ID of the RAM disk.
> We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User provided kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon Elastic Compute Cloud User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-ramdiskid

property securityGroupIds

readonly securityGroupIds?: string[];

The IDs of the security groups. You can specify the IDs of existing security groups and references to resources created by the stack template.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-securitygroupids

property securityGroups

readonly securityGroups?: string[];

One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-securitygroups

property tagSpecifications

readonly tagSpecifications?:
    | Array<CfnLaunchTemplate.TagSpecificationProperty | cdk.IResolvable>
    | cdk.IResolvable;

The tags to apply to the resources that are created during instance launch.
You can specify tags for the following resources only:
- Instances - Volumes - Elastic graphics - Spot Instance requests - Network interfaces
To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html) .
> To tag the launch template itself, you must use the [TagSpecification](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html) parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications

property userData

readonly userData?: string;

The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see [Run commands on your Linux instance at launch](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) (Linux) or [Work with instance user data](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/instancedata-add-user-data.html) (Windows) in the *Amazon Elastic Compute Cloud User Guide* .
If you are creating the launch template for use with AWS Batch , the user data must be provided in the [MIME multi-part archive format](https://docs.aws.amazon.com/https://cloudinit.readthedocs.io/en/latest/topics/format.html#mime-multi-part-archive) . For more information, see [Amazon EC2 user data in launch templates](https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) in the *AWS Batch User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-userdata

interface LaunchTemplateElasticInferenceAcceleratorProperty

interface LaunchTemplateElasticInferenceAcceleratorProperty {}

Specifies an elastic inference accelerator.
LaunchTemplateElasticInferenceAccelerator is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplateelasticinferenceaccelerator.html

property count

readonly count?: number;

The number of elastic inference accelerators to attach to the instance.
Default: 1
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplateelasticinferenceaccelerator.html#cfn-ec2-launchtemplate-launchtemplateelasticinferenceaccelerator-count

property type

readonly type?: string;

The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplateelasticinferenceaccelerator.html#cfn-ec2-launchtemplate-launchtemplateelasticinferenceaccelerator-type

interface LaunchTemplateTagSpecificationProperty

interface LaunchTemplateTagSpecificationProperty {}

Specifies the tags to apply to the launch template during creation.
LaunchTemplateTagSpecification is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatetagspecification.html

property resourceType

readonly resourceType?: string;

The type of resource. To tag the launch template, ResourceType must be launch-template .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatetagspecification.html#cfn-ec2-launchtemplate-launchtemplatetagspecification-resourcetype

property tags

readonly tags?: cdk.CfnTag[];

The tags for the resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatetagspecification.html#cfn-ec2-launchtemplate-launchtemplatetagspecification-tags

interface LicenseSpecificationProperty

interface LicenseSpecificationProperty {}

Specifies a license configuration for an instance.
LicenseSpecification is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-licensespecification.html

property licenseConfigurationArn

readonly licenseConfigurationArn?: string;

The Amazon Resource Name (ARN) of the license configuration.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-licensespecification.html#cfn-ec2-launchtemplate-licensespecification-licenseconfigurationarn

interface MaintenanceOptionsProperty

interface MaintenanceOptionsProperty {}

The maintenance options of your instance.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-maintenanceoptions.html

property autoRecovery

readonly autoRecovery?: string;

Disables the automatic recovery behavior of your instance or sets it to default.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-maintenanceoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-maintenanceoptions-autorecovery

interface MemoryGiBPerVCpuProperty

interface MemoryGiBPerVCpuProperty {}

The minimum and maximum amount of memory per vCPU, in GiB.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-memorygibpervcpu.html

property max

readonly max?: number;

The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-memorygibpervcpu.html#cfn-ec2-launchtemplate-memorygibpervcpu-max

property min

readonly min?: number;

The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-memorygibpervcpu.html#cfn-ec2-launchtemplate-memorygibpervcpu-min

interface MemoryMiBProperty

interface MemoryMiBProperty {}

The minimum and maximum amount of memory, in MiB.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-memorymib.html

property max

readonly max?: number;

The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-memorymib.html#cfn-ec2-launchtemplate-memorymib-max

property min

readonly min?: number;

The minimum amount of memory, in MiB. To specify no minimum limit, specify 0 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-memorymib.html#cfn-ec2-launchtemplate-memorymib-min

interface MetadataOptionsProperty

interface MetadataOptionsProperty {}

The metadata options for the instance. For more information, see [Instance metadata and user data](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) in the *Amazon EC2 User Guide* .
MetadataOptions is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html

property httpEndpoint

readonly httpEndpoint?: string;

Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled .
> If you specify a value of disabled , you will not be able to access your instance metadata.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-httpendpoint

property httpProtocolIpv6

readonly httpProtocolIpv6?: string;

Enables or disables the IPv6 endpoint for the instance metadata service.
Default: disabled
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-httpprotocolipv6

property httpPutResponseHopLimit

readonly httpPutResponseHopLimit?: number;

The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-httpputresponsehoplimit

property httpTokens

readonly httpTokens?: string;

IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional (in other words, set the use of IMDSv2 to optional ) or required (in other words, set the use of IMDSv2 to required ).
- optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role credentials are returned. - required - When IMDSv2 is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.
Default: optional
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-httptokens

property instanceMetadataTags

readonly instanceMetadataTags?: string;

Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see [Work with instance tags using the instance metadata](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS) .
Default: disabled
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-instancemetadatatags

interface MonitoringProperty

interface MonitoringProperty {}

Specifies whether detailed monitoring is enabled for an instance. For more information about detailed monitoring, see [Enable or turn off detailed monitoring for your instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html) in the *Amazon EC2 User Guide* .
Monitoring is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-monitoring.html

property enabled

readonly enabled?: boolean | cdk.IResolvable;

Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-monitoring.html#cfn-ec2-launchtemplate-launchtemplatedata-monitoring-enabled

interface NetworkBandwidthGbpsProperty

interface NetworkBandwidthGbpsProperty {}

The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
> Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the *Amazon EC2 User Guide* .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkbandwidthgbps.html

property max

readonly max?: number;

The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkbandwidthgbps.html#cfn-ec2-launchtemplate-networkbandwidthgbps-max

property min

readonly min?: number;

The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkbandwidthgbps.html#cfn-ec2-launchtemplate-networkbandwidthgbps-min

interface NetworkInterfaceCountProperty

interface NetworkInterfaceCountProperty {}

The minimum and maximum number of network interfaces.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterfacecount.html

property max

readonly max?: number;

The maximum number of network interfaces. To specify no maximum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterfacecount.html#cfn-ec2-launchtemplate-networkinterfacecount-max

property min

readonly min?: number;

The minimum number of network interfaces. To specify no minimum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterfacecount.html#cfn-ec2-launchtemplate-networkinterfacecount-min

interface NetworkInterfaceProperty

interface NetworkInterfaceProperty {}

Specifies the parameters for a network interface.
NetworkInterface is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html

property associateCarrierIpAddress

readonly associateCarrierIpAddress?: boolean | cdk.IResolvable;

Indicates whether to associate a Carrier IP address with eth0 for a new network interface.
Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see [Carrier IP addresses](https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip) in the *AWS Wavelength Developer Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-associatecarrieripaddress

property associatePublicIpAddress

readonly associatePublicIpAddress?: boolean | cdk.IResolvable;

Associates a public IPv4 address with eth0 for a new network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-associatepublicipaddress

property deleteOnTermination

readonly deleteOnTermination?: boolean | cdk.IResolvable;

Indicates whether the network interface is deleted when the instance is terminated.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-deleteontermination

property description

readonly description?: string;

A description for the network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-description

property deviceIndex

readonly deviceIndex?: number;

The device index for the network interface attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-deviceindex

property groups

readonly groups?: string[];

The IDs of one or more security groups.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-groups

property interfaceType

readonly interfaceType?: string;

The type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa . For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon Elastic Compute Cloud User Guide* .
If you are not creating an EFA, specify interface or omit this parameter.
Valid values: interface | efa
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-interfacetype

property ipv4PrefixCount

readonly ipv4PrefixCount?: number;

The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv4Prefix option.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-ipv4prefixcount

property ipv4Prefixes

readonly ipv4Prefixes?:
    | Array<CfnLaunchTemplate.Ipv4PrefixSpecificationProperty | cdk.IResolvable>
    | cdk.IResolvable;

One or more IPv4 prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-ipv4prefixes

property ipv6AddressCount

readonly ipv6AddressCount?: number;

The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-ipv6addresscount

property ipv6Addresses

readonly ipv6Addresses?:
    | Array<CfnLaunchTemplate.Ipv6AddProperty | cdk.IResolvable>
    | cdk.IResolvable;

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-ipv6addresses

property ipv6PrefixCount

readonly ipv6PrefixCount?: number;

The number of IPv6 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-ipv6prefixcount

property ipv6Prefixes

readonly ipv6Prefixes?:
    | Array<CfnLaunchTemplate.Ipv6PrefixSpecificationProperty | cdk.IResolvable>
    | cdk.IResolvable;

One or more IPv6 prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-ipv6prefixes

property networkCardIndex

readonly networkCardIndex?: number;

The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-networkcardindex

property networkInterfaceId

readonly networkInterfaceId?: string;

The ID of the network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-networkinterfaceid

property privateIpAddress

readonly privateIpAddress?: string;

The primary private IPv4 address of the network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-privateipaddress

property privateIpAddresses

readonly privateIpAddresses?:
    | Array<CfnLaunchTemplate.PrivateIpAddProperty | cdk.IResolvable>
    | cdk.IResolvable;

One or more private IPv4 addresses.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-privateipaddresses

property secondaryPrivateIpAddressCount

readonly secondaryPrivateIpAddressCount?: number;

The number of secondary private IPv4 addresses to assign to a network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-secondaryprivateipaddresscount

property subnetId

readonly subnetId?: string;

The ID of the subnet for the network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-subnetid

interface PlacementProperty

interface PlacementProperty {}

Specifies the placement of an instance.
Placement is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html

property affinity

readonly affinity?: string;

The affinity setting for an instance on a Dedicated Host.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-affinity

property availabilityZone

readonly availabilityZone?: string;

The Availability Zone for the instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-availabilityzone

property groupId

readonly groupId?: string;

The Group Id of a placement group. You must specify the Placement Group *Group Id* to launch an instance in a shared placement group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-groupid

property groupName

readonly groupName?: string;

The name of the placement group for the instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-groupname

property hostId

readonly hostId?: string;

The ID of the Dedicated Host for the instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-hostid

property hostResourceGroupArn

readonly hostResourceGroupArn?: string;

The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the *Tenancy* parameter or set it to host .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-hostresourcegrouparn

property partitionNumber

readonly partitionNumber?: number;

The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-partitionnumber

property spreadDomain

readonly spreadDomain?: string;

Reserved for future use.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-spreaddomain

property tenancy

readonly tenancy?: string;

The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-tenancy

interface PrivateDnsNameOptionsProperty

interface PrivateDnsNameOptionsProperty {}

The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide* .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-privatednsnameoptions.html

property enableResourceNameDnsAaaaRecord

readonly enableResourceNameDnsAaaaRecord?: boolean | cdk.IResolvable;

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-privatednsnameoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-privatednsnameoptions-enableresourcenamednsaaaarecord

property enableResourceNameDnsARecord

readonly enableResourceNameDnsARecord?: boolean | cdk.IResolvable;

Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-privatednsnameoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-privatednsnameoptions-enableresourcenamednsarecord

property hostnameType

readonly hostnameType?: string;

The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-privatednsnameoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-privatednsnameoptions-hostnametype

interface PrivateIpAddProperty

interface PrivateIpAddProperty {}

Specifies a secondary private IPv4 address for a network interface.
PrivateIpAdd is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-privateipadd.html

property primary

readonly primary?: boolean | cdk.IResolvable;

Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-privateipadd.html#cfn-ec2-launchtemplate-privateipadd-primary

property privateIpAddress

readonly privateIpAddress?: string;

The private IPv4 address.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-privateipadd.html#cfn-ec2-launchtemplate-privateipadd-privateipaddress

interface SpotOptionsProperty

interface SpotOptionsProperty {}

Specifies options for Spot Instances.
SpotOptions is a property of [AWS::EC2::LaunchTemplate InstanceMarketOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions.html

property blockDurationMinutes

readonly blockDurationMinutes?: number;

Deprecated.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions-blockdurationminutes

property instanceInterruptionBehavior

readonly instanceInterruptionBehavior?: string;

The behavior when a Spot Instance is interrupted. The default is terminate .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions-instanceinterruptionbehavior

property maxPrice

readonly maxPrice?: string;

The maximum hourly price you're willing to pay for the Spot Instances. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
> If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions-maxprice

property spotInstanceType

readonly spotInstanceType?: string;

The Spot Instance request type.
If you are using Spot Instances with an Auto Scaling group, use one-time requests, as the Amazon EC2 Auto Scaling service handles requesting new Spot Instances whenever the group is below its desired capacity.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions-spotinstancetype

property validUntil

readonly validUntil?: string;

The end date of the request, in UTC format ( *YYYY-MM-DD* T *HH:MM:SS* Z). Supported only for persistent requests.
- For a persistent request, the request remains active until the ValidUntil date and time is reached. Otherwise, the request remains active until you cancel it. - For a one-time request, ValidUntil is not supported. The request remains active until all instances launch or you cancel the request.
Default: 7 days from the current date
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions-validuntil

interface TagSpecificationProperty

interface TagSpecificationProperty {}

Specifies the tags to apply to a resource when the resource is created for the launch template.
TagSpecification is a property type of [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) . [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html

property resourceType

readonly resourceType?: string;

The type of resource to tag.
The Valid Values are all the resource types that can be tagged. However, when creating a launch template, you can specify tags for the following resource types only: instance | volume | elastic-gpu | network-interface | spot-instances-request
To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html#cfn-ec2-launchtemplate-tagspecification-resourcetype

property tags

readonly tags?: cdk.CfnTag[];

The tags to apply to the resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html#cfn-ec2-launchtemplate-tagspecification-tags

interface TotalLocalStorageGBProperty

interface TotalLocalStorageGBProperty {}

The minimum and maximum amount of total local storage, in GB.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-totallocalstoragegb.html

property max

readonly max?: number;

The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-totallocalstoragegb.html#cfn-ec2-launchtemplate-totallocalstoragegb-max

property min

readonly min?: number;

The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-totallocalstoragegb.html#cfn-ec2-launchtemplate-totallocalstoragegb-min

interface VCpuCountProperty

interface VCpuCountProperty {}

The minimum and maximum number of vCPUs.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-vcpucount.html

property max

readonly max?: number;

The maximum number of vCPUs. To specify no maximum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-vcpucount.html#cfn-ec2-launchtemplate-vcpucount-max

property min

readonly min?: number;

The minimum number of vCPUs. To specify no minimum limit, specify 0 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-vcpucount.html#cfn-ec2-launchtemplate-vcpucount-min

namespace CfnNetworkAclEntry

namespace CfnNetworkAclEntry {}

interface IcmpProperty

interface IcmpProperty {}

Describes the ICMP type and code.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-icmp.html

property code

readonly code?: number;

The Internet Control Message Protocol (ICMP) code. You can use -1 to specify all ICMP codes for the given ICMP type. Requirement is conditional: Required if you specify 1 (ICMP) for the protocol parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-icmp.html#cfn-ec2-networkaclentry-icmp-code

property type

readonly type?: number;

The Internet Control Message Protocol (ICMP) type. You can use -1 to specify all ICMP types. Conditional requirement: Required if you specify 1 (ICMP) for the CreateNetworkAclEntry protocol parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-icmp.html#cfn-ec2-networkaclentry-icmp-type

interface PortRangeProperty

interface PortRangeProperty {}

Describes a range of ports.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-portrange.html

property from

readonly from?: number;

The first port in the range. Required if you specify 6 (TCP) or 17 (UDP) for the protocol parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-portrange.html#cfn-ec2-networkaclentry-portrange-from

property to

readonly to?: number;

The last port in the range. Required if you specify 6 (TCP) or 17 (UDP) for the protocol parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-portrange.html#cfn-ec2-networkaclentry-portrange-to

namespace CfnNetworkInsightsAccessScope

namespace CfnNetworkInsightsAccessScope {}

interface AccessScopePathRequestProperty

interface AccessScopePathRequestProperty {}

Describes a path.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-accessscopepathrequest.html

property destination

readonly destination?:
    | CfnNetworkInsightsAccessScope.PathStatementRequestProperty
    | cdk.IResolvable;

The destination.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-accessscopepathrequest.html#cfn-ec2-networkinsightsaccessscope-accessscopepathrequest-destination

property source

readonly source?:
    | CfnNetworkInsightsAccessScope.PathStatementRequestProperty
    | cdk.IResolvable;

The source.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-accessscopepathrequest.html#cfn-ec2-networkinsightsaccessscope-accessscopepathrequest-source

property throughResources

readonly throughResources?:
    | Array<
          | CfnNetworkInsightsAccessScope.ThroughResourcesStatementRequestProperty
          | cdk.IResolvable
      >
    | cdk.IResolvable;

The through resources.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-accessscopepathrequest.html#cfn-ec2-networkinsightsaccessscope-accessscopepathrequest-throughresources

interface PacketHeaderStatementRequestProperty

interface PacketHeaderStatementRequestProperty {}

Describes a packet header statement.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-packetheaderstatementrequest.html

property destinationAddresses

readonly destinationAddresses?: string[];

The destination addresses.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-packetheaderstatementrequest.html#cfn-ec2-networkinsightsaccessscope-packetheaderstatementrequest-destinationaddresses

property destinationPorts

readonly destinationPorts?: string[];

The destination ports.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-packetheaderstatementrequest.html#cfn-ec2-networkinsightsaccessscope-packetheaderstatementrequest-destinationports

property destinationPrefixLists

readonly destinationPrefixLists?: string[];

The destination prefix lists.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-packetheaderstatementrequest.html#cfn-ec2-networkinsightsaccessscope-packetheaderstatementrequest-destinationprefixlists

property protocols

readonly protocols?: string[];

The protocols.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-packetheaderstatementrequest.html#cfn-ec2-networkinsightsaccessscope-packetheaderstatementrequest-protocols

property sourceAddresses

readonly sourceAddresses?: string[];

The source addresses.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-packetheaderstatementrequest.html#cfn-ec2-networkinsightsaccessscope-packetheaderstatementrequest-sourceaddresses

property sourcePorts

readonly sourcePorts?: string[];

The source ports.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-packetheaderstatementrequest.html#cfn-ec2-networkinsightsaccessscope-packetheaderstatementrequest-sourceports

property sourcePrefixLists

readonly sourcePrefixLists?: string[];

The source prefix lists.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-packetheaderstatementrequest.html#cfn-ec2-networkinsightsaccessscope-packetheaderstatementrequest-sourceprefixlists

interface PathStatementRequestProperty

interface PathStatementRequestProperty {}

Describes a path statement.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-pathstatementrequest.html

property packetHeaderStatement

readonly packetHeaderStatement?:
    | CfnNetworkInsightsAccessScope.PacketHeaderStatementRequestProperty
    | cdk.IResolvable;

The packet header statement.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-pathstatementrequest.html#cfn-ec2-networkinsightsaccessscope-pathstatementrequest-packetheaderstatement

property resourceStatement

readonly resourceStatement?:
    | CfnNetworkInsightsAccessScope.ResourceStatementRequestProperty
    | cdk.IResolvable;

The resource statement.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-pathstatementrequest.html#cfn-ec2-networkinsightsaccessscope-pathstatementrequest-resourcestatement

interface ResourceStatementRequestProperty

interface ResourceStatementRequestProperty {}

Describes a resource statement.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-resourcestatementrequest.html

property resources

readonly resources?: string[];

The resources.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-resourcestatementrequest.html#cfn-ec2-networkinsightsaccessscope-resourcestatementrequest-resources

property resourceTypes

readonly resourceTypes?: string[];

The resource types.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-resourcestatementrequest.html#cfn-ec2-networkinsightsaccessscope-resourcestatementrequest-resourcetypes

interface ThroughResourcesStatementRequestProperty

interface ThroughResourcesStatementRequestProperty {}

Describes a through resource statement.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-throughresourcesstatementrequest.html

property resourceStatement

readonly resourceStatement?:
    | CfnNetworkInsightsAccessScope.ResourceStatementRequestProperty
    | cdk.IResolvable;

The resource statement.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-throughresourcesstatementrequest.html#cfn-ec2-networkinsightsaccessscope-throughresourcesstatementrequest-resourcestatement

namespace CfnNetworkInsightsAnalysis

namespace CfnNetworkInsightsAnalysis {}

interface AdditionalDetailProperty

interface AdditionalDetailProperty {}

Describes an additional detail for a path analysis. For more information, see [Reachability Analyzer additional detail codes](https://docs.aws.amazon.com/vpc/latest/reachability/additional-detail-codes.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-additionaldetail.html

property additionalDetailType

readonly additionalDetailType?: string;

The additional detail code.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-additionaldetail.html#cfn-ec2-networkinsightsanalysis-additionaldetail-additionaldetailtype

property component

readonly component?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The path component.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-additionaldetail.html#cfn-ec2-networkinsightsanalysis-additionaldetail-component

property loadBalancers

readonly loadBalancers?:
    | Array<
          CfnNetworkInsightsAnalysis.AnalysisComponentProperty | cdk.IResolvable
      >
    | cdk.IResolvable;

The load balancers.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-additionaldetail.html#cfn-ec2-networkinsightsanalysis-additionaldetail-loadbalancers

property serviceName

readonly serviceName?: string;

The name of the VPC endpoint service.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-additionaldetail.html#cfn-ec2-networkinsightsanalysis-additionaldetail-servicename

interface AlternatePathHintProperty

interface AlternatePathHintProperty {}

Describes an potential intermediate component of a feasible path.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-alternatepathhint.html

property componentArn

readonly componentArn?: string;

The Amazon Resource Name (ARN) of the component.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-alternatepathhint.html#cfn-ec2-networkinsightsanalysis-alternatepathhint-componentarn

property componentId

readonly componentId?: string;

The ID of the component.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-alternatepathhint.html#cfn-ec2-networkinsightsanalysis-alternatepathhint-componentid

interface AnalysisAclRuleProperty

interface AnalysisAclRuleProperty {}

Describes a network access control (ACL) rule.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisaclrule.html

property cidr

readonly cidr?: string;

The IPv4 address range, in CIDR notation.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisaclrule.html#cfn-ec2-networkinsightsanalysis-analysisaclrule-cidr

property egress

readonly egress?: boolean | cdk.IResolvable;

Indicates whether the rule is an outbound rule.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisaclrule.html#cfn-ec2-networkinsightsanalysis-analysisaclrule-egress

property portRange

readonly portRange?:
    | CfnNetworkInsightsAnalysis.PortRangeProperty
    | cdk.IResolvable;

The range of ports.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisaclrule.html#cfn-ec2-networkinsightsanalysis-analysisaclrule-portrange

property protocol

readonly protocol?: string;

The protocol.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisaclrule.html#cfn-ec2-networkinsightsanalysis-analysisaclrule-protocol

property ruleAction

readonly ruleAction?: string;

Indicates whether to allow or deny traffic that matches the rule.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisaclrule.html#cfn-ec2-networkinsightsanalysis-analysisaclrule-ruleaction

property ruleNumber

readonly ruleNumber?: number;

The rule number.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisaclrule.html#cfn-ec2-networkinsightsanalysis-analysisaclrule-rulenumber

interface AnalysisComponentProperty

interface AnalysisComponentProperty {}

Describes a path component.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysiscomponent.html

property arn

readonly arn?: string;

The Amazon Resource Name (ARN) of the component.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysiscomponent.html#cfn-ec2-networkinsightsanalysis-analysiscomponent-arn

property id

readonly id?: string;

The ID of the component.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysiscomponent.html#cfn-ec2-networkinsightsanalysis-analysiscomponent-id

interface AnalysisLoadBalancerListenerProperty

interface AnalysisLoadBalancerListenerProperty {}

Describes a load balancer listener.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisloadbalancerlistener.html

property instancePort

readonly instancePort?: number;

[Classic Load Balancers] The back-end port for the listener.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisloadbalancerlistener.html#cfn-ec2-networkinsightsanalysis-analysisloadbalancerlistener-instanceport

property loadBalancerPort

readonly loadBalancerPort?: number;

The port on which the load balancer is listening.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisloadbalancerlistener.html#cfn-ec2-networkinsightsanalysis-analysisloadbalancerlistener-loadbalancerport

interface AnalysisLoadBalancerTargetProperty

interface AnalysisLoadBalancerTargetProperty {}

Describes a load balancer target.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisloadbalancertarget.html

property address

readonly address?: string;

The IP address.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisloadbalancertarget.html#cfn-ec2-networkinsightsanalysis-analysisloadbalancertarget-address

property availabilityZone

readonly availabilityZone?: string;

The Availability Zone.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisloadbalancertarget.html#cfn-ec2-networkinsightsanalysis-analysisloadbalancertarget-availabilityzone

property instance

readonly instance?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

Information about the instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisloadbalancertarget.html#cfn-ec2-networkinsightsanalysis-analysisloadbalancertarget-instance

property port

readonly port?: number;

The port on which the target is listening.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisloadbalancertarget.html#cfn-ec2-networkinsightsanalysis-analysisloadbalancertarget-port

interface AnalysisPacketHeaderProperty

interface AnalysisPacketHeaderProperty {}

Describes a header. Reflects any changes made by a component as traffic passes through. The fields of an inbound header are null except for the first component of a path.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysispacketheader.html

property destinationAddresses

readonly destinationAddresses?: string[];

The destination addresses.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysispacketheader.html#cfn-ec2-networkinsightsanalysis-analysispacketheader-destinationaddresses

property destinationPortRanges

readonly destinationPortRanges?:
    | Array<CfnNetworkInsightsAnalysis.PortRangeProperty | cdk.IResolvable>
    | cdk.IResolvable;

The destination port ranges.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysispacketheader.html#cfn-ec2-networkinsightsanalysis-analysispacketheader-destinationportranges

property protocol

readonly protocol?: string;

The protocol.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysispacketheader.html#cfn-ec2-networkinsightsanalysis-analysispacketheader-protocol

property sourceAddresses

readonly sourceAddresses?: string[];

The source addresses.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysispacketheader.html#cfn-ec2-networkinsightsanalysis-analysispacketheader-sourceaddresses

property sourcePortRanges

readonly sourcePortRanges?:
    | Array<CfnNetworkInsightsAnalysis.PortRangeProperty | cdk.IResolvable>
    | cdk.IResolvable;

The source port ranges.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysispacketheader.html#cfn-ec2-networkinsightsanalysis-analysispacketheader-sourceportranges

interface AnalysisRouteTableRouteProperty

interface AnalysisRouteTableRouteProperty {}

Describes a route table route.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html

property destinationCidr

readonly destinationCidr?: string;

The destination IPv4 address, in CIDR notation.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-destinationcidr

property destinationPrefixListId

readonly destinationPrefixListId?: string;

The prefix of the AWS service .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-destinationprefixlistid

property egressOnlyInternetGatewayId

readonly egressOnlyInternetGatewayId?: string;

The ID of an egress-only internet gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-egressonlyinternetgatewayid

property gatewayId

readonly gatewayId?: string;

The ID of the gateway, such as an internet gateway or virtual private gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-gatewayid

property instanceId

readonly instanceId?: string;

The ID of the instance, such as a NAT instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-instanceid

property natGatewayId

readonly natGatewayId?: string;

The ID of a NAT gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-natgatewayid

property networkInterfaceId

readonly networkInterfaceId?: string;

The ID of a network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-networkinterfaceid

property origin

readonly origin?: string;

Describes how the route was created. The following are the possible values:
- CreateRouteTable - The route was automatically created when the route table was created. - CreateRoute - The route was manually added to the route table. - EnableVgwRoutePropagation - The route was propagated by route propagation.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-origin

property state

readonly state?: string;

The state. The following are the possible values:
- active - blackhole
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-state

property transitGatewayId

readonly transitGatewayId?: string;

The ID of a transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-transitgatewayid

property vpcPeeringConnectionId

readonly vpcPeeringConnectionId?: string;

The ID of a VPC peering connection.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-vpcpeeringconnectionid

interface AnalysisSecurityGroupRuleProperty

interface AnalysisSecurityGroupRuleProperty {}

Describes a security group rule.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysissecuritygrouprule.html

property cidr

readonly cidr?: string;

The IPv4 address range, in CIDR notation.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysissecuritygrouprule.html#cfn-ec2-networkinsightsanalysis-analysissecuritygrouprule-cidr

property direction

readonly direction?: string;

The direction. The following are the possible values:
- egress - ingress
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysissecuritygrouprule.html#cfn-ec2-networkinsightsanalysis-analysissecuritygrouprule-direction

property portRange

readonly portRange?:
    | CfnNetworkInsightsAnalysis.PortRangeProperty
    | cdk.IResolvable;

The port range.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysissecuritygrouprule.html#cfn-ec2-networkinsightsanalysis-analysissecuritygrouprule-portrange

property prefixListId

readonly prefixListId?: string;

The prefix list ID.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysissecuritygrouprule.html#cfn-ec2-networkinsightsanalysis-analysissecuritygrouprule-prefixlistid

property protocol

readonly protocol?: string;

The protocol name.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysissecuritygrouprule.html#cfn-ec2-networkinsightsanalysis-analysissecuritygrouprule-protocol

property securityGroupId

readonly securityGroupId?: string;

The security group ID.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysissecuritygrouprule.html#cfn-ec2-networkinsightsanalysis-analysissecuritygrouprule-securitygroupid

interface ExplanationProperty

interface ExplanationProperty {}

Describes an explanation code for an unreachable path. For more information, see [Reachability Analyzer explanation codes](https://docs.aws.amazon.com/vpc/latest/reachability/explanation-codes.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html

property acl

readonly acl?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The network ACL.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-acl

property aclRule

readonly aclRule?:
    | CfnNetworkInsightsAnalysis.AnalysisAclRuleProperty
    | cdk.IResolvable;

The network ACL rule.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-aclrule

property address

readonly address?: string;

The IPv4 address, in CIDR notation.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-address

property addresses

readonly addresses?: string[];

The IPv4 addresses, in CIDR notation.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-addresses

property attachedTo

readonly attachedTo?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The resource to which the component is attached.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-attachedto

property availabilityZones

readonly availabilityZones?: string[];

The Availability Zones.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-availabilityzones

property cidrs

readonly cidrs?: string[];

The CIDR ranges.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-cidrs

property classicLoadBalancerListener

readonly classicLoadBalancerListener?:
    | CfnNetworkInsightsAnalysis.AnalysisLoadBalancerListenerProperty
    | cdk.IResolvable;

The listener for a Classic Load Balancer.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-classicloadbalancerlistener

property component

readonly component?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The component.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-component

property componentAccount

readonly componentAccount?: string;

The AWS account for the component.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-componentaccount

property componentRegion

readonly componentRegion?: string;

The Region for the component.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-componentregion

property customerGateway

readonly customerGateway?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The customer gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-customergateway

property destination

readonly destination?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The destination.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-destination

property destinationVpc

readonly destinationVpc?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The destination VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-destinationvpc

property direction

readonly direction?: string;

The direction. The following are the possible values:
- egress - ingress
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-direction

property elasticLoadBalancerListener

readonly elasticLoadBalancerListener?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The load balancer listener.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-elasticloadbalancerlistener

property explanationCode

readonly explanationCode?: string;

The explanation code.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-explanationcode

property ingressRouteTable

readonly ingressRouteTable?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-ingressroutetable

property internetGateway

readonly internetGateway?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The internet gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-internetgateway

property loadBalancerArn

readonly loadBalancerArn?: string;

The Amazon Resource Name (ARN) of the load balancer.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-loadbalancerarn

property loadBalancerListenerPort

readonly loadBalancerListenerPort?: number;

The listener port of the load balancer.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-loadbalancerlistenerport

property loadBalancerTarget

readonly loadBalancerTarget?:
    | CfnNetworkInsightsAnalysis.AnalysisLoadBalancerTargetProperty
    | cdk.IResolvable;

The target.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-loadbalancertarget

property loadBalancerTargetGroup

readonly loadBalancerTargetGroup?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The target group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-loadbalancertargetgroup

property loadBalancerTargetGroups

readonly loadBalancerTargetGroups?:
    | Array<
          CfnNetworkInsightsAnalysis.AnalysisComponentProperty | cdk.IResolvable
      >
    | cdk.IResolvable;

The target groups.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-loadbalancertargetgroups

property loadBalancerTargetPort

readonly loadBalancerTargetPort?: number;

The target port.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-loadbalancertargetport

property missingComponent

readonly missingComponent?: string;

The missing component.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-missingcomponent

property natGateway

readonly natGateway?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The NAT gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-natgateway

property networkInterface

readonly networkInterface?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-networkinterface

property packetField

readonly packetField?: string;

The packet field.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-packetfield

property port

readonly port?: number;

The port.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-port

property portRanges

readonly portRanges?:
    | Array<CfnNetworkInsightsAnalysis.PortRangeProperty | cdk.IResolvable>
    | cdk.IResolvable;

The port ranges.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-portranges

property prefixList

readonly prefixList?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The prefix list.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-prefixlist

property protocols

readonly protocols?: string[];

The protocols.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-protocols

property routeTable

readonly routeTable?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-routetable

property routeTableRoute

readonly routeTableRoute?:
    | CfnNetworkInsightsAnalysis.AnalysisRouteTableRouteProperty
    | cdk.IResolvable;

The route table route.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-routetableroute

property securityGroup

readonly securityGroup?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The security group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-securitygroup

property securityGroupRule

readonly securityGroupRule?:
    | CfnNetworkInsightsAnalysis.AnalysisSecurityGroupRuleProperty
    | cdk.IResolvable;

The security group rule.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-securitygrouprule

property securityGroups

readonly securityGroups?:
    | Array<
          CfnNetworkInsightsAnalysis.AnalysisComponentProperty | cdk.IResolvable
      >
    | cdk.IResolvable;

The security groups.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-securitygroups

property sourceVpc

readonly sourceVpc?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The source VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-sourcevpc

property state

readonly state?: string;

The state.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-state

property subnet

readonly subnet?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The subnet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-subnet

property subnetRouteTable

readonly subnetRouteTable?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The route table for the subnet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-subnetroutetable

property transitGateway

readonly transitGateway?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-transitgateway

property transitGatewayAttachment

readonly transitGatewayAttachment?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The transit gateway attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-transitgatewayattachment

property transitGatewayRouteTable

readonly transitGatewayRouteTable?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The transit gateway route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-transitgatewayroutetable

property transitGatewayRouteTableRoute

readonly transitGatewayRouteTableRoute?:
    | CfnNetworkInsightsAnalysis.TransitGatewayRouteTableRouteProperty
    | cdk.IResolvable;

The transit gateway route table route.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-transitgatewayroutetableroute

property vpc

readonly vpc?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The component VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-vpc

property vpcEndpoint

readonly vpcEndpoint?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The VPC endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-vpcendpoint

property vpcPeeringConnection

readonly vpcPeeringConnection?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The VPC peering connection.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-vpcpeeringconnection

property vpnConnection

readonly vpnConnection?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The VPN connection.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-vpnconnection

property vpnGateway

readonly vpnGateway?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The VPN gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-vpngateway

interface PathComponentProperty

interface PathComponentProperty {}

Describes a path component.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html

property aclRule

readonly aclRule?:
    | CfnNetworkInsightsAnalysis.AnalysisAclRuleProperty
    | cdk.IResolvable;

The network ACL rule.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-aclrule

property additionalDetails

readonly additionalDetails?:
    | Array<
          CfnNetworkInsightsAnalysis.AdditionalDetailProperty | cdk.IResolvable
      >
    | cdk.IResolvable;

The additional details.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-additionaldetails

property component

readonly component?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The component.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-component

property destinationVpc

readonly destinationVpc?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The destination VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-destinationvpc

property elasticLoadBalancerListener

readonly elasticLoadBalancerListener?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The load balancer listener.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-elasticloadbalancerlistener

property explanations

readonly explanations?:
    | Array<CfnNetworkInsightsAnalysis.ExplanationProperty | cdk.IResolvable>
    | cdk.IResolvable;

The explanation codes.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-explanations

property inboundHeader

readonly inboundHeader?:
    | CfnNetworkInsightsAnalysis.AnalysisPacketHeaderProperty
    | cdk.IResolvable;

The inbound header.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-inboundheader

property outboundHeader

readonly outboundHeader?:
    | CfnNetworkInsightsAnalysis.AnalysisPacketHeaderProperty
    | cdk.IResolvable;

The outbound header.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-outboundheader

property routeTableRoute

readonly routeTableRoute?:
    | CfnNetworkInsightsAnalysis.AnalysisRouteTableRouteProperty
    | cdk.IResolvable;

The route table route.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-routetableroute

property securityGroupRule

readonly securityGroupRule?:
    | CfnNetworkInsightsAnalysis.AnalysisSecurityGroupRuleProperty
    | cdk.IResolvable;

The security group rule.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-securitygrouprule

property sequenceNumber

readonly sequenceNumber?: number;

The sequence number.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-sequencenumber

property serviceName

readonly serviceName?: string;

The name of the VPC endpoint service.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-servicename

property sourceVpc

readonly sourceVpc?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The source VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-sourcevpc

property subnet

readonly subnet?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The subnet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-subnet

property transitGateway

readonly transitGateway?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The transit gateway.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-transitgateway

property transitGatewayRouteTableRoute

readonly transitGatewayRouteTableRoute?:
    | CfnNetworkInsightsAnalysis.TransitGatewayRouteTableRouteProperty
    | cdk.IResolvable;

The route in a transit gateway route table.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-transitgatewayroutetableroute

property vpc

readonly vpc?:
    | CfnNetworkInsightsAnalysis.AnalysisComponentProperty
    | cdk.IResolvable;

The component VPC.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-vpc

interface PortRangeProperty

interface PortRangeProperty {}

Describes a range of ports.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-portrange.html

property from

readonly from?: number;

The first port in the range.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-portrange.html#cfn-ec2-networkinsightsanalysis-portrange-from

property to

readonly to?: number;

The last port in the range.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-portrange.html#cfn-ec2-networkinsightsanalysis-portrange-to

interface TransitGatewayRouteTableRouteProperty

interface TransitGatewayRouteTableRouteProperty {}

Describes a route in a transit gateway route table.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html

property attachmentId

readonly attachmentId?: string;

The ID of the route attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html#cfn-ec2-networkinsightsanalysis-transitgatewayroutetableroute-attachmentid

property destinationCidr

readonly destinationCidr?: string;

The CIDR block used for destination matches.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html#cfn-ec2-networkinsightsanalysis-transitgatewayroutetableroute-destinationcidr

property prefixListId

readonly prefixListId?: string;

The ID of the prefix list.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html#cfn-ec2-networkinsightsanalysis-transitgatewayroutetableroute-prefixlistid

property resourceId

readonly resourceId?: string;

The ID of the resource for the route attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html#cfn-ec2-networkinsightsanalysis-transitgatewayroutetableroute-resourceid

property resourceType

readonly resourceType?: string;

The resource type for the route attachment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html#cfn-ec2-networkinsightsanalysis-transitgatewayroutetableroute-resourcetype

property routeOrigin

readonly routeOrigin?: string;

The route origin. The following are the possible values:
- static - propagated
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html#cfn-ec2-networkinsightsanalysis-transitgatewayroutetableroute-routeorigin

property state

readonly state?: string;

The state of the route.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html#cfn-ec2-networkinsightsanalysis-transitgatewayroutetableroute-state

namespace CfnNetworkInsightsPath

namespace CfnNetworkInsightsPath {}

interface FilterPortRangeProperty

interface FilterPortRangeProperty {}

Describes a port range.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightspath-filterportrange.html

property fromPort

readonly fromPort?: number;

The first port in the range.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightspath-filterportrange.html#cfn-ec2-networkinsightspath-filterportrange-fromport

property toPort

readonly toPort?: number;

The last port in the range.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightspath-filterportrange.html#cfn-ec2-networkinsightspath-filterportrange-toport

interface PathFilterProperty

interface PathFilterProperty {}

Describes a set of filters for a path analysis. Use path filters to scope the analysis when there can be multiple resulting paths.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightspath-pathfilter.html

property destinationAddress

readonly destinationAddress?: string;

The destination IPv4 address.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightspath-pathfilter.html#cfn-ec2-networkinsightspath-pathfilter-destinationaddress

property destinationPortRange

readonly destinationPortRange?:
    | CfnNetworkInsightsPath.FilterPortRangeProperty
    | cdk.IResolvable;

The destination port range.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightspath-pathfilter.html#cfn-ec2-networkinsightspath-pathfilter-destinationportrange

property sourceAddress

readonly sourceAddress?: string;

The source IPv4 address.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightspath-pathfilter.html#cfn-ec2-networkinsightspath-pathfilter-sourceaddress

property sourcePortRange

readonly sourcePortRange?:
    | CfnNetworkInsightsPath.FilterPortRangeProperty
    | cdk.IResolvable;

The source port range.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightspath-pathfilter.html#cfn-ec2-networkinsightspath-pathfilter-sourceportrange

namespace CfnNetworkInterface

namespace CfnNetworkInterface {}

interface InstanceIpv6AddressProperty

interface InstanceIpv6AddressProperty {}

Describes the IPv6 addresses to associate with the network interface.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-instanceipv6address.html

property ipv6Address

readonly ipv6Address: string;

An IPv6 address to associate with the network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-instanceipv6address.html#cfn-ec2-networkinterface-instanceipv6address-ipv6address

interface PrivateIpAddressSpecificationProperty

interface PrivateIpAddressSpecificationProperty {}

Describes a secondary private IPv4 address for a network interface.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-privateipaddressspecification.html

property primary

readonly primary: boolean | cdk.IResolvable;

Sets the private IP address as the primary private address. You can set only one primary private IP address. If you don't specify a primary private IP address, Amazon EC2 automatically assigns a primary private IP address.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-privateipaddressspecification.html#cfn-ec2-networkinterface-privateipaddressspecification-primary

property privateIpAddress

readonly privateIpAddress: string;

The private IP address of the network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-privateipaddressspecification.html#cfn-ec2-networkinterface-privateipaddressspecification-privateipaddress

namespace CfnPrefixList

namespace CfnPrefixList {}

interface EntryProperty

interface EntryProperty {}

An entry for a prefix list.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-prefixlist-entry.html

property cidr

readonly cidr: string;

The CIDR block.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-prefixlist-entry.html#cfn-ec2-prefixlist-entry-cidr

property description

readonly description?: string;

A description for the entry.
Constraints: Up to 255 characters in length.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-prefixlist-entry.html#cfn-ec2-prefixlist-entry-description

namespace CfnSecurityGroup

namespace CfnSecurityGroup {}

interface EgressProperty

interface EgressProperty {}

Adds the specified egress rules to a security group for use with a VPC.
An outbound rule permits instances to send traffic to the specified destination IPv4 or IPv6 CIDR address ranges, or to the specified destination security groups for the same VPC.
You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.
You must specify only one of the following properties: CidrIp , CidrIpv6 , DestinationPrefixListId , or DestinationSecurityGroupId .
You must specify a destination security group ( DestinationPrefixListId or DestinationSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ). If you do not specify one of these parameters, the stack will launch successfully but the rule will not be added to the security group.
Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.
For more information about VPC security group limits, see [Amazon VPC Limits](https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html) .
Use SecurityGroup.Ingress and SecurityGroup.Egress only when necessary, typically to allow security groups to reference each other in ingress and egress rules. Otherwise, use the embedded ingress and egress rules of the security group. For more information, see [Amazon EC2 Security Groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html) .
The EC2 Security Group Rule is an embedded property of the AWS::EC2::SecurityGroup type.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html

property cidrIp

readonly cidrIp?: string;

The IPv4 address range, in CIDR format.
You must specify a destination security group ( DestinationPrefixListId or DestinationSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ).
For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-cidrip

property cidrIpv6

readonly cidrIpv6?: string;

The IPv6 address range, in CIDR format.
You must specify a destination security group ( DestinationPrefixListId or DestinationSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ).
For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-cidripv6

property description

readonly description?: string;

A description for the security group rule.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-description

property destinationPrefixListId

readonly destinationPrefixListId?: string;

The prefix list IDs for the destination AWS service. This is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.
You must specify a destination security group ( DestinationPrefixListId or DestinationSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-destinationprefixlistid

property destinationSecurityGroupId

readonly destinationSecurityGroupId?: string;

The ID of the destination VPC security group.
You must specify a destination security group ( DestinationPrefixListId or DestinationSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-destsecgroupid

property fromPort

readonly fromPort?: number;

If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-fromport

property ipProtocol

readonly ipProtocol: string;

The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) ).
Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-ipprotocol

property toPort

readonly toPort?: number;

If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-toport

interface IngressProperty

interface IngressProperty {}

Adds an inbound rule to a security group.
An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address range, or from the instances associated with the specified security group.
You must specify only one of the following properties: CidrIp , CidrIpv6 , SourcePrefixListId , SourceSecurityGroupId , or SourceSecurityGroupName .
You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify a port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.
You must specify a source security group ( SourcePrefixListId , SourceSecurityGroupId , or SourceSecurityGroupName ) or a CIDR range ( CidrIp or CidrIpv6 ). If you do not specify one of these parameters, the stack will launch successfully but the rule will not be added to the security group.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
The EC2 Security Group Rule is an embedded property of the AWS::EC2::SecurityGroup type.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html

property cidrIp

readonly cidrIp?: string;

The IPv4 address range, in CIDR format.
You must specify a source security group ( SourcePrefixListId or SourceSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ).
For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-cidrip

property cidrIpv6

readonly cidrIpv6?: string;

The IPv6 address range, in CIDR format.
You must specify a source security group ( SourcePrefixListId or SourceSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ).
For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-cidripv6

property description

readonly description?: string;

Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-description

property fromPort

readonly fromPort?: number;

If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-fromport

property ipProtocol

readonly ipProtocol: string;

The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) ).
Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-ipprotocol

property sourcePrefixListId

readonly sourcePrefixListId?: string;

The ID of a prefix list.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-securitygroup-ingress-sourceprefixlistid

property sourceSecurityGroupId

readonly sourceSecurityGroupId?: string;

The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-sourcesecuritygroupid

property sourceSecurityGroupName

readonly sourceSecurityGroupName?: string;

[Default VPC] The name of the source security group. You must specify either the security group ID or the security group name. You can't specify the group name in combination with an IP address range. Creates rules that grant full ICMP, UDP, and TCP access.
For security groups in a nondefault VPC, you must specify the group ID.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-sourcesecuritygroupname

property sourceSecurityGroupOwnerId

readonly sourceSecurityGroupOwnerId?: string;

[nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account. You can't specify this property with an IP address range. Creates rules that grant full ICMP, UDP, and TCP access.
If you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId ; otherwise, this property is optional.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-sourcesecuritygroupownerid

property toPort

readonly toPort?: number;

If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-toport

namespace CfnSpotFleet

namespace CfnSpotFleet {}

interface AcceleratorCountRequestProperty

interface AcceleratorCountRequestProperty {}

The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set Max to 0 .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-acceleratorcountrequest.html

property max

readonly max?: number;

The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set Max to 0 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-acceleratorcountrequest.html#cfn-ec2-spotfleet-acceleratorcountrequest-max

property min

readonly min?: number;

The minimum number of accelerators. To specify no minimum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-acceleratorcountrequest.html#cfn-ec2-spotfleet-acceleratorcountrequest-min

interface AcceleratorTotalMemoryMiBRequestProperty

interface AcceleratorTotalMemoryMiBRequestProperty {}

The minimum and maximum amount of total accelerator memory, in MiB.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-acceleratortotalmemorymibrequest.html

property max

readonly max?: number;

The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-acceleratortotalmemorymibrequest.html#cfn-ec2-spotfleet-acceleratortotalmemorymibrequest-max

property min

readonly min?: number;

The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-acceleratortotalmemorymibrequest.html#cfn-ec2-spotfleet-acceleratortotalmemorymibrequest-min

interface BaselineEbsBandwidthMbpsRequestProperty

interface BaselineEbsBandwidthMbpsRequestProperty {}

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide* .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-baselineebsbandwidthmbpsrequest.html

property max

readonly max?: number;

The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-baselineebsbandwidthmbpsrequest.html#cfn-ec2-spotfleet-baselineebsbandwidthmbpsrequest-max

property min

readonly min?: number;

The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-baselineebsbandwidthmbpsrequest.html#cfn-ec2-spotfleet-baselineebsbandwidthmbpsrequest-min

interface BlockDeviceMappingProperty

interface BlockDeviceMappingProperty {}

Specifies a block device mapping.
You can specify Ebs or VirtualName , but not both.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-blockdevicemapping.html

property deviceName

readonly deviceName: string;

The device name (for example, /dev/sdh or xvdh ).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-blockdevicemapping.html#cfn-ec2-spotfleet-blockdevicemapping-devicename

property ebs

readonly ebs?: CfnSpotFleet.EbsBlockDeviceProperty | cdk.IResolvable;

Parameters used to automatically set up EBS volumes when the instance is launched.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-blockdevicemapping.html#cfn-ec2-spotfleet-blockdevicemapping-ebs

property noDevice

readonly noDevice?: string;

To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-blockdevicemapping.html#cfn-ec2-spotfleet-blockdevicemapping-nodevice

property virtualName

readonly virtualName?: string;

The virtual device name ( ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-blockdevicemapping.html#cfn-ec2-spotfleet-blockdevicemapping-virtualname

interface ClassicLoadBalancerProperty

interface ClassicLoadBalancerProperty {}

Specifies a Classic Load Balancer.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-classicloadbalancer.html

property name

readonly name: string;

The name of the load balancer.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-classicloadbalancer.html#cfn-ec2-spotfleet-classicloadbalancer-name

interface ClassicLoadBalancersConfigProperty

interface ClassicLoadBalancersConfigProperty {}

Specifies the Classic Load Balancers to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these Classic Load Balancers.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-classicloadbalancersconfig.html

property classicLoadBalancers

readonly classicLoadBalancers:
    | Array<CfnSpotFleet.ClassicLoadBalancerProperty | cdk.IResolvable>
    | cdk.IResolvable;

One or more Classic Load Balancers.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-classicloadbalancersconfig.html#cfn-ec2-spotfleet-classicloadbalancersconfig-classicloadbalancers

interface EbsBlockDeviceProperty

interface EbsBlockDeviceProperty {}

Describes a block device for an EBS volume.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html

property deleteOnTermination

readonly deleteOnTermination?: boolean | cdk.IResolvable;

Indicates whether the EBS volume is deleted on instance termination. For more information, see [Preserving Amazon EBS volumes on instance termination](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination) in the *Amazon EC2 User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html#cfn-ec2-spotfleet-ebsblockdevice-deleteontermination

property encrypted

readonly encrypted?: boolean | cdk.IResolvable;

Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Amazon EBS Encryption](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-parameters) in the *Amazon EC2 User Guide* .
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see [Supported Instance Types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances) .
This parameter is not returned by [DescribeImageAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImageAttribute.html) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html#cfn-ec2-spotfleet-ebsblockdevice-encrypted

property iops

readonly iops?: number;

The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
- gp3 : 3,000-16,000 IOPS - io1 : 100-64,000 IOPS - io2 : 100-64,000 IOPS
For io1 and io2 volumes, we guarantee 64,000 IOPS only for [Instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html#cfn-ec2-spotfleet-ebsblockdevice-iops

property snapshotId

readonly snapshotId?: string;

The ID of the snapshot.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html#cfn-ec2-spotfleet-ebsblockdevice-snapshotid

property volumeSize

readonly volumeSize?: number;

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
- gp2 and gp3 :1-16,384 - io1 and io2 : 4-16,384 - st1 and sc1 : 125-16,384 - standard : 1-1,024
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html#cfn-ec2-spotfleet-ebsblockdevice-volumesize

property volumeType

readonly volumeType?: string;

The volume type. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon EC2 User Guide* . If the volume type is io1 or io2 , you must specify the IOPS that the volume supports.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html#cfn-ec2-spotfleet-ebsblockdevice-volumetype

interface FleetLaunchTemplateSpecificationProperty

interface FleetLaunchTemplateSpecificationProperty {}

Specifies the launch template to be used by the Spot Fleet request for configuring Amazon EC2 instances.
You must specify the following:
- The ID or the name of the launch template, but not both. - The version of the launch template.
FleetLaunchTemplateSpecification is a property of the [AWS::EC2::SpotFleet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-spotfleet.html) resource.
For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template) in the *Amazon EC2 User Guide* .
For examples of launch templates, see [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-fleetlaunchtemplatespecification.html

property launchTemplateId

readonly launchTemplateId?: string;

The ID of the launch template.
You must specify the LaunchTemplateId or the LaunchTemplateName , but not both.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-fleetlaunchtemplatespecification.html#cfn-ec2-spotfleet-fleetlaunchtemplatespecification-launchtemplateid

property launchTemplateName

readonly launchTemplateName?: string;

The name of the launch template.
You must specify the LaunchTemplateName or the LaunchTemplateId , but not both.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-fleetlaunchtemplatespecification.html#cfn-ec2-spotfleet-fleetlaunchtemplatespecification-launchtemplatename

property version

readonly version: string;

The version number of the launch template.
Specifying $Latest or $Default for the template version number is not supported. However, you can specify LatestVersionNumber or DefaultVersionNumber using the Fn::GetAtt intrinsic function. For more information, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate-return-values-fn--getatt) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-fleetlaunchtemplatespecification.html#cfn-ec2-spotfleet-fleetlaunchtemplatespecification-version

interface GroupIdentifierProperty

interface GroupIdentifierProperty {}

Describes a security group.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-groupidentifier.html

property groupId

readonly groupId: string;

The ID of the security group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-groupidentifier.html#cfn-ec2-spotfleet-groupidentifier-groupid

interface IamInstanceProfileSpecificationProperty

interface IamInstanceProfileSpecificationProperty {}

Describes an IAM instance profile.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-iaminstanceprofilespecification.html

property arn

readonly arn?: string;

The Amazon Resource Name (ARN) of the instance profile.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-iaminstanceprofilespecification.html#cfn-ec2-spotfleet-iaminstanceprofilespecification-arn

interface InstanceIpv6AddressProperty

interface InstanceIpv6AddressProperty {}

Describes an IPv6 address.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instanceipv6address.html

property ipv6Address

readonly ipv6Address: string;

The IPv6 address.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instanceipv6address.html#cfn-ec2-spotfleet-instanceipv6address-ipv6address

interface InstanceNetworkInterfaceSpecificationProperty

interface InstanceNetworkInterfaceSpecificationProperty {}

Describes a network interface.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html

property associatePublicIpAddress

readonly associatePublicIpAddress?: boolean | cdk.IResolvable;

Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-associatepublicipaddress

property deleteOnTermination

readonly deleteOnTermination?: boolean | cdk.IResolvable;

Indicates whether the network interface is deleted when the instance is terminated.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-deleteontermination

property description

readonly description?: string;

The description of the network interface. Applies only if creating a network interface when launching an instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-description

property deviceIndex

readonly deviceIndex?: number;

The position of the network interface in the attachment order. A primary network interface has a device index of 0.
If you specify a network interface when launching an instance, you must specify the device index.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-deviceindex

property groups

readonly groups?: string[];

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-groups

property ipv6AddressCount

readonly ipv6AddressCount?: number;

A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-ipv6addresscount

property ipv6Addresses

readonly ipv6Addresses?:
    | Array<CfnSpotFleet.InstanceIpv6AddressProperty | cdk.IResolvable>
    | cdk.IResolvable;

The IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-ipv6addresses

property networkInterfaceId

readonly networkInterfaceId?: string;

The ID of the network interface.
If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-networkinterfaceid

property privateIpAddresses

readonly privateIpAddresses?:
    | Array<CfnSpotFleet.PrivateIpAddressSpecificationProperty | cdk.IResolvable>
    | cdk.IResolvable;

The private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-privateipaddresses

property secondaryPrivateIpAddressCount

readonly secondaryPrivateIpAddressCount?: number;

The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-secondaryprivateipaddresscount

property subnetId

readonly subnetId?: string;

The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-subnetid

interface InstanceRequirementsRequestProperty

interface InstanceRequirementsRequestProperty {}

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
- AllowedInstanceTypes - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes. - ExcludedInstanceTypes - The instance types to exclude from the list, even if they match your specified attributes.
> You must specify VCpuCount and MemoryMiB . All other attributes are optional. Any unspecified optional attribute is set to its default.
For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) , [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html) , and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide* .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html

property acceleratorCount

readonly acceleratorCount?:
    | CfnSpotFleet.AcceleratorCountRequestProperty
    | cdk.IResolvable;

The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.
To exclude accelerator-enabled instance types, set Max to 0 .
Default: No minimum or maximum limits
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-acceleratorcount

property acceleratorManufacturers

readonly acceleratorManufacturers?: string[];

Indicates whether instance types must have accelerators by specific manufacturers.
- For instance types with NVIDIA devices, specify nvidia . - For instance types with AMD devices, specify amd . - For instance types with AWS devices, specify amazon-web-services . - For instance types with Xilinx devices, specify xilinx .
Default: Any manufacturer
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-acceleratormanufacturers

property acceleratorNames

readonly acceleratorNames?: string[];

The accelerators that must be on the instance type.
- For instance types with NVIDIA A100 GPUs, specify a100 . - For instance types with NVIDIA V100 GPUs, specify v100 . - For instance types with NVIDIA K80 GPUs, specify k80 . - For instance types with NVIDIA T4 GPUs, specify t4 . - For instance types with NVIDIA M60 GPUs, specify m60 . - For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520 . - For instance types with Xilinx VU9P FPGAs, specify vu9p . - For instance types with AWS Inferentia chips, specify inferentia . - For instance types with NVIDIA GRID K520 GPUs, specify k520 .
Default: Any accelerator
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-acceleratornames

property acceleratorTotalMemoryMiB

readonly acceleratorTotalMemoryMiB?:
    | CfnSpotFleet.AcceleratorTotalMemoryMiBRequestProperty
    | cdk.IResolvable;

The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limits
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-acceleratortotalmemorymib

property acceleratorTypes

readonly acceleratorTypes?: string[];

The accelerator types that must be on the instance type.
- To include instance types with GPU hardware, specify gpu . - To include instance types with FPGA hardware, specify fpga . - To include instance types with inference hardware, specify inference .
Default: Any accelerator type
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-acceleratortypes

property allowedInstanceTypes

readonly allowedInstanceTypes?: string[];

The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.
You can use strings with one or more wild cards, represented by an asterisk ( * ), to allow an instance type, size, or generation. The following are examples: m5.8xlarge , c5*.* , m5a.* , r* , *3* .
For example, if you specify c5* ,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.* , Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.
> If you specify AllowedInstanceTypes , you can't specify ExcludedInstanceTypes .
Default: All instance types
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-allowedinstancetypes

property bareMetal

readonly bareMetal?: string;

Indicates whether bare metal instance types must be included, excluded, or required.
- To include bare metal instance types, specify included . - To require only bare metal instance types, specify required . - To exclude bare metal instance types, specify excluded .
Default: excluded
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-baremetal

property baselineEbsBandwidthMbps

readonly baselineEbsBandwidthMbps?:
    | CfnSpotFleet.BaselineEbsBandwidthMbpsRequestProperty
    | cdk.IResolvable;

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide* .
Default: No minimum or maximum limits
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-baselineebsbandwidthmbps

property burstablePerformance

readonly burstablePerformance?: string;

Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) .
- To include burstable performance instance types, specify included . - To require only burstable performance instance types, specify required . - To exclude burstable performance instance types, specify excluded .
Default: excluded
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-burstableperformance

property cpuManufacturers

readonly cpuManufacturers?: string[];

The CPU manufacturers to include.
- For instance types with Intel CPUs, specify intel . - For instance types with AMD CPUs, specify amd . - For instance types with AWS CPUs, specify amazon-web-services .
> Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-cpumanufacturers

property excludedInstanceTypes

readonly excludedInstanceTypes?: string[];

The instance types to exclude.
You can use strings with one or more wild cards, represented by an asterisk ( * ), to exclude an instance family, type, size, or generation. The following are examples: m5.8xlarge , c5*.* , m5a.* , r* , *3* .
For example, if you specify c5* ,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.* , Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.
> If you specify ExcludedInstanceTypes , you can't specify AllowedInstanceTypes .
Default: No excluded instance types
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-excludedinstancetypes

property instanceGenerations

readonly instanceGenerations?: string[];

Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide* .
For current generation instance types, specify current .
For previous generation instance types, specify previous .
Default: Current and previous generation instance types
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-instancegenerations

property localStorage

readonly localStorage?: string;

Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide* .
- To include instance types with instance store volumes, specify included . - To require only instance types with instance store volumes, specify required . - To exclude instance types with instance store volumes, specify excluded .
Default: included
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-localstorage

property localStorageTypes

readonly localStorageTypes?: string[];

The type of local storage that is required.
- For instance types with hard disk drive (HDD) storage, specify hdd . - For instance types with solid state drive (SSD) storage, specify ssd .
Default: hdd and ssd
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-localstoragetypes

property memoryGiBPerVCpu

readonly memoryGiBPerVCpu?:
    | CfnSpotFleet.MemoryGiBPerVCpuRequestProperty
    | cdk.IResolvable;

The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limits
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-memorygibpervcpu

property memoryMiB

readonly memoryMiB?: CfnSpotFleet.MemoryMiBRequestProperty | cdk.IResolvable;

The minimum and maximum amount of memory, in MiB.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-memorymib

property networkBandwidthGbps

readonly networkBandwidthGbps?:
    | CfnSpotFleet.NetworkBandwidthGbpsRequestProperty
    | cdk.IResolvable;

The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Default: No minimum or maximum limits
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-networkbandwidthgbps

property networkInterfaceCount

readonly networkInterfaceCount?:
    | CfnSpotFleet.NetworkInterfaceCountRequestProperty
    | cdk.IResolvable;

The minimum and maximum number of network interfaces.
Default: No minimum or maximum limits
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-networkinterfacecount

property onDemandMaxPricePercentageOverLowestPrice

readonly onDemandMaxPricePercentageOverLowestPrice?: number;

The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as 999999 .
This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html) .
> If you set TargetCapacityUnitType to vcpu or memory-mib , the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: 20
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-ondemandmaxpricepercentageoverlowestprice

property requireHibernateSupport

readonly requireHibernateSupport?: boolean | cdk.IResolvable;

Indicates whether instance types must support hibernation for On-Demand Instances.
This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) .
Default: false
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-requirehibernatesupport

property spotMaxPricePercentageOverLowestPrice

readonly spotMaxPricePercentageOverLowestPrice?: number;

The price protection threshold for Spot Instance. This is the maximum you’ll pay for an Spot Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as 999999 .
This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html) .
> If you set TargetCapacityUnitType to vcpu or memory-mib , the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: 100
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-spotmaxpricepercentageoverlowestprice

property totalLocalStorageGb

readonly totalLocalStorageGb?:
    | CfnSpotFleet.TotalLocalStorageGBRequestProperty
    | cdk.IResolvable;

The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limits
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-totallocalstoragegb

property vCpuCount

readonly vCpuCount?:
    | CfnSpotFleet.VCpuCountRangeRequestProperty
    | cdk.IResolvable;

The minimum and maximum number of vCPUs.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-vcpucount

interface LaunchTemplateConfigProperty

interface LaunchTemplateConfigProperty {}

Specifies a launch template and overrides.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateconfig.html

property launchTemplateSpecification

readonly launchTemplateSpecification?:
    | CfnSpotFleet.FleetLaunchTemplateSpecificationProperty
    | cdk.IResolvable;

The launch template to use. Make sure that the launch template does not contain the NetworkInterfaceId parameter because you can't specify a network interface ID in a Spot Fleet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateconfig.html#cfn-ec2-spotfleet-launchtemplateconfig-launchtemplatespecification

property overrides

readonly overrides?:
    | Array<CfnSpotFleet.LaunchTemplateOverridesProperty | cdk.IResolvable>
    | cdk.IResolvable;

Any parameters that you specify override the same parameters in the launch template.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateconfig.html#cfn-ec2-spotfleet-launchtemplateconfig-overrides

interface LaunchTemplateOverridesProperty

interface LaunchTemplateOverridesProperty {}

Specifies overrides for a launch template.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html

property availabilityZone

readonly availabilityZone?: string;

The Availability Zone in which to launch the instances.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-availabilityzone

property instanceRequirements

readonly instanceRequirements?:
    | CfnSpotFleet.InstanceRequirementsRequestProperty
    | cdk.IResolvable;

The instance requirements. When you specify instance requirements, Amazon EC2 will identify instance types with the provided requirements, and then use your On-Demand and Spot allocation strategies to launch instances from these instance types, in the same way as when you specify a list of instance types.
> If you specify InstanceRequirements , you can't specify InstanceType .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-instancerequirements

property instanceType

readonly instanceType?: string;

The instance type.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-instancetype

property priority

readonly priority?: number;

The priority for the launch template override. The highest priority is launched first.
If OnDemandAllocationStrategy is set to prioritized , Spot Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacityOptimizedPrioritized , Spot Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-priority

property spotPrice

readonly spotPrice?: string;

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
> If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-spotprice

property subnetId

readonly subnetId?: string;

The ID of the subnet in which to launch the instances.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-subnetid

property weightedCapacity

readonly weightedCapacity?: number;

The number of units provided by the specified instance type.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-weightedcapacity

interface LoadBalancersConfigProperty

interface LoadBalancersConfigProperty {}

Specifies the Classic Load Balancers and target groups to attach to a Spot Fleet request.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-loadbalancersconfig.html

property classicLoadBalancersConfig

readonly classicLoadBalancersConfig?:
    | CfnSpotFleet.ClassicLoadBalancersConfigProperty
    | cdk.IResolvable;

The Classic Load Balancers.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-loadbalancersconfig.html#cfn-ec2-spotfleet-loadbalancersconfig-classicloadbalancersconfig

property targetGroupsConfig

readonly targetGroupsConfig?:
    | CfnSpotFleet.TargetGroupsConfigProperty
    | cdk.IResolvable;

The target groups.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-loadbalancersconfig.html#cfn-ec2-spotfleet-loadbalancersconfig-targetgroupsconfig

interface MemoryGiBPerVCpuRequestProperty

interface MemoryGiBPerVCpuRequestProperty {}

The minimum and maximum amount of memory per vCPU, in GiB.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-memorygibpervcpurequest.html

property max

readonly max?: number;

The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-memorygibpervcpurequest.html#cfn-ec2-spotfleet-memorygibpervcpurequest-max

property min

readonly min?: number;

The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-memorygibpervcpurequest.html#cfn-ec2-spotfleet-memorygibpervcpurequest-min

interface MemoryMiBRequestProperty

interface MemoryMiBRequestProperty {}

The minimum and maximum amount of memory, in MiB.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-memorymibrequest.html

property max

readonly max?: number;

The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-memorymibrequest.html#cfn-ec2-spotfleet-memorymibrequest-max

property min

readonly min?: number;

The minimum amount of memory, in MiB. To specify no minimum limit, specify 0 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-memorymibrequest.html#cfn-ec2-spotfleet-memorymibrequest-min

interface NetworkBandwidthGbpsRequestProperty

interface NetworkBandwidthGbpsRequestProperty {}

The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Default: No minimum or maximum limits
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-networkbandwidthgbpsrequest.html

property max

readonly max?: number;

The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-networkbandwidthgbpsrequest.html#cfn-ec2-spotfleet-networkbandwidthgbpsrequest-max

property min

readonly min?: number;

The minimum amount of network bandwidth, in Gbps. To specify no minimum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-networkbandwidthgbpsrequest.html#cfn-ec2-spotfleet-networkbandwidthgbpsrequest-min

interface NetworkInterfaceCountRequestProperty

interface NetworkInterfaceCountRequestProperty {}

The minimum and maximum number of network interfaces.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-networkinterfacecountrequest.html

property max

readonly max?: number;

The maximum number of network interfaces. To specify no maximum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-networkinterfacecountrequest.html#cfn-ec2-spotfleet-networkinterfacecountrequest-max

property min

readonly min?: number;

The minimum number of network interfaces. To specify no minimum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-networkinterfacecountrequest.html#cfn-ec2-spotfleet-networkinterfacecountrequest-min

interface PrivateIpAddressSpecificationProperty

interface PrivateIpAddressSpecificationProperty {}

Describes a secondary private IPv4 address for a network interface.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-privateipaddressspecification.html

property primary

readonly primary?: boolean | cdk.IResolvable;

Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-privateipaddressspecification.html#cfn-ec2-spotfleet-privateipaddressspecification-primary

property privateIpAddress

readonly privateIpAddress: string;

The private IPv4 address.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-privateipaddressspecification.html#cfn-ec2-spotfleet-privateipaddressspecification-privateipaddress

interface SpotCapacityRebalanceProperty

interface SpotCapacityRebalanceProperty {}

The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted. For more information, see [Capacity rebalancing](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-capacity-rebalance.html) in the *Amazon EC2 User Guide for Linux Instances* .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotcapacityrebalance.html

property replacementStrategy

readonly replacementStrategy?: string;

The replacement strategy to use. Only available for fleets of type maintain .
launch - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. Spot Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running.
launch-before-terminate - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in TerminationDelay ), terminates the instances that received a rebalance notification.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotcapacityrebalance.html#cfn-ec2-spotfleet-spotcapacityrebalance-replacementstrategy

property terminationDelay

readonly terminationDelay?: number;

The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.
Required when ReplacementStrategy is set to launch-before-terminate .
Not valid when ReplacementStrategy is set to launch .
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotcapacityrebalance.html#cfn-ec2-spotfleet-spotcapacityrebalance-terminationdelay

interface SpotFleetLaunchSpecificationProperty

interface SpotFleetLaunchSpecificationProperty {}

Specifies the launch specification for one or more Spot Instances. If you include On-Demand capacity in your fleet request, you can't use SpotFleetLaunchSpecification ; you must use [LaunchTemplateConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateconfig.html) .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html

property blockDeviceMappings

readonly blockDeviceMappings?:
    | Array<CfnSpotFleet.BlockDeviceMappingProperty | cdk.IResolvable>
    | cdk.IResolvable;

One or more block devices that are mapped to the Spot Instances. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-blockdevicemappings

property ebsOptimized

readonly ebsOptimized?: boolean | cdk.IResolvable;

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-ebsoptimized

property iamInstanceProfile

readonly iamInstanceProfile?:
    | CfnSpotFleet.IamInstanceProfileSpecificationProperty
    | cdk.IResolvable;

The IAM instance profile.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-iaminstanceprofile

property imageId

readonly imageId: string;

The ID of the AMI.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-imageid

property instanceRequirements

readonly instanceRequirements?:
    | CfnSpotFleet.InstanceRequirementsRequestProperty
    | cdk.IResolvable;

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
> If you specify InstanceRequirements , you can't specify InstanceType .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-instancerequirements

property instanceType

readonly instanceType?: string;

The instance type.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-instancetype

property kernelId

readonly kernelId?: string;

The ID of the kernel.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-kernelid

property keyName

readonly keyName?: string;

The name of the key pair.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-keyname

property monitoring

readonly monitoring?: CfnSpotFleet.SpotFleetMonitoringProperty | cdk.IResolvable;

Enable or disable monitoring for the instances.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-monitoring

property networkInterfaces

readonly networkInterfaces?:
    | Array<
          | CfnSpotFleet.InstanceNetworkInterfaceSpecificationProperty
          | cdk.IResolvable
      >
    | cdk.IResolvable;

One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
> SpotFleetLaunchSpecification currently does not support Elastic Fabric Adapter (EFA). To specify an EFA, you must use [LaunchTemplateConfig](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplateConfig.html) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-networkinterfaces

property placement

readonly placement?: CfnSpotFleet.SpotPlacementProperty | cdk.IResolvable;

The placement information.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-placement

property ramdiskId

readonly ramdiskId?: string;

The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, refer to the AWS Resource Center and search for the kernel ID.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-ramdiskid

property securityGroups

readonly securityGroups?:
    | Array<CfnSpotFleet.GroupIdentifierProperty | cdk.IResolvable>
    | cdk.IResolvable;

The security groups.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-securitygroups

property spotPrice

readonly spotPrice?: string;

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
> If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-spotprice

property subnetId

readonly subnetId?: string;

The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-1234abcdeexample1, subnet-0987cdef6example2".
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-subnetid

property tagSpecifications

readonly tagSpecifications?:
    | Array<CfnSpotFleet.SpotFleetTagSpecificationProperty | cdk.IResolvable>
    | cdk.IResolvable;

The tags to apply during creation.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-tagspecifications

property userData

readonly userData?: string;

The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-userdata

property weightedCapacity

readonly weightedCapacity?: number;

The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-weightedcapacity

interface SpotFleetMonitoringProperty

interface SpotFleetMonitoringProperty {}

Describes whether monitoring is enabled.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetmonitoring.html

property enabled

readonly enabled?: boolean | cdk.IResolvable;

Enables monitoring for the instance.
Default: false
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetmonitoring.html#cfn-ec2-spotfleet-spotfleetmonitoring-enabled

interface SpotFleetRequestConfigDataProperty

interface SpotFleetRequestConfigDataProperty {}

Specifies the configuration of a Spot Fleet request. For more information, see [Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet.html) in the *Amazon EC2 User Guide* .
You must specify either LaunchSpecifications or LaunchTemplateConfigs .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html

property allocationStrategy

readonly allocationStrategy?: string;

The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet launch configuration. For more information, see [Allocation strategies for Spot Instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-allocation-strategy.html) in the *Amazon EC2 User Guide* .
- **priceCapacityOptimized (recommended)** - Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools. - **capacityOptimized** - Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized . Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides . You can assign the same priority to different LaunchTemplateOverrides . EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized , the same priority is applied when fulfilling On-Demand capacity. - **diversified** - Spot Fleet requests instances from all of the Spot Instance pools that you specify. - **lowestPrice** - Spot Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.
Default: lowestPrice
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-allocationstrategy

property context

readonly context?: string;

Reserved.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-context

property excessCapacityTerminationPolicy

readonly excessCapacityTerminationPolicy?: string;

Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.
Supported only for fleets of type maintain .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-excesscapacityterminationpolicy

property iamFleetRole

readonly iamFleetRole: string;

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see [Spot Fleet Prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html#spot-fleet-prerequisites) in the *Amazon EC2 User Guide for Linux Instances* . Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-iamfleetrole

property instanceInterruptionBehavior

readonly instanceInterruptionBehavior?: string;

The behavior when a Spot Instance is interrupted. The default is terminate .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-instanceinterruptionbehavior

property instancePoolsToUseCount

readonly instancePoolsToUseCount?: number;

The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot *AllocationStrategy* is set to lowest-price . Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-instancepoolstousecount

property launchSpecifications

readonly launchSpecifications?:
    | Array<CfnSpotFleet.SpotFleetLaunchSpecificationProperty | cdk.IResolvable>
    | cdk.IResolvable;

The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications , you can't specify LaunchTemplateConfigs .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications

property launchTemplateConfigs

readonly launchTemplateConfigs?:
    | Array<CfnSpotFleet.LaunchTemplateConfigProperty | cdk.IResolvable>
    | cdk.IResolvable;

The launch template and overrides. If you specify LaunchTemplateConfigs , you can't specify LaunchSpecifications .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-launchtemplateconfigs

property loadBalancersConfig

readonly loadBalancersConfig?:
    | CfnSpotFleet.LoadBalancersConfigProperty
    | cdk.IResolvable;

One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.
With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-loadbalancersconfig

property onDemandAllocationStrategy

readonly onDemandAllocationStrategy?: string;

The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowestPrice , Spot Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized , Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to lowestPrice .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-ondemandallocationstrategy

property onDemandMaxTotalPrice

readonly onDemandMaxTotalPrice?: string;

The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-ondemandmaxtotalprice

property onDemandTargetCapacity

readonly onDemandTargetCapacity?: number;

The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain , you can specify a target capacity of 0 and add capacity later.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-ondemandtargetcapacity

property replaceUnhealthyInstances

readonly replaceUnhealthyInstances?: boolean | cdk.IResolvable;

Indicates whether Spot Fleet should replace unhealthy instances.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-replaceunhealthyinstances

property spotMaintenanceStrategies

readonly spotMaintenanceStrategies?:
    | CfnSpotFleet.SpotMaintenanceStrategiesProperty
    | cdk.IResolvable;

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-spotmaintenancestrategies

property spotMaxTotalPrice

readonly spotMaxTotalPrice?: string;

The maximum amount per hour for Spot Instances that you're willing to pay. You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-spotmaxtotalprice

property spotPrice

readonly spotPrice?: string;

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
> If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-spotprice

property tagSpecifications

readonly tagSpecifications?:
    | Array<CfnSpotFleet.SpotFleetTagSpecificationProperty | cdk.IResolvable>
    | cdk.IResolvable;

The key-value pair for tagging the Spot Fleet request on creation. The value for ResourceType must be spot-fleet-request , otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the [launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template) (valid only if you use LaunchTemplateConfigs ) or in the [SpotFleetTagSpecification](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetTagSpecification.html) (valid only if you use LaunchSpecifications ). For information about tagging after launch, see [Tagging Your Resources](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-tagspecifications

property targetCapacity

readonly targetCapacity: number;

The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain , you can specify a target capacity of 0 and add capacity later.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-targetcapacity

property targetCapacityUnitType

readonly targetCapacityUnitType?: string;

The unit for the target capacity. TargetCapacityUnitType can only be specified when InstanceRequirements is specified.
Default: units (translates to number of instances)
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-targetcapacityunittype

property terminateInstancesWithExpiration

readonly terminateInstancesWithExpiration?: boolean | cdk.IResolvable;

Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-terminateinstanceswithexpiration

property type

readonly type?: string;

The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is request , the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is maintain , the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain . instant is listed but is not used by Spot Fleet.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-type

property validFrom

readonly validFrom?: string;

The start date and time of the request, in UTC format ( *YYYY* - *MM* - *DD* T *HH* : *MM* : *SS* Z). By default, Amazon EC2 starts fulfilling the request immediately.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-validfrom

property validUntil

readonly validUntil?: string;

The end date and time of the request, in UTC format ( *YYYY* - *MM* - *DD* T *HH* : *MM* : *SS* Z). After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-validuntil

interface SpotFleetTagSpecificationProperty

interface SpotFleetTagSpecificationProperty {}

The tags for a Spot Fleet resource.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleettagspecification.html

property resourceType

readonly resourceType?: string;

The type of resource. Currently, the only resource type that is supported is instance . To tag the Spot Fleet request on creation, use the TagSpecifications parameter in [SpotFleetRequestConfigData](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetRequestConfigData.html) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleettagspecification.html#cfn-ec2-spotfleet-spotfleettagspecification-resourcetype

property tags

readonly tags?: cdk.CfnTag[];

The tags.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleettagspecification.html#cfn-ec2-spotfleet-spotfleettagspecification-tags

interface SpotMaintenanceStrategiesProperty

interface SpotMaintenanceStrategiesProperty {}

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotmaintenancestrategies.html

property capacityRebalance

readonly capacityRebalance?:
    | CfnSpotFleet.SpotCapacityRebalanceProperty
    | cdk.IResolvable;

The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted. For more information, see [Capacity rebalancing](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-capacity-rebalance.html) in the *Amazon EC2 User Guide for Linux Instances* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotmaintenancestrategies.html#cfn-ec2-spotfleet-spotmaintenancestrategies-capacityrebalance

interface SpotPlacementProperty

interface SpotPlacementProperty {}

Describes Spot Instance placement.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotplacement.html

property availabilityZone

readonly availabilityZone?: string;

The Availability Zone.
To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotplacement.html#cfn-ec2-spotfleet-spotplacement-availabilityzone

property groupName

readonly groupName?: string;

The name of the placement group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotplacement.html#cfn-ec2-spotfleet-spotplacement-groupname

property tenancy

readonly tenancy?: string;

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for Spot Instances.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotplacement.html#cfn-ec2-spotfleet-spotplacement-tenancy

interface TargetGroupProperty

interface TargetGroupProperty {}

Describes a load balancer target group.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-targetgroup.html

property arn

readonly arn: string;

The Amazon Resource Name (ARN) of the target group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-targetgroup.html#cfn-ec2-spotfleet-targetgroup-arn

interface TargetGroupsConfigProperty

interface TargetGroupsConfigProperty {}

Describes the target groups to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these target groups.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-targetgroupsconfig.html

property targetGroups

readonly targetGroups:
    | Array<CfnSpotFleet.TargetGroupProperty | cdk.IResolvable>
    | cdk.IResolvable;

One or more target groups.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-targetgroupsconfig.html#cfn-ec2-spotfleet-targetgroupsconfig-targetgroups

interface TotalLocalStorageGBRequestProperty

interface TotalLocalStorageGBRequestProperty {}

The minimum and maximum amount of total local storage, in GB.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-totallocalstoragegbrequest.html

property max

readonly max?: number;

The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-totallocalstoragegbrequest.html#cfn-ec2-spotfleet-totallocalstoragegbrequest-max

property min

readonly min?: number;

The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-totallocalstoragegbrequest.html#cfn-ec2-spotfleet-totallocalstoragegbrequest-min

interface VCpuCountRangeRequestProperty

interface VCpuCountRangeRequestProperty {}

The minimum and maximum number of vCPUs.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-vcpucountrangerequest.html

property max

readonly max?: number;

The maximum number of vCPUs. To specify no maximum limit, omit this parameter.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-vcpucountrangerequest.html#cfn-ec2-spotfleet-vcpucountrangerequest-max

property min

readonly min?: number;

The minimum number of vCPUs. To specify no minimum limit, specify 0 .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-vcpucountrangerequest.html#cfn-ec2-spotfleet-vcpucountrangerequest-min

namespace CfnSubnet

namespace CfnSubnet {}

interface PrivateDnsNameOptionsOnLaunchProperty

interface PrivateDnsNameOptionsOnLaunchProperty {}

Describes the options for instance hostnames.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-subnet-privatednsnameoptionsonlaunch.html

property enableResourceNameDnsAaaaRecord

readonly enableResourceNameDnsAaaaRecord?: boolean | cdk.IResolvable;

Indicates whether to respond to DNS queries for instance hostname with DNS AAAA records.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-subnet-privatednsnameoptionsonlaunch.html#cfn-ec2-subnet-privatednsnameoptionsonlaunch-enableresourcenamednsaaaarecord

property enableResourceNameDnsARecord

readonly enableResourceNameDnsARecord?: boolean | cdk.IResolvable;

Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-subnet-privatednsnameoptionsonlaunch.html#cfn-ec2-subnet-privatednsnameoptionsonlaunch-enableresourcenamednsarecord

property hostnameType

readonly hostnameType?: string;

The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-subnet-privatednsnameoptionsonlaunch.html#cfn-ec2-subnet-privatednsnameoptionsonlaunch-hostnametype

namespace CfnTrafficMirrorFilterRule

namespace CfnTrafficMirrorFilterRule {}

interface TrafficMirrorPortRangeProperty

interface TrafficMirrorPortRangeProperty {}

Describes the Traffic Mirror port range.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-trafficmirrorfilterrule-trafficmirrorportrange.html

property fromPort

readonly fromPort: number;

The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-trafficmirrorfilterrule-trafficmirrorportrange.html#cfn-ec2-trafficmirrorfilterrule-trafficmirrorportrange-fromport

property toPort

readonly toPort: number;

The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-trafficmirrorfilterrule-trafficmirrorportrange.html#cfn-ec2-trafficmirrorfilterrule-trafficmirrorportrange-toport

namespace CfnTransitGatewayAttachment

namespace CfnTransitGatewayAttachment {}

interface OptionsProperty

interface OptionsProperty {}

Describes the VPC attachment options.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayattachment-options.html

property applianceModeSupport

readonly applianceModeSupport?: string;

Indicates whether appliance mode support is enabled.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayattachment-options.html#cfn-ec2-transitgatewayattachment-options-appliancemodesupport

property dnsSupport

readonly dnsSupport?: string;

Indicates whether DNS support is enabled.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayattachment-options.html#cfn-ec2-transitgatewayattachment-options-dnssupport

property ipv6Support

readonly ipv6Support?: string;

Indicates whether IPv6 support is disabled.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayattachment-options.html#cfn-ec2-transitgatewayattachment-options-ipv6support

namespace CfnTransitGatewayConnect

namespace CfnTransitGatewayConnect {}

interface TransitGatewayConnectOptionsProperty

interface TransitGatewayConnectOptionsProperty {}

Describes the Connect attachment options.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayconnect-transitgatewayconnectoptions.html

property protocol

readonly protocol?: string;

The tunnel protocol.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayconnect-transitgatewayconnectoptions.html#cfn-ec2-transitgatewayconnect-transitgatewayconnectoptions-protocol

namespace CfnTransitGatewayMulticastDomain

namespace CfnTransitGatewayMulticastDomain {}

interface OptionsProperty

interface OptionsProperty {}

The options for the transit gateway multicast domain.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewaymulticastdomain-options.html

property autoAcceptSharedAssociations

readonly autoAcceptSharedAssociations?: string;

Indicates whether to automatically accept cross-account subnet associations that are associated with the transit gateway multicast domain.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewaymulticastdomain-options.html#cfn-ec2-transitgatewaymulticastdomain-options-autoacceptsharedassociations

property igmpv2Support

readonly igmpv2Support?: string;

Specify whether to enable Internet Group Management Protocol (IGMP) version 2 for the transit gateway multicast domain.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewaymulticastdomain-options.html#cfn-ec2-transitgatewaymulticastdomain-options-igmpv2support

property staticSourcesSupport

readonly staticSourcesSupport?: string;

Specify whether to enable support for statically configuring multicast group sources for a domain.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewaymulticastdomain-options.html#cfn-ec2-transitgatewaymulticastdomain-options-staticsourcessupport

namespace CfnTransitGatewayPeeringAttachment

namespace CfnTransitGatewayPeeringAttachment {}

interface PeeringAttachmentStatusProperty

interface PeeringAttachmentStatusProperty {}

The status of the transit gateway peering attachment.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewaypeeringattachment-peeringattachmentstatus.html

property code

readonly code?: string;

The status code.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewaypeeringattachment-peeringattachmentstatus.html#cfn-ec2-transitgatewaypeeringattachment-peeringattachmentstatus-code

property message

readonly message?: string;

The status message, if applicable.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewaypeeringattachment-peeringattachmentstatus.html#cfn-ec2-transitgatewaypeeringattachment-peeringattachmentstatus-message

namespace CfnTransitGatewayVpcAttachment

namespace CfnTransitGatewayVpcAttachment {}

interface OptionsProperty

interface OptionsProperty {}

Describes the VPC attachment options.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayvpcattachment-options.html

property applianceModeSupport

readonly applianceModeSupport?: string;

Indicates whether appliance mode support is enabled.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayvpcattachment-options.html#cfn-ec2-transitgatewayvpcattachment-options-appliancemodesupport

property dnsSupport

readonly dnsSupport?: string;

Indicates whether DNS support is enabled.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayvpcattachment-options.html#cfn-ec2-transitgatewayvpcattachment-options-dnssupport

property ipv6Support

readonly ipv6Support?: string;

Indicates whether IPv6 support is disabled.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayvpcattachment-options.html#cfn-ec2-transitgatewayvpcattachment-options-ipv6support

namespace CfnVerifiedAccessEndpoint

namespace CfnVerifiedAccessEndpoint {}

interface LoadBalancerOptionsProperty

interface LoadBalancerOptionsProperty {}

Describes the load balancer options when creating an AWS Verified Access endpoint using the load-balancer type.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-loadbalanceroptions.html

property loadBalancerArn

readonly loadBalancerArn?: string;

The ARN of the load balancer.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-loadbalanceroptions.html#cfn-ec2-verifiedaccessendpoint-loadbalanceroptions-loadbalancerarn

property port

readonly port?: number;

The IP port number.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-loadbalanceroptions.html#cfn-ec2-verifiedaccessendpoint-loadbalanceroptions-port

property protocol

readonly protocol?: string;

The IP protocol.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-loadbalanceroptions.html#cfn-ec2-verifiedaccessendpoint-loadbalanceroptions-protocol

property subnetIds

readonly subnetIds?: string[];

The IDs of the subnets.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-loadbalanceroptions.html#cfn-ec2-verifiedaccessendpoint-loadbalanceroptions-subnetids

interface NetworkInterfaceOptionsProperty

interface NetworkInterfaceOptionsProperty {}

Describes the network interface options when creating an AWS Verified Access endpoint using the network-interface type.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-networkinterfaceoptions.html

property networkInterfaceId

readonly networkInterfaceId?: string;

The ID of the network interface.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-networkinterfaceoptions.html#cfn-ec2-verifiedaccessendpoint-networkinterfaceoptions-networkinterfaceid

property port

readonly port?: number;

The IP port number.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-networkinterfaceoptions.html#cfn-ec2-verifiedaccessendpoint-networkinterfaceoptions-port

property protocol

readonly protocol?: string;

The IP protocol.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-networkinterfaceoptions.html#cfn-ec2-verifiedaccessendpoint-networkinterfaceoptions-protocol

namespace CfnVerifiedAccessInstance

namespace CfnVerifiedAccessInstance {}

interface CloudWatchLogsProperty

interface CloudWatchLogsProperty {}

Options for CloudWatch Logs as a logging destination.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-cloudwatchlogs.html

property enabled

readonly enabled?: boolean | cdk.IResolvable;

Indicates whether logging is enabled.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-cloudwatchlogs.html#cfn-ec2-verifiedaccessinstance-cloudwatchlogs-enabled

property logGroup

readonly logGroup?: string;

The ID of the CloudWatch Logs log group.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-cloudwatchlogs.html#cfn-ec2-verifiedaccessinstance-cloudwatchlogs-loggroup

interface KinesisDataFirehoseProperty

interface KinesisDataFirehoseProperty {}

Options for Kinesis as a logging destination.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-kinesisdatafirehose.html

property deliveryStream

readonly deliveryStream?: string;

The ID of the delivery stream.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-kinesisdatafirehose.html#cfn-ec2-verifiedaccessinstance-kinesisdatafirehose-deliverystream

property enabled

readonly enabled?: boolean | cdk.IResolvable;

Indicates whether logging is enabled.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-kinesisdatafirehose.html#cfn-ec2-verifiedaccessinstance-kinesisdatafirehose-enabled

interface S3Property

interface S3Property {}

Options for Amazon S3 as a logging destination.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-s3.html

property bucketName

readonly bucketName?: string;

The bucket name.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-s3.html#cfn-ec2-verifiedaccessinstance-s3-bucketname

property bucketOwner

readonly bucketOwner?: string;

The AWS account number that owns the bucket.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-s3.html#cfn-ec2-verifiedaccessinstance-s3-bucketowner

property enabled

readonly enabled?: boolean | cdk.IResolvable;

Indicates whether logging is enabled.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-s3.html#cfn-ec2-verifiedaccessinstance-s3-enabled

property prefix

readonly prefix?: string;

The bucket prefix.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-s3.html#cfn-ec2-verifiedaccessinstance-s3-prefix

interface VerifiedAccessLogsProperty

interface VerifiedAccessLogsProperty {}

Describes the destinations for Verified Access logs.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesslogs.html

property cloudWatchLogs

readonly cloudWatchLogs?:
    | CfnVerifiedAccessInstance.CloudWatchLogsProperty
    | cdk.IResolvable;

CloudWatch Logs logging destination.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesslogs.html#cfn-ec2-verifiedaccessinstance-verifiedaccesslogs-cloudwatchlogs

property kinesisDataFirehose

readonly kinesisDataFirehose?:
    | CfnVerifiedAccessInstance.KinesisDataFirehoseProperty
    | cdk.IResolvable;

Kinesis logging destination.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesslogs.html#cfn-ec2-verifiedaccessinstance-verifiedaccesslogs-kinesisdatafirehose

property s3

readonly s3?: CfnVerifiedAccessInstance.S3Property | cdk.IResolvable;

Amazon S3 logging options.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesslogs.html#cfn-ec2-verifiedaccessinstance-verifiedaccesslogs-s3

interface VerifiedAccessTrustProviderProperty

interface VerifiedAccessTrustProviderProperty {}

Describes a Verified Access trust provider.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesstrustprovider.html

property description

readonly description?: string;

A description for the AWS Verified Access trust provider.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccessinstance-verifiedaccesstrustprovider-description

property deviceTrustProviderType

readonly deviceTrustProviderType?: string;

The type of device-based trust provider.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccessinstance-verifiedaccesstrustprovider-devicetrustprovidertype

property trustProviderType

readonly trustProviderType?: string;

The type of Verified Access trust provider.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccessinstance-verifiedaccesstrustprovider-trustprovidertype

property userTrustProviderType

readonly userTrustProviderType?: string;

The type of user-based trust provider.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccessinstance-verifiedaccesstrustprovider-usertrustprovidertype

property verifiedAccessTrustProviderId

readonly verifiedAccessTrustProviderId?: string;

The ID of the AWS Verified Access trust provider.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccessinstance-verifiedaccesstrustprovider-verifiedaccesstrustproviderid

namespace CfnVerifiedAccessTrustProvider

namespace CfnVerifiedAccessTrustProvider {}

interface DeviceOptionsProperty

interface DeviceOptionsProperty {}

Describes the options for an AWS Verified Access device-identity based trust provider.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-deviceoptions.html

property tenantId

readonly tenantId?: string;

The ID of the tenant application with the device-identity provider.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-deviceoptions.html#cfn-ec2-verifiedaccesstrustprovider-deviceoptions-tenantid

interface OidcOptionsProperty

interface OidcOptionsProperty {}

Describes the options for an OpenID Connect-compatible user-identity trust provider.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-oidcoptions.html

property authorizationEndpoint

readonly authorizationEndpoint?: string;

The OIDC authorization endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-oidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions-authorizationendpoint

property clientId

readonly clientId?: string;

The client identifier.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-oidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions-clientid

property clientSecret

readonly clientSecret?: string;

The client secret.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-oidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions-clientsecret

property issuer

readonly issuer?: string;

The OIDC issuer.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-oidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions-issuer

property scope

readonly scope?: string;

The OpenID Connect (OIDC) scope specified.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-oidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions-scope

property tokenEndpoint

readonly tokenEndpoint?: string;

The OIDC token endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-oidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions-tokenendpoint

property userInfoEndpoint

readonly userInfoEndpoint?: string;

The OIDC user info endpoint.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-oidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions-userinfoendpoint

namespace CfnVPNConnection

namespace CfnVPNConnection {}

interface VpnTunnelOptionsSpecificationProperty

interface VpnTunnelOptionsSpecificationProperty {}

The tunnel options for a single VPN tunnel.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html

property preSharedKey

readonly preSharedKey?: string;

The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway.
Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-presharedkey

property tunnelInsideCidr

readonly tunnelInsideCidr?: string;

The range of inside IP addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.
Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The following CIDR blocks are reserved and cannot be used:
- 169.254.0.0/30 - 169.254.1.0/30 - 169.254.2.0/30 - 169.254.3.0/30 - 169.254.4.0/30 - 169.254.5.0/30 - 169.254.169.252/30
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-tunnelinsidecidr

Dependencies (12)

Dev Dependencies (10)

Peer Dependencies (12)

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@aws-cdk/aws-ec2.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@aws-cdk/aws-ec2)

HTML

<a href="https://www.jsdocs.io/package/@aws-cdk/aws-ec2"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 2 years ago.
Package analyzed in 37894 ms.
Missing or incorrect documentation? Open an issue for this package.

@aws-cdk/aws-ec2

Install

Overview

Index

Variables

Classes

Interfaces

Enums

Namespaces

Variables

variable RESERVED_TUNNEL_INSIDE_CIDR

Classes

class AclCidr

method anyIpv4

method anyIpv6

method ipv4

method ipv6

method toCidrConfig

class AclTraffic

method allTraffic

method icmp

method icmpv6

method tcpPort

method tcpPortRange

method toTrafficConfig

method udpPort

method udpPortRange

class AmazonLinuxImage

method getImage

method ssmParameterName

class BastionHostLinux

property connections

property grantPrincipal

property instance

property instanceAvailabilityZone

property instanceId

property instancePrivateDnsName

property instancePrivateIp

property instancePublicDnsName

property instancePublicIp

property role

property stack

method allowSshAccessFrom

class BlockDeviceVolume

Parameter ebsDevice

Parameter virtualName

property ebsDevice

property virtualName

method ebs

Parameter volumeSize

Parameter options

method ebsFromSnapshot

Parameter snapshotId

Parameter options

method ephemeral

Parameter volumeIndex

class CfnCapacityReservation

Parameter scope

Parameter id

Parameter props

property attrAvailabilityZone

property attrAvailableInstanceCount

property attrId

property attrInstanceType

property attrTenancy

property attrTotalInstanceCount

property availabilityZone

property CFN_RESOURCE_TYPE_NAME

property cfnProperties

property ebsOptimized

property endDate

property endDateType

property ephemeralStorage

property instanceCount

property instanceMatchCriteria

property instancePlatform

property instanceType

property outPostArn

property placementGroupArn

property tagSpecifications