blib/lib/Paws/EC2/StopInstances.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/EC2/StateReason.pm ↑ Summary blib/lib/Paws/EC2/StopInstancesResult.pm »
1  
2 package Paws::EC2::StopInstances;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' );
5 1 has Force => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'force' );
6 1 has Hibernate => (is => 'ro', isa => 'Bool');
7 1 has InstanceIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'InstanceId' , required => 1);
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 => 'StopInstances');
12 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::StopInstancesResult');
13 1 class_has _result_key => (isa => 'Str', is => 'ro');
14 1 1;
15  
16 ### main pod documentation begin ###
17  
18 =head1 NAME
19  
20 Paws::EC2::StopInstances - Arguments for method StopInstances on L<Paws::EC2>
21  
22 =head1 DESCRIPTION
23  
24 This class represents the parameters used for calling the method StopInstances on the
25 L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class
26 as arguments to method StopInstances.
27  
28 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StopInstances.
29  
30 =head1 SYNOPSIS
31  
32 my $ec2 = Paws->service('EC2');
33 # To stop a running EC2 instance
34 # This example stops the specified EC2 instance.
35 my $StopInstancesResult =
36 $ec2->StopInstances( 'InstanceIds' => ['i-1234567890abcdef0'] );
37  
38 # Results:
39 my $StoppingInstances = $StopInstancesResult->StoppingInstances;
40  
41 # Returns a L<Paws::EC2::StopInstancesResult> object.
42  
43 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.
44 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/StopInstances>
45  
46 =head1 ATTRIBUTES
47  
48  
49 =head2 DryRun => Bool
50  
51 Checks whether you have the required permissions for the action,
52 without actually making the request, and provides an error response. If
53 you have the required permissions, the error response is
54 C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
55  
56  
57  
58 =head2 Force => Bool
59  
60 Forces the instances to stop. The instances do not have an opportunity
61 to flush file system caches or file system metadata. If you use this
62 option, you must perform file system check and repair procedures. This
63 option is not recommended for Windows instances.
64  
65 Default: C<false>
66  
67  
68  
69 =head2 Hibernate => Bool
70  
71 Hibernates the instance if the instance was enabled for hibernation at
72 launch. If the instance cannot hibernate successfully, a normal
73 shutdown occurs. For more information, see Hibernate your instance
74 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in
75 the I<Amazon EC2 User Guide>.
76  
77 Default: C<false>
78  
79  
80  
81 =head2 B<REQUIRED> InstanceIds => ArrayRef[Str|Undef]
82  
83 The IDs of the instances.
84  
85  
86  
87  
88 =head1 SEE ALSO
89  
90 This class forms part of L<Paws>, documenting arguments for method StopInstances in L<Paws::EC2>
91  
92 =head1 BUGS and CONTRIBUTIONS
93  
94 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
95  
96 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
97  
98 =cut
99  
« blib/lib/Paws/EC2/StateReason.pm ↑ Summary blib/lib/Paws/EC2/StopInstancesResult.pm »