« blib/lib/Paws/CloudFormation/StackSetOperationResultSummary.pm
↑ Summary
blib/lib/Paws/CloudFormation/StackSetSummary.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFormation::StackSetOperationSummary; | ||
| 3 | use Moose; | ||
| 4 | has Action => (is => 'ro', isa => 'Str'); | ||
| 5 | has CreationTimestamp => (is => 'ro', isa => 'Str'); | ||
| 6 | has EndTimestamp => (is => 'ro', isa => 'Str'); | ||
| 7 | has OperationId => (is => 'ro', isa => 'Str'); | ||
| 8 | has Status => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::CloudFormation::StackSetOperationSummary | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::CloudFormation::StackSetOperationSummary object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { Action => $value, ..., Status => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFormation::StackSetOperationSummary object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->Action | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | The structures that contain summary information about the specified | ||
| 41 | operation. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 Action => Str | ||
| 47 | |||
| 48 | The type of operation: C<CREATE>, C<UPDATE>, or C<DELETE>. Create and | ||
| 49 | delete operations affect only the specified stack instances that are | ||
| 50 | associated with the specified stack set. Update operations affect both | ||
| 51 | the stack set itself as well as I<all> associated stack set instances. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 CreationTimestamp => Str | ||
| 55 | |||
| 56 | The time at which the operation was initiated. Note that the creation | ||
| 57 | times for the stack set operation might differ from the creation time | ||
| 58 | of the individual stacks themselves. This is because AWS CloudFormation | ||
| 59 | needs to perform preparatory work for the operation, such as | ||
| 60 | dispatching the work to the requested Regions, before actually creating | ||
| 61 | the first stacks. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 EndTimestamp => Str | ||
| 65 | |||
| 66 | The time at which the stack set operation ended, across all accounts | ||
| 67 | and Regions specified. Note that this doesn't necessarily mean that the | ||
| 68 | stack set operation was successful, or even attempted, in each account | ||
| 69 | or Region. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 OperationId => Str | ||
| 73 | |||
| 74 | The unique ID of the stack set operation. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 Status => Str | ||
| 78 | |||
| 79 | The overall status of the operation. | ||
| 80 | |||
| 81 | =over | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | C<FAILED>: The operation exceeded the specified failure tolerance. The | ||
| 86 | failure tolerance value that you've set for an operation is applied for | ||
| 87 | each Region during stack create and update operations. If the number of | ||
| 88 | failed stacks within a Region exceeds the failure tolerance, the status | ||
| 89 | of the operation in the Region is set to C<FAILED>. This in turn sets | ||
| 90 | the status of the operation as a whole to C<FAILED>, and AWS | ||
| 91 | CloudFormation cancels the operation in any remaining Regions. | ||
| 92 | |||
| 93 | =item * | ||
| 94 | |||
| 95 | C<QUEUED>: [Service-managed permissions] For automatic deployments that | ||
| 96 | require a sequence of operations, the operation is queued to be | ||
| 97 | performed. For more information, see the stack set operation status | ||
| 98 | codes | ||
| 99 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes) | ||
| 100 | in the AWS CloudFormation User Guide. | ||
| 101 | |||
| 102 | =item * | ||
| 103 | |||
| 104 | C<RUNNING>: The operation is currently being performed. | ||
| 105 | |||
| 106 | =item * | ||
| 107 | |||
| 108 | C<STOPPED>: The user has cancelled the operation. | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | C<STOPPING>: The operation is in the process of stopping, at user | ||
| 113 | request. | ||
| 114 | |||
| 115 | =item * | ||
| 116 | |||
| 117 | C<SUCCEEDED>: The operation completed creating or updating all the | ||
| 118 | specified stacks without exceeding the failure tolerance for the | ||
| 119 | operation. | ||
| 120 | |||
| 121 | =back | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head1 SEE ALSO | ||
| 127 | |||
| 128 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFormation> | ||
| 129 | |||
| 130 | =head1 BUGS and CONTRIBUTIONS | ||
| 131 | |||
| 132 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 133 | |||
| 134 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 135 | |||
| 136 | =cut | ||
| 137 |