blib/lib/Paws/SSM/CreateActivation.pm untested

filter: Statementstmt 0.0% 0 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 17 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::SSM::CreateActivation;
3 use Moose;
4 has DefaultInstanceName => (is => 'ro', isa => 'Str');
5 has Description => (is => 'ro', isa => 'Str');
6 has ExpirationDate => (is => 'ro', isa => 'Str');
7 has IamRole => (is => 'ro', isa => 'Str', required => 1);
8 has RegistrationLimit => (is => 'ro', isa => 'Int');
9 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SSM::Tag]');
10  
11 use MooseX::ClassAttribute;
12  
13 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateActivation');
14 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSM::CreateActivationResult');
15 class_has _result_key => (isa => 'Str', is => 'ro');
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::SSM::CreateActivation - Arguments for method CreateActivation on L<Paws::SSM>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method CreateActivation on the
27 L<Amazon Simple Systems Manager (SSM)|Paws::SSM> service. Use the attributes of this class
28 as arguments to method CreateActivation.
29  
30 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateActivation.
31  
32 =head1 SYNOPSIS
33  
34 my $ssm = Paws->service('SSM');
35 my $CreateActivationResult = $ssm->CreateActivation(
36 IamRole => 'MyIamRole',
37 DefaultInstanceName => 'MyDefaultInstanceName', # OPTIONAL
38 Description => 'MyActivationDescription', # OPTIONAL
39 ExpirationDate => '1970-01-01T01:00:00', # OPTIONAL
40 RegistrationLimit => 1, # OPTIONAL
41 Tags => [
42 {
43 Key => 'MyTagKey', # min: 1, max: 128
44 Value => 'MyTagValue', # min: 1, max: 256
45  
46 },
47 ...
48 ], # OPTIONAL
49 );
50  
51 # Results:
52 my $ActivationCode = $CreateActivationResult->ActivationCode;
53 my $ActivationId = $CreateActivationResult->ActivationId;
54  
55 # Returns a L<Paws::SSM::CreateActivationResult> object.
56  
57 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.
58 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm/CreateActivation>
59  
60 =head1 ATTRIBUTES
61  
62  
63 =head2 DefaultInstanceName => Str
64  
65 The name of the registered, managed instance as it will appear in the
66 Systems Manager console or when you use the AWS command line tools to
67 list Systems Manager resources.
68  
69 Do not enter personally identifiable information in this field.
70  
71  
72  
73 =head2 Description => Str
74  
75 A user-defined description of the resource that you want to register
76 with Systems Manager.
77  
78 Do not enter personally identifiable information in this field.
79  
80  
81  
82 =head2 ExpirationDate => Str
83  
84 The date by which this activation request should expire, in timestamp
85 format, such as "2021-07-07T00:00:00". You can specify a date up to 30
86 days in advance. If you don't provide an expiration date, the
87 activation code expires in 24 hours.
88  
89  
90  
91 =head2 B<REQUIRED> IamRole => Str
92  
93 The Amazon Identity and Access Management (IAM) role that you want to
94 assign to the managed instance. This IAM role must provide AssumeRole
95 permissions for the Systems Manager service principal
96 C<ssm.amazonaws.com>. For more information, see Create an IAM service
97 role for a hybrid environment
98 (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html)
99 in the I<AWS Systems Manager User Guide>.
100  
101  
102  
103 =head2 RegistrationLimit => Int
104  
105 Specify the maximum number of managed instances you want to register.
106 The default value is 1 instance.
107  
108  
109  
110 =head2 Tags => ArrayRef[L<Paws::SSM::Tag>]
111  
112 Optional metadata that you assign to a resource. Tags enable you to
113 categorize a resource in different ways, such as by purpose, owner, or
114 environment. For example, you might want to tag an activation to
115 identify which servers or virtual machines (VMs) in your on-premises
116 environment you intend to activate. In this case, you could specify the
117 following key name/value pairs:
118  
119 =over
120  
121 =item *
122  
123 C<Key=OS,Value=Windows>
124  
125 =item *
126  
127 C<Key=Environment,Value=Production>
128  
129 =back
130  
131 When you install SSM Agent on your on-premises servers and VMs, you
132 specify an activation ID and code. When you specify the activation ID
133 and code, tags assigned to the activation are automatically applied to
134 the on-premises servers or VMs.
135  
136 You can't add tags to or delete tags from an existing activation. You
137 can tag your on-premises servers and VMs after they connect to Systems
138 Manager for the first time and are assigned a managed instance ID. This
139 means they are listed in the AWS Systems Manager console with an ID
140 that is prefixed with "mi-". For information about how to add tags to
141 your managed instances, see AddTagsToResource. For information about
142 how to remove tags from your managed instances, see
143 RemoveTagsFromResource.
144  
145  
146  
147  
148 =head1 SEE ALSO
149  
150 This class forms part of L<Paws>, documenting arguments for method CreateActivation in L<Paws::SSM>
151  
152 =head1 BUGS and CONTRIBUTIONS
153  
154 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
155  
156 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
157  
158 =cut
159