Class CreateChangeSetRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.cloudformation.model.CreateChangeSetRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class CreateChangeSetRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
The input for the CreateChangeSet action.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description CreateChangeSetRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CreateChangeSetRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
List<String>
getCapabilities()
A list of capabilities that you must specify before AWS CloudFormation can update certain stacks.String
getChangeSetName()
The name of the change set.String
getClientToken()
A unique identifier for thisCreateChangeSet
request.String
getDescription()
A description to help you identify this change set.List<String>
getNotificationARNs()
The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack.List<Parameter>
getParameters()
A list ofParameter
structures that specify input parameters for the change set.List<String>
getResourceTypes()
The template resource types that you have permissions to work with if you execute this change set, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.String
getStackName()
The name or the unique ID of the stack for which you are creating a change set.List<Tag>
getTags()
Key-value pairs to associate with this stack.String
getTemplateBody()
A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes.String
getTemplateURL()
The location of the file that contains the revised template.Boolean
getUsePreviousTemplate()
Whether to reuse the template that is associated with the stack to create the change set.int
hashCode()
Boolean
isUsePreviousTemplate()
Whether to reuse the template that is associated with the stack to create the change set.void
setCapabilities(Collection<String> capabilities)
A list of capabilities that you must specify before AWS CloudFormation can update certain stacks.void
setChangeSetName(String changeSetName)
The name of the change set.void
setClientToken(String clientToken)
A unique identifier for thisCreateChangeSet
request.void
setDescription(String description)
A description to help you identify this change set.void
setNotificationARNs(Collection<String> notificationARNs)
The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack.void
setParameters(Collection<Parameter> parameters)
A list ofParameter
structures that specify input parameters for the change set.void
setResourceTypes(Collection<String> resourceTypes)
The template resource types that you have permissions to work with if you execute this change set, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.void
setStackName(String stackName)
The name or the unique ID of the stack for which you are creating a change set.void
setTags(Collection<Tag> tags)
Key-value pairs to associate with this stack.void
setTemplateBody(String templateBody)
A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes.void
setTemplateURL(String templateURL)
The location of the file that contains the revised template.void
setUsePreviousTemplate(Boolean usePreviousTemplate)
Whether to reuse the template that is associated with the stack to create the change set.String
toString()
Returns a string representation of this object; useful for testing and debugging.CreateChangeSetRequest
withCapabilities(Capability... capabilities)
A list of capabilities that you must specify before AWS CloudFormation can update certain stacks.CreateChangeSetRequest
withCapabilities(String... capabilities)
A list of capabilities that you must specify before AWS CloudFormation can update certain stacks.CreateChangeSetRequest
withCapabilities(Collection<String> capabilities)
A list of capabilities that you must specify before AWS CloudFormation can update certain stacks.CreateChangeSetRequest
withChangeSetName(String changeSetName)
The name of the change set.CreateChangeSetRequest
withClientToken(String clientToken)
A unique identifier for thisCreateChangeSet
request.CreateChangeSetRequest
withDescription(String description)
A description to help you identify this change set.CreateChangeSetRequest
withNotificationARNs(String... notificationARNs)
The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack.CreateChangeSetRequest
withNotificationARNs(Collection<String> notificationARNs)
The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack.CreateChangeSetRequest
withParameters(Parameter... parameters)
A list ofParameter
structures that specify input parameters for the change set.CreateChangeSetRequest
withParameters(Collection<Parameter> parameters)
A list ofParameter
structures that specify input parameters for the change set.CreateChangeSetRequest
withResourceTypes(String... resourceTypes)
The template resource types that you have permissions to work with if you execute this change set, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.CreateChangeSetRequest
withResourceTypes(Collection<String> resourceTypes)
The template resource types that you have permissions to work with if you execute this change set, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.CreateChangeSetRequest
withStackName(String stackName)
The name or the unique ID of the stack for which you are creating a change set.CreateChangeSetRequest
withTags(Tag... tags)
Key-value pairs to associate with this stack.CreateChangeSetRequest
withTags(Collection<Tag> tags)
Key-value pairs to associate with this stack.CreateChangeSetRequest
withTemplateBody(String templateBody)
A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes.CreateChangeSetRequest
withTemplateURL(String templateURL)
The location of the file that contains the revised template.CreateChangeSetRequest
withUsePreviousTemplate(Boolean usePreviousTemplate)
Whether to reuse the template that is associated with the stack to create the change set.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setStackName
public void setStackName(String stackName)
The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.
- Parameters:
stackName
- The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.
-
getStackName
public String getStackName()
The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.
- Returns:
- The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.
-
withStackName
public CreateChangeSetRequest withStackName(String stackName)
The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.
- Parameters:
stackName
- The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTemplateBody
public void setTemplateBody(String templateBody)
A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified.
Conditional: You must specify only
TemplateBody
orTemplateURL
.- Parameters:
templateBody
- A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified.Conditional: You must specify only
TemplateBody
orTemplateURL
.
-
getTemplateBody
public String getTemplateBody()
A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified.
Conditional: You must specify only
TemplateBody
orTemplateURL
.- Returns:
- A structure that contains the body of the revised template, with
a minimum length of 1 byte and a maximum length of 51,200 bytes.
AWS CloudFormation generates the change set by comparing this
template with the template of the stack that you specified.
Conditional: You must specify only
TemplateBody
orTemplateURL
.
-
withTemplateBody
public CreateChangeSetRequest withTemplateBody(String templateBody)
A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified.
Conditional: You must specify only
TemplateBody
orTemplateURL
.- Parameters:
templateBody
- A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified.Conditional: You must specify only
TemplateBody
orTemplateURL
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTemplateURL
public void setTemplateURL(String templateURL)
The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.
Conditional: You must specify only
TemplateBody
orTemplateURL
.- Parameters:
templateURL
- The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.Conditional: You must specify only
TemplateBody
orTemplateURL
.
-
getTemplateURL
public String getTemplateURL()
The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.
Conditional: You must specify only
TemplateBody
orTemplateURL
.- Returns:
- The location of the file that contains the revised template. The
URL must point to a template (max size: 460,800 bytes) that is
located in an S3 bucket. AWS CloudFormation generates the change
set by comparing this template with the stack that you
specified.
Conditional: You must specify only
TemplateBody
orTemplateURL
.
-
withTemplateURL
public CreateChangeSetRequest withTemplateURL(String templateURL)
The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.
Conditional: You must specify only
TemplateBody
orTemplateURL
.- Parameters:
templateURL
- The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.Conditional: You must specify only
TemplateBody
orTemplateURL
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setUsePreviousTemplate
public void setUsePreviousTemplate(Boolean usePreviousTemplate)
Whether to reuse the template that is associated with the stack to create the change set.
- Parameters:
usePreviousTemplate
- Whether to reuse the template that is associated with the stack to create the change set.
-
getUsePreviousTemplate
public Boolean getUsePreviousTemplate()
Whether to reuse the template that is associated with the stack to create the change set.
- Returns:
- Whether to reuse the template that is associated with the stack to create the change set.
-
withUsePreviousTemplate
public CreateChangeSetRequest withUsePreviousTemplate(Boolean usePreviousTemplate)
Whether to reuse the template that is associated with the stack to create the change set.
- Parameters:
usePreviousTemplate
- Whether to reuse the template that is associated with the stack to create the change set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isUsePreviousTemplate
public Boolean isUsePreviousTemplate()
Whether to reuse the template that is associated with the stack to create the change set.
- Returns:
- Whether to reuse the template that is associated with the stack to create the change set.
-
getParameters
public List<Parameter> getParameters()
A list of
Parameter
structures that specify input parameters for the change set. For more information, see the Parameter data type.- Returns:
- A list of
Parameter
structures that specify input parameters for the change set. For more information, see the Parameter data type.
-
setParameters
public void setParameters(Collection<Parameter> parameters)
A list of
Parameter
structures that specify input parameters for the change set. For more information, see the Parameter data type.- Parameters:
parameters
- A list ofParameter
structures that specify input parameters for the change set. For more information, see the Parameter data type.
-
withParameters
public CreateChangeSetRequest withParameters(Parameter... parameters)
A list of
Parameter
structures that specify input parameters for the change set. For more information, see the Parameter data type.NOTE: This method appends the values to the existing list (if any). Use
setParameters(java.util.Collection)
orwithParameters(java.util.Collection)
if you want to override the existing values.- Parameters:
parameters
- A list ofParameter
structures that specify input parameters for the change set. For more information, see the Parameter data type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withParameters
public CreateChangeSetRequest withParameters(Collection<Parameter> parameters)
A list of
Parameter
structures that specify input parameters for the change set. For more information, see the Parameter data type.- Parameters:
parameters
- A list ofParameter
structures that specify input parameters for the change set. For more information, see the Parameter data type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getCapabilities
public List<String> getCapabilities()
A list of capabilities that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.
Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.- Returns:
- A list of capabilities that you must specify before AWS
CloudFormation can update certain stacks. Some stack templates
might include resources that can affect permissions in your AWS
account, for example, by creating new AWS Identity and Access
Management (IAM) users. For those stacks, you must explicitly
acknowledge their capabilities by specifying this parameter.
Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error. - See Also:
Capability
-
setCapabilities
public void setCapabilities(Collection<String> capabilities)
A list of capabilities that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.
Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.- Parameters:
capabilities
- A list of capabilities that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.- See Also:
Capability
-
withCapabilities
public CreateChangeSetRequest withCapabilities(String... capabilities)
A list of capabilities that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.
Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.NOTE: This method appends the values to the existing list (if any). Use
setCapabilities(java.util.Collection)
orwithCapabilities(java.util.Collection)
if you want to override the existing values.- Parameters:
capabilities
- A list of capabilities that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
Capability
-
withCapabilities
public CreateChangeSetRequest withCapabilities(Collection<String> capabilities)
A list of capabilities that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.
Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.- Parameters:
capabilities
- A list of capabilities that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
Capability
-
withCapabilities
public CreateChangeSetRequest withCapabilities(Capability... capabilities)
A list of capabilities that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.
Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.- Parameters:
capabilities
- A list of capabilities that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
Capability
-
getResourceTypes
public List<String> getResourceTypes()
The template resource types that you have permissions to work with if you execute this change set, such as
AWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.
- Returns:
- The template resource types that you have permissions to work
with if you execute this change set, such as
AWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.
-
setResourceTypes
public void setResourceTypes(Collection<String> resourceTypes)
The template resource types that you have permissions to work with if you execute this change set, such as
AWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.
- Parameters:
resourceTypes
- The template resource types that you have permissions to work with if you execute this change set, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.
-
withResourceTypes
public CreateChangeSetRequest withResourceTypes(String... resourceTypes)
The template resource types that you have permissions to work with if you execute this change set, such as
AWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.
NOTE: This method appends the values to the existing list (if any). Use
setResourceTypes(java.util.Collection)
orwithResourceTypes(java.util.Collection)
if you want to override the existing values.- Parameters:
resourceTypes
- The template resource types that you have permissions to work with if you execute this change set, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withResourceTypes
public CreateChangeSetRequest withResourceTypes(Collection<String> resourceTypes)
The template resource types that you have permissions to work with if you execute this change set, such as
AWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.
- Parameters:
resourceTypes
- The template resource types that you have permissions to work with if you execute this change set, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getNotificationARNs
public List<String> getNotificationARNs()
The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.
- Returns:
- The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.
-
setNotificationARNs
public void setNotificationARNs(Collection<String> notificationARNs)
The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.
- Parameters:
notificationARNs
- The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.
-
withNotificationARNs
public CreateChangeSetRequest withNotificationARNs(String... notificationARNs)
The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.
NOTE: This method appends the values to the existing list (if any). Use
setNotificationARNs(java.util.Collection)
orwithNotificationARNs(java.util.Collection)
if you want to override the existing values.- Parameters:
notificationARNs
- The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withNotificationARNs
public CreateChangeSetRequest withNotificationARNs(Collection<String> notificationARNs)
The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.
- Parameters:
notificationARNs
- The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getTags
public List<Tag> getTags()
Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 10 tags.
- Returns:
- Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 10 tags.
-
setTags
public void setTags(Collection<Tag> tags)
Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 10 tags.
- Parameters:
tags
- Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 10 tags.
-
withTags
public CreateChangeSetRequest withTags(Tag... tags)
Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 10 tags.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
orwithTags(java.util.Collection)
if you want to override the existing values.- Parameters:
tags
- Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 10 tags.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withTags
public CreateChangeSetRequest withTags(Collection<Tag> tags)
Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 10 tags.
- Parameters:
tags
- Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 10 tags.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setChangeSetName
public void setChangeSetName(String changeSetName)
The name of the change set. The name must be unique among all change sets that are associated with the specified stack.
A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.
- Parameters:
changeSetName
- The name of the change set. The name must be unique among all change sets that are associated with the specified stack.A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.
-
getChangeSetName
public String getChangeSetName()
The name of the change set. The name must be unique among all change sets that are associated with the specified stack.
A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.
- Returns:
- The name of the change set. The name must be unique among all
change sets that are associated with the specified stack.
A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.
-
withChangeSetName
public CreateChangeSetRequest withChangeSetName(String changeSetName)
The name of the change set. The name must be unique among all change sets that are associated with the specified stack.
A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.
- Parameters:
changeSetName
- The name of the change set. The name must be unique among all change sets that are associated with the specified stack.A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setClientToken
public void setClientToken(String clientToken)
A unique identifier for this
CreateChangeSet
request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another change set with the same name. You might retryCreateChangeSet
requests to ensure that AWS CloudFormation successfully received them.- Parameters:
clientToken
- A unique identifier for thisCreateChangeSet
request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another change set with the same name. You might retryCreateChangeSet
requests to ensure that AWS CloudFormation successfully received them.
-
getClientToken
public String getClientToken()
A unique identifier for this
CreateChangeSet
request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another change set with the same name. You might retryCreateChangeSet
requests to ensure that AWS CloudFormation successfully received them.- Returns:
- A unique identifier for this
CreateChangeSet
request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another change set with the same name. You might retryCreateChangeSet
requests to ensure that AWS CloudFormation successfully received them.
-
withClientToken
public CreateChangeSetRequest withClientToken(String clientToken)
A unique identifier for this
CreateChangeSet
request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another change set with the same name. You might retryCreateChangeSet
requests to ensure that AWS CloudFormation successfully received them.- Parameters:
clientToken
- A unique identifier for thisCreateChangeSet
request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another change set with the same name. You might retryCreateChangeSet
requests to ensure that AWS CloudFormation successfully received them.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDescription
public void setDescription(String description)
A description to help you identify this change set.
- Parameters:
description
- A description to help you identify this change set.
-
getDescription
public String getDescription()
A description to help you identify this change set.
- Returns:
- A description to help you identify this change set.
-
withDescription
public CreateChangeSetRequest withDescription(String description)
A description to help you identify this change set.
- Parameters:
description
- A description to help you identify this change set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public CreateChangeSetRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-