blib/lib/Paws/Lightsail/CreateContainerService.pm untested

filter: Statementstmt 0.0% 0 / 21 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 23 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Lightsail::CreateContainerService;
3 use Moose;
4 has Deployment => (is => 'ro', isa => 'Paws::Lightsail::ContainerServiceDeploymentRequest', traits => ['NameInRequest'], request_name => 'deployment' );
5 has Power => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'power' , required => 1);
6 has PublicDomainNames => (is => 'ro', isa => 'Paws::Lightsail::ContainerServicePublicDomains', traits => ['NameInRequest'], request_name => 'publicDomainNames' );
7 has Scale => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'scale' , required => 1);
8 has ServiceName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'serviceName' , required => 1);
9 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Lightsail::Tag]', traits => ['NameInRequest'], request_name => 'tags' );
10  
11 use MooseX::ClassAttribute;
12  
13 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateContainerService');
14 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Lightsail::CreateContainerServiceResult');
15 class_has _result_key => (isa => 'Str', is => 'ro');
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::Lightsail::CreateContainerService - Arguments for method CreateContainerService on L<Paws::Lightsail>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method CreateContainerService on the
27 L<Amazon Lightsail|Paws::Lightsail> service. Use the attributes of this class
28 as arguments to method CreateContainerService.
29  
30 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateContainerService.
31  
32 =head1 SYNOPSIS
33  
34 my $lightsail = Paws->service('Lightsail');
35 my $CreateContainerServiceResult = $lightsail->CreateContainerService(
36 Power => 'nano',
37 Scale => 1,
38 ServiceName => 'MyContainerServiceName',
39 Deployment => {
40 Containers => {
41 'MyContainerName' => {
42 Command => [ 'Mystring', ... ], # OPTIONAL
43 Environment => { 'Mystring' => 'Mystring', }, # OPTIONAL
44 Image => 'Mystring',
45 Ports => {
46 'Mystring' => 'HTTP', # , value: values: HTTP, HTTPS, TCP, UDP
47 }, # OPTIONAL
48 }, # key: min: 1, max: 53
49 }, # OPTIONAL
50 PublicEndpoint => {
51 ContainerName => 'Mystring',
52 ContainerPort => 1,
53 HealthCheck => {
54 HealthyThreshold => 1,
55 IntervalSeconds => 1,
56 Path => 'Mystring',
57 SuccessCodes => 'Mystring',
58 TimeoutSeconds => 1,
59 UnhealthyThreshold => 1,
60 }, # OPTIONAL
61 }, # OPTIONAL
62 }, # OPTIONAL
63 PublicDomainNames => { 'Mystring' => [ 'Mystring', ... ], }, # OPTIONAL
64 Tags => [
65 {
66 Key => 'MyTagKey', # OPTIONAL
67 Value => 'MyTagValue', # OPTIONAL
68 },
69 ...
70 ], # OPTIONAL
71 );
72  
73 # Results:
74 my $ContainerService = $CreateContainerServiceResult->ContainerService;
75  
76 # Returns a L<Paws::Lightsail::CreateContainerServiceResult> object.
77  
78 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.
79 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lightsail/CreateContainerService>
80  
81 =head1 ATTRIBUTES
82  
83  
84 =head2 Deployment => L<Paws::Lightsail::ContainerServiceDeploymentRequest>
85  
86 An object that describes a deployment for the container service.
87  
88 A deployment specifies the containers that will be launched on the
89 container service and their settings, such as the ports to open, the
90 environment variables to apply, and the launch command to run. It also
91 specifies the container that will serve as the public endpoint of the
92 deployment and its settings, such as the HTTP or HTTPS port to use, and
93 the health check configuration.
94  
95  
96  
97 =head2 B<REQUIRED> Power => Str
98  
99 The power specification for the container service.
100  
101 The power specifies the amount of memory, vCPUs, and base monthly cost
102 of each node of the container service. The C<power> and C<scale> of a
103 container service makes up its configured capacity. To determine the
104 monthly price of your container service, multiply the base price of the
105 C<power> with the C<scale> (the number of nodes) of the service.
106  
107 Use the C<GetContainerServicePowers> action to get a list of power
108 options that you can specify using this parameter, and their base
109 monthly cost.
110  
111 Valid values are: C<"nano">, C<"micro">, C<"small">, C<"medium">, C<"large">, C<"xlarge">
112  
113 =head2 PublicDomainNames => L<Paws::Lightsail::ContainerServicePublicDomains>
114  
115 The public domain names to use with the container service, such as
116 C<example.com> and C<www.example.com>.
117  
118 You can specify up to four public domain names for a container service.
119 The domain names that you specify are used when you create a deployment
120 with a container configured as the public endpoint of your container
121 service.
122  
123 If you don't specify public domain names, then you can use the default
124 domain of the container service.
125  
126 You must create and validate an SSL/TLS certificate before you can use
127 public domain names with your container service. Use the
128 C<CreateCertificate> action to create a certificate for the public
129 domain names you want to use with your container service.
130  
131 You can specify public domain names using a string to array map as
132 shown in the example later on this page.
133  
134  
135  
136 =head2 B<REQUIRED> Scale => Int
137  
138 The scale specification for the container service.
139  
140 The scale specifies the allocated compute nodes of the container
141 service. The C<power> and C<scale> of a container service makes up its
142 configured capacity. To determine the monthly price of your container
143 service, multiply the base price of the C<power> with the C<scale> (the
144 number of nodes) of the service.
145  
146  
147  
148 =head2 B<REQUIRED> ServiceName => Str
149  
150 The name for the container service.
151  
152 The name that you specify for your container service will make up part
153 of its default domain. The default domain of a container service is
154 typically
155 C<https://E<lt>ServiceNameE<gt>.E<lt>RandomGUIDE<gt>.E<lt>AWSRegionE<gt>.cs.amazonlightsail.com>.
156 If the name of your container service is C<container-service-1>, and
157 it's located in the US East (Ohio) AWS region (C<us-east-2>), then the
158 domain for your container service will be like the following example:
159 C<https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com>
160  
161 The following are the requirements for container service names:
162  
163 =over
164  
165 =item *
166  
167 Must be unique within each AWS Region in your Lightsail account.
168  
169 =item *
170  
171 Must contain 1 to 63 characters.
172  
173 =item *
174  
175 Must contain only alphanumeric characters and hyphens.
176  
177 =item *
178  
179 A hyphen (-) can separate words but cannot be at the start or end of
180 the name.
181  
182 =back
183  
184  
185  
186  
187 =head2 Tags => ArrayRef[L<Paws::Lightsail::Tag>]
188  
189 The tag keys and optional values for the container service.
190  
191 For more information about tags in Lightsail, see the Lightsail Dev
192 Guide
193 (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags).
194  
195  
196  
197  
198 =head1 SEE ALSO
199  
200 This class forms part of L<Paws>, documenting arguments for method CreateContainerService in L<Paws::Lightsail>
201  
202 =head1 BUGS and CONTRIBUTIONS
203  
204 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
205  
206 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
207  
208 =cut
209