public static interface StackSetOperation.Builder extends SdkPojo, CopyableBuilder<StackSetOperation.Builder,StackSetOperation>
| Modifier and Type | Method and Description |
|---|---|
StackSetOperation.Builder |
action(StackSetOperationAction action)
The type of stack set operation:
CREATE, UPDATE, or DELETE. |
StackSetOperation.Builder |
action(String action)
The type of stack set operation:
CREATE, UPDATE, or DELETE. |
StackSetOperation.Builder |
administrationRoleARN(String administrationRoleARN)
The Amazon Resource Number (ARN) of the IAM role used to perform this stack set operation.
|
StackSetOperation.Builder |
creationTimestamp(Instant creationTimestamp)
The time at which the operation was initiated.
|
default StackSetOperation.Builder |
deploymentTargets(Consumer<DeploymentTargets.Builder> deploymentTargets)
[Service-managed permissions] The Organizations accounts affected by the stack operation.
|
StackSetOperation.Builder |
deploymentTargets(DeploymentTargets deploymentTargets)
[Service-managed permissions] The Organizations accounts affected by the stack operation.
|
StackSetOperation.Builder |
endTimestamp(Instant endTimestamp)
The time at which the stack set operation ended, across all accounts and Regions specified.
|
StackSetOperation.Builder |
executionRoleName(String executionRoleName)
The name of the IAM execution role used to create or update the stack set.
|
StackSetOperation.Builder |
operationId(String operationId)
The unique ID of a stack set operation.
|
default StackSetOperation.Builder |
operationPreferences(Consumer<StackSetOperationPreferences.Builder> operationPreferences)
The preferences for how CloudFormation performs this stack set operation.
|
StackSetOperation.Builder |
operationPreferences(StackSetOperationPreferences operationPreferences)
The preferences for how CloudFormation performs this stack set operation.
|
StackSetOperation.Builder |
retainStacks(Boolean 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. |
default StackSetOperation.Builder |
stackSetDriftDetectionDetails(Consumer<StackSetDriftDetectionDetails.Builder> stackSetDriftDetectionDetails)
Detailed information about the drift status of the stack set.
|
StackSetOperation.Builder |
stackSetDriftDetectionDetails(StackSetDriftDetectionDetails stackSetDriftDetectionDetails)
Detailed information about the drift status of the stack set.
|
StackSetOperation.Builder |
stackSetId(String stackSetId)
The ID of the stack set.
|
StackSetOperation.Builder |
status(StackSetOperationStatus status)
The status of the operation.
|
StackSetOperation.Builder |
status(String status)
The status of the operation.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildStackSetOperation.Builder operationId(String operationId)
The unique ID of a stack set operation.
operationId - The unique ID of a stack set operation.StackSetOperation.Builder stackSetId(String stackSetId)
The ID of the stack set.
stackSetId - The ID of the stack set.StackSetOperation.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, in addition to all associated stack set
instances.
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, in addition to all
associated stack set instances.StackSetOperationAction,
StackSetOperationActionStackSetOperation.Builder action(StackSetOperationAction 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, in addition to all associated stack set
instances.
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, in addition to all
associated stack set instances.StackSetOperationAction,
StackSetOperationActionStackSetOperation.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 stack set operation 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.
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 stack set operation 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.
StackSetOperationStatus,
StackSetOperationStatusStackSetOperation.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 stack set operation 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.
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 stack set operation 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.
StackSetOperationStatus,
StackSetOperationStatusStackSetOperation.Builder operationPreferences(StackSetOperationPreferences operationPreferences)
The preferences for how CloudFormation performs this stack set operation.
operationPreferences - The preferences for how CloudFormation performs this stack set operation.default StackSetOperation.Builder operationPreferences(Consumer<StackSetOperationPreferences.Builder> operationPreferences)
The preferences for how CloudFormation performs this stack set operation.
This is a convenience that creates an instance of theStackSetOperationPreferences.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).operationPreferences - a consumer that will call methods on StackSetOperationPreferences.BuilderoperationPreferences(StackSetOperationPreferences)StackSetOperation.Builder retainStacks(Boolean 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 re-associate a retained stack, or add
an existing, saved stack to a new stack set.
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 re-associate a
retained stack, or add an existing, saved stack to a new stack set.StackSetOperation.Builder administrationRoleARN(String 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 CloudFormation User Guide.
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 CloudFormation User Guide.
StackSetOperation.Builder executionRoleName(String 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.
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.
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.
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.StackSetOperation.Builder endTimestamp(Instant 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.
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.StackSetOperation.Builder deploymentTargets(DeploymentTargets deploymentTargets)
[Service-managed permissions] The Organizations accounts affected by the stack operation.
deploymentTargets - [Service-managed permissions] The Organizations accounts affected by the stack operation.default StackSetOperation.Builder deploymentTargets(Consumer<DeploymentTargets.Builder> deploymentTargets)
[Service-managed permissions] The Organizations accounts affected by the stack operation.
This is a convenience that creates an instance of theDeploymentTargets.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).deploymentTargets - a consumer that will call methods on DeploymentTargets.BuilderdeploymentTargets(DeploymentTargets)StackSetOperation.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 CloudFormation User Guide.
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 CloudFormation User Guide.
default StackSetOperation.Builder stackSetDriftDetectionDetails(Consumer<StackSetDriftDetectionDetails.Builder> 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 CloudFormation User Guide.
This is a convenience that creates an instance of theStackSetDriftDetectionDetails.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)
.stackSetDriftDetectionDetails - a consumer that will call methods on StackSetDriftDetectionDetails.BuilderstackSetDriftDetectionDetails(StackSetDriftDetectionDetails)Copyright © 2022. All rights reserved.