CfnInstanceProps

class aws_cdk.aws_opsworks.CfnInstanceProps(*, instance_type, layer_ids, stack_id, agent_version=None, ami_id=None, architecture=None, auto_scaling_type=None, availability_zone=None, block_device_mappings=None, ebs_optimized=None, elastic_ips=None, hostname=None, install_updates_on_boot=None, os=None, root_device_type=None, ssh_key_name=None, subnet_id=None, tenancy=None, time_based_auto_scaling=None, virtualization_type=None, volumes=None)

Bases: object

Properties for defining a CfnInstance.

Parameters:

instance_type (str) – The instance type, such as t2.micro . For a list of supported instance types, open the stack in the console, choose Instances , and choose + Instance . The Size list contains the currently supported types. For more information, see Instance Families and Types . The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.
layer_ids (Sequence[str]) – An array that contains the instance’s layer IDs.
stack_id (str) – The stack ID.
agent_version (Optional[str]) – The default AWS OpsWorks Stacks agent version. You have the following options:. - INHERIT - Use the stack’s default agent version setting. - version_number - Use the specified agent version. This value overrides the stack’s default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks installs that version on the instance. The default setting is INHERIT . To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions . AgentVersion cannot be set to Chef 12.2.
ami_id (Optional[str]) – A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs . .. epigraph:: If you specify a custom AMI, you must set Os to Custom .
architecture (Optional[str]) –
The instance architecture. The default option is x86_64 . Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types .
auto_scaling_type (Optional[str]) – For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
availability_zone (Optional[str]) – The Availability Zone of the AWS OpsWorks instance, such as us-east-2a .
block_device_mappings (Union[IResolvable, Sequence[Union[IResolvable, BlockDeviceMappingProperty, Dict[str, Any]]], None]) – An array of BlockDeviceMapping objects that specify the instance’s block devices. For more information, see Block Device Mapping . Note that block device mappings are not supported for custom AMIs.
ebs_optimized (Union[bool, IResolvable, None]) – Whether to create an Amazon EBS-optimized instance.
elastic_ips (Optional[Sequence[str]]) – A list of Elastic IP addresses to associate with the instance.
hostname (Optional[str]) – The instance host name. The following are character limits for instance host names. - Linux-based instances: 63 characters - Windows-based instances: 15 characters
install_updates_on_boot (Union[bool, IResolvable, None]) – Whether to install operating system and package updates when the instance boots. The default value is true . To control when updates are installed, set this value to false . You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances. .. epigraph:: We strongly recommend using the default value of true to ensure that your instances have the latest security updates.
os (Optional[str]) –
The instance’s operating system, which must be set to one of the following. - A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2 , Amazon Linux 2018.03 , Amazon Linux 2017.09 , Amazon Linux 2017.03 , Amazon Linux 2016.09 , Amazon Linux 2016.03 , Amazon Linux 2015.09 , or Amazon Linux 2015.03 . - A supported Ubuntu operating system, such as Ubuntu 18.04 LTS , Ubuntu 16.04 LTS , Ubuntu 14.04 LTS , or Ubuntu 12.04 LTS . - CentOS Linux 7 - Red Hat Enterprise Linux 7 - A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base , Microsoft Windows Server 2012 R2 with SQL Server Express , Microsoft Windows Server 2012 R2 with SQL Server Standard , or Microsoft Windows Server 2012 R2 with SQL Server Web . - A custom AMI: Custom . Not all operating systems are supported with all versions of Chef. For more information about the supported operating systems, see AWS OpsWorks Stacks Operating Systems . The default option is the current Amazon Linux version. If you set this parameter to Custom , you must use the CreateInstance action’s AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom . For more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs .
root_device_type (Optional[str]) – The instance root device type. For more information, see Storage for the Root Device .
ssh_key_name (Optional[str]) – The instance’s Amazon EC2 key-pair name.
subnet_id (Optional[str]) – The ID of the instance’s subnet. If the stack is running in a VPC, you can use this parameter to override the stack’s default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.
tenancy (Optional[str]) – The instance’s tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated , default , or host . Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts . For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances .
time_based_auto_scaling (Union[IResolvable, TimeBasedAutoScalingProperty, Dict[str, Any], None]) – The time-based scaling configuration for the instance.
virtualization_type (Optional[str]) – The instance’s virtualization type, paravirtual or hvm .
volumes (Optional[Sequence[str]]) – A list of AWS OpsWorks volume IDs to associate with the instance. For more information, see `AWS::OpsWorks::Volume <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html>`_ .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_opsworks as opsworks

