Package software.amazon.awscdk.cfnpropertymixins.services.opsworks

Class CfnInstanceMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.opsworks.CfnInstanceMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnInstanceMixinProps>

Enclosing interface:

CfnInstanceMixinProps

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

A builder for CfnInstanceMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnInstanceMixinProps.Builder	agentVersion(String agentVersion)	Sets the value of CfnInstanceMixinProps.getAgentVersion()
CfnInstanceMixinProps.Builder	amiId(String amiId)	Sets the value of CfnInstanceMixinProps.getAmiId()
CfnInstanceMixinProps.Builder	architecture(String architecture)	Sets the value of CfnInstanceMixinProps.getArchitecture()
CfnInstanceMixinProps.Builder	autoScalingType(String autoScalingType)	Sets the value of CfnInstanceMixinProps.getAutoScalingType()
CfnInstanceMixinProps.Builder	availabilityZone(String availabilityZone)	Sets the value of CfnInstanceMixinProps.getAvailabilityZone()
CfnInstanceMixinProps.Builder	blockDeviceMappings(List<? extends Object> blockDeviceMappings)	Sets the value of CfnInstanceMixinProps.getBlockDeviceMappings()
CfnInstanceMixinProps.Builder	blockDeviceMappings(IResolvable blockDeviceMappings)	Sets the value of CfnInstanceMixinProps.getBlockDeviceMappings()
CfnInstanceMixinProps	build()	Builds the configured instance.
CfnInstanceMixinProps.Builder	ebsOptimized(Boolean ebsOptimized)	Sets the value of CfnInstanceMixinProps.getEbsOptimized()
CfnInstanceMixinProps.Builder	ebsOptimized(IResolvable ebsOptimized)	Sets the value of CfnInstanceMixinProps.getEbsOptimized()
CfnInstanceMixinProps.Builder	elasticIps(List<String> elasticIps)	Sets the value of CfnInstanceMixinProps.getElasticIps()
CfnInstanceMixinProps.Builder	hostname(String hostname)	Sets the value of CfnInstanceMixinProps.getHostname()
CfnInstanceMixinProps.Builder	installUpdatesOnBoot(Boolean installUpdatesOnBoot)	Sets the value of CfnInstanceMixinProps.getInstallUpdatesOnBoot()
CfnInstanceMixinProps.Builder	installUpdatesOnBoot(IResolvable installUpdatesOnBoot)	Sets the value of CfnInstanceMixinProps.getInstallUpdatesOnBoot()
CfnInstanceMixinProps.Builder	instanceType(String instanceType)	Sets the value of CfnInstanceMixinProps.getInstanceType()
CfnInstanceMixinProps.Builder	layerIds(List<String> layerIds)	Sets the value of CfnInstanceMixinProps.getLayerIds()
CfnInstanceMixinProps.Builder	os(String os)	Sets the value of CfnInstanceMixinProps.getOs()
CfnInstanceMixinProps.Builder	rootDeviceType(String rootDeviceType)	Sets the value of CfnInstanceMixinProps.getRootDeviceType()
CfnInstanceMixinProps.Builder	sshKeyName(String sshKeyName)	Sets the value of CfnInstanceMixinProps.getSshKeyName()
CfnInstanceMixinProps.Builder	stackId(String stackId)	Sets the value of CfnInstanceMixinProps.getStackId()
CfnInstanceMixinProps.Builder	subnetId(String subnetId)	Sets the value of CfnInstanceMixinProps.getSubnetId()
CfnInstanceMixinProps.Builder	tenancy(String tenancy)	Sets the value of CfnInstanceMixinProps.getTenancy()
CfnInstanceMixinProps.Builder	timeBasedAutoScaling(CfnInstancePropsMixin.TimeBasedAutoScalingProperty timeBasedAutoScaling)	Sets the value of CfnInstanceMixinProps.getTimeBasedAutoScaling()
CfnInstanceMixinProps.Builder	timeBasedAutoScaling(IResolvable timeBasedAutoScaling)	Sets the value of CfnInstanceMixinProps.getTimeBasedAutoScaling()
CfnInstanceMixinProps.Builder	virtualizationType(String virtualizationType)	Sets the value of CfnInstanceMixinProps.getVirtualizationType()
CfnInstanceMixinProps.Builder	volumes(List<String> volumes)	Sets the value of CfnInstanceMixinProps.getVolumes()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

agentVersion

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

Sets the value of CfnInstanceMixinProps.getAgentVersion()

Parameters:

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

Returns:

this

amiId

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

Sets the value of CfnInstanceMixinProps.getAmiId()

Parameters:

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 .

Returns:

this

architecture

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

Sets the value of CfnInstanceMixinProps.getArchitecture()

Parameters:

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 .

Returns:

this

autoScalingType

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

Sets the value of CfnInstanceMixinProps.getAutoScalingType()

Parameters:

autoScalingType - For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

Returns:

this

availabilityZone

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

Sets the value of CfnInstanceMixinProps.getAvailabilityZone()

Parameters:

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

Returns:

this

blockDeviceMappings

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

Sets the value of CfnInstanceMixinProps.getBlockDeviceMappings()

Parameters:

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.

Returns:

this

blockDeviceMappings

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

Sets the value of CfnInstanceMixinProps.getBlockDeviceMappings()

Parameters:

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.

Returns:

this

ebsOptimized

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

Sets the value of CfnInstanceMixinProps.getEbsOptimized()

Parameters:

ebsOptimized - Whether to create an Amazon EBS-optimized instance.

Returns:

this

ebsOptimized

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

Sets the value of CfnInstanceMixinProps.getEbsOptimized()

Parameters:

ebsOptimized - Whether to create an Amazon EBS-optimized instance.

Returns:

this

elasticIps

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

Sets the value of CfnInstanceMixinProps.getElasticIps()

Parameters:

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

Returns:

this

hostname

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

Sets the value of CfnInstanceMixinProps.getHostname()

Parameters:

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

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

Returns:

this

installUpdatesOnBoot

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

Sets the value of CfnInstanceMixinProps.getInstallUpdatesOnBoot()

Parameters:

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.

Returns:

this

installUpdatesOnBoot

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

Sets the value of CfnInstanceMixinProps.getInstallUpdatesOnBoot()

Parameters:

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.

Returns:

this

instanceType

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

Sets the value of CfnInstanceMixinProps.getInstanceType()

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.

Returns:

this

layerIds

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

Sets the value of CfnInstanceMixinProps.getLayerIds()

Parameters:

layerIds - An array that contains the instance's layer IDs.

Returns:

this

os

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

Sets the value of CfnInstanceMixinProps.getOs()

Parameters:

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

Returns:

this

rootDeviceType

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

Sets the value of CfnInstanceMixinProps.getRootDeviceType()

Parameters:

rootDeviceType - The instance root device type. For more information, see Storage for the Root Device .

Returns:

this

sshKeyName

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

Sets the value of CfnInstanceMixinProps.getSshKeyName()

Parameters:

sshKeyName - The instance's Amazon EC2 key-pair name.

Returns:

this

stackId

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

Sets the value of CfnInstanceMixinProps.getStackId()

Parameters:

stackId - The stack ID.

Returns:

this

subnetId

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

Sets the value of CfnInstanceMixinProps.getSubnetId()

Parameters:

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

Returns:

this

tenancy

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

Sets the value of CfnInstanceMixinProps.getTenancy()

Parameters:

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 .

Returns:

this

timeBasedAutoScaling

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

Sets the value of CfnInstanceMixinProps.getTimeBasedAutoScaling()

Parameters:

timeBasedAutoScaling - The time-based scaling configuration for the instance.

Returns:

this

timeBasedAutoScaling

@Stability(Stable)
public CfnInstanceMixinProps.Builder timeBasedAutoScaling(CfnInstancePropsMixin.TimeBasedAutoScalingProperty timeBasedAutoScaling)

Sets the value of CfnInstanceMixinProps.getTimeBasedAutoScaling()

Parameters:

timeBasedAutoScaling - The time-based scaling configuration for the instance.

Returns:

this

virtualizationType

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

Sets the value of CfnInstanceMixinProps.getVirtualizationType()

Parameters:

virtualizationType - The instance's virtualization type, paravirtual or hvm .

Returns:

this

volumes

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

Sets the value of CfnInstanceMixinProps.getVolumes()

Parameters:

volumes - A list of OpsWorks volume IDs to associate with the instance. For more information, see AWS::OpsWorks::Volume .

Returns:

this

build

@Stability(Stable)
public CfnInstanceMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnInstanceMixinProps

Throws:

NullPointerException - if any required attribute was not provided