Package software.amazon.awscdk.services.opsworks

Class CfnInstance.Builder

java.lang.Object

software.amazon.awscdk.services.opsworks.CfnInstance.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnInstance>

Enclosing class:

CfnInstance

@Stability(Stable)
public static final class CfnInstance.Builder
extends Object
implements software.amazon.jsii.Builder<CfnInstance>

A fluent builder for CfnInstance.

Method Summary

Modifier and Type	Method	Description
CfnInstance.Builder	agentVersion(String agentVersion)	The default AWS OpsWorks Stacks agent version.
CfnInstance.Builder	amiId(String amiId)	A custom AMI ID to be used to create the instance.
CfnInstance.Builder	architecture(String architecture)	The instance architecture.
CfnInstance.Builder	autoScalingType(String autoScalingType)	For load-based or time-based instances, the type.
CfnInstance.Builder	availabilityZone(String availabilityZone)	The Availability Zone of the AWS OpsWorks instance, such as us-east-2a .
CfnInstance.Builder	blockDeviceMappings(List<? extends Object> blockDeviceMappings)	An array of BlockDeviceMapping objects that specify the instance's block devices.
CfnInstance.Builder	blockDeviceMappings(IResolvable blockDeviceMappings)	An array of BlockDeviceMapping objects that specify the instance's block devices.
CfnInstance	build()
static CfnInstance.Builder	create(software.constructs.Construct scope, String id)
CfnInstance.Builder	ebsOptimized(Boolean ebsOptimized)	Whether to create an Amazon EBS-optimized instance.
CfnInstance.Builder	ebsOptimized(IResolvable ebsOptimized)	Whether to create an Amazon EBS-optimized instance.
CfnInstance.Builder	elasticIps(List<String> elasticIps)	A list of Elastic IP addresses to associate with the instance.
CfnInstance.Builder	hostname(String hostname)	The instance host name.
CfnInstance.Builder	installUpdatesOnBoot(Boolean installUpdatesOnBoot)	Whether to install operating system and package updates when the instance boots.
CfnInstance.Builder	installUpdatesOnBoot(IResolvable installUpdatesOnBoot)	Whether to install operating system and package updates when the instance boots.
CfnInstance.Builder	instanceType(String instanceType)	The instance type, such as t2.micro .
CfnInstance.Builder	layerIds(List<String> layerIds)	An array that contains the instance's layer IDs.
CfnInstance.Builder	os(String os)	The instance's operating system, which must be set to one of the following.
CfnInstance.Builder	rootDeviceType(String rootDeviceType)	The instance root device type.
CfnInstance.Builder	sshKeyName(String sshKeyName)	The instance's Amazon EC2 key-pair name.
CfnInstance.Builder	stackId(String stackId)	The stack ID.
CfnInstance.Builder	subnetId(String subnetId)	The ID of the instance's subnet.
CfnInstance.Builder	tenancy(String tenancy)	The instance's tenancy option.
CfnInstance.Builder	timeBasedAutoScaling(IResolvable timeBasedAutoScaling)	The time-based scaling configuration for the instance.
CfnInstance.Builder	timeBasedAutoScaling(CfnInstance.TimeBasedAutoScalingProperty timeBasedAutoScaling)	The time-based scaling configuration for the instance.
CfnInstance.Builder	virtualizationType(String virtualizationType)	The instance's virtualization type, paravirtual or hvm .
CfnInstance.Builder	volumes(List<String> volumes)	A list of AWS OpsWorks volume IDs to associate with the instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnInstance.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnInstance.Builder.

instanceType

@Stability(Stable)
public CfnInstance.Builder instanceType(String instanceType)

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.

Parameters:

instanceType - 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. This parameter is required.

Returns:

this

See Also:

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

layerIds

@Stability(Stable)
public CfnInstance.Builder layerIds(List<String> layerIds)

An array that contains the instance's layer IDs.

Parameters:

layerIds - An array that contains the instance's layer IDs. This parameter is required.

Returns:

this

See Also:

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

stackId

@Stability(Stable)
public CfnInstance.Builder stackId(String stackId)

The stack ID.

Parameters:

stackId - The stack ID. This parameter is required.

Returns:

this

See Also:

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

agentVersion

@Stability(Stable)
public CfnInstance.Builder agentVersion(String agentVersion)

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.

Parameters:

agentVersion - The default AWS OpsWorks Stacks agent version. You have the following options:. This parameter is required.

Returns:

this

See Also:

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

amiId

@Stability(Stable)
public CfnInstance.Builder amiId(String amiId)

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 .

Parameters:

amiId - A custom AMI ID to be used to create the instance. This parameter is required.

Returns:

this

See Also:

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

architecture

@Stability(Stable)
public CfnInstance.Builder architecture(String architecture)

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 .

Parameters:

architecture - The instance architecture. This parameter is required.

Returns:

this

See Also:

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

autoScalingType

@Stability(Stable)
public CfnInstance.Builder autoScalingType(String autoScalingType)

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

Windows stacks can use only time-based instances.

Parameters:

autoScalingType - For load-based or time-based instances, the type. This parameter is required.

Returns:

this

See Also:

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