cfn_instance_props = opsworks.CfnInstanceProps(
    instance_type="instanceType",
    layer_ids=["layerIds"],
    stack_id="stackId",

    # the properties below are optional
    agent_version="agentVersion",
    ami_id="amiId",
    architecture="architecture",
    auto_scaling_type="autoScalingType",
    availability_zone="availabilityZone",
    block_device_mappings=[opsworks.CfnInstance.BlockDeviceMappingProperty(
        device_name="deviceName",
        ebs=opsworks.CfnInstance.EbsBlockDeviceProperty(
            delete_on_termination=False,
            iops=123,
            snapshot_id="snapshotId",
            volume_size=123,
            volume_type="volumeType"
        ),
        no_device="noDevice",
        virtual_name="virtualName"
    )],
    ebs_optimized=False,
    elastic_ips=["elasticIps"],
    hostname="hostname",
    install_updates_on_boot=False,
    os="os",
    root_device_type="rootDeviceType",
    ssh_key_name="sshKeyName",
    subnet_id="subnetId",
    tenancy="tenancy",
    time_based_auto_scaling=opsworks.CfnInstance.TimeBasedAutoScalingProperty(
        friday={
            "friday_key": "friday"
        },
        monday={
            "monday_key": "monday"
        },
        saturday={
            "saturday_key": "saturday"
        },
        sunday={
            "sunday_key": "sunday"
        },
        thursday={
            "thursday_key": "thursday"
        },
        tuesday={
            "tuesday_key": "tuesday"
        },
        wednesday={
            "wednesday_key": "wednesday"
        }
    ),
    virtualization_type="virtualizationType",
    volumes=["volumes"]
)

Attributes

agent_version

.

INHERIT - Use the stack’s default agent version setting.
version_number - Use the specified agent version. This value overrides the stack’s default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks installs that version on the instance.

The default setting is INHERIT . To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions . AgentVersion cannot be set to Chef 12.2.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-agentversion
Type:: The default AWS OpsWorks Stacks agent version. You have the following options

ami_id

A custom AMI ID to be used to create the instance.

The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs . .. epigraph:

If you specify a custom AMI, you must set ``Os`` to ``Custom`` .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-amiid

architecture

The instance architecture.

The default option is x86_64 . Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-architecture

auto_scaling_type

For load-based or time-based instances, the type.

Windows stacks can use only time-based instances.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-autoscalingtype

availability_zone

The Availability Zone of the AWS OpsWorks instance, such as us-east-2a .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-availabilityzone

block_device_mappings

An array of BlockDeviceMapping objects that specify the instance’s block devices.

For more information, see Block Device Mapping . Note that block device mappings are not supported for custom AMIs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-blockdevicemappings

ebs_optimized

Whether to create an Amazon EBS-optimized instance.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-ebsoptimized

elastic_ips

A list of Elastic IP addresses to associate with the instance.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-elasticips

hostname

The instance host name. The following are character limits for instance host names.

Linux-based instances: 63 characters
Windows-based instances: 15 characters

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-hostname

install_updates_on_boot

Whether to install operating system and package updates when the instance boots.

The default value is true . To control when updates are installed, set this value to false . You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances. .. epigraph:

We strongly recommend using the default value of ``true`` to ensure that your instances have the latest security updates.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-installupdatesonboot

instance_type

//docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html>`_ . The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-instancetype
Type:: The instance type, such as t2.micro . For a list of supported instance types, open the stack in the console, choose Instances , and choose + Instance . The Size list contains the currently supported types. For more information, see `Instance Families and Types <https

layer_ids

An array that contains the instance’s layer IDs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-layerids

os

The instance’s operating system, which must be set to one of the following.

A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2 , Amazon Linux 2018.03 , Amazon Linux 2017.09 , Amazon Linux 2017.03 , Amazon Linux 2016.09 , Amazon Linux 2016.03 , Amazon Linux 2015.09 , or Amazon Linux 2015.03 .
A supported Ubuntu operating system, such as Ubuntu 18.04 LTS , Ubuntu 16.04 LTS , Ubuntu 14.04 LTS , or Ubuntu 12.04 LTS .
CentOS Linux 7
Red Hat Enterprise Linux 7
A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base , Microsoft Windows Server 2012 R2 with SQL Server Express , Microsoft Windows Server 2012 R2 with SQL Server Standard , or Microsoft Windows Server 2012 R2 with SQL Server Web .
A custom AMI: Custom .

Not all operating systems are supported with all versions of Chef. For more information about the supported operating systems, see AWS OpsWorks Stacks Operating Systems .

The default option is the current Amazon Linux version. If you set this parameter to Custom , you must use the CreateInstance action’s AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom . For more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-os

root_device_type

The instance root device type.

For more information, see Storage for the Root Device .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-rootdevicetype

ssh_key_name

The instance’s Amazon EC2 key-pair name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-sshkeyname

stack_id

The stack ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-stackid

subnet_id

The ID of the instance’s subnet.

If the stack is running in a VPC, you can use this parameter to override the stack’s default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-subnetid

tenancy

The instance’s tenancy option.

The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated , default , or host . Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts . For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-tenancy

time_based_auto_scaling

The time-based scaling configuration for the instance.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-timebasedautoscaling

virtualization_type

The instance’s virtualization type, paravirtual or hvm .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-virtualizationtype

volumes

A list of AWS OpsWorks volume IDs to associate with the instance.

For more information, see `AWS::OpsWorks::Volume <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html>`_ .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-volumes