You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Lightsail::Types::ContainerService

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes an Amazon Lightsail container service.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the container service.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the container service.

#container_service_name ⇒ String

The name of the container service.

Returns:

  • (String) —

    The name of the container service.

#created_at ⇒ Time

The timestamp when the container service was created.

Returns:

  • (Time) —

    The timestamp when the container service was created.

#current_deployment ⇒ Types::ContainerServiceDeployment

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

Returns:

#is_disabled ⇒ Boolean

A Boolean value indicating whether the container service is disabled.

Returns:

  • (Boolean) —

    A Boolean value indicating whether the container service is disabled.

#location ⇒ Types::ResourceLocation

An object that describes the location of the container service, such as the AWS Region and Availability Zone.

Returns:

  • (Types::ResourceLocation) —

    An object that describes the location of the container service, such as the AWS Region and Availability Zone.

#next_deployment ⇒ Types::ContainerServiceDeployment

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

This value is null when there is no deployment in a pending state.

Returns:

#power ⇒ String

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.

Possible values:

  • nano
  • micro
  • small
  • medium
  • large
  • xlarge

Returns:

  • (String) —

    The power specification of the container service.

#power_id ⇒ String

The ID of the power of the container service.

Returns:

  • (String) —

    The ID of the power of the container service.

#principal_arn ⇒ String

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.

Returns:

  • (String) —

    The principal ARN of the container service.

#private_domain_name ⇒ String

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.

Returns:

  • (String) —

    The private domain name of the container service.

#public_domain_names ⇒ Hash<String,Array<String>>

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.

Returns:

  • (Hash<String,Array<String>>) —

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

#resource_type ⇒ String

The Lightsail resource type of the container service (i.e., ContainerService).

Possible values:

  • ContainerService
  • Instance
  • StaticIp
  • KeyPair
  • InstanceSnapshot
  • Domain
  • PeeredVpc
  • LoadBalancer
  • LoadBalancerTlsCertificate
  • Disk
  • DiskSnapshot
  • RelationalDatabase
  • RelationalDatabaseSnapshot
  • ExportSnapshotRecord
  • CloudFormationStackRecord
  • Alarm
  • ContactMethod
  • Distribution
  • Certificate

Returns:

  • (String) —

    The Lightsail resource type of the container service (i.e., ContainerService).

#scale ⇒ Integer

The scale specification of the container service.

The scale specifies the allocated compute nodes of the container service.

Returns:

  • (Integer) —

    The scale specification of the container service.

#state ⇒ String

The current state of the container service.

The state can be:

  • Pending - The container service is being created.

  • Ready - The container service is created but does not have a container deployment.

  • Disabled - The container service is disabled.

  • Updating - The container service capacity or other setting is being updated.

  • Deploying - The container service is launching a container deployment.

  • Running - The container service is created and it has a container deployment.

    Possible values:

    • PENDING
    • READY
    • RUNNING
    • UPDATING
    • DELETING
    • DISABLED

Returns:

  • (String) —

    The current state of the container service.

#tags ⇒ Array<Types::Tag>

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.

Returns:

  • (Array<Types::Tag>) —

    The tag keys and optional values for the resource.

#url ⇒ String

The publicly accessible URL of the container service.

If no public endpoint is specified in the currentDeployment, this URL returns a 404 response.

Returns:

  • (String) —

    The publicly accessible URL of the container service.