Package software.amazon.awscdk.services.opsworks

Class CfnInstance

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.opsworks.CfnInstance
All Implemented Interfaces:
IInspectable, IInstanceRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:44.351Z") @Stability(Stable) public class CfnInstance extends CfnResource implements IInspectable, IInstanceRef
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 software.amazon.awscdk.services.opsworks.*;
 CfnInstance cfnInstance = CfnInstance.Builder.create(this, "MyCfnInstance")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnInstance

      protected CfnInstance(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnInstance

      protected CfnInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnInstance

      @Stability(Stable) public CfnInstance(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnInstanceProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAvailabilityZone

      @Stability(Stable) @NotNull public String getAttrAvailabilityZone()
      The Availability Zone of the OpsWorks instance, such as us-east-2a .

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getAttrPrivateDnsName

      @Stability(Stable) @NotNull public String getAttrPrivateDnsName()
      The private DNS name of the OpsWorks instance.

    • getAttrPrivateIp

      @Stability(Stable) @NotNull public String getAttrPrivateIp()
      The private IP address of the OpsWorks instance, such as 192.0.2.0 .

    • getAttrPublicDnsName

      @Stability(Stable) @NotNull public String getAttrPublicDnsName()
      The public DNS name of the OpsWorks instance.

    • getAttrPublicIp

      @Stability(Stable) @NotNull public String getAttrPublicIp()
      The public IP address of the OpsWorks instance, such as 192.0.2.0 .

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

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getInstanceRef

      @Stability(Stable) @NotNull public InstanceReference getInstanceRef()
      A reference to a Instance resource.
      Specified by:
      getInstanceRef in interface IInstanceRef

    • getInstanceType

      @Stability(Stable) @NotNull public 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.

    • setInstanceType

      @Stability(Stable) public void setInstanceType(@NotNull String value)
      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.

    • getLayerIds

      @Stability(Stable) @NotNull public List<String> getLayerIds()
      An array that contains the instance's layer IDs.

    • setLayerIds

      @Stability(Stable) public void setLayerIds(@NotNull List<String> value)
      An array that contains the instance's layer IDs.

    • getStackId

      @Stability(Stable) @NotNull public String getStackId()
      The stack ID.

    • setStackId

      @Stability(Stable) public void setStackId(@NotNull String value)
      The stack ID.

    • getAgentVersion

      @Stability(Stable) @Nullable public String getAgentVersion()
      The default OpsWorks Stacks agent version.

      You have the following options:.

    • setAgentVersion

      @Stability(Stable) public void setAgentVersion(@Nullable String value)
      The default OpsWorks Stacks agent version.

      You have the following options:.

    • getAmiId

      @Stability(Stable) @Nullable public String getAmiId()
      A custom AMI ID to be used to create the instance.

    • setAmiId

      @Stability(Stable) public void setAmiId(@Nullable String value)
      A custom AMI ID to be used to create the instance.

    • getArchitecture

      @Stability(Stable) @Nullable public String getArchitecture()
      The instance architecture.

    • setArchitecture

      @Stability(Stable) public void setArchitecture(@Nullable String value)
      The instance architecture.

    • getAutoScalingType

      @Stability(Stable) @Nullable public String getAutoScalingType()
      For load-based or time-based instances, the type.

    • setAutoScalingType

      @Stability(Stable) public void setAutoScalingType(@Nullable String value)
      For load-based or time-based instances, the type.

    • getAvailabilityZone

      @Stability(Stable) @Nullable public String getAvailabilityZone()
      The Availability Zone of the OpsWorks instance, such as us-east-2a .

    • setAvailabilityZone

      @Stability(Stable) public void setAvailabilityZone(@Nullable String value)
      The Availability Zone of the OpsWorks instance, such as us-east-2a .

    • getBlockDeviceMappings

      @Stability(Stable) @Nullable public Object getBlockDeviceMappings()
      An array of BlockDeviceMapping objects that specify the instance's block devices.

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

    • setBlockDeviceMappings

      @Stability(Stable) public void setBlockDeviceMappings(@Nullable IResolvable value)
      An array of BlockDeviceMapping objects that specify the instance's block devices.

    • setBlockDeviceMappings

      @Stability(Stable) public void setBlockDeviceMappings(@Nullable List<Object> value)
      An array of BlockDeviceMapping objects that specify the instance's block devices.

    • getEbsOptimized

      @Stability(Stable) @Nullable public Object getEbsOptimized()
      Whether to create an Amazon EBS-optimized instance.

      Returns union: either Boolean or IResolvable

    • setEbsOptimized

      @Stability(Stable) public void setEbsOptimized(@Nullable Boolean value)
      Whether to create an Amazon EBS-optimized instance.

    • setEbsOptimized

      @Stability(Stable) public void setEbsOptimized(@Nullable IResolvable value)
      Whether to create an Amazon EBS-optimized instance.

    • getElasticIps

      @Stability(Stable) @Nullable public List<String> getElasticIps()
      A list of Elastic IP addresses to associate with the instance.

    • setElasticIps

      @Stability(Stable) public void setElasticIps(@Nullable List<String> value)
      A list of Elastic IP addresses to associate with the instance.

    • getHostname

      @Stability(Stable) @Nullable public String getHostname()
      The instance host name.

      The following are character limits for instance host names.

    • setHostname

      @Stability(Stable) public void setHostname(@Nullable String value)
      The instance host name.

      The following are character limits for instance host names.

    • getInstallUpdatesOnBoot

      @Stability(Stable) @Nullable public Object getInstallUpdatesOnBoot()
      Whether to install operating system and package updates when the instance boots.

      Returns union: either Boolean or IResolvable

    • setInstallUpdatesOnBoot

      @Stability(Stable) public void setInstallUpdatesOnBoot(@Nullable Boolean value)
      Whether to install operating system and package updates when the instance boots.

    • setInstallUpdatesOnBoot

      @Stability(Stable) public void setInstallUpdatesOnBoot(@Nullable IResolvable value)
      Whether to install operating system and package updates when the instance boots.

    • getOs

      @Stability(Stable) @Nullable public String getOs()
      The instance's operating system, which must be set to one of the following.

    • setOs

      @Stability(Stable) public void setOs(@Nullable String value)
      The instance's operating system, which must be set to one of the following.

    • getRootDeviceType

      @Stability(Stable) @Nullable public String getRootDeviceType()
      The instance root device type.

    • setRootDeviceType

      @Stability(Stable) public void setRootDeviceType(@Nullable String value)
      The instance root device type.

    • getSshKeyName

      @Stability(Stable) @Nullable public String getSshKeyName()
      The instance's Amazon EC2 key-pair name.

    • setSshKeyName

      @Stability(Stable) public void setSshKeyName(@Nullable String value)
      The instance's Amazon EC2 key-pair name.

    • getSubnetId

      @Stability(Stable) @Nullable public String getSubnetId()
      The ID of the instance's subnet.

    • setSubnetId

      @Stability(Stable) public void setSubnetId(@Nullable String value)
      The ID of the instance's subnet.

    • getTenancy

      @Stability(Stable) @Nullable public String getTenancy()
      The instance's tenancy option.

    • setTenancy

      @Stability(Stable) public void setTenancy(@Nullable String value)
      The instance's tenancy option.

    • getTimeBasedAutoScaling

      @Stability(Stable) @Nullable public Object getTimeBasedAutoScaling()
      The time-based scaling configuration for the instance.

      Returns union: either IResolvable or CfnInstance.TimeBasedAutoScalingProperty

    • setTimeBasedAutoScaling

      @Stability(Stable) public void setTimeBasedAutoScaling(@Nullable IResolvable value)
      The time-based scaling configuration for the instance.

    • setTimeBasedAutoScaling

      @Stability(Stable) public void setTimeBasedAutoScaling(@Nullable CfnInstance.TimeBasedAutoScalingProperty value)
      The time-based scaling configuration for the instance.

    • getVirtualizationType

      @Stability(Stable) @Nullable public String getVirtualizationType()
      The instance's virtualization type, paravirtual or hvm .

    • setVirtualizationType

      @Stability(Stable) public void setVirtualizationType(@Nullable String value)
      The instance's virtualization type, paravirtual or hvm .

    • getVolumes

      @Stability(Stable) @Nullable public List<String> getVolumes()
      A list of OpsWorks volume IDs to associate with the instance.

    • setVolumes

      @Stability(Stable) public void setVolumes(@Nullable List<String> value)
      A list of OpsWorks volume IDs to associate with the instance.