CreateChangeSetRequest (AWS Java SDK :: Services :: AWS CloudFormation 2.5.43 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest
    - - software.amazon.awssdk.services.cloudformation.model.CreateChangeSetRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateChangeSetRequest.Builder,CreateChangeSetRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateChangeSetRequest
extends CloudFormationRequest
implements ToCopyableBuilder<CreateChangeSetRequest.Builder,CreateChangeSetRequest>

The input for the CreateChangeSet action.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateChangeSetRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateChangeSetRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateChangeSetRequest.Builder`	`builder()`
`List<Capability>`	`capabilities()` In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.
`List<String>`	`capabilitiesAsStrings()` In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS 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)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`List<String>`	`notificationARNs()` The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack.
`List<Parameter>`	`parameters()` A list of `Parameter` structures that specify input parameters for the change set.
`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 AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set.
`RollbackConfiguration`	`rollbackConfiguration()` The rollback triggers for AWS 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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - stackName
```
public 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.
    
    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.
  - templateBody
```
public 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.
    
    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 or TemplateURL.
  - templateURL
```
public 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.
    
    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 or TemplateURL.
  - usePreviousTemplate
```
public Boolean usePreviousTemplate()
```
    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.
  - parameters
```
public 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.
    
    Returns:
    
    A list of Parameter structures that specify input parameters for the change set. For more information, see the Parameter data type.
  - capabilities
```
public List<Capability> capabilities()
```
    In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.
    - CAPABILITY_IAM and CAPABILITY_NAMED_IAM
      
      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 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, AWS 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.
      
      AWS::IAM::AccessKey
      
      AWS::IAM::Group
      
      AWS::IAM::InstanceProfile
      
      AWS::IAM::Policy
      
      AWS::IAM::Role
      
      AWS::IAM::User
      
      AWS::IAM::UserToGroupAddition
      
      For more information, see Acknowledging IAM Resources in AWS 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 AWS CloudFormation.
      
      This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect.
      
      Also, change sets do not currently support nested stacks. 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 AWS CloudFormation Macros to Perform Custom Processing on Templates.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    Returns:
    In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.
    
    CAPABILITY_IAM and CAPABILITY_NAMED_IAM
    
    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 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, AWS 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.
    
    AWS::IAM::AccessKey
    
    AWS::IAM::Group
    
    AWS::IAM::InstanceProfile
    
    AWS::IAM::Policy
    
    AWS::IAM::Role
    
    AWS::IAM::User
    
    AWS::IAM::UserToGroupAddition
    
    For more information, see Acknowledging IAM Resources in AWS 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 AWS CloudFormation.
    
    This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect.
    
    Also, change sets do not currently support nested stacks. 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 AWS CloudFormation Macros to Perform Custom Processing on Templates.
  - capabilitiesAsStrings
```
public List<String> capabilitiesAsStrings()
```
    In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.
    - CAPABILITY_IAM and CAPABILITY_NAMED_IAM
      
      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 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, AWS 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.
      
      AWS::IAM::AccessKey
      
      AWS::IAM::Group
      
      AWS::IAM::InstanceProfile
      
      AWS::IAM::Policy
      
      AWS::IAM::Role
      
      AWS::IAM::User
      
      AWS::IAM::UserToGroupAddition
      
      For more information, see Acknowledging IAM Resources in AWS 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 AWS CloudFormation.
      
      This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect.
      
      Also, change sets do not currently support nested stacks. 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 AWS CloudFormation Macros to Perform Custom Processing on Templates.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    Returns:
    In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.
    
    CAPABILITY_IAM and CAPABILITY_NAMED_IAM
    
    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 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, AWS 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.
    
    AWS::IAM::AccessKey
    
    AWS::IAM::Group
    
    AWS::IAM::InstanceProfile
    
    AWS::IAM::Policy
    
    AWS::IAM::Role
    
    AWS::IAM::User
    
    AWS::IAM::UserToGroupAddition
    
    For more information, see Acknowledging IAM Resources in AWS 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 AWS CloudFormation.
    
    This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect.
    
    Also, change sets do not currently support nested stacks. 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 AWS CloudFormation Macros to Perform Custom Processing on Templates.
  - resourceTypes
```
public 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, 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    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::*, 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.
  - roleARN
```
public 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.
    
    Returns:
    
    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.
  - rollbackConfiguration
```
public RollbackConfiguration rollbackConfiguration()
```
    The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
    
    Returns:
    
    The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
  - notificationARNs
```
public List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    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.
  - tags
```
public List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    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 50 tags.
  - changeSetName
```
public 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.
    
    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.
  - clientToken
```
public 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.
    
    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 retry CreateChangeSet requests to ensure that AWS CloudFormation successfully received them.
  - description
```
public String description()
```
    A description to help you identify this change set.
    
    Returns:
    
    A description to help you identify this change set.
  - changeSetType
```
public 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.
    
    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().
    
    Returns:
    
    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.
    
    See Also:
    
    ChangeSetType
  - changeSetTypeAsString
```
public 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.
    
    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.
    
    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().
    
    Returns:
    
    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.
    
    See Also:
    
    ChangeSetType
  - toBuilder
```
public CreateChangeSetRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateChangeSetRequest.Builder,CreateChangeSetRequest>
    
    Specified by:
    
    toBuilder in class CloudFormationRequest
  - builder
```
public static CreateChangeSetRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateChangeSetRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateChangeSetRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

stackName

templateBody

templateURL

usePreviousTemplate

parameters

capabilities

capabilitiesAsStrings

resourceTypes

roleARN

rollbackConfiguration

notificationARNs

tags

changeSetName

clientToken

description

changeSetType

changeSetTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields