|
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 |
java.lang.Objectcom.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.opsworks.model.CloneStackRequest
public class CloneStackRequest
Container for the parameters to the CloneStack operation
.
Creates a clone of a specified stack. For more information, see Clone a Stack .
AWSOpsWorks.cloneStack(CloneStackRequest)
,
Serialized FormConstructor Summary | |
---|---|
CloneStackRequest()
|
Method Summary | |
---|---|
boolean |
equals(Object obj)
|
Map<String,String> |
getAttributes()
A list of stack attributes and values as key/value pairs to be added to the cloned stack. |
List<String> |
getCloneAppIds()
A list of source stack app IDs to be included in the cloned stack. |
Boolean |
getClonePermissions()
Whether to clone the source stack's permissions. |
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 cloned stack's 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 cloned stack name. |
String |
getRegion()
The cloned 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. |
String |
getSourceStackId()
The source stack ID. |
Boolean |
getUseCustomCookbooks()
Whether to use custom cookbooks. |
int |
hashCode()
|
Boolean |
isClonePermissions()
Whether to clone the source stack's permissions. |
Boolean |
isUseCustomCookbooks()
Whether to use custom cookbooks. |
void |
setAttributes(Map<String,String> attributes)
A list of stack attributes and values as key/value pairs to be added to the cloned stack. |
void |
setCloneAppIds(Collection<String> cloneAppIds)
A list of source stack app IDs to be included in the cloned stack. |
void |
setClonePermissions(Boolean clonePermissions)
Whether to clone the source stack's permissions. |
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 cloned stack's 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 cloned stack name. |
void |
setRegion(String region)
The cloned 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 |
setSourceStackId(String sourceStackId)
The source stack ID. |
void |
setUseCustomCookbooks(Boolean useCustomCookbooks)
Whether to use custom cookbooks. |
String |
toString()
Returns a string representation of this object; useful for testing and debugging. |
CloneStackRequest |
withAttributes(Map<String,String> attributes)
A list of stack attributes and values as key/value pairs to be added to the cloned stack. |
CloneStackRequest |
withCloneAppIds(Collection<String> cloneAppIds)
A list of source stack app IDs to be included in the cloned stack. |
CloneStackRequest |
withCloneAppIds(String... cloneAppIds)
A list of source stack app IDs to be included in the cloned stack. |
CloneStackRequest |
withClonePermissions(Boolean clonePermissions)
Whether to clone the source stack's permissions. |
CloneStackRequest |
withCustomCookbooksSource(Source customCookbooksSource)
Contains the information required to retrieve an app or cookbook from a repository. |
CloneStackRequest |
withCustomJson(String customJson)
A string that contains user-defined, custom JSON. |
CloneStackRequest |
withDefaultAvailabilityZone(String defaultAvailabilityZone)
The cloned stack's Availability Zone. |
CloneStackRequest |
withDefaultInstanceProfileArn(String defaultInstanceProfileArn)
The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. |
CloneStackRequest |
withDefaultOs(String defaultOs)
The cloned stack default operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS". |
CloneStackRequest |
withDefaultRootDeviceType(RootDeviceType defaultRootDeviceType)
The default root device type. |
CloneStackRequest |
withDefaultRootDeviceType(String defaultRootDeviceType)
The default root device type. |
CloneStackRequest |
withDefaultSshKeyName(String defaultSshKeyName)
A default SSH key for the stack instances. |
CloneStackRequest |
withHostnameTheme(String hostnameTheme)
The stack's host name theme, with spaces are replaced by underscores. |
CloneStackRequest |
withName(String name)
The cloned stack name. |
CloneStackRequest |
withRegion(String region)
The cloned stack AWS region, such as "us-east-1". |
CloneStackRequest |
withServiceRoleArn(String serviceRoleArn)
The stack AWS Identity and Access Management (IAM) role, which allows OpsWorks to work with AWS resources on your behalf. |
CloneStackRequest |
withSourceStackId(String sourceStackId)
The source stack ID. |
CloneStackRequest |
withUseCustomCookbooks(Boolean useCustomCookbooks)
Whether to use 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 |
---|
public CloneStackRequest()
Method Detail |
---|
public String getSourceStackId()
public void setSourceStackId(String sourceStackId)
sourceStackId
- The source stack ID.public CloneStackRequest withSourceStackId(String sourceStackId)
Returns a reference to this object so that method calls can be chained together.
sourceStackId
- The source stack ID.
public String getName()
public void setName(String name)
name
- The cloned stack name.public CloneStackRequest withName(String name)
Returns a reference to this object so that method calls can be chained together.
name
- The cloned stack name.
public String getRegion()
public void setRegion(String region)
region
- The cloned stack AWS region, such as "us-east-1". For more information
about AWS regions, see Regions
and Endpoints.public CloneStackRequest withRegion(String region)
Returns a reference to this object so that method calls can be chained together.
region
- The cloned stack AWS region, such as "us-east-1". For more information
about AWS regions, see Regions
and Endpoints.
public Map<String,String> getAttributes()
public void setAttributes(Map<String,String> attributes)
attributes
- A list of stack attributes and values as key/value pairs to be added
to the cloned stack.public CloneStackRequest withAttributes(Map<String,String> attributes)
Returns a reference to this object so that method calls can be chained together.
attributes
- A list of stack attributes and values as key/value pairs to be added
to the cloned stack.
public String getServiceRoleArn()
public void setServiceRoleArn(String serviceRoleArn)
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.
If you create a stack by using the OpsWorks console, it creates the
role for you. You can obtain an existing stack's IAM ARN
programmatically by calling DescribePermissions. For more
information about IAM ARNs, see Using
Identifiers. public CloneStackRequest 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
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.
If you create a stack by using the OpsWorks console, it creates the
role for you. You can obtain an existing stack's IAM ARN
programmatically by calling DescribePermissions. For more
information about IAM ARNs, see Using
Identifiers. 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 CloneStackRequest 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()
public void setDefaultOs(String defaultOs)
defaultOs
- The cloned stack default operating system, which must be either
"Amazon Linux" or "Ubuntu 12.04 LTS".public CloneStackRequest withDefaultOs(String defaultOs)
Returns a reference to this object so that method calls can be chained together.
defaultOs
- The cloned stack default operating system, which must be either
"Amazon Linux" or "Ubuntu 12.04 LTS".
public String getHostnameTheme()
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.
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.
public void setHostnameTheme(String hostnameTheme)
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.
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.
public CloneStackRequest withHostnameTheme(String hostnameTheme)
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.
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.
public String getDefaultAvailabilityZone()
public void setDefaultAvailabilityZone(String defaultAvailabilityZone)
defaultAvailabilityZone
- The cloned stack's Availability Zone. For more information, see Regions
and Endpoints.public CloneStackRequest withDefaultAvailabilityZone(String defaultAvailabilityZone)
Returns a reference to this object so that method calls can be chained together.
defaultAvailabilityZone
- The cloned stack's Availability Zone. For more information, see Regions
and Endpoints.
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 CloneStackRequest 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 Boolean isUseCustomCookbooks()
public void setUseCustomCookbooks(Boolean useCustomCookbooks)
useCustomCookbooks
- Whether to use custom cookbooks.public CloneStackRequest withUseCustomCookbooks(Boolean useCustomCookbooks)
Returns a reference to this object so that method calls can be chained together.
useCustomCookbooks
- Whether to use 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 CloneStackRequest 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 CloneStackRequest 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 Boolean isClonePermissions()
public void setClonePermissions(Boolean clonePermissions)
clonePermissions
- Whether to clone the source stack's permissions.public CloneStackRequest withClonePermissions(Boolean clonePermissions)
Returns a reference to this object so that method calls can be chained together.
clonePermissions
- Whether to clone the source stack's permissions.
public Boolean getClonePermissions()
public List<String> getCloneAppIds()
public void setCloneAppIds(Collection<String> cloneAppIds)
cloneAppIds
- A list of source stack app IDs to be included in the cloned stack.public CloneStackRequest withCloneAppIds(String... cloneAppIds)
Returns a reference to this object so that method calls can be chained together.
cloneAppIds
- A list of source stack app IDs to be included in the cloned stack.
public CloneStackRequest withCloneAppIds(Collection<String> cloneAppIds)
Returns a reference to this object so that method calls can be chained together.
cloneAppIds
- A list of source stack app IDs to be included in the cloned stack.
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 CloneStackRequest 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 CloneStackRequest 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()
public int hashCode()
hashCode
in class Object
public boolean equals(Object obj)
equals
in class Object
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |