You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CloudFormation::Types::StackSetOperationSummary

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

Overview

The structures that contain summary information about the specified operation.

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack 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)


4253
4254
4255
4256
4257
4258
4259
4260
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4253

class StackSetOperationSummary < Struct.new(
  :operation_id,
  :action,
  :status,
  :creation_timestamp,
  :end_timestamp)
  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 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)


4253
4254
4255
4256
4257
4258
4259
4260
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4253

class StackSetOperationSummary < Struct.new(
  :operation_id,
  :action,
  :status,
  :creation_timestamp,
  :end_timestamp)
  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)


4253
4254
4255
4256
4257
4258
4259
4260
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4253

class StackSetOperationSummary < Struct.new(
  :operation_id,
  :action,
  :status,
  :creation_timestamp,
  :end_timestamp)
  include Aws::Structure
end

#operation_idString

The unique ID of the stack set operation.

Returns:

  • (String)


4253
4254
4255
4256
4257
4258
4259
4260
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4253

class StackSetOperationSummary < Struct.new(
  :operation_id,
  :action,
  :status,
  :creation_timestamp,
  :end_timestamp)
  include Aws::Structure
end

#statusString

The overall 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)


4253
4254
4255
4256
4257
4258
4259
4260
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4253

class StackSetOperationSummary < Struct.new(
  :operation_id,
  :action,
  :status,
  :creation_timestamp,
  :end_timestamp)
  include Aws::Structure
end