Class: Aws::CloudFormation::Types::StackSetOperation

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudformation/types.rb

Overview

The structure that contains information about a stack set operation.

See Also:

Instance Attribute Summary collapse

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, as well as all associated stack set instances.

Returns:

  • (String) 


6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 6105

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,
  :stack_set_drift_detection_details)
  include Aws::Structure
end

#administration_role_arn ⇒ String

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*.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html

Returns:

  • (String) 


6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 6105

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,
  :stack_set_drift_detection_details)
  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 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.

Returns:

  • (Time) 


6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 6105

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,
  :stack_set_drift_detection_details)
  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.

Returns:

  • (Time) 


6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 6105

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,
  :stack_set_drift_detection_details)
  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.

Returns:

  • (String) 


6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 6105

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,
  :stack_set_drift_detection_details)
  include Aws::Structure
end

#operation_id ⇒ String

The unique ID of a stack set operation.

Returns:

  • (String) 


6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 6105

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,
  :stack_set_drift_detection_details)
  include Aws::Structure
end

#operation_preferences ⇒ Types::StackSetOperationPreferences

The preferences for how AWS CloudFormation performs this stack set operation.

Returns:



6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 6105

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,
  :stack_set_drift_detection_details)
  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 reassociate a retained stack, or add an existing, saved stack to a new stack set.

Returns:

  • (Boolean) 


6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 6105

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,
  :stack_set_drift_detection_details)
  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 AWS CloudFormation User Guide.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html

Returns:



6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 6105

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,
  :stack_set_drift_detection_details)
  include Aws::Structure
end

#stack_set_id ⇒ String

The ID of the stack set.

Returns:

  • (String) 


6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 6105

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,
  :stack_set_drift_detection_details)
  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 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.

  • ‘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.

Returns:

  • (String) 


6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 6105

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,
  :stack_set_drift_detection_details)
  include Aws::Structure
end