interface IInstance

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

Implemented by BastionHostLinux, Instance

Properties

Name	Type	Description
connections	Connections	The network connections associated with this resource.
env	ResourceEnvironment	The environment this resource belongs to.
grantPrincipal	IPrincipal	The principal to grant permissions to.
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 for this construct.
stack	Stack	The stack in which this resource is defined.

---

connections

Type: Connections

The network connections associated with this resource.

---

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.

---

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 for this construct.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.

---

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).