software.amazon.awssdk.services.cloudformation.model.DescribeChangeSetResponse Maven / Gradle / Ivy
Show all versions of cloudformation Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.cloudformation.model;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The output for the DescribeChangeSet action.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeChangeSetResponse extends CloudFormationResponse implements
ToCopyableBuilder {
private static final SdkField CHANGE_SET_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ChangeSetName").getter(getter(DescribeChangeSetResponse::changeSetName))
.setter(setter(Builder::changeSetName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ChangeSetName").build()).build();
private static final SdkField CHANGE_SET_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ChangeSetId").getter(getter(DescribeChangeSetResponse::changeSetId))
.setter(setter(Builder::changeSetId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ChangeSetId").build()).build();
private static final SdkField STACK_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StackId").getter(getter(DescribeChangeSetResponse::stackId)).setter(setter(Builder::stackId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StackId").build()).build();
private static final SdkField STACK_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StackName").getter(getter(DescribeChangeSetResponse::stackName)).setter(setter(Builder::stackName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StackName").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(DescribeChangeSetResponse::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField> PARAMETERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Parameters")
.getter(getter(DescribeChangeSetResponse::parameters))
.setter(setter(Builder::parameters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Parameters").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Parameter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField CREATION_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreationTime").getter(getter(DescribeChangeSetResponse::creationTime))
.setter(setter(Builder::creationTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreationTime").build()).build();
private static final SdkField EXECUTION_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ExecutionStatus").getter(getter(DescribeChangeSetResponse::executionStatusAsString))
.setter(setter(Builder::executionStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExecutionStatus").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(DescribeChangeSetResponse::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final SdkField STATUS_REASON_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StatusReason").getter(getter(DescribeChangeSetResponse::statusReason))
.setter(setter(Builder::statusReason))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StatusReason").build()).build();
private static final SdkField> NOTIFICATION_AR_NS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("NotificationARNs")
.getter(getter(DescribeChangeSetResponse::notificationARNs))
.setter(setter(Builder::notificationARNs))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NotificationARNs").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField ROLLBACK_CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("RollbackConfiguration")
.getter(getter(DescribeChangeSetResponse::rollbackConfiguration)).setter(setter(Builder::rollbackConfiguration))
.constructor(RollbackConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RollbackConfiguration").build())
.build();
private static final SdkField> CAPABILITIES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Capabilities")
.getter(getter(DescribeChangeSetResponse::capabilitiesAsStrings))
.setter(setter(Builder::capabilitiesWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Capabilities").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(DescribeChangeSetResponse::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> CHANGES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Changes")
.getter(getter(DescribeChangeSetResponse::changes))
.setter(setter(Builder::changes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Changes").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Change::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(DescribeChangeSetResponse::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField INCLUDE_NESTED_STACKS_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("IncludeNestedStacks").getter(getter(DescribeChangeSetResponse::includeNestedStacks))
.setter(setter(Builder::includeNestedStacks))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IncludeNestedStacks").build())
.build();
private static final SdkField PARENT_CHANGE_SET_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ParentChangeSetId").getter(getter(DescribeChangeSetResponse::parentChangeSetId))
.setter(setter(Builder::parentChangeSetId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ParentChangeSetId").build()).build();
private static final SdkField ROOT_CHANGE_SET_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RootChangeSetId").getter(getter(DescribeChangeSetResponse::rootChangeSetId))
.setter(setter(Builder::rootChangeSetId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RootChangeSetId").build()).build();
private static final SdkField ON_STACK_FAILURE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OnStackFailure").getter(getter(DescribeChangeSetResponse::onStackFailureAsString))
.setter(setter(Builder::onStackFailure))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OnStackFailure").build()).build();
private static final SdkField IMPORT_EXISTING_RESOURCES_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("ImportExistingResources").getter(getter(DescribeChangeSetResponse::importExistingResources))
.setter(setter(Builder::importExistingResources))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ImportExistingResources").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CHANGE_SET_NAME_FIELD,
CHANGE_SET_ID_FIELD, STACK_ID_FIELD, STACK_NAME_FIELD, DESCRIPTION_FIELD, PARAMETERS_FIELD, CREATION_TIME_FIELD,
EXECUTION_STATUS_FIELD, STATUS_FIELD, STATUS_REASON_FIELD, NOTIFICATION_AR_NS_FIELD, ROLLBACK_CONFIGURATION_FIELD,
CAPABILITIES_FIELD, TAGS_FIELD, CHANGES_FIELD, NEXT_TOKEN_FIELD, INCLUDE_NESTED_STACKS_FIELD,
PARENT_CHANGE_SET_ID_FIELD, ROOT_CHANGE_SET_ID_FIELD, ON_STACK_FAILURE_FIELD, IMPORT_EXISTING_RESOURCES_FIELD));
private final String changeSetName;
private final String changeSetId;
private final String stackId;
private final String stackName;
private final String description;
private final List parameters;
private final Instant creationTime;
private final String executionStatus;
private final String status;
private final String statusReason;
private final List notificationARNs;
private final RollbackConfiguration rollbackConfiguration;
private final List capabilities;
private final List tags;
private final List changes;
private final String nextToken;
private final Boolean includeNestedStacks;
private final String parentChangeSetId;
private final String rootChangeSetId;
private final String onStackFailure;
private final Boolean importExistingResources;
private DescribeChangeSetResponse(BuilderImpl builder) {
super(builder);
this.changeSetName = builder.changeSetName;
this.changeSetId = builder.changeSetId;
this.stackId = builder.stackId;
this.stackName = builder.stackName;
this.description = builder.description;
this.parameters = builder.parameters;
this.creationTime = builder.creationTime;
this.executionStatus = builder.executionStatus;
this.status = builder.status;
this.statusReason = builder.statusReason;
this.notificationARNs = builder.notificationARNs;
this.rollbackConfiguration = builder.rollbackConfiguration;
this.capabilities = builder.capabilities;
this.tags = builder.tags;
this.changes = builder.changes;
this.nextToken = builder.nextToken;
this.includeNestedStacks = builder.includeNestedStacks;
this.parentChangeSetId = builder.parentChangeSetId;
this.rootChangeSetId = builder.rootChangeSetId;
this.onStackFailure = builder.onStackFailure;
this.importExistingResources = builder.importExistingResources;
}
/**
*
* The name of the change set.
*
*
* @return The name of the change set.
*/
public final String changeSetName() {
return changeSetName;
}
/**
*
* The Amazon Resource Name (ARN) of the change set.
*
*
* @return The Amazon Resource Name (ARN) of the change set.
*/
public final String changeSetId() {
return changeSetId;
}
/**
*
* The Amazon Resource Name (ARN) of the stack that's associated with the change set.
*
*
* @return The Amazon Resource Name (ARN) of the stack that's associated with the change set.
*/
public final String stackId() {
return stackId;
}
/**
*
* The name of the stack that's associated with the change set.
*
*
* @return The name of the stack that's associated with the change set.
*/
public final String stackName() {
return stackName;
}
/**
*
* Information about the change set.
*
*
* @return Information about the change set.
*/
public final String description() {
return description;
}
/**
* 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 {@code 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 boolean hasParameters() {
return parameters != null && !(parameters instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasParameters} method.
*
*
* @return 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.
*/
public final List parameters() {
return parameters;
}
/**
*
* The start time when the change set was created, in UTC.
*
*
* @return The start time when the change set was created, in UTC.
*/
public final Instant creationTime() {
return creationTime;
}
/**
*
* 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, {@link #executionStatus}
* will return {@link ExecutionStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #executionStatusAsString}.
*
*
* @return 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 ExecutionStatus
*/
public final ExecutionStatus executionStatus() {
return ExecutionStatus.fromValue(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, {@link #executionStatus}
* will return {@link ExecutionStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #executionStatusAsString}.
*
*
* @return 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 ExecutionStatus
*/
public final String executionStatusAsString() {
return executionStatus;
}
/**
*
* 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, {@link #status} will
* return {@link ChangeSetStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return The current status of the change set, such as CREATE_IN_PROGRESS,
* CREATE_COMPLETE, or FAILED.
* @see ChangeSetStatus
*/
public final ChangeSetStatus status() {
return ChangeSetStatus.fromValue(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, {@link #status} will
* return {@link ChangeSetStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return The current status of the change set, such as CREATE_IN_PROGRESS,
* CREATE_COMPLETE, or FAILED.
* @see ChangeSetStatus
*/
public final String statusAsString() {
return status;
}
/**
*
* A description of the change set's status. For example, if your attempt to create a change set failed,
* CloudFormation shows the error message.
*
*
* @return A description of the change set's status. For example, if your attempt to create a change set failed,
* CloudFormation shows the error message.
*/
public final String statusReason() {
return statusReason;
}
/**
* 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 {@code 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 boolean hasNotificationARNs() {
return notificationARNs != null && !(notificationARNs instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasNotificationARNs} method.
*
*
* @return The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the
* stack if you execute the change set.
*/
public final List notificationARNs() {
return notificationARNs;
}
/**
*
* The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the
* specified monitoring period afterwards.
*
*
* @return The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and
* for the specified monitoring period afterwards.
*/
public final RollbackConfiguration rollbackConfiguration() {
return rollbackConfiguration;
}
/**
*
* 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 {@link #hasCapabilities} method.
*
*
* @return If you execute the change set, the list of capabilities that were explicitly acknowledged when the change
* set was created.
*/
public final List capabilities() {
return CapabilitiesCopier.copyStringToEnum(capabilities);
}
/**
* 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 {@code 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 boolean hasCapabilities() {
return capabilities != null && !(capabilities instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasCapabilities} method.
*
*
* @return If you execute the change set, the list of capabilities that were explicitly acknowledged when the change
* set was created.
*/
public final List capabilitiesAsStrings() {
return capabilities;
}
/**
* 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 {@code 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 boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasTags} method.
*
*
* @return If you execute the change set, the tags that will be associated with the stack.
*/
public final List tags() {
return tags;
}
/**
* 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 {@code 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 boolean hasChanges() {
return changes != null && !(changes instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasChanges} method.
*
*
* @return A list of Change structures that describes the resources CloudFormation changes if you
* execute the change set.
*/
public final List changes() {
return changes;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* Verifies if IncludeNestedStacks is set to True.
*
*
* @return Verifies if IncludeNestedStacks is set to True.
*/
public final Boolean includeNestedStacks() {
return includeNestedStacks;
}
/**
*
* Specifies the change set ID of the parent change set in the current nested change set hierarchy.
*
*
* @return Specifies the change set ID of the parent change set in the current nested change set hierarchy.
*/
public final String parentChangeSetId() {
return parentChangeSetId;
}
/**
*
* Specifies the change set ID of the root change set in the current nested change set hierarchy.
*
*
* @return Specifies the change set ID of the root change set in the current nested change set hierarchy.
*/
public final String rootChangeSetId() {
return rootChangeSetId;
}
/**
*
* 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, {@link #onStackFailure}
* will return {@link OnStackFailure#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #onStackFailureAsString}.
*
*
* @return 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 OnStackFailure
*/
public final OnStackFailure onStackFailure() {
return OnStackFailure.fromValue(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, {@link #onStackFailure}
* will return {@link OnStackFailure#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #onStackFailureAsString}.
*
*
* @return 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 OnStackFailure
*/
public final String onStackFailureAsString() {
return onStackFailure;
}
/**
*
* Indicates if the change set imports resources that already exist.
*
*
*
* This parameter can only import resources that have custom names
* in templates. To import resources that do not accept custom names, such as EC2 instances, use the resource import
* feature instead.
*
*
*
* @return Indicates if the change set imports resources that already exist.
*
* This parameter can only import resources that have custom
* names in templates. To import resources that do not accept custom names, such as EC2 instances, use
* the resource
* import feature instead.
*
*/
public final Boolean importExistingResources() {
return importExistingResources;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(changeSetName());
hashCode = 31 * hashCode + Objects.hashCode(changeSetId());
hashCode = 31 * hashCode + Objects.hashCode(stackId());
hashCode = 31 * hashCode + Objects.hashCode(stackName());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(hasParameters() ? parameters() : null);
hashCode = 31 * hashCode + Objects.hashCode(creationTime());
hashCode = 31 * hashCode + Objects.hashCode(executionStatusAsString());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(statusReason());
hashCode = 31 * hashCode + Objects.hashCode(hasNotificationARNs() ? notificationARNs() : null);
hashCode = 31 * hashCode + Objects.hashCode(rollbackConfiguration());
hashCode = 31 * hashCode + Objects.hashCode(hasCapabilities() ? capabilitiesAsStrings() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasChanges() ? changes() : null);
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(includeNestedStacks());
hashCode = 31 * hashCode + Objects.hashCode(parentChangeSetId());
hashCode = 31 * hashCode + Objects.hashCode(rootChangeSetId());
hashCode = 31 * hashCode + Objects.hashCode(onStackFailureAsString());
hashCode = 31 * hashCode + Objects.hashCode(importExistingResources());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeChangeSetResponse)) {
return false;
}
DescribeChangeSetResponse other = (DescribeChangeSetResponse) obj;
return Objects.equals(changeSetName(), other.changeSetName()) && Objects.equals(changeSetId(), other.changeSetId())
&& Objects.equals(stackId(), other.stackId()) && Objects.equals(stackName(), other.stackName())
&& Objects.equals(description(), other.description()) && hasParameters() == other.hasParameters()
&& Objects.equals(parameters(), other.parameters()) && Objects.equals(creationTime(), other.creationTime())
&& Objects.equals(executionStatusAsString(), other.executionStatusAsString())
&& Objects.equals(statusAsString(), other.statusAsString())
&& Objects.equals(statusReason(), other.statusReason()) && hasNotificationARNs() == other.hasNotificationARNs()
&& Objects.equals(notificationARNs(), other.notificationARNs())
&& Objects.equals(rollbackConfiguration(), other.rollbackConfiguration())
&& hasCapabilities() == other.hasCapabilities()
&& Objects.equals(capabilitiesAsStrings(), other.capabilitiesAsStrings()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags()) && hasChanges() == other.hasChanges()
&& Objects.equals(changes(), other.changes()) && Objects.equals(nextToken(), other.nextToken())
&& Objects.equals(includeNestedStacks(), other.includeNestedStacks())
&& Objects.equals(parentChangeSetId(), other.parentChangeSetId())
&& Objects.equals(rootChangeSetId(), other.rootChangeSetId())
&& Objects.equals(onStackFailureAsString(), other.onStackFailureAsString())
&& Objects.equals(importExistingResources(), other.importExistingResources());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("DescribeChangeSetResponse").add("ChangeSetName", changeSetName())
.add("ChangeSetId", changeSetId()).add("StackId", stackId()).add("StackName", stackName())
.add("Description", description()).add("Parameters", hasParameters() ? parameters() : null)
.add("CreationTime", creationTime()).add("ExecutionStatus", executionStatusAsString())
.add("Status", statusAsString()).add("StatusReason", statusReason())
.add("NotificationARNs", hasNotificationARNs() ? notificationARNs() : null)
.add("RollbackConfiguration", rollbackConfiguration())
.add("Capabilities", hasCapabilities() ? capabilitiesAsStrings() : null).add("Tags", hasTags() ? tags() : null)
.add("Changes", hasChanges() ? changes() : null).add("NextToken", nextToken())
.add("IncludeNestedStacks", includeNestedStacks()).add("ParentChangeSetId", parentChangeSetId())
.add("RootChangeSetId", rootChangeSetId()).add("OnStackFailure", onStackFailureAsString())
.add("ImportExistingResources", importExistingResources()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ChangeSetName":
return Optional.ofNullable(clazz.cast(changeSetName()));
case "ChangeSetId":
return Optional.ofNullable(clazz.cast(changeSetId()));
case "StackId":
return Optional.ofNullable(clazz.cast(stackId()));
case "StackName":
return Optional.ofNullable(clazz.cast(stackName()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "Parameters":
return Optional.ofNullable(clazz.cast(parameters()));
case "CreationTime":
return Optional.ofNullable(clazz.cast(creationTime()));
case "ExecutionStatus":
return Optional.ofNullable(clazz.cast(executionStatusAsString()));
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "StatusReason":
return Optional.ofNullable(clazz.cast(statusReason()));
case "NotificationARNs":
return Optional.ofNullable(clazz.cast(notificationARNs()));
case "RollbackConfiguration":
return Optional.ofNullable(clazz.cast(rollbackConfiguration()));
case "Capabilities":
return Optional.ofNullable(clazz.cast(capabilitiesAsStrings()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
case "Changes":
return Optional.ofNullable(clazz.cast(changes()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "IncludeNestedStacks":
return Optional.ofNullable(clazz.cast(includeNestedStacks()));
case "ParentChangeSetId":
return Optional.ofNullable(clazz.cast(parentChangeSetId()));
case "RootChangeSetId":
return Optional.ofNullable(clazz.cast(rootChangeSetId()));
case "OnStackFailure":
return Optional.ofNullable(clazz.cast(onStackFailureAsString()));
case "ImportExistingResources":
return Optional.ofNullable(clazz.cast(importExistingResources()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeChangeSetResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CloudFormationResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the change set.
*
*
* @param changeSetName
* The name of the change set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder changeSetName(String changeSetName);
/**
*
* The Amazon Resource Name (ARN) of the change set.
*
*
* @param changeSetId
* The Amazon Resource Name (ARN) of the change set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder changeSetId(String changeSetId);
/**
*
* The Amazon Resource Name (ARN) of the stack that's associated with the change set.
*
*
* @param stackId
* The Amazon Resource Name (ARN) of the stack that's associated with the change set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stackId(String stackId);
/**
*
* The name of the stack that's associated with the change set.
*
*
* @param stackName
* The name of the stack that's associated with the change set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stackName(String stackName);
/**
*
* Information about the change set.
*
*
* @param description
* Information about the change set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder parameters(Collection 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder parameters(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.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.cloudformation.model.Parameter.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.cloudformation.model.Parameter#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.cloudformation.model.Parameter.Builder#build()} is called immediately
* and its result is passed to {@link #parameters(List)}.
*
* @param parameters
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.Parameter.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #parameters(java.util.Collection)
*/
Builder parameters(Consumer... parameters);
/**
*
* The start time when the change set was created, in UTC.
*
*
* @param creationTime
* The start time when the change set was created, in UTC.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationTime(Instant creationTime);
/**
*
* 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.
*
*
* @param 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.
* @see ExecutionStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ExecutionStatus
*/
Builder executionStatus(String 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.
*
*
* @param 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.
* @see ExecutionStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ExecutionStatus
*/
Builder executionStatus(ExecutionStatus executionStatus);
/**
*
* The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE,
* or FAILED.
*
*
* @param status
* The current status of the change set, such as CREATE_IN_PROGRESS,
* CREATE_COMPLETE, or FAILED.
* @see ChangeSetStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChangeSetStatus
*/
Builder status(String status);
/**
*
* The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE,
* or FAILED.
*
*
* @param status
* The current status of the change set, such as CREATE_IN_PROGRESS,
* CREATE_COMPLETE, or FAILED.
* @see ChangeSetStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChangeSetStatus
*/
Builder status(ChangeSetStatus status);
/**
*
* A description of the change set's status. For example, if your attempt to create a change set failed,
* CloudFormation shows the error message.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder statusReason(String statusReason);
/**
*
* The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack
* if you execute the change set.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder notificationARNs(Collection 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder notificationARNs(String... notificationARNs);
/**
*
* The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for
* the specified monitoring period afterwards.
*
*
* @param rollbackConfiguration
* The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and
* for the specified monitoring period afterwards.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder rollbackConfiguration(RollbackConfiguration rollbackConfiguration);
/**
*
* The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for
* the specified monitoring period afterwards.
*
* This is a convenience method that creates an instance of the {@link RollbackConfiguration.Builder} avoiding
* the need to create one manually via {@link RollbackConfiguration#builder()}.
*
*
* When the {@link Consumer} completes, {@link RollbackConfiguration.Builder#build()} is called immediately and
* its result is passed to {@link #rollbackConfiguration(RollbackConfiguration)}.
*
* @param rollbackConfiguration
* a consumer that will call methods on {@link RollbackConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #rollbackConfiguration(RollbackConfiguration)
*/
default Builder rollbackConfiguration(Consumer rollbackConfiguration) {
return rollbackConfiguration(RollbackConfiguration.builder().applyMutation(rollbackConfiguration).build());
}
/**
*
* If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set
* was created.
*
*
* @param capabilities
* If you execute the change set, the list of capabilities that were explicitly acknowledged when the
* change set was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder capabilitiesWithStrings(Collection capabilities);
/**
*
* If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set
* was created.
*
*
* @param capabilities
* If you execute the change set, the list of capabilities that were explicitly acknowledged when the
* change set was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder capabilitiesWithStrings(String... capabilities);
/**
*
* If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set
* was created.
*
*
* @param capabilities
* If you execute the change set, the list of capabilities that were explicitly acknowledged when the
* change set was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder capabilities(Collection capabilities);
/**
*
* If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set
* was created.
*
*
* @param capabilities
* If you execute the change set, the list of capabilities that were explicitly acknowledged when the
* change set was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder capabilities(Capability... capabilities);
/**
*
* If you execute the change set, the tags that will be associated with the stack.
*
*
* @param tags
* If you execute the change set, the tags that will be associated with the stack.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* If you execute the change set, the tags that will be associated with the stack.
*
*
* @param tags
* If you execute the change set, the tags that will be associated with the stack.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* If you execute the change set, the tags that will be associated with the stack.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.cloudformation.model.Tag.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.cloudformation.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.cloudformation.model.Tag.Builder#build()} is called immediately and
* its result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
/**
*
* A list of Change structures that describes the resources CloudFormation changes if you execute
* the change set.
*
*
* @param changes
* A list of Change structures that describes the resources CloudFormation changes if you
* execute the change set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder changes(Collection changes);
/**
*
* A list of Change structures that describes the resources CloudFormation changes if you execute
* the change set.
*
*
* @param changes
* A list of Change structures that describes the resources CloudFormation changes if you
* execute the change set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder changes(Change... changes);
/**
*
* A list of Change structures that describes the resources CloudFormation changes if you execute
* the change set.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.cloudformation.model.Change.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.cloudformation.model.Change#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.cloudformation.model.Change.Builder#build()} is called immediately and
* its result is passed to {@link #changes(List)}.
*
* @param changes
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.Change.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #changes(java.util.Collection)
*/
Builder changes(Consumer... changes);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* Verifies if IncludeNestedStacks is set to True.
*
*
* @param includeNestedStacks
* Verifies if IncludeNestedStacks is set to True.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder includeNestedStacks(Boolean includeNestedStacks);
/**
*
* Specifies the change set ID of the parent change set in the current nested change set hierarchy.
*
*
* @param parentChangeSetId
* Specifies the change set ID of the parent change set in the current nested change set hierarchy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder parentChangeSetId(String parentChangeSetId);
/**
*
* Specifies the change set ID of the root change set in the current nested change set hierarchy.
*
*
* @param rootChangeSetId
* Specifies the change set ID of the root change set in the current nested change set hierarchy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder rootChangeSetId(String rootChangeSetId);
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @see OnStackFailure
* @return Returns a reference to this object so that method calls can be chained together.
* @see OnStackFailure
*/
Builder onStackFailure(String 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.
*
*
*
*
* @param 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.
*
*
* @see OnStackFailure
* @return Returns a reference to this object so that method calls can be chained together.
* @see OnStackFailure
*/
Builder onStackFailure(OnStackFailure onStackFailure);
/**
*
* Indicates if the change set imports resources that already exist.
*
*
*
* This parameter can only import resources that have custom
* names in templates. To import resources that do not accept custom names, such as EC2 instances, use the
* resource
* import feature instead.
*
*
*
* @param importExistingResources
* Indicates if the change set imports resources that already exist.
*
* This parameter can only import resources that have custom
* names in templates. To import resources that do not accept custom names, such as EC2 instances,
* use the resource
* import feature instead.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder importExistingResources(Boolean importExistingResources);
}
static final class BuilderImpl extends CloudFormationResponse.BuilderImpl implements Builder {
private String changeSetName;
private String changeSetId;
private String stackId;
private String stackName;
private String description;
private List parameters = DefaultSdkAutoConstructList.getInstance();
private Instant creationTime;
private String executionStatus;
private String status;
private String statusReason;
private List notificationARNs = DefaultSdkAutoConstructList.getInstance();
private RollbackConfiguration rollbackConfiguration;
private List capabilities = DefaultSdkAutoConstructList.getInstance();
private List tags = DefaultSdkAutoConstructList.getInstance();
private List changes = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private Boolean includeNestedStacks;
private String parentChangeSetId;
private String rootChangeSetId;
private String onStackFailure;
private Boolean importExistingResources;
private BuilderImpl() {
}
private BuilderImpl(DescribeChangeSetResponse model) {
super(model);
changeSetName(model.changeSetName);
changeSetId(model.changeSetId);
stackId(model.stackId);
stackName(model.stackName);
description(model.description);
parameters(model.parameters);
creationTime(model.creationTime);
executionStatus(model.executionStatus);
status(model.status);
statusReason(model.statusReason);
notificationARNs(model.notificationARNs);
rollbackConfiguration(model.rollbackConfiguration);
capabilitiesWithStrings(model.capabilities);
tags(model.tags);
changes(model.changes);
nextToken(model.nextToken);
includeNestedStacks(model.includeNestedStacks);
parentChangeSetId(model.parentChangeSetId);
rootChangeSetId(model.rootChangeSetId);
onStackFailure(model.onStackFailure);
importExistingResources(model.importExistingResources);
}
public final String getChangeSetName() {
return changeSetName;
}
public final void setChangeSetName(String changeSetName) {
this.changeSetName = changeSetName;
}
@Override
public final Builder changeSetName(String changeSetName) {
this.changeSetName = changeSetName;
return this;
}
public final String getChangeSetId() {
return changeSetId;
}
public final void setChangeSetId(String changeSetId) {
this.changeSetId = changeSetId;
}
@Override
public final Builder changeSetId(String changeSetId) {
this.changeSetId = changeSetId;
return this;
}
public final String getStackId() {
return stackId;
}
public final void setStackId(String stackId) {
this.stackId = stackId;
}
@Override
public final Builder stackId(String stackId) {
this.stackId = stackId;
return this;
}
public final String getStackName() {
return stackName;
}
public final void setStackName(String stackName) {
this.stackName = stackName;
}
@Override
public final Builder stackName(String stackName) {
this.stackName = stackName;
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final List getParameters() {
List result = ParametersCopier.copyToBuilder(this.parameters);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setParameters(Collection parameters) {
this.parameters = ParametersCopier.copyFromBuilder(parameters);
}
@Override
public final Builder parameters(Collection parameters) {
this.parameters = ParametersCopier.copy(parameters);
return this;
}
@Override
@SafeVarargs
public final Builder parameters(Parameter... parameters) {
parameters(Arrays.asList(parameters));
return this;
}
@Override
@SafeVarargs
public final Builder parameters(Consumer... parameters) {
parameters(Stream.of(parameters).map(c -> Parameter.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final Instant getCreationTime() {
return creationTime;
}
public final void setCreationTime(Instant creationTime) {
this.creationTime = creationTime;
}
@Override
public final Builder creationTime(Instant creationTime) {
this.creationTime = creationTime;
return this;
}
public final String getExecutionStatus() {
return executionStatus;
}
public final void setExecutionStatus(String executionStatus) {
this.executionStatus = executionStatus;
}
@Override
public final Builder executionStatus(String executionStatus) {
this.executionStatus = executionStatus;
return this;
}
@Override
public final Builder executionStatus(ExecutionStatus executionStatus) {
this.executionStatus(executionStatus == null ? null : executionStatus.toString());
return this;
}
public final String getStatus() {
return status;
}
public final void setStatus(String status) {
this.status = status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(ChangeSetStatus status) {
this.status(status == null ? null : status.toString());
return this;
}
public final String getStatusReason() {
return statusReason;
}
public final void setStatusReason(String statusReason) {
this.statusReason = statusReason;
}
@Override
public final Builder statusReason(String statusReason) {
this.statusReason = statusReason;
return this;
}
public final Collection getNotificationARNs() {
if (notificationARNs instanceof SdkAutoConstructList) {
return null;
}
return notificationARNs;
}
public final void setNotificationARNs(Collection notificationARNs) {
this.notificationARNs = NotificationARNsCopier.copy(notificationARNs);
}
@Override
public final Builder notificationARNs(Collection notificationARNs) {
this.notificationARNs = NotificationARNsCopier.copy(notificationARNs);
return this;
}
@Override
@SafeVarargs
public final Builder notificationARNs(String... notificationARNs) {
notificationARNs(Arrays.asList(notificationARNs));
return this;
}
public final RollbackConfiguration.Builder getRollbackConfiguration() {
return rollbackConfiguration != null ? rollbackConfiguration.toBuilder() : null;
}
public final void setRollbackConfiguration(RollbackConfiguration.BuilderImpl rollbackConfiguration) {
this.rollbackConfiguration = rollbackConfiguration != null ? rollbackConfiguration.build() : null;
}
@Override
public final Builder rollbackConfiguration(RollbackConfiguration rollbackConfiguration) {
this.rollbackConfiguration = rollbackConfiguration;
return this;
}
public final Collection getCapabilities() {
if (capabilities instanceof SdkAutoConstructList) {
return null;
}
return capabilities;
}
public final void setCapabilities(Collection capabilities) {
this.capabilities = CapabilitiesCopier.copy(capabilities);
}
@Override
public final Builder capabilitiesWithStrings(Collection capabilities) {
this.capabilities = CapabilitiesCopier.copy(capabilities);
return this;
}
@Override
@SafeVarargs
public final Builder capabilitiesWithStrings(String... capabilities) {
capabilitiesWithStrings(Arrays.asList(capabilities));
return this;
}
@Override
public final Builder capabilities(Collection capabilities) {
this.capabilities = CapabilitiesCopier.copyEnumToString(capabilities);
return this;
}
@Override
@SafeVarargs
public final Builder capabilities(Capability... capabilities) {
capabilities(Arrays.asList(capabilities));
return this;
}
public final List getTags() {
List result = TagsCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagsCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagsCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final List getChanges() {
List result = ChangesCopier.copyToBuilder(this.changes);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setChanges(Collection changes) {
this.changes = ChangesCopier.copyFromBuilder(changes);
}
@Override
public final Builder changes(Collection changes) {
this.changes = ChangesCopier.copy(changes);
return this;
}
@Override
@SafeVarargs
public final Builder changes(Change... changes) {
changes(Arrays.asList(changes));
return this;
}
@Override
@SafeVarargs
public final Builder changes(Consumer... changes) {
changes(Stream.of(changes).map(c -> Change.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final Boolean getIncludeNestedStacks() {
return includeNestedStacks;
}
public final void setIncludeNestedStacks(Boolean includeNestedStacks) {
this.includeNestedStacks = includeNestedStacks;
}
@Override
public final Builder includeNestedStacks(Boolean includeNestedStacks) {
this.includeNestedStacks = includeNestedStacks;
return this;
}
public final String getParentChangeSetId() {
return parentChangeSetId;
}
public final void setParentChangeSetId(String parentChangeSetId) {
this.parentChangeSetId = parentChangeSetId;
}
@Override
public final Builder parentChangeSetId(String parentChangeSetId) {
this.parentChangeSetId = parentChangeSetId;
return this;
}
public final String getRootChangeSetId() {
return rootChangeSetId;
}
public final void setRootChangeSetId(String rootChangeSetId) {
this.rootChangeSetId = rootChangeSetId;
}
@Override
public final Builder rootChangeSetId(String rootChangeSetId) {
this.rootChangeSetId = rootChangeSetId;
return this;
}
public final String getOnStackFailure() {
return onStackFailure;
}
public final void setOnStackFailure(String onStackFailure) {
this.onStackFailure = onStackFailure;
}
@Override
public final Builder onStackFailure(String onStackFailure) {
this.onStackFailure = onStackFailure;
return this;
}
@Override
public final Builder onStackFailure(OnStackFailure onStackFailure) {
this.onStackFailure(onStackFailure == null ? null : onStackFailure.toString());
return this;
}
public final Boolean getImportExistingResources() {
return importExistingResources;
}
public final void setImportExistingResources(Boolean importExistingResources) {
this.importExistingResources = importExistingResources;
}
@Override
public final Builder importExistingResources(Boolean importExistingResources) {
this.importExistingResources = importExistingResources;
return this;
}
@Override
public DescribeChangeSetResponse build() {
return new DescribeChangeSetResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}