Skip to content

UpdateContainerServiceRequest

Source code in docs_src/capo_lightsail/types/update_container_service_request.py
class UpdateContainerServiceRequest(TypedDict, closed=True):
    service_name: "capo_lightsail.types.container_service_name.ContainerServiceName"
    """<p>The name of the container service to update.</p>"""
    power: NotRequired[
        "capo_lightsail.types.container_service_power_name.ContainerServicePowerName"
    ]
    """<p>The power for the container service.</p> <p>The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the container service. The <code>power</code> and <code>scale</code> of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the <code>power</code> with the <code>scale</code> (the number of nodes) of the service.</p> <p>Use the <code>GetContainerServicePowers</code> action to view the specifications of each power option.</p>"""
    scale: NotRequired[
        "capo_lightsail.types.container_service_scale.ContainerServiceScale"
    ]
    """<p>The scale for the container service.</p> <p>The scale specifies the allocated compute nodes of the container service. The <code>power</code> and <code>scale</code> of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the <code>power</code> with the <code>scale</code> (the number of nodes) of the service.</p>"""
    is_disabled: NotRequired["capo_lightsail.types.boolean.boolean"]
    """<p>A Boolean value to indicate whether the container service is disabled.</p>"""
    public_domain_names: NotRequired[
        "capo_lightsail.types.container_service_public_domains.ContainerServicePublicDomains"
    ]
    """<p>The public domain names to use with the container service, such as <code>example.com</code> and <code>www.example.com</code>.</p> <p>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.</p> <p>If you don't specify public domain names, then you can use the default domain of the container service.</p> <important> <p>You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the <code>CreateCertificate</code> action to create a certificate for the public domain names you want to use with your container service.</p> </important> <p>You can specify public domain names using a string to array map as shown in the example later on this page.</p>"""
    private_registry_access: NotRequired[
        "capo_lightsail.types.private_registry_access_request.PrivateRegistryAccessRequest"
    ]
    """<p>An object to describe the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-container-service-ecr-private-repo-access">Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>"""

is_disabled instance-attribute

is_disabled: NotRequired[boolean]

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

power instance-attribute

power: NotRequired[ContainerServicePowerName]

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.

private_registry_access instance-attribute

private_registry_access: NotRequired[PrivateRegistryAccessRequest]

An object to describe 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.

public_domain_names instance-attribute

public_domain_names: NotRequired[ContainerServicePublicDomains]

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.

scale instance-attribute

scale: NotRequired[ContainerServiceScale]

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.

service_name instance-attribute

service_name: ContainerServiceName

The name of the container service to update.