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

filter: Statementstmt 0.0% 0 / 19 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 21 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::SSM::CreateDocument;
3 use Moose;
4 has Attachments => (is => 'ro', isa => 'ArrayRef[Paws::SSM::AttachmentsSource]');
5 has Content => (is => 'ro', isa => 'Str', required => 1);
6 has DisplayName => (is => 'ro', isa => 'Str');
7 has DocumentFormat => (is => 'ro', isa => 'Str');
8 has DocumentType => (is => 'ro', isa => 'Str');
9 has Name => (is => 'ro', isa => 'Str', required => 1);
10 has Requires => (is => 'ro', isa => 'ArrayRef[Paws::SSM::DocumentRequires]');
11 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SSM::Tag]');
12 has TargetType => (is => 'ro', isa => 'Str');
13 has VersionName => (is => 'ro', isa => 'Str');
14  
15 use MooseX::ClassAttribute;
16  
17 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDocument');
18 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSM::CreateDocumentResult');
19 class_has _result_key => (isa => 'Str', is => 'ro');
20 1;
21  
22 ### main pod documentation begin ###
23  
24 =head1 NAME
25  
26 Paws::SSM::CreateDocument - Arguments for method CreateDocument on L<Paws::SSM>
27  
28 =head1 DESCRIPTION
29  
30 This class represents the parameters used for calling the method CreateDocument on the
31 L<Amazon Simple Systems Manager (SSM)|Paws::SSM> service. Use the attributes of this class
32 as arguments to method CreateDocument.
33  
34 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDocument.
35  
36 =head1 SYNOPSIS
37  
38 my $ssm = Paws->service('SSM');
39 my $CreateDocumentResult = $ssm->CreateDocument(
40 Content => 'MyDocumentContent',
41 Name => 'MyDocumentName',
42 Attachments => [
43 {
44 Key => 'SourceUrl'
45 , # values: SourceUrl, S3FileUrl, AttachmentReference; OPTIONAL
46 Name => 'MyAttachmentIdentifier', # OPTIONAL
47 Values => [
48 'MyAttachmentsSourceValue', ... # min: 1, max: 1024
49 ], # min: 1, max: 1; OPTIONAL
50 },
51 ...
52 ], # OPTIONAL
53 DisplayName => 'MyDocumentDisplayName', # OPTIONAL
54 DocumentFormat => 'YAML', # OPTIONAL
55 DocumentType => 'Command', # OPTIONAL
56 Requires => [
57 {
58 Name => 'MyDocumentARN',
59 Version => 'MyDocumentVersion', # OPTIONAL
60 },
61 ...
62 ], # OPTIONAL
63 Tags => [
64 {
65 Key => 'MyTagKey', # min: 1, max: 128
66 Value => 'MyTagValue', # min: 1, max: 256
67  
68 },
69 ...
70 ], # OPTIONAL
71 TargetType => 'MyTargetType', # OPTIONAL
72 VersionName => 'MyDocumentVersionName', # OPTIONAL
73 );
74  
75 # Results:
76 my $DocumentDescription = $CreateDocumentResult->DocumentDescription;
77  
78 # Returns a L<Paws::SSM::CreateDocumentResult> object.
79  
80 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.
81 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm/CreateDocument>
82  
83 =head1 ATTRIBUTES
84  
85  
86 =head2 Attachments => ArrayRef[L<Paws::SSM::AttachmentsSource>]
87  
88 A list of key and value pairs that describe attachments to a version of
89 a document.
90  
91  
92  
93 =head2 B<REQUIRED> Content => Str
94  
95 The content for the new SSM document in JSON or YAML format. We
96 recommend storing the contents for your new document in an external
97 JSON or YAML file and referencing the file in a command.
98  
99 For examples, see the following topics in the I<AWS Systems Manager
100 User Guide>.
101  
102 =over
103  
104 =item *
105  
106 Create an SSM document (AWS API)
107 (https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-api.html)
108  
109 =item *
110  
111 Create an SSM document (AWS CLI)
112 (https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-cli.html)
113  
114 =item *
115  
116 Create an SSM document (API)
117 (https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-api.html)
118  
119 =back
120  
121  
122  
123  
124 =head2 DisplayName => Str
125  
126 An optional field where you can specify a friendly name for the Systems
127 Manager document. This value can differ for each version of the
128 document. You can update this value at a later time using the
129 UpdateDocument action.
130  
131  
132  
133 =head2 DocumentFormat => Str
134  
135 Specify the document format for the request. The document format can be
136 JSON, YAML, or TEXT. JSON is the default format.
137  
138 Valid values are: C<"YAML">, C<"JSON">, C<"TEXT">
139  
140 =head2 DocumentType => Str
141  
142 The type of document to create.
143  
144 Valid values are: C<"Command">, C<"Policy">, C<"Automation">, C<"Session">, C<"Package">, C<"ApplicationConfiguration">, C<"ApplicationConfigurationSchema">, C<"DeploymentStrategy">, C<"ChangeCalendar">, C<"Automation.ChangeTemplate">, C<"ProblemAnalysis">, C<"ProblemAnalysisTemplate">
145  
146 =head2 B<REQUIRED> Name => Str
147  
148 A name for the Systems Manager document.
149  
150 You can't use the following strings as document name prefixes. These
151 are reserved by AWS for use as document name prefixes:
152  
153 =over
154  
155 =item *
156  
157 C<aws->
158  
159 =item *
160  
161 C<amazon>
162  
163 =item *
164  
165 C<amzn>
166  
167 =back
168  
169  
170  
171  
172 =head2 Requires => ArrayRef[L<Paws::SSM::DocumentRequires>]
173  
174 A list of SSM documents required by a document. This parameter is used
175 exclusively by AWS AppConfig. When a user creates an AppConfig
176 configuration in an SSM document, the user must also specify a required
177 document for validation purposes. In this case, an
178 C<ApplicationConfiguration> document requires an
179 C<ApplicationConfigurationSchema> document for validation purposes. For
180 more information, see AWS AppConfig
181 (https://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig.html)
182 in the I<AWS Systems Manager User Guide>.
183  
184  
185  
186 =head2 Tags => ArrayRef[L<Paws::SSM::Tag>]
187  
188 Optional metadata that you assign to a resource. Tags enable you to
189 categorize a resource in different ways, such as by purpose, owner, or
190 environment. For example, you might want to tag an SSM document to
191 identify the types of targets or the environment where it will run. In
192 this case, you could specify the following key name/value pairs:
193  
194 =over
195  
196 =item *
197  
198 C<Key=OS,Value=Windows>
199  
200 =item *
201  
202 C<Key=Environment,Value=Production>
203  
204 =back
205  
206 To add tags to an existing SSM document, use the AddTagsToResource
207 action.
208  
209  
210  
211 =head2 TargetType => Str
212  
213 Specify a target type to define the kinds of resources the document can
214 run on. For example, to run a document on EC2 instances, specify the
215 following value: /AWS::EC2::Instance. If you specify a value of '/' the
216 document can run on all types of resources. If you don't specify a
217 value, the document can't run on any resources. For a list of valid
218 resource types, see AWS resource and property types reference
219 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
220 in the I<AWS CloudFormation User Guide>.
221  
222  
223  
224 =head2 VersionName => Str
225  
226 An optional field specifying the version of the artifact you are
227 creating with the document. For example, "Release 12, Update 6". This
228 value is unique across all versions of a document, and cannot be
229 changed.
230  
231  
232  
233  
234 =head1 SEE ALSO
235  
236 This class forms part of L<Paws>, documenting arguments for method CreateDocument in L<Paws::SSM>
237  
238 =head1 BUGS and CONTRIBUTIONS
239  
240 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
241  
242 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
243  
244 =cut
245