Class: Aws::Lightsail::Types::UpdateContainerServiceRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb

Overview

Note:

When making an API call, you may pass UpdateContainerServiceRequest data as a hash:

{
  service_name: "ContainerServiceName", # required
  power: "nano", # accepts nano, micro, small, medium, large, xlarge
  scale: 1,
  is_disabled: false,
  public_domain_names: {
    "string" => ["string"],
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#is_disabledBoolean

A Boolean value to indicate whether the container service is disabled.

Returns:

  • (Boolean)


14748
14749
14750
14751
14752
14753
14754
14755
14756
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 14748

class UpdateContainerServiceRequest < Struct.new(
  :service_name,
  :power,
  :scale,
  :is_disabled,
  :public_domain_names)
  SENSITIVE = []
  include Aws::Structure
end

#powerString

The power for the container service.

The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

Use the GetContainerServicePowers action to view the specifications of each power option.

Returns:

  • (String)


14748
14749
14750
14751
14752
14753
14754
14755
14756
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 14748

class UpdateContainerServiceRequest < Struct.new(
  :service_name,
  :power,
  :scale,
  :is_disabled,
  :public_domain_names)
  SENSITIVE = []
  include Aws::Structure
end

#public_domain_namesHash<String,Array<String>>

The public domain names to use with 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.

You can specify public domain names using a string to array map as shown in the example later on this page.

Returns:

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


14748
14749
14750
14751
14752
14753
14754
14755
14756
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 14748

class UpdateContainerServiceRequest < Struct.new(
  :service_name,
  :power,
  :scale,
  :is_disabled,
  :public_domain_names)
  SENSITIVE = []
  include Aws::Structure
end

#scaleInteger

The scale for the container service.

The scale specifies the allocated compute nodes of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

Returns:

  • (Integer)


14748
14749
14750
14751
14752
14753
14754
14755
14756
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 14748

class UpdateContainerServiceRequest < Struct.new(
  :service_name,
  :power,
  :scale,
  :is_disabled,
  :public_domain_names)
  SENSITIVE = []
  include Aws::Structure
end

#service_nameString

The name of the container service to update.

Returns:

  • (String)


14748
14749
14750
14751
14752
14753
14754
14755
14756
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 14748

class UpdateContainerServiceRequest < Struct.new(
  :service_name,
  :power,
  :scale,
  :is_disabled,
  :public_domain_names)
  SENSITIVE = []
  include Aws::Structure
end