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

Inherits:
Struct
  • Object
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

Instance Attribute Details

#arnString

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

Returns:

  • (String)


2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2363

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_nameString

The name of the container service.

Returns:

  • (String)


2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2363

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_atTime

The timestamp when the container service was created.

Returns:

  • (Time)


2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2363

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_deploymentTypes::ContainerServiceDeployment

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



2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2363

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_disabledBoolean

A Boolean value indicating whether the container service is disabled.

Returns:

  • (Boolean)


2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2363

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

#locationTypes::ResourceLocation

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



2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2363

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_deploymentTypes::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.



2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2363

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

#powerString

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)


2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2363

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_idString

The ID of the power of the container service.

Returns:

  • (String)


2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2363

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_arnString

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)


2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2363

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_nameString

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)


2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2363

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_accessTypes::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.



2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2363

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


2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2363

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_typeString

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

Returns:

  • (String)


2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2363

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

#scaleInteger

The scale specification of the container service.

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

Returns:

  • (Integer)


2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2363

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

#stateString

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)


2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2363

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_detailTypes::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.



2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2363

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

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



2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2363

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

#urlString

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)


2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2363

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