public static interface CloneStackRequest.Builder extends OpsWorksRequest.Builder, CopyableBuilder<CloneStackRequest.Builder,CloneStackRequest>
Modifier and Type | Method and Description |
---|---|
CloneStackRequest.Builder |
agentVersion(String agentVersion)
The default AWS OpsWorks Stacks agent version.
|
CloneStackRequest.Builder |
attributes(Map<StackAttributesKeys,String> attributes)
A list of stack attributes and values as key/value pairs to be added to the cloned stack.
|
CloneStackRequest.Builder |
attributesWithStrings(Map<String,String> attributes)
A list of stack attributes and values as key/value pairs to be added to the cloned stack.
|
CloneStackRequest.Builder |
chefConfiguration(ChefConfiguration chefConfiguration)
A
ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version
on Chef 11.10 stacks. |
default CloneStackRequest.Builder |
chefConfiguration(Consumer<ChefConfiguration.Builder> chefConfiguration)
A
ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version
on Chef 11.10 stacks. |
CloneStackRequest.Builder |
cloneAppIds(Collection<String> cloneAppIds)
A list of source stack app IDs to be included in the cloned stack.
|
CloneStackRequest.Builder |
cloneAppIds(String... cloneAppIds)
A list of source stack app IDs to be included in the cloned stack.
|
CloneStackRequest.Builder |
clonePermissions(Boolean clonePermissions)
Whether to clone the source stack's permissions.
|
default CloneStackRequest.Builder |
configurationManager(Consumer<StackConfigurationManager.Builder> configurationManager)
The configuration manager.
|
CloneStackRequest.Builder |
configurationManager(StackConfigurationManager configurationManager)
The configuration manager.
|
default CloneStackRequest.Builder |
customCookbooksSource(Consumer<Source.Builder> customCookbooksSource)
Sets the value of the CustomCookbooksSource property for this object.
|
CloneStackRequest.Builder |
customCookbooksSource(Source customCookbooksSource)
Sets the value of the CustomCookbooksSource property for this object.
|
CloneStackRequest.Builder |
customJson(String customJson)
A string that contains user-defined, custom JSON.
|
CloneStackRequest.Builder |
defaultAvailabilityZone(String defaultAvailabilityZone)
The cloned stack's default Availability Zone, which must be in the specified region.
|
CloneStackRequest.Builder |
defaultInstanceProfileArn(String defaultInstanceProfileArn)
The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2
instances.
|
CloneStackRequest.Builder |
defaultOs(String defaultOs)
The stack's operating system, which must be set to one of the following.
|
CloneStackRequest.Builder |
defaultRootDeviceType(RootDeviceType defaultRootDeviceType)
The default root device type.
|
CloneStackRequest.Builder |
defaultRootDeviceType(String defaultRootDeviceType)
The default root device type.
|
CloneStackRequest.Builder |
defaultSshKeyName(String defaultSshKeyName)
A default Amazon EC2 key pair name.
|
CloneStackRequest.Builder |
defaultSubnetId(String defaultSubnetId)
The stack's default VPC subnet ID.
|
CloneStackRequest.Builder |
hostnameTheme(String hostnameTheme)
The stack's host name theme, with spaces are replaced by underscores.
|
CloneStackRequest.Builder |
name(String name)
The cloned stack name.
|
CloneStackRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
CloneStackRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
CloneStackRequest.Builder |
region(String region)
The cloned stack AWS region, such as "ap-northeast-2".
|
CloneStackRequest.Builder |
serviceRoleArn(String serviceRoleArn)
The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS
resources on your behalf.
|
CloneStackRequest.Builder |
sourceStackId(String sourceStackId)
The source stack ID.
|
CloneStackRequest.Builder |
useCustomCookbooks(Boolean useCustomCookbooks)
Whether to use custom cookbooks.
|
CloneStackRequest.Builder |
useOpsworksSecurityGroups(Boolean useOpsworksSecurityGroups)
Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
|
CloneStackRequest.Builder |
vpcId(String vpcId)
The ID of the VPC that the cloned stack is to be launched into.
|
build
overrideConfiguration
copy
applyMutation, build
CloneStackRequest.Builder sourceStackId(String sourceStackId)
The source stack ID.
sourceStackId
- The source stack ID.CloneStackRequest.Builder name(String name)
The cloned stack name.
name
- The cloned stack name.CloneStackRequest.Builder region(String region)
The cloned stack AWS region, such as "ap-northeast-2". For more information about AWS regions, see Regions and Endpoints.
region
- The cloned stack AWS region, such as "ap-northeast-2". For more information about AWS regions, see Regions and Endpoints.CloneStackRequest.Builder vpcId(String vpcId)
The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All instances are launched into this VPC, and you cannot change the ID later.
If your account supports EC2 Classic, the default value is no VPC.
If your account does not support EC2 Classic, the default value is the default VPC for the specified region.
If the VPC ID corresponds to a default VPC and you have specified either the
DefaultAvailabilityZone
or the DefaultSubnetId
parameter only, AWS OpsWorks Stacks
infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these
parameters to the first valid Availability Zone for the specified region and the corresponding default VPC
subnet ID, respectively.
If you specify a nondefault VPC ID, note the following:
It must belong to a VPC in your account that is in the specified region.
You must specify a value for DefaultSubnetId
.
For more information on how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2 Classic, see Supported Platforms.
vpcId
- The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region.
All instances are launched into this VPC, and you cannot change the ID later.
If your account supports EC2 Classic, the default value is no VPC.
If your account does not support EC2 Classic, the default value is the default VPC for the specified region.
If the VPC ID corresponds to a default VPC and you have specified either the
DefaultAvailabilityZone
or the DefaultSubnetId
parameter only, AWS OpsWorks
Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks
sets these parameters to the first valid Availability Zone for the specified region and the
corresponding default VPC subnet ID, respectively.
If you specify a nondefault VPC ID, note the following:
It must belong to a VPC in your account that is in the specified region.
You must specify a value for DefaultSubnetId
.
For more information on how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2 Classic, see Supported Platforms.
CloneStackRequest.Builder attributesWithStrings(Map<String,String> attributes)
A list of stack attributes and values as key/value pairs to be added to the cloned stack.
attributes
- A list of stack attributes and values as key/value pairs to be added to the cloned stack.CloneStackRequest.Builder attributes(Map<StackAttributesKeys,String> attributes)
A list of stack attributes and values as key/value pairs to be added to the cloned stack.
attributes
- A list of stack attributes and values as key/value pairs to be added to the cloned stack.CloneStackRequest.Builder serviceRoleArn(String serviceRoleArn)
The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. If you create a stack by using the AWS OpsWorks Stacks console, it creates the role for you. You can obtain an existing stack's IAM ARN programmatically by calling DescribePermissions. For more information about IAM ARNs, see Using Identifiers.
You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.
serviceRoleArn
- The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with
AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an
existing IAM role. If you create a stack by using the AWS OpsWorks Stacks console, it creates the role
for you. You can obtain an existing stack's IAM ARN programmatically by calling
DescribePermissions. For more information about IAM ARNs, see Using
Identifiers. You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.
CloneStackRequest.Builder defaultInstanceProfileArn(String defaultInstanceProfileArn)
The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
defaultInstanceProfileArn
- The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's
EC2 instances. For more information about IAM ARNs, see Using Identifiers.CloneStackRequest.Builder defaultOs(String defaultOs)
The stack'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 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 16.04 LTS
, Ubuntu 14.04 LTS
, or
Ubuntu 12.04 LTS
.
CentOS Linux 7
Red Hat Enterprise Linux 7
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
. You specify the custom AMI you want to use when you create instances. For
more information on how to use custom AMIs with OpsWorks, see Using Custom
AMIs.
The default option is the parent stack's operating system. For more information on the supported operating systems, see AWS OpsWorks Stacks Operating Systems.
You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux.
defaultOs
- The stack'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 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 16.04 LTS
,
Ubuntu 14.04 LTS
, or Ubuntu 12.04 LTS
.
CentOS Linux 7
Red Hat Enterprise Linux 7
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
. You specify the custom AMI you want to use when you create
instances. For more information on how to use custom AMIs with OpsWorks, see Using
Custom AMIs.
The default option is the parent stack's operating system. For more information on the supported operating systems, see AWS OpsWorks Stacks Operating Systems.
You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux.
CloneStackRequest.Builder hostnameTheme(String hostnameTheme)
The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate host
names for the stack's instances. By default, HostnameTheme
is set to
Layer_Dependent
, which creates host names by appending integers to the layer's short name. The
other themes are:
Baked_Goods
Clouds
Europe_Cities
Fruits
Greek_Deities
Legendary_creatures_from_Japan
Planets_and_Moons
Roman_Deities
Scottish_Islands
US_Cities
Wild_Cats
To obtain a generated host name, call GetHostNameSuggestion
, which returns a host name based on
the current theme.
hostnameTheme
- The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate
host names for the stack's instances. By default, HostnameTheme
is set to
Layer_Dependent
, which creates host names by appending integers to the layer's short
name. The other themes are:
Baked_Goods
Clouds
Europe_Cities
Fruits
Greek_Deities
Legendary_creatures_from_Japan
Planets_and_Moons
Roman_Deities
Scottish_Islands
US_Cities
Wild_Cats
To obtain a generated host name, call GetHostNameSuggestion
, which returns a host name
based on the current theme.
CloneStackRequest.Builder defaultAvailabilityZone(String defaultAvailabilityZone)
The cloned stack's default Availability Zone, which must be in the specified region. For more information,
see Regions and Endpoints. If you also
specify a value for DefaultSubnetId
, the subnet must be in the same zone. For more information,
see the VpcId
parameter description.
defaultAvailabilityZone
- The cloned stack's default Availability Zone, which must be in the specified region. For more
information, see Regions and
Endpoints. If you also specify a value for DefaultSubnetId
, the subnet must be in the
same zone. For more information, see the VpcId
parameter description.CloneStackRequest.Builder defaultSubnetId(String defaultSubnetId)
The stack's default VPC subnet ID. This parameter is required if you specify a value for the
VpcId
parameter. All instances are launched into this subnet unless you specify otherwise when
you create the instance. If you also specify a value for DefaultAvailabilityZone
, the subnet
must be in that zone. For information on default values and when this parameter is required, see the
VpcId
parameter description.
defaultSubnetId
- The stack's default VPC subnet ID. This parameter is required if you specify a value for the
VpcId
parameter. All instances are launched into this subnet unless you specify otherwise
when you create the instance. If you also specify a value for DefaultAvailabilityZone
,
the subnet must be in that zone. For information on default values and when this parameter is
required, see the VpcId
parameter description.CloneStackRequest.Builder customJson(String customJson)
A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format:
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes
customJson
- A string that contains user-defined, custom JSON. It is used to override the corresponding default
stack configuration JSON values. The string should be in the following format:
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes
CloneStackRequest.Builder configurationManager(StackConfigurationManager configurationManager)
The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.
configurationManager
- The configuration manager. When you clone a stack we recommend that you use the configuration manager
to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The
default value for Linux stacks is currently 12.default CloneStackRequest.Builder configurationManager(Consumer<StackConfigurationManager.Builder> configurationManager)
The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.
This is a convenience that creates an instance of theStackConfigurationManager.Builder
avoiding the
need to create one manually via StackConfigurationManager.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately
and its result is passed to configurationManager(StackConfigurationManager)
.configurationManager
- a consumer that will call methods on StackConfigurationManager.Builder
configurationManager(StackConfigurationManager)
CloneStackRequest.Builder chefConfiguration(ChefConfiguration chefConfiguration)
A ChefConfiguration
object that specifies whether to enable Berkshelf and the Berkshelf version
on Chef 11.10 stacks. For more information, see Create a New
Stack.
chefConfiguration
- A ChefConfiguration
object that specifies whether to enable Berkshelf and the Berkshelf
version on Chef 11.10 stacks. For more information, see Create a New
Stack.default CloneStackRequest.Builder chefConfiguration(Consumer<ChefConfiguration.Builder> chefConfiguration)
A ChefConfiguration
object that specifies whether to enable Berkshelf and the Berkshelf version
on Chef 11.10 stacks. For more information, see Create a New
Stack.
ChefConfiguration.Builder
avoiding the need to
create one manually via ChefConfiguration.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to chefConfiguration(ChefConfiguration)
.chefConfiguration
- a consumer that will call methods on ChefConfiguration.Builder
chefConfiguration(ChefConfiguration)
CloneStackRequest.Builder useCustomCookbooks(Boolean useCustomCookbooks)
Whether to use custom cookbooks.
useCustomCookbooks
- Whether to use custom cookbooks.CloneStackRequest.Builder useOpsworksSecurityGroups(Boolean useOpsworksSecurityGroups)
Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are
associated with layers by default. With UseOpsworksSecurityGroups
you can instead provide your
own custom security groups. UseOpsworksSecurityGroups
has the following settings:
True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it but you cannot delete the built-in security group.
False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate Amazon Elastic Compute Cloud (Amazon EC2) security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.
For more information, see Create a New Stack.
useOpsworksSecurityGroups
- Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are
associated with layers by default. With UseOpsworksSecurityGroups
you can instead provide
your own custom security groups. UseOpsworksSecurityGroups
has the following settings:
True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it but you cannot delete the built-in security group.
False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate Amazon Elastic Compute Cloud (Amazon EC2) security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.
For more information, see Create a New Stack.
CloneStackRequest.Builder customCookbooksSource(Source customCookbooksSource)
customCookbooksSource
- The new value for the CustomCookbooksSource property for this object.default CloneStackRequest.Builder customCookbooksSource(Consumer<Source.Builder> customCookbooksSource)
Source.Builder
avoiding the need to create one
manually via Source.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result is
passed to customCookbooksSource(Source)
.customCookbooksSource
- a consumer that will call methods on Source.Builder
customCookbooksSource(Source)
CloneStackRequest.Builder defaultSshKeyName(String defaultSshKeyName)
A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.
defaultSshKeyName
- A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS
OpsWorks installs the public key on the instance and you can use the private key with an SSH client to
log in to the instance. For more information, see Using SSH to
Communicate with an Instance and Managing SSH
Access. You can override this setting by specifying a different key pair, or no key pair, when you
create an
instance.CloneStackRequest.Builder clonePermissions(Boolean clonePermissions)
Whether to clone the source stack's permissions.
clonePermissions
- Whether to clone the source stack's permissions.CloneStackRequest.Builder cloneAppIds(Collection<String> cloneAppIds)
A list of source stack app IDs to be included in the cloned stack.
cloneAppIds
- A list of source stack app IDs to be included in the cloned stack.CloneStackRequest.Builder cloneAppIds(String... cloneAppIds)
A list of source stack app IDs to be included in the cloned stack.
cloneAppIds
- A list of source stack app IDs to be included in the cloned stack.CloneStackRequest.Builder defaultRootDeviceType(String defaultRootDeviceType)
The default root device type. This value is used by default for all instances in the cloned stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.
defaultRootDeviceType
- The default root device type. This value is used by default for all instances in the cloned stack, but
you can override it when you create an instance. For more information, see Storage for the Root Device.RootDeviceType
,
RootDeviceType
CloneStackRequest.Builder defaultRootDeviceType(RootDeviceType defaultRootDeviceType)
The default root device type. This value is used by default for all instances in the cloned stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.
defaultRootDeviceType
- The default root device type. This value is used by default for all instances in the cloned stack, but
you can override it when you create an instance. For more information, see Storage for the Root Device.RootDeviceType
,
RootDeviceType
CloneStackRequest.Builder agentVersion(String agentVersion)
The default AWS OpsWorks Stacks agent version. You have the following options:
Auto-update - Set this parameter to LATEST
. AWS OpsWorks Stacks automatically installs new agent
versions on the stack's instances as soon as they are available.
Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.
The default setting is LATEST
. 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.
You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.
agentVersion
- The default AWS OpsWorks Stacks agent version. You have the following options:
Auto-update - Set this parameter to LATEST
. AWS OpsWorks Stacks automatically installs
new agent versions on the stack's instances as soon as they are available.
Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.
The default setting is LATEST
. 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.
You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.
CloneStackRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.CloneStackRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.