File Coverage

blib/lib/Paws/ElasticBeanstalk/TerminateEnvironment.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::ElasticBeanstalk::TerminateEnvironment;
3 1     1   395 use Moose;
  1     1   3  
  1         7  
  1         314  
  1         2  
  1         6  
4             has EnvironmentId => (is => 'ro', isa => 'Str');
5             has EnvironmentName => (is => 'ro', isa => 'Str');
6             has ForceTerminate => (is => 'ro', isa => 'Bool');
7             has TerminateResources => (is => 'ro', isa => 'Bool');
8              
9 1     1   6183 use MooseX::ClassAttribute;
  1     1   4  
  1         9  
  1         5546  
  1         2  
  1         8  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'TerminateEnvironment');
12             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ElasticBeanstalk::EnvironmentDescription');
13             class_has _result_key => (isa => 'Str', is => 'ro', default => 'TerminateEnvironmentResult');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::ElasticBeanstalk::TerminateEnvironment - Arguments for method TerminateEnvironment on Paws::ElasticBeanstalk
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method TerminateEnvironment on the
25             AWS Elastic Beanstalk service. Use the attributes of this class
26             as arguments to method TerminateEnvironment.
27              
28             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to TerminateEnvironment.
29              
30             As an example:
31              
32             $service_obj->TerminateEnvironment(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 EnvironmentId => Str
40              
41             The ID of the environment to terminate.
42              
43             Condition: You must specify either this or an EnvironmentName, or both.
44             If you do not specify either, AWS Elastic Beanstalk returns
45             C<MissingRequiredParameter> error.
46              
47              
48              
49             =head2 EnvironmentName => Str
50              
51             The name of the environment to terminate.
52              
53             Condition: You must specify either this or an EnvironmentId, or both.
54             If you do not specify either, AWS Elastic Beanstalk returns
55             C<MissingRequiredParameter> error.
56              
57              
58              
59             =head2 ForceTerminate => Bool
60              
61             Terminates the target environment even if another environment in the
62             same group is dependent on it.
63              
64              
65              
66             =head2 TerminateResources => Bool
67              
68             Indicates whether the associated AWS resources should shut down when
69             the environment is terminated:
70              
71             =over
72              
73             =item *
74              
75             C<true>: The specified environment as well as the associated AWS
76             resources, such as Auto Scaling group and LoadBalancer, are terminated.
77              
78             =item *
79              
80             C<false>: AWS Elastic Beanstalk resource management is removed from the
81             environment, but the AWS resources continue to operate.
82              
83             =back
84              
85             For more information, see the AWS Elastic Beanstalk User Guide.
86              
87             Default: C<true>
88              
89             Valid Values: C<true> | C<false>
90              
91              
92              
93              
94             =head1 SEE ALSO
95              
96             This class forms part of L<Paws>, documenting arguments for method TerminateEnvironment in L<Paws::ElasticBeanstalk>
97              
98             =head1 BUGS and CONTRIBUTIONS
99              
100             The source code is located here: https://github.com/pplu/aws-sdk-perl
101              
102             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
103              
104             =cut
105