« blib/lib/Paws/CloudFormation/StackDriftInformation.pm
↑ Summary
blib/lib/Paws/CloudFormation/StackInstance.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFormation::StackEvent; | ||
| 3 | use Moose; | ||
| 4 | has ClientRequestToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has EventId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has LogicalResourceId => (is => 'ro', isa => 'Str'); | ||
| 7 | has PhysicalResourceId => (is => 'ro', isa => 'Str'); | ||
| 8 | has ResourceProperties => (is => 'ro', isa => 'Str'); | ||
| 9 | has ResourceStatus => (is => 'ro', isa => 'Str'); | ||
| 10 | has ResourceStatusReason => (is => 'ro', isa => 'Str'); | ||
| 11 | has ResourceType => (is => 'ro', isa => 'Str'); | ||
| 12 | has StackId => (is => 'ro', isa => 'Str', required => 1); | ||
| 13 | has StackName => (is => 'ro', isa => 'Str', required => 1); | ||
| 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::StackEvent | ||
| 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::StackEvent object: | ||
| 34 | |||
| 35 | $service_obj->Method(Att1 => { ClientRequestToken => $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::StackEvent object: | ||
| 40 | |||
| 41 | $result = $service_obj->Method(...); | ||
| 42 | $result->Att1->ClientRequestToken | ||
| 43 | |||
| 44 | =head1 DESCRIPTION | ||
| 45 | |||
| 46 | The StackEvent data type. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 ClientRequestToken => Str | ||
| 52 | |||
| 53 | The token passed to the operation that generated this event. | ||
| 54 | |||
| 55 | All events triggered by a given stack operation are assigned the same | ||
| 56 | client request token, which you can use to track operations. For | ||
| 57 | example, if you execute a C<CreateStack> operation with the token | ||
| 58 | C<token1>, then all the C<StackEvents> generated by that operation will | ||
| 59 | have C<ClientRequestToken> set as C<token1>. | ||
| 60 | |||
| 61 | In the console, stack operations display the client request token on | ||
| 62 | the Events tab. Stack operations that are initiated from the console | ||
| 63 | use the token format I<Console-StackOperation-ID>, which helps you | ||
| 64 | easily identify the stack operation . For example, if you create a | ||
| 65 | stack using the console, each stack event would be assigned the same | ||
| 66 | token in the following format: | ||
| 67 | C<Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002>. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> EventId => Str | ||
| 71 | |||
| 72 | The unique ID of this event. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 LogicalResourceId => Str | ||
| 76 | |||
| 77 | The logical name of the resource specified in the template. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 PhysicalResourceId => Str | ||
| 81 | |||
| 82 | The name or unique identifier associated with the physical instance of | ||
| 83 | the resource. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 ResourceProperties => Str | ||
| 87 | |||
| 88 | BLOB of the properties used to create the resource. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 ResourceStatus => Str | ||
| 92 | |||
| 93 | Current status of the resource. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 ResourceStatusReason => Str | ||
| 97 | |||
| 98 | Success/failure message associated with the resource. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 ResourceType => Str | ||
| 102 | |||
| 103 | Type of resource. (For more information, go to AWS Resource Types | ||
| 104 | Reference | ||
| 105 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) | ||
| 106 | in the AWS CloudFormation User Guide.) | ||
| 107 | |||
| 108 | |||
| 109 | =head2 B<REQUIRED> StackId => Str | ||
| 110 | |||
| 111 | The unique ID name of the instance of the stack. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 B<REQUIRED> StackName => Str | ||
| 115 | |||
| 116 | The name associated with a stack. | ||
| 117 | |||
| 118 | |||
| 119 | =head2 B<REQUIRED> Timestamp => Str | ||
| 120 | |||
| 121 | Time the status was updated. | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head1 SEE ALSO | ||
| 126 | |||
| 127 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFormation> | ||
| 128 | |||
| 129 | =head1 BUGS and CONTRIBUTIONS | ||
| 130 | |||
| 131 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 132 | |||
| 133 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 134 | |||
| 135 | =cut | ||
| 136 |