Package software.amazon.awscdk.services.opsworks

Interface CfnInstanceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnInstanceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:44.356Z")
@Stability(Stable)
public interface CfnInstanceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnInstance.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.opsworks.*;
 CfnInstanceProps cfnInstanceProps = CfnInstanceProps.builder()
         .instanceType("instanceType")
         .layerIds(List.of("layerIds"))
         .stackId("stackId")
         // the properties below are optional
         .agentVersion("agentVersion")
         .amiId("amiId")
         .architecture("architecture")
         .autoScalingType("autoScalingType")
         .availabilityZone("availabilityZone")
         .blockDeviceMappings(List.of(BlockDeviceMappingProperty.builder()
                 .deviceName("deviceName")
                 .ebs(EbsBlockDeviceProperty.builder()
                         .deleteOnTermination(false)
                         .iops(123)
                         .snapshotId("snapshotId")
                         .volumeSize(123)
                         .volumeType("volumeType")
                         .build())
                 .noDevice("noDevice")
                 .virtualName("virtualName")
                 .build()))
         .ebsOptimized(false)
         .elasticIps(List.of("elasticIps"))
         .hostname("hostname")
         .installUpdatesOnBoot(false)
         .os("os")
         .rootDeviceType("rootDeviceType")
         .sshKeyName("sshKeyName")
         .subnetId("subnetId")
         .tenancy("tenancy")
         .timeBasedAutoScaling(TimeBasedAutoScalingProperty.builder()
                 .friday(Map.of(
                         "fridayKey", "friday"))
                 .monday(Map.of(
                         "mondayKey", "monday"))
                 .saturday(Map.of(
                         "saturdayKey", "saturday"))
                 .sunday(Map.of(
                         "sundayKey", "sunday"))
                 .thursday(Map.of(
                         "thursdayKey", "thursday"))
                 .tuesday(Map.of(
                         "tuesdayKey", "tuesday"))
                 .wednesday(Map.of(
                         "wednesdayKey", "wednesday"))
                 .build())
         .virtualizationType("virtualizationType")
         .volumes(List.of("volumes"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnInstanceProps.Builder	A builder for CfnInstanceProps
static final class	CfnInstanceProps.Jsii$Proxy	An implementation for CfnInstanceProps

Method Summary

Modifier and Type	Method	Description
static CfnInstanceProps.Builder	builder()
default String	getAgentVersion()	The default OpsWorks Stacks agent version.
default String	getAmiId()	A custom AMI ID to be used to create the instance.
default String	getArchitecture()	The instance architecture.
default String	getAutoScalingType()	For load-based or time-based instances, the type.
default String	getAvailabilityZone()	The Availability Zone of the OpsWorks instance, such as us-east-2a .
default Object	getBlockDeviceMappings()	An array of BlockDeviceMapping objects that specify the instance's block devices.
default Object	getEbsOptimized()	Whether to create an Amazon EBS-optimized instance.
default List<String>	getElasticIps()	A list of Elastic IP addresses to associate with the instance.
default String	getHostname()	The instance host name.
default Object	getInstallUpdatesOnBoot()	Whether to install operating system and package updates when the instance boots.
String	getInstanceType()	The instance type, such as t2.micro .
List<String>	getLayerIds()	An array that contains the instance's layer IDs.
default String	getOs()	The instance's operating system, which must be set to one of the following.
default String	getRootDeviceType()	The instance root device type.
default String	getSshKeyName()	The instance's Amazon EC2 key-pair name.
String	getStackId()	The stack ID.
default String	getSubnetId()	The ID of the instance's subnet.
default String	getTenancy()	The instance's tenancy option.
default Object	getTimeBasedAutoScaling()	The time-based scaling configuration for the instance.
default String	getVirtualizationType()	The instance's virtualization type, paravirtual or hvm .
default List<String>	getVolumes()	A list of OpsWorks volume IDs to associate with the instance.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInstanceType

@Stability(Stable)
@NotNull
String getInstanceType()

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.

See Also:

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

getLayerIds

@Stability(Stable)
@NotNull
List<String> getLayerIds()

An array that contains the instance's layer IDs.

See Also:

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

getStackId

@Stability(Stable)
@NotNull
String getStackId()

The stack ID.

See Also:

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

getAgentVersion

@Stability(Stable)
@Nullable
default String getAgentVersion()

The default 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. 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 Also:

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

getAmiId

@Stability(Stable)
@Nullable
default String getAmiId()

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 .

See Also:

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

getArchitecture

@Stability(Stable)
@Nullable
default String getArchitecture()

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 Also:

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

getAutoScalingType

@Stability(Stable)
@Nullable
default String getAutoScalingType()

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

Windows stacks can use only time-based instances.

See Also:

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

getAvailabilityZone

@Stability(Stable)
@Nullable
default String getAvailabilityZone()

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

See Also:

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

getBlockDeviceMappings

@Stability(Stable)
@Nullable
default Object getBlockDeviceMappings()

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnInstance.BlockDeviceMappingProperty>

See Also:

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

getEbsOptimized

@Stability(Stable)
@Nullable
default Object getEbsOptimized()

Whether to create an Amazon EBS-optimized instance.

Returns union: either Boolean or IResolvable

See Also:

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

getElasticIps

@Stability(Stable)
@Nullable
default List<String> getElasticIps()

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

See Also:

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

getHostname

@Stability(Stable)
@Nullable
default String getHostname()

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

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

See Also:

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

getInstallUpdatesOnBoot

@Stability(Stable)
@Nullable
default Object getInstallUpdatesOnBoot()

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.

Returns union: either Boolean or IResolvable

See Also:

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

getOs

@Stability(Stable)
@Nullable
default String getOs()

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 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 OpsWorks Stacks, see Using Custom AMIs .

See Also:

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

getRootDeviceType

@Stability(Stable)
@Nullable
default String getRootDeviceType()

The instance root device type.

For more information, see Storage for the Root Device .

See Also:

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

getSshKeyName

@Stability(Stable)
@Nullable
default String getSshKeyName()

The instance's Amazon EC2 key-pair name.

See Also:

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

getSubnetId

@Stability(Stable)
@Nullable
default String getSubnetId()

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 OpsWorks Stacks to launch the instance in a different subnet.

See Also:

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

getTenancy

@Stability(Stable)
@Nullable
default String getTenancy()

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 Also:

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

getTimeBasedAutoScaling

@Stability(Stable)
@Nullable
default Object getTimeBasedAutoScaling()

The time-based scaling configuration for the instance.

Returns union: either IResolvable or CfnInstance.TimeBasedAutoScalingProperty

See Also:

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

getVirtualizationType

@Stability(Stable)
@Nullable
default String getVirtualizationType()

The instance's virtualization type, paravirtual or hvm .

See Also:

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

getVolumes

@Stability(Stable)
@Nullable
default List<String> getVolumes()

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

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

See Also:

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

builder

@Stability(Stable)
static CfnInstanceProps.Builder builder()

Returns:

a CfnInstanceProps.Builder of CfnInstanceProps