NAME

Paws::CloudFormation::StackSetOperation

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::CloudFormation::StackSetOperation object:

  $service_obj->Method(Att1 => { Action => $value, ..., Status => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFormation::StackSetOperation object:

  $result = $service_obj->Method(...);
  $result->Att1->Action

DESCRIPTION

The structure that contains information about a stack set operation.

ATTRIBUTES

Action => Str

  The type of stack set operation: C<CREATE>, C<UPDATE>, or C<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 I<all>
associated stack set instances.

AdministrationRoleARN => Str

  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 (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) in the AWS CloudFormation User Guide.

CreationTimestamp => Str

  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.

EndTimestamp => Str

  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.

ExecutionRoleName => Str

  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.

OperationId => Str

  The unique ID of a stack set operation.

OperationPreferences => Paws::CloudFormation::StackSetOperationPreferences

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

RetainStacks => Bool

  For stack set operations of action type C<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.

StackSetId => Str

  The ID of the stack set.

Status => Str

  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.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::CloudFormation

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues