Interface StackSetOperation.Builder

All Superinterfaces:
Buildable, CopyableBuilder<StackSetOperation.Builder,StackSetOperation>, SdkBuilder<StackSetOperation.Builder,StackSetOperation>, SdkPojo
Enclosing class:
StackSetOperation
@Mutable @NotThreadSafe public static interface StackSetOperation.Builder extends SdkPojo, CopyableBuilder<StackSetOperation.Builder,StackSetOperation>

  • Method Details

    • operationId

      StackSetOperation.Builder operationId(String operationId)

      The unique ID of a StackSet operation.

      Parameters:
      operationId - The unique ID of a StackSet operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stackSetId

      StackSetOperation.Builder stackSetId(String stackSetId)

      The ID of the StackSet.

      Parameters:
      stackSetId - The ID of the StackSet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • action

      StackSetOperation.Builder action(String action)

      The type of StackSet operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified StackSet. Update operations affect both the StackSet itself, in addition to all associated stack instances.

      Parameters:
      action - The type of StackSet operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified StackSet. Update operations affect both the StackSet itself, in addition to all associated stack instances.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • action

      StackSetOperation.Builder action(StackSetOperationAction action)

      The type of StackSet operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified StackSet. Update operations affect both the StackSet itself, in addition to all associated stack instances.

      Parameters:
      action - The type of StackSet operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified StackSet. Update operations affect both the StackSet itself, in addition to all associated stack instances.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      StackSetOperation.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 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 StackSets status codes in the CloudFormation User Guide.

      • RUNNING: The operation is currently being performed.

      • STOPPED: The user has canceled 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.

      Parameters:
      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 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 StackSets status codes in the CloudFormation User Guide.

      • RUNNING: The operation is currently being performed.

      • STOPPED: The user has canceled 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      StackSetOperation.Builder status(StackSetOperationStatus 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 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 StackSets status codes in the CloudFormation User Guide.

      • RUNNING: The operation is currently being performed.

      • STOPPED: The user has canceled 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.

      Parameters:
      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 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 StackSets status codes in the CloudFormation User Guide.

      • RUNNING: The operation is currently being performed.

      • STOPPED: The user has canceled 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • operationPreferences

      StackSetOperation.Builder operationPreferences(StackSetOperationPreferences operationPreferences)

      The preferences for how CloudFormation performs this StackSet operation.

      Parameters:
      operationPreferences - The preferences for how CloudFormation performs this StackSet operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • operationPreferences

      default StackSetOperation.Builder operationPreferences(Consumer<StackSetOperationPreferences.Builder> operationPreferences)

      The preferences for how CloudFormation performs this StackSet operation.

      This is a convenience method that creates an instance of the StackSetOperationPreferences.Builder avoiding the need to create one manually via StackSetOperationPreferences.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to operationPreferences(StackSetOperationPreferences).

      Parameters:
      operationPreferences - a consumer that will call methods on StackSetOperationPreferences.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • retainStacks

      StackSetOperation.Builder retainStacks(Boolean retainStacks)

      For StackSet operations of action type DELETE, specifies whether to remove the stack instances from the specified StackSet, but doesn't delete the stacks. You can't re-associate a retained stack, or add an existing, saved stack to a new StackSet.

      Parameters:
      retainStacks - For StackSet operations of action type DELETE, specifies whether to remove the stack instances from the specified StackSet, but doesn't delete the stacks. You can't re-associate a retained stack, or add an existing, saved stack to a new StackSet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • administrationRoleARN

      StackSetOperation.Builder administrationRoleARN(String administrationRoleARN)

      The Amazon Resource Name (ARN) of the IAM role used to perform this StackSet operation.

      Use customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see Grant self-managed permissions in the CloudFormation User Guide.

      Parameters:
      administrationRoleARN - The Amazon Resource Name (ARN) of the IAM role used to perform this StackSet operation.

      Use customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see Grant self-managed permissions in the CloudFormation User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionRoleName

      StackSetOperation.Builder executionRoleName(String executionRoleName)

      The name of the IAM execution role used to create or update the StackSet.

      Use customized execution roles to control which stack resources users and groups can include in their StackSets.

      Parameters:
      executionRoleName - The name of the IAM execution role used to create or update the StackSet.

      Use customized execution roles to control which stack resources users and groups can include in their StackSets.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationTimestamp

      StackSetOperation.Builder creationTimestamp(Instant 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 CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.

      Parameters:
      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 CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTimestamp

      StackSetOperation.Builder endTimestamp(Instant endTimestamp)

      The time at which the StackSet operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the StackSet operation was successful, or even attempted, in each account or Region.

      Parameters:
      endTimestamp - The time at which the StackSet operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the StackSet operation was successful, or even attempted, in each account or Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deploymentTargets

      StackSetOperation.Builder deploymentTargets(DeploymentTargets deploymentTargets)

      The Organizations accounts affected by the stack operation. Valid only if the StackSet uses service-managed permissions.

      Parameters:
      deploymentTargets - The Organizations accounts affected by the stack operation. Valid only if the StackSet uses service-managed permissions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deploymentTargets

      default StackSetOperation.Builder deploymentTargets(Consumer<DeploymentTargets.Builder> deploymentTargets)

      The Organizations accounts affected by the stack operation. Valid only if the StackSet uses service-managed permissions.

      This is a convenience method that creates an instance of the DeploymentTargets.Builder avoiding the need to create one manually via DeploymentTargets.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deploymentTargets(DeploymentTargets).

      Parameters:
      deploymentTargets - a consumer that will call methods on DeploymentTargets.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • stackSetDriftDetectionDetails

      StackSetOperation.Builder stackSetDriftDetectionDetails(StackSetDriftDetectionDetails stackSetDriftDetectionDetails)

      Detailed information about the drift status of the StackSet. This includes information about drift operations currently being performed on the StackSet.

      This information will only be present for StackSet operations whose Action type is DETECT_DRIFT.

      For more information, see Performing drift detection on CloudFormation StackSets in the CloudFormation User Guide.

      Parameters:
      stackSetDriftDetectionDetails - Detailed information about the drift status of the StackSet. This includes information about drift operations currently being performed on the StackSet.

      This information will only be present for StackSet operations whose Action type is DETECT_DRIFT.

      For more information, see Performing drift detection on CloudFormation StackSets in the CloudFormation User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stackSetDriftDetectionDetails

      default StackSetOperation.Builder stackSetDriftDetectionDetails(Consumer<StackSetDriftDetectionDetails.Builder> stackSetDriftDetectionDetails)

      Detailed information about the drift status of the StackSet. This includes information about drift operations currently being performed on the StackSet.

      This information will only be present for StackSet operations whose Action type is DETECT_DRIFT.

      For more information, see Performing drift detection on CloudFormation StackSets in the CloudFormation User Guide.

      This is a convenience method that creates an instance of the StackSetDriftDetectionDetails.Builder avoiding the need to create one manually via StackSetDriftDetectionDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to stackSetDriftDetectionDetails(StackSetDriftDetectionDetails).

      Parameters:
      stackSetDriftDetectionDetails - a consumer that will call methods on StackSetDriftDetectionDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusReason

      StackSetOperation.Builder statusReason(String statusReason)

      The status of the operation in details.

      Parameters:
      statusReason - The status of the operation in details.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statusDetails

      StackSetOperation.Builder statusDetails(StackSetOperationStatusDetails statusDetails)

      Detailed information about the StackSet operation.

      Parameters:
      statusDetails - Detailed information about the StackSet operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statusDetails

      default StackSetOperation.Builder statusDetails(Consumer<StackSetOperationStatusDetails.Builder> statusDetails)

      Detailed information about the StackSet operation.

      This is a convenience method that creates an instance of the StackSetOperationStatusDetails.Builder avoiding the need to create one manually via StackSetOperationStatusDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to statusDetails(StackSetOperationStatusDetails).

      Parameters:
      statusDetails - a consumer that will call methods on StackSetOperationStatusDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: