« blib/lib/Paws/CloudFormation/ListImportsOutput.pm
↑ Summary
blib/lib/Paws/CloudFormation/ListStackInstancesOutput.pm »
| 1 | |||
| 2 | package Paws::CloudFormation::ListStackInstances; | ||
| 3 | use Moose; | ||
| 4 | has CallAs => (is => 'ro', isa => 'Str'); | ||
| 5 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::CloudFormation::StackInstanceFilter]'); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 8 | has StackInstanceAccount => (is => 'ro', isa => 'Str'); | ||
| 9 | has StackInstanceRegion => (is => 'ro', isa => 'Str'); | ||
| 10 | has StackSetName => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListStackInstances'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudFormation::ListStackInstancesOutput'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ListStackInstancesResult'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::CloudFormation::ListStackInstances - Arguments for method ListStackInstances on L<Paws::CloudFormation> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method ListStackInstances on the | ||
| 28 | L<AWS CloudFormation|Paws::CloudFormation> service. Use the attributes of this class | ||
| 29 | as arguments to method ListStackInstances. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListStackInstances. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $cloudformation = Paws->service('CloudFormation'); | ||
| 36 | my $ListStackInstancesOutput = $cloudformation->ListStackInstances( | ||
| 37 | StackSetName => 'MyStackSetName', | ||
| 38 | CallAs => 'SELF', # OPTIONAL | ||
| 39 | Filters => [ | ||
| 40 | { | ||
| 41 | Name => 'DETAILED_STATUS', # values: DETAILED_STATUS; OPTIONAL | ||
| 42 | Values => 'MyStackInstanceFilterValues', # min: 6, max: 10; OPTIONAL | ||
| 43 | }, | ||
| 44 | ... | ||
| 45 | ], # OPTIONAL | ||
| 46 | MaxResults => 1, # OPTIONAL | ||
| 47 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 48 | StackInstanceAccount => 'MyAccount', # OPTIONAL | ||
| 49 | StackInstanceRegion => 'MyRegion', # OPTIONAL | ||
| 50 | ); | ||
| 51 | |||
| 52 | # Results: | ||
| 53 | my $NextToken = $ListStackInstancesOutput->NextToken; | ||
| 54 | my $Summaries = $ListStackInstancesOutput->Summaries; | ||
| 55 | |||
| 56 | # Returns a L<Paws::CloudFormation::ListStackInstancesOutput> object. | ||
| 57 | |||
| 58 | 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. | ||
| 59 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloudformation/ListStackInstances> | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 CallAs => Str | ||
| 65 | |||
| 66 | [Service-managed permissions] Specifies whether you are acting as an | ||
| 67 | account administrator in the organization's management account or as a | ||
| 68 | delegated administrator in a member account. | ||
| 69 | |||
| 70 | By default, C<SELF> is specified. Use C<SELF> for stack sets with | ||
| 71 | self-managed permissions. | ||
| 72 | |||
| 73 | =over | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | If you are signed in to the management account, specify C<SELF>. | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | If you are signed in to a delegated administrator account, specify | ||
| 82 | C<DELEGATED_ADMIN>. | ||
| 83 | |||
| 84 | Your AWS account must be registered as a delegated administrator in the | ||
| 85 | management account. For more information, see Register a delegated | ||
| 86 | administrator | ||
| 87 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) | ||
| 88 | in the I<AWS CloudFormation User Guide>. | ||
| 89 | |||
| 90 | =back | ||
| 91 | |||
| 92 | |||
| 93 | Valid values are: C<"SELF">, C<"DELEGATED_ADMIN"> | ||
| 94 | |||
| 95 | =head2 Filters => ArrayRef[L<Paws::CloudFormation::StackInstanceFilter>] | ||
| 96 | |||
| 97 | The status that stack instances are filtered by. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 MaxResults => Int | ||
| 102 | |||
| 103 | The maximum number of results to be returned with a single call. If the | ||
| 104 | number of available results exceeds this maximum, the response includes | ||
| 105 | a C<NextToken> value that you can assign to the C<NextToken> request | ||
| 106 | parameter to get the next set of results. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 NextToken => Str | ||
| 111 | |||
| 112 | If the previous request didn't return all of the remaining results, the | ||
| 113 | response's C<NextToken> parameter value is set to a token. To retrieve | ||
| 114 | the next set of results, call C<ListStackInstances> again and assign | ||
| 115 | that token to the request object's C<NextToken> parameter. If there are | ||
| 116 | no remaining results, the previous response object's C<NextToken> | ||
| 117 | parameter is set to C<null>. | ||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head2 StackInstanceAccount => Str | ||
| 122 | |||
| 123 | The name of the AWS account that you want to list stack instances for. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head2 StackInstanceRegion => Str | ||
| 128 | |||
| 129 | The name of the Region where you want to list stack instances. | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head2 B<REQUIRED> StackSetName => Str | ||
| 134 | |||
| 135 | The name or unique ID of the stack set that you want to list stack | ||
| 136 | instances for. | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | =head1 SEE ALSO | ||
| 142 | |||
| 143 | This class forms part of L<Paws>, documenting arguments for method ListStackInstances in L<Paws::CloudFormation> | ||
| 144 | |||
| 145 | =head1 BUGS and CONTRIBUTIONS | ||
| 146 | |||
| 147 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 148 | |||
| 149 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 150 | |||
| 151 | =cut | ||
| 152 |