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

Inherits:

Struct

Object
Struct
Aws::CloudFormation::Types::StackSetOperation

show all

Includes:: Structure

Defined in:: lib/aws-sdk-cloudformation/types.rb

Overview

The structure that contains information about a StackSet operation.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#action ⇒ String

The type of StackSet operation: ‘CREATE`, `UPDATE`, or `DELETE`.
#administration_role_arn ⇒ String

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

The time at which the operation was initiated.
#deployment_targets ⇒ Types::DeploymentTargets

The Organizations accounts affected by the stack operation.
#end_timestamp ⇒ Time

The time at which the StackSet 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 StackSet.
#operation_id ⇒ String

The unique ID of a StackSet operation.
#operation_preferences ⇒ Types::StackSetOperationPreferences

The preferences for how CloudFormation performs this StackSet operation.
#retain_stacks ⇒ Boolean

For StackSet operations of action type ‘DELETE`, specifies whether to remove the stack instances from the specified StackSet, but doesn’t delete the stacks.
#stack_set_drift_detection_details ⇒ Types::StackSetDriftDetectionDetails

Detailed information about the drift status of the StackSet.
#stack_set_id ⇒ String

The ID of the StackSet.
#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 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:

(String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10471

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

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

Returns:

(String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10471

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.

Returns:

(Time)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10471

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`

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

Returns:

(Types::DeploymentTargets)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10471

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 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:

(Time)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10471

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

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

Returns:

(String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10471

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 StackSet operation.

Returns:

(String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10471

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 StackSet operation.

Returns:

(Types::StackSetOperationPreferences)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10471

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 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:

(Boolean)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10471

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

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

Returns:

(Types::StackSetDriftDetectionDetails)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10471

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

Returns:

(String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10471

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 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][1

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.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes

Returns:

(String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10471

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.

Returns:

(Types::StackSetOperationStatusDetails)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10471

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.

Returns:

(String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 10471

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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ String

#administration_role_arn ⇒ String

#creation_timestamp ⇒ Time

#deployment_targets ⇒ Types::DeploymentTargets

#end_timestamp ⇒ Time

#execution_role_name ⇒ String

#operation_id ⇒ String

#operation_preferences ⇒ Types::StackSetOperationPreferences

#retain_stacks ⇒ Boolean

#stack_set_drift_detection_details ⇒ Types::StackSetDriftDetectionDetails

#stack_set_id ⇒ String

#status ⇒ String

#status_details ⇒ Types::StackSetOperationStatusDetails

#status_reason ⇒ String

#action ⇒ `String`

#administration_role_arn ⇒ `String`

#creation_timestamp ⇒ `Time`

#deployment_targets ⇒ `Types::DeploymentTargets`

#end_timestamp ⇒ `Time`

#execution_role_name ⇒ `String`

#operation_id ⇒ `String`

#operation_preferences ⇒ `Types::StackSetOperationPreferences`

#retain_stacks ⇒ `Boolean`

#stack_set_drift_detection_details ⇒ `Types::StackSetDriftDetectionDetails`

#stack_set_id ⇒ `String`

#status ⇒ `String`

#status_details ⇒ `Types::StackSetOperationStatusDetails`

#status_reason ⇒ `String`