« blib/lib/Paws/CloudFormation/StackInstanceSummary.pm
↑ Summary
blib/lib/Paws/CloudFormation/StackResourceDetail.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFormation::StackResource; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str'); | ||
| 5 | has DriftInformation => (is => 'ro', isa => 'Paws::CloudFormation::StackResourceDriftInformation'); | ||
| 6 | has LogicalResourceId => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has ModuleInfo => (is => 'ro', isa => 'Paws::CloudFormation::ModuleInfo'); | ||
| 8 | has PhysicalResourceId => (is => 'ro', isa => 'Str'); | ||
| 9 | has ResourceStatus => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has ResourceStatusReason => (is => 'ro', isa => 'Str'); | ||
| 11 | has ResourceType => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has StackId => (is => 'ro', isa => 'Str'); | ||
| 13 | has StackName => (is => 'ro', isa => 'Str'); | ||
| 14 | has Timestamp => (is => 'ro', isa => 'Str', required => 1); | ||
| 15 | |||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::CloudFormation::StackResource | ||
| 23 | |||
| 24 | =head1 USAGE | ||
| 25 | |||
| 26 | This class represents one of two things: | ||
| 27 | |||
| 28 | =head3 Arguments in a call to a service | ||
| 29 | |||
| 30 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 31 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 32 | |||
| 33 | As an example, if Att1 is expected to be a Paws::CloudFormation::StackResource object: | ||
| 34 | |||
| 35 | $service_obj->Method(Att1 => { Description => $value, ..., Timestamp => $value }); | ||
| 36 | |||
| 37 | =head3 Results returned from an API call | ||
| 38 | |||
| 39 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFormation::StackResource object: | ||
| 40 | |||
| 41 | $result = $service_obj->Method(...); | ||
| 42 | $result->Att1->Description | ||
| 43 | |||
| 44 | =head1 DESCRIPTION | ||
| 45 | |||
| 46 | The StackResource data type. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 Description => Str | ||
| 52 | |||
| 53 | User defined description associated with the resource. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 DriftInformation => L<Paws::CloudFormation::StackResourceDriftInformation> | ||
| 57 | |||
| 58 | Information about whether the resource's actual configuration differs, | ||
| 59 | or has I<drifted>, from its expected configuration, as defined in the | ||
| 60 | stack template and any values specified as template parameters. For | ||
| 61 | more information, see Detecting Unregulated Configuration Changes to | ||
| 62 | Stacks and Resources | ||
| 63 | (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). | ||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> LogicalResourceId => Str | ||
| 67 | |||
| 68 | The logical name of the resource specified in the template. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 ModuleInfo => L<Paws::CloudFormation::ModuleInfo> | ||
| 72 | |||
| 73 | Contains information about the module from which the resource was | ||
| 74 | created, if the resource was created from a module included in the | ||
| 75 | stack template. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 PhysicalResourceId => Str | ||
| 79 | |||
| 80 | The name or unique identifier that corresponds to a physical instance | ||
| 81 | ID of a resource supported by AWS CloudFormation. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 B<REQUIRED> ResourceStatus => Str | ||
| 85 | |||
| 86 | Current status of the resource. | ||
| 87 | |||
| 88 | |||
| 89 | =head2 ResourceStatusReason => Str | ||
| 90 | |||
| 91 | Success/failure message associated with the resource. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 B<REQUIRED> ResourceType => Str | ||
| 95 | |||
| 96 | Type of resource. (For more information, go to AWS Resource Types | ||
| 97 | Reference | ||
| 98 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) | ||
| 99 | in the AWS CloudFormation User Guide.) | ||
| 100 | |||
| 101 | |||
| 102 | =head2 StackId => Str | ||
| 103 | |||
| 104 | Unique identifier of the stack. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 StackName => Str | ||
| 108 | |||
| 109 | The name associated with the stack. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 B<REQUIRED> Timestamp => Str | ||
| 113 | |||
| 114 | Time the status was updated. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head1 SEE ALSO | ||
| 119 | |||
| 120 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFormation> | ||
| 121 | |||
| 122 | =head1 BUGS and CONTRIBUTIONS | ||
| 123 | |||
| 124 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 125 | |||
| 126 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 127 | |||
| 128 | =cut | ||
| 129 |