@Generated(value="software.amazon.awssdk:codegen") public final class CreateChangeSetRequest extends CloudFormationRequest implements ToCopyableBuilder<CreateChangeSetRequest.Builder,CreateChangeSetRequest>
The input for the CreateChangeSet action.
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateChangeSetRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static CreateChangeSetRequest.Builder |
builder() |
List<Capability> |
capabilities()
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
for CloudFormation to create the stack.
|
List<String> |
capabilitiesAsStrings()
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
for CloudFormation to create the stack.
|
String |
changeSetName()
The name of the change set.
|
ChangeSetType |
changeSetType()
The type of change set operation.
|
String |
changeSetTypeAsString()
The type of change set operation.
|
String |
clientToken()
A unique identifier for this
CreateChangeSet request. |
String |
description()
A description to help you identify this change set.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasCapabilities()
For responses, this returns true if the service returned a value for the Capabilities property.
|
int |
hashCode() |
boolean |
hasNotificationARNs()
For responses, this returns true if the service returned a value for the NotificationARNs property.
|
boolean |
hasParameters()
For responses, this returns true if the service returned a value for the Parameters property.
|
boolean |
hasResourcesToImport()
For responses, this returns true if the service returned a value for the ResourcesToImport property.
|
boolean |
hasResourceTypes()
For responses, this returns true if the service returned a value for the ResourceTypes property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
Boolean |
includeNestedStacks()
Creates a change set for the all nested stacks specified in the template.
|
List<String> |
notificationARNs()
The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation
associates with the stack.
|
List<Parameter> |
parameters()
A list of
Parameter structures that specify input parameters for the change set. |
List<ResourceToImport> |
resourcesToImport()
The resources to import into your stack.
|
List<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. |
String |
roleARN()
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when
executing the change set.
|
RollbackConfiguration |
rollbackConfiguration()
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the
specified monitoring period afterwards.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateChangeSetRequest.Builder> |
serializableBuilderClass() |
String |
stackName()
The name or the unique ID of the stack for which you are creating a change set.
|
List<Tag> |
tags()
Key-value pairs to associate with this stack.
|
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.
|
String |
templateURL()
The location of the file that contains the revised template.
|
CreateChangeSetRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
Boolean |
usePreviousTemplate()
Whether to reuse the template that is associated with the stack to create the change set.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String stackName()
The name or the unique ID of the stack for which you are creating a change set. 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.
public final 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. 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.
Conditional: You must specify only TemplateBody or TemplateURL.
public final 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 or a Systems Manager document. CloudFormation generates the change set by comparing this template with the stack that you specified.
Conditional: You must specify only TemplateBody or TemplateURL.
Conditional: You must specify only TemplateBody or TemplateURL.
public final Boolean usePreviousTemplate()
Whether to reuse the template that is associated with the stack to create the change set.
public final boolean hasParameters()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<Parameter> parameters()
A list of Parameter structures that specify input parameters for the change set. For more
information, see the Parameter data type.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasParameters() method.
Parameter structures that specify input parameters for the change set. For more
information, see the Parameter data type.public final List<Capability> capabilities()
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or
CAPABILITY_NAMED_IAM capability.
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 either of these capabilities, CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.
For more information on macros, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasCapabilities() method.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or
CAPABILITY_NAMED_IAM capability.
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 either of these capabilities, CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.
For more information on macros, see Using CloudFormation Macros to Perform Custom Processing on Templates.
public final boolean hasCapabilities()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> capabilitiesAsStrings()
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or
CAPABILITY_NAMED_IAM capability.
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 either of these capabilities, CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.
For more information on macros, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasCapabilities() method.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or
CAPABILITY_NAMED_IAM capability.
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 either of these capabilities, CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.
For more information on macros, see Using CloudFormation Macros to Perform Custom Processing on Templates.
public final boolean hasResourceTypes()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see Controlling Access with Identity and Access Management in the CloudFormation User Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasResourceTypes() method.
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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see Controlling Access with Identity and Access Management in the CloudFormation User Guide.
public final String roleARN()
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, 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, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.
public final RollbackConfiguration rollbackConfiguration()
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
public final boolean hasNotificationARNs()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> notificationARNs()
The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasNotificationARNs() method.
public final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<Tag> tags()
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
public final 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.
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.
public final String clientToken()
A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry
requests so that CloudFormation knows that you're not attempting to create another change set with the same name.
You might retry CreateChangeSet requests to ensure that CloudFormation successfully received them.
CreateChangeSet request. Specify this token if you plan to
retry requests so that CloudFormation knows that you're not attempting to create another change set with
the same name. You might retry CreateChangeSet requests to ensure that CloudFormation
successfully received them.public final String description()
A description to help you identify this change set.
public final 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. To create a change set for an import operation,
specify IMPORT.
If you create a change set for a new stack, 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, 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.
If the service returns an enum value that is not available in the current SDK version, changeSetType
will return ChangeSetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
changeSetTypeAsString().
CREATE. To
create a change set for an existing stack, specify UPDATE. To create a change set for an
import operation, specify IMPORT.
If you create a change set for a new stack, 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, 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.
ChangeSetTypepublic final String changeSetTypeAsString()
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. To create a change set for an import operation,
specify IMPORT.
If you create a change set for a new stack, 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, 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.
If the service returns an enum value that is not available in the current SDK version, changeSetType
will return ChangeSetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
changeSetTypeAsString().
CREATE. To
create a change set for an existing stack, specify UPDATE. To create a change set for an
import operation, specify IMPORT.
If you create a change set for a new stack, 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, 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.
ChangeSetTypepublic final boolean hasResourcesToImport()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<ResourceToImport> resourcesToImport()
The resources to import into your stack.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasResourcesToImport() method.
public final Boolean includeNestedStacks()
Creates a change set for the all nested stacks specified in the template. The default behavior of this action is
set to False. To include nested sets in a change set, specify True.
False. To include nested sets in a change set, specify True.public CreateChangeSetRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateChangeSetRequest.Builder,CreateChangeSetRequest>toBuilder in class CloudFormationRequestpublic static CreateChangeSetRequest.Builder builder()
public static Class<? extends CreateChangeSetRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2022. All rights reserved.