Instance

class aws_cdk.aws_ec2.Instance(scope, id, *, instance_type, machine_image, vpc, allow_all_outbound=None, availability_zone=None, block_devices=None, init=None, init_options=None, instance_name=None, key_name=None, private_ip_address=None, resource_signal_timeout=None, role=None, security_group=None, source_dest_check=None, user_data=None, user_data_causes_replacement=None, vpc_subnets=None)

Bases: aws_cdk.core.Resource

This represents a single EC2 instance.

Parameters
  • scope (Construct) –

  • id (str) –

  • instance_type (InstanceType) – Type of instance to launch.

  • machine_image (IMachineImage) – AMI to launch.

  • vpc (IVpc) – VPC to launch the instance in.

  • allow_all_outbound (Optional[bool]) – Whether the instance could initiate connections to anywhere by default. This property is only used when you do not provide a security group. Default: true

  • availability_zone (Optional[str]) – In which AZ to place the instance within the VPC. Default: - Random zone.

  • block_devices (Optional[List[BlockDevice]]) – Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. Each instance that is launched has an associated root device volume, either an Amazon EBS volume or an instance store volume. You can use block device mappings to specify additional EBS volumes or instance store volumes to attach to an instance when it is launched. Default: - Uses the block device mapping of the AMI

  • init (Optional[CloudFormationInit]) – Apply the given CloudFormation Init configuration to the instance at startup. Default: - no CloudFormation init

  • init_options (Optional[ApplyCloudFormationInitOptions]) – Use the given options for applying CloudFormation Init. Describes the configsets to use and the timeout to wait Default: - default options

  • instance_name (Optional[str]) – The name of the instance. Default: - CDK generated name

  • key_name (Optional[str]) – Name of SSH keypair to grant access to instance. Default: - No SSH access will be possible.

  • private_ip_address (Optional[str]) – Defines a private IP address to associate with an instance. Private IP should be available within the VPC that the instance is build within. Default: - no association

  • resource_signal_timeout (Optional[Duration]) – The length of time to wait for the resourceSignalCount. The maximum value is 43200 (12 hours). Default: Duration.minutes(5)

  • role (Optional[IRole]) – An IAM role to associate with the instance profile assigned to this Auto Scaling Group. The role must be assumable by the service principal ec2.amazonaws.com: Default: - A role will automatically be created, it can be accessed via the role property

  • security_group (Optional[ISecurityGroup]) – Security Group to assign to this instance. Default: - create new security group

  • source_dest_check (Optional[bool]) – 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. Default: true

  • user_data (Optional[UserData]) – Specific UserData to use. The UserData may still be mutated after creation. Default: - A UserData object appropriate for the MachineImage’s Operating System is created.

  • user_data_causes_replacement (Optional[bool]) – 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. Default: - true iff initOptions is specified, false otherwise.

  • vpc_subnets (Optional[SubnetSelection]) – Where to place the instance within the VPC. Default: - Private subnets.

Methods

add_security_group(security_group)

Add the security group to the instance.

Parameters

security_group (ISecurityGroup) – : The security group to add.

Return type

None

add_to_role_policy(statement)

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

Parameters

statement (PolicyStatement) –

Return type

None

add_user_data(*commands)

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

Parameters

commands (str) –

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

connections

Allows specify security group connections for the instance.

Return type

Connections

env

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.

Return type

ResourceEnvironment

grant_principal

The principal to grant permissions to.

Return type

IPrincipal

instance

the underlying instance resource.

Return type

CfnInstance

instance_availability_zone

The availability zone the instance was launched in.

attribute: :attribute:: true

Return type

str

instance_id

The instance’s ID.

attribute: :attribute:: true

Return type

str

instance_private_dns_name

Private DNS name for this instance.

attribute: :attribute:: true

Return type

str

instance_private_ip

Private IP for this instance.

attribute: :attribute:: true

Return type

str

instance_public_dns_name

Publicly-routable DNS name for this instance.

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

attribute: :attribute:: true

Return type

str

instance_public_ip

Publicly-routable IP address for this instance.

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

attribute: :attribute:: true

Return type

str

node

The construct tree node associated with this construct.

Return type

ConstructNode

os_type

The type of OS the instance is running.

Return type

OperatingSystemType

role

The IAM role assumed by the instance.

Return type

IRole

stack

The stack in which this resource is defined.

Return type

Stack

user_data

UserData for the instance.

Return type

UserData

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool