« blib/lib/Paws/CloudFormation/DescribeStackEventsOutput.pm
↑ Summary
blib/lib/Paws/CloudFormation/DescribeStackInstanceOutput.pm »
| 1 | |||
| 2 | package Paws::CloudFormation::DescribeStackInstance; | ||
| 3 | use Moose; | ||
| 4 | has CallAs => (is => 'ro', isa => 'Str'); | ||
| 5 | has StackInstanceAccount => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has StackInstanceRegion => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has StackSetName => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeStackInstance'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudFormation::DescribeStackInstanceOutput'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeStackInstanceResult'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::CloudFormation::DescribeStackInstance - Arguments for method DescribeStackInstance on L<Paws::CloudFormation> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DescribeStackInstance on the | ||
| 25 | L<AWS CloudFormation|Paws::CloudFormation> service. Use the attributes of this class | ||
| 26 | as arguments to method DescribeStackInstance. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeStackInstance. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $cloudformation = Paws->service('CloudFormation'); | ||
| 33 | my $DescribeStackInstanceOutput = $cloudformation->DescribeStackInstance( | ||
| 34 | StackInstanceAccount => 'MyAccount', | ||
| 35 | StackInstanceRegion => 'MyRegion', | ||
| 36 | StackSetName => 'MyStackSetName', | ||
| 37 | CallAs => 'SELF', # OPTIONAL | ||
| 38 | ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $StackInstance = $DescribeStackInstanceOutput->StackInstance; | ||
| 42 | |||
| 43 | # Returns a L<Paws::CloudFormation::DescribeStackInstanceOutput> object. | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloudformation/DescribeStackInstance> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 CallAs => Str | ||
| 52 | |||
| 53 | [Service-managed permissions] Specifies whether you are acting as an | ||
| 54 | account administrator in the organization's management account or as a | ||
| 55 | delegated administrator in a member account. | ||
| 56 | |||
| 57 | By default, C<SELF> is specified. Use C<SELF> for stack sets with | ||
| 58 | self-managed permissions. | ||
| 59 | |||
| 60 | =over | ||
| 61 | |||
| 62 | =item * | ||
| 63 | |||
| 64 | If you are signed in to the management account, specify C<SELF>. | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | If you are signed in to a delegated administrator account, specify | ||
| 69 | C<DELEGATED_ADMIN>. | ||
| 70 | |||
| 71 | Your AWS account must be registered as a delegated administrator in the | ||
| 72 | management account. For more information, see Register a delegated | ||
| 73 | administrator | ||
| 74 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) | ||
| 75 | in the I<AWS CloudFormation User Guide>. | ||
| 76 | |||
| 77 | =back | ||
| 78 | |||
| 79 | |||
| 80 | Valid values are: C<"SELF">, C<"DELEGATED_ADMIN"> | ||
| 81 | |||
| 82 | =head2 B<REQUIRED> StackInstanceAccount => Str | ||
| 83 | |||
| 84 | The ID of an AWS account that's associated with this stack instance. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 B<REQUIRED> StackInstanceRegion => Str | ||
| 89 | |||
| 90 | The name of a Region that's associated with this stack instance. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 B<REQUIRED> StackSetName => Str | ||
| 95 | |||
| 96 | The name or the unique stack ID of the stack set that you want to get | ||
| 97 | stack instance information for. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head1 SEE ALSO | ||
| 103 | |||
| 104 | This class forms part of L<Paws>, documenting arguments for method DescribeStackInstance in L<Paws::CloudFormation> | ||
| 105 | |||
| 106 | =head1 BUGS and CONTRIBUTIONS | ||
| 107 | |||
| 108 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 109 | |||
| 110 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 111 | |||
| 112 | =cut | ||
| 113 |