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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

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.

Returns:

  • (String)


9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
# File 'lib/aws-sdk-cloudformation/types.rb', line 9312

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_arnString

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

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

Returns:

  • (String)


9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
# File 'lib/aws-sdk-cloudformation/types.rb', line 9312

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_timestampTime

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)


9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
# File 'lib/aws-sdk-cloudformation/types.rb', line 9312

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

[Service-managed permissions] The Organizations accounts affected by the stack operation.



9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
# File 'lib/aws-sdk-cloudformation/types.rb', line 9312

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_timestampTime

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)


9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
# File 'lib/aws-sdk-cloudformation/types.rb', line 9312

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_nameString

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)


9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
# File 'lib/aws-sdk-cloudformation/types.rb', line 9312

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_idString

The unique ID of a stack set operation.

Returns:

  • (String)


9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
# File 'lib/aws-sdk-cloudformation/types.rb', line 9312

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

The preferences for how CloudFormation performs this stack set operation.



9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
# File 'lib/aws-sdk-cloudformation/types.rb', line 9312

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_stacksBoolean

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.

Returns:

  • (Boolean)


9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
# File 'lib/aws-sdk-cloudformation/types.rb', line 9312

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_detailsTypes::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 [Detect stack set drift] in the *CloudFormation User Guide*.

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



9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
# File 'lib/aws-sdk-cloudformation/types.rb', line 9312

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_idString

The ID of the stack set.

Returns:

  • (String)


9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
# File 'lib/aws-sdk-cloudformation/types.rb', line 9312

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

#statusString

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.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html#stackset-status-codes

Returns:

  • (String)


9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
# File 'lib/aws-sdk-cloudformation/types.rb', line 9312

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

Detailed information about the StackSet operation.



9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
# File 'lib/aws-sdk-cloudformation/types.rb', line 9312

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_reasonString

The status of the operation in details.

Returns:

  • (String)


9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
# File 'lib/aws-sdk-cloudformation/types.rb', line 9312

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