« blib/lib/Paws/CloudFormation/DeleteChangeSetOutput.pm
↑ Summary
blib/lib/Paws/CloudFormation/DeleteStackInstances.pm »
| 1 | |||
| 2 | package Paws::CloudFormation::DeleteStack; | ||
| 3 | use Moose; | ||
| 4 | has ClientRequestToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has RetainResources => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 6 | has RoleARN => (is => 'ro', isa => 'Str'); | ||
| 7 | has StackName => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DeleteStack'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::CloudFormation::DeleteStack - Arguments for method DeleteStack on L<Paws::CloudFormation> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DeleteStack on the | ||
| 25 | L<AWS CloudFormation|Paws::CloudFormation> service. Use the attributes of this class | ||
| 26 | as arguments to method DeleteStack. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteStack. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $cloudformation = Paws->service('CloudFormation'); | ||
| 33 | $cloudformation->DeleteStack( | ||
| 34 | StackName => 'MyStackName', | ||
| 35 | ClientRequestToken => 'MyClientRequestToken', # OPTIONAL | ||
| 36 | RetainResources => [ 'MyLogicalResourceId', ... ], # OPTIONAL | ||
| 37 | RoleARN => 'MyRoleARN', # OPTIONAL | ||
| 38 | ); | ||
| 39 | |||
| 40 | 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. | ||
| 41 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloudformation/DeleteStack> | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 ClientRequestToken => Str | ||
| 47 | |||
| 48 | A unique identifier for this C<DeleteStack> request. Specify this token | ||
| 49 | if you plan to retry requests so that AWS CloudFormation knows that | ||
| 50 | you're not attempting to delete a stack with the same name. You might | ||
| 51 | retry C<DeleteStack> requests to ensure that AWS CloudFormation | ||
| 52 | successfully received them. | ||
| 53 | |||
| 54 | All events triggered by a given stack operation are assigned the same | ||
| 55 | client request token, which you can use to track operations. For | ||
| 56 | example, if you execute a C<CreateStack> operation with the token | ||
| 57 | C<token1>, then all the C<StackEvents> generated by that operation will | ||
| 58 | have C<ClientRequestToken> set as C<token1>. | ||
| 59 | |||
| 60 | In the console, stack operations display the client request token on | ||
| 61 | the Events tab. Stack operations that are initiated from the console | ||
| 62 | use the token format I<Console-StackOperation-ID>, which helps you | ||
| 63 | easily identify the stack operation . For example, if you create a | ||
| 64 | stack using the console, each stack event would be assigned the same | ||
| 65 | token in the following format: | ||
| 66 | C<Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002>. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 RetainResources => ArrayRef[Str|Undef] | ||
| 71 | |||
| 72 | For stacks in the C<DELETE_FAILED> state, a list of resource logical | ||
| 73 | IDs that are associated with the resources you want to retain. During | ||
| 74 | deletion, AWS CloudFormation deletes the stack but does not delete the | ||
| 75 | retained resources. | ||
| 76 | |||
| 77 | Retaining resources is useful when you cannot delete a resource, such | ||
| 78 | as a non-empty S3 bucket, but you want to delete the stack. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 RoleARN => Str | ||
| 83 | |||
| 84 | The Amazon Resource Name (ARN) of an AWS Identity and Access Management | ||
| 85 | (IAM) role that AWS CloudFormation assumes to delete the stack. AWS | ||
| 86 | CloudFormation uses the role's credentials to make calls on your | ||
| 87 | behalf. | ||
| 88 | |||
| 89 | If you don't specify a value, AWS CloudFormation uses the role that was | ||
| 90 | previously associated with the stack. If no role is available, AWS | ||
| 91 | CloudFormation uses a temporary session that is generated from your | ||
| 92 | user credentials. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 B<REQUIRED> StackName => Str | ||
| 97 | |||
| 98 | The name or the unique stack ID that is associated with the stack. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head1 SEE ALSO | ||
| 104 | |||
| 105 | This class forms part of L<Paws>, documenting arguments for method DeleteStack in L<Paws::CloudFormation> | ||
| 106 | |||
| 107 | =head1 BUGS and CONTRIBUTIONS | ||
| 108 | |||
| 109 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 110 | |||
| 111 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 112 | |||
| 113 | =cut | ||
| 114 |