DescribeChangeSetResponse (AWS Java SDK :: Services :: AWS CloudFormation 2.20.159 API)

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.cloudformation.model.CloudFormationResponse
    - - software.amazon.awssdk.services.cloudformation.model.DescribeChangeSetResponse

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

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

The output for the DescribeChangeSet action.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeChangeSetResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeChangeSetResponse.Builder`	`builder()`
`List<Capability>`	`capabilities()` If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
`List<String>`	`capabilitiesAsStrings()` If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
`List<Change>`	`changes()` A list of `Change` structures that describes the resources CloudFormation changes if you execute the change set.
`String`	`changeSetId()` The Amazon Resource Name (ARN) of the change set.
`String`	`changeSetName()` The name of the change set.
`Instant`	`creationTime()` The start time when the change set was created, in UTC.
`String`	`description()` Information about the change set.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`ExecutionStatus`	`executionStatus()` If the change set execution status is `AVAILABLE`, you can execute the change set.
`String`	`executionStatusAsString()` If the change set execution status is `AVAILABLE`, you can execute the change set.
`<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.
`boolean`	`hasChanges()` For responses, this returns true if the service returned a value for the Changes 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`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`Boolean`	`includeNestedStacks()` Verifies if `IncludeNestedStacks` is set to `True`.
`String`	`nextToken()` If the output exceeds 1 MB, a string that identifies the next page of changes.
`List<String>`	`notificationARNs()` The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
`OnStackFailure`	`onStackFailure()` Determines what action will be taken if stack creation fails.
`String`	`onStackFailureAsString()` Determines what action will be taken if stack creation fails.
`List<Parameter>`	`parameters()` A list of `Parameter` structures that describes the input parameters and their values used to create the change set.
`String`	`parentChangeSetId()` Specifies the change set ID of the parent change set in the current nested change set hierarchy.
`RollbackConfiguration`	`rollbackConfiguration()` The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
`String`	`rootChangeSetId()` Specifies the change set ID of the root change set in the current nested change set hierarchy.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeChangeSetResponse.Builder>`	`serializableBuilderClass()`
`String`	`stackId()` The Amazon Resource Name (ARN) of the stack that's associated with the change set.
`String`	`stackName()` The name of the stack that's associated with the change set.
`ChangeSetStatus`	`status()` The current status of the change set, such as `CREATE_IN_PROGRESS`, `CREATE_COMPLETE`, or `FAILED`.
`String`	`statusAsString()` The current status of the change set, such as `CREATE_IN_PROGRESS`, `CREATE_COMPLETE`, or `FAILED`.
`String`	`statusReason()` A description of the change set's status.
`List<Tag>`	`tags()` If you execute the change set, the tags that will be associated with the stack.
`DescribeChangeSetResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.cloudformation.model.CloudFormationResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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
  - changeSetName
```
public final String changeSetName()
```
    The name of the change set.
    
    Returns:
    
    The name of the change set.
  - changeSetId
```
public final String changeSetId()
```
    The Amazon Resource Name (ARN) of the change set.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the change set.
  - stackId
```
public final String stackId()
```
    The Amazon Resource Name (ARN) of the stack that's associated with the change set.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the stack that's associated with the change set.
  - stackName
```
public final String stackName()
```
    The name of the stack that's associated with the change set.
    
    Returns:
    
    The name of the stack that's associated with the change set.
  - description
```
public final String description()
```
    Information about the change set.
    
    Returns:
    
    Information about the change set.
  - hasParameters
```
public final boolean hasParameters()
```
    For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - parameters
```
public final List<Parameter> parameters()
```
    A list of Parameter structures that describes the input parameters and their values used to create 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.
    
    Returns:
    
    A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.
  - creationTime
```
public final Instant creationTime()
```
    The start time when the change set was created, in UTC.
    
    Returns:
    
    The start time when the change set was created, in UTC.
  - executionStatus
```
public final ExecutionStatus executionStatus()
```
    If the change set execution status is AVAILABLE, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.
    
    If the service returns an enum value that is not available in the current SDK version, executionStatus will return ExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from executionStatusAsString().
    
    Returns:
    
    If the change set execution status is AVAILABLE, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.
    
    See Also:
    
    ExecutionStatus
  - executionStatusAsString
```
public final String executionStatusAsString()
```
    If the change set execution status is AVAILABLE, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.
    
    If the service returns an enum value that is not available in the current SDK version, executionStatus will return ExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from executionStatusAsString().
    
    Returns:
    
    If the change set execution status is AVAILABLE, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.
    
    See Also:
    
    ExecutionStatus
  - status
```
public final ChangeSetStatus status()
```
    The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ChangeSetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.
    
    See Also:
    
    ChangeSetStatus
  - statusAsString
```
public final String statusAsString()
```
    The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ChangeSetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.
    
    See Also:
    
    ChangeSetStatus
  - statusReason
```
public final String statusReason()
```
    A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.
    
    Returns:
    
    A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.
  - hasNotificationARNs
```
public final boolean hasNotificationARNs()
```
    For responses, this returns true if the service returned a value for the NotificationARNs property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - notificationARNs
```
public final List<String> notificationARNs()
```
    The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
    
    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.
    
    Returns:
    
    The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
  - rollbackConfiguration
```
public final RollbackConfiguration rollbackConfiguration()
```
    The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
    
    Returns:
    
    The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
  - capabilities
```
public final List<Capability> capabilities()
```
    If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
    
    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.
    
    Returns:
    
    If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
  - hasCapabilities
```
public final boolean hasCapabilities()
```
    For responses, this returns true if the service returned a value for the Capabilities property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - capabilitiesAsStrings
```
public final List<String> capabilitiesAsStrings()
```
    If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
    
    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.
    
    Returns:
    
    If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - tags
```
public final List<Tag> tags()
```
    If you execute the change set, the tags that will be associated with the 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 hasTags() method.
    
    Returns:
    
    If you execute the change set, the tags that will be associated with the stack.
  - hasChanges
```
public final boolean hasChanges()
```
    For responses, this returns true if the service returned a value for the Changes property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - changes
```
public final List<Change> changes()
```
    A list of Change structures that describes the resources CloudFormation changes if you execute the change set.
    
    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 hasChanges() method.
    
    Returns:
    
    A list of Change structures that describes the resources CloudFormation changes if you execute the change set.
  - nextToken
```
public final String nextToken()
```
    If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.
    
    Returns:
    
    If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.
  - includeNestedStacks
```
public final Boolean includeNestedStacks()
```
    Verifies if IncludeNestedStacks is set to True.
    
    Returns:
    
    Verifies if IncludeNestedStacks is set to True.
  - parentChangeSetId
```
public final String parentChangeSetId()
```
    Specifies the change set ID of the parent change set in the current nested change set hierarchy.
    
    Returns:
    
    Specifies the change set ID of the parent change set in the current nested change set hierarchy.
  - rootChangeSetId
```
public final String rootChangeSetId()
```
    Specifies the change set ID of the root change set in the current nested change set hierarchy.
    
    Returns:
    
    Specifies the change set ID of the root change set in the current nested change set hierarchy.
  - onStackFailure
```
public final OnStackFailure onStackFailure()
```
    Determines what action will be taken if stack creation fails. When this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
    - DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.
    - DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.
    - ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.
    If the service returns an enum value that is not available in the current SDK version, onStackFailure will return OnStackFailure.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from onStackFailureAsString().
    Returns:
    Determines what action will be taken if stack creation fails. When this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
    
    DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.
    
    DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.
    
    ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.
    See Also:
    
    OnStackFailure
  - onStackFailureAsString
```
public final String onStackFailureAsString()
```
    Determines what action will be taken if stack creation fails. When this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
    - DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.
    - DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.
    - ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.
    If the service returns an enum value that is not available in the current SDK version, onStackFailure will return OnStackFailure.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from onStackFailureAsString().
    Returns:
    Determines what action will be taken if stack creation fails. When this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
    
    DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.
    
    DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.
    
    ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.
    See Also:
    
    OnStackFailure
  - toBuilder
```
public DescribeChangeSetResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeChangeSetResponse.Builder,DescribeChangeSetResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeChangeSetResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeChangeSetResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeChangeSetResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.cloudformation.model.CloudFormationResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

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

Method Detail

changeSetName

changeSetId

stackId

stackName

description

hasParameters

parameters

creationTime

executionStatus

executionStatusAsString

status

statusAsString

statusReason

hasNotificationARNs

notificationARNs

rollbackConfiguration

capabilities

hasCapabilities

capabilitiesAsStrings

hasTags

tags

hasChanges

changes

nextToken

includeNestedStacks

parentChangeSetId

rootChangeSetId

onStackFailure

onStackFailureAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields