This documentation is for the developer preview release of the AWS CDK. Do not use this version of the AWS CDK in production. Subsequent releases of the AWS CDK will likely include breaking changes.

@aws-cdk/aws-ec2

AWS Compute and Networking Construct Library

The @aws-cdk/aws-ec2 package contains primitives for setting up networking and instances.

VPC

Most projects need a Virtual Private Cloud to provide security by means of network partitioning. This is easily achieved by creating an instance of VpcNetwork:

import ec2 = require('@aws-cdk/aws-ec2');

const vpc = new ec2.VpcNetwork(this, 'VPC');

All default Constructs requires EC2 instances to be launched inside a VPC, so you should generally start by defining a VPC whenever you need to launch instances for your project.

Our default VpcNetwork class creates a private and public subnet for every availability zone. Classes that use the VPC will generally launch instances into all private subnets, and provide a parameter called vpcSubnets to allow you to override the placement. Read more about subnets.

Advanced Subnet Configuration

If you require the ability to configure subnets the VpcNetwork can be customized with SubnetConfiguration array. This is best explained by an example:

import ec2 = require('@aws-cdk/aws-ec2');

const vpc = new ec2.VpcNetwork(this, 'TheVPC', {
  cidr: '10.0.0.0/21',
  subnetConfiguration: [
    {
      cidrMask: 24,
      name: 'Ingress',
      subnetType: SubnetType.Public,
    },
    {
      cidrMask: 24,
      name: 'Application',
      subnetType: SubnetType.Private,
    },
    {
      cidrMask: 28,
      name: 'Database',
      subnetType: SubnetType.Isolated,
    }
  ],
});

The example above is one possible configuration, but the user can use the constructs above to implement many other network configurations.

The VpcNetwork from the above configuration in a Region with three availability zones will be the following:

  • IngressSubnet1: 10.0.0.0/24
  • IngressSubnet2: 10.0.1.0/24
  • IngressSubnet3: 10.0.2.0/24
  • ApplicationSubnet1: 10.0.3.0/24
  • ApplicationSubnet2: 10.0.4.0/24
  • ApplicationSubnet3: 10.0.5.0/24
  • DatabaseSubnet1: 10.0.6.0/28
  • DatabaseSubnet2: 10.0.6.16/28
  • DatabaseSubnet3: 10.0.6.32/28

Each Public Subnet will have a NAT Gateway. Each Private Subnet will have a route to the NAT Gateway in the same availability zone. Each Isolated subnet will not have a route to the internet, but is routeable inside the VPC. The numbers [1-3] will consistently map to availability zones (e.g. IngressSubnet1 and ApplicationSubnet1 will be in the same avialbility zone).

Isolated Subnets provide simplified secure networking principles, but come at an operational complexity. The lack of an internet route means that if you deploy instances in this subnet you will not be able to patch from the internet, this is commonly reffered to as fully baked images. Features such as cfn-signal are also unavailable. Using these subnets for managed services (RDS, Elasticache, Redshift) is a very practical use because the managed services do not incur additional operational overhead.

Many times when you plan to build an application you don’t know how many instances of the application you will need and therefore you don’t know how much IP space to allocate. For example, you know the application will only have Elastic Loadbalancers in the public subnets and you know you will have 1-3 RDS databases for your data tier, and the rest of the IP space should just be evenly distributed for the application.

import ec2 = require('@aws-cdk/aws-ec2');

const vpc = new ec2.VpcNetwork(this, 'TheVPC', {
  cidr: '10.0.0.0/16',
  natGateways: 1,
  subnetConfiguration: [
    {
      cidrMask: 26,
      name: 'Public',
      subnetType: SubnetType.Public,
    },
    {
      name: 'Application',
      subnetType: SubnetType.Private,
    },
    {
      cidrMask: 27,
      name: 'Database',
      subnetType: SubnetType.Isolated,
    }
  ],
});

The VpcNetwork from the above configuration in a Region with three availability zones will be the following:

  • PublicSubnet1: 10.0.0.0/26
  • PublicSubnet2: 10.0.0.64/26
  • PublicSubnet3: 10.0.2.128/26
  • DatabaseSubnet1: 10.0.0.192/27
  • DatabaseSubnet2: 10.0.0.224/27
  • DatabaseSubnet3: 10.0.1.0/27
  • ApplicationSubnet1: 10.0.64.0/18
  • ApplicationSubnet2: 10.0.128.0/18
  • ApplicationSubnet3: 10.0.192.0/18

Any subnet configuration without a cidrMask will be counted up and allocated evenly across the remaining IP space.

Teams may also become cost conscious and be willing to trade availability for cost. For example, in your test environments perhaps you would like the same VPC as production, but instead of 3 NAT Gateways you would like only 1. This will save on the cost, but trade the 3 availability zone to a 1 for all egress traffic. This can be accomplished with a single parameter configuration:

import ec2 = require('@aws-cdk/aws-ec2');

const vpc = new ec2.VpcNetwork(this, 'TheVPC', {
  cidr: '10.0.0.0/16',
  natGateways: 1,
  natGatewayPlacement: {subnetName: 'Public'},
  subnetConfiguration: [
    {
      cidrMask: 26,
      name: 'Public',
      subnetType: SubnetType.Public,
      natGateway: true,
    },
    {
      name: 'Application',
      subnetType: SubnetType.Private,
    },
    {
      cidrMask: 27,
      name: 'Database',
      subnetType: SubnetType.Isolated,
    }
  ],
});

The VpcNetwork above will have the exact same subnet definitions as listed above. However, this time the VPC will have only 1 NAT Gateway and all Application subnets will route to the NAT Gateway.

Reserving subnet IP space

There are situations where the IP space for a subnet or number of subnets
will need to be reserved. This is useful in situations where subnets

would need to be added after the vpc is originally deployed, without causing IP renumbering for existing subnets. The IP space for a subnet may be reserved by setting the reserved subnetConfiguration property to true, as shown below:

import ec2 = require('@aws-cdk/aws-ec2');
const vpc = new ec2.VpcNetwork(this, 'TheVPC', {
  cidr: '10.0.0.0/16',
  natGateways: 1,
  subnetConfiguration: [
    {
      cidrMask: 26,
      name: 'Public',
      subnetType: SubnetType.Public,
    },
    {
      cidrMask: 26,
      name: 'Application1',
      subnetType: SubnetType.Private,
    },
    {
      cidrMask: 26,
      name: 'Application2',
      subnetType: SubnetType.Private,
      reserved: true,
    },
    {
      cidrMask: 27,
      name: 'Database',
      subnetType: SubnetType.Isolated,
    }
  ],
});

In the example above, the subnet for Application2 is not actually provisioned but its IP space is still reserved. If in the future this subnet needs to be provisioned, then the reserved: true property should be removed. Most importantly, this action would not cause the Database subnet to get renumbered, but rather the IP space that was previously reserved will be used for the subnet provisioned for Application2. The reserved property also takes into consideration the number of availability zones when reserving IP space.

Sharing VPCs between stacks

If you are creating multiple Stacks inside the same CDK application, you can reuse a VPC defined in one Stack in another by using export() and import():

/**
 * Stack1 creates the VPC
 */
class Stack1 extends cdk.Stack {
  public readonly vpc: ec2.VpcNetwork;

  constructor(scope: cdk.App, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    this.vpc = new ec2.VpcNetwork(this, 'VPC');
  }
}

interface Stack2Props extends cdk.StackProps {
  vpc: ec2.IVpcNetwork;
}

/**
 * Stack2 consumes the VPC
 */
class Stack2 extends cdk.Stack {
  constructor(scope: cdk.App, id: string, props: Stack2Props) {
    super(scope, id, props);

    // Pass the VPC to a construct that needs it
    new ConstructThatTakesAVpc(this, 'Construct', {
      vpc: props.vpc
    });
  }
}

const stack1 = new Stack1(app, 'Stack1');
const stack2 = new Stack2(app, 'Stack2', {
  vpc: stack1.vpc,
});

Importing an existing VPC

If your VPC is created outside your CDK app, you can use importFromContext():

const vpc = ec2.VpcNetwork.importFromContext(stack, 'VPC', {
  // This imports the default VPC but you can also
  // specify a 'vpcName' or 'tags'.
  isDefault: true
});

Allowing Connections

In AWS, all network traffic in and out of Elastic Network Interfaces (ENIs) is controlled by Security Groups. You can think of Security Groups as a firewall with a set of rules. By default, Security Groups allow no incoming (ingress) traffic and all outgoing (egress) traffic. You can add ingress rules to them to allow incoming traffic streams. To exert fine-grained control over egress traffic, set allowAllOutbound: false on the SecurityGroup, after which you can add egress traffic rules.

You can manipulate Security Groups directly:

const mySecurityGroup = new ec2.SecurityGroup(this, 'SecurityGroup', {
  vpc,
  description: 'Allow ssh access to ec2 instances',
  allowAllOutbound: true   // Can be set to false
});
mySecurityGroup.addIngressRule(new ec2.AnyIPv4(), new ec2.TcpPort(22), 'allow ssh access from the world');

All constructs that create ENIs on your behalf (typically constructs that create EC2 instances or other VPC-connected resources) will all have security groups automatically assigned. Those constructs have an attribute called connections, which is an object that makes it convenient to update the security groups. If you want to allow connections between two constructs that have security groups, you have to add an Egress rule to one Security Group, and an Ingress rule to the other. The connections object will automatically take care of this for you:

// Allow connections from anywhere
loadBalancer.connections.allowFromAnyIpv4(new ec2.TcpPort(443), 'Allow inbound HTTPS');

// The same, but an explicit IP address
loadBalancer.connections.allowFrom(new ec2.CidrIpv4('1.2.3.4/32'), new ec2.TcpPort(443), 'Allow inbound HTTPS');

// Allow connection between AutoScalingGroups
appFleet.connections.allowTo(dbFleet, new ec2.TcpPort(443), 'App can call database');

Connection Peers

There are various classes that implement the connection peer part:

// Simple connection peers
let peer = new ec2.CidrIp("10.0.0.0/16");
let peer = new ec2.AnyIPv4();
let peer = new ec2.CidrIpv6("::0/0");
let peer = new ec2.AnyIPv6();
let peer = new ec2.PrefixList("pl-12345");
fleet.connections.allowTo(peer, new ec2.TcpPort(443), 'Allow outbound HTTPS');

Any object that has a security group can itself be used as a connection peer:

// These automatically create appropriate ingress and egress rules in both security groups
fleet1.connections.allowTo(fleet2, new ec2.TcpPort(80), 'Allow between fleets');

fleet.connections.allowTcpPort(80), 'Allow from load balancer');

Port Ranges

The connections that are allowed are specified by port ranges. A number of classes provide the connection specifier:

new ec2.TcpPort(80)
new ec2.TcpPortRange(60000, 65535)
new ec2.TcpAllPorts()
new ec2.AllConnections()
NOTE: This set is not complete yet; for example, there is no library support for ICMP at the moment. However, you can write your own classes to implement those.

Default Ports

Some Constructs have default ports associated with them. For example, the listener of a load balancer does (it’s the public port), or instances of an RDS database (it’s the port the database is accepting connections on).

If the object you’re calling the peering method on has a default port associated with it, you can call allowDefaultPortFrom() and omit the port specifier. If the argument has an associated default port, call allowToDefaultPort().

