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: aws_cdk.core.CfnResource

A CloudFormation AWS::OpsWorks::Instance.

See

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

CloudformationResource

AWS::OpsWorks::Instance

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) – AWS::OpsWorks::Instance.InstanceType.

  • layer_ids (List[str]) – AWS::OpsWorks::Instance.LayerIds.

  • stack_id (str) – AWS::OpsWorks::Instance.StackId.

  • agent_version (Optional[str]) – AWS::OpsWorks::Instance.AgentVersion.

  • ami_id (Optional[str]) – AWS::OpsWorks::Instance.AmiId.

  • architecture (Optional[str]) – AWS::OpsWorks::Instance.Architecture.

  • auto_scaling_type (Optional[str]) – AWS::OpsWorks::Instance.AutoScalingType.

  • availability_zone (Optional[str]) – AWS::OpsWorks::Instance.AvailabilityZone.

  • block_device_mappings (Union[IResolvable, List[Union[IResolvable, BlockDeviceMappingProperty]], None]) – AWS::OpsWorks::Instance.BlockDeviceMappings.

  • ebs_optimized (Union[bool, IResolvable, None]) – AWS::OpsWorks::Instance.EbsOptimized.

  • elastic_ips (Optional[List[str]]) – AWS::OpsWorks::Instance.ElasticIps.

  • hostname (Optional[str]) – AWS::OpsWorks::Instance.Hostname.

  • install_updates_on_boot (Union[bool, IResolvable, None]) – AWS::OpsWorks::Instance.InstallUpdatesOnBoot.

  • os (Optional[str]) – AWS::OpsWorks::Instance.Os.

  • root_device_type (Optional[str]) – AWS::OpsWorks::Instance.RootDeviceType.

  • ssh_key_name (Optional[str]) – AWS::OpsWorks::Instance.SshKeyName.

  • subnet_id (Optional[str]) – AWS::OpsWorks::Instance.SubnetId.

  • tenancy (Optional[str]) – AWS::OpsWorks::Instance.Tenancy.

  • time_based_auto_scaling (Union[IResolvable, TimeBasedAutoScalingProperty, None]) – AWS::OpsWorks::Instance.TimeBasedAutoScaling.

  • virtualization_type (Optional[str]) – AWS::OpsWorks::Instance.VirtualizationType.

  • volumes (Optional[List[str]]) – AWS::OpsWorks::Instance.Volumes.

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 without compilation. See https://github.com/aws/jsii/issues/826
add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
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.

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.

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

inspect(inspector)

(experimental) Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Stability

experimental

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

AWS::OpsWorks::Instance.AgentVersion.

See

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

Return type

Optional[str]

ami_id

AWS::OpsWorks::Instance.AmiId.

See

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

Return type

Optional[str]

architecture

AWS::OpsWorks::Instance.Architecture.

See

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

Return type

Optional[str]

attr_availability_zone

AvailabilityZone

Type

cloudformationAttribute

Return type

str

attr_private_dns_name

PrivateDnsName

Type

cloudformationAttribute

Return type

str

attr_private_ip

PrivateIp

Type

cloudformationAttribute

Return type

str

attr_public_dns_name

PublicDnsName

Type

cloudformationAttribute

Return type

str

attr_public_ip

PublicIp

Type

cloudformationAttribute

Return type

str

auto_scaling_type

AWS::OpsWorks::Instance.AutoScalingType.

See

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

Return type

Optional[str]

availability_zone

AWS::OpsWorks::Instance.AvailabilityZone.

See

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

Return type

Optional[str]

block_device_mappings

AWS::OpsWorks::Instance.BlockDeviceMappings.

See

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

Return type

Union[IResolvable, List[Union[IResolvable, BlockDeviceMappingProperty]], 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

AWS::OpsWorks::Instance.EbsOptimized.

See

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

AWS::OpsWorks::Instance.ElasticIps.

See

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

Return type

Optional[List[str]]

hostname

AWS::OpsWorks::Instance.Hostname.

See

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

AWS::OpsWorks::Instance.InstallUpdatesOnBoot.

See

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

AWS::OpsWorks::Instance.InstanceType.

See

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

Return type

str

layer_ids

AWS::OpsWorks::Instance.LayerIds.

See

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 construct tree node associated with this construct.

Return type

ConstructNode

os

AWS::OpsWorks::Instance.Os.

See

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

AWS::OpsWorks::Instance.RootDeviceType.

See

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

Return type

Optional[str]

ssh_key_name

AWS::OpsWorks::Instance.SshKeyName.

See

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

AWS::OpsWorks::Instance.StackId.

See

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

Return type

str

subnet_id

AWS::OpsWorks::Instance.SubnetId.

See

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

Return type

Optional[str]

tenancy

AWS::OpsWorks::Instance.Tenancy.

See

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

AWS::OpsWorks::Instance.TimeBasedAutoScaling.

See

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

Return type

Union[IResolvable, TimeBasedAutoScalingProperty, None]

virtualization_type

AWS::OpsWorks::Instance.VirtualizationType.

See

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

Return type

Optional[str]

volumes

AWS::OpsWorks::Instance.Volumes.

See

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)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

BlockDeviceMappingProperty

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

Bases: object

Parameters
  • device_name (Optional[str]) – CfnInstance.BlockDeviceMappingProperty.DeviceName.

  • ebs (Union[IResolvable, EbsBlockDeviceProperty, None]) – CfnInstance.BlockDeviceMappingProperty.Ebs.

  • no_device (Optional[str]) – CfnInstance.BlockDeviceMappingProperty.NoDevice.

  • virtual_name (Optional[str]) – CfnInstance.BlockDeviceMappingProperty.VirtualName.

See

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

Attributes

device_name

CfnInstance.BlockDeviceMappingProperty.DeviceName.

See

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

Return type

Optional[str]

ebs

CfnInstance.BlockDeviceMappingProperty.Ebs.

See

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

Return type

Union[IResolvable, EbsBlockDeviceProperty, None]

no_device

CfnInstance.BlockDeviceMappingProperty.NoDevice.

See

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

CfnInstance.BlockDeviceMappingProperty.VirtualName.

See

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

Parameters
  • delete_on_termination (Union[bool, IResolvable, None]) – CfnInstance.EbsBlockDeviceProperty.DeleteOnTermination.

  • iops (Union[int, float, None]) – CfnInstance.EbsBlockDeviceProperty.Iops.

  • snapshot_id (Optional[str]) – CfnInstance.EbsBlockDeviceProperty.SnapshotId.

  • volume_size (Union[int, float, None]) – CfnInstance.EbsBlockDeviceProperty.VolumeSize.

  • volume_type (Optional[str]) – CfnInstance.EbsBlockDeviceProperty.VolumeType.

See

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

Attributes

delete_on_termination

CfnInstance.EbsBlockDeviceProperty.DeleteOnTermination.

See

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

CfnInstance.EbsBlockDeviceProperty.Iops.

See

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

CfnInstance.EbsBlockDeviceProperty.SnapshotId.

See

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

CfnInstance.EbsBlockDeviceProperty.VolumeSize.

See

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

CfnInstance.EbsBlockDeviceProperty.VolumeType.

See

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

Parameters
  • friday (Union[IResolvable, Mapping[str, str], None]) – CfnInstance.TimeBasedAutoScalingProperty.Friday.

  • monday (Union[IResolvable, Mapping[str, str], None]) – CfnInstance.TimeBasedAutoScalingProperty.Monday.

  • saturday (Union[IResolvable, Mapping[str, str], None]) – CfnInstance.TimeBasedAutoScalingProperty.Saturday.

  • sunday (Union[IResolvable, Mapping[str, str], None]) – CfnInstance.TimeBasedAutoScalingProperty.Sunday.

  • thursday (Union[IResolvable, Mapping[str, str], None]) – CfnInstance.TimeBasedAutoScalingProperty.Thursday.

  • tuesday (Union[IResolvable, Mapping[str, str], None]) – CfnInstance.TimeBasedAutoScalingProperty.Tuesday.

  • wednesday (Union[IResolvable, Mapping[str, str], None]) – CfnInstance.TimeBasedAutoScalingProperty.Wednesday.

See

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

Attributes

friday

CfnInstance.TimeBasedAutoScalingProperty.Friday.

See

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

CfnInstance.TimeBasedAutoScalingProperty.Monday.

See

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

CfnInstance.TimeBasedAutoScalingProperty.Saturday.

See

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

CfnInstance.TimeBasedAutoScalingProperty.Sunday.

See

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

CfnInstance.TimeBasedAutoScalingProperty.Thursday.

See

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

CfnInstance.TimeBasedAutoScalingProperty.Tuesday.

See

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

CfnInstance.TimeBasedAutoScalingProperty.Wednesday.

See

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]