« blib/lib/Paws/CloudFormation/RequiredActivatedType.pm
↑ Summary
blib/lib/Paws/CloudFormation/ResourceChangeDetail.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFormation::ResourceChange; | ||
| 3 | use Moose; | ||
| 4 | has Action => (is => 'ro', isa => 'Str'); | ||
| 5 | has ChangeSetId => (is => 'ro', isa => 'Str'); | ||
| 6 | has Details => (is => 'ro', isa => 'ArrayRef[Paws::CloudFormation::ResourceChangeDetail]'); | ||
| 7 | has LogicalResourceId => (is => 'ro', isa => 'Str'); | ||
| 8 | has ModuleInfo => (is => 'ro', isa => 'Paws::CloudFormation::ModuleInfo'); | ||
| 9 | has PhysicalResourceId => (is => 'ro', isa => 'Str'); | ||
| 10 | has Replacement => (is => 'ro', isa => 'Str'); | ||
| 11 | has ResourceType => (is => 'ro', isa => 'Str'); | ||
| 12 | has Scope => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::CloudFormation::ResourceChange | ||
| 21 | |||
| 22 | =head1 USAGE | ||
| 23 | |||
| 24 | This class represents one of two things: | ||
| 25 | |||
| 26 | =head3 Arguments in a call to a service | ||
| 27 | |||
| 28 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 29 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 30 | |||
| 31 | As an example, if Att1 is expected to be a Paws::CloudFormation::ResourceChange object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { Action => $value, ..., Scope => $value }); | ||
| 34 | |||
| 35 | =head3 Results returned from an API call | ||
| 36 | |||
| 37 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFormation::ResourceChange object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->Action | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | The C<ResourceChange> structure describes the resource and the action | ||
| 45 | that AWS CloudFormation will perform on it if you execute this change | ||
| 46 | set. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 Action => Str | ||
| 52 | |||
| 53 | The action that AWS CloudFormation takes on the resource, such as | ||
| 54 | C<Add> (adds a new resource), C<Modify> (changes a resource), C<Remove> | ||
| 55 | (deletes a resource), C<Import> (imports a resource), or C<Dynamic> | ||
| 56 | (exact action for the resource cannot be determined). | ||
| 57 | |||
| 58 | |||
| 59 | =head2 ChangeSetId => Str | ||
| 60 | |||
| 61 | The change set ID of the nested change set. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 Details => ArrayRef[L<Paws::CloudFormation::ResourceChangeDetail>] | ||
| 65 | |||
| 66 | For the C<Modify> action, a list of C<ResourceChangeDetail> structures | ||
| 67 | that describes the changes that AWS CloudFormation will make to the | ||
| 68 | resource. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 LogicalResourceId => Str | ||
| 72 | |||
| 73 | The resource's logical ID, which is defined in the stack's template. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 ModuleInfo => L<Paws::CloudFormation::ModuleInfo> | ||
| 77 | |||
| 78 | Contains information about the module from which the resource was | ||
| 79 | created, if the resource was created from a module included in the | ||
| 80 | stack template. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 PhysicalResourceId => Str | ||
| 84 | |||
| 85 | The resource's physical ID (resource name). Resources that you are | ||
| 86 | adding don't have physical IDs because they haven't been created. | ||
| 87 | |||
| 88 | |||
| 89 | =head2 Replacement => Str | ||
| 90 | |||
| 91 | For the C<Modify> action, indicates whether AWS CloudFormation will | ||
| 92 | replace the resource by creating a new one and deleting the old one. | ||
| 93 | This value depends on the value of the C<RequiresRecreation> property | ||
| 94 | in the C<ResourceTargetDefinition> structure. For example, if the | ||
| 95 | C<RequiresRecreation> field is C<Always> and the C<Evaluation> field is | ||
| 96 | C<Static>, C<Replacement> is C<True>. If the C<RequiresRecreation> | ||
| 97 | field is C<Always> and the C<Evaluation> field is C<Dynamic>, | ||
| 98 | C<Replacement> is C<Conditionally>. | ||
| 99 | |||
| 100 | If you have multiple changes with different C<RequiresRecreation> | ||
| 101 | values, the C<Replacement> value depends on the change with the most | ||
| 102 | impact. A C<RequiresRecreation> value of C<Always> has the most impact, | ||
| 103 | followed by C<Conditionally>, and then C<Never>. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 ResourceType => Str | ||
| 107 | |||
| 108 | The type of AWS CloudFormation resource, such as C<AWS::S3::Bucket>. | ||
| 109 | |||
| 110 | |||
| 111 | =head2 Scope => ArrayRef[Str|Undef] | ||
| 112 | |||
| 113 | For the C<Modify> action, indicates which resource attribute is | ||
| 114 | triggering this update, such as a change in the resource attribute's | ||
| 115 | C<Metadata>, C<Properties>, or C<Tags>. | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head1 SEE ALSO | ||
| 120 | |||
| 121 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFormation> | ||
| 122 | |||
| 123 | =head1 BUGS and CONTRIBUTIONS | ||
| 124 | |||
| 125 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 126 | |||
| 127 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 128 | |||
| 129 | =cut | ||
| 130 |