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   547 use Moose;
  1         3  
  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   6628 use MooseX::ClassAttribute;
  1         3  
  1         9  
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              
48              
49             =head2 RetainResources => ArrayRef[Str|Undef]
50              
51             For stacks in the C<DELETE_FAILED> state, a list of resource logical
52             IDs that are associated with the resources you want to retain. During
53             deletion, AWS CloudFormation deletes the stack but does not delete the
54             retained resources.
55              
56             Retaining resources is useful when you cannot delete a resource, such
57             as a non-empty S3 bucket, but you want to delete the stack.
58              
59              
60              
61             =head2 RoleARN => Str
62              
63             The Amazon Resource Name (ARN) of an AWS Identity and Access Management
64             (IAM) role that AWS CloudFormation assumes to delete the stack. AWS
65             CloudFormation uses the role's credentials to make calls on your
66             behalf.
67              
68             If you don't specify a value, AWS CloudFormation uses the role that was
69             previously associated with the stack. If no role is available, AWS
70             CloudFormation uses a temporary session that is generated from your
71             user credentials.
72              
73              
74              
75             =head2 B<REQUIRED> StackName => Str
76              
77             The name or the unique stack ID that is associated with the stack.
78              
79              
80              
81              
82             =head1 SEE ALSO
83              
84             This class forms part of L<Paws>, documenting arguments for method DeleteStack in L<Paws::CloudFormation>
85              
86             =head1 BUGS and CONTRIBUTIONS
87              
88             The source code is located here: https://github.com/pplu/aws-sdk-perl
89              
90             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
91              
92             =cut
93