Class CreateStackRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAttributesEntry
(String key, String value) Removes all the entries added into Attributes.clone()
Creates a shallow clone of this request.boolean
The default AWS OpsWorks agent version.One or more user-defined key-value pairs to be added to the stack attributes.AChefConfiguration
object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks.The configuration manager.A string that contains user-defined, custom JSON.The stack's default Availability Zone, which must be in the specified region.The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances.The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance.The default root device type.A default Amazon EC2 key pair name.The stack's default VPC subnet ID.The stack's host name theme, with spaces replaced by underscores.getName()
The stack name.The stack's AWS region, such as "us-east-1".The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf.Whether the stack uses custom cookbooks.Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.getVpcId()
The ID of the VPC that the stack is to be launched into.int
hashCode()
Whether the stack uses custom cookbooks.Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.void
setAgentVersion
(String agentVersion) The default AWS OpsWorks agent version.void
setAttributes
(Map<String, String> attributes) One or more user-defined key-value pairs to be added to the stack attributes.void
setChefConfiguration
(ChefConfiguration chefConfiguration) AChefConfiguration
object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks.void
setConfigurationManager
(StackConfigurationManager configurationManager) The configuration manager.void
setCustomCookbooksSource
(Source customCookbooksSource) void
setCustomJson
(String customJson) A string that contains user-defined, custom JSON.void
setDefaultAvailabilityZone
(String defaultAvailabilityZone) The stack's default Availability Zone, which must be in the specified region.void
setDefaultInstanceProfileArn
(String defaultInstanceProfileArn) The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances.void
setDefaultOs
(String defaultOs) The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance.void
setDefaultRootDeviceType
(RootDeviceType defaultRootDeviceType) The default root device type.void
setDefaultRootDeviceType
(String defaultRootDeviceType) The default root device type.void
setDefaultSshKeyName
(String defaultSshKeyName) A default Amazon EC2 key pair name.void
setDefaultSubnetId
(String defaultSubnetId) The stack's default VPC subnet ID.void
setHostnameTheme
(String hostnameTheme) The stack's host name theme, with spaces replaced by underscores.void
The stack name.void
The stack's AWS region, such as "us-east-1".void
setServiceRoleArn
(String serviceRoleArn) The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf.void
setUseCustomCookbooks
(Boolean useCustomCookbooks) Whether the stack uses custom cookbooks.void
setUseOpsworksSecurityGroups
(Boolean useOpsworksSecurityGroups) Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.void
The ID of the VPC that the stack is to be launched into.toString()
Returns a string representation of this object; useful for testing and debugging.withAgentVersion
(String agentVersion) The default AWS OpsWorks agent version.withAttributes
(Map<String, String> attributes) One or more user-defined key-value pairs to be added to the stack attributes.withChefConfiguration
(ChefConfiguration chefConfiguration) AChefConfiguration
object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks.withConfigurationManager
(StackConfigurationManager configurationManager) The configuration manager.withCustomCookbooksSource
(Source customCookbooksSource) withCustomJson
(String customJson) A string that contains user-defined, custom JSON.withDefaultAvailabilityZone
(String defaultAvailabilityZone) The stack's default Availability Zone, which must be in the specified region.withDefaultInstanceProfileArn
(String defaultInstanceProfileArn) The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances.withDefaultOs
(String defaultOs) The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance.withDefaultRootDeviceType
(RootDeviceType defaultRootDeviceType) The default root device type.withDefaultRootDeviceType
(String defaultRootDeviceType) The default root device type.withDefaultSshKeyName
(String defaultSshKeyName) A default Amazon EC2 key pair name.withDefaultSubnetId
(String defaultSubnetId) The stack's default VPC subnet ID.withHostnameTheme
(String hostnameTheme) The stack's host name theme, with spaces replaced by underscores.The stack name.withRegion
(String region) The stack's AWS region, such as "us-east-1".withServiceRoleArn
(String serviceRoleArn) The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf.withUseCustomCookbooks
(Boolean useCustomCookbooks) Whether the stack uses custom cookbooks.withUseOpsworksSecurityGroups
(Boolean useOpsworksSecurityGroups) Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.The ID of the VPC that the stack is to be launched into.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
CreateStackRequest
public CreateStackRequest()
-
-
Method Details
-
setName
The stack name.
- Parameters:
name
- The stack name.
-
getName
The stack name.
- Returns:
- The stack name.
-
withName
The stack name.
- Parameters:
name
- The stack name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setRegion
The stack's AWS region, such as "us-east-1". For more information about Amazon regions, see Regions and Endpoints.
- Parameters:
region
- The stack's AWS region, such as "us-east-1". For more information about Amazon regions, see Regions and Endpoints.
-
getRegion
The stack's AWS region, such as "us-east-1". For more information about Amazon regions, see Regions and Endpoints.
- Returns:
- The stack's AWS region, such as "us-east-1". For more information about Amazon regions, see Regions and Endpoints.
-
withRegion
The stack's AWS region, such as "us-east-1". For more information about Amazon regions, see Regions and Endpoints.
- Parameters:
region
- The stack's AWS region, such as "us-east-1". For more information about Amazon regions, see Regions and Endpoints.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setVpcId
The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. 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 theDefaultSubnetId
parameter only, AWS OpsWorks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks 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 with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2-Classic, see Supported Platforms.
- Parameters:
vpcId
- The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. 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 theDefaultSubnetId
parameter only, AWS OpsWorks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks 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 with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2-Classic, see Supported Platforms.
- If your account supports EC2-Classic, the default value is
- If your account supports EC2-Classic, the default value is
-
getVpcId
The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. 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 theDefaultSubnetId
parameter only, AWS OpsWorks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks 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 with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2-Classic, see Supported Platforms.
- Returns:
- The ID of the VPC that the stack is to be launched into. The VPC
must be in the stack's region. All instances are launched into
this VPC. 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 theDefaultSubnetId
parameter only, AWS OpsWorks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks 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 with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2-Classic, see Supported Platforms.
- If your account supports EC2-Classic, the default value is
- If your account supports EC2-Classic, the default value is
-
withVpcId
The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. 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 theDefaultSubnetId
parameter only, AWS OpsWorks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks 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 with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2-Classic, see Supported Platforms.
- Parameters:
vpcId
- The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. 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 theDefaultSubnetId
parameter only, AWS OpsWorks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks 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 with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2-Classic, see Supported Platforms.
- If your account supports EC2-Classic, the default value is
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- If your account supports EC2-Classic, the default value is
-
getAttributes
One or more user-defined key-value pairs to be added to the stack attributes.
- Returns:
- One or more user-defined key-value pairs to be added to the stack attributes.
-
setAttributes
One or more user-defined key-value pairs to be added to the stack attributes.
- Parameters:
attributes
- One or more user-defined key-value pairs to be added to the stack attributes.
-
withAttributes
One or more user-defined key-value pairs to be added to the stack attributes.
- Parameters:
attributes
- One or more user-defined key-value pairs to be added to the stack attributes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addAttributesEntry
-
clearAttributesEntries
Removes all the entries added into Attributes. <p> Returns a reference to this object so that method calls can be chained together. -
setServiceRoleArn
The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.
- Parameters:
serviceRoleArn
- The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.
-
getServiceRoleArn
The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.
- Returns:
- The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.
-
withServiceRoleArn
The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.
- Parameters:
serviceRoleArn
- The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDefaultInstanceProfileArn
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.
- Parameters:
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.
-
getDefaultInstanceProfileArn
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.
- Returns:
- 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.
-
withDefaultInstanceProfileArn
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDefaultOs
The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.
- A supported Linux operating system: An Amazon Linux version, such as
Amazon Linux 2015.03
,Red Hat Enterprise Linux 7
,Ubuntu 12.04 LTS
, orUbuntu 14.04 LTS
. Microsoft Windows Server 2012 R2 Base
.- A custom AMI:
Custom
. You specify the custom AMI you want to use when you create instances. For more information, see Using Custom AMIs.
The default option is the current Amazon Linux version. For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
- Parameters:
defaultOs
- The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.- A supported Linux operating system: An Amazon Linux version,
such as
Amazon Linux 2015.03
,Red Hat Enterprise Linux 7
,Ubuntu 12.04 LTS
, orUbuntu 14.04 LTS
. Microsoft Windows Server 2012 R2 Base
.- A custom AMI:
Custom
. You specify the custom AMI you want to use when you create instances. For more information, see Using Custom AMIs.
The default option is the current Amazon Linux version. For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
- A supported Linux operating system: An Amazon Linux version,
such as
- A supported Linux operating system: An Amazon Linux version, such as
-
getDefaultOs
The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.
- A supported Linux operating system: An Amazon Linux version, such as
Amazon Linux 2015.03
,Red Hat Enterprise Linux 7
,Ubuntu 12.04 LTS
, orUbuntu 14.04 LTS
. Microsoft Windows Server 2012 R2 Base
.- A custom AMI:
Custom
. You specify the custom AMI you want to use when you create instances. For more information, see Using Custom AMIs.
The default option is the current Amazon Linux version. For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
- Returns:
- The stack's default operating system, which is installed on every
instance unless you specify a different operating system when you
create the instance. You can specify one of the following.
- A supported Linux operating system: An Amazon Linux version,
such as
Amazon Linux 2015.03
,Red Hat Enterprise Linux 7
,Ubuntu 12.04 LTS
, orUbuntu 14.04 LTS
. Microsoft Windows Server 2012 R2 Base
.- A custom AMI:
Custom
. You specify the custom AMI you want to use when you create instances. For more information, see Using Custom AMIs.
The default option is the current Amazon Linux version. For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
- A supported Linux operating system: An Amazon Linux version,
such as
- A supported Linux operating system: An Amazon Linux version, such as
-
withDefaultOs
The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.
- A supported Linux operating system: An Amazon Linux version, such as
Amazon Linux 2015.03
,Red Hat Enterprise Linux 7
,Ubuntu 12.04 LTS
, orUbuntu 14.04 LTS
. Microsoft Windows Server 2012 R2 Base
.- A custom AMI:
Custom
. You specify the custom AMI you want to use when you create instances. For more information, see Using Custom AMIs.
The default option is the current Amazon Linux version. For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
- Parameters:
defaultOs
- The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.- A supported Linux operating system: An Amazon Linux version,
such as
Amazon Linux 2015.03
,Red Hat Enterprise Linux 7
,Ubuntu 12.04 LTS
, orUbuntu 14.04 LTS
. Microsoft Windows Server 2012 R2 Base
.- A custom AMI:
Custom
. You specify the custom AMI you want to use when you create instances. For more information, see Using Custom AMIs.
The default option is the current Amazon Linux version. For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
- A supported Linux operating system: An Amazon Linux version,
such as
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- A supported Linux operating system: An Amazon Linux version, such as
-
setHostnameTheme
The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default,
HostnameTheme
is set toLayer_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.- Parameters:
hostnameTheme
- The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default,HostnameTheme
is set toLayer_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.-
-
-
getHostnameTheme
The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default,
HostnameTheme
is set toLayer_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.- Returns:
- The stack's host name theme, with spaces replaced by underscores.
The theme is used to generate host names for the stack's
instances. By default,
HostnameTheme
is set toLayer_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. -
-
-
withHostnameTheme
The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default,
HostnameTheme
is set toLayer_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.- Parameters:
hostnameTheme
- The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default,HostnameTheme
is set toLayer_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.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
setDefaultAvailabilityZone
The 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 theVpcId
parameter description.- Parameters:
defaultAvailabilityZone
- The 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 forDefaultSubnetId
, the subnet must be in the same zone. For more information, see theVpcId
parameter description.
-
getDefaultAvailabilityZone
The 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 theVpcId
parameter description.- Returns:
- The 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 theVpcId
parameter description.
-
withDefaultAvailabilityZone
The 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 theVpcId
parameter description.- Parameters:
defaultAvailabilityZone
- The 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 forDefaultSubnetId
, the subnet must be in the same zone. For more information, see theVpcId
parameter description.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDefaultSubnetId
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 forDefaultAvailabilityZone
, the subnet must be in that zone. For information on default values and when this parameter is required, see theVpcId
parameter description.- Parameters:
defaultSubnetId
- The stack's default VPC subnet ID. This parameter is required if you specify a value for theVpcId
parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value forDefaultAvailabilityZone
, the subnet must be in that zone. For information on default values and when this parameter is required, see theVpcId
parameter description.
-
getDefaultSubnetId
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 forDefaultAvailabilityZone
, the subnet must be in that zone. For information on default values and when this parameter is required, see theVpcId
parameter description.- Returns:
- 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 forDefaultAvailabilityZone
, the subnet must be in that zone. For information on default values and when this parameter is required, see theVpcId
parameter description.
-
withDefaultSubnetId
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 forDefaultAvailabilityZone
, the subnet must be in that zone. For information on default values and when this parameter is required, see theVpcId
parameter description.- Parameters:
defaultSubnetId
- The stack's default VPC subnet ID. This parameter is required if you specify a value for theVpcId
parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value forDefaultAvailabilityZone
, the subnet must be in that zone. For information on default values and when this parameter is required, see theVpcId
parameter description.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCustomJson
A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following escape characters such as '"':
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
- Parameters:
customJson
- A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following escape characters such as '"':"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
-
getCustomJson
A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following escape characters such as '"':
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
- Returns:
- A string that contains user-defined, custom JSON. It can be used
to override the corresponding default stack configuration
attribute values or to pass data to recipes. The string should be
in the following escape characters such as '"':
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
-
withCustomJson
A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following escape characters such as '"':
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
- Parameters:
customJson
- A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following escape characters such as '"':"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setConfigurationManager
The configuration manager. When you create 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 11.4.
- Parameters:
configurationManager
- The configuration manager. When you create 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 11.4.
-
getConfigurationManager
The configuration manager. When you create 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 11.4.
- Returns:
- The configuration manager. When you create 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 11.4.
-
withConfigurationManager
The configuration manager. When you create 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 11.4.
- Parameters:
configurationManager
- The configuration manager. When you create 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 11.4.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setChefConfiguration
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.- Parameters:
chefConfiguration
- AChefConfiguration
object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.
-
getChefConfiguration
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.- Returns:
- 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.
-
withChefConfiguration
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.- Parameters:
chefConfiguration
- AChefConfiguration
object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setUseCustomCookbooks
Whether the stack uses custom cookbooks.
- Parameters:
useCustomCookbooks
- Whether the stack uses custom cookbooks.
-
getUseCustomCookbooks
Whether the stack uses custom cookbooks.
- Returns:
- Whether the stack uses custom cookbooks.
-
withUseCustomCookbooks
Whether the stack uses custom cookbooks.
- Parameters:
useCustomCookbooks
- Whether the stack uses custom cookbooks.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isUseCustomCookbooks
Whether the stack uses custom cookbooks.
- Returns:
- Whether the stack uses custom cookbooks.
-
setUseOpsworksSecurityGroups
Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.
AWS OpsWorks 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 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 does not associate built-in security groups with layers. You must create appropriate 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.
- Parameters:
useOpsworksSecurityGroups
- Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.AWS OpsWorks 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 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 does not associate built-in security groups with layers. You must create appropriate 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.
-
getUseOpsworksSecurityGroups
Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.
AWS OpsWorks 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 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 does not associate built-in security groups with layers. You must create appropriate 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.
- Returns:
- Whether to associate the AWS OpsWorks built-in security groups
with the stack's layers.
AWS OpsWorks 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 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 does not associate built-in security groups with layers. You must create appropriate 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.
-
withUseOpsworksSecurityGroups
Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.
AWS OpsWorks 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 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 does not associate built-in security groups with layers. You must create appropriate 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.
- Parameters:
useOpsworksSecurityGroups
- Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.AWS OpsWorks 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 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 does not associate built-in security groups with layers. You must create appropriate 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isUseOpsworksSecurityGroups
Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.
AWS OpsWorks 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 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 does not associate built-in security groups with layers. You must create appropriate 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.
- Returns:
- Whether to associate the AWS OpsWorks built-in security groups
with the stack's layers.
AWS OpsWorks 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 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 does not associate built-in security groups with layers. You must create appropriate 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.
-
setCustomCookbooksSource
- Parameters:
customCookbooksSource
-
-
getCustomCookbooksSource
- Returns:
-
withCustomCookbooksSource
- Parameters:
customCookbooksSource
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDefaultSshKeyName
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.
- Parameters:
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.
-
getDefaultSshKeyName
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.
- Returns:
- 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.
-
withDefaultSshKeyName
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDefaultRootDeviceType
The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is
instance-store
. For more information, see Storage for the Root Device.- Parameters:
defaultRootDeviceType
- The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option isinstance-store
. For more information, see Storage for the Root Device.- See Also:
-
getDefaultRootDeviceType
The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is
instance-store
. For more information, see Storage for the Root Device.- Returns:
- The default root device type. This value is the default for all
instances in the stack, but you can override it when you create
an instance. The default option is
instance-store
. For more information, see Storage for the Root Device. - See Also:
-
withDefaultRootDeviceType
The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is
instance-store
. For more information, see Storage for the Root Device.- Parameters:
defaultRootDeviceType
- The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option isinstance-store
. For more information, see Storage for the Root Device.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setDefaultRootDeviceType
The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is
instance-store
. For more information, see Storage for the Root Device.- Parameters:
defaultRootDeviceType
- The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option isinstance-store
. For more information, see Storage for the Root Device.- See Also:
-
withDefaultRootDeviceType
The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is
instance-store
. For more information, see Storage for the Root Device.- Parameters:
defaultRootDeviceType
- The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option isinstance-store
. For more information, see Storage for the Root Device.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setAgentVersion
The default AWS OpsWorks agent version. You have the following options:
- Auto-update - Set this parameter to
LATEST
. AWS OpsWorks 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 then automatically installs that version on the stack's instances.
The default setting is the most recent release of the agent. 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.
You can also specify an agent version when you create or update an instance, which overrides the stack's default setting. - Parameters:
agentVersion
- The default AWS OpsWorks agent version. You have the following options:- Auto-update - Set this parameter to
LATEST
. AWS OpsWorks 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 then automatically installs that version on the stack's instances.
The default setting is the most recent release of the agent. 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.
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
- Auto-update - Set this parameter to
-
getAgentVersion
The default AWS OpsWorks agent version. You have the following options:
- Auto-update - Set this parameter to
LATEST
. AWS OpsWorks 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 then automatically installs that version on the stack's instances.
The default setting is the most recent release of the agent. 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.
You can also specify an agent version when you create or update an instance, which overrides the stack's default setting. - Returns:
- The default AWS OpsWorks agent version. You have the following
options:
- Auto-update - Set this parameter to
LATEST
. AWS OpsWorks 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 then automatically installs that version on the stack's instances.
The default setting is the most recent release of the agent. 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.
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
- Auto-update - Set this parameter to
-
withAgentVersion
The default AWS OpsWorks agent version. You have the following options:
- Auto-update - Set this parameter to
LATEST
. AWS OpsWorks 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 then automatically installs that version on the stack's instances.
The default setting is the most recent release of the agent. 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.
You can also specify an agent version when you create or update an instance, which overrides the stack's default setting. - Parameters:
agentVersion
- The default AWS OpsWorks agent version. You have the following options:- Auto-update - Set this parameter to
LATEST
. AWS OpsWorks 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 then automatically installs that version on the stack's instances.
The default setting is the most recent release of the agent. 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.
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- Auto-update - Set this parameter to
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-