class CfnInstance (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.OpsWorks.CfnInstance`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsopsworks#CfnInstance`
Java	`software.amazon.awscdk.services.opsworks.CfnInstance`
Python	`aws_cdk.aws_opsworks.CfnInstance`
TypeScript	`aws-cdk-lib` » `aws_opsworks` » `CfnInstance`

Implements IConstruct, IDependable, IInspectable

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_opsworks as opsworks } from 'aws-cdk-lib';
const cfnInstance = new opsworks.CfnInstance(this, 'MyCfnInstance', {
  instanceType: 'instanceType',
  layerIds: ['layerIds'],
  stackId: 'stackId',

  // the properties below are optional
  agentVersion: 'agentVersion',
  amiId: 'amiId',
  architecture: 'architecture',
  autoScalingType: 'autoScalingType',
  availabilityZone: 'availabilityZone',
  blockDeviceMappings: [{
    deviceName: 'deviceName',
    ebs: {
      deleteOnTermination: false,
      iops: 123,
      snapshotId: 'snapshotId',
      volumeSize: 123,
      volumeType: 'volumeType',
    },
    noDevice: 'noDevice',
    virtualName: 'virtualName',
  }],
  ebsOptimized: false,
  elasticIps: ['elasticIps'],
  hostname: 'hostname',
  installUpdatesOnBoot: false,
  os: 'os',
  rootDeviceType: 'rootDeviceType',
  sshKeyName: 'sshKeyName',
  subnetId: 'subnetId',
  tenancy: 'tenancy',
  timeBasedAutoScaling: {
    friday: {
      fridayKey: 'friday',
    },
    monday: {
      mondayKey: 'monday',
    },
    saturday: {
      saturdayKey: 'saturday',
    },
    sunday: {
      sundayKey: 'sunday',
    },
    thursday: {
      thursdayKey: 'thursday',
    },
    tuesday: {
      tuesdayKey: 'tuesday',
    },
    wednesday: {
      wednesdayKey: 'wednesday',
    },
  },
  virtualizationType: 'virtualizationType',
  volumes: ['volumes'],
});

Initializer

new CfnInstance(scope: Construct, id: string, props: CfnInstanceProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnInstanceProps — Resource properties.

Construct Props

Name	Type	Description
instanceType	`string`	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.
layerIds	`string[]`	An array that contains the instance's layer IDs.
stackId	`string`	The stack ID.
agentVersion?	`string`	The default AWS OpsWorks Stacks agent version. You have the following options:.
amiId?	`string`	A custom AMI ID to be used to create the instance.
architecture?	`string`	The instance architecture.
autoScalingType?	`string`	For load-based or time-based instances, the type.
availabilityZone?	`string`	The Availability Zone of the AWS OpsWorks instance, such as `us-east-2a` .
blockDeviceMappings?	`IResolvable` `\|` `IResolvable` `\|` `BlockDeviceMappingProperty[]`	An array of `BlockDeviceMapping` objects that specify the instance's block devices.
ebsOptimized?	`boolean \|` `IResolvable`	Whether to create an Amazon EBS-optimized instance.
elasticIps?	`string[]`	A list of Elastic IP addresses to associate with the instance.
hostname?	`string`	The instance host name. The following are character limits for instance host names.
installUpdatesOnBoot?	`boolean \|` `IResolvable`	Whether to install operating system and package updates when the instance boots.
os?	`string`	The instance's operating system, which must be set to one of the following.
rootDeviceType?	`string`	The instance root device type.
sshKeyName?	`string`	The instance's Amazon EC2 key-pair name.
subnetId?	`string`	The ID of the instance's subnet.
tenancy?	`string`	The instance's tenancy option.
timeBasedAutoScaling?	`IResolvable` `\|` `TimeBasedAutoScalingProperty`	The time-based scaling configuration for the instance.
virtualizationType?	`string`	The instance's virtualization type, `paravirtual` or `hvm` .
volumes?	`string[]`	A list of AWS OpsWorks volume IDs to associate with the instance.

instanceType

Type: string

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.

layerIds

Type: string[]

An array that contains the instance's layer IDs.

stackId

Type: string

The stack ID.

agentVersion?

Type: string (optional)

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.

amiId?

Type: string (optional)

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 .

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

architecture?

Type: string (optional)

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 .

autoScalingType?

Type: string (optional)

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

Windows stacks can use only time-based instances.

availabilityZone?

Type: string (optional)

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

blockDeviceMappings?

Type: IResolvable | IResolvable | BlockDeviceMappingProperty[] (optional)

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.

ebsOptimized?

Type: boolean | IResolvable (optional)

Whether to create an Amazon EBS-optimized instance.

elasticIps?

Type: string[] (optional)

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

hostname?

Type: string (optional)

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

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

installUpdatesOnBoot?

Type: boolean | IResolvable (optional)

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.

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

os?

Type: string (optional)

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 .

rootDeviceType?

Type: string (optional)

The instance root device type.

For more information, see Storage for the Root Device .

sshKeyName?

Type: string (optional)

The instance's Amazon EC2 key-pair name.

subnetId?

Type: string (optional)

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?

Type: string (optional)

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 .

timeBasedAutoScaling?

Type: IResolvable | TimeBasedAutoScalingProperty (optional)

The time-based scaling configuration for the instance.

virtualizationType?

Type: string (optional)

The instance's virtualization type, paravirtual or hvm .

volumes?

Type: string[] (optional)

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

For more information, see AWS::OpsWorks::Volume .

Properties

Name	Type	Description
attrAvailabilityZone	`string`	The Availability Zone of the AWS OpsWorks instance, such as `us-east-2a` .
attrId	`string`
attrPrivateDnsName	`string`	The private DNS name of the AWS OpsWorks instance.
attrPrivateIp	`string`	The private IP address of the AWS OpsWorks instance, such as `192.0.2.0` .
attrPublicDnsName	`string`	The public DNS name of the AWS OpsWorks instance.
attrPublicIp	`string`	The public IP address of the AWS OpsWorks instance, such as `192.0.2.0` .
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
instanceType	`string`	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.
layerIds	`string[]`	An array that contains the instance's layer IDs.
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`Node`	The tree node.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
stackId	`string`	The stack ID.
agentVersion?	`string`	The default AWS OpsWorks Stacks agent version.
amiId?	`string`	A custom AMI ID to be used to create the instance.
architecture?	`string`	The instance architecture.
autoScalingType?	`string`	For load-based or time-based instances, the type.
availabilityZone?	`string`	The Availability Zone of the AWS OpsWorks instance, such as `us-east-2a` .
blockDeviceMappings?	`IResolvable` `\|` `IResolvable` `\|` `BlockDeviceMappingProperty[]`	An array of `BlockDeviceMapping` objects that specify the instance's block devices.
ebsOptimized?	`boolean \|` `IResolvable`	Whether to create an Amazon EBS-optimized instance.
elasticIps?	`string[]`	A list of Elastic IP addresses to associate with the instance.
hostname?	`string`	The instance host name.
installUpdatesOnBoot?	`boolean \|` `IResolvable`	Whether to install operating system and package updates when the instance boots.
os?	`string`	The instance's operating system, which must be set to one of the following.
rootDeviceType?	`string`	The instance root device type.
sshKeyName?	`string`	The instance's Amazon EC2 key-pair name.
subnetId?	`string`	The ID of the instance's subnet.
tenancy?	`string`	The instance's tenancy option.
timeBasedAutoScaling?	`IResolvable` `\|` `TimeBasedAutoScalingProperty`	The time-based scaling configuration for the instance.
virtualizationType?	`string`	The instance's virtualization type, `paravirtual` or `hvm` .
volumes?	`string[]`	A list of AWS OpsWorks volume IDs to associate with the instance.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrAvailabilityZone

Type: string

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

attrId

Type: string

attrPrivateDnsName

Type: string

The private DNS name of the AWS OpsWorks instance.

attrPrivateIp

Type: string

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

attrPublicDnsName

Type: string

The public DNS name of the AWS OpsWorks instance.

attrPublicIp

Type: string

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.

cfnOptions

Type: ICfnResourceOptions

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

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

instanceType

Type: string

layerIds

Type: string[]

An array that contains the instance's layer IDs.

logicalId

Type: string

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

node

Type: Node

The tree node.

ref

Type: string

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

stack

Type: Stack

The stack in which this element is defined.

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

stackId

Type: string

The stack ID.

agentVersion?

Type: string (optional)

The default AWS OpsWorks Stacks agent version.

You have the following options:.

amiId?

Type: string (optional)

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

architecture?

Type: string (optional)

The instance architecture.

autoScalingType?

Type: string (optional)

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

availabilityZone?

Type: string (optional)

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

blockDeviceMappings?

Type: IResolvable | IResolvable | BlockDeviceMappingProperty[] (optional)

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

ebsOptimized?

Type: boolean | IResolvable (optional)

Whether to create an Amazon EBS-optimized instance.

elasticIps?

Type: string[] (optional)

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

hostname?

Type: string (optional)

The instance host name.

The following are character limits for instance host names.

installUpdatesOnBoot?

Type: boolean | IResolvable (optional)

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

os?

Type: string (optional)

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

rootDeviceType?

Type: string (optional)

The instance root device type.

sshKeyName?

Type: string (optional)

The instance's Amazon EC2 key-pair name.

subnetId?

Type: string (optional)

The ID of the instance's subnet.

tenancy?

Type: string (optional)

The instance's tenancy option.

timeBasedAutoScaling?

Type: IResolvable | TimeBasedAutoScalingProperty (optional)

The time-based scaling configuration for the instance.

virtualizationType?

Type: string (optional)

The instance's virtualization type, paravirtual or hvm .

volumes?

Type: string[] (optional)

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

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

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.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

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

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

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

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The 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,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

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

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

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

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

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

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

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:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

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.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

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

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

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

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }