File Coverage

blib/lib/Paws/CloudFormation/DeleteStack.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::CloudFormation::DeleteStack;
3 1     1   332 use Moose;
  1         2  
  1         6  
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 1     1   5366 use MooseX::ClassAttribute;
  1         2  
  1         7  
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 Paws::CloudFormation
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method DeleteStack on the
25             AWS 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             As an example:
31              
32             $service_obj->DeleteStack(Att1 => $value1, Att2 => $value2, ...);
33              
34             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.
35              
36             =head1 ATTRIBUTES
37              
38              
39             =head2 ClientRequestToken => Str
40              
41             A unique identifier for this C<DeleteStack> request. Specify this token
42             if you plan to retry requests so that AWS CloudFormation knows that
43             you're not attempting to delete a stack with the same name. You might
44             retry C<DeleteStack> requests to ensure that AWS CloudFormation
45             successfully received them.
46              
47             All events triggered by a given stack operation are assigned the same
48             client request token, which you can use to track operations. For
49             example, if you execute a C<CreateStack> operation with the token
50             C<token1>, then all the C<StackEvents> generated by that operation will
51             have C<ClientRequestToken> set as C<token1>.
52              
53             In the console, stack operations display the client request token on
54             the Events tab. Stack operations that are initiated from the console
55             use the token format I<Console-StackOperation-ID>, which helps you
56             easily identify the stack operation . For example, if you create a
57             stack using the console, each stack event would be assigned the same
58             token in the following format:
59             C<Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002>.
60              
61              
62              
63             =head2 RetainResources => ArrayRef[Str|Undef]
64              
65             For stacks in the C<DELETE_FAILED> state, a list of resource logical
66             IDs that are associated with the resources you want to retain. During
67             deletion, AWS CloudFormation deletes the stack but does not delete the
68             retained resources.
69              
70             Retaining resources is useful when you cannot delete a resource, such
71             as a non-empty S3 bucket, but you want to delete the stack.
72              
73              
74              
75             =head2 RoleARN => Str
76              
77             The Amazon Resource Name (ARN) of an AWS Identity and Access Management
78             (IAM) role that AWS CloudFormation assumes to delete the stack. AWS
79             CloudFormation uses the role's credentials to make calls on your
80             behalf.
81              
82             If you don't specify a value, AWS CloudFormation uses the role that was
83             previously associated with the stack. If no role is available, AWS
84             CloudFormation uses a temporary session that is generated from your
85             user credentials.
86              
87              
88              
89             =head2 B<REQUIRED> StackName => Str
90              
91             The name or the unique stack ID that is associated with the stack.
92              
93              
94              
95              
96             =head1 SEE ALSO
97              
98             This class forms part of L<Paws>, documenting arguments for method DeleteStack in L<Paws::CloudFormation>
99              
100             =head1 BUGS and CONTRIBUTIONS
101              
102             The source code is located here: https://github.com/pplu/aws-sdk-perl
103              
104             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
105              
106             =cut
107