CfnInstance

class aws_cdk.aws_opsworks.CfnInstance(scope, id, *, 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: CfnResource

A CloudFormation AWS::OpsWorks::Instance.

Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer .

Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .

CloudformationResource

AWS::OpsWorks::Instance

Link

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 = opsworks.CfnInstance(self, "MyCfnInstance",
    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"]
)

Create a new AWS::OpsWorks::Instance.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • 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[BlockDeviceMappingProperty, Dict[str, Any], IResolvable]], 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[TimeBasedAutoScalingProperty, Dict[str, Any], IResolvable, 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>`_ .

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::OpsWorks::Instance'
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.

Link

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

Return type

Optional[str]

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`` .
Link

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

Return type

Optional[str]

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 .

Link

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

Return type

Optional[str]

attr_availability_zone

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

CloudformationAttribute

AvailabilityZone

Return type

str

attr_private_dns_name

The private DNS name of the AWS OpsWorks instance.

CloudformationAttribute

PrivateDnsName

Return type

str

attr_private_ip

The private IP address of the AWS OpsWorks instance, such as 192.0.2.0 .

CloudformationAttribute

PrivateIp

Return type

str

attr_public_dns_name

The public DNS name of the AWS OpsWorks instance.

CloudformationAttribute

PublicDnsName

Return type

str

attr_public_ip

The public IP address of the AWS OpsWorks instance, such as 192.0.2.0 .

Use this attribute only when the AWS OpsWorks instance is in an AWS OpsWorks layer that auto-assigns public IP addresses.

CloudformationAttribute

PublicIp

Return type

str

auto_scaling_type

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

Windows stacks can use only time-based instances.

Link

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

Return type

Optional[str]

availability_zone

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

Link

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

Return type

Optional[str]

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.

Link

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

Return type

Union[IResolvable, List[Union[BlockDeviceMappingProperty, IResolvable]], None]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

ebs_optimized

Whether to create an Amazon EBS-optimized instance.

Link

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

Return type

Union[bool, IResolvable, None]

elastic_ips

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

Link

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

Return type

Optional[List[str]]

hostname

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

  • Linux-based instances: 63 characters

  • Windows-based instances: 15 characters

Link

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

Return type

Optional[str]

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

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

Return type

Union[bool, IResolvable, None]

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.

Link

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

Return type

str

layer_ids

An array that contains the instance’s layer IDs.

Link

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

Return type

List[str]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The tree node.

Return type

Node

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 .

Link

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

Return type

Optional[str]

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

root_device_type

The instance root device type.

For more information, see Storage for the Root Device .

Link

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

Return type

Optional[str]

ssh_key_name

The instance’s Amazon EC2 key-pair name.

Link

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

Return type

Optional[str]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

stack_id

The stack ID.

Link

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

Return type

str

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.

Link

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

Return type

Optional[str]

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 .

Link

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

Return type

Optional[str]

time_based_auto_scaling

The time-based scaling configuration for the instance.

Link

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

Return type

Union[TimeBasedAutoScalingProperty, IResolvable, None]

virtualization_type

The instance’s virtualization type, paravirtual or hvm .

Link

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

Return type

Optional[str]

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>`_ .

Link

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

Return type

Optional[List[str]]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

x (Any) – Any object.

Return type

bool

Returns

true if x is an object created from a class which extends Construct.

BlockDeviceMappingProperty

class CfnInstance.BlockDeviceMappingProperty(*, device_name=None, ebs=None, no_device=None, virtual_name=None)

Bases: object

Describes a block device mapping.

This data type maps directly to the Amazon EC2 BlockDeviceMapping data type.

Parameters
  • device_name (Optional[str]) – The device name that is exposed to the instance, such as /dev/sdh . For the root device, you can use the explicit device name or you can set this parameter to ROOT_DEVICE and AWS OpsWorks Stacks will provide the correct device name.

  • ebs (Union[EbsBlockDeviceProperty, Dict[str, Any], IResolvable, None]) – An EBSBlockDevice that defines how to configure an Amazon EBS volume when the instance is launched. You can specify either the VirtualName or Ebs , but not both.

  • no_device (Optional[str]) – Suppresses the specified device included in the AMI’s block device mapping.

  • virtual_name (Optional[str]) –

    The virtual device name. For more information, see BlockDeviceMapping . You can specify either the VirtualName or Ebs , but not both.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.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

block_device_mapping_property = 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"
)

Attributes

device_name

The device name that is exposed to the instance, such as /dev/sdh .

For the root device, you can use the explicit device name or you can set this parameter to ROOT_DEVICE and AWS OpsWorks Stacks will provide the correct device name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-devicename

Return type

Optional[str]

ebs

An EBSBlockDevice that defines how to configure an Amazon EBS volume when the instance is launched.

You can specify either the VirtualName or Ebs , but not both.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-ebs

Return type

Union[EbsBlockDeviceProperty, IResolvable, None]

no_device

Suppresses the specified device included in the AMI’s block device mapping.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-nodevice

Return type

Optional[str]

virtual_name

The virtual device name.

For more information, see BlockDeviceMapping . You can specify either the VirtualName or Ebs , but not both.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-virtualname

Return type

Optional[str]

EbsBlockDeviceProperty

class CfnInstance.EbsBlockDeviceProperty(*, delete_on_termination=None, iops=None, snapshot_id=None, volume_size=None, volume_type=None)

Bases: object

Describes an Amazon EBS volume.

This data type maps directly to the Amazon EC2 EbsBlockDevice data type.

Parameters
  • delete_on_termination (Union[bool, IResolvable, None]) – Whether the volume is deleted on instance termination.

  • iops (Union[int, float, None]) –

    The number of I/O operations per second (IOPS) that the volume supports. For more information, see EbsBlockDevice .

  • snapshot_id (Optional[str]) – The snapshot ID.

  • volume_size (Union[int, float, None]) –

    The volume size, in GiB. For more information, see EbsBlockDevice .

  • volume_type (Optional[str]) – The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 for Cold HDD,and standard for Magnetic volumes. If you specify the io1 volume type, you must also specify a value for the Iops attribute. The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. AWS uses the default volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume size).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.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

ebs_block_device_property = opsworks.CfnInstance.EbsBlockDeviceProperty(
    delete_on_termination=False,
    iops=123,
    snapshot_id="snapshotId",
    volume_size=123,
    volume_type="volumeType"
)

Attributes

delete_on_termination

Whether the volume is deleted on instance termination.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-deleteontermination

Return type

Union[bool, IResolvable, None]

iops

The number of I/O operations per second (IOPS) that the volume supports.

For more information, see EbsBlockDevice .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-iops

Return type

Union[int, float, None]

snapshot_id

The snapshot ID.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-snapshotid

Return type

Optional[str]

volume_size

The volume size, in GiB.

For more information, see EbsBlockDevice .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-volumesize

Return type

Union[int, float, None]

volume_type

The volume type.

gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 for Cold HDD,and standard for Magnetic volumes.

If you specify the io1 volume type, you must also specify a value for the Iops attribute. The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. AWS uses the default volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume size).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-volumetype

Return type

Optional[str]

TimeBasedAutoScalingProperty

class CfnInstance.TimeBasedAutoScalingProperty(*, friday=None, monday=None, saturday=None, sunday=None, thursday=None, tuesday=None, wednesday=None)

Bases: object

Describes an instance’s time-based auto scaling configuration.

Parameters
  • friday (Union[IResolvable, Mapping[str, str], None]) – The schedule for Friday.

  • monday (Union[IResolvable, Mapping[str, str], None]) – The schedule for Monday.

  • saturday (Union[IResolvable, Mapping[str, str], None]) – The schedule for Saturday.

  • sunday (Union[IResolvable, Mapping[str, str], None]) – The schedule for Sunday.

  • thursday (Union[IResolvable, Mapping[str, str], None]) – The schedule for Thursday.

  • tuesday (Union[IResolvable, Mapping[str, str], None]) – The schedule for Tuesday.

  • wednesday (Union[IResolvable, Mapping[str, str], None]) – The schedule for Wednesday.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.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

time_based_auto_scaling_property = 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"
    }
)

Attributes

friday

The schedule for Friday.

Link

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

Return type

Union[IResolvable, Mapping[str, str], None]

monday

The schedule for Monday.

Link

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

Return type

Union[IResolvable, Mapping[str, str], None]

saturday

The schedule for Saturday.

Link

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

Return type

Union[IResolvable, Mapping[str, str], None]

sunday

The schedule for Sunday.

Link

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

Return type

Union[IResolvable, Mapping[str, str], None]

thursday

The schedule for Thursday.

Link

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

Return type

Union[IResolvable, Mapping[str, str], None]

tuesday

The schedule for Tuesday.

Link

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

Return type

Union[IResolvable, Mapping[str, str], None]

wednesday

The schedule for Wednesday.

Link

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

Return type

Union[IResolvable, Mapping[str, str], None]