« blib/lib/Paws/CloudFormation/DescribeStackResourceOutput.pm
↑ Summary
blib/lib/Paws/CloudFormation/DescribeStackResourcesOutput.pm »
| 1 | |||
| 2 | package Paws::CloudFormation::DescribeStackResources; | ||
| 3 | use Moose; | ||
| 4 | has LogicalResourceId => (is => 'ro', isa => 'Str'); | ||
| 5 | has PhysicalResourceId => (is => 'ro', isa => 'Str'); | ||
| 6 | has StackName => (is => 'ro', isa => 'Str'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeStackResources'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudFormation::DescribeStackResourcesOutput'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeStackResourcesResult'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::CloudFormation::DescribeStackResources - Arguments for method DescribeStackResources on L<Paws::CloudFormation> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method DescribeStackResources on the | ||
| 24 | L<AWS CloudFormation|Paws::CloudFormation> service. Use the attributes of this class | ||
| 25 | as arguments to method DescribeStackResources. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeStackResources. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $cloudformation = Paws->service('CloudFormation'); | ||
| 32 | my $DescribeStackResourcesOutput = $cloudformation->DescribeStackResources( | ||
| 33 | LogicalResourceId => 'MyLogicalResourceId', # OPTIONAL | ||
| 34 | PhysicalResourceId => 'MyPhysicalResourceId', # OPTIONAL | ||
| 35 | StackName => 'MyStackName', # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $StackResources = $DescribeStackResourcesOutput->StackResources; | ||
| 40 | |||
| 41 | # Returns a L<Paws::CloudFormation::DescribeStackResourcesOutput> object. | ||
| 42 | |||
| 43 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloudformation/DescribeStackResources> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 LogicalResourceId => Str | ||
| 50 | |||
| 51 | The logical name of the resource as specified in the template. | ||
| 52 | |||
| 53 | Default: There is no default value. | ||
| 54 | |||
| 55 | |||
| 56 | |||
| 57 | =head2 PhysicalResourceId => Str | ||
| 58 | |||
| 59 | The name or unique identifier that corresponds to a physical instance | ||
| 60 | ID of a resource supported by AWS CloudFormation. | ||
| 61 | |||
| 62 | For example, for an Amazon Elastic Compute Cloud (EC2) instance, | ||
| 63 | C<PhysicalResourceId> corresponds to the C<InstanceId>. You can pass | ||
| 64 | the EC2 C<InstanceId> to C<DescribeStackResources> to find which stack | ||
| 65 | the instance belongs to and what other resources are part of the stack. | ||
| 66 | |||
| 67 | Required: Conditional. If you do not specify C<PhysicalResourceId>, you | ||
| 68 | must specify C<StackName>. | ||
| 69 | |||
| 70 | Default: There is no default value. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 StackName => Str | ||
| 75 | |||
| 76 | The name or the unique stack ID that is associated with the stack, | ||
| 77 | which are not always interchangeable: | ||
| 78 | |||
| 79 | =over | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | Running stacks: You can specify either the stack's name or its unique | ||
| 84 | stack ID. | ||
| 85 | |||
| 86 | =item * | ||
| 87 | |||
| 88 | Deleted stacks: You must specify the unique stack ID. | ||
| 89 | |||
| 90 | =back | ||
| 91 | |||
| 92 | Default: There is no default value. | ||
| 93 | |||
| 94 | Required: Conditional. If you do not specify C<StackName>, you must | ||
| 95 | specify C<PhysicalResourceId>. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head1 SEE ALSO | ||
| 101 | |||
| 102 | This class forms part of L<Paws>, documenting arguments for method DescribeStackResources in L<Paws::CloudFormation> | ||
| 103 | |||
| 104 | =head1 BUGS and CONTRIBUTIONS | ||
| 105 | |||
| 106 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 107 | |||
| 108 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 109 | |||
| 110 | =cut | ||
| 111 |