For example:

// Port implicit in listener
listener.connections.allowDefaultPortFromAnyIpv4('Allow public');

// Port implicit in peer
fleet.connections.allowToDefaultPort(rdsDatabase, 'Fleet can access database');

Machine Images (AMIs)

AMIs control the OS that gets launched when you start your EC2 instance. The EC2 library contains constructs to select the AMI you want to use.

Depending on the type of AMI, you select it a different way.

The latest version of Amazon Linux and Microsoft Windows images are selectable by instantiating one of these classes:

// Pick a Windows edition to use
const windows = new ec2.WindowsImage(ec2.WindowsVersion.WindowsServer2019EnglishFullBase);

// Pick the right Amazon Linux edition. All arguments shown are optional
// and will default to these values when omitted.
const amznLinux = new ec2.AmazonLinuxImage({
  generation: ec2.AmazonLinuxGeneration.AmazonLinux,
  edition: ec2.AmazonLinuxEdition.Standard,
  virtualization: ec2.AmazonLinuxVirt.HVM,
  storage: ec2.AmazonLinuxStorage.GeneralPurpose,
});

// For other custom (Linux) images, instantiate a `GenericLinuxImage` with
// a map giving the AMI to in for each region:

const linux = new ec2.GenericLinuxImage({
    'us-east-1': 'ami-97785bed',
    'eu-west-1': 'ami-12345678',
    // ...
});

NOTE: The Amazon Linux images selected will be cached in your cdk.json, so that your AutoScalingGroups don’t automatically change out from under you when you’re making unrelated changes. To update to the latest version of Amazon Linux, remove the cache entry from the context section of your cdk.json.

We will add command-line options to make this step easier in the future.

VPN connections to a VPC

Create your VPC with VPN connections by specifying the vpnConnections props (keys are construct ids):

const vpc = new ec2.VpcNetwork(stack, 'MyVpc', {
  vpnConnections: {
    dynamic: { // Dynamic routing (BGP)
      ip: '1.2.3.4'
    },
    static: { // Static routing
      ip: '4.5.6.7',
      staticRoutes: [
        '192.168.10.0/24',
        '192.168.20.0/24'
      ]
    }
  }
});

To create a VPC that can accept VPN connections, set vpnGateway to true:

const vpc = new ec2.VpcNetwork(stack, 'MyVpc', {
  vpnGateway: true
});

VPN connections can then be added:

vpc.addVpnConnection('Dynamic', {
  ip: '1.2.3.4'
});

Routes will be propagated on the route tables associated with the private subnets.

VPN connections expose metrics (cloudwatch.Metric) across all tunnels in the account/region and per connection:

// Across all tunnels in the account/region
const allDataOut = VpnConnection.metricAllTunnelDataOut();

// For a specific vpn connection
const vpnConnection = vpc.addVpnConnection('Dynamic', {
  ip: '1.2.3.4'
});
const state = vpnConnection.metricTunnelState();

Reference

View in Nuget

csproj:

<PackageReference Include="Amazon.CDK.AWS.EC2" Version="0.28.0" />

dotnet:

dotnet add package Amazon.CDK.AWS.EC2 --version 0.28.0

packages.config:

<package id="Amazon.CDK.AWS.EC2" version="0.28.0" />

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:ec2:jar:0.28.0'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="ec2" rev="0.28.0"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>ec2</artifactId>
  <version>0.28.0</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:ec2:0.28.0'

Groovy Grape:

@Grapes(
@Grab(group='software.amazon.awscdk', module='ec2', version='0.28.0')
)

View in NPM

npm:

$ npm i @aws-cdk/aws-ec2@0.28.0

package.json:

{
  "@aws-cdk/aws-ec2": "^0.28.0"
}

yarn:

$ yarn add @aws-cdk/aws-ec2@0.28.0

View in NPM

npm:

$ npm i @aws-cdk/aws-ec2@0.28.0

package.json:

{
  "@aws-cdk/aws-ec2": "^0.28.0"
}

yarn:

$ yarn add @aws-cdk/aws-ec2@0.28.0

AllTraffic

class @aws-cdk/aws-ec2.AllTraffic

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AllTraffic;
const { AllTraffic } = require('@aws-cdk/aws-ec2');
import { AllTraffic } from '@aws-cdk/aws-ec2';

All Traffic

Implements:IPortRange
toRuleJSON() → any

Implements @aws-cdk/aws-ec2.IPortRange.toRuleJSON()

Produce the ingress/egress rule JSON for the given connection

Return type:any
toString() → string

Returns a string representation of an object.

Return type:string
canInlineRule

Implements @aws-cdk/aws-ec2.IPortRange.canInlineRule()

Whether the rule containing this port range can be inlined into a securitygroup or not.

Type:boolean (readonly)

AmazonLinuxEdition (enum)

class @aws-cdk/aws-ec2.AmazonLinuxEdition

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AmazonLinuxEdition;
const { AmazonLinuxEdition } = require('@aws-cdk/aws-ec2');
import { AmazonLinuxEdition } from '@aws-cdk/aws-ec2';

Amazon Linux edition

Standard

Standard edition

Minimal

Minimal edition

AmazonLinuxGeneration (enum)

class @aws-cdk/aws-ec2.AmazonLinuxGeneration

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AmazonLinuxGeneration;
const { AmazonLinuxGeneration } = require('@aws-cdk/aws-ec2');
import { AmazonLinuxGeneration } from '@aws-cdk/aws-ec2';

What generation of Amazon Linux to use

AmazonLinux

Amazon Linux

AmazonLinux2

Amazon Linux 2

AmazonLinuxImage

class @aws-cdk/aws-ec2.AmazonLinuxImage([props])

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AmazonLinuxImage;
const { AmazonLinuxImage } = require('@aws-cdk/aws-ec2');
import { AmazonLinuxImage } from '@aws-cdk/aws-ec2';

Selects the latest version of Amazon Linux

The AMI ID is selected using the values published to the SSM parameter store.

Implements:IMachineImageSource
Parameters:props (AmazonLinuxImageProps (optional)) –
getImage(scope) → @aws-cdk/aws-ec2.MachineImage

Implements @aws-cdk/aws-ec2.IMachineImageSource.getImage()

Return the image to use in the given context

Parameters:scope (@aws-cdk/cdk.Construct) –
Return type:MachineImage

AmazonLinuxImageProps (interface)

class @aws-cdk/aws-ec2.AmazonLinuxImageProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AmazonLinuxImageProps;
// AmazonLinuxImageProps is an interface
import { AmazonLinuxImageProps } from '@aws-cdk/aws-ec2';

Amazon Linux image properties

edition

What edition of Amazon Linux to use

Type:AmazonLinuxEdition (optional) (readonly)
Default:Standard
generation

What generation of Amazon Linux to use

Type:AmazonLinuxGeneration (optional) (readonly)
Default:AmazonLinux
storage

What storage backed image to use

Type:AmazonLinuxStorage (optional) (readonly)
Default:GeneralPurpose
virtualization

Virtualization type

Type:AmazonLinuxVirt (optional) (readonly)
Default:HVM

AmazonLinuxStorage (enum)

class @aws-cdk/aws-ec2.AmazonLinuxStorage

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AmazonLinuxStorage;
const { AmazonLinuxStorage } = require('@aws-cdk/aws-ec2');
import { AmazonLinuxStorage } from '@aws-cdk/aws-ec2';
EBS

EBS-backed storage

GeneralPurpose

General Purpose-based storage (recommended)

AmazonLinuxVirt (enum)

class @aws-cdk/aws-ec2.AmazonLinuxVirt

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AmazonLinuxVirt;
const { AmazonLinuxVirt } = require('@aws-cdk/aws-ec2');
import { AmazonLinuxVirt } from '@aws-cdk/aws-ec2';

Virtualization type for Amazon Linux

HVM

HVM virtualization (recommended)

PV

PV virtualization

AnyIPv4

class @aws-cdk/aws-ec2.AnyIPv4

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AnyIPv4;
const { AnyIPv4 } = require('@aws-cdk/aws-ec2');
import { AnyIPv4 } from '@aws-cdk/aws-ec2';

Any IPv4 address

Extends:CidrIPv4
toEgressRuleJSON() → any

Inherited from @aws-cdk/aws-ec2.CidrIPv4

Produce the egress rule JSON for the given connection

Return type:any
toIngressRuleJSON() → any

Inherited from @aws-cdk/aws-ec2.CidrIPv4

Produce the ingress rule JSON for the given connection

Return type:any
canInlineRule

Inherited from @aws-cdk/aws-ec2.CidrIPv4

Whether the rule can be inlined into a SecurityGroup or not

Type:boolean (readonly)
cidrIp

Inherited from @aws-cdk/aws-ec2.CidrIPv4

Type:string (readonly)
connections

Inherited from @aws-cdk/aws-ec2.CidrIPv4

Type:Connections (readonly)
uniqueId

Inherited from @aws-cdk/aws-ec2.CidrIPv4

A unique identifier for this connection peer

Type:string (readonly)

AnyIPv6

class @aws-cdk/aws-ec2.AnyIPv6

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AnyIPv6;
const { AnyIPv6 } = require('@aws-cdk/aws-ec2');
import { AnyIPv6 } from '@aws-cdk/aws-ec2';

Any IPv6 address

Extends:CidrIPv6
toEgressRuleJSON() → any

Inherited from @aws-cdk/aws-ec2.CidrIPv6

Produce the egress rule JSON for the given connection

Return type:any
toIngressRuleJSON() → any

Inherited from @aws-cdk/aws-ec2.CidrIPv6

Produce the ingress rule JSON for the given connection

Return type:any
canInlineRule

Inherited from @aws-cdk/aws-ec2.CidrIPv6

Whether the rule can be inlined into a SecurityGroup or not

Type:boolean (readonly)
cidrIpv6

Inherited from @aws-cdk/aws-ec2.CidrIPv6

Type:string (readonly)
connections

Inherited from @aws-cdk/aws-ec2.CidrIPv6

Type:Connections (readonly)
uniqueId

Inherited from @aws-cdk/aws-ec2.CidrIPv6

A unique identifier for this connection peer

Type:string (readonly)

CfnCustomerGateway

class @aws-cdk/aws-ec2.CfnCustomerGateway(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnCustomerGateway;
const { CfnCustomerGateway } = require('@aws-cdk/aws-ec2');
import { CfnCustomerGateway } from '@aws-cdk/aws-ec2';

A CloudFormation AWS::EC2::CustomerGateway

Extends:

@aws-cdk/cdk.CfnResource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.CfnResource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
customerGatewayName
Type:string (readonly)
propertyOverrides
Type:CfnCustomerGatewayProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.CfnElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.CfnElement

Automatically detect references in this CfnElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.CfnElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.CfnElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.CfnElement

Return the path with respect to the stack

Type:string (readonly)
ref

Inherited from @aws-cdk/cdk.CfnRefElement

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
referenceToken

Inherited from @aws-cdk/cdk.CfnRefElement

Return a token that will CloudFormation { Ref } this stack element

Protected property

Type:@aws-cdk/cdk.Token (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.CfnResource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.CfnResource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.CfnResource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.CfnResource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
options

Inherited from @aws-cdk/cdk.CfnResource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.IResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.CfnResource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.CfnResource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.CfnResource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

CfnCustomerGatewayProps (interface)

class @aws-cdk/aws-ec2.CfnCustomerGatewayProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnCustomerGatewayProps;
// CfnCustomerGatewayProps is an interface
import { CfnCustomerGatewayProps } from '@aws-cdk/aws-ec2';

Properties for defining a AWS::EC2::CustomerGateway

bgpAsn

AWS::EC2::CustomerGateway.BgpAsn

Type:number or @aws-cdk/cdk.Token (readonly)
ipAddress

AWS::EC2::CustomerGateway.IpAddress

Type:string (readonly)
type

AWS::EC2::CustomerGateway.Type

Type:string (readonly)
tags

AWS::EC2::CustomerGateway.Tags

Type:@aws-cdk/cdk.CfnTag[] (optional) (readonly)

CfnDHCPOptions

class @aws-cdk/aws-ec2.CfnDHCPOptions(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnDHCPOptions;
const { CfnDHCPOptions } = require('@aws-cdk/aws-ec2');
import { CfnDHCPOptions } from '@aws-cdk/aws-ec2';

A CloudFormation AWS::EC2::DHCPOptions

Extends:

@aws-cdk/cdk.CfnResource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.CfnResource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
dhcpOptionsName
Type:string (readonly)
propertyOverrides
Type:CfnDHCPOptionsProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.CfnElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.CfnElement

Automatically detect references in this CfnElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.CfnElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.CfnElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.CfnElement

Return the path with respect to the stack

Type:string (readonly)
ref

Inherited from @aws-cdk/cdk.CfnRefElement

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
referenceToken

Inherited from @aws-cdk/cdk.CfnRefElement

Return a token that will CloudFormation { Ref } this stack element

Protected property

Type:@aws-cdk/cdk.Token (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.CfnResource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.CfnResource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.CfnResource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.CfnResource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
options

Inherited from @aws-cdk/cdk.CfnResource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.IResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.CfnResource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.CfnResource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.CfnResource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

CfnDHCPOptionsProps (interface)

class @aws-cdk/aws-ec2.CfnDHCPOptionsProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnDHCPOptionsProps;
// CfnDHCPOptionsProps is an interface
import { CfnDHCPOptionsProps } from '@aws-cdk/aws-ec2';

Properties for defining a AWS::EC2::DHCPOptions

domainName

AWS::EC2::DHCPOptions.DomainName

Type:string (optional) (readonly)
domainNameServers

AWS::EC2::DHCPOptions.DomainNameServers

Type:string[] (optional) (readonly)
netbiosNameServers

AWS::EC2::DHCPOptions.NetbiosNameServers

Type:string[] (optional) (readonly)
netbiosNodeType

AWS::EC2::DHCPOptions.NetbiosNodeType

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
ntpServers

AWS::EC2::DHCPOptions.NtpServers

Type:string[] (optional) (readonly)
tags

AWS::EC2::DHCPOptions.Tags

Type:@aws-cdk/cdk.CfnTag[] (optional) (readonly)

CfnEC2Fleet

class @aws-cdk/aws-ec2.CfnEC2Fleet(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnEC2Fleet;
const { CfnEC2Fleet } = require('@aws-cdk/aws-ec2');
import { CfnEC2Fleet } from '@aws-cdk/aws-ec2';

A CloudFormation AWS::EC2::EC2Fleet

Extends:

@aws-cdk/cdk.CfnResource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.CfnResource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
ec2FleetId
Type:string (readonly)
propertyOverrides
Type:CfnEC2FleetProps (readonly)
class FleetLaunchTemplateConfigRequestProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnEC2Fleet.FleetLaunchTemplateConfigRequestProperty;
// CfnEC2Fleet.FleetLaunchTemplateConfigRequestProperty is an interface
import { CfnEC2Fleet.FleetLaunchTemplateConfigRequestProperty } from '@aws-cdk/aws-ec2';
launchTemplateSpecification

CfnEC2Fleet.FleetLaunchTemplateConfigRequestProperty.LaunchTemplateSpecification

Type:@aws-cdk/cdk.Token or FleetLaunchTemplateSpecificationRequestProperty (optional) (readonly)
overrides

CfnEC2Fleet.FleetLaunchTemplateConfigRequestProperty.Overrides

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or FleetLaunchTemplateOverridesRequestProperty)[] (optional) (readonly)
class FleetLaunchTemplateOverridesRequestProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnEC2Fleet.FleetLaunchTemplateOverridesRequestProperty;
// CfnEC2Fleet.FleetLaunchTemplateOverridesRequestProperty is an interface
import { CfnEC2Fleet.FleetLaunchTemplateOverridesRequestProperty } from '@aws-cdk/aws-ec2';
availabilityZone

CfnEC2Fleet.FleetLaunchTemplateOverridesRequestProperty.AvailabilityZone

Type:string (optional) (readonly)
instanceType

CfnEC2Fleet.FleetLaunchTemplateOverridesRequestProperty.InstanceType

Type:string (optional) (readonly)
maxPrice

CfnEC2Fleet.FleetLaunchTemplateOverridesRequestProperty.MaxPrice

Type:string (optional) (readonly)
priority

CfnEC2Fleet.FleetLaunchTemplateOverridesRequestProperty.Priority

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
subnetId

CfnEC2Fleet.FleetLaunchTemplateOverridesRequestProperty.SubnetId

Type:string (optional) (readonly)
weightedCapacity

CfnEC2Fleet.FleetLaunchTemplateOverridesRequestProperty.WeightedCapacity

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
class FleetLaunchTemplateSpecificationRequestProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnEC2Fleet.FleetLaunchTemplateSpecificationRequestProperty;
// CfnEC2Fleet.FleetLaunchTemplateSpecificationRequestProperty is an interface
import { CfnEC2Fleet.FleetLaunchTemplateSpecificationRequestProperty } from '@aws-cdk/aws-ec2';
launchTemplateId

CfnEC2Fleet.FleetLaunchTemplateSpecificationRequestProperty.LaunchTemplateId

Type:string (optional) (readonly)
launchTemplateName

CfnEC2Fleet.FleetLaunchTemplateSpecificationRequestProperty.LaunchTemplateName

Type:string (optional) (readonly)
version

CfnEC2Fleet.FleetLaunchTemplateSpecificationRequestProperty.Version

Type:string (optional) (readonly)
class OnDemandOptionsRequestProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnEC2Fleet.OnDemandOptionsRequestProperty;
// CfnEC2Fleet.OnDemandOptionsRequestProperty is an interface
import { CfnEC2Fleet.OnDemandOptionsRequestProperty } from '@aws-cdk/aws-ec2';
allocationStrategy

CfnEC2Fleet.OnDemandOptionsRequestProperty.AllocationStrategy

Type:string (optional) (readonly)
class SpotOptionsRequestProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnEC2Fleet.SpotOptionsRequestProperty;
// CfnEC2Fleet.SpotOptionsRequestProperty is an interface
import { CfnEC2Fleet.SpotOptionsRequestProperty } from '@aws-cdk/aws-ec2';
allocationStrategy

CfnEC2Fleet.SpotOptionsRequestProperty.AllocationStrategy

Type:string (optional) (readonly)
instanceInterruptionBehavior

CfnEC2Fleet.SpotOptionsRequestProperty.InstanceInterruptionBehavior

Type:string (optional) (readonly)
instancePoolsToUseCount

CfnEC2Fleet.SpotOptionsRequestProperty.InstancePoolsToUseCount

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
class TagRequestProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnEC2Fleet.TagRequestProperty;
// CfnEC2Fleet.TagRequestProperty is an interface
import { CfnEC2Fleet.TagRequestProperty } from '@aws-cdk/aws-ec2';
key

CfnEC2Fleet.TagRequestProperty.Key

Type:string (optional) (readonly)
value

CfnEC2Fleet.TagRequestProperty.Value

Type:string (optional) (readonly)
class TagSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnEC2Fleet.TagSpecificationProperty;
// CfnEC2Fleet.TagSpecificationProperty is an interface
import { CfnEC2Fleet.TagSpecificationProperty } from '@aws-cdk/aws-ec2';
resourceType

CfnEC2Fleet.TagSpecificationProperty.ResourceType

Type:string (optional) (readonly)
tags

CfnEC2Fleet.TagSpecificationProperty.Tags

Type:TagRequestProperty[] (optional) (readonly)
class TargetCapacitySpecificationRequestProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnEC2Fleet.TargetCapacitySpecificationRequestProperty;
// CfnEC2Fleet.TargetCapacitySpecificationRequestProperty is an interface
import { CfnEC2Fleet.TargetCapacitySpecificationRequestProperty } from '@aws-cdk/aws-ec2';
totalTargetCapacity

CfnEC2Fleet.TargetCapacitySpecificationRequestProperty.TotalTargetCapacity

Type:number or @aws-cdk/cdk.Token (readonly)
defaultTargetCapacityType

CfnEC2Fleet.TargetCapacitySpecificationRequestProperty.DefaultTargetCapacityType

Type:string (optional) (readonly)
onDemandTargetCapacity

CfnEC2Fleet.TargetCapacitySpecificationRequestProperty.OnDemandTargetCapacity

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
spotTargetCapacity

CfnEC2Fleet.TargetCapacitySpecificationRequestProperty.SpotTargetCapacity

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.CfnElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.CfnElement

Automatically detect references in this CfnElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.CfnElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.CfnElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.CfnElement

Return the path with respect to the stack

Type:string (readonly)
ref

Inherited from @aws-cdk/cdk.CfnRefElement

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
referenceToken

Inherited from @aws-cdk/cdk.CfnRefElement

Return a token that will CloudFormation { Ref } this stack element

Protected property

Type:@aws-cdk/cdk.Token (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.CfnResource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.CfnResource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.CfnResource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.CfnResource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
options

Inherited from @aws-cdk/cdk.CfnResource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.IResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.CfnResource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.CfnResource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.CfnResource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

CfnEC2FleetProps (interface)

class @aws-cdk/aws-ec2.CfnEC2FleetProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnEC2FleetProps;
// CfnEC2FleetProps is an interface
import { CfnEC2FleetProps } from '@aws-cdk/aws-ec2';

Properties for defining a AWS::EC2::EC2Fleet

launchTemplateConfigs

AWS::EC2::EC2Fleet.LaunchTemplateConfigs

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or FleetLaunchTemplateConfigRequestProperty)[] (readonly)
targetCapacitySpecification

AWS::EC2::EC2Fleet.TargetCapacitySpecification

Type:@aws-cdk/cdk.Token or TargetCapacitySpecificationRequestProperty (readonly)
excessCapacityTerminationPolicy

AWS::EC2::EC2Fleet.ExcessCapacityTerminationPolicy

Type:string (optional) (readonly)
onDemandOptions

AWS::EC2::EC2Fleet.OnDemandOptions

Type:@aws-cdk/cdk.Token or OnDemandOptionsRequestProperty (optional) (readonly)
replaceUnhealthyInstances

AWS::EC2::EC2Fleet.ReplaceUnhealthyInstances

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)
spotOptions

AWS::EC2::EC2Fleet.SpotOptions

Type:@aws-cdk/cdk.Token or SpotOptionsRequestProperty (optional) (readonly)
tagSpecifications

AWS::EC2::EC2Fleet.TagSpecifications

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or TagSpecificationProperty)[] (optional) (readonly)
terminateInstancesWithExpiration

AWS::EC2::EC2Fleet.TerminateInstancesWithExpiration

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)
type

AWS::EC2::EC2Fleet.Type

Type:string (optional) (readonly)
validFrom

AWS::EC2::EC2Fleet.ValidFrom

Type:string (optional) (readonly)
validUntil

AWS::EC2::EC2Fleet.ValidUntil

Type:string (optional) (readonly)

CfnEIP

class @aws-cdk/aws-ec2.CfnEIP(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnEIP;
const { CfnEIP } = require('@aws-cdk/aws-ec2');
import { CfnEIP } from '@aws-cdk/aws-ec2';

A CloudFormation AWS::EC2::EIP

Extends:

@aws-cdk/cdk.CfnResource

Parameters:
  • scope (@aws-cdk/cdk.Construct) –
    • scope in which this resource is defined
  • id (string) –
    • scoped id of the resource
  • props (CfnEIPProps (optional)) –
    • resource properties
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.CfnResource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
eipAllocationId
Type:string (readonly)
eipIp
Type:string (readonly)
propertyOverrides
Type:CfnEIPProps (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.CfnElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.CfnElement

Automatically detect references in this CfnElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.CfnElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.CfnElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.CfnElement

Return the path with respect to the stack

Type:string (readonly)
ref

Inherited from @aws-cdk/cdk.CfnRefElement

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
referenceToken

Inherited from @aws-cdk/cdk.CfnRefElement

Return a token that will CloudFormation { Ref } this stack element

Protected property

Type:@aws-cdk/cdk.Token (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.CfnResource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.CfnResource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.CfnResource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.CfnResource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
options

Inherited from @aws-cdk/cdk.CfnResource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.IResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.CfnResource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.CfnResource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.CfnResource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

CfnEIPAssociation

class @aws-cdk/aws-ec2.CfnEIPAssociation(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnEIPAssociation;
const { CfnEIPAssociation } = require('@aws-cdk/aws-ec2');
import { CfnEIPAssociation } from '@aws-cdk/aws-ec2';

A CloudFormation AWS::EC2::EIPAssociation

Extends:

@aws-cdk/cdk.CfnResource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.CfnResource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
eipAssociationName
Type:string (readonly)
propertyOverrides
Type:CfnEIPAssociationProps (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.CfnElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.CfnElement

Automatically detect references in this CfnElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.CfnElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.CfnElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.CfnElement

Return the path with respect to the stack

Type:string (readonly)
ref

Inherited from @aws-cdk/cdk.CfnRefElement

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
referenceToken

Inherited from @aws-cdk/cdk.CfnRefElement

Return a token that will CloudFormation { Ref } this stack element

Protected property

Type:@aws-cdk/cdk.Token (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.CfnResource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.CfnResource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.CfnResource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.CfnResource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
options

Inherited from @aws-cdk/cdk.CfnResource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.IResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.CfnResource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.CfnResource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.CfnResource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

CfnEIPAssociationProps (interface)

class @aws-cdk/aws-ec2.CfnEIPAssociationProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnEIPAssociationProps;
// CfnEIPAssociationProps is an interface
import { CfnEIPAssociationProps } from '@aws-cdk/aws-ec2';

Properties for defining a AWS::EC2::EIPAssociation

allocationId

AWS::EC2::EIPAssociation.AllocationId

Type:string (optional) (readonly)
eip

AWS::EC2::EIPAssociation.EIP

Type:string (optional) (readonly)
instanceId

AWS::EC2::EIPAssociation.InstanceId

Type:string (optional) (readonly)
networkInterfaceId

AWS::EC2::EIPAssociation.NetworkInterfaceId

Type:string (optional) (readonly)
privateIpAddress

AWS::EC2::EIPAssociation.PrivateIpAddress

Type:string (optional) (readonly)

CfnEIPProps (interface)

class @aws-cdk/aws-ec2.CfnEIPProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnEIPProps;
// CfnEIPProps is an interface
import { CfnEIPProps } from '@aws-cdk/aws-ec2';

Properties for defining a AWS::EC2::EIP

domain

AWS::EC2::EIP.Domain

Type:string (optional) (readonly)
instanceId

AWS::EC2::EIP.InstanceId

Type:string (optional) (readonly)
publicIpv4Pool

AWS::EC2::EIP.PublicIpv4Pool

Type:string (optional) (readonly)

CfnEgressOnlyInternetGateway

class @aws-cdk/aws-ec2.CfnEgressOnlyInternetGateway(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnEgressOnlyInternetGateway;
const { CfnEgressOnlyInternetGateway } = require('@aws-cdk/aws-ec2');
import { CfnEgressOnlyInternetGateway } from '@aws-cdk/aws-ec2';

A CloudFormation AWS::EC2::EgressOnlyInternetGateway

Extends:

@aws-cdk/cdk.CfnResource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.CfnResource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
egressOnlyInternetGatewayId
Type:string (readonly)
propertyOverrides
Type:CfnEgressOnlyInternetGatewayProps (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.CfnElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.CfnElement

Automatically detect references in this CfnElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.CfnElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.CfnElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.CfnElement

Return the path with respect to the stack

Type:string (readonly)
ref

Inherited from @aws-cdk/cdk.CfnRefElement

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
referenceToken

Inherited from @aws-cdk/cdk.CfnRefElement

Return a token that will CloudFormation { Ref } this stack element

Protected property

Type:@aws-cdk/cdk.Token (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.CfnResource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.CfnResource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.CfnResource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.CfnResource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
options

Inherited from @aws-cdk/cdk.CfnResource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.IResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.CfnResource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.CfnResource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.CfnResource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

CfnEgressOnlyInternetGatewayProps (interface)

class @aws-cdk/aws-ec2.CfnEgressOnlyInternetGatewayProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnEgressOnlyInternetGatewayProps;
// CfnEgressOnlyInternetGatewayProps is an interface
import { CfnEgressOnlyInternetGatewayProps } from '@aws-cdk/aws-ec2';

Properties for defining a AWS::EC2::EgressOnlyInternetGateway

vpcId

AWS::EC2::EgressOnlyInternetGateway.VpcId

Type:string (readonly)

CfnFlowLog

class @aws-cdk/aws-ec2.CfnFlowLog(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnFlowLog;
const { CfnFlowLog } = require('@aws-cdk/aws-ec2');
import { CfnFlowLog } from '@aws-cdk/aws-ec2';

A CloudFormation AWS::EC2::FlowLog

Extends:

@aws-cdk/cdk.CfnResource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.CfnResource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
flowLogId
Type:string (readonly)
propertyOverrides
Type:CfnFlowLogProps (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.CfnElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.CfnElement

Automatically detect references in this CfnElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.CfnElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.CfnElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.CfnElement

Return the path with respect to the stack

Type:string (readonly)
ref

Inherited from @aws-cdk/cdk.CfnRefElement

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
referenceToken

Inherited from @aws-cdk/cdk.CfnRefElement

Return a token that will CloudFormation { Ref } this stack element

Protected property

Type:@aws-cdk/cdk.Token (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.CfnResource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.CfnResource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.CfnResource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.CfnResource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
options

Inherited from @aws-cdk/cdk.CfnResource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.IResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.CfnResource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.CfnResource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.CfnResource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

CfnFlowLogProps (interface)

class @aws-cdk/aws-ec2.CfnFlowLogProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnFlowLogProps;
// CfnFlowLogProps is an interface
import { CfnFlowLogProps } from '@aws-cdk/aws-ec2';

Properties for defining a AWS::EC2::FlowLog

resourceId

AWS::EC2::FlowLog.ResourceId

Type:string (readonly)
resourceType

AWS::EC2::FlowLog.ResourceType

Type:string (readonly)
trafficType

AWS::EC2::FlowLog.TrafficType

Type:string (readonly)
deliverLogsPermissionArn

AWS::EC2::FlowLog.DeliverLogsPermissionArn

Type:string (optional) (readonly)
logDestination

AWS::EC2::FlowLog.LogDestination

Type:string (optional) (readonly)
logDestinationType

AWS::EC2::FlowLog.LogDestinationType

Type:string (optional) (readonly)
logGroupName

AWS::EC2::FlowLog.LogGroupName

Type:string (optional) (readonly)

CfnHost

class @aws-cdk/aws-ec2.CfnHost(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnHost;
const { CfnHost } = require('@aws-cdk/aws-ec2');
import { CfnHost } from '@aws-cdk/aws-ec2';

A CloudFormation AWS::EC2::Host

Extends:

@aws-cdk/cdk.CfnResource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.CfnResource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
hostId
Type:string (readonly)
propertyOverrides
Type:CfnHostProps (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.CfnElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.CfnElement

Automatically detect references in this CfnElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.CfnElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.CfnElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.CfnElement

Return the path with respect to the stack

Type:string (readonly)
ref

Inherited from @aws-cdk/cdk.CfnRefElement

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
referenceToken

Inherited from @aws-cdk/cdk.CfnRefElement

Return a token that will CloudFormation { Ref } this stack element

Protected property

Type:@aws-cdk/cdk.Token (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.CfnResource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.CfnResource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.CfnResource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.CfnResource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
options

Inherited from @aws-cdk/cdk.CfnResource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.IResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.CfnResource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.CfnResource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.CfnResource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

CfnHostProps (interface)

class @aws-cdk/aws-ec2.CfnHostProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnHostProps;
// CfnHostProps is an interface
import { CfnHostProps } from '@aws-cdk/aws-ec2';

Properties for defining a AWS::EC2::Host

availabilityZone

AWS::EC2::Host.AvailabilityZone

Type:string (readonly)
instanceType

AWS::EC2::Host.InstanceType

Type:string (readonly)
autoPlacement

AWS::EC2::Host.AutoPlacement

Type:string (optional) (readonly)

CfnInstance

class @aws-cdk/aws-ec2.CfnInstance(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnInstance;
const { CfnInstance } = require('@aws-cdk/aws-ec2');
import { CfnInstance } from '@aws-cdk/aws-ec2';

A CloudFormation AWS::EC2::Instance

Extends:

@aws-cdk/cdk.CfnResource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.CfnResource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
instanceAvailabilityZone
Type:string (readonly)
instanceId
Type:string (readonly)
instancePrivateDnsName
Type:string (readonly)
instancePrivateIp
Type:string (readonly)
instancePublicDnsName
Type:string (readonly)
instancePublicIp
Type:string (readonly)
propertyOverrides
Type:CfnInstanceProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
class AssociationParameterProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnInstance.AssociationParameterProperty;
// CfnInstance.AssociationParameterProperty is an interface
import { CfnInstance.AssociationParameterProperty } from '@aws-cdk/aws-ec2';
key

CfnInstance.AssociationParameterProperty.Key

Type:string (readonly)
value

CfnInstance.AssociationParameterProperty.Value

Type:string[] (readonly)
class BlockDeviceMappingProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnInstance.BlockDeviceMappingProperty;
// CfnInstance.BlockDeviceMappingProperty is an interface
import { CfnInstance.BlockDeviceMappingProperty } from '@aws-cdk/aws-ec2';
deviceName

CfnInstance.BlockDeviceMappingProperty.DeviceName

Type:string (readonly)
ebs

CfnInstance.BlockDeviceMappingProperty.Ebs

Type:@aws-cdk/cdk.Token or EbsProperty (optional) (readonly)
noDevice

CfnInstance.BlockDeviceMappingProperty.NoDevice

Type:@aws-cdk/cdk.Token or NoDeviceProperty (optional) (readonly)
virtualName

CfnInstance.BlockDeviceMappingProperty.VirtualName

Type:string (optional) (readonly)
class CreditSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnInstance.CreditSpecificationProperty;
// CfnInstance.CreditSpecificationProperty is an interface
import { CfnInstance.CreditSpecificationProperty } from '@aws-cdk/aws-ec2';
cpuCredits

CfnInstance.CreditSpecificationProperty.CPUCredits

Type:string (optional) (readonly)
class EbsProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnInstance.EbsProperty;
// CfnInstance.EbsProperty is an interface
import { CfnInstance.EbsProperty } from '@aws-cdk/aws-ec2';
deleteOnTermination

CfnInstance.EbsProperty.DeleteOnTermination

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)
encrypted

CfnInstance.EbsProperty.Encrypted

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)
iops

CfnInstance.EbsProperty.Iops

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
snapshotId

CfnInstance.EbsProperty.SnapshotId

Type:string (optional) (readonly)
volumeSize

CfnInstance.EbsProperty.VolumeSize

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
volumeType

CfnInstance.EbsProperty.VolumeType

Type:string (optional) (readonly)
class ElasticGpuSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnInstance.ElasticGpuSpecificationProperty;
// CfnInstance.ElasticGpuSpecificationProperty is an interface
import { CfnInstance.ElasticGpuSpecificationProperty } from '@aws-cdk/aws-ec2';
type

CfnInstance.ElasticGpuSpecificationProperty.Type

Type:string (readonly)
class ElasticInferenceAcceleratorProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnInstance.ElasticInferenceAcceleratorProperty;
// CfnInstance.ElasticInferenceAcceleratorProperty is an interface
import { CfnInstance.ElasticInferenceAcceleratorProperty } from '@aws-cdk/aws-ec2';
type

CfnInstance.ElasticInferenceAcceleratorProperty.Type

Type:string (readonly)
class InstanceIpv6AddressProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnInstance.InstanceIpv6AddressProperty;
// CfnInstance.InstanceIpv6AddressProperty is an interface
import { CfnInstance.InstanceIpv6AddressProperty } from '@aws-cdk/aws-ec2';
ipv6Address

CfnInstance.InstanceIpv6AddressProperty.Ipv6Address

Type:string (readonly)
class LaunchTemplateSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnInstance.LaunchTemplateSpecificationProperty;
// CfnInstance.LaunchTemplateSpecificationProperty is an interface
import { CfnInstance.LaunchTemplateSpecificationProperty } from '@aws-cdk/aws-ec2';
version

CfnInstance.LaunchTemplateSpecificationProperty.Version

Type:string (readonly)
launchTemplateId

CfnInstance.LaunchTemplateSpecificationProperty.LaunchTemplateId

Type:string (optional) (readonly)
launchTemplateName

CfnInstance.LaunchTemplateSpecificationProperty.LaunchTemplateName

Type:string (optional) (readonly)
class LicenseSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnInstance.LicenseSpecificationProperty;
// CfnInstance.LicenseSpecificationProperty is an interface
import { CfnInstance.LicenseSpecificationProperty } from '@aws-cdk/aws-ec2';
licenseConfigurationArn

CfnInstance.LicenseSpecificationProperty.LicenseConfigurationArn

Type:string (readonly)
class NetworkInterfaceProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnInstance.NetworkInterfaceProperty;
// CfnInstance.NetworkInterfaceProperty is an interface
import { CfnInstance.NetworkInterfaceProperty } from '@aws-cdk/aws-ec2';
deviceIndex

CfnInstance.NetworkInterfaceProperty.DeviceIndex

Type:string (readonly)
associatePublicIpAddress

CfnInstance.NetworkInterfaceProperty.AssociatePublicIpAddress

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)
deleteOnTermination

CfnInstance.NetworkInterfaceProperty.DeleteOnTermination

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)
description

CfnInstance.NetworkInterfaceProperty.Description

Type:string (optional) (readonly)
groupSet

CfnInstance.NetworkInterfaceProperty.GroupSet

Type:string[] (optional) (readonly)
ipv6AddressCount

CfnInstance.NetworkInterfaceProperty.Ipv6AddressCount

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
ipv6Addresses

CfnInstance.NetworkInterfaceProperty.Ipv6Addresses

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or InstanceIpv6AddressProperty)[] (optional) (readonly)
networkInterfaceId

CfnInstance.NetworkInterfaceProperty.NetworkInterfaceId

Type:string (optional) (readonly)
privateIpAddress

CfnInstance.NetworkInterfaceProperty.PrivateIpAddress

Type:string (optional) (readonly)
privateIpAddresses

CfnInstance.NetworkInterfaceProperty.PrivateIpAddresses

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or PrivateIpAddressSpecificationProperty)[] (optional) (readonly)
secondaryPrivateIpAddressCount

CfnInstance.NetworkInterfaceProperty.SecondaryPrivateIpAddressCount

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
subnetId

CfnInstance.NetworkInterfaceProperty.SubnetId

Type:string (optional) (readonly)
class NoDeviceProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnInstance.NoDeviceProperty;
// CfnInstance.NoDeviceProperty is an interface
import { CfnInstance.NoDeviceProperty } from '@aws-cdk/aws-ec2';
class PrivateIpAddressSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnInstance.PrivateIpAddressSpecificationProperty;
// CfnInstance.PrivateIpAddressSpecificationProperty is an interface
import { CfnInstance.PrivateIpAddressSpecificationProperty } from '@aws-cdk/aws-ec2';
primary

CfnInstance.PrivateIpAddressSpecificationProperty.Primary

Type:boolean or @aws-cdk/cdk.Token (readonly)
privateIpAddress

CfnInstance.PrivateIpAddressSpecificationProperty.PrivateIpAddress

Type:string (readonly)
class SsmAssociationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnInstance.SsmAssociationProperty;
// CfnInstance.SsmAssociationProperty is an interface
import { CfnInstance.SsmAssociationProperty } from '@aws-cdk/aws-ec2';
documentName

CfnInstance.SsmAssociationProperty.DocumentName

Type:string (readonly)
associationParameters

CfnInstance.SsmAssociationProperty.AssociationParameters

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or AssociationParameterProperty)[] (optional) (readonly)
class VolumeProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnInstance.VolumeProperty;
// CfnInstance.VolumeProperty is an interface
import { CfnInstance.VolumeProperty } from '@aws-cdk/aws-ec2';
device

CfnInstance.VolumeProperty.Device

Type:string (readonly)
volumeId

CfnInstance.VolumeProperty.VolumeId

Type:string (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.CfnElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.CfnElement

Automatically detect references in this CfnElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.CfnElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.CfnElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.CfnElement

Return the path with respect to the stack

Type:string (readonly)
ref

Inherited from @aws-cdk/cdk.CfnRefElement

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
referenceToken

Inherited from @aws-cdk/cdk.CfnRefElement

Return a token that will CloudFormation { Ref } this stack element

Protected property

Type:@aws-cdk/cdk.Token (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.CfnResource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.CfnResource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.CfnResource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.CfnResource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
options

Inherited from @aws-cdk/cdk.CfnResource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.IResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.CfnResource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.CfnResource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.CfnResource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

CfnInstanceProps (interface)

class @aws-cdk/aws-ec2.CfnInstanceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnInstanceProps;
// CfnInstanceProps is an interface
import { CfnInstanceProps } from '@aws-cdk/aws-ec2';

Properties for defining a AWS::EC2::Instance

additionalInfo

AWS::EC2::Instance.AdditionalInfo

Type:string (optional) (readonly)
affinity

AWS::EC2::Instance.Affinity

Type:string (optional) (readonly)
availabilityZone

AWS::EC2::Instance.AvailabilityZone

Type:string (optional) (readonly)
blockDeviceMappings

AWS::EC2::Instance.BlockDeviceMappings

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or BlockDeviceMappingProperty)[] (optional) (readonly)
creditSpecification

AWS::EC2::Instance.CreditSpecification

Type:@aws-cdk/cdk.Token or CreditSpecificationProperty (optional) (readonly)
disableApiTermination

AWS::EC2::Instance.DisableApiTermination

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)
ebsOptimized

AWS::EC2::Instance.EbsOptimized

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)
elasticGpuSpecifications

AWS::EC2::Instance.ElasticGpuSpecifications

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ElasticGpuSpecificationProperty)[] (optional) (readonly)
elasticInferenceAccelerators

AWS::EC2::Instance.ElasticInferenceAccelerators

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ElasticInferenceAcceleratorProperty)[] (optional) (readonly)
hostId

AWS::EC2::Instance.HostId

Type:string (optional) (readonly)
iamInstanceProfile

AWS::EC2::Instance.IamInstanceProfile

Type:string (optional) (readonly)
imageId

AWS::EC2::Instance.ImageId

Type:string (optional) (readonly)
instanceInitiatedShutdownBehavior

AWS::EC2::Instance.InstanceInitiatedShutdownBehavior

Type:string (optional) (readonly)
instanceType

AWS::EC2::Instance.InstanceType

Type:string (optional) (readonly)
ipv6AddressCount

AWS::EC2::Instance.Ipv6AddressCount

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
ipv6Addresses

AWS::EC2::Instance.Ipv6Addresses

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or InstanceIpv6AddressProperty)[] (optional) (readonly)
kernelId

AWS::EC2::Instance.KernelId

Type:string (optional) (readonly)
keyName

AWS::EC2::Instance.KeyName

Type:string (optional) (readonly)
launchTemplate

AWS::EC2::Instance.LaunchTemplate

Type:@aws-cdk/cdk.Token or LaunchTemplateSpecificationProperty (optional) (readonly)
licenseSpecifications

AWS::EC2::Instance.LicenseSpecifications

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or LicenseSpecificationProperty)[] (optional) (readonly)
monitoring

AWS::EC2::Instance.Monitoring

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)
networkInterfaces

AWS::EC2::Instance.NetworkInterfaces

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or NetworkInterfaceProperty)[] (optional) (readonly)
placementGroupName

AWS::EC2::Instance.PlacementGroupName

Type:string (optional) (readonly)
privateIpAddress

AWS::EC2::Instance.PrivateIpAddress

Type:string (optional) (readonly)
ramdiskId

AWS::EC2::Instance.RamdiskId

Type:string (optional) (readonly)
securityGroupIds

AWS::EC2::Instance.SecurityGroupIds

Type:string[] (optional) (readonly)
securityGroups

AWS::EC2::Instance.SecurityGroups

Type:string[] (optional) (readonly)
sourceDestCheck

AWS::EC2::Instance.SourceDestCheck

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)
ssmAssociations

AWS::EC2::Instance.SsmAssociations

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or SsmAssociationProperty)[] (optional) (readonly)
subnetId

AWS::EC2::Instance.SubnetId

Type:string (optional) (readonly)
tags

AWS::EC2::Instance.Tags

Type:@aws-cdk/cdk.CfnTag[] (optional) (readonly)
tenancy

AWS::EC2::Instance.Tenancy

Type:string (optional) (readonly)
userData

AWS::EC2::Instance.UserData

Type:string (optional) (readonly)
volumes

AWS::EC2::Instance.Volumes

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or VolumeProperty)[] (optional) (readonly)

