blib/lib/Paws/ElasticBeanstalk/TerminateEnvironment.pm

filter: Statementstmt 100% 14 / 14 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 16 / 16 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/ElasticBeanstalk/SourceBuildInformation.pm ↑ Summary blib/lib/Paws/ElasticBeanstalk/UpdateApplication.pm »
1  
2 package Paws::ElasticBeanstalk::TerminateEnvironment;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has EnvironmentId => (is => 'ro', isa => 'Str');
5 1 has EnvironmentName => (is => 'ro', isa => 'Str');
6 1 has ForceTerminate => (is => 'ro', isa => 'Bool');
7 1 has TerminateResources => (is => 'ro', isa => 'Bool');
8  
9 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
10  
11 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'TerminateEnvironment');
12 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ElasticBeanstalk::EnvironmentDescription');
13 1 class_has _result_key => (isa => 'Str', is => 'ro', default => 'TerminateEnvironmentResult');
14 1 1;
15  
16 ### main pod documentation begin ###
17  
18 =head1 NAME
19  
20 Paws::ElasticBeanstalk::TerminateEnvironment - Arguments for method TerminateEnvironment on L<Paws::ElasticBeanstalk>
21  
22 =head1 DESCRIPTION
23  
24 This class represents the parameters used for calling the method TerminateEnvironment on the
25 L<AWS Elastic Beanstalk|Paws::ElasticBeanstalk> 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 =head1 SYNOPSIS
31  
32 my $elasticbeanstalk = Paws->service('ElasticBeanstalk');
33 # To terminate an environment
34 # The following operation terminates an Elastic Beanstalk environment named
35 # my-env:
36 my $EnvironmentDescription =
37 $elasticbeanstalk->TerminateEnvironment( 'EnvironmentName' => 'my-env' );
38  
39 # Results:
40 my $AbortableOperationInProgress =
41 $EnvironmentDescription->AbortableOperationInProgress;
42 my $ApplicationName = $EnvironmentDescription->ApplicationName;
43 my $CNAME = $EnvironmentDescription->CNAME;
44 my $DateCreated = $EnvironmentDescription->DateCreated;
45 my $DateUpdated = $EnvironmentDescription->DateUpdated;
46 my $EndpointURL = $EnvironmentDescription->EndpointURL;
47 my $EnvironmentId = $EnvironmentDescription->EnvironmentId;
48 my $EnvironmentName = $EnvironmentDescription->EnvironmentName;
49 my $Health = $EnvironmentDescription->Health;
50 my $SolutionStackName = $EnvironmentDescription->SolutionStackName;
51 my $Status = $EnvironmentDescription->Status;
52 my $Tier = $EnvironmentDescription->Tier;
53  
54 # Returns a L<Paws::ElasticBeanstalk::EnvironmentDescription> object.
55  
56 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.
57 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk/TerminateEnvironment>
58  
59 =head1 ATTRIBUTES
60  
61  
62 =head2 EnvironmentId => Str
63  
64 The ID of the environment to terminate.
65  
66 Condition: You must specify either this or an EnvironmentName, or both.
67 If you do not specify either, AWS Elastic Beanstalk returns
68 C<MissingRequiredParameter> error.
69  
70  
71  
72 =head2 EnvironmentName => Str
73  
74 The name of the environment to terminate.
75  
76 Condition: You must specify either this or an EnvironmentId, or both.
77 If you do not specify either, AWS Elastic Beanstalk returns
78 C<MissingRequiredParameter> error.
79  
80  
81  
82 =head2 ForceTerminate => Bool
83  
84 Terminates the target environment even if another environment in the
85 same group is dependent on it.
86  
87  
88  
89 =head2 TerminateResources => Bool
90  
91 Indicates whether the associated AWS resources should shut down when
92 the environment is terminated:
93  
94 =over
95  
96 =item *
97  
98 C<true>: The specified environment as well as the associated AWS
99 resources, such as Auto Scaling group and LoadBalancer, are terminated.
100  
101 =item *
102  
103 C<false>: AWS Elastic Beanstalk resource management is removed from the
104 environment, but the AWS resources continue to operate.
105  
106 =back
107  
108 For more information, see the AWS Elastic Beanstalk User Guide.
109 (https://docs.aws.amazon.com/elasticbeanstalk/latest/ug/)
110  
111 Default: C<true>
112  
113 Valid Values: C<true> | C<false>
114  
115  
116  
117  
118 =head1 SEE ALSO
119  
120 This class forms part of L<Paws>, documenting arguments for method TerminateEnvironment in L<Paws::ElasticBeanstalk>
121  
122 =head1 BUGS and CONTRIBUTIONS
123  
124 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
125  
126 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
127  
128 =cut
129  
« blib/lib/Paws/ElasticBeanstalk/SourceBuildInformation.pm ↑ Summary blib/lib/Paws/ElasticBeanstalk/UpdateApplication.pm »