public class CreateStackRequest extends AmazonWebServiceRequest implements Serializable
CreateStack operation
.
Creates a new stack. For more information, see Create a New Stack .
Constructor and Description |
---|
CreateStackRequest() |
Modifier and Type | Method and Description |
---|---|
CreateStackRequest |
addAttributesEntry(String key,
String value)
One or more user-defined key/value pairs to be added to the stack
attributes bag.
|
CreateStackRequest |
clearAttributesEntries()
Removes all the entries added into Attributes.
|
boolean |
equals(Object obj) |
Map<String,String> |
getAttributes()
One or more user-defined key/value pairs to be added to the stack
attributes bag.
|
StackConfigurationManager |
getConfigurationManager()
The configuration manager.
|
Source |
getCustomCookbooksSource()
Contains the information required to retrieve an app or cookbook from
a repository.
|
String |
getCustomJson()
A string that contains user-defined, custom JSON.
|
String |
getDefaultAvailabilityZone()
The stack's default Availability Zone, which must be in the specified
region.
|
String |
getDefaultInstanceProfileArn()
The ARN of an IAM profile that is the default profile for all of the
stack's EC2 instances.
|
String |
getDefaultOs()
The stack's default operating system, which must be set to
Amazon Linux or Ubuntu 12.04 LTS . |
String |
getDefaultRootDeviceType()
The default root device type.
|
String |
getDefaultSshKeyName()
A default SSH key for the stack instances.
|
String |
getDefaultSubnetId()
The stack's default subnet ID.
|
String |
getHostnameTheme()
The stack's host name theme, with spaces are replaced by underscores.
|
String |
getName()
The stack name.
|
String |
getRegion()
The stack AWS region, such as "us-east-1".
|
String |
getServiceRoleArn()
The stack AWS Identity and Access Management (IAM) role, which allows
AWS OpsWorks to work with AWS resources on your behalf.
|
Boolean |
getUseCustomCookbooks()
Whether the stack uses custom cookbooks.
|
String |
getVpcId()
The ID of the VPC that the stack is to be launched into.
|
int |
hashCode() |
Boolean |
isUseCustomCookbooks()
Whether the stack uses custom cookbooks.
|
void |
setAttributes(Map<String,String> attributes)
One or more user-defined key/value pairs to be added to the stack
attributes bag.
|
void |
setConfigurationManager(StackConfigurationManager configurationManager)
The configuration manager.
|
void |
setCustomCookbooksSource(Source customCookbooksSource)
Contains the information required to retrieve an app or cookbook from
a repository.
|
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 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 must be set to
Amazon Linux or Ubuntu 12.04 LTS . |
void |
setDefaultRootDeviceType(RootDeviceType defaultRootDeviceType)
The default root device type.
|
void |
setDefaultRootDeviceType(String defaultRootDeviceType)
The default root device type.
|
void |
setDefaultSshKeyName(String defaultSshKeyName)
A default SSH key for the stack instances.
|
void |
setDefaultSubnetId(String defaultSubnetId)
The stack's default subnet ID.
|
void |
setHostnameTheme(String hostnameTheme)
The stack's host name theme, with spaces are replaced by underscores.
|
void |
setName(String name)
The stack name.
|
void |
setRegion(String region)
The stack AWS region, such as "us-east-1".
|
void |
setServiceRoleArn(String serviceRoleArn)
The stack 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 |
setVpcId(String vpcId)
The ID of the VPC that the stack is to be launched into.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CreateStackRequest |
withAttributes(Map<String,String> attributes)
One or more user-defined key/value pairs to be added to the stack
attributes bag.
|
CreateStackRequest |
withConfigurationManager(StackConfigurationManager configurationManager)
The configuration manager.
|
CreateStackRequest |
withCustomCookbooksSource(Source customCookbooksSource)
Contains the information required to retrieve an app or cookbook from
a repository.
|
CreateStackRequest |
withCustomJson(String customJson)
A string that contains user-defined, custom JSON.
|
CreateStackRequest |
withDefaultAvailabilityZone(String defaultAvailabilityZone)
The stack's default Availability Zone, which must be in the specified
region.
|
CreateStackRequest |
withDefaultInstanceProfileArn(String defaultInstanceProfileArn)
The ARN of an IAM profile that is the default profile for all of the
stack's EC2 instances.
|
CreateStackRequest |
withDefaultOs(String defaultOs)
The stack's default operating system, which must be set to
Amazon Linux or Ubuntu 12.04 LTS . |
CreateStackRequest |
withDefaultRootDeviceType(RootDeviceType defaultRootDeviceType)
The default root device type.
|
CreateStackRequest |
withDefaultRootDeviceType(String defaultRootDeviceType)
The default root device type.
|
CreateStackRequest |
withDefaultSshKeyName(String defaultSshKeyName)
A default SSH key for the stack instances.
|
CreateStackRequest |
withDefaultSubnetId(String defaultSubnetId)
The stack's default subnet ID.
|
CreateStackRequest |
withHostnameTheme(String hostnameTheme)
The stack's host name theme, with spaces are replaced by underscores.
|
CreateStackRequest |
withName(String name)
The stack name.
|
CreateStackRequest |
withRegion(String region)
The stack AWS region, such as "us-east-1".
|
CreateStackRequest |
withServiceRoleArn(String serviceRoleArn)
The stack AWS Identity and Access Management (IAM) role, which allows
AWS OpsWorks to work with AWS resources on your behalf.
|
CreateStackRequest |
withUseCustomCookbooks(Boolean useCustomCookbooks)
Whether the stack uses custom cookbooks.
|
CreateStackRequest |
withVpcId(String vpcId)
The ID of the VPC that the stack is to be launched into.
|
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector
public String getName()
public void setName(String name)
name
- The stack name.public CreateStackRequest withName(String name)
Returns a reference to this object so that method calls can be chained together.
name
- The stack name.public String getRegion()
public void setRegion(String region)
region
- The stack AWS region, such as "us-east-1". For more information about
Amazon regions, see Regions
and Endpoints.public CreateStackRequest withRegion(String region)
Returns a reference to this object so that method calls can be chained together.
region
- The stack AWS region, such as "us-east-1". For more information about
Amazon regions, see Regions
and Endpoints.public String getVpcId()
If the VPC ID corresponds to a
default VPC and you have specified either the
DefaultAvailabilityZone
or the
DefaultSubnetId
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:
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 the VPC ID corresponds to a
default VPC and you have specified either the
DefaultAvailabilityZone
or the
DefaultSubnetId
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:
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.
public void setVpcId(String vpcId)
If the VPC ID corresponds to a
default VPC and you have specified either the
DefaultAvailabilityZone
or the
DefaultSubnetId
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:
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.
vpcId
- The ID of the VPC that the stack is to be launched into. It must be in
the specified region. All instances will be launched into this VPC,
and you cannot change the ID later. If the VPC ID corresponds to a
default VPC and you have specified either the
DefaultAvailabilityZone
or the
DefaultSubnetId
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:
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.
public CreateStackRequest withVpcId(String vpcId)
If the VPC ID corresponds to a
default VPC and you have specified either the
DefaultAvailabilityZone
or the
DefaultSubnetId
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:
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 a reference to this object so that method calls can be chained together.
vpcId
- The ID of the VPC that the stack is to be launched into. It must be in
the specified region. All instances will be launched into this VPC,
and you cannot change the ID later. If the VPC ID corresponds to a
default VPC and you have specified either the
DefaultAvailabilityZone
or the
DefaultSubnetId
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:
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.
public Map<String,String> getAttributes()
public void setAttributes(Map<String,String> attributes)
attributes
- One or more user-defined key/value pairs to be added to the stack
attributes bag.public CreateStackRequest withAttributes(Map<String,String> attributes)
Returns a reference to this object so that method calls can be chained together.
attributes
- One or more user-defined key/value pairs to be added to the stack
attributes bag.public CreateStackRequest addAttributesEntry(String key, String value)
The method adds a new key-value pair into Attributes parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into Attributes.value
- The corresponding value of the entry to be added into Attributes.public CreateStackRequest clearAttributesEntries()
Returns a reference to this object so that method calls can be chained together.
public String getServiceRoleArn()
public void setServiceRoleArn(String serviceRoleArn)
serviceRoleArn
- The stack 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.public CreateStackRequest withServiceRoleArn(String serviceRoleArn)
Returns a reference to this object so that method calls can be chained together.
serviceRoleArn
- The stack 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.public String getDefaultInstanceProfileArn()
public void setDefaultInstanceProfileArn(String defaultInstanceProfileArn)
defaultInstanceProfileArn
- The 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 CreateStackRequest withDefaultInstanceProfileArn(String defaultInstanceProfileArn)
Returns a reference to this object so that method calls can be chained together.
defaultInstanceProfileArn
- The 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 String getDefaultOs()
Amazon Linux
or Ubuntu 12.04 LTS
. The
default option is Amazon Linux
.Amazon Linux
or Ubuntu 12.04 LTS
. The
default option is Amazon Linux
.public void setDefaultOs(String defaultOs)
Amazon Linux
or Ubuntu 12.04 LTS
. The
default option is Amazon Linux
.defaultOs
- The stack's default operating system, which must be set to
Amazon Linux
or Ubuntu 12.04 LTS
. The
default option is Amazon Linux
.public CreateStackRequest withDefaultOs(String defaultOs)
Amazon Linux
or Ubuntu 12.04 LTS
. The
default option is Amazon Linux
.
Returns a reference to this object so that method calls can be chained together.
defaultOs
- The stack's default operating system, which must be set to
Amazon Linux
or Ubuntu 12.04 LTS
. The
default option is Amazon Linux
.public String getHostnameTheme()
HostnameTheme
is set to Layer_Dependent, which
creates host names by appending integers to the layer's short name.
The other themes are: 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: To obtain a generated host name, call
GetHostNameSuggestion
, which returns a host name based on
the current theme.
public void setHostnameTheme(String hostnameTheme)
HostnameTheme
is set to Layer_Dependent, which
creates host names by appending integers to the layer's short name.
The other themes are: 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: To obtain a generated host name, call
GetHostNameSuggestion
, which returns a host name based on
the current theme.
public CreateStackRequest withHostnameTheme(String hostnameTheme)
HostnameTheme
is set to Layer_Dependent, which
creates host names by appending integers to the layer's short name.
The other themes are: To obtain a generated host name, call
GetHostNameSuggestion
, which returns a host name based on
the current theme.
Returns a reference to this object so that method calls can be chained together.
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: To obtain a generated host name, call
GetHostNameSuggestion
, which returns a host name based on
the current theme.
public String getDefaultAvailabilityZone()
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 void setDefaultAvailabilityZone(String defaultAvailabilityZone)
DefaultSubnetId
, the subnet must be in the same zone. For
more information, see the VpcId
parameter description.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 for
DefaultSubnetId
, the subnet must be in the same zone. For
more information, see the VpcId
parameter description.public CreateStackRequest withDefaultAvailabilityZone(String defaultAvailabilityZone)
DefaultSubnetId
, the subnet must be in the same zone. For
more information, see the VpcId
parameter description.
Returns a reference to this object so that method calls can be chained together.
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 for
DefaultSubnetId
, the subnet must be in the same zone. For
more information, see the VpcId
parameter description.public String getDefaultSubnetId()
DefaultAvailabilityZone
,
the subnet must be in that zone. For information on default values and
when this parameter is required, see the VpcId
parameter
description.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 void setDefaultSubnetId(String defaultSubnetId)
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 subnet ID. All instances will be 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 CreateStackRequest withDefaultSubnetId(String defaultSubnetId)
DefaultAvailabilityZone
,
the subnet must be in that zone. For information on default values and
when this parameter is required, see the VpcId
parameter
description.
Returns a reference to this object so that method calls can be chained together.
defaultSubnetId
- The stack's default subnet ID. All instances will be 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 String getCustomJson()
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
public void setCustomJson(String customJson)
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
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 and must escape
characters such as '"'.: "{\"key1\": \"value1\", \"key2\":
\"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
public CreateStackRequest withCustomJson(String customJson)
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
Returns a reference to this object so that method calls can be chained together.
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 and must escape
characters such as '"'.: "{\"key1\": \"value1\", \"key2\":
\"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
public StackConfigurationManager getConfigurationManager()
public void setConfigurationManager(StackConfigurationManager configurationManager)
configurationManager
- The configuration manager. When you create a stack we recommend that
you use the configuration manager to specify the Chef version, 0.9 or
11.4. The default value is currently 0.9. However, we expect to change
the default value to 11.4 in September 2013.public CreateStackRequest withConfigurationManager(StackConfigurationManager configurationManager)
Returns a reference to this object so that method calls can be chained together.
configurationManager
- The configuration manager. When you create a stack we recommend that
you use the configuration manager to specify the Chef version, 0.9 or
11.4. The default value is currently 0.9. However, we expect to change
the default value to 11.4 in September 2013.public Boolean isUseCustomCookbooks()
public void setUseCustomCookbooks(Boolean useCustomCookbooks)
useCustomCookbooks
- Whether the stack uses custom cookbooks.public CreateStackRequest withUseCustomCookbooks(Boolean useCustomCookbooks)
Returns a reference to this object so that method calls can be chained together.
useCustomCookbooks
- Whether the stack uses custom cookbooks.public Boolean getUseCustomCookbooks()
public Source getCustomCookbooksSource()
public void setCustomCookbooksSource(Source customCookbooksSource)
customCookbooksSource
- Contains the information required to retrieve an app or cookbook from
a repository. For more information, see Creating
Apps or Custom
Recipes and Cookbooks.public CreateStackRequest withCustomCookbooksSource(Source customCookbooksSource)
Returns a reference to this object so that method calls can be chained together.
customCookbooksSource
- Contains the information required to retrieve an app or cookbook from
a repository. For more information, see Creating
Apps or Custom
Recipes and Cookbooks.public String getDefaultSshKeyName()
public void setDefaultSshKeyName(String defaultSshKeyName)
defaultSshKeyName
- A default SSH key for the stack instances. You can override this value
when you create or update an instance.public CreateStackRequest withDefaultSshKeyName(String defaultSshKeyName)
Returns a reference to this object so that method calls can be chained together.
defaultSshKeyName
- A default SSH key for the stack instances. You can override this value
when you create or update an instance.public String getDefaultRootDeviceType()
Constraints:
Allowed Values: ebs, instance-store
RootDeviceType
public void setDefaultRootDeviceType(String defaultRootDeviceType)
Constraints:
Allowed Values: ebs, instance-store
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
public CreateStackRequest withDefaultRootDeviceType(String defaultRootDeviceType)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ebs, instance-store
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
public void setDefaultRootDeviceType(RootDeviceType defaultRootDeviceType)
Constraints:
Allowed Values: ebs, instance-store
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
public CreateStackRequest withDefaultRootDeviceType(RootDeviceType defaultRootDeviceType)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ebs, instance-store
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
public String toString()
toString
in class Object
Object.toString()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.