@Generated(value="software.amazon.awssdk:codegen") public final class CloneStackRequest extends OpsWorksRequest implements ToCopyableBuilder<CloneStackRequest.Builder,CloneStackRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CloneStackRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
agentVersion()
The default AWS OpsWorks Stacks agent version.
|
Map<StackAttributesKeys,String> |
attributes()
A list of stack attributes and values as key/value pairs to be added to the cloned stack.
|
Map<String,String> |
attributesAsStrings()
A list of stack attributes and values as key/value pairs to be added to the cloned stack.
|
static CloneStackRequest.Builder |
builder() |
ChefConfiguration |
chefConfiguration()
A
ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on
Chef 11.10 stacks. |
List<String> |
cloneAppIds()
A list of source stack app IDs to be included in the cloned stack.
|
Boolean |
clonePermissions()
Whether to clone the source stack's permissions.
|
StackConfigurationManager |
configurationManager()
The configuration manager.
|
Source |
customCookbooksSource()
Contains the information required to retrieve an app or cookbook from a repository.
|
String |
customJson()
A string that contains user-defined, custom JSON.
|
String |
defaultAvailabilityZone()
The cloned stack's default Availability Zone, which must be in the specified region.
|
String |
defaultInstanceProfileArn()
The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2
instances.
|
String |
defaultOs()
The stack's operating system, which must be set to one of the following.
|
RootDeviceType |
defaultRootDeviceType()
The default root device type.
|
String |
defaultRootDeviceTypeAsString()
The default root device type.
|
String |
defaultSshKeyName()
A default Amazon EC2 key pair name.
|
String |
defaultSubnetId()
The stack's default VPC subnet ID.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
boolean |
hasAttributes()
Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
boolean |
hasCloneAppIds()
Returns true if the CloneAppIds property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
int |
hashCode() |
String |
hostnameTheme()
The stack's host name theme, with spaces are replaced by underscores.
|
String |
name()
The cloned stack name.
|
String |
region()
The cloned stack AWS region, such as "ap-northeast-2".
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CloneStackRequest.Builder> |
serializableBuilderClass() |
String |
serviceRoleArn()
The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS
resources on your behalf.
|
String |
sourceStackId()
The source stack ID.
|
CloneStackRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
Boolean |
useCustomCookbooks()
Whether to use custom cookbooks.
|
Boolean |
useOpsworksSecurityGroups()
Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
|
String |
vpcId()
The ID of the VPC that the cloned stack is to be launched into.
|
overrideConfiguration
copy
public final String sourceStackId()
The source stack ID.
public final String name()
The cloned stack name.
public final String region()
The cloned stack AWS region, such as "ap-northeast-2". For more information about AWS regions, see Regions and Endpoints.
public final 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 about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2 Classic, see Supported Platforms.
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 about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2 Classic, see Supported Platforms.
public final Map<StackAttributesKeys,String> attributes()
A list of stack attributes and values as key/value pairs to be added to the cloned stack.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAttributes()
to see if a value was sent in this field.
public final boolean hasAttributes()
public final Map<String,String> attributesAsStrings()
A list of stack attributes and values as key/value pairs to be added to the cloned stack.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAttributes()
to see if a value was sent in this field.
public final 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.
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.
public final 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.
public final 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 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 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 about how to use custom AMIs with OpsWorks, see Using Custom
AMIs.
The default option is the parent stack's operating system. For more information about 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.
A supported Linux operating system: An Amazon Linux version, such as 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 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 about how to use custom AMIs with OpsWorks, see Using
Custom AMIs.
The default option is the parent stack's operating system. For more information about 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.
public final 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_and_Titans
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
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_and_Titans
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.
public final 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.
DefaultSubnetId
, the subnet must be in the
same zone. For more information, see the VpcId
parameter description.public final 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.
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.public final 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 about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes
public final 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.
public final 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
object that specifies whether to enable Berkshelf and the Berkshelf
version on Chef 11.10 stacks. For more information, see Create a New
Stack.public final Boolean useCustomCookbooks()
Whether to use custom cookbooks.
public final 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.
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.
public final Source customCookbooksSource()
Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.
public final 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.
public final Boolean clonePermissions()
Whether to clone the source stack's permissions.
public final boolean hasCloneAppIds()
public final List<String> cloneAppIds()
A list of source stack app IDs to be included in the cloned stack.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasCloneAppIds()
to see if a value was sent in this field.
public final 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.
If the service returns an enum value that is not available in the current SDK version,
defaultRootDeviceType
will return RootDeviceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned
by the service is available from defaultRootDeviceTypeAsString()
.
RootDeviceType
public final String defaultRootDeviceTypeAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
defaultRootDeviceType
will return RootDeviceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned
by the service is available from defaultRootDeviceTypeAsString()
.
RootDeviceType
public final 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.
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.
public CloneStackRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CloneStackRequest.Builder,CloneStackRequest>
toBuilder
in class OpsWorksRequest
public static CloneStackRequest.Builder builder()
public static Class<? extends CloneStackRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.