class Instance (construct)

Language	Type name
.NET	Amazon.CDK.AWS.EC2.Instance
Java	software.amazon.awscdk.services.ec2.Instance
Python	aws_cdk.aws_ec2.Instance
TypeScript (source)	@aws-cdk/aws-ec2 » Instance

Implements IConstruct, IConstruct, IDependable, IResource, IInstance, IConnectable, IGrantable

This represents a single EC2 instance.

Example

declare const vpc: ec2.Vpc;
declare const instanceType: ec2.InstanceType;
declare const machineImage: ec2.IMachineImage;

new ec2.Instance(this, 'Instance', {
  vpc,
  instanceType,
  machineImage,

  // ...

  blockDevices: [
    {
      deviceName: '/dev/sda1',
      volume: ec2.BlockDeviceVolume.ebs(50),
    },
    {
      deviceName: '/dev/sdm',
      volume: ec2.BlockDeviceVolume.ebs(100),
    },
  ],
});

Initializer

new Instance(scope: Construct, id: string, props: InstanceProps)

Parameters

• scope Construct
• id string
• props InstanceProps

Construct Props

Name	Type	Description
instanceType	InstanceType	Type of instance to launch.
machineImage	IMachineImage	AMI to launch.
vpc	IVpc	VPC to launch the instance in.
allowAllOutbound?	boolean	Whether the instance could initiate connections to anywhere by default.
availabilityZone?	string	In which AZ to place the instance within the VPC.
blockDevices?	BlockDevice[]	Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.
detailedMonitoring?	boolean	Whether "Detailed Monitoring" is enabled for this instance Keep in mind that Detailed Monitoring results in extra charges.
init?	CloudFormationInit	Apply the given CloudFormation Init configuration to the instance at startup.
initOptions?	ApplyCloudFormationInitOptions	Use the given options for applying CloudFormation Init.
instanceName?	string	The name of the instance.
keyName?	string	Name of SSH keypair to grant access to instance.
privateIpAddress?	string	Defines a private IP address to associate with an instance.
propagateTagsToVolumeOnCreation?	boolean	Propagate the EC2 instance tags to the EBS volumes.
requireImdsv2?	boolean	Whether IMDSv2 should be required on this instance.
resourceSignalTimeout?	Duration	The length of time to wait for the resourceSignalCount.
role?	IRole	An IAM role to associate with the instance profile assigned to this Auto Scaling Group.
securityGroup?	ISecurityGroup	Security Group to assign to this instance.
sourceDestCheck?	boolean	Specifies whether to enable an instance launched in a VPC to perform NAT.
userData?	UserData	Specific UserData to use.
userDataCausesReplacement?	boolean	Changes to the UserData force replacement.
vpcSubnets?	SubnetSelection	Where to place the instance within the VPC.

---

instanceType

Type: InstanceType

Type of instance to launch.

---

machineImage

Type: IMachineImage

AMI to launch.

---

vpc

Type: IVpc

VPC to launch the instance in.

---

allowAllOutbound?

Type: boolean (optional, default: true)

Whether the instance could initiate connections to anywhere by default.

This property is only used when you do not provide a security group.

---

availabilityZone?

Type: string (optional, default: Random zone.)

In which AZ to place the instance within the VPC.

---

blockDevices?

Type: BlockDevice[] (optional, default: Uses the block device mapping of the AMI)

Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.

Each instance that is launched has an associated root device volume, either an Amazon EBS volume or an instance store volume. You can use block device mappings to specify additional EBS volumes or instance store volumes to attach to an instance when it is launched.

See also: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html

---

detailedMonitoring?

Type: boolean (optional, default: false)

Whether "Detailed Monitoring" is enabled for this instance Keep in mind that Detailed Monitoring results in extra charges.

See also: http://aws.amazon.com/cloudwatch/pricing/

---

init?

Type: CloudFormationInit (optional, default: no CloudFormation init)

Apply the given CloudFormation Init configuration to the instance at startup.

---

initOptions?

Type: ApplyCloudFormationInitOptions (optional, default: default options)

Use the given options for applying CloudFormation Init.

Describes the configsets to use and the timeout to wait

---

instanceName?

Type: string (optional, default: CDK generated name)

The name of the instance.

---

keyName?

Type: string (optional, default: No SSH access will be possible.)

Name of SSH keypair to grant access to instance.

---

privateIpAddress?

Type: string (optional, default: no association)

Defines a private IP address to associate with an instance.

Private IP should be available within the VPC that the instance is build within.

---

propagateTagsToVolumeOnCreation?

Type: boolean (optional, default: false)

Propagate the EC2 instance tags to the EBS volumes.

---

requireImdsv2?

Type: boolean (optional, default: false)

Whether IMDSv2 should be required on this instance.

---

resourceSignalTimeout?

Type: Duration (optional, default: Duration.minutes(5))

The length of time to wait for the resourceSignalCount.

The maximum value is 43200 (12 hours).

---

role?

Type: IRole (optional, default: A role will automatically be created, it can be accessed via the role property)

An IAM role to associate with the instance profile assigned to this Auto Scaling Group.

The role must be assumable by the service principal ec2.amazonaws.com: Example

const role = new iam.Role(this, 'MyRole', {
  assumedBy: new iam.ServicePrincipal('ec2.amazonaws.com')
});

---

securityGroup?

Type: ISecurityGroup (optional, default: create new security group)

Security Group to assign to this instance.

---

sourceDestCheck?

Type: boolean (optional, default: true)

Specifies whether to enable an instance launched in a VPC to perform NAT.

This controls whether source/destination checking is enabled on the instance. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform NAT.

---

userData?

Type: UserData (optional, default: A UserData object appropriate for the MachineImage's Operating System is created.)

Specific UserData to use.

The UserData may still be mutated after creation.

---

userDataCausesReplacement?

Type: boolean (optional, default: true iff initOptions is specified, false otherwise.)

Changes to the UserData force replacement.

Depending the EC2 instance type, changing UserData either restarts the instance or replaces the instance.

• Instance store-backed instances are replaced.
• EBS-backed instances are restarted.

By default, restarting does not execute the new UserData so you will need a different mechanism to ensure the instance is restarted.

Setting this to true will make the instance's Logical ID depend on the UserData, which will cause CloudFormation to replace it if the UserData changes.

---

vpcSubnets?

Type: SubnetSelection (optional, default: Private subnets.)

Where to place the instance within the VPC.

Properties

Name	Type	Description
connections	Connections	Allows specify security group connections for the instance.
env	ResourceEnvironment	The environment this resource belongs to.
grantPrincipal	IPrincipal	The principal to grant permissions to.
instance	CfnInstance	the underlying instance resource.
instanceAvailabilityZone	string	The availability zone the instance was launched in.
instanceId	string	The instance's ID.
instancePrivateDnsName	string	Private DNS name for this instance.
instancePrivateIp	string	Private IP for this instance.
instancePublicDnsName	string	Publicly-routable DNS name for this instance.
instancePublicIp	string	Publicly-routable IP address for this instance.
node	ConstructNode	The construct tree node associated with this construct.
osType	OperatingSystemType	The type of OS the instance is running.
role	IRole	The IAM role assumed by the instance.
stack	Stack	The stack in which this resource is defined.
userData	UserData	UserData for the instance.

---

connections

Type: Connections

Allows specify security group connections for the instance.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

grantPrincipal

Type: IPrincipal

The principal to grant permissions to.

---

instance

Type: CfnInstance

the underlying instance resource.

---

instanceAvailabilityZone

Type: string

The availability zone the instance was launched in.

---

instanceId

Type: string

The instance's ID.

---

instancePrivateDnsName

Type: string

Private DNS name for this instance.

---

instancePrivateIp

Type: string

Private IP for this instance.

---

instancePublicDnsName

Type: string

Publicly-routable DNS name for this instance.

(May be an empty string if the instance does not have a public name).

---

instancePublicIp

Type: string

Publicly-routable IP address for this instance.

(May be an empty string if the instance does not have a public IP).

---

node

Type: ConstructNode

The construct tree node associated with this construct.

---

osType

Type: OperatingSystemType

The type of OS the instance is running.

---

role

Type: IRole

The IAM role assumed by the instance.

---

stack

Type: Stack

The stack in which this resource is defined.

---

userData

Type: UserData

UserData for the instance.

Methods

Name	Description
addSecurityGroup(securityGroup)	Add the security group to the instance.
addToRolePolicy(statement)	Adds a statement to the IAM role assumed by the instance.
addUserData(...commands)	Add command to the startup script of the instance.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.

---

addSecurityGroup(securityGroup)

public addSecurityGroup(securityGroup: ISecurityGroup): void

Parameters

• securityGroup ISecurityGroup — : The security group to add.

Add the security group to the instance.

---

addToRolePolicy(statement)

public addToRolePolicy(statement: PolicyStatement): void

Parameters

• statement PolicyStatement

Adds a statement to the IAM role assumed by the instance.

---

addUserData(...commands)

public addUserData(...commands: string[]): void

Parameters

• commands string

Add command to the startup script of the instance.

The command must be in the scripting language supported by the instance's OS (i.e. Linux/Windows).

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.