public static interface CreateChangeSetRequest.Builder extends CloudFormationRequest.Builder, CopyableBuilder<CreateChangeSetRequest.Builder,CreateChangeSetRequest>
Modifier and Type | Method and Description |
---|---|
CreateChangeSetRequest.Builder |
capabilities(Collection<String> capabilities)
A list of values that you must specify before AWS CloudFormation can update certain stacks.
|
CreateChangeSetRequest.Builder |
capabilities(String... capabilities)
A list of values that you must specify before AWS CloudFormation can update certain stacks.
|
CreateChangeSetRequest.Builder |
changeSetName(String changeSetName)
The name of the change set.
|
CreateChangeSetRequest.Builder |
changeSetType(ChangeSetType changeSetType)
The type of change set operation.
|
CreateChangeSetRequest.Builder |
changeSetType(String changeSetType)
The type of change set operation.
|
CreateChangeSetRequest.Builder |
clientToken(String clientToken)
A unique identifier for this
CreateChangeSet request. |
CreateChangeSetRequest.Builder |
description(String description)
A description to help you identify this change set.
|
CreateChangeSetRequest.Builder |
notificationARNs(Collection<String> notificationARNs)
The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS
CloudFormation associates with the stack.
|
CreateChangeSetRequest.Builder |
notificationARNs(String... notificationARNs)
The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS
CloudFormation associates with the stack.
|
CreateChangeSetRequest.Builder |
parameters(Collection<Parameter> parameters)
A list of
Parameter structures that specify input parameters for the change set. |
CreateChangeSetRequest.Builder |
parameters(Parameter... parameters)
A list of
Parameter structures that specify input parameters for the change set. |
CreateChangeSetRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
CreateChangeSetRequest.Builder |
resourceTypes(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::* , or Custom::MyCustomInstance . |
CreateChangeSetRequest.Builder |
resourceTypes(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::* , or Custom::MyCustomInstance . |
CreateChangeSetRequest.Builder |
roleARN(String roleARN)
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
assumes when executing the change set.
|
default CreateChangeSetRequest.Builder |
rollbackConfiguration(Consumer<RollbackConfiguration.Builder> rollbackConfiguration)
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and
for the specified monitoring period afterwards.
|
CreateChangeSetRequest.Builder |
rollbackConfiguration(RollbackConfiguration rollbackConfiguration)
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and
for the specified monitoring period afterwards.
|
CreateChangeSetRequest.Builder |
stackName(String stackName)
The name or the unique ID of the stack for which you are creating a change set.
|
CreateChangeSetRequest.Builder |
tags(Collection<Tag> tags)
Key-value pairs to associate with this stack.
|
CreateChangeSetRequest.Builder |
tags(Tag... tags)
Key-value pairs to associate with this stack.
|
CreateChangeSetRequest.Builder |
templateBody(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.Builder |
templateURL(String templateURL)
The location of the file that contains the revised template.
|
CreateChangeSetRequest.Builder |
usePreviousTemplate(Boolean usePreviousTemplate)
Whether to reuse the template that is associated with the stack to create the change set.
|
build
requestOverrideConfig, requestOverrideConfig
copy
apply, build
CreateChangeSetRequest.Builder stackName(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.
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.CreateChangeSetRequest.Builder templateBody(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
or TemplateURL
.
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
or TemplateURL
.
CreateChangeSetRequest.Builder templateURL(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
or TemplateURL
.
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
or TemplateURL
.
CreateChangeSetRequest.Builder usePreviousTemplate(Boolean usePreviousTemplate)
Whether to reuse the template that is associated with the stack to create the change set.
usePreviousTemplate
- Whether to reuse the template that is associated with the stack to create the change set.CreateChangeSetRequest.Builder parameters(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
- A list of Parameter
structures that specify input parameters for the change set. For more
information, see the Parameter data type.CreateChangeSetRequest.Builder parameters(Parameter... parameters)
A list of Parameter
structures that specify input parameters for the change set. For more
information, see the Parameter data
type.
parameters
- A list of Parameter
structures that specify input parameters for the change set. For more
information, see the Parameter data type.CreateChangeSetRequest.Builder capabilities(Collection<String> capabilities)
A list of values 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.
The only valid values are CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
. The following
resources require you to specify this parameter:
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 you have IAM resources, you can specify either capability. If you have IAM resources with custom names,
you must specify CAPABILITY_NAMED_IAM
. If you don't specify this parameter, this action returns
an InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
capabilities
- A list of values 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.
The only valid values are CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
. The
following resources require you to specify this parameter:
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 you have IAM resources, you can specify either capability. If you have IAM resources with custom
names, you must specify CAPABILITY_NAMED_IAM
. If you don't specify this parameter, this
action returns an InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
CreateChangeSetRequest.Builder capabilities(String... capabilities)
A list of values 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.
The only valid values are CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
. The following
resources require you to specify this parameter:
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 you have IAM resources, you can specify either capability. If you have IAM resources with custom names,
you must specify CAPABILITY_NAMED_IAM
. If you don't specify this parameter, this action returns
an InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
capabilities
- A list of values 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.
The only valid values are CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
. The
following resources require you to specify this parameter:
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 you have IAM resources, you can specify either capability. If you have IAM resources with custom
names, you must specify CAPABILITY_NAMED_IAM
. If you don't specify this parameter, this
action returns an InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
CreateChangeSetRequest.Builder resourceTypes(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::*
, or Custom::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.
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::*
, or
Custom::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.
CreateChangeSetRequest.Builder resourceTypes(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::*
, or Custom::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.
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::*
, or
Custom::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.
CreateChangeSetRequest.Builder roleARN(String roleARN)
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
roleARN
- The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS
CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials
to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the
stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role
even if the users don't have permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
CreateChangeSetRequest.Builder rollbackConfiguration(RollbackConfiguration rollbackConfiguration)
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
rollbackConfiguration
- The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations,
and for the specified monitoring period afterwards.default CreateChangeSetRequest.Builder rollbackConfiguration(Consumer<RollbackConfiguration.Builder> rollbackConfiguration)
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
This is a convenience that creates an instance of theRollbackConfiguration.Builder
avoiding the need
to create one manually via RollbackConfiguration.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and
its result is passed to rollbackConfiguration(RollbackConfiguration)
.rollbackConfiguration
- a consumer that will call methods on RollbackConfiguration.Builder
rollbackConfiguration(RollbackConfiguration)
CreateChangeSetRequest.Builder notificationARNs(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.
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.CreateChangeSetRequest.Builder notificationARNs(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.
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.CreateChangeSetRequest.Builder tags(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 50 tags.
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 50 tags.CreateChangeSetRequest.Builder tags(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 50 tags.
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 50 tags.CreateChangeSetRequest.Builder changeSetName(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.
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.
CreateChangeSetRequest.Builder clientToken(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 retry CreateChangeSet
requests to ensure that AWS CloudFormation
successfully received them.
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 retry CreateChangeSet
requests to ensure that AWS
CloudFormation successfully received them.CreateChangeSetRequest.Builder description(String description)
A description to help you identify this change set.
description
- A description to help you identify this change set.CreateChangeSetRequest.Builder changeSetType(String changeSetType)
The type of change set operation. To create a change set for a new stack, specify CREATE
. To
create a change set for an existing stack, specify UPDATE
.
If you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID, but no
template or resources. The stack will be in the
REVIEW_IN_PROGRESS
state until you execute the change set.
By default, AWS CloudFormation specifies UPDATE
. You can't use the UPDATE
type to
create a change set for a new stack or the CREATE
type to create a change set for an existing
stack.
changeSetType
- The type of change set operation. To create a change set for a new stack, specify CREATE
.
To create a change set for an existing stack, specify UPDATE
.
If you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID,
but no template or resources. The stack will be in the REVIEW_IN_PROGRESS
state until you execute the change set.
By default, AWS CloudFormation specifies UPDATE
. You can't use the UPDATE
type to create a change set for a new stack or the CREATE
type to create a change set for
an existing stack.
ChangeSetType
,
ChangeSetType
CreateChangeSetRequest.Builder changeSetType(ChangeSetType changeSetType)
The type of change set operation. To create a change set for a new stack, specify CREATE
. To
create a change set for an existing stack, specify UPDATE
.
If you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID, but no
template or resources. The stack will be in the
REVIEW_IN_PROGRESS
state until you execute the change set.
By default, AWS CloudFormation specifies UPDATE
. You can't use the UPDATE
type to
create a change set for a new stack or the CREATE
type to create a change set for an existing
stack.
changeSetType
- The type of change set operation. To create a change set for a new stack, specify CREATE
.
To create a change set for an existing stack, specify UPDATE
.
If you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID,
but no template or resources. The stack will be in the REVIEW_IN_PROGRESS
state until you execute the change set.
By default, AWS CloudFormation specifies UPDATE
. You can't use the UPDATE
type to create a change set for a new stack or the CREATE
type to create a change set for
an existing stack.
ChangeSetType
,
ChangeSetType
CreateChangeSetRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.Builder
requestOverrideConfig
in interface AwsRequest.Builder
awsRequestOverrideConfig
- The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.