availabilityZone

@Stability(Stable)
public CfnInstance.Builder availabilityZone(String availabilityZone)

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

Parameters:

availabilityZone - The Availability Zone of the AWS OpsWorks instance, such as us-east-2a . This parameter is required.

Returns:

this

See Also:

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

blockDeviceMappings

@Stability(Stable)
public CfnInstance.Builder blockDeviceMappings(IResolvable blockDeviceMappings)

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.

Parameters:

blockDeviceMappings - An array of BlockDeviceMapping objects that specify the instance's block devices. This parameter is required.

Returns:

this

See Also:

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

blockDeviceMappings

@Stability(Stable)
public CfnInstance.Builder blockDeviceMappings(List<? extends Object> blockDeviceMappings)

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.

Parameters:

blockDeviceMappings - An array of BlockDeviceMapping objects that specify the instance's block devices. This parameter is required.

Returns:

this

See Also:

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

ebsOptimized

@Stability(Stable)
public CfnInstance.Builder ebsOptimized(Boolean ebsOptimized)

Whether to create an Amazon EBS-optimized instance.

Parameters:

ebsOptimized - Whether to create an Amazon EBS-optimized instance. This parameter is required.

Returns:

this

See Also:

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

ebsOptimized

@Stability(Stable)
public CfnInstance.Builder ebsOptimized(IResolvable ebsOptimized)

Whether to create an Amazon EBS-optimized instance.

Parameters:

ebsOptimized - Whether to create an Amazon EBS-optimized instance. This parameter is required.

Returns:

this

See Also:

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

elasticIps

@Stability(Stable)
public CfnInstance.Builder elasticIps(List<String> elasticIps)

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

Parameters:

elasticIps - A list of Elastic IP addresses to associate with the instance. This parameter is required.

Returns:

this

See Also:

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

hostname

@Stability(Stable)
public CfnInstance.Builder hostname(String hostname)

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

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

Parameters:

hostname - The instance host name. The following are character limits for instance host names. This parameter is required.

Returns:

this

See Also:

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

installUpdatesOnBoot

@Stability(Stable)
public CfnInstance.Builder installUpdatesOnBoot(Boolean installUpdatesOnBoot)

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.

Parameters:

installUpdatesOnBoot - Whether to install operating system and package updates when the instance boots. This parameter is required.

Returns:

this

See Also:

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

installUpdatesOnBoot

@Stability(Stable)
public CfnInstance.Builder installUpdatesOnBoot(IResolvable installUpdatesOnBoot)

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.

Parameters:

installUpdatesOnBoot - Whether to install operating system and package updates when the instance boots. This parameter is required.

Returns:

this

See Also:

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

os

@Stability(Stable)
public CfnInstance.Builder os(String os)

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 .

Parameters:

os - The instance's operating system, which must be set to one of the following. This parameter is required.

Returns:

this

See Also:

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

rootDeviceType

@Stability(Stable)
public CfnInstance.Builder rootDeviceType(String rootDeviceType)

The instance root device type.

For more information, see Storage for the Root Device .

Parameters:

rootDeviceType - The instance root device type. This parameter is required.

Returns:

this

See Also:

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

sshKeyName

@Stability(Stable)
public CfnInstance.Builder sshKeyName(String sshKeyName)

The instance's Amazon EC2 key-pair name.

Parameters:

sshKeyName - The instance's Amazon EC2 key-pair name. This parameter is required.

Returns:

this

See Also:

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

subnetId

@Stability(Stable)
public CfnInstance.Builder subnetId(String subnetId)

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.

Parameters:

subnetId - The ID of the instance's subnet. This parameter is required.

Returns:

this

See Also:

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

tenancy

@Stability(Stable)
public CfnInstance.Builder tenancy(String tenancy)

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 .

Parameters:

tenancy - The instance's tenancy option. This parameter is required.

Returns:

this

See Also:

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

timeBasedAutoScaling

@Stability(Stable)
public CfnInstance.Builder timeBasedAutoScaling(IResolvable timeBasedAutoScaling)

The time-based scaling configuration for the instance.

Parameters:

timeBasedAutoScaling - The time-based scaling configuration for the instance. This parameter is required.

Returns:

this

See Also:

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

timeBasedAutoScaling

@Stability(Stable)
public CfnInstance.Builder timeBasedAutoScaling(CfnInstance.TimeBasedAutoScalingProperty timeBasedAutoScaling)

The time-based scaling configuration for the instance.

Parameters:

timeBasedAutoScaling - The time-based scaling configuration for the instance. This parameter is required.

Returns:

this

See Also:

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

virtualizationType

@Stability(Stable)
public CfnInstance.Builder virtualizationType(String virtualizationType)

The instance's virtualization type, paravirtual or hvm .

Parameters:

virtualizationType - The instance's virtualization type, paravirtual or hvm . This parameter is required.

Returns:

this

See Also:

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

volumes

@Stability(Stable)
public CfnInstance.Builder volumes(List<String> volumes)

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

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

Parameters:

volumes - A list of AWS OpsWorks volume IDs to associate with the instance. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnInstance build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnInstance>

Returns:

a newly built instance of CfnInstance.