« blib/lib/Paws/CloudFormation/StackSetDriftDetectionDetails.pm
↑ Summary
blib/lib/Paws/CloudFormation/StackSetOperationPreferences.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFormation::StackSetOperation; | ||
| 3 | use Moose; | ||
| 4 | has Action => (is => 'ro', isa => 'Str'); | ||
| 5 | has AdministrationRoleARN => (is => 'ro', isa => 'Str'); | ||
| 6 | has CreationTimestamp => (is => 'ro', isa => 'Str'); | ||
| 7 | has DeploymentTargets => (is => 'ro', isa => 'Paws::CloudFormation::DeploymentTargets'); | ||
| 8 | has EndTimestamp => (is => 'ro', isa => 'Str'); | ||
| 9 | has ExecutionRoleName => (is => 'ro', isa => 'Str'); | ||
| 10 | has OperationId => (is => 'ro', isa => 'Str'); | ||
| 11 | has OperationPreferences => (is => 'ro', isa => 'Paws::CloudFormation::StackSetOperationPreferences'); | ||
| 12 | has RetainStacks => (is => 'ro', isa => 'Bool'); | ||
| 13 | has StackSetDriftDetectionDetails => (is => 'ro', isa => 'Paws::CloudFormation::StackSetDriftDetectionDetails'); | ||
| 14 | has StackSetId => (is => 'ro', isa => 'Str'); | ||
| 15 | has Status => (is => 'ro', isa => 'Str'); | ||
| 16 | |||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::CloudFormation::StackSetOperation | ||
| 24 | |||
| 25 | =head1 USAGE | ||
| 26 | |||
| 27 | This class represents one of two things: | ||
| 28 | |||
| 29 | =head3 Arguments in a call to a service | ||
| 30 | |||
| 31 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 32 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 33 | |||
| 34 | As an example, if Att1 is expected to be a Paws::CloudFormation::StackSetOperation object: | ||
| 35 | |||
| 36 | $service_obj->Method(Att1 => { Action => $value, ..., Status => $value }); | ||
| 37 | |||
| 38 | =head3 Results returned from an API call | ||
| 39 | |||
| 40 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFormation::StackSetOperation object: | ||
| 41 | |||
| 42 | $result = $service_obj->Method(...); | ||
| 43 | $result->Att1->Action | ||
| 44 | |||
| 45 | =head1 DESCRIPTION | ||
| 46 | |||
| 47 | The structure that contains information about a stack set operation. | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 Action => Str | ||
| 53 | |||
| 54 | The type of stack set operation: C<CREATE>, C<UPDATE>, or C<DELETE>. | ||
| 55 | Create and delete operations affect only the specified stack set | ||
| 56 | instances that are associated with the specified stack set. Update | ||
| 57 | operations affect both the stack set itself, as well as I<all> | ||
| 58 | associated stack set instances. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 AdministrationRoleARN => Str | ||
| 62 | |||
| 63 | The Amazon Resource Number (ARN) of the IAM role used to perform this | ||
| 64 | stack set operation. | ||
| 65 | |||
| 66 | Use customized administrator roles to control which users or groups can | ||
| 67 | manage specific stack sets within the same administrator account. For | ||
| 68 | more information, see Define Permissions for Multiple Administrators | ||
| 69 | (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) | ||
| 70 | in the I<AWS CloudFormation User Guide>. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 CreationTimestamp => Str | ||
| 74 | |||
| 75 | The time at which the operation was initiated. Note that the creation | ||
| 76 | times for the stack set operation might differ from the creation time | ||
| 77 | of the individual stacks themselves. This is because AWS CloudFormation | ||
| 78 | needs to perform preparatory work for the operation, such as | ||
| 79 | dispatching the work to the requested Regions, before actually creating | ||
| 80 | the first stacks. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 DeploymentTargets => L<Paws::CloudFormation::DeploymentTargets> | ||
| 84 | |||
| 85 | [Service-managed permissions] The AWS Organizations accounts affected | ||
| 86 | by the stack operation. | ||
| 87 | |||
| 88 | |||
| 89 | =head2 EndTimestamp => Str | ||
| 90 | |||
| 91 | The time at which the stack set operation ended, across all accounts | ||
| 92 | and Regions specified. Note that this doesn't necessarily mean that the | ||
| 93 | stack set operation was successful, or even attempted, in each account | ||
| 94 | or Region. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 ExecutionRoleName => Str | ||
| 98 | |||
| 99 | The name of the IAM execution role used to create or update the stack | ||
| 100 | set. | ||
| 101 | |||
| 102 | Use customized execution roles to control which stack resources users | ||
| 103 | and groups can include in their stack sets. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 OperationId => Str | ||
| 107 | |||
| 108 | The unique ID of a stack set operation. | ||
| 109 | |||
| 110 | |||
| 111 | =head2 OperationPreferences => L<Paws::CloudFormation::StackSetOperationPreferences> | ||
| 112 | |||
| 113 | The preferences for how AWS CloudFormation performs this stack set | ||
| 114 | operation. | ||
| 115 | |||
| 116 | |||
| 117 | =head2 RetainStacks => Bool | ||
| 118 | |||
| 119 | For stack set operations of action type C<DELETE>, specifies whether to | ||
| 120 | remove the stack instances from the specified stack set, but doesn't | ||
| 121 | delete the stacks. You can't reassociate a retained stack, or add an | ||
| 122 | existing, saved stack to a new stack set. | ||
| 123 | |||
| 124 | |||
| 125 | =head2 StackSetDriftDetectionDetails => L<Paws::CloudFormation::StackSetDriftDetectionDetails> | ||
| 126 | |||
| 127 | Detailed information about the drift status of the stack set. This | ||
| 128 | includes information about drift operations currently being performed | ||
| 129 | on the stack set. | ||
| 130 | |||
| 131 | this information will only be present for stack set operations whose | ||
| 132 | C<Action> type is C<DETECT_DRIFT>. | ||
| 133 | |||
| 134 | For more information, see Detecting Unmanaged Changes in Stack Sets | ||
| 135 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html) | ||
| 136 | in the AWS CloudFormation User Guide. | ||
| 137 | |||
| 138 | |||
| 139 | =head2 StackSetId => Str | ||
| 140 | |||
| 141 | The ID of the stack set. | ||
| 142 | |||
| 143 | |||
| 144 | =head2 Status => Str | ||
| 145 | |||
| 146 | The status of the operation. | ||
| 147 | |||
| 148 | =over | ||
| 149 | |||
| 150 | =item * | ||
| 151 | |||
| 152 | C<FAILED>: The operation exceeded the specified failure tolerance. The | ||
| 153 | failure tolerance value that you've set for an operation is applied for | ||
| 154 | each Region during stack create and update operations. If the number of | ||
| 155 | failed stacks within a Region exceeds the failure tolerance, the status | ||
| 156 | of the operation in the Region is set to C<FAILED>. This in turn sets | ||
| 157 | the status of the operation as a whole to C<FAILED>, and AWS | ||
| 158 | CloudFormation cancels the operation in any remaining Regions. | ||
| 159 | |||
| 160 | =item * | ||
| 161 | |||
| 162 | C<QUEUED>: [Service-managed permissions] For automatic deployments that | ||
| 163 | require a sequence of operations, the operation is queued to be | ||
| 164 | performed. For more information, see the stack set operation status | ||
| 165 | codes | ||
| 166 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes) | ||
| 167 | in the AWS CloudFormation User Guide. | ||
| 168 | |||
| 169 | =item * | ||
| 170 | |||
| 171 | C<RUNNING>: The operation is currently being performed. | ||
| 172 | |||
| 173 | =item * | ||
| 174 | |||
| 175 | C<STOPPED>: The user has cancelled the operation. | ||
| 176 | |||
| 177 | =item * | ||
| 178 | |||
| 179 | C<STOPPING>: The operation is in the process of stopping, at user | ||
| 180 | request. | ||
| 181 | |||
| 182 | =item * | ||
| 183 | |||
| 184 | C<SUCCEEDED>: The operation completed creating or updating all the | ||
| 185 | specified stacks without exceeding the failure tolerance for the | ||
| 186 | operation. | ||
| 187 | |||
| 188 | =back | ||
| 189 | |||
| 190 | |||
| 191 | |||
| 192 | |||
| 193 | =head1 SEE ALSO | ||
| 194 | |||
| 195 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFormation> | ||
| 196 | |||
| 197 | =head1 BUGS and CONTRIBUTIONS | ||
| 198 | |||
| 199 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 200 | |||
| 201 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 202 | |||
| 203 | =cut | ||
| 204 |