CfnInternetGateway

class @aws-cdk/aws-ec2.CfnInternetGateway(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnInternetGateway;
const { CfnInternetGateway } = require('@aws-cdk/aws-ec2');
import { CfnInternetGateway } from '@aws-cdk/aws-ec2';

A CloudFormation AWS::EC2::InternetGateway

Extends:

@aws-cdk/cdk.CfnResource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.CfnResource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
internetGatewayName
Type:string (readonly)
propertyOverrides
Type:CfnInternetGatewayProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.CfnElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.CfnElement

Automatically detect references in this CfnElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.CfnElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.CfnElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.CfnElement

Return the path with respect to the stack

Type:string (readonly)
ref

Inherited from @aws-cdk/cdk.CfnRefElement

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
referenceToken

Inherited from @aws-cdk/cdk.CfnRefElement

Return a token that will CloudFormation { Ref } this stack element

Protected property

Type:@aws-cdk/cdk.Token (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.CfnResource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.CfnResource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.CfnResource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.CfnResource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
options

Inherited from @aws-cdk/cdk.CfnResource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.IResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.CfnResource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.CfnResource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.CfnResource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

CfnInternetGatewayProps (interface)

class @aws-cdk/aws-ec2.CfnInternetGatewayProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnInternetGatewayProps;
// CfnInternetGatewayProps is an interface
import { CfnInternetGatewayProps } from '@aws-cdk/aws-ec2';

Properties for defining a AWS::EC2::InternetGateway

tags

AWS::EC2::InternetGateway.Tags

Type:@aws-cdk/cdk.CfnTag[] (optional) (readonly)

CfnLaunchTemplate

class @aws-cdk/aws-ec2.CfnLaunchTemplate(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnLaunchTemplate;
const { CfnLaunchTemplate } = require('@aws-cdk/aws-ec2');
import { CfnLaunchTemplate } from '@aws-cdk/aws-ec2';

A CloudFormation AWS::EC2::LaunchTemplate

Extends:

@aws-cdk/cdk.CfnResource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.CfnResource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
launchTemplateDefaultVersionNumber
Type:string (readonly)
launchTemplateId
Type:string (readonly)
launchTemplateLatestVersionNumber
Type:string (readonly)
propertyOverrides
Type:CfnLaunchTemplateProps (readonly)
class BlockDeviceMappingProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnLaunchTemplate.BlockDeviceMappingProperty;
// CfnLaunchTemplate.BlockDeviceMappingProperty is an interface
import { CfnLaunchTemplate.BlockDeviceMappingProperty } from '@aws-cdk/aws-ec2';
deviceName

CfnLaunchTemplate.BlockDeviceMappingProperty.DeviceName

Type:string (optional) (readonly)
ebs

CfnLaunchTemplate.BlockDeviceMappingProperty.Ebs

Type:@aws-cdk/cdk.Token or EbsProperty (optional) (readonly)
noDevice

CfnLaunchTemplate.BlockDeviceMappingProperty.NoDevice

Type:string (optional) (readonly)
virtualName

CfnLaunchTemplate.BlockDeviceMappingProperty.VirtualName

Type:string (optional) (readonly)
class CapacityReservationSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnLaunchTemplate.CapacityReservationSpecificationProperty;
// CfnLaunchTemplate.CapacityReservationSpecificationProperty is an interface
import { CfnLaunchTemplate.CapacityReservationSpecificationProperty } from '@aws-cdk/aws-ec2';
capacityReservationPreference

CfnLaunchTemplate.CapacityReservationSpecificationProperty.CapacityReservationPreference

Type:string (optional) (readonly)
capacityReservationTarget

CfnLaunchTemplate.CapacityReservationSpecificationProperty.CapacityReservationTarget

Type:@aws-cdk/cdk.Token or CapacityReservationTargetProperty (optional) (readonly)
class CapacityReservationTargetProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnLaunchTemplate.CapacityReservationTargetProperty;
// CfnLaunchTemplate.CapacityReservationTargetProperty is an interface
import { CfnLaunchTemplate.CapacityReservationTargetProperty } from '@aws-cdk/aws-ec2';
capacityReservationId

CfnLaunchTemplate.CapacityReservationTargetProperty.CapacityReservationId

Type:string (optional) (readonly)
class CpuOptionsProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnLaunchTemplate.CpuOptionsProperty;
// CfnLaunchTemplate.CpuOptionsProperty is an interface
import { CfnLaunchTemplate.CpuOptionsProperty } from '@aws-cdk/aws-ec2';
coreCount

CfnLaunchTemplate.CpuOptionsProperty.CoreCount

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
threadsPerCore

CfnLaunchTemplate.CpuOptionsProperty.ThreadsPerCore

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
class CreditSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnLaunchTemplate.CreditSpecificationProperty;
// CfnLaunchTemplate.CreditSpecificationProperty is an interface
import { CfnLaunchTemplate.CreditSpecificationProperty } from '@aws-cdk/aws-ec2';
cpuCredits

CfnLaunchTemplate.CreditSpecificationProperty.CpuCredits

Type:string (optional) (readonly)
class EbsProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnLaunchTemplate.EbsProperty;
// CfnLaunchTemplate.EbsProperty is an interface
import { CfnLaunchTemplate.EbsProperty } from '@aws-cdk/aws-ec2';
deleteOnTermination

CfnLaunchTemplate.EbsProperty.DeleteOnTermination

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)
encrypted

CfnLaunchTemplate.EbsProperty.Encrypted

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)
iops

CfnLaunchTemplate.EbsProperty.Iops

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
kmsKeyId

CfnLaunchTemplate.EbsProperty.KmsKeyId

Type:string (optional) (readonly)
snapshotId

CfnLaunchTemplate.EbsProperty.SnapshotId

Type:string (optional) (readonly)
volumeSize

CfnLaunchTemplate.EbsProperty.VolumeSize

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
volumeType

CfnLaunchTemplate.EbsProperty.VolumeType

Type:string (optional) (readonly)
class ElasticGpuSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnLaunchTemplate.ElasticGpuSpecificationProperty;
// CfnLaunchTemplate.ElasticGpuSpecificationProperty is an interface
import { CfnLaunchTemplate.ElasticGpuSpecificationProperty } from '@aws-cdk/aws-ec2';
type

CfnLaunchTemplate.ElasticGpuSpecificationProperty.Type

Type:string (optional) (readonly)
class HibernationOptionsProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnLaunchTemplate.HibernationOptionsProperty;
// CfnLaunchTemplate.HibernationOptionsProperty is an interface
import { CfnLaunchTemplate.HibernationOptionsProperty } from '@aws-cdk/aws-ec2';
configured

CfnLaunchTemplate.HibernationOptionsProperty.Configured

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)
class IamInstanceProfileProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnLaunchTemplate.IamInstanceProfileProperty;
// CfnLaunchTemplate.IamInstanceProfileProperty is an interface
import { CfnLaunchTemplate.IamInstanceProfileProperty } from '@aws-cdk/aws-ec2';
arn

CfnLaunchTemplate.IamInstanceProfileProperty.Arn

Type:string (optional) (readonly)
name

CfnLaunchTemplate.IamInstanceProfileProperty.Name

Type:string (optional) (readonly)
class InstanceMarketOptionsProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnLaunchTemplate.InstanceMarketOptionsProperty;
// CfnLaunchTemplate.InstanceMarketOptionsProperty is an interface
import { CfnLaunchTemplate.InstanceMarketOptionsProperty } from '@aws-cdk/aws-ec2';
marketType

CfnLaunchTemplate.InstanceMarketOptionsProperty.MarketType

Type:string (optional) (readonly)
spotOptions

CfnLaunchTemplate.InstanceMarketOptionsProperty.SpotOptions

Type:@aws-cdk/cdk.Token or SpotOptionsProperty (optional) (readonly)
class Ipv6AddProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnLaunchTemplate.Ipv6AddProperty;
// CfnLaunchTemplate.Ipv6AddProperty is an interface
import { CfnLaunchTemplate.Ipv6AddProperty } from '@aws-cdk/aws-ec2';
ipv6Address

CfnLaunchTemplate.Ipv6AddProperty.Ipv6Address

Type:string (optional) (readonly)
class LaunchTemplateDataProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnLaunchTemplate.LaunchTemplateDataProperty;
// CfnLaunchTemplate.LaunchTemplateDataProperty is an interface
import { CfnLaunchTemplate.LaunchTemplateDataProperty } from '@aws-cdk/aws-ec2';
blockDeviceMappings

CfnLaunchTemplate.LaunchTemplateDataProperty.BlockDeviceMappings

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or BlockDeviceMappingProperty)[] (optional) (readonly)
capacityReservationSpecification

CfnLaunchTemplate.LaunchTemplateDataProperty.CapacityReservationSpecification

Type:@aws-cdk/cdk.Token or CapacityReservationSpecificationProperty (optional) (readonly)
cpuOptions

CfnLaunchTemplate.LaunchTemplateDataProperty.CpuOptions

Type:@aws-cdk/cdk.Token or CpuOptionsProperty (optional) (readonly)
creditSpecification

CfnLaunchTemplate.LaunchTemplateDataProperty.CreditSpecification

Type:@aws-cdk/cdk.Token or CreditSpecificationProperty (optional) (readonly)
disableApiTermination

CfnLaunchTemplate.LaunchTemplateDataProperty.DisableApiTermination

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)
ebsOptimized

CfnLaunchTemplate.LaunchTemplateDataProperty.EbsOptimized

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)
elasticGpuSpecifications

CfnLaunchTemplate.LaunchTemplateDataProperty.ElasticGpuSpecifications

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ElasticGpuSpecificationProperty)[] (optional) (readonly)
elasticInferenceAccelerators

CfnLaunchTemplate.LaunchTemplateDataProperty.ElasticInferenceAccelerators

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or LaunchTemplateElasticInferenceAcceleratorProperty)[] (optional) (readonly)
hibernationOptions

CfnLaunchTemplate.LaunchTemplateDataProperty.HibernationOptions

Type:@aws-cdk/cdk.Token or HibernationOptionsProperty (optional) (readonly)
iamInstanceProfile

CfnLaunchTemplate.LaunchTemplateDataProperty.IamInstanceProfile

Type:@aws-cdk/cdk.Token or IamInstanceProfileProperty (optional) (readonly)
imageId

CfnLaunchTemplate.LaunchTemplateDataProperty.ImageId

Type:string (optional) (readonly)
instanceInitiatedShutdownBehavior

CfnLaunchTemplate.LaunchTemplateDataProperty.InstanceInitiatedShutdownBehavior

Type:string (optional) (readonly)
instanceMarketOptions

CfnLaunchTemplate.LaunchTemplateDataProperty.InstanceMarketOptions

Type:@aws-cdk/cdk.Token or InstanceMarketOptionsProperty (optional) (readonly)
instanceType

CfnLaunchTemplate.LaunchTemplateDataProperty.InstanceType

Type:string (optional) (readonly)
kernelId

CfnLaunchTemplate.LaunchTemplateDataProperty.KernelId

Type:string (optional) (readonly)
keyName

CfnLaunchTemplate.LaunchTemplateDataProperty.KeyName

Type:string (optional) (readonly)
licenseSpecifications

CfnLaunchTemplate.LaunchTemplateDataProperty.LicenseSpecifications

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or LicenseSpecificationProperty)[] (optional) (readonly)
monitoring

CfnLaunchTemplate.LaunchTemplateDataProperty.Monitoring

Type:@aws-cdk/cdk.Token or MonitoringProperty (optional) (readonly)
networkInterfaces

CfnLaunchTemplate.LaunchTemplateDataProperty.NetworkInterfaces

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or NetworkInterfaceProperty)[] (optional) (readonly)
placement

CfnLaunchTemplate.LaunchTemplateDataProperty.Placement

Type:@aws-cdk/cdk.Token or PlacementProperty (optional) (readonly)
ramDiskId

CfnLaunchTemplate.LaunchTemplateDataProperty.RamDiskId

Type:string (optional) (readonly)
securityGroupIds

CfnLaunchTemplate.LaunchTemplateDataProperty.SecurityGroupIds

Type:string[] (optional) (readonly)
securityGroups

CfnLaunchTemplate.LaunchTemplateDataProperty.SecurityGroups

Type:string[] (optional) (readonly)
tagSpecifications

CfnLaunchTemplate.LaunchTemplateDataProperty.TagSpecifications

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or TagSpecificationProperty)[] (optional) (readonly)
userData

CfnLaunchTemplate.LaunchTemplateDataProperty.UserData

Type:string (optional) (readonly)
class LaunchTemplateElasticInferenceAcceleratorProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnLaunchTemplate.LaunchTemplateElasticInferenceAcceleratorProperty;
// CfnLaunchTemplate.LaunchTemplateElasticInferenceAcceleratorProperty is an interface
import { CfnLaunchTemplate.LaunchTemplateElasticInferenceAcceleratorProperty } from '@aws-cdk/aws-ec2';
type

CfnLaunchTemplate.LaunchTemplateElasticInferenceAcceleratorProperty.Type

Type:string (optional) (readonly)
class LicenseSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnLaunchTemplate.LicenseSpecificationProperty;
// CfnLaunchTemplate.LicenseSpecificationProperty is an interface
import { CfnLaunchTemplate.LicenseSpecificationProperty } from '@aws-cdk/aws-ec2';
licenseConfigurationArn

CfnLaunchTemplate.LicenseSpecificationProperty.LicenseConfigurationArn

Type:string (optional) (readonly)
class MonitoringProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnLaunchTemplate.MonitoringProperty;
// CfnLaunchTemplate.MonitoringProperty is an interface
import { CfnLaunchTemplate.MonitoringProperty } from '@aws-cdk/aws-ec2';
enabled

CfnLaunchTemplate.MonitoringProperty.Enabled

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)
class NetworkInterfaceProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnLaunchTemplate.NetworkInterfaceProperty;
// CfnLaunchTemplate.NetworkInterfaceProperty is an interface
import { CfnLaunchTemplate.NetworkInterfaceProperty } from '@aws-cdk/aws-ec2';
associatePublicIpAddress

CfnLaunchTemplate.NetworkInterfaceProperty.AssociatePublicIpAddress

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)
deleteOnTermination

CfnLaunchTemplate.NetworkInterfaceProperty.DeleteOnTermination

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)
description

CfnLaunchTemplate.NetworkInterfaceProperty.Description

Type:string (optional) (readonly)
deviceIndex

CfnLaunchTemplate.NetworkInterfaceProperty.DeviceIndex

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
groups

CfnLaunchTemplate.NetworkInterfaceProperty.Groups

Type:string[] (optional) (readonly)
ipv6AddressCount

CfnLaunchTemplate.NetworkInterfaceProperty.Ipv6AddressCount

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
ipv6Addresses

CfnLaunchTemplate.NetworkInterfaceProperty.Ipv6Addresses

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or Ipv6AddProperty)[] (optional) (readonly)
networkInterfaceId

CfnLaunchTemplate.NetworkInterfaceProperty.NetworkInterfaceId

Type:string (optional) (readonly)
privateIpAddress

CfnLaunchTemplate.NetworkInterfaceProperty.PrivateIpAddress

Type:string (optional) (readonly)
privateIpAddresses

CfnLaunchTemplate.NetworkInterfaceProperty.PrivateIpAddresses

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or PrivateIpAddProperty)[] (optional) (readonly)
secondaryPrivateIpAddressCount

CfnLaunchTemplate.NetworkInterfaceProperty.SecondaryPrivateIpAddressCount

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
subnetId

CfnLaunchTemplate.NetworkInterfaceProperty.SubnetId

Type:string (optional) (readonly)
class PlacementProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnLaunchTemplate.PlacementProperty;
// CfnLaunchTemplate.PlacementProperty is an interface
import { CfnLaunchTemplate.PlacementProperty } from '@aws-cdk/aws-ec2';
affinity

CfnLaunchTemplate.PlacementProperty.Affinity

Type:string (optional) (readonly)
availabilityZone

CfnLaunchTemplate.PlacementProperty.AvailabilityZone

Type:string (optional) (readonly)
groupName

CfnLaunchTemplate.PlacementProperty.GroupName

Type:string (optional) (readonly)
hostId

CfnLaunchTemplate.PlacementProperty.HostId

Type:string (optional) (readonly)
tenancy

CfnLaunchTemplate.PlacementProperty.Tenancy

Type:string (optional) (readonly)
class PrivateIpAddProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnLaunchTemplate.PrivateIpAddProperty;
// CfnLaunchTemplate.PrivateIpAddProperty is an interface
import { CfnLaunchTemplate.PrivateIpAddProperty } from '@aws-cdk/aws-ec2';
primary

CfnLaunchTemplate.PrivateIpAddProperty.Primary

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)
privateIpAddress

CfnLaunchTemplate.PrivateIpAddProperty.PrivateIpAddress

Type:string (optional) (readonly)
class SpotOptionsProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnLaunchTemplate.SpotOptionsProperty;
// CfnLaunchTemplate.SpotOptionsProperty is an interface
import { CfnLaunchTemplate.SpotOptionsProperty } from '@aws-cdk/aws-ec2';
instanceInterruptionBehavior

CfnLaunchTemplate.SpotOptionsProperty.InstanceInterruptionBehavior

Type:string (optional) (readonly)
maxPrice

CfnLaunchTemplate.SpotOptionsProperty.MaxPrice

Type:string (optional) (readonly)
spotInstanceType

CfnLaunchTemplate.SpotOptionsProperty.SpotInstanceType

Type:string (optional) (readonly)
class TagSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnLaunchTemplate.TagSpecificationProperty;
// CfnLaunchTemplate.TagSpecificationProperty is an interface
import { CfnLaunchTemplate.TagSpecificationProperty } from '@aws-cdk/aws-ec2';
resourceType

CfnLaunchTemplate.TagSpecificationProperty.ResourceType

Type:string (optional) (readonly)
tags

CfnLaunchTemplate.TagSpecificationProperty.Tags

Type:@aws-cdk/cdk.CfnTag[] (optional) (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.CfnElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.CfnElement

Automatically detect references in this CfnElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.CfnElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.CfnElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.CfnElement

Return the path with respect to the stack

Type:string (readonly)
ref

Inherited from @aws-cdk/cdk.CfnRefElement

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
referenceToken

Inherited from @aws-cdk/cdk.CfnRefElement

Return a token that will CloudFormation { Ref } this stack element

Protected property

Type:@aws-cdk/cdk.Token (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.CfnResource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.CfnResource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.CfnResource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.CfnResource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
options

Inherited from @aws-cdk/cdk.CfnResource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.IResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.CfnResource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.CfnResource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.CfnResource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

CfnLaunchTemplateProps (interface)

class @aws-cdk/aws-ec2.CfnLaunchTemplateProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnLaunchTemplateProps;
// CfnLaunchTemplateProps is an interface
import { CfnLaunchTemplateProps } from '@aws-cdk/aws-ec2';

Properties for defining a AWS::EC2::LaunchTemplate

launchTemplateData

AWS::EC2::LaunchTemplate.LaunchTemplateData

Type:@aws-cdk/cdk.Token or LaunchTemplateDataProperty (optional) (readonly)
launchTemplateName

AWS::EC2::LaunchTemplate.LaunchTemplateName

Type:string (optional) (readonly)

CfnNatGateway

class @aws-cdk/aws-ec2.CfnNatGateway(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnNatGateway;
const { CfnNatGateway } = require('@aws-cdk/aws-ec2');
import { CfnNatGateway } from '@aws-cdk/aws-ec2';

A CloudFormation AWS::EC2::NatGateway

Extends:

@aws-cdk/cdk.CfnResource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.CfnResource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
natGatewayId
Type:string (readonly)
propertyOverrides
Type:CfnNatGatewayProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.CfnElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.CfnElement

Automatically detect references in this CfnElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.CfnElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.CfnElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.CfnElement

Return the path with respect to the stack

Type:string (readonly)
ref

Inherited from @aws-cdk/cdk.CfnRefElement

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
referenceToken

Inherited from @aws-cdk/cdk.CfnRefElement

Return a token that will CloudFormation { Ref } this stack element

Protected property

Type:@aws-cdk/cdk.Token (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.CfnResource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.CfnResource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.CfnResource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.CfnResource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
options

Inherited from @aws-cdk/cdk.CfnResource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.IResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.CfnResource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.CfnResource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.CfnResource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

CfnNatGatewayProps (interface)

class @aws-cdk/aws-ec2.CfnNatGatewayProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnNatGatewayProps;
// CfnNatGatewayProps is an interface
import { CfnNatGatewayProps } from '@aws-cdk/aws-ec2';

Properties for defining a AWS::EC2::NatGateway

allocationId

AWS::EC2::NatGateway.AllocationId

Type:string (readonly)
subnetId

AWS::EC2::NatGateway.SubnetId

Type:string (readonly)
tags

AWS::EC2::NatGateway.Tags

Type:@aws-cdk/cdk.CfnTag[] (optional) (readonly)

CfnNetworkAcl

class @aws-cdk/aws-ec2.CfnNetworkAcl(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnNetworkAcl;
const { CfnNetworkAcl } = require('@aws-cdk/aws-ec2');
import { CfnNetworkAcl } from '@aws-cdk/aws-ec2';

A CloudFormation AWS::EC2::NetworkAcl

Extends:

@aws-cdk/cdk.CfnResource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.CfnResource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
networkAclName
Type:string (readonly)
propertyOverrides
Type:CfnNetworkAclProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.CfnElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.CfnElement

Automatically detect references in this CfnElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.CfnElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.CfnElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.CfnElement

Return the path with respect to the stack

Type:string (readonly)
ref

Inherited from @aws-cdk/cdk.CfnRefElement

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
referenceToken

Inherited from @aws-cdk/cdk.CfnRefElement

Return a token that will CloudFormation { Ref } this stack element

Protected property

Type:@aws-cdk/cdk.Token (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.CfnResource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.CfnResource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.CfnResource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.CfnResource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
options

Inherited from @aws-cdk/cdk.CfnResource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.IResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.CfnResource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.CfnResource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.CfnResource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

CfnNetworkAclEntry

class @aws-cdk/aws-ec2.CfnNetworkAclEntry(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnNetworkAclEntry;
const { CfnNetworkAclEntry } = require('@aws-cdk/aws-ec2');
import { CfnNetworkAclEntry } from '@aws-cdk/aws-ec2';

A CloudFormation AWS::EC2::NetworkAclEntry

Extends:

@aws-cdk/cdk.CfnResource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.CfnResource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
networkAclEntryName
Type:string (readonly)
propertyOverrides
Type:CfnNetworkAclEntryProps (readonly)
class IcmpProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnNetworkAclEntry.IcmpProperty;
// CfnNetworkAclEntry.IcmpProperty is an interface
import { CfnNetworkAclEntry.IcmpProperty } from '@aws-cdk/aws-ec2';
code

CfnNetworkAclEntry.IcmpProperty.Code

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
type

CfnNetworkAclEntry.IcmpProperty.Type

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
class PortRangeProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnNetworkAclEntry.PortRangeProperty;
// CfnNetworkAclEntry.PortRangeProperty is an interface
import { CfnNetworkAclEntry.PortRangeProperty } from '@aws-cdk/aws-ec2';
from

CfnNetworkAclEntry.PortRangeProperty.From

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
to

CfnNetworkAclEntry.PortRangeProperty.To

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.CfnElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.CfnElement

Automatically detect references in this CfnElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.CfnElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.CfnElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.CfnElement

Return the path with respect to the stack

Type:string (readonly)
ref

Inherited from @aws-cdk/cdk.CfnRefElement

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
referenceToken

Inherited from @aws-cdk/cdk.CfnRefElement

Return a token that will CloudFormation { Ref } this stack element

Protected property

Type:@aws-cdk/cdk.Token (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.CfnResource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.CfnResource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.CfnResource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.CfnResource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
options

Inherited from @aws-cdk/cdk.CfnResource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.IResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.CfnResource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.CfnResource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.CfnResource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

CfnNetworkAclEntryProps (interface)

class @aws-cdk/aws-ec2.CfnNetworkAclEntryProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnNetworkAclEntryProps;
// CfnNetworkAclEntryProps is an interface
import { CfnNetworkAclEntryProps } from '@aws-cdk/aws-ec2';

Properties for defining a AWS::EC2::NetworkAclEntry

networkAclId

AWS::EC2::NetworkAclEntry.NetworkAclId

Type:string (readonly)
protocol

AWS::EC2::NetworkAclEntry.Protocol

Type:number or @aws-cdk/cdk.Token (readonly)
ruleAction

AWS::EC2::NetworkAclEntry.RuleAction

Type:string (readonly)
ruleNumber

AWS::EC2::NetworkAclEntry.RuleNumber

Type:number or @aws-cdk/cdk.Token (readonly)
cidrBlock

AWS::EC2::NetworkAclEntry.CidrBlock

Type:string (optional) (readonly)
egress

AWS::EC2::NetworkAclEntry.Egress

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)
icmp

AWS::EC2::NetworkAclEntry.Icmp

Type:@aws-cdk/cdk.Token or IcmpProperty (optional) (readonly)
ipv6CidrBlock

AWS::EC2::NetworkAclEntry.Ipv6CidrBlock

Type:string (optional) (readonly)
portRange

AWS::EC2::NetworkAclEntry.PortRange

Type:@aws-cdk/cdk.Token or PortRangeProperty (optional) (readonly)

CfnNetworkAclProps (interface)

class @aws-cdk/aws-ec2.CfnNetworkAclProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnNetworkAclProps;
// CfnNetworkAclProps is an interface
import { CfnNetworkAclProps } from '@aws-cdk/aws-ec2';

Properties for defining a AWS::EC2::NetworkAcl

vpcId

AWS::EC2::NetworkAcl.VpcId

Type:string (readonly)
tags

AWS::EC2::NetworkAcl.Tags

Type:@aws-cdk/cdk.CfnTag[] (optional) (readonly)

CfnNetworkInterface

class @aws-cdk/aws-ec2.CfnNetworkInterface(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnNetworkInterface;
const { CfnNetworkInterface } = require('@aws-cdk/aws-ec2');
import { CfnNetworkInterface } from '@aws-cdk/aws-ec2';

A CloudFormation AWS::EC2::NetworkInterface

Extends:

@aws-cdk/cdk.CfnResource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.CfnResource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
networkInterfaceName
Type:string (readonly)
networkInterfacePrimaryPrivateIpAddress
Type:string (readonly)
networkInterfaceSecondaryPrivateIpAddresses
Type:string[] (readonly)
propertyOverrides
Type:CfnNetworkInterfaceProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
class InstanceIpv6AddressProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnNetworkInterface.InstanceIpv6AddressProperty;
// CfnNetworkInterface.InstanceIpv6AddressProperty is an interface
import { CfnNetworkInterface.InstanceIpv6AddressProperty } from '@aws-cdk/aws-ec2';
ipv6Address

CfnNetworkInterface.InstanceIpv6AddressProperty.Ipv6Address

Type:string (readonly)
class PrivateIpAddressSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnNetworkInterface.PrivateIpAddressSpecificationProperty;
// CfnNetworkInterface.PrivateIpAddressSpecificationProperty is an interface
import { CfnNetworkInterface.PrivateIpAddressSpecificationProperty } from '@aws-cdk/aws-ec2';
primary

CfnNetworkInterface.PrivateIpAddressSpecificationProperty.Primary

Type:boolean or @aws-cdk/cdk.Token (readonly)
privateIpAddress

CfnNetworkInterface.PrivateIpAddressSpecificationProperty.PrivateIpAddress

Type:string (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.CfnElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.CfnElement

Automatically detect references in this CfnElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.CfnElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.CfnElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.CfnElement

Return the path with respect to the stack

Type:string (readonly)
ref

Inherited from @aws-cdk/cdk.CfnRefElement

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
referenceToken

Inherited from @aws-cdk/cdk.CfnRefElement

Return a token that will CloudFormation { Ref } this stack element

Protected property

Type:@aws-cdk/cdk.Token (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.CfnResource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.CfnResource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.CfnResource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.CfnResource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
options

Inherited from @aws-cdk/cdk.CfnResource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.IResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.CfnResource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.CfnResource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.CfnResource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

CfnNetworkInterfaceAttachment

class @aws-cdk/aws-ec2.CfnNetworkInterfaceAttachment(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnNetworkInterfaceAttachment;
const { CfnNetworkInterfaceAttachment } = require('@aws-cdk/aws-ec2');
import { CfnNetworkInterfaceAttachment } from '@aws-cdk/aws-ec2';

A CloudFormation AWS::EC2::NetworkInterfaceAttachment

Extends:

@aws-cdk/cdk.CfnResource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.CfnResource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
networkInterfaceAttachmentName
Type:string (readonly)
propertyOverrides
Type:CfnNetworkInterfaceAttachmentProps (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.CfnElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.CfnElement

Automatically detect references in this CfnElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.CfnElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.CfnElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.CfnElement

Return the path with respect to the stack

Type:string (readonly)
ref

Inherited from @aws-cdk/cdk.CfnRefElement

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
referenceToken

Inherited from @aws-cdk/cdk.CfnRefElement

Return a token that will CloudFormation { Ref } this stack element

Protected property

Type:@aws-cdk/cdk.Token (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.CfnResource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.CfnResource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.CfnResource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.CfnResource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
options

Inherited from @aws-cdk/cdk.CfnResource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.IResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.CfnResource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.CfnResource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.CfnResource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

CfnNetworkInterfaceAttachmentProps (interface)

class @aws-cdk/aws-ec2.CfnNetworkInterfaceAttachmentProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnNetworkInterfaceAttachmentProps;
// CfnNetworkInterfaceAttachmentProps is an interface
import { CfnNetworkInterfaceAttachmentProps } from '@aws-cdk/aws-ec2';

Properties for defining a AWS::EC2::NetworkInterfaceAttachment

deviceIndex

AWS::EC2::NetworkInterfaceAttachment.DeviceIndex

Type:string (readonly)
instanceId

AWS::EC2::NetworkInterfaceAttachment.InstanceId

Type:string (readonly)
networkInterfaceId

AWS::EC2::NetworkInterfaceAttachment.NetworkInterfaceId

Type:string (readonly)
deleteOnTermination

AWS::EC2::NetworkInterfaceAttachment.DeleteOnTermination

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)

CfnNetworkInterfacePermission

class @aws-cdk/aws-ec2.CfnNetworkInterfacePermission(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnNetworkInterfacePermission;
const { CfnNetworkInterfacePermission } = require('@aws-cdk/aws-ec2');
import { CfnNetworkInterfacePermission } from '@aws-cdk/aws-ec2';

A CloudFormation AWS::EC2::NetworkInterfacePermission

Extends:

@aws-cdk/cdk.CfnResource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.CfnResource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
networkInterfacePermissionId
Type:string (readonly)
propertyOverrides
Type:CfnNetworkInterfacePermissionProps (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.CfnElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.CfnElement

Automatically detect references in this CfnElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.CfnElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.CfnElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.CfnElement

Return the path with respect to the stack

Type:string (readonly)
ref

Inherited from @aws-cdk/cdk.CfnRefElement

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
referenceToken

Inherited from @aws-cdk/cdk.CfnRefElement

Return a token that will CloudFormation { Ref } this stack element

Protected property

Type:@aws-cdk/cdk.Token (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.CfnResource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.CfnResource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.CfnResource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.CfnResource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
options

Inherited from @aws-cdk/cdk.CfnResource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.IResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.CfnResource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.CfnResource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.CfnResource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

CfnNetworkInterfacePermissionProps (interface)

class @aws-cdk/aws-ec2.CfnNetworkInterfacePermissionProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnNetworkInterfacePermissionProps;
// CfnNetworkInterfacePermissionProps is an interface
import { CfnNetworkInterfacePermissionProps } from '@aws-cdk/aws-ec2';

Properties for defining a AWS::EC2::NetworkInterfacePermission

awsAccountId

AWS::EC2::NetworkInterfacePermission.AwsAccountId

Type:string (readonly)
networkInterfaceId

AWS::EC2::NetworkInterfacePermission.NetworkInterfaceId

Type:string (readonly)
permission

AWS::EC2::NetworkInterfacePermission.Permission

Type:string (readonly)

CfnNetworkInterfaceProps (interface)

class @aws-cdk/aws-ec2.CfnNetworkInterfaceProps

Language-specific names:

using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CfnNetworkInterfaceProps;
// CfnNetworkInterfaceProps is an interface
import { CfnNetworkInterfaceProps } from '@aws-cdk/aws-ec2';

Properties for defining a AWS::EC2::NetworkInterface

subnetId

AWS::EC2::NetworkInterface.SubnetId

Type:string (readonly)
description

AWS::EC2::NetworkInterface.Description

Type:string (optional) (readonly)
groupSet

AWS::EC2::NetworkInterface.GroupSet

Type:string[] (optional) (readonly)
interfaceType

AWS::EC2::NetworkInterface.InterfaceType

Type:string (optional) (readonly)
ipv6AddressCount

AWS::EC2::NetworkInterface.Ipv6AddressCount

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
ipv6Addresses

AWS::EC2::NetworkInterface.Ipv6Addresses

Type:@aws-cdk/cdk.Token or InstanceIpv6AddressProperty (optional) (readonly)
privateIpAddress

AWS::EC2::NetworkInterface.PrivateIpAddress