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

Inherits:

Struct

Object
Struct
Aws::Lightsail::Types::ContainerService

show all

Defined in:: gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb

Overview

Describes an Amazon Lightsail container service.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#arn ⇒ String
The Amazon Resource Name (ARN) of the container service.
#container_service_name ⇒ String
The name of the container service.
#created_at ⇒ 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.
#is_disabled ⇒ 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 Amazon Web Services Region and Availability Zone.
#next_deployment ⇒ Types::ContainerServiceDeployment
An object that describes the next deployment of the container service.
#power ⇒ String
The power specification of the container service.
#power_id ⇒ String
The ID of the power of the container service.
#principal_arn ⇒ String
The principal ARN of the container service.
#private_domain_name ⇒ String
The private domain name of the container service.
#private_registry_access ⇒ Types::PrivateRegistryAccess
An object that describes the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
#public_domain_names ⇒ 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.
#scale ⇒ Integer
The scale specification of the container service.
#state ⇒ String
The current state of the container service.
#state_detail ⇒ Types::ContainerServiceStateDetail
An object that describes the current state of the container service.
#tags ⇒ Array<Types::Tag>
The tag keys and optional values for the resource.
#url ⇒ String
The publicly accessible URL of the container service.

Instance Attribute Details

#arn ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2268

class ContainerService < Struct.new(
  :container_service_name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :power,
  :power_id,
  :state,
  :state_detail,
  :scale,
  :current_deployment,
  :next_deployment,
  :is_disabled,
  :principal_arn,
  :private_domain_name,
  :public_domain_names,
  :url,
  :private_registry_access)
  SENSITIVE = []
  include Aws::Structure
end

#container_service_name ⇒ `String`

The name of the container service.

Returns:

(String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2268

class ContainerService < Struct.new(
  :container_service_name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :power,
  :power_id,
  :state,
  :state_detail,
  :scale,
  :current_deployment,
  :next_deployment,
  :is_disabled,
  :principal_arn,
  :private_domain_name,
  :public_domain_names,
  :url,
  :private_registry_access)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ `Time`

The timestamp when the container service was created.

Returns:

(Time)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2268

class ContainerService < Struct.new(
  :container_service_name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :power,
  :power_id,
  :state,
  :state_detail,
  :scale,
  :current_deployment,
  :next_deployment,
  :is_disabled,
  :principal_arn,
  :private_domain_name,
  :public_domain_names,
  :url,
  :private_registry_access)
  SENSITIVE = []
  include Aws::Structure
end

#current_deployment ⇒ `Types::ContainerServiceDeployment`

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

Returns:

(Types::ContainerServiceDeployment)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2268

class ContainerService < Struct.new(
  :container_service_name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :power,
  :power_id,
  :state,
  :state_detail,
  :scale,
  :current_deployment,
  :next_deployment,
  :is_disabled,
  :principal_arn,
  :private_domain_name,
  :public_domain_names,
  :url,
  :private_registry_access)
  SENSITIVE = []
  include Aws::Structure
end

#is_disabled ⇒ `Boolean`

A Boolean value indicating whether the container service is disabled.

Returns:

(Boolean)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2268

class ContainerService < Struct.new(
  :container_service_name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :power,
  :power_id,
  :state,
  :state_detail,
  :scale,
  :current_deployment,
  :next_deployment,
  :is_disabled,
  :principal_arn,
  :private_domain_name,
  :public_domain_names,
  :url,
  :private_registry_access)
  SENSITIVE = []
  include Aws::Structure
end

#location ⇒ `Types::ResourceLocation`

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

Returns:

(Types::ResourceLocation)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2268

class ContainerService < Struct.new(
  :container_service_name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :power,
  :power_id,
  :state,
  :state_detail,
  :scale,
  :current_deployment,
  :next_deployment,
  :is_disabled,
  :principal_arn,
  :private_domain_name,
  :public_domain_names,
  :url,
  :private_registry_access)
  SENSITIVE = []
  include Aws::Structure
end

#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:

(Types::ContainerServiceDeployment)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2268

class ContainerService < Struct.new(
  :container_service_name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :power,
  :power_id,
  :state,
  :state_detail,
  :scale,
  :current_deployment,
  :next_deployment,
  :is_disabled,
  :principal_arn,
  :private_domain_name,
  :public_domain_names,
  :url,
  :private_registry_access)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

(String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2268

class ContainerService < Struct.new(
  :container_service_name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :power,
  :power_id,
  :state,
  :state_detail,
  :scale,
  :current_deployment,
  :next_deployment,
  :is_disabled,
  :principal_arn,
  :private_domain_name,
  :public_domain_names,
  :url,
  :private_registry_access)
  SENSITIVE = []
  include Aws::Structure
end

#power_id ⇒ `String`

The ID of the power of the container service.

Returns:

(String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2268

class ContainerService < Struct.new(
  :container_service_name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :power,
  :power_id,
  :state,
  :state_detail,
  :scale,
  :current_deployment,
  :next_deployment,
  :is_disabled,
  :principal_arn,
  :private_domain_name,
  :public_domain_names,
  :url,
  :private_registry_access)
  SENSITIVE = []
  include Aws::Structure
end

#principal_arn ⇒ `String`

The principal ARN of the container service.

The principal ARN can be used to create a trust relationship between your standard Amazon Web Services account and your Lightsail container service. This allows you to give your service permission to access resources in your standard Amazon Web Services account.

Returns:

(String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2268

class ContainerService < Struct.new(
  :container_service_name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :power,
  :power_id,
  :state,
  :state_detail,
  :scale,
  :current_deployment,
  :next_deployment,
  :is_disabled,
  :principal_arn,
  :private_domain_name,
  :public_domain_names,
  :url,
  :private_registry_access)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2268

class ContainerService < Struct.new(
  :container_service_name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :power,
  :power_id,
  :state,
  :state_detail,
  :scale,
  :current_deployment,
  :next_deployment,
  :is_disabled,
  :principal_arn,
  :private_domain_name,
  :public_domain_names,
  :url,
  :private_registry_access)
  SENSITIVE = []
  include Aws::Structure
end

#private_registry_access ⇒ `Types::PrivateRegistryAccess`

An object that describes the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

Returns:

(Types::PrivateRegistryAccess)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2268

class ContainerService < Struct.new(
  :container_service_name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :power,
  :power_id,
  :state,
  :state_detail,
  :scale,
  :current_deployment,
  :next_deployment,
  :is_disabled,
  :principal_arn,
  :private_domain_name,
  :public_domain_names,
  :url,
  :private_registry_access)
  SENSITIVE = []
  include Aws::Structure
end

#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>>)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2268

class ContainerService < Struct.new(
  :container_service_name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :power,
  :power_id,
  :state,
  :state_detail,
  :scale,
  :current_deployment,
  :next_deployment,
  :is_disabled,
  :principal_arn,
  :private_domain_name,
  :public_domain_names,
  :url,
  :private_registry_access)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ `String`

The Lightsail resource type of the container service.

Returns:

(String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2268

class ContainerService < Struct.new(
  :container_service_name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :power,
  :power_id,
  :state,
  :state_detail,
  :scale,
  :current_deployment,
  :next_deployment,
  :is_disabled,
  :principal_arn,
  :private_domain_name,
  :public_domain_names,
  :url,
  :private_registry_access)
  SENSITIVE = []
  include Aws::Structure
end

#scale ⇒ `Integer`

The scale specification of the container service.

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

Returns:

(Integer)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2268

class ContainerService < Struct.new(
  :container_service_name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :power,
  :power_id,
  :state,
  :state_detail,
  :scale,
  :current_deployment,
  :next_deployment,
  :is_disabled,
  :principal_arn,
  :private_domain_name,
  :public_domain_names,
  :url,
  :private_registry_access)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2268

class ContainerService < Struct.new(
  :container_service_name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :power,
  :power_id,
  :state,
  :state_detail,
  :scale,
  :current_deployment,
  :next_deployment,
  :is_disabled,
  :principal_arn,
  :private_domain_name,
  :public_domain_names,
  :url,
  :private_registry_access)
  SENSITIVE = []
  include Aws::Structure
end

#state_detail ⇒ `Types::ContainerServiceStateDetail`

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

The state detail is populated only when a container service is in a PENDING, DEPLOYING, or UPDATING state.

Returns:

(Types::ContainerServiceStateDetail)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2268

class ContainerService < Struct.new(
  :container_service_name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :power,
  :power_id,
  :state,
  :state_detail,
  :scale,
  :current_deployment,
  :next_deployment,
  :is_disabled,
  :principal_arn,
  :private_domain_name,
  :public_domain_names,
  :url,
  :private_registry_access)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

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

Returns:

(Array<Types::Tag>)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2268

class ContainerService < Struct.new(
  :container_service_name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :power,
  :power_id,
  :state,
  :state_detail,
  :scale,
  :current_deployment,
  :next_deployment,
  :is_disabled,
  :principal_arn,
  :private_domain_name,
  :public_domain_names,
  :url,
  :private_registry_access)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2268

class ContainerService < Struct.new(
  :container_service_name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :tags,
  :power,
  :power_id,
  :state,
  :state_detail,
  :scale,
  :current_deployment,
  :next_deployment,
  :is_disabled,
  :principal_arn,
  :private_domain_name,
  :public_domain_names,
  :url,
  :private_registry_access)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

#container_service_name ⇒ String

#created_at ⇒ Time

#current_deployment ⇒ Types::ContainerServiceDeployment

#is_disabled ⇒ Boolean

#location ⇒ Types::ResourceLocation

#next_deployment ⇒ Types::ContainerServiceDeployment

#power ⇒ String

#power_id ⇒ String

#principal_arn ⇒ String

#private_domain_name ⇒ String

#private_registry_access ⇒ Types::PrivateRegistryAccess

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

#resource_type ⇒ String

#scale ⇒ Integer

#state ⇒ String

#state_detail ⇒ Types::ContainerServiceStateDetail

#tags ⇒ Array<Types::Tag>

#url ⇒ String

#arn ⇒ `String`

#container_service_name ⇒ `String`

#created_at ⇒ `Time`

#current_deployment ⇒ `Types::ContainerServiceDeployment`

#is_disabled ⇒ `Boolean`

#location ⇒ `Types::ResourceLocation`

#next_deployment ⇒ `Types::ContainerServiceDeployment`

#power ⇒ `String`

#power_id ⇒ `String`

#principal_arn ⇒ `String`

#private_domain_name ⇒ `String`

#private_registry_access ⇒ `Types::PrivateRegistryAccess`

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

#resource_type ⇒ `String`

#scale ⇒ `Integer`

#state ⇒ `String`

#state_detail ⇒ `Types::ContainerServiceStateDetail`

#tags ⇒ `Array<Types::Tag>`

#url ⇒ `String`