« blib/lib/Paws/CloudFormation/DescribeStacksOutput.pm
↑ Summary
blib/lib/Paws/CloudFormation/GetTemplateOutput.pm »
| 1 | |||
| 2 | package Paws::CloudFormation::GetTemplate; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has ChangeSetName => (is => 'ro', isa => 'Str'); | |
| 5 | 1 | has StackName => (is => 'ro', isa => 'Str'); | |
| 6 | 1 | has TemplateStage => (is => 'ro', isa => 'Str'); | |
| 7 | |||
| 8 | 1 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 9 | |||
| 10 | 1 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetTemplate'); | |
| 11 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudFormation::GetTemplateOutput'); | |
| 12 | 1 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'GetTemplateResult'); | |
| 13 | 1 | 1; | |
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::CloudFormation::GetTemplate - Arguments for method GetTemplate on L<Paws::CloudFormation> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method GetTemplate on the | ||
| 24 | L<AWS CloudFormation|Paws::CloudFormation> service. Use the attributes of this class | ||
| 25 | as arguments to method GetTemplate. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetTemplate. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $cloudformation = Paws->service('CloudFormation'); | ||
| 32 | my $GetTemplateOutput = $cloudformation->GetTemplate( | ||
| 33 | ChangeSetName => 'MyChangeSetNameOrId', # OPTIONAL | ||
| 34 | StackName => 'MyStackName', # OPTIONAL | ||
| 35 | TemplateStage => 'Original', # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $StagesAvailable = $GetTemplateOutput->StagesAvailable; | ||
| 40 | my $TemplateBody = $GetTemplateOutput->TemplateBody; | ||
| 41 | |||
| 42 | # Returns a L<Paws::CloudFormation::GetTemplateOutput> object. | ||
| 43 | |||
| 44 | 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. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloudformation/GetTemplate> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 ChangeSetName => Str | ||
| 51 | |||
| 52 | The name or Amazon Resource Name (ARN) of a change set for which AWS | ||
| 53 | CloudFormation returns the associated template. If you specify a name, | ||
| 54 | you must also specify the C<StackName>. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 StackName => Str | ||
| 59 | |||
| 60 | The name or the unique stack ID that is associated with the stack, | ||
| 61 | which are not always interchangeable: | ||
| 62 | |||
| 63 | =over | ||
| 64 | |||
| 65 | =item * | ||
| 66 | |||
| 67 | Running stacks: You can specify either the stack's name or its unique | ||
| 68 | stack ID. | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | Deleted stacks: You must specify the unique stack ID. | ||
| 73 | |||
| 74 | =back | ||
| 75 | |||
| 76 | Default: There is no default value. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 TemplateStage => Str | ||
| 81 | |||
| 82 | For templates that include transforms, the stage of the template that | ||
| 83 | AWS CloudFormation returns. To get the user-submitted template, specify | ||
| 84 | C<Original>. To get the template after AWS CloudFormation has processed | ||
| 85 | all transforms, specify C<Processed>. | ||
| 86 | |||
| 87 | If the template doesn't include transforms, C<Original> and | ||
| 88 | C<Processed> return the same template. By default, AWS CloudFormation | ||
| 89 | specifies C<Processed>. | ||
| 90 | |||
| 91 | Valid values are: C<"Original">, C<"Processed"> | ||
| 92 | |||
| 93 | |||
| 94 | =head1 SEE ALSO | ||
| 95 | |||
| 96 | This class forms part of L<Paws>, documenting arguments for method GetTemplate in L<Paws::CloudFormation> | ||
| 97 | |||
| 98 | =head1 BUGS and CONTRIBUTIONS | ||
| 99 | |||
| 100 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 101 | |||
| 102 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 103 | |||
| 104 | =cut | ||
| 105 | |||