« blib/lib/Paws/CloudFormation/StackResourceSummary.pm
↑ Summary
blib/lib/Paws/CloudFormation/StackSetDriftDetectionDetails.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFormation::StackSet; | ||
| 3 | use Moose; | ||
| 4 | has AdministrationRoleARN => (is => 'ro', isa => 'Str'); | ||
| 5 | has AutoDeployment => (is => 'ro', isa => 'Paws::CloudFormation::AutoDeployment'); | ||
| 6 | has Capabilities => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 7 | has Description => (is => 'ro', isa => 'Str'); | ||
| 8 | has ExecutionRoleName => (is => 'ro', isa => 'Str'); | ||
| 9 | has OrganizationalUnitIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 10 | has Parameters => (is => 'ro', isa => 'ArrayRef[Paws::CloudFormation::Parameter]'); | ||
| 11 | has PermissionModel => (is => 'ro', isa => 'Str'); | ||
| 12 | has StackSetARN => (is => 'ro', isa => 'Str'); | ||
| 13 | has StackSetDriftDetectionDetails => (is => 'ro', isa => 'Paws::CloudFormation::StackSetDriftDetectionDetails'); | ||
| 14 | has StackSetId => (is => 'ro', isa => 'Str'); | ||
| 15 | has StackSetName => (is => 'ro', isa => 'Str'); | ||
| 16 | has Status => (is => 'ro', isa => 'Str'); | ||
| 17 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::CloudFormation::Tag]'); | ||
| 18 | has TemplateBody => (is => 'ro', isa => 'Str', decode_as => 'JSON', method => 'Template', traits => ['JSONAttribute']); | ||
| 19 | |||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::CloudFormation::StackSet | ||
| 27 | |||
| 28 | =head1 USAGE | ||
| 29 | |||
| 30 | This class represents one of two things: | ||
| 31 | |||
| 32 | =head3 Arguments in a call to a service | ||
| 33 | |||
| 34 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 35 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 36 | |||
| 37 | As an example, if Att1 is expected to be a Paws::CloudFormation::StackSet object: | ||
| 38 | |||
| 39 | $service_obj->Method(Att1 => { AdministrationRoleARN => $value, ..., TemplateBody => $value }); | ||
| 40 | |||
| 41 | =head3 Results returned from an API call | ||
| 42 | |||
| 43 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFormation::StackSet object: | ||
| 44 | |||
| 45 | $result = $service_obj->Method(...); | ||
| 46 | $result->Att1->AdministrationRoleARN | ||
| 47 | |||
| 48 | =head1 DESCRIPTION | ||
| 49 | |||
| 50 | A structure that contains information about a stack set. A stack set | ||
| 51 | enables you to provision stacks into AWS accounts and across Regions by | ||
| 52 | using a single CloudFormation template. In the stack set, you specify | ||
| 53 | the template to use, as well as any parameters and capabilities that | ||
| 54 | the template requires. | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 AdministrationRoleARN => Str | ||
| 60 | |||
| 61 | The Amazon Resource Number (ARN) of the IAM role used to create or | ||
| 62 | update the stack set. | ||
| 63 | |||
| 64 | Use customized administrator roles to control which users or groups can | ||
| 65 | manage specific stack sets within the same administrator account. For | ||
| 66 | more information, see Prerequisites: Granting Permissions for Stack Set | ||
| 67 | Operations | ||
| 68 | (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) | ||
| 69 | in the I<AWS CloudFormation User Guide>. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 AutoDeployment => L<Paws::CloudFormation::AutoDeployment> | ||
| 73 | |||
| 74 | [Service-managed permissions] Describes whether StackSets automatically | ||
| 75 | deploys to AWS Organizations accounts that are added to a target | ||
| 76 | organization or organizational unit (OU). | ||
| 77 | |||
| 78 | |||
| 79 | =head2 Capabilities => ArrayRef[Str|Undef] | ||
| 80 | |||
| 81 | The capabilities that are allowed in the stack set. Some stack set | ||
| 82 | templates might include resources that can affect permissions in your | ||
| 83 | AWS accountE<mdash>for example, by creating new AWS Identity and Access | ||
| 84 | Management (IAM) users. For more information, see Acknowledging IAM | ||
| 85 | Resources in AWS CloudFormation Templates. | ||
| 86 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities) | ||
| 87 | |||
| 88 | |||
| 89 | =head2 Description => Str | ||
| 90 | |||
| 91 | A description of the stack set that you specify when the stack set is | ||
| 92 | created or updated. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 ExecutionRoleName => Str | ||
| 96 | |||
| 97 | The name of the IAM execution role used to create or update the stack | ||
| 98 | set. | ||
| 99 | |||
| 100 | Use customized execution roles to control which stack resources users | ||
| 101 | and groups can include in their stack sets. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 OrganizationalUnitIds => ArrayRef[Str|Undef] | ||
| 105 | |||
| 106 | [Service-managed permissions] The organization root ID or | ||
| 107 | organizational unit (OU) IDs that you specified for DeploymentTargets | ||
| 108 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html). | ||
| 109 | |||
| 110 | |||
| 111 | =head2 Parameters => ArrayRef[L<Paws::CloudFormation::Parameter>] | ||
| 112 | |||
| 113 | A list of input parameters for a stack set. | ||
| 114 | |||
| 115 | |||
| 116 | =head2 PermissionModel => Str | ||
| 117 | |||
| 118 | Describes how the IAM roles required for stack set operations are | ||
| 119 | created. | ||
| 120 | |||
| 121 | =over | ||
| 122 | |||
| 123 | =item * | ||
| 124 | |||
| 125 | With C<self-managed> permissions, you must create the administrator and | ||
| 126 | execution roles required to deploy to target accounts. For more | ||
| 127 | information, see Grant Self-Managed Stack Set Permissions | ||
| 128 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html). | ||
| 129 | |||
| 130 | =item * | ||
| 131 | |||
| 132 | With C<service-managed> permissions, StackSets automatically creates | ||
| 133 | the IAM roles required to deploy to accounts managed by AWS | ||
| 134 | Organizations. For more information, see Grant Service-Managed Stack | ||
| 135 | Set Permissions | ||
| 136 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html). | ||
| 137 | |||
| 138 | =back | ||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | =head2 StackSetARN => Str | ||
| 143 | |||
| 144 | The Amazon Resource Number (ARN) of the stack set. | ||
| 145 | |||
| 146 | |||
| 147 | =head2 StackSetDriftDetectionDetails => L<Paws::CloudFormation::StackSetDriftDetectionDetails> | ||
| 148 | |||
| 149 | Detailed information about the drift status of the stack set. | ||
| 150 | |||
| 151 | For stack sets, contains information about the last I<completed> drift | ||
| 152 | operation performed on the stack set. Information about drift | ||
| 153 | operations currently in progress is not included. | ||
| 154 | |||
| 155 | |||
| 156 | =head2 StackSetId => Str | ||
| 157 | |||
| 158 | The ID of the stack set. | ||
| 159 | |||
| 160 | |||
| 161 | =head2 StackSetName => Str | ||
| 162 | |||
| 163 | The name that's associated with the stack set. | ||
| 164 | |||
| 165 | |||
| 166 | =head2 Status => Str | ||
| 167 | |||
| 168 | The status of the stack set. | ||
| 169 | |||
| 170 | |||
| 171 | =head2 Tags => ArrayRef[L<Paws::CloudFormation::Tag>] | ||
| 172 | |||
| 173 | A list of tags that specify information about the stack set. A maximum | ||
| 174 | number of 50 tags can be specified. | ||
| 175 | |||
| 176 | |||
| 177 | =head2 TemplateBody => Str | ||
| 178 | |||
| 179 | The structure that contains the body of the template that was used to | ||
| 180 | create or update the stack set. | ||
| 181 | |||
| 182 | |||
| 183 | |||
| 184 | =head1 SEE ALSO | ||
| 185 | |||
| 186 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFormation> | ||
| 187 | |||
| 188 | =head1 BUGS and CONTRIBUTIONS | ||
| 189 | |||
| 190 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 191 | |||
| 192 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 193 | |||
| 194 | =cut | ||
| 195 |