InstanceProps

class aws_cdk.aws_ec2.InstanceProps(*, instance_type, machine_image, vpc, allow_all_outbound=None, availability_zone=None, block_devices=None, detailed_monitoring=None, init=None, init_options=None, instance_name=None, key_name=None, private_ip_address=None, propagate_tags_to_volume_on_creation=None, require_imdsv2=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: object

Properties of an EC2 Instance.

Parameters:

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[Sequence[Union[BlockDevice, Dict[str, Any]]]]) – 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
detailed_monitoring (Optional[bool]) – Whether “Detailed Monitoring” is enabled for this instance Keep in mind that Detailed Monitoring results in extra charges. Default: - false
init (Optional[CloudFormationInit]) – Apply the given CloudFormation Init configuration to the instance at startup. Default: - no CloudFormation init
init_options (Union[ApplyCloudFormationInitOptions, Dict[str, Any], None]) – 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
propagate_tags_to_volume_on_creation (Optional[bool]) – Propagate the EC2 instance tags to the EBS volumes. Default: - false
require_imdsv2 (Optional[bool]) – Whether IMDSv2 should be required on this instance. Default: - false
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 (Union[SubnetSelection, Dict[str, Any], None]) – Where to place the instance within the VPC. Default: - Private subnets.

ExampleMetadata:

infused

Example:

# vpc: ec2.Vpc
# instance_type: ec2.InstanceType
# machine_image: ec2.IMachineImage


ec2.Instance(self, "Instance",
    vpc=vpc,
    instance_type=instance_type,
    machine_image=machine_image,

    # ...

    block_devices=[ec2.BlockDevice(
        device_name="/dev/sda1",
        volume=ec2.BlockDeviceVolume.ebs(50)
    ), ec2.BlockDevice(
        device_name="/dev/sdm",
        volume=ec2.BlockDeviceVolume.ebs(100)
    )
    ]
)

Attributes

allow_all_outbound

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

In which AZ to place the instance within the VPC.

Default:

Random zone.

block_devices

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

See:

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

detailed_monitoring

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

Default:

false

See:

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

init

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

Default:

no CloudFormation init

init_options

Use the given options for applying CloudFormation Init.

Describes the configsets to use and the timeout to wait

Default:

default options

instance_name

The name of the instance.

Default:

CDK generated name

instance_type: Type of instance to launch.

key_name

Name of SSH keypair to grant access to instance.

Default:

No SSH access will be possible.

machine_image: AMI to launch.

private_ip_address

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

propagate_tags_to_volume_on_creation

Propagate the EC2 instance tags to the EBS volumes.

Default:

false

require_imdsv2

Whether IMDSv2 should be required on this instance.

Default:

false

resource_signal_timeout

The length of time to wait for the resourceSignalCount.

The maximum value is 43200 (12 hours).

Default:: Duration.minutes(5)

role

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

Example:

role = iam.Role(self, "MyRole",
    assumed_by=iam.ServicePrincipal("ec2.amazonaws.com")
)

security_group

Security Group to assign to this instance.

Default:

create new security group

source_dest_check

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

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

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: VPC to launch the instance in.

vpc_subnets

Where to place the instance within the VPC.

Default:

Private subnets.