« blib/lib/Paws/Lightsail/ContainerMap.pm
↑ Summary
blib/lib/Paws/Lightsail/ContainerServiceDeployment.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Lightsail::ContainerService; | ||
| 3 | use Moose; | ||
| 4 | has Arn => (is => 'ro', isa => 'Str', request_name => 'arn', traits => ['NameInRequest']); | ||
| 5 | has ContainerServiceName => (is => 'ro', isa => 'Str', request_name => 'containerServiceName', traits => ['NameInRequest']); | ||
| 6 | has CreatedAt => (is => 'ro', isa => 'Str', request_name => 'createdAt', traits => ['NameInRequest']); | ||
| 7 | has CurrentDeployment => (is => 'ro', isa => 'Paws::Lightsail::ContainerServiceDeployment', request_name => 'currentDeployment', traits => ['NameInRequest']); | ||
| 8 | has IsDisabled => (is => 'ro', isa => 'Bool', request_name => 'isDisabled', traits => ['NameInRequest']); | ||
| 9 | has Location => (is => 'ro', isa => 'Paws::Lightsail::ResourceLocation', request_name => 'location', traits => ['NameInRequest']); | ||
| 10 | has NextDeployment => (is => 'ro', isa => 'Paws::Lightsail::ContainerServiceDeployment', request_name => 'nextDeployment', traits => ['NameInRequest']); | ||
| 11 | has Power => (is => 'ro', isa => 'Str', request_name => 'power', traits => ['NameInRequest']); | ||
| 12 | has PowerId => (is => 'ro', isa => 'Str', request_name => 'powerId', traits => ['NameInRequest']); | ||
| 13 | has PrincipalArn => (is => 'ro', isa => 'Str', request_name => 'principalArn', traits => ['NameInRequest']); | ||
| 14 | has PrivateDomainName => (is => 'ro', isa => 'Str', request_name => 'privateDomainName', traits => ['NameInRequest']); | ||
| 15 | has PublicDomainNames => (is => 'ro', isa => 'Paws::Lightsail::ContainerServicePublicDomains', request_name => 'publicDomainNames', traits => ['NameInRequest']); | ||
| 16 | has ResourceType => (is => 'ro', isa => 'Str', request_name => 'resourceType', traits => ['NameInRequest']); | ||
| 17 | has Scale => (is => 'ro', isa => 'Int', request_name => 'scale', traits => ['NameInRequest']); | ||
| 18 | has State => (is => 'ro', isa => 'Str', request_name => 'state', traits => ['NameInRequest']); | ||
| 19 | has StateDetail => (is => 'ro', isa => 'Paws::Lightsail::ContainerServiceStateDetail', request_name => 'stateDetail', traits => ['NameInRequest']); | ||
| 20 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Lightsail::Tag]', request_name => 'tags', traits => ['NameInRequest']); | ||
| 21 | has Url => (is => 'ro', isa => 'Str', request_name => 'url', traits => ['NameInRequest']); | ||
| 22 | |||
| 23 | 1; | ||
| 24 | |||
| 25 | ### main pod documentation begin ### | ||
| 26 | |||
| 27 | =head1 NAME | ||
| 28 | |||
| 29 | Paws::Lightsail::ContainerService | ||
| 30 | |||
| 31 | =head1 USAGE | ||
| 32 | |||
| 33 | This class represents one of two things: | ||
| 34 | |||
| 35 | =head3 Arguments in a call to a service | ||
| 36 | |||
| 37 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 38 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 39 | |||
| 40 | As an example, if Att1 is expected to be a Paws::Lightsail::ContainerService object: | ||
| 41 | |||
| 42 | $service_obj->Method(Att1 => { Arn => $value, ..., Url => $value }); | ||
| 43 | |||
| 44 | =head3 Results returned from an API call | ||
| 45 | |||
| 46 | Use accessors for each attribute. If Att1 is expected to be an Paws::Lightsail::ContainerService object: | ||
| 47 | |||
| 48 | $result = $service_obj->Method(...); | ||
| 49 | $result->Att1->Arn | ||
| 50 | |||
| 51 | =head1 DESCRIPTION | ||
| 52 | |||
| 53 | Describes an Amazon Lightsail container service. | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 Arn => Str | ||
| 59 | |||
| 60 | The Amazon Resource Name (ARN) of the container service. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 ContainerServiceName => Str | ||
| 64 | |||
| 65 | The name of the container service. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 CreatedAt => Str | ||
| 69 | |||
| 70 | The timestamp when the container service was created. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 CurrentDeployment => L<Paws::Lightsail::ContainerServiceDeployment> | ||
| 74 | |||
| 75 | An object that describes the current container deployment of the | ||
| 76 | container service. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 IsDisabled => Bool | ||
| 80 | |||
| 81 | A Boolean value indicating whether the container service is disabled. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 Location => L<Paws::Lightsail::ResourceLocation> | ||
| 85 | |||
| 86 | An object that describes the location of the container service, such as | ||
| 87 | the AWS Region and Availability Zone. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 NextDeployment => L<Paws::Lightsail::ContainerServiceDeployment> | ||
| 91 | |||
| 92 | An object that describes the next deployment of the container service. | ||
| 93 | |||
| 94 | This value is C<null> when there is no deployment in a C<pending> | ||
| 95 | state. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 Power => Str | ||
| 99 | |||
| 100 | The power specification of the container service. | ||
| 101 | |||
| 102 | The power specifies the amount of RAM, the number of vCPUs, and the | ||
| 103 | base price of the container service. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 PowerId => Str | ||
| 107 | |||
| 108 | The ID of the power of the container service. | ||
| 109 | |||
| 110 | |||
| 111 | =head2 PrincipalArn => Str | ||
| 112 | |||
| 113 | The principal ARN of the container service. | ||
| 114 | |||
| 115 | The principal ARN can be used to create a trust relationship between | ||
| 116 | your standard AWS account and your Lightsail container service. This | ||
| 117 | allows you to give your service permission to access resources in your | ||
| 118 | standard AWS account. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 PrivateDomainName => Str | ||
| 122 | |||
| 123 | The private domain name of the container service. | ||
| 124 | |||
| 125 | The private domain name is accessible only by other resources within | ||
| 126 | the default virtual private cloud (VPC) of your Lightsail account. | ||
| 127 | |||
| 128 | |||
| 129 | =head2 PublicDomainNames => L<Paws::Lightsail::ContainerServicePublicDomains> | ||
| 130 | |||
| 131 | The public domain name of the container service, such as C<example.com> | ||
| 132 | and C<www.example.com>. | ||
| 133 | |||
| 134 | You can specify up to four public domain names for a container service. | ||
| 135 | The domain names that you specify are used when you create a deployment | ||
| 136 | with a container configured as the public endpoint of your container | ||
| 137 | service. | ||
| 138 | |||
| 139 | If you don't specify public domain names, then you can use the default | ||
| 140 | domain of the container service. | ||
| 141 | |||
| 142 | You must create and validate an SSL/TLS certificate before you can use | ||
| 143 | public domain names with your container service. Use the | ||
| 144 | C<CreateCertificate> action to create a certificate for the public | ||
| 145 | domain names you want to use with your container service. | ||
| 146 | |||
| 147 | See C<CreateContainerService> or C<UpdateContainerService> for | ||
| 148 | information about how to specify public domain names for your Lightsail | ||
| 149 | container service. | ||
| 150 | |||
| 151 | |||
| 152 | =head2 ResourceType => Str | ||
| 153 | |||
| 154 | The Lightsail resource type of the container service (i.e., | ||
| 155 | C<ContainerService>). | ||
| 156 | |||
| 157 | |||
| 158 | =head2 Scale => Int | ||
| 159 | |||
| 160 | The scale specification of the container service. | ||
| 161 | |||
| 162 | The scale specifies the allocated compute nodes of the container | ||
| 163 | service. | ||
| 164 | |||
| 165 | |||
| 166 | =head2 State => Str | ||
| 167 | |||
| 168 | The current state of the container service. | ||
| 169 | |||
| 170 | The following container service states are possible: | ||
| 171 | |||
| 172 | =over | ||
| 173 | |||
| 174 | =item * | ||
| 175 | |||
| 176 | C<PENDING> - The container service is being created. | ||
| 177 | |||
| 178 | =item * | ||
| 179 | |||
| 180 | C<READY> - The container service is running but it does not have an | ||
| 181 | active container deployment. | ||
| 182 | |||
| 183 | =item * | ||
| 184 | |||
| 185 | C<DEPLOYING> - The container service is launching a container | ||
| 186 | deployment. | ||
| 187 | |||
| 188 | =item * | ||
| 189 | |||
| 190 | C<RUNNING> - The container service is running and it has an active | ||
| 191 | container deployment. | ||
| 192 | |||
| 193 | =item * | ||
| 194 | |||
| 195 | C<UPDATING> - The container service capacity or its custom domains are | ||
| 196 | being updated. | ||
| 197 | |||
| 198 | =item * | ||
| 199 | |||
| 200 | C<DELETING> - The container service is being deleted. | ||
| 201 | |||
| 202 | =item * | ||
| 203 | |||
| 204 | C<DISABLED> - The container service is disabled, and its active | ||
| 205 | deployment and containers, if any, are shut down. | ||
| 206 | |||
| 207 | =back | ||
| 208 | |||
| 209 | |||
| 210 | |||
| 211 | =head2 StateDetail => L<Paws::Lightsail::ContainerServiceStateDetail> | ||
| 212 | |||
| 213 | An object that describes the current state of the container service. | ||
| 214 | |||
| 215 | The state detail is populated only when a container service is in a | ||
| 216 | C<PENDING>, C<DEPLOYING>, or C<UPDATING> state. | ||
| 217 | |||
| 218 | |||
| 219 | =head2 Tags => ArrayRef[L<Paws::Lightsail::Tag>] | ||
| 220 | |||
| 221 | The tag keys and optional values for the resource. For more information | ||
| 222 | about tags in Lightsail, see the Lightsail Dev Guide | ||
| 223 | (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). | ||
| 224 | |||
| 225 | |||
| 226 | =head2 Url => Str | ||
| 227 | |||
| 228 | The publicly accessible URL of the container service. | ||
| 229 | |||
| 230 | If no public endpoint is specified in the C<currentDeployment>, this | ||
| 231 | URL returns a 404 response. | ||
| 232 | |||
| 233 | |||
| 234 | |||
| 235 | =head1 SEE ALSO | ||
| 236 | |||
| 237 | This class forms part of L<Paws>, describing an object used in L<Paws::Lightsail> | ||
| 238 | |||
| 239 | =head1 BUGS and CONTRIBUTIONS | ||
| 240 | |||
| 241 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 242 | |||
| 243 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 244 | |||
| 245 | =cut | ||
| 246 |