« blib/lib/Paws/CloudFormation/Parameter.pm
↑ Summary
blib/lib/Paws/CloudFormation/StackDriftInformationSummary.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFormation::Stack; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has Capabilities => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | |
| 5 | 1 | has ChangeSetId => (is => 'ro', isa => 'Str'); | |
| 6 | 1 | has CreationTime => (is => 'ro', isa => 'Str', required => 1); | |
| 7 | 1 | has DeletionTime => (is => 'ro', isa => 'Str'); | |
| 8 | 1 | has Description => (is => 'ro', isa => 'Str'); | |
| 9 | 1 | has DisableRollback => (is => 'ro', isa => 'Bool'); | |
| 10 | 1 | has DriftInformation => (is => 'ro', isa => 'Paws::CloudFormation::StackDriftInformation'); | |
| 11 | 1 | has EnableTerminationProtection => (is => 'ro', isa => 'Bool'); | |
| 12 | 1 | has LastUpdatedTime => (is => 'ro', isa => 'Str'); | |
| 13 | 1 | has NotificationARNs => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | |
| 14 | 1 | has Outputs => (is => 'ro', isa => 'ArrayRef[Paws::CloudFormation::Output]'); | |
| 15 | 1 | has Parameters => (is => 'ro', isa => 'ArrayRef[Paws::CloudFormation::Parameter]'); | |
| 16 | 1 | has ParentId => (is => 'ro', isa => 'Str'); | |
| 17 | 1 | has RoleARN => (is => 'ro', isa => 'Str'); | |
| 18 | 1 | has RollbackConfiguration => (is => 'ro', isa => 'Paws::CloudFormation::RollbackConfiguration'); | |
| 19 | 1 | has RootId => (is => 'ro', isa => 'Str'); | |
| 20 | 1 | has StackId => (is => 'ro', isa => 'Str'); | |
| 21 | 1 | has StackName => (is => 'ro', isa => 'Str', required => 1); | |
| 22 | 1 | has StackStatus => (is => 'ro', isa => 'Str', required => 1); | |
| 23 | 1 | has StackStatusReason => (is => 'ro', isa => 'Str'); | |
| 24 | 1 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::CloudFormation::Tag]'); | |
| 25 | 1 | has TimeoutInMinutes => (is => 'ro', isa => 'Int'); | |
| 26 | |||
| 27 | 1 | 1; | |
| 28 | |||
| 29 | ### main pod documentation begin ### | ||
| 30 | |||
| 31 | =head1 NAME | ||
| 32 | |||
| 33 | Paws::CloudFormation::Stack | ||
| 34 | |||
| 35 | =head1 USAGE | ||
| 36 | |||
| 37 | This class represents one of two things: | ||
| 38 | |||
| 39 | =head3 Arguments in a call to a service | ||
| 40 | |||
| 41 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 42 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 43 | |||
| 44 | As an example, if Att1 is expected to be a Paws::CloudFormation::Stack object: | ||
| 45 | |||
| 46 | $service_obj->Method(Att1 => { Capabilities => $value, ..., TimeoutInMinutes => $value }); | ||
| 47 | |||
| 48 | =head3 Results returned from an API call | ||
| 49 | |||
| 50 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFormation::Stack object: | ||
| 51 | |||
| 52 | $result = $service_obj->Method(...); | ||
| 53 | $result->Att1->Capabilities | ||
| 54 | |||
| 55 | =head1 DESCRIPTION | ||
| 56 | |||
| 57 | The Stack data type. | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 Capabilities => ArrayRef[Str|Undef] | ||
| 63 | |||
| 64 | The capabilities allowed in the stack. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 ChangeSetId => Str | ||
| 68 | |||
| 69 | The unique ID of the change set. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 B<REQUIRED> CreationTime => Str | ||
| 73 | |||
| 74 | The time at which the stack was created. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 DeletionTime => Str | ||
| 78 | |||
| 79 | The time the stack was deleted. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 Description => Str | ||
| 83 | |||
| 84 | A user-defined description associated with the stack. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 DisableRollback => Bool | ||
| 88 | |||
| 89 | Boolean to enable or disable rollback on stack creation failures: | ||
| 90 | |||
| 91 | =over | ||
| 92 | |||
| 93 | =item * | ||
| 94 | |||
| 95 | C<true>: disable rollback | ||
| 96 | |||
| 97 | =item * | ||
| 98 | |||
| 99 | C<false>: enable rollback | ||
| 100 | |||
| 101 | =back | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 DriftInformation => L<Paws::CloudFormation::StackDriftInformation> | ||
| 106 | |||
| 107 | Information on whether a stack's actual configuration differs, or has | ||
| 108 | I<drifted>, from it's expected configuration, as defined in the stack | ||
| 109 | template and any values specified as template parameters. For more | ||
| 110 | information, see Detecting Unregulated Configuration Changes to Stacks | ||
| 111 | and Resources | ||
| 112 | (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). | ||
| 113 | |||
| 114 | |||
| 115 | =head2 EnableTerminationProtection => Bool | ||
| 116 | |||
| 117 | Whether termination protection is enabled for the stack. | ||
| 118 | |||
| 119 | For nested stacks | ||
| 120 | (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html), | ||
| 121 | termination protection is set on the root stack and cannot be changed | ||
| 122 | directly on the nested stack. For more information, see Protecting a | ||
| 123 | Stack From Being Deleted | ||
| 124 | (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) | ||
| 125 | in the I<AWS CloudFormation User Guide>. | ||
| 126 | |||
| 127 | |||
| 128 | =head2 LastUpdatedTime => Str | ||
| 129 | |||
| 130 | The time the stack was last updated. This field will only be returned | ||
| 131 | if the stack has been updated at least once. | ||
| 132 | |||
| 133 | |||
| 134 | =head2 NotificationARNs => ArrayRef[Str|Undef] | ||
| 135 | |||
| 136 | SNS topic ARNs to which stack related events are published. | ||
| 137 | |||
| 138 | |||
| 139 | =head2 Outputs => ArrayRef[L<Paws::CloudFormation::Output>] | ||
| 140 | |||
| 141 | A list of output structures. | ||
| 142 | |||
| 143 | |||
| 144 | =head2 Parameters => ArrayRef[L<Paws::CloudFormation::Parameter>] | ||
| 145 | |||
| 146 | A list of C<Parameter> structures. | ||
| 147 | |||
| 148 | |||
| 149 | =head2 ParentId => Str | ||
| 150 | |||
| 151 | For nested stacks--stacks created as resources for another stack--the | ||
| 152 | stack ID of the direct parent of this stack. For the first level of | ||
| 153 | nested stacks, the root stack is also the parent stack. | ||
| 154 | |||
| 155 | For more information, see Working with Nested Stacks | ||
| 156 | (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) | ||
| 157 | in the I<AWS CloudFormation User Guide>. | ||
| 158 | |||
| 159 | |||
| 160 | =head2 RoleARN => Str | ||
| 161 | |||
| 162 | The Amazon Resource Name (ARN) of an AWS Identity and Access Management | ||
| 163 | (IAM) role that is associated with the stack. During a stack operation, | ||
| 164 | AWS CloudFormation uses this role's credentials to make calls on your | ||
| 165 | behalf. | ||
| 166 | |||
| 167 | |||
| 168 | =head2 RollbackConfiguration => L<Paws::CloudFormation::RollbackConfiguration> | ||
| 169 | |||
| 170 | The rollback triggers for AWS CloudFormation to monitor during stack | ||
| 171 | creation and updating operations, and for the specified monitoring | ||
| 172 | period afterwards. | ||
| 173 | |||
| 174 | |||
| 175 | =head2 RootId => Str | ||
| 176 | |||
| 177 | For nested stacks--stacks created as resources for another stack--the | ||
| 178 | stack ID of the top-level stack to which the nested stack ultimately | ||
| 179 | belongs. | ||
| 180 | |||
| 181 | For more information, see Working with Nested Stacks | ||
| 182 | (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) | ||
| 183 | in the I<AWS CloudFormation User Guide>. | ||
| 184 | |||
| 185 | |||
| 186 | =head2 StackId => Str | ||
| 187 | |||
| 188 | Unique identifier of the stack. | ||
| 189 | |||
| 190 | |||
| 191 | =head2 B<REQUIRED> StackName => Str | ||
| 192 | |||
| 193 | The name associated with the stack. | ||
| 194 | |||
| 195 | |||
| 196 | =head2 B<REQUIRED> StackStatus => Str | ||
| 197 | |||
| 198 | Current status of the stack. | ||
| 199 | |||
| 200 | |||
| 201 | =head2 StackStatusReason => Str | ||
| 202 | |||
| 203 | Success/failure message associated with the stack status. | ||
| 204 | |||
| 205 | |||
| 206 | =head2 Tags => ArrayRef[L<Paws::CloudFormation::Tag>] | ||
| 207 | |||
| 208 | A list of C<Tag>s that specify information about the stack. | ||
| 209 | |||
| 210 | |||
| 211 | =head2 TimeoutInMinutes => Int | ||
| 212 | |||
| 213 | The amount of time within which stack creation should complete. | ||
| 214 | |||
| 215 | |||
| 216 | |||
| 217 | =head1 SEE ALSO | ||
| 218 | |||
| 219 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFormation> | ||
| 220 | |||
| 221 | =head1 BUGS and CONTRIBUTIONS | ||
| 222 | |||
| 223 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 224 | |||
| 225 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 226 | |||
| 227 | =cut | ||
| 228 | |||