Class CfnInstanceProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnInstanceProps>
- Enclosing interface:
CfnInstanceProps
CfnInstanceProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionagentVersion
(String agentVersion) Sets the value ofCfnInstanceProps.getAgentVersion()
Sets the value ofCfnInstanceProps.getAmiId()
architecture
(String architecture) Sets the value ofCfnInstanceProps.getArchitecture()
autoScalingType
(String autoScalingType) Sets the value ofCfnInstanceProps.getAutoScalingType()
availabilityZone
(String availabilityZone) Sets the value ofCfnInstanceProps.getAvailabilityZone()
blockDeviceMappings
(List<? extends Object> blockDeviceMappings) Sets the value ofCfnInstanceProps.getBlockDeviceMappings()
blockDeviceMappings
(IResolvable blockDeviceMappings) Sets the value ofCfnInstanceProps.getBlockDeviceMappings()
build()
Builds the configured instance.ebsOptimized
(Boolean ebsOptimized) Sets the value ofCfnInstanceProps.getEbsOptimized()
ebsOptimized
(IResolvable ebsOptimized) Sets the value ofCfnInstanceProps.getEbsOptimized()
elasticIps
(List<String> elasticIps) Sets the value ofCfnInstanceProps.getElasticIps()
Sets the value ofCfnInstanceProps.getHostname()
installUpdatesOnBoot
(Boolean installUpdatesOnBoot) Sets the value ofCfnInstanceProps.getInstallUpdatesOnBoot()
installUpdatesOnBoot
(IResolvable installUpdatesOnBoot) Sets the value ofCfnInstanceProps.getInstallUpdatesOnBoot()
instanceType
(String instanceType) Sets the value ofCfnInstanceProps.getInstanceType()
Sets the value ofCfnInstanceProps.getLayerIds()
Sets the value ofCfnInstanceProps.getOs()
rootDeviceType
(String rootDeviceType) Sets the value ofCfnInstanceProps.getRootDeviceType()
sshKeyName
(String sshKeyName) Sets the value ofCfnInstanceProps.getSshKeyName()
Sets the value ofCfnInstanceProps.getStackId()
Sets the value ofCfnInstanceProps.getSubnetId()
Sets the value ofCfnInstanceProps.getTenancy()
timeBasedAutoScaling
(IResolvable timeBasedAutoScaling) Sets the value ofCfnInstanceProps.getTimeBasedAutoScaling()
timeBasedAutoScaling
(CfnInstance.TimeBasedAutoScalingProperty timeBasedAutoScaling) Sets the value ofCfnInstanceProps.getTimeBasedAutoScaling()
virtualizationType
(String virtualizationType) Sets the value ofCfnInstanceProps.getVirtualizationType()
Sets the value ofCfnInstanceProps.getVolumes()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
instanceType
Sets the value ofCfnInstanceProps.getInstanceType()
- Parameters:
instanceType
- The instance type, such ast2.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
-
layerIds
Sets the value ofCfnInstanceProps.getLayerIds()
- Parameters:
layerIds
- An array that contains the instance's layer IDs. This parameter is required.- Returns:
this
-
stackId
Sets the value ofCfnInstanceProps.getStackId()
- Parameters:
stackId
- The stack ID. This parameter is required.- Returns:
this
-
agentVersion
Sets the value ofCfnInstanceProps.getAgentVersion()
- Parameters:
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, callDescribeAgentVersions
. AgentVersion cannot be set to Chef 12.2.- Returns:
this
-
amiId
Sets the value ofCfnInstanceProps.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
toCustom
.- Returns:
this
-
architecture
Sets the value ofCfnInstanceProps.getArchitecture()
- Parameters:
architecture
- The instance architecture. The default option isx86_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
Sets the value ofCfnInstanceProps.getAutoScalingType()
- Parameters:
autoScalingType
- For load-based or time-based instances, the type. Windows stacks can use only time-based instances.- Returns:
this
-
availabilityZone
Sets the value ofCfnInstanceProps.getAvailabilityZone()
- Parameters:
availabilityZone
- The Availability Zone of the AWS OpsWorks instance, such asus-east-2a
.- Returns:
this
-
blockDeviceMappings
@Stability(Stable) public CfnInstanceProps.Builder blockDeviceMappings(IResolvable blockDeviceMappings) Sets the value ofCfnInstanceProps.getBlockDeviceMappings()
- Parameters:
blockDeviceMappings
- An array ofBlockDeviceMapping
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 CfnInstanceProps.Builder blockDeviceMappings(List<? extends Object> blockDeviceMappings) Sets the value ofCfnInstanceProps.getBlockDeviceMappings()
- Parameters:
blockDeviceMappings
- An array ofBlockDeviceMapping
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
Sets the value ofCfnInstanceProps.getEbsOptimized()
- Parameters:
ebsOptimized
- Whether to create an Amazon EBS-optimized instance.- Returns:
this
-
ebsOptimized
Sets the value ofCfnInstanceProps.getEbsOptimized()
- Parameters:
ebsOptimized
- Whether to create an Amazon EBS-optimized instance.- Returns:
this
-
elasticIps
Sets the value ofCfnInstanceProps.getElasticIps()
- Parameters:
elasticIps
- A list of Elastic IP addresses to associate with the instance.- Returns:
this
-
hostname
Sets the value ofCfnInstanceProps.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 CfnInstanceProps.Builder installUpdatesOnBoot(Boolean installUpdatesOnBoot) Sets the value ofCfnInstanceProps.getInstallUpdatesOnBoot()
- Parameters:
installUpdatesOnBoot
- Whether to install operating system and package updates when the instance boots. The default value istrue
. To control when updates are installed, set this value tofalse
. You must then update your instances manually by usingCreateDeployment
to run theupdate_dependencies
stack command or by manually runningyum
(Amazon Linux) orapt-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 CfnInstanceProps.Builder installUpdatesOnBoot(IResolvable installUpdatesOnBoot) Sets the value ofCfnInstanceProps.getInstallUpdatesOnBoot()
- Parameters:
installUpdatesOnBoot
- Whether to install operating system and package updates when the instance boots. The default value istrue
. To control when updates are installed, set this value tofalse
. You must then update your instances manually by usingCreateDeployment
to run theupdate_dependencies
stack command or by manually runningyum
(Amazon Linux) orapt-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
-
os
Sets the value ofCfnInstanceProps.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
, orAmazon Linux 2015.03
. - A supported Ubuntu operating system, such as
Ubuntu 18.04 LTS
,Ubuntu 16.04 LTS
,Ubuntu 14.04 LTS
, orUbuntu 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
, orMicrosoft 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 theCreateInstance
action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value isCustom
. For more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs .- A supported Linux operating system: An Amazon Linux version, such as
- Returns:
this
-
rootDeviceType
Sets the value ofCfnInstanceProps.getRootDeviceType()
- Parameters:
rootDeviceType
- The instance root device type. For more information, see Storage for the Root Device .- Returns:
this
-
sshKeyName
Sets the value ofCfnInstanceProps.getSshKeyName()
- Parameters:
sshKeyName
- The instance's Amazon EC2 key-pair name.- Returns:
this
-
subnetId
Sets the value ofCfnInstanceProps.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 AWS OpsWorks Stacks to launch the instance in a different subnet.- Returns:
this
-
tenancy
Sets the value ofCfnInstanceProps.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
, orhost
. 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 CfnInstanceProps.Builder timeBasedAutoScaling(IResolvable timeBasedAutoScaling) Sets the value ofCfnInstanceProps.getTimeBasedAutoScaling()
- Parameters:
timeBasedAutoScaling
- The time-based scaling configuration for the instance.- Returns:
this
-
timeBasedAutoScaling
@Stability(Stable) public CfnInstanceProps.Builder timeBasedAutoScaling(CfnInstance.TimeBasedAutoScalingProperty timeBasedAutoScaling) Sets the value ofCfnInstanceProps.getTimeBasedAutoScaling()
- Parameters:
timeBasedAutoScaling
- The time-based scaling configuration for the instance.- Returns:
this
-
virtualizationType
Sets the value ofCfnInstanceProps.getVirtualizationType()
- Parameters:
virtualizationType
- The instance's virtualization type,paravirtual
orhvm
.- Returns:
this
-
volumes
Sets the value ofCfnInstanceProps.getVolumes()
- Parameters:
volumes
- A list of AWS OpsWorks volume IDs to associate with the instance. For more information, seeAWS::OpsWorks::Volume
.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnInstanceProps>
- Returns:
- a new instance of
CfnInstanceProps
- Throws:
NullPointerException
- if any required attribute was not provided
-