Overview  Package   Class  Index  Help 

Did this page help you?

   Yes   No   Tell us about it...
 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 .

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

Constructor Summary
CreateStackRequest()
           
 
Method Summary
 boolean equals(Object obj)
           
 Map<String,String> getAttributes()
          One or more user-defined key/value pairs to be added to the stack attributes bag.
 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 default Availability Zone.
 String getDefaultInstanceProfileArn()
          The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances.
 String getDefaultOs()
          The cloned stack default operating system, which must be either "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 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 OpsWorks to work with AWS resources on your behalf.
 Boolean getUseCustomCookbooks()
          Whether the stack uses custom cookbooks.
 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 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 default Availability Zone.
 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 cloned stack default operating system, which must be either "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 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 OpsWorks to work with AWS resources on your behalf.
 void setUseCustomCookbooks(Boolean useCustomCookbooks)
          Whether the stack uses custom cookbooks.
 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 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 default Availability Zone.
 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 cloned stack default operating system, which must be either "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 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 OpsWorks to work with AWS resources on your behalf.
 CreateStackRequest withUseCustomCookbooks(Boolean useCustomCookbooks)
          Whether the stack uses custom cookbooks.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials
 
Methods inherited from class java.lang.Object
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.

getAttributes

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

Returns:
One or more user-defined key/value pairs to be added to the stack attributes bag.

setAttributes

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

Parameters:
attributes - One or more user-defined key/value pairs to be added to the stack attributes bag.

withAttributes

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

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

getServiceRoleArn

public String getServiceRoleArn()
The stack AWS Identity and Access Management (IAM) role, which allows 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 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 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 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 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 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 cloned stack default operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".

Returns:
The cloned stack default operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".

setDefaultOs

public void setDefaultOs(String defaultOs)
The cloned stack default operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".

Parameters:
defaultOs - The cloned stack default operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".

withDefaultOs

public CreateStackRequest withDefaultOs(String defaultOs)
The cloned stack default operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".

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

Parameters:
defaultOs - The cloned stack default operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".
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 hostnames for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates hostnames by appending integers to the layer's shortname. The other themes are:

To obtain a generated hostname, call GetHostNameSuggestion, which returns a hostname based on the current theme.

Returns:
The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate hostnames for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates hostnames by appending integers to the layer's shortname. 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 hostname, call GetHostNameSuggestion, which returns a hostname 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 hostnames for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates hostnames by appending integers to the layer's shortname. The other themes are:

To obtain a generated hostname, call GetHostNameSuggestion, which returns a hostname 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 hostnames for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates hostnames by appending integers to the layer's shortname. 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 hostname, call GetHostNameSuggestion, which returns a hostname 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 hostnames for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates hostnames by appending integers to the layer's shortname. The other themes are:

To obtain a generated hostname, call GetHostNameSuggestion, which returns a hostname 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 hostnames for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates hostnames by appending integers to the layer's shortname. 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 hostname, call GetHostNameSuggestion, which returns a hostname 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 default Availability Zone. For more information, see Regions and Endpoints.

Returns:
The stack default Availability Zone. For more information, see Regions and Endpoints.

setDefaultAvailabilityZone

public void setDefaultAvailabilityZone(String defaultAvailabilityZone)
The stack default Availability Zone. For more information, see Regions and Endpoints.

Parameters:
defaultAvailabilityZone - The stack default Availability Zone. For more information, see Regions and Endpoints.

withDefaultAvailabilityZone

public CreateStackRequest withDefaultAvailabilityZone(String defaultAvailabilityZone)
The stack default Availability Zone. For more information, see Regions and Endpoints.

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

Parameters:
defaultAvailabilityZone - The stack default Availability Zone. For more information, see Regions and Endpoints.
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.

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.

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 cloned stack, but you can override it when you create an instance. 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 cloned stack, but you can override it when you create an instance. 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 cloned stack, but you can override it when you create an instance. 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 cloned stack, but you can override it when you create an instance. 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 cloned stack, but you can override it when you create an instance. 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 cloned stack, but you can override it when you create an instance. 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 cloned stack, but you can override it when you create an instance. 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 cloned stack, but you can override it when you create an instance. 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 cloned stack, but you can override it when you create an instance. 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 cloned stack, but you can override it when you create an instance. 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  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.