class Aws::Lightsail::Types::ContainerService

Describes an Amazon Lightsail container service.

@!attribute [rw] container_service_name

The name of the container service.
@return [String]

@!attribute [rw] arn

The Amazon Resource Name (ARN) of the container service.
@return [String]

@!attribute [rw] created_at

The timestamp when the container service was created.
@return [Time]

@!attribute [rw] location

An object that describes the location of the container service, such
as the AWS Region and Availability Zone.
@return [Types::ResourceLocation]

@!attribute [rw] resource_type

The Lightsail resource type of the container service (i.e.,
`ContainerService`).
@return [String]

@!attribute [rw] tags

The tag keys and optional values for the resource. For more
information about tags in Lightsail, see the [Amazon Lightsail
Developer Guide][1].

[1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags
@return [Array<Types::Tag>]

@!attribute [rw] power

The power specification of the container service.

The power specifies the amount of RAM, the number of vCPUs, and the
base price of the container service.
@return [String]

@!attribute [rw] power_id

The ID of the power of the container service.
@return [String]

@!attribute [rw] state

The current state of the container service.

The following container service states are possible:

* `PENDING` - The container service is being created.

* `READY` - The container service is running but it does not have an
  active container deployment.

* `DEPLOYING` - The container service is launching a container
  deployment.

* `RUNNING` - The container service is running and it has an active
  container deployment.

* `UPDATING` - The container service capacity or its custom domains
  are being updated.

* `DELETING` - The container service is being deleted.

* `DISABLED` - The container service is disabled, and its active
  deployment and containers, if any, are shut down.
@return [String]

@!attribute [rw] state_detail

An object that describes the current state of the container service.

<note markdown="1"> The state detail is populated only when a container service is in a
`PENDING`, `DEPLOYING`, or `UPDATING` state.

 </note>
@return [Types::ContainerServiceStateDetail]

@!attribute [rw] scale

The scale specification of the container service.

The scale specifies the allocated compute nodes of the container
service.
@return [Integer]

@!attribute [rw] current_deployment

An object that describes the current container deployment of the
container service.
@return [Types::ContainerServiceDeployment]

@!attribute [rw] next_deployment

An object that describes the next deployment of the container
service.

This value is `null` when there is no deployment in a `pending`
state.
@return [Types::ContainerServiceDeployment]

@!attribute [rw] is_disabled

A Boolean value indicating whether the container service is
disabled.
@return [Boolean]

@!attribute [rw] principal_arn

The principal ARN of the container service.

The principal ARN can be used to create a trust relationship between
your standard AWS account and your Lightsail container service. This
allows you to give your service permission to access resources in
your standard AWS account.
@return [String]

@!attribute [rw] private_domain_name

The private domain name of the container service.

The private domain name is accessible only by other resources within
the default virtual private cloud (VPC) of your Lightsail account.
@return [String]

@!attribute [rw] public_domain_names

The public domain name of the container service, such as
`example.com` and `www.example.com`.

You can specify up to four public domain names for a container
service. The domain names that you specify are used when you create
a deployment with a container configured as the public endpoint of
your container service.

If you don't specify public domain names, then you can use the
default domain of the container service.

You must create and validate an SSL/TLS certificate before you can
use public domain names with your container service. Use the
`CreateCertificate` action to create a certificate for the public
domain names you want to use with your container service.

See `CreateContainerService` or `UpdateContainerService` for
information about how to specify public domain names for your
Lightsail container service.
@return [Hash<String,Array<String>>]

@!attribute [rw] url

The publicly accessible URL of the container service.

If no public endpoint is specified in the `currentDeployment`, this
URL returns a 404 response.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ContainerService AWS API Documentation

Constants

SENSITIVE