software.amazon.awssdk.services.cloudformation.model.StackSetOperation Maven / Gradle / Ivy
/*
* 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.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
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 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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The structure that contains information about a stack set operation.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class StackSetOperation implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField OPERATION_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OperationId").getter(getter(StackSetOperation::operationId)).setter(setter(Builder::operationId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OperationId").build()).build();
private static final SdkField STACK_SET_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StackSetId").getter(getter(StackSetOperation::stackSetId)).setter(setter(Builder::stackSetId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StackSetId").build()).build();
private static final SdkField ACTION_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Action")
.getter(getter(StackSetOperation::actionAsString)).setter(setter(Builder::action))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Action").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(StackSetOperation::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final SdkField OPERATION_PREFERENCES_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("OperationPreferences")
.getter(getter(StackSetOperation::operationPreferences)).setter(setter(Builder::operationPreferences))
.constructor(StackSetOperationPreferences::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OperationPreferences").build())
.build();
private static final SdkField RETAIN_STACKS_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("RetainStacks").getter(getter(StackSetOperation::retainStacks)).setter(setter(Builder::retainStacks))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RetainStacks").build()).build();
private static final SdkField ADMINISTRATION_ROLE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AdministrationRoleARN").getter(getter(StackSetOperation::administrationRoleARN))
.setter(setter(Builder::administrationRoleARN))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AdministrationRoleARN").build())
.build();
private static final SdkField EXECUTION_ROLE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ExecutionRoleName").getter(getter(StackSetOperation::executionRoleName))
.setter(setter(Builder::executionRoleName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExecutionRoleName").build()).build();
private static final SdkField CREATION_TIMESTAMP_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreationTimestamp").getter(getter(StackSetOperation::creationTimestamp))
.setter(setter(Builder::creationTimestamp))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreationTimestamp").build()).build();
private static final SdkField END_TIMESTAMP_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("EndTimestamp").getter(getter(StackSetOperation::endTimestamp)).setter(setter(Builder::endTimestamp))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndTimestamp").build()).build();
private static final SdkField DEPLOYMENT_TARGETS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("DeploymentTargets")
.getter(getter(StackSetOperation::deploymentTargets)).setter(setter(Builder::deploymentTargets))
.constructor(DeploymentTargets::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DeploymentTargets").build()).build();
private static final SdkField STACK_SET_DRIFT_DETECTION_DETAILS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("StackSetDriftDetectionDetails")
.getter(getter(StackSetOperation::stackSetDriftDetectionDetails))
.setter(setter(Builder::stackSetDriftDetectionDetails))
.constructor(StackSetDriftDetectionDetails::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StackSetDriftDetectionDetails")
.build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(OPERATION_ID_FIELD,
STACK_SET_ID_FIELD, ACTION_FIELD, STATUS_FIELD, OPERATION_PREFERENCES_FIELD, RETAIN_STACKS_FIELD,
ADMINISTRATION_ROLE_ARN_FIELD, EXECUTION_ROLE_NAME_FIELD, CREATION_TIMESTAMP_FIELD, END_TIMESTAMP_FIELD,
DEPLOYMENT_TARGETS_FIELD, STACK_SET_DRIFT_DETECTION_DETAILS_FIELD));
private static final long serialVersionUID = 1L;
private final String operationId;
private final String stackSetId;
private final String action;
private final String status;
private final StackSetOperationPreferences operationPreferences;
private final Boolean retainStacks;
private final String administrationRoleARN;
private final String executionRoleName;
private final Instant creationTimestamp;
private final Instant endTimestamp;
private final DeploymentTargets deploymentTargets;
private final StackSetDriftDetectionDetails stackSetDriftDetectionDetails;
private StackSetOperation(BuilderImpl builder) {
this.operationId = builder.operationId;
this.stackSetId = builder.stackSetId;
this.action = builder.action;
this.status = builder.status;
this.operationPreferences = builder.operationPreferences;
this.retainStacks = builder.retainStacks;
this.administrationRoleARN = builder.administrationRoleARN;
this.executionRoleName = builder.executionRoleName;
this.creationTimestamp = builder.creationTimestamp;
this.endTimestamp = builder.endTimestamp;
this.deploymentTargets = builder.deploymentTargets;
this.stackSetDriftDetectionDetails = builder.stackSetDriftDetectionDetails;
}
/**
*
* The unique ID of a stack set operation.
*
*
* @return The unique ID of a stack set operation.
*/
public String operationId() {
return operationId;
}
/**
*
* The ID of the stack set.
*
*
* @return The ID of the stack set.
*/
public String stackSetId() {
return stackSetId;
}
/**
*
* The type of stack set operation: CREATE, UPDATE, or DELETE. Create and
* delete operations affect only the specified stack set instances that are associated with the specified stack set.
* Update operations affect both the stack set itself, as well as all associated stack set instances.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #action} will
* return {@link StackSetOperationAction#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #actionAsString}.
*
*
* @return The type of stack set operation: CREATE, UPDATE, or DELETE. Create
* and delete operations affect only the specified stack set instances that are associated with the
* specified stack set. Update operations affect both the stack set itself, as well as all associated
* stack set instances.
* @see StackSetOperationAction
*/
public StackSetOperationAction action() {
return StackSetOperationAction.fromValue(action);
}
/**
*
* The type of stack set operation: CREATE, UPDATE, or DELETE. Create and
* delete operations affect only the specified stack set instances that are associated with the specified stack set.
* Update operations affect both the stack set itself, as well as all associated stack set instances.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #action} will
* return {@link StackSetOperationAction#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #actionAsString}.
*
*
* @return The type of stack set operation: CREATE, UPDATE, or DELETE. Create
* and delete operations affect only the specified stack set instances that are associated with the
* specified stack set. Update operations affect both the stack set itself, as well as all associated
* stack set instances.
* @see StackSetOperationAction
*/
public String actionAsString() {
return action;
}
/**
*
* The status of the operation.
*
*
* -
*
* FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that
* you've set for an operation is applied for each Region during stack create and update operations. If the number
* of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set
* to FAILED. This in turn sets the status of the operation as a whole to FAILED, and AWS
* CloudFormation cancels the operation in any remaining Regions.
*
*
* -
*
* QUEUED: [Service-managed permissions] For automatic deployments that require a sequence
* of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the AWS CloudFormation User Guide.
*
*
* -
*
* RUNNING: The operation is currently being performed.
*
*
* -
*
* STOPPED: The user has cancelled the operation.
*
*
* -
*
* STOPPING: The operation is in the process of stopping, at user request.
*
*
* -
*
* SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding
* the failure tolerance for the operation.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link StackSetOperationStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #statusAsString}.
*
*
* @return The status of the operation.
*
* -
*
* FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value
* that you've set for an operation is applied for each Region during stack create and update operations. If
* the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in
* the Region is set to FAILED. This in turn sets the status of the operation as a whole to
* FAILED, and AWS CloudFormation cancels the operation in any remaining Regions.
*
*
* -
*
* QUEUED: [Service-managed permissions] For automatic deployments that require a
* sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the AWS CloudFormation User Guide.
*
*
* -
*
* RUNNING: The operation is currently being performed.
*
*
* -
*
* STOPPED: The user has cancelled the operation.
*
*
* -
*
* STOPPING: The operation is in the process of stopping, at user request.
*
*
* -
*
* SUCCEEDED: The operation completed creating or updating all the specified stacks without
* exceeding the failure tolerance for the operation.
*
*
* @see StackSetOperationStatus
*/
public StackSetOperationStatus status() {
return StackSetOperationStatus.fromValue(status);
}
/**
*
* The status of the operation.
*
*
* -
*
* FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that
* you've set for an operation is applied for each Region during stack create and update operations. If the number
* of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set
* to FAILED. This in turn sets the status of the operation as a whole to FAILED, and AWS
* CloudFormation cancels the operation in any remaining Regions.
*
*
* -
*
* QUEUED: [Service-managed permissions] For automatic deployments that require a sequence
* of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the AWS CloudFormation User Guide.
*
*
* -
*
* RUNNING: The operation is currently being performed.
*
*
* -
*
* STOPPED: The user has cancelled the operation.
*
*
* -
*
* STOPPING: The operation is in the process of stopping, at user request.
*
*
* -
*
* SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding
* the failure tolerance for the operation.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link StackSetOperationStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #statusAsString}.
*
*
* @return The status of the operation.
*
* -
*
* FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value
* that you've set for an operation is applied for each Region during stack create and update operations. If
* the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in
* the Region is set to FAILED. This in turn sets the status of the operation as a whole to
* FAILED, and AWS CloudFormation cancels the operation in any remaining Regions.
*
*
* -
*
* QUEUED: [Service-managed permissions] For automatic deployments that require a
* sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the AWS CloudFormation User Guide.
*
*
* -
*
* RUNNING: The operation is currently being performed.
*
*
* -
*
* STOPPED: The user has cancelled the operation.
*
*
* -
*
* STOPPING: The operation is in the process of stopping, at user request.
*
*
* -
*
* SUCCEEDED: The operation completed creating or updating all the specified stacks without
* exceeding the failure tolerance for the operation.
*
*
* @see StackSetOperationStatus
*/
public String statusAsString() {
return status;
}
/**
*
* The preferences for how AWS CloudFormation performs this stack set operation.
*
*
* @return The preferences for how AWS CloudFormation performs this stack set operation.
*/
public StackSetOperationPreferences operationPreferences() {
return operationPreferences;
}
/**
*
* For stack set operations of action type DELETE, specifies whether to remove the stack instances from
* the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack, or add an
* existing, saved stack to a new stack set.
*
*
* @return For stack set operations of action type DELETE, specifies whether to remove the stack
* instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained
* stack, or add an existing, saved stack to a new stack set.
*/
public Boolean retainStacks() {
return retainStacks;
}
/**
*
* The Amazon Resource Number (ARN) of the IAM role used to perform this stack set operation.
*
*
* Use customized administrator roles to control which users or groups can manage specific stack sets within the
* same administrator account. For more information, see Define Permissions
* for Multiple Administrators in the AWS CloudFormation User Guide.
*
*
* @return The Amazon Resource Number (ARN) of the IAM role used to perform this stack set operation.
*
* Use customized administrator roles to control which users or groups can manage specific stack sets within
* the same administrator account. For more information, see Define
* Permissions for Multiple Administrators in the AWS CloudFormation User Guide.
*/
public String administrationRoleARN() {
return administrationRoleARN;
}
/**
*
* The name of the IAM execution role used to create or update the stack set.
*
*
* Use customized execution roles to control which stack resources users and groups can include in their stack sets.
*
*
* @return The name of the IAM execution role used to create or update the stack set.
*
* Use customized execution roles to control which stack resources users and groups can include in their
* stack sets.
*/
public String executionRoleName() {
return executionRoleName;
}
/**
*
* The time at which the operation was initiated. Note that the creation times for the stack set operation might
* differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to
* perform preparatory work for the operation, such as dispatching the work to the requested Regions, before
* actually creating the first stacks.
*
*
* @return The time at which the operation was initiated. Note that the creation times for the stack set operation
* might differ from the creation time of the individual stacks themselves. This is because AWS
* CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the
* requested Regions, before actually creating the first stacks.
*/
public Instant creationTimestamp() {
return creationTimestamp;
}
/**
*
* The time at which the stack set operation ended, across all accounts and Regions specified. Note that this
* doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or
* Region.
*
*
* @return The time at which the stack set operation ended, across all accounts and Regions specified. Note that
* this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each
* account or Region.
*/
public Instant endTimestamp() {
return endTimestamp;
}
/**
*
* [Service-managed permissions] The AWS Organizations accounts affected by the stack operation.
*
*
* @return [Service-managed permissions] The AWS Organizations accounts affected by the stack
* operation.
*/
public DeploymentTargets deploymentTargets() {
return deploymentTargets;
}
/**
*
* Detailed information about the drift status of the stack set. This includes information about drift operations
* currently being performed on the stack set.
*
*
* this information will only be present for stack set operations whose Action type is
* DETECT_DRIFT.
*
*
* For more information, see Detecting Unmanaged
* Changes in Stack Sets in the AWS CloudFormation User Guide.
*
*
* @return Detailed information about the drift status of the stack set. This includes information about drift
* operations currently being performed on the stack set.
*
* this information will only be present for stack set operations whose Action type is
* DETECT_DRIFT.
*
*
* For more information, see Detecting
* Unmanaged Changes in Stack Sets in the AWS CloudFormation User Guide.
*/
public StackSetDriftDetectionDetails stackSetDriftDetectionDetails() {
return stackSetDriftDetectionDetails;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(operationId());
hashCode = 31 * hashCode + Objects.hashCode(stackSetId());
hashCode = 31 * hashCode + Objects.hashCode(actionAsString());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(operationPreferences());
hashCode = 31 * hashCode + Objects.hashCode(retainStacks());
hashCode = 31 * hashCode + Objects.hashCode(administrationRoleARN());
hashCode = 31 * hashCode + Objects.hashCode(executionRoleName());
hashCode = 31 * hashCode + Objects.hashCode(creationTimestamp());
hashCode = 31 * hashCode + Objects.hashCode(endTimestamp());
hashCode = 31 * hashCode + Objects.hashCode(deploymentTargets());
hashCode = 31 * hashCode + Objects.hashCode(stackSetDriftDetectionDetails());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof StackSetOperation)) {
return false;
}
StackSetOperation other = (StackSetOperation) obj;
return Objects.equals(operationId(), other.operationId()) && Objects.equals(stackSetId(), other.stackSetId())
&& Objects.equals(actionAsString(), other.actionAsString())
&& Objects.equals(statusAsString(), other.statusAsString())
&& Objects.equals(operationPreferences(), other.operationPreferences())
&& Objects.equals(retainStacks(), other.retainStacks())
&& Objects.equals(administrationRoleARN(), other.administrationRoleARN())
&& Objects.equals(executionRoleName(), other.executionRoleName())
&& Objects.equals(creationTimestamp(), other.creationTimestamp())
&& Objects.equals(endTimestamp(), other.endTimestamp())
&& Objects.equals(deploymentTargets(), other.deploymentTargets())
&& Objects.equals(stackSetDriftDetectionDetails(), other.stackSetDriftDetectionDetails());
}
/**
* 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 String toString() {
return ToString.builder("StackSetOperation").add("OperationId", operationId()).add("StackSetId", stackSetId())
.add("Action", actionAsString()).add("Status", statusAsString())
.add("OperationPreferences", operationPreferences()).add("RetainStacks", retainStacks())
.add("AdministrationRoleARN", administrationRoleARN()).add("ExecutionRoleName", executionRoleName())
.add("CreationTimestamp", creationTimestamp()).add("EndTimestamp", endTimestamp())
.add("DeploymentTargets", deploymentTargets())
.add("StackSetDriftDetectionDetails", stackSetDriftDetectionDetails()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "OperationId":
return Optional.ofNullable(clazz.cast(operationId()));
case "StackSetId":
return Optional.ofNullable(clazz.cast(stackSetId()));
case "Action":
return Optional.ofNullable(clazz.cast(actionAsString()));
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "OperationPreferences":
return Optional.ofNullable(clazz.cast(operationPreferences()));
case "RetainStacks":
return Optional.ofNullable(clazz.cast(retainStacks()));
case "AdministrationRoleARN":
return Optional.ofNullable(clazz.cast(administrationRoleARN()));
case "ExecutionRoleName":
return Optional.ofNullable(clazz.cast(executionRoleName()));
case "CreationTimestamp":
return Optional.ofNullable(clazz.cast(creationTimestamp()));
case "EndTimestamp":
return Optional.ofNullable(clazz.cast(endTimestamp()));
case "DeploymentTargets":
return Optional.ofNullable(clazz.cast(deploymentTargets()));
case "StackSetDriftDetectionDetails":
return Optional.ofNullable(clazz.cast(stackSetDriftDetectionDetails()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((StackSetOperation) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The unique ID of a stack set operation.
*
*
* @param operationId
* The unique ID of a stack set operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder operationId(String operationId);
/**
*
* The ID of the stack set.
*
*
* @param stackSetId
* The ID of the stack set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stackSetId(String stackSetId);
/**
*
* The type of stack set operation: CREATE, UPDATE, or DELETE. Create and
* delete operations affect only the specified stack set instances that are associated with the specified stack
* set. Update operations affect both the stack set itself, as well as all associated stack set
* instances.
*
*
* @param action
* The type of stack set operation: CREATE, UPDATE, or DELETE.
* Create and delete operations affect only the specified stack set instances that are associated with
* the specified stack set. Update operations affect both the stack set itself, as well as all
* associated stack set instances.
* @see StackSetOperationAction
* @return Returns a reference to this object so that method calls can be chained together.
* @see StackSetOperationAction
*/
Builder action(String action);
/**
*
* The type of stack set operation: CREATE, UPDATE, or DELETE. Create and
* delete operations affect only the specified stack set instances that are associated with the specified stack
* set. Update operations affect both the stack set itself, as well as all associated stack set
* instances.
*
*
* @param action
* The type of stack set operation: CREATE, UPDATE, or DELETE.
* Create and delete operations affect only the specified stack set instances that are associated with
* the specified stack set. Update operations affect both the stack set itself, as well as all
* associated stack set instances.
* @see StackSetOperationAction
* @return Returns a reference to this object so that method calls can be chained together.
* @see StackSetOperationAction
*/
Builder action(StackSetOperationAction action);
/**
*
* The status of the operation.
*
*
* -
*
* FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that
* you've set for an operation is applied for each Region during stack create and update operations. If the
* number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the
* Region is set to FAILED. This in turn sets the status of the operation as a whole to
* FAILED, and AWS CloudFormation cancels the operation in any remaining Regions.
*
*
* -
*
* QUEUED: [Service-managed permissions] For automatic deployments that require a
* sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the AWS CloudFormation User Guide.
*
*
* -
*
* RUNNING: The operation is currently being performed.
*
*
* -
*
* STOPPED: The user has cancelled the operation.
*
*
* -
*
* STOPPING: The operation is in the process of stopping, at user request.
*
*
* -
*
* SUCCEEDED: The operation completed creating or updating all the specified stacks without
* exceeding the failure tolerance for the operation.
*
*
*
*
* @param status
* The status of the operation.
*
* -
*
* FAILED: The operation exceeded the specified failure tolerance. The failure tolerance
* value that you've set for an operation is applied for each Region during stack create and update
* operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status
* of the operation in the Region is set to FAILED. This in turn sets the status of the
* operation as a whole to FAILED, and AWS CloudFormation cancels the operation in any
* remaining Regions.
*
*
* -
*
* QUEUED: [Service-managed permissions] For automatic deployments that require
* a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the AWS CloudFormation User Guide.
*
*
* -
*
* RUNNING: The operation is currently being performed.
*
*
* -
*
* STOPPED: The user has cancelled the operation.
*
*
* -
*
* STOPPING: The operation is in the process of stopping, at user request.
*
*
* -
*
* SUCCEEDED: The operation completed creating or updating all the specified stacks without
* exceeding the failure tolerance for the operation.
*
*
* @see StackSetOperationStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see StackSetOperationStatus
*/
Builder status(String status);
/**
*
* The status of the operation.
*
*
* -
*
* FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that
* you've set for an operation is applied for each Region during stack create and update operations. If the
* number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the
* Region is set to FAILED. This in turn sets the status of the operation as a whole to
* FAILED, and AWS CloudFormation cancels the operation in any remaining Regions.
*
*
* -
*
* QUEUED: [Service-managed permissions] For automatic deployments that require a
* sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the AWS CloudFormation User Guide.
*
*
* -
*
* RUNNING: The operation is currently being performed.
*
*
* -
*
* STOPPED: The user has cancelled the operation.
*
*
* -
*
* STOPPING: The operation is in the process of stopping, at user request.
*
*
* -
*
* SUCCEEDED: The operation completed creating or updating all the specified stacks without
* exceeding the failure tolerance for the operation.
*
*
*
*
* @param status
* The status of the operation.
*
* -
*
* FAILED: The operation exceeded the specified failure tolerance. The failure tolerance
* value that you've set for an operation is applied for each Region during stack create and update
* operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status
* of the operation in the Region is set to FAILED. This in turn sets the status of the
* operation as a whole to FAILED, and AWS CloudFormation cancels the operation in any
* remaining Regions.
*
*
* -
*
* QUEUED: [Service-managed permissions] For automatic deployments that require
* a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the AWS CloudFormation User Guide.
*
*
* -
*
* RUNNING: The operation is currently being performed.
*
*
* -
*
* STOPPED: The user has cancelled the operation.
*
*
* -
*
* STOPPING: The operation is in the process of stopping, at user request.
*
*
* -
*
* SUCCEEDED: The operation completed creating or updating all the specified stacks without
* exceeding the failure tolerance for the operation.
*
*
* @see StackSetOperationStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see StackSetOperationStatus
*/
Builder status(StackSetOperationStatus status);
/**
*
* The preferences for how AWS CloudFormation performs this stack set operation.
*
*
* @param operationPreferences
* The preferences for how AWS CloudFormation performs this stack set operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder operationPreferences(StackSetOperationPreferences operationPreferences);
/**
*
* The preferences for how AWS CloudFormation performs this stack set operation.
*
* This is a convenience that creates an instance of the {@link StackSetOperationPreferences.Builder} avoiding
* the need to create one manually via {@link StackSetOperationPreferences#builder()}.
*
* When the {@link Consumer} completes, {@link StackSetOperationPreferences.Builder#build()} is called
* immediately and its result is passed to {@link #operationPreferences(StackSetOperationPreferences)}.
*
* @param operationPreferences
* a consumer that will call methods on {@link StackSetOperationPreferences.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #operationPreferences(StackSetOperationPreferences)
*/
default Builder operationPreferences(Consumer operationPreferences) {
return operationPreferences(StackSetOperationPreferences.builder().applyMutation(operationPreferences).build());
}
/**
*
* For stack set operations of action type DELETE, specifies whether to remove the stack instances
* from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack, or add
* an existing, saved stack to a new stack set.
*
*
* @param retainStacks
* For stack set operations of action type DELETE, specifies whether to remove the stack
* instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a
* retained stack, or add an existing, saved stack to a new stack set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder retainStacks(Boolean retainStacks);
/**
*
* The Amazon Resource Number (ARN) of the IAM role used to perform this stack set operation.
*
*
* Use customized administrator roles to control which users or groups can manage specific stack sets within the
* same administrator account. For more information, see Define
* Permissions for Multiple Administrators in the AWS CloudFormation User Guide.
*
*
* @param administrationRoleARN
* The Amazon Resource Number (ARN) of the IAM role used to perform this stack set operation.
*
* Use customized administrator roles to control which users or groups can manage specific stack sets
* within the same administrator account. For more information, see Define
* Permissions for Multiple Administrators in the AWS CloudFormation User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder administrationRoleARN(String administrationRoleARN);
/**
*
* The name of the IAM execution role used to create or update the stack set.
*
*
* Use customized execution roles to control which stack resources users and groups can include in their stack
* sets.
*
*
* @param executionRoleName
* The name of the IAM execution role used to create or update the stack set.
*
* Use customized execution roles to control which stack resources users and groups can include in their
* stack sets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder executionRoleName(String executionRoleName);
/**
*
* The time at which the operation was initiated. Note that the creation times for the stack set operation might
* differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs
* to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before
* actually creating the first stacks.
*
*
* @param creationTimestamp
* The time at which the operation was initiated. Note that the creation times for the stack set
* operation might differ from the creation time of the individual stacks themselves. This is because AWS
* CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to
* the requested Regions, before actually creating the first stacks.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationTimestamp(Instant creationTimestamp);
/**
*
* The time at which the stack set operation ended, across all accounts and Regions specified. Note that this
* doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or
* Region.
*
*
* @param endTimestamp
* The time at which the stack set operation ended, across all accounts and Regions specified. Note that
* this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each
* account or Region.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder endTimestamp(Instant endTimestamp);
/**
*
* [Service-managed permissions] The AWS Organizations accounts affected by the stack operation.
*
*
* @param deploymentTargets
* [Service-managed permissions] The AWS Organizations accounts affected by the stack
* operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deploymentTargets(DeploymentTargets deploymentTargets);
/**
*
* [Service-managed permissions] The AWS Organizations accounts affected by the stack operation.
*
* This is a convenience that creates an instance of the {@link DeploymentTargets.Builder} avoiding the need to
* create one manually via {@link DeploymentTargets#builder()}.
*
* When the {@link Consumer} completes, {@link DeploymentTargets.Builder#build()} is called immediately and its
* result is passed to {@link #deploymentTargets(DeploymentTargets)}.
*
* @param deploymentTargets
* a consumer that will call methods on {@link DeploymentTargets.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #deploymentTargets(DeploymentTargets)
*/
default Builder deploymentTargets(Consumer deploymentTargets) {
return deploymentTargets(DeploymentTargets.builder().applyMutation(deploymentTargets).build());
}
/**
*
* Detailed information about the drift status of the stack set. This includes information about drift
* operations currently being performed on the stack set.
*
*
* this information will only be present for stack set operations whose Action type is
* DETECT_DRIFT.
*
*
* For more information, see Detecting
* Unmanaged Changes in Stack Sets in the AWS CloudFormation User Guide.
*
*
* @param stackSetDriftDetectionDetails
* Detailed information about the drift status of the stack set. This includes information about drift
* operations currently being performed on the stack set.
*
* this information will only be present for stack set operations whose Action type is
* DETECT_DRIFT.
*
*
* For more information, see Detecting
* Unmanaged Changes in Stack Sets in the AWS CloudFormation User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stackSetDriftDetectionDetails(StackSetDriftDetectionDetails stackSetDriftDetectionDetails);
/**
*
* Detailed information about the drift status of the stack set. This includes information about drift
* operations currently being performed on the stack set.
*
*
* this information will only be present for stack set operations whose Action type is
* DETECT_DRIFT.
*
*
* For more information, see Detecting
* Unmanaged Changes in Stack Sets in the AWS CloudFormation User Guide.
*
* This is a convenience that creates an instance of the {@link StackSetDriftDetectionDetails.Builder} avoiding
* the need to create one manually via {@link StackSetDriftDetectionDetails#builder()}.
*
* When the {@link Consumer} completes, {@link StackSetDriftDetectionDetails.Builder#build()} is called
* immediately and its result is passed to {@link #stackSetDriftDetectionDetails(StackSetDriftDetectionDetails)}
* .
*
* @param stackSetDriftDetectionDetails
* a consumer that will call methods on {@link StackSetDriftDetectionDetails.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #stackSetDriftDetectionDetails(StackSetDriftDetectionDetails)
*/
default Builder stackSetDriftDetectionDetails(
Consumer stackSetDriftDetectionDetails) {
return stackSetDriftDetectionDetails(StackSetDriftDetectionDetails.builder()
.applyMutation(stackSetDriftDetectionDetails).build());
}
}
static final class BuilderImpl implements Builder {
private String operationId;
private String stackSetId;
private String action;
private String status;
private StackSetOperationPreferences operationPreferences;
private Boolean retainStacks;
private String administrationRoleARN;
private String executionRoleName;
private Instant creationTimestamp;
private Instant endTimestamp;
private DeploymentTargets deploymentTargets;
private StackSetDriftDetectionDetails stackSetDriftDetectionDetails;
private BuilderImpl() {
}
private BuilderImpl(StackSetOperation model) {
operationId(model.operationId);
stackSetId(model.stackSetId);
action(model.action);
status(model.status);
operationPreferences(model.operationPreferences);
retainStacks(model.retainStacks);
administrationRoleARN(model.administrationRoleARN);
executionRoleName(model.executionRoleName);
creationTimestamp(model.creationTimestamp);
endTimestamp(model.endTimestamp);
deploymentTargets(model.deploymentTargets);
stackSetDriftDetectionDetails(model.stackSetDriftDetectionDetails);
}
public final String getOperationId() {
return operationId;
}
@Override
public final Builder operationId(String operationId) {
this.operationId = operationId;
return this;
}
public final void setOperationId(String operationId) {
this.operationId = operationId;
}
public final String getStackSetId() {
return stackSetId;
}
@Override
public final Builder stackSetId(String stackSetId) {
this.stackSetId = stackSetId;
return this;
}
public final void setStackSetId(String stackSetId) {
this.stackSetId = stackSetId;
}
public final String getAction() {
return action;
}
@Override
public final Builder action(String action) {
this.action = action;
return this;
}
@Override
public final Builder action(StackSetOperationAction action) {
this.action(action == null ? null : action.toString());
return this;
}
public final void setAction(String action) {
this.action = action;
}
public final String getStatus() {
return status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(StackSetOperationStatus status) {
this.status(status == null ? null : status.toString());
return this;
}
public final void setStatus(String status) {
this.status = status;
}
public final StackSetOperationPreferences.Builder getOperationPreferences() {
return operationPreferences != null ? operationPreferences.toBuilder() : null;
}
@Override
public final Builder operationPreferences(StackSetOperationPreferences operationPreferences) {
this.operationPreferences = operationPreferences;
return this;
}
public final void setOperationPreferences(StackSetOperationPreferences.BuilderImpl operationPreferences) {
this.operationPreferences = operationPreferences != null ? operationPreferences.build() : null;
}
public final Boolean getRetainStacks() {
return retainStacks;
}
@Override
public final Builder retainStacks(Boolean retainStacks) {
this.retainStacks = retainStacks;
return this;
}
public final void setRetainStacks(Boolean retainStacks) {
this.retainStacks = retainStacks;
}
public final String getAdministrationRoleARN() {
return administrationRoleARN;
}
@Override
public final Builder administrationRoleARN(String administrationRoleARN) {
this.administrationRoleARN = administrationRoleARN;
return this;
}
public final void setAdministrationRoleARN(String administrationRoleARN) {
this.administrationRoleARN = administrationRoleARN;
}
public final String getExecutionRoleName() {
return executionRoleName;
}
@Override
public final Builder executionRoleName(String executionRoleName) {
this.executionRoleName = executionRoleName;
return this;
}
public final void setExecutionRoleName(String executionRoleName) {
this.executionRoleName = executionRoleName;
}
public final Instant getCreationTimestamp() {
return creationTimestamp;
}
@Override
public final Builder creationTimestamp(Instant creationTimestamp) {
this.creationTimestamp = creationTimestamp;
return this;
}
public final void setCreationTimestamp(Instant creationTimestamp) {
this.creationTimestamp = creationTimestamp;
}
public final Instant getEndTimestamp() {
return endTimestamp;
}
@Override
public final Builder endTimestamp(Instant endTimestamp) {
this.endTimestamp = endTimestamp;
return this;
}
public final void setEndTimestamp(Instant endTimestamp) {
this.endTimestamp = endTimestamp;
}
public final DeploymentTargets.Builder getDeploymentTargets() {
return deploymentTargets != null ? deploymentTargets.toBuilder() : null;
}
@Override
public final Builder deploymentTargets(DeploymentTargets deploymentTargets) {
this.deploymentTargets = deploymentTargets;
return this;
}
public final void setDeploymentTargets(DeploymentTargets.BuilderImpl deploymentTargets) {
this.deploymentTargets = deploymentTargets != null ? deploymentTargets.build() : null;
}
public final StackSetDriftDetectionDetails.Builder getStackSetDriftDetectionDetails() {
return stackSetDriftDetectionDetails != null ? stackSetDriftDetectionDetails.toBuilder() : null;
}
@Override
public final Builder stackSetDriftDetectionDetails(StackSetDriftDetectionDetails stackSetDriftDetectionDetails) {
this.stackSetDriftDetectionDetails = stackSetDriftDetectionDetails;
return this;
}
public final void setStackSetDriftDetectionDetails(StackSetDriftDetectionDetails.BuilderImpl stackSetDriftDetectionDetails) {
this.stackSetDriftDetectionDetails = stackSetDriftDetectionDetails != null ? stackSetDriftDetectionDetails.build()
: null;
}
@Override
public StackSetOperation build() {
return new StackSetOperation(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}