Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.opsworks.model
Class CreateStackRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.opsworks.model.CreateStackRequest
All Implemented Interfaces:
Serializable
public class CreateStackRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the CreateStack operation.

Creates a new stack. For more information, see Create a New Stack .

Required Permissions : To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .

See Also:
AWSOpsWorks.createStack(CreateStackRequest), Serialized Form

Constructor Summary
CreateStackRequest()
           
 
Method Summary
 CreateStackRequest addAttributesEntry(String key, String value)
          One or more user-defined key/value pairs to be added to the stack attributes.
 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.
 ChefConfiguration getChefConfiguration()
          A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks.
 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.
 Boolean getUseOpsworksSecurityGroups()
          Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.
 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.
 Boolean isUseOpsworksSecurityGroups()
          Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.
 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)
          A ChefConfiguration 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)
          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 setUseOpsworksSecurityGroups(Boolean useOpsworksSecurityGroups)
          Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.
 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.
 CreateStackRequest withChefConfiguration(ChefConfiguration chefConfiguration)
          A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks.
 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 withUseOpsworksSecurityGroups(Boolean useOpsworksSecurityGroups)
          Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.
 CreateStackRequest withVpcId(String vpcId)
          The ID of the VPC that the stack is to be launched into.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CreateStackRequest

public CreateStackRequest()
Method Detail

getName

public String getName()
The stack name.

Returns:
The stack name.

setName

public void setName(String name)
The stack name.

Parameters:
name - The stack name.

withName

public CreateStackRequest withName(String name)
The stack name.

Returns a reference to this object so that method calls can be chained together.

Parameters:
name - The stack name.
Returns:
A reference to this updated object so that method calls can be chained together.

getRegion

public String getRegion()
The stack AWS region, such as "us-east-1". For more information about Amazon regions, see Regions and Endpoints.

Returns:
The stack AWS region, such as "us-east-1". For more information about Amazon regions, see Regions and Endpoints.

setRegion

public void setRegion(String region)
The stack AWS region, such as "us-east-1". For more information about Amazon regions, see Regions and Endpoints.

Parameters:
region - The stack AWS region, such as "us-east-1". For more information about Amazon regions, see Regions and Endpoints.

withRegion

public CreateStackRequest withRegion(String region)
The stack AWS region, such as "us-east-1". For more information about Amazon regions, see Regions and Endpoints.

Returns a reference to this object so that method calls can be chained together.

Parameters:
region - The stack AWS region, such as "us-east-1". For more information about Amazon regions, see Regions and Endpoints.
Returns:
A reference to this updated object so that method calls can be chained together.

getVpcId

public String getVpcId()
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:

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. It must be in the specified region. All instances will be 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 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.

setVpcId

public void setVpcId(String 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:

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. It must be in the specified region. All instances will be 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 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.

withVpcId

public CreateStackRequest withVpcId(String 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:

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.

Parameters:
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 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 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:
A reference to this updated object so that method calls can be chained together.

getAttributes

public Map<String,String> 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

public void setAttributes(Map<String,String> attributes)
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

public CreateStackRequest withAttributes(Map<String,String> attributes)
One or more user-defined key/value pairs to be added to the stack attributes.

Returns a reference to this object so that method calls can be chained together.

Parameters:
attributes - One or more user-defined key/value pairs to be added to the stack attributes.
Returns:
A reference to this updated object so that method calls can be chained together.

addAttributesEntry

public CreateStackRequest addAttributesEntry(String key,
                                             String value)
One or more user-defined key/value pairs to be added to the stack attributes.

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.

Parameters:
key - The key of the entry to be added into Attributes.
value - The corresponding value of the entry to be added into Attributes.

clearAttributesEntries

public CreateStackRequest clearAttributesEntries()
Removes all the entries added into Attributes.

Returns a reference to this object so that method calls can be chained together.

getServiceRoleArn

public String getServiceRoleArn()
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.

Returns:
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.

setServiceRoleArn

public 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. 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 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

public 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. 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 a reference to this object so that method calls can be chained together.

Parameters:
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.
Returns:
A reference to this updated object so that method calls can be chained together.

getDefaultInstanceProfileArn

public String getDefaultInstanceProfileArn()
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.

Returns:
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.

setDefaultInstanceProfileArn

public void setDefaultInstanceProfileArn(String 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.

Parameters:
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.

withDefaultInstanceProfileArn

public CreateStackRequest withDefaultInstanceProfileArn(String 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:
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.
Returns:
A reference to this updated object so that method calls can be chained together.

getDefaultOs

public String getDefaultOs()
The stack's default operating system, which must be set to Amazon Linux or Ubuntu 12.04 LTS. The default option is Amazon Linux.

Returns:
The stack's default operating system, which must be set to Amazon Linux or Ubuntu 12.04 LTS. The default option is Amazon Linux.

setDefaultOs

public void setDefaultOs(String 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.

Parameters:
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.

withDefaultOs

public CreateStackRequest withDefaultOs(String 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:
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.
Returns:
A reference to this updated object so that method calls can be chained together.

getHostnameTheme

public String getHostnameTheme()
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.

Returns:
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
  • European_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.

setHostnameTheme

public void setHostnameTheme(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:

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 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
  • European_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

public CreateStackRequest withHostnameTheme(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:

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.

Parameters:
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
  • European_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:
A reference to this updated object so that method calls can be chained together.

getDefaultAvailabilityZone

public String 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 the VpcId 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 the VpcId parameter description.

setDefaultAvailabilityZone

public void setDefaultAvailabilityZone(String 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.

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 for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.

withDefaultAvailabilityZone

public CreateStackRequest withDefaultAvailabilityZone(String 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.

Returns a reference to this object so that method calls can be chained together.

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 for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.
Returns:
A reference to this updated object so that method calls can be chained together.

getDefaultSubnetId

public String getDefaultSubnetId()
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.

Returns:
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.

setDefaultSubnetId

public void setDefaultSubnetId(String 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.

Parameters:
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.

withDefaultSubnetId

public CreateStackRequest withDefaultSubnetId(String 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:
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.
Returns:
A reference to this updated object so that method calls can be chained together.

getCustomJson

public String getCustomJson()
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.

Returns:
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.

setCustomJson

public void setCustomJson(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 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.

Parameters:
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.

withCustomJson

public CreateStackRequest withCustomJson(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 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:
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.

Returns:
A reference to this updated object so that method calls can be chained together.

getConfigurationManager

public StackConfigurationManager getConfigurationManager()
The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version, 0.9, 11.4, or 11.10. The default value is currently 11.4.

Returns:
The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version, 0.9, 11.4, or 11.10. The default value is currently 11.4.

setConfigurationManager

public void setConfigurationManager(StackConfigurationManager configurationManager)
The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version, 0.9, 11.4, or 11.10. The default value is currently 11.4.

Parameters:
configurationManager - The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version, 0.9, 11.4, or 11.10. The default value is currently 11.4.

withConfigurationManager

public CreateStackRequest withConfigurationManager(StackConfigurationManager configurationManager)
The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version, 0.9, 11.4, or 11.10. The default value is currently 11.4.

Returns a reference to this object so that method calls can be chained together.

Parameters:
configurationManager - The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version, 0.9, 11.4, or 11.10. The default value is currently 11.4.
Returns:
A reference to this updated object so that method calls can be chained together.

getChefConfiguration

public ChefConfiguration 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.

setChefConfiguration

public void setChefConfiguration(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.

Parameters:
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.

withChefConfiguration

public CreateStackRequest withChefConfiguration(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.

Returns a reference to this object so that method calls can be chained together.

Parameters:
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.
Returns:
A reference to this updated object so that method calls can be chained together.

isUseCustomCookbooks

public Boolean isUseCustomCookbooks()
Whether the stack uses custom cookbooks.

Returns:
Whether the stack uses custom cookbooks.

setUseCustomCookbooks

public void setUseCustomCookbooks(Boolean useCustomCookbooks)
Whether the stack uses custom cookbooks.

Parameters:
useCustomCookbooks - Whether the stack uses custom cookbooks.

withUseCustomCookbooks

public CreateStackRequest withUseCustomCookbooks(Boolean useCustomCookbooks)
Whether the stack uses custom cookbooks.

Returns a reference to this object so that method calls can be chained together.

Parameters:
useCustomCookbooks - Whether the stack uses custom cookbooks.
Returns:
A reference to this updated object so that method calls can be chained together.

getUseCustomCookbooks

public Boolean getUseCustomCookbooks()
Whether the stack uses custom cookbooks.

Returns:
Whether the stack uses custom cookbooks.

isUseOpsworksSecurityGroups

public Boolean 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:

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.

setUseOpsworksSecurityGroups

public void setUseOpsworksSecurityGroups(Boolean 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:

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.

withUseOpsworksSecurityGroups

public CreateStackRequest withUseOpsworksSecurityGroups(Boolean 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:

For more information, see Create a New Stack.

Returns a reference to this object so that method calls can be chained together.

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:
A reference to this updated object so that method calls can be chained together.

getUseOpsworksSecurityGroups

public Boolean 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:

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.

getCustomCookbooksSource

public Source getCustomCookbooksSource()
Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.

Returns:
Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.

setCustomCookbooksSource

public void setCustomCookbooksSource(Source 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.

Parameters:
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.

withCustomCookbooksSource

public CreateStackRequest withCustomCookbooksSource(Source 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:
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.
Returns:
A reference to this updated object so that method calls can be chained together.

getDefaultSshKeyName

public String getDefaultSshKeyName()
A default SSH key for the stack instances. You can override this value when you create or update an instance.

Returns:
A default SSH key for the stack instances. You can override this value when you create or update an instance.

setDefaultSshKeyName

public void setDefaultSshKeyName(String defaultSshKeyName)
A default SSH key for the stack instances. You can override this value when you create or update an instance.

Parameters:
defaultSshKeyName - A default SSH key for the stack instances. You can override this value when you create or update an instance.

withDefaultSshKeyName

public CreateStackRequest withDefaultSshKeyName(String defaultSshKeyName)
A default SSH key for the stack instances. You can override this value when you create or update an instance.

Returns a reference to this object so that method calls can be chained together.

Parameters:
defaultSshKeyName - A default SSH key for the stack instances. You can override this value when you create or update an instance.
Returns:
A reference to this updated object so that method calls can be chained together.

getDefaultRootDeviceType

public String getDefaultRootDeviceType()
The default root device type. This value is used by 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.

Constraints:
Allowed Values: ebs, instance-store

Returns:
The default root device type. This value is used by 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:
RootDeviceType

setDefaultRootDeviceType

public void setDefaultRootDeviceType(String defaultRootDeviceType)
The default root device type. This value is used by 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.

Constraints:
Allowed Values: ebs, instance-store

Parameters:
defaultRootDeviceType - The default root device type. This value is used by 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:
RootDeviceType

withDefaultRootDeviceType

public CreateStackRequest withDefaultRootDeviceType(String defaultRootDeviceType)
The default root device type. This value is used by 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 a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: ebs, instance-store

Parameters:
defaultRootDeviceType - The default root device type. This value is used by 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:
A reference to this updated object so that method calls can be chained together.
See Also:
RootDeviceType

setDefaultRootDeviceType

public void setDefaultRootDeviceType(RootDeviceType defaultRootDeviceType)
The default root device type. This value is used by 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.

Constraints:
Allowed Values: ebs, instance-store

Parameters:
defaultRootDeviceType - The default root device type. This value is used by 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:
RootDeviceType

withDefaultRootDeviceType

public CreateStackRequest withDefaultRootDeviceType(RootDeviceType defaultRootDeviceType)
The default root device type. This value is used by 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 a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: ebs, instance-store

Parameters:
defaultRootDeviceType - The default root device type. This value is used by 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:
A reference to this updated object so that method calls can be chained together.
See Also:
RootDeviceType

toString

public String toString()
Returns a string representation of this object; useful for testing and debugging.

Overrides:
toString in class Object
Returns:
A string representation of this object.
See Also:
Object.toString()

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2016. All rights reserved.