@aws-cdk/aws-ec2

@aws-cdk/aws-ec2

Version 1.156.1
Published 4 days ago
14 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 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;

Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.
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;

AWS::EC2::CapacityReservationFleet.NoRemoveEndDate
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-noremoveenddate

property removeEndDate

removeEndDate: any;

AWS::EC2::CapacityReservationFleet.RemoveEndDate
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. The CIDR block should be /22 or greater.
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-customer-gateway.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 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-customer-gateway.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 ipAddress

ipAddress: string;

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customer-gateway.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-customer-gateway.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-customer-gateway.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.
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* .
[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another AWS ac

@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 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

property tenancy