Class: Aws::CloudFormation::Types::StackSetOperation
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudFormation::Types::StackSetOperation
- Defined in:
- gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb
Overview
The structure that contains information about a stack set operation.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#action ⇒ String
The type of stack set operation:
CREATE
,UPDATE
, orDELETE
. -
#administration_role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role used to perform this stack set operation.
-
#creation_timestamp ⇒ Time
The time at which the operation was initiated.
-
#deployment_targets ⇒ Types::DeploymentTargets
[Service-managed permissions] The Organizations accounts affected by the stack operation.
-
#end_timestamp ⇒ Time
The time at which the stack set operation ended, across all accounts and Regions specified.
-
#execution_role_name ⇒ String
The name of the IAM execution role used to create or update the stack set.
-
#operation_id ⇒ String
The unique ID of a stack set operation.
-
#operation_preferences ⇒ Types::StackSetOperationPreferences
The preferences for how CloudFormation performs this stack set operation.
-
#retain_stacks ⇒ Boolean
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. -
#stack_set_drift_detection_details ⇒ Types::StackSetDriftDetectionDetails
Detailed information about the drift status of the stack set.
-
#stack_set_id ⇒ String
The ID of the stack set.
-
#status ⇒ String
The status of the operation.
-
#status_details ⇒ Types::StackSetOperationStatusDetails
Detailed information about the StackSet operation.
-
#status_reason ⇒ String
The status of the operation in details.
Instance Attribute Details
#action ⇒ String
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.
9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 9250 class StackSetOperation < Struct.new( :operation_id, :stack_set_id, :action, :status, :operation_preferences, :retain_stacks, :administration_role_arn, :execution_role_name, :creation_timestamp, :end_timestamp, :deployment_targets, :stack_set_drift_detection_details, :status_reason, :status_details) SENSITIVE = [] include Aws::Structure end |
#administration_role_arn ⇒ String
The Amazon Resource Name (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.
9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 9250 class StackSetOperation < Struct.new( :operation_id, :stack_set_id, :action, :status, :operation_preferences, :retain_stacks, :administration_role_arn, :execution_role_name, :creation_timestamp, :end_timestamp, :deployment_targets, :stack_set_drift_detection_details, :status_reason, :status_details) SENSITIVE = [] include Aws::Structure end |
#creation_timestamp ⇒ Time
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.
9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 9250 class StackSetOperation < Struct.new( :operation_id, :stack_set_id, :action, :status, :operation_preferences, :retain_stacks, :administration_role_arn, :execution_role_name, :creation_timestamp, :end_timestamp, :deployment_targets, :stack_set_drift_detection_details, :status_reason, :status_details) SENSITIVE = [] include Aws::Structure end |
#deployment_targets ⇒ Types::DeploymentTargets
[Service-managed permissions] The Organizations accounts affected by the stack operation.
9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 9250 class StackSetOperation < Struct.new( :operation_id, :stack_set_id, :action, :status, :operation_preferences, :retain_stacks, :administration_role_arn, :execution_role_name, :creation_timestamp, :end_timestamp, :deployment_targets, :stack_set_drift_detection_details, :status_reason, :status_details) SENSITIVE = [] include Aws::Structure end |
#end_timestamp ⇒ Time
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.
9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 9250 class StackSetOperation < Struct.new( :operation_id, :stack_set_id, :action, :status, :operation_preferences, :retain_stacks, :administration_role_arn, :execution_role_name, :creation_timestamp, :end_timestamp, :deployment_targets, :stack_set_drift_detection_details, :status_reason, :status_details) SENSITIVE = [] include Aws::Structure end |
#execution_role_name ⇒ String
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.
9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 9250 class StackSetOperation < Struct.new( :operation_id, :stack_set_id, :action, :status, :operation_preferences, :retain_stacks, :administration_role_arn, :execution_role_name, :creation_timestamp, :end_timestamp, :deployment_targets, :stack_set_drift_detection_details, :status_reason, :status_details) SENSITIVE = [] include Aws::Structure end |
#operation_id ⇒ String
The unique ID of a stack set operation.
9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 9250 class StackSetOperation < Struct.new( :operation_id, :stack_set_id, :action, :status, :operation_preferences, :retain_stacks, :administration_role_arn, :execution_role_name, :creation_timestamp, :end_timestamp, :deployment_targets, :stack_set_drift_detection_details, :status_reason, :status_details) SENSITIVE = [] include Aws::Structure end |
#operation_preferences ⇒ Types::StackSetOperationPreferences
The preferences for how CloudFormation performs this stack set operation.
9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 9250 class StackSetOperation < Struct.new( :operation_id, :stack_set_id, :action, :status, :operation_preferences, :retain_stacks, :administration_role_arn, :execution_role_name, :creation_timestamp, :end_timestamp, :deployment_targets, :stack_set_drift_detection_details, :status_reason, :status_details) SENSITIVE = [] include Aws::Structure end |
#retain_stacks ⇒ Boolean
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.
9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 9250 class StackSetOperation < Struct.new( :operation_id, :stack_set_id, :action, :status, :operation_preferences, :retain_stacks, :administration_role_arn, :execution_role_name, :creation_timestamp, :end_timestamp, :deployment_targets, :stack_set_drift_detection_details, :status_reason, :status_details) SENSITIVE = [] include Aws::Structure end |
#stack_set_drift_detection_details ⇒ Types::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.
9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 9250 class StackSetOperation < Struct.new( :operation_id, :stack_set_id, :action, :status, :operation_preferences, :retain_stacks, :administration_role_arn, :execution_role_name, :creation_timestamp, :end_timestamp, :deployment_targets, :stack_set_drift_detection_details, :status_reason, :status_details) SENSITIVE = [] include Aws::Structure end |
#stack_set_id ⇒ String
The ID of the stack set.
9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 9250 class StackSetOperation < Struct.new( :operation_id, :stack_set_id, :action, :status, :operation_preferences, :retain_stacks, :administration_role_arn, :execution_role_name, :creation_timestamp, :end_timestamp, :deployment_targets, :stack_set_drift_detection_details, :status_reason, :status_details) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
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 toFAILED
. This in turn sets the status of the operation as a whole toFAILED
, 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.
9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 9250 class StackSetOperation < Struct.new( :operation_id, :stack_set_id, :action, :status, :operation_preferences, :retain_stacks, :administration_role_arn, :execution_role_name, :creation_timestamp, :end_timestamp, :deployment_targets, :stack_set_drift_detection_details, :status_reason, :status_details) SENSITIVE = [] include Aws::Structure end |
#status_details ⇒ Types::StackSetOperationStatusDetails
Detailed information about the StackSet operation.
9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 9250 class StackSetOperation < Struct.new( :operation_id, :stack_set_id, :action, :status, :operation_preferences, :retain_stacks, :administration_role_arn, :execution_role_name, :creation_timestamp, :end_timestamp, :deployment_targets, :stack_set_drift_detection_details, :status_reason, :status_details) SENSITIVE = [] include Aws::Structure end |
#status_reason ⇒ String
The status of the operation in details.
9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 9250 class StackSetOperation < Struct.new( :operation_id, :stack_set_id, :action, :status, :operation_preferences, :retain_stacks, :administration_role_arn, :execution_role_name, :creation_timestamp, :end_timestamp, :deployment_targets, :stack_set_drift_detection_details, :status_reason, :status_details) SENSITIVE = [] include Aws::Structure end |