Package software.amazon.awscdk.services.opsworks

Class CfnInstance

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.opsworks.CfnInstance
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.587Z") @Stability(Stable) public class CfnInstance extends CfnResource implements IInspectable
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 .

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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnInstanceProps props)
      Create a new AWS::OpsWorks::Instance.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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 AWS OpsWorks instance, such as us-east-2a .

    • getAttrPrivateDnsName

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

    • getAttrPrivateIp

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

    • getAttrPublicDnsName

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

    • getAttrPublicIp

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

    • getCfnProperties

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

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

    • setAgentVersion

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

    • getAmiId

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

    • setAmiId

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

    • getArchitecture

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

    • setArchitecture

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

    • getAutoScalingType

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

      Windows stacks can use only time-based instances.

    • setAutoScalingType

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

      Windows stacks can use only time-based instances.

    • getAvailabilityZone

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

    • setAvailabilityZone

      @Stability(Stable) public void setAvailabilityZone(@Nullable String value)
      The Availability Zone of the AWS 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.

      For more information, see Block Device Mapping . Note that block device mappings are not supported for custom AMIs.

    • setBlockDeviceMappings

      @Stability(Stable) public void setBlockDeviceMappings(@Nullable IResolvable value)
      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.

    • setBlockDeviceMappings

      @Stability(Stable) public void setBlockDeviceMappings(@Nullable List<Object> value)
      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.

    • getEbsOptimized

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

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

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

    • setHostname

      @Stability(Stable) public void setHostname(@Nullable String value)
      The instance host name. The following are character limits for instance host names.

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

    • getInstallUpdatesOnBoot

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

    • setInstallUpdatesOnBoot

      @Stability(Stable) public void setInstallUpdatesOnBoot(@Nullable Boolean value)
      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.

    • setInstallUpdatesOnBoot

      @Stability(Stable) public void setInstallUpdatesOnBoot(@Nullable IResolvable value)
      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.

    • getOs

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

    • setOs

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

    • getRootDeviceType

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

      For more information, see Storage for the Root Device .

    • setRootDeviceType

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

      For more information, see Storage for the Root Device .

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

      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.

    • setSubnetId

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

    • getTenancy

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

    • setTenancy

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

    • getTimeBasedAutoScaling

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

    • 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 AWS OpsWorks volume IDs to associate with the instance.

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

    • setVolumes

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

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