amazonka-lightsail-2.0: Amazon Lightsail SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Lightsail.UpdateContainerService

Description

Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names.

Synopsis

Creating a Request

data UpdateContainerService Source #

See: newUpdateContainerService smart constructor.

Constructors

UpdateContainerService' 

Fields

  • isDisabled :: Maybe Bool

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

  • power :: Maybe 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.

  • privateRegistryAccess :: Maybe 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.

  • publicDomainNames :: Maybe (HashMap Text [Text])

    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 :: Maybe Natural

    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.

  • serviceName :: Text

    The name of the container service to update.

Instances

Instances details
ToJSON UpdateContainerService Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateContainerService

ToHeaders UpdateContainerService Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateContainerService

ToPath UpdateContainerService Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateContainerService

ToQuery UpdateContainerService Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateContainerService

AWSRequest UpdateContainerService Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateContainerService

Associated Types

type AWSResponse UpdateContainerService #

Generic UpdateContainerService Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateContainerService

Associated Types

type Rep UpdateContainerService :: Type -> Type #

Read UpdateContainerService Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateContainerService

Show UpdateContainerService Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateContainerService

NFData UpdateContainerService Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateContainerService

Methods

rnf :: UpdateContainerService -> () #

Eq UpdateContainerService Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateContainerService

Hashable UpdateContainerService Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateContainerService

type AWSResponse UpdateContainerService Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateContainerService

type Rep UpdateContainerService Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateContainerService

type Rep UpdateContainerService = D1 ('MetaData "UpdateContainerService" "Amazonka.Lightsail.UpdateContainerService" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "UpdateContainerService'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "isDisabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "power") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContainerServicePowerName)) :*: S1 ('MetaSel ('Just "privateRegistryAccess") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PrivateRegistryAccessRequest)))) :*: (S1 ('MetaSel ('Just "publicDomainNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: (S1 ('MetaSel ('Just "scale") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "serviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateContainerService Source #

Create a value of UpdateContainerService with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateContainerService, updateContainerService_isDisabled - A Boolean value to indicate whether the container service is disabled.

UpdateContainerService, updateContainerService_power - 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.

UpdateContainerService, updateContainerService_privateRegistryAccess - 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.

UpdateContainerService, updateContainerService_publicDomainNames - 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.

UpdateContainerService, updateContainerService_scale - 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.

UpdateContainerService, updateContainerService_serviceName - The name of the container service to update.

Request Lenses

updateContainerService_isDisabled :: Lens' UpdateContainerService (Maybe Bool) Source #

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

updateContainerService_power :: Lens' UpdateContainerService (Maybe ContainerServicePowerName) Source #

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.

updateContainerService_privateRegistryAccess :: Lens' UpdateContainerService (Maybe PrivateRegistryAccessRequest) Source #

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.

updateContainerService_publicDomainNames :: Lens' UpdateContainerService (Maybe (HashMap Text [Text])) Source #

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.

updateContainerService_scale :: Lens' UpdateContainerService (Maybe Natural) Source #

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.

updateContainerService_serviceName :: Lens' UpdateContainerService Text Source #

The name of the container service to update.

Destructuring the Response

data UpdateContainerServiceResponse Source #

See: newUpdateContainerServiceResponse smart constructor.

Constructors

UpdateContainerServiceResponse' 

Fields

Instances

Instances details
Generic UpdateContainerServiceResponse Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateContainerService

Associated Types

type Rep UpdateContainerServiceResponse :: Type -> Type #

Read UpdateContainerServiceResponse Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateContainerService

Show UpdateContainerServiceResponse Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateContainerService

NFData UpdateContainerServiceResponse Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateContainerService

Eq UpdateContainerServiceResponse Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateContainerService

type Rep UpdateContainerServiceResponse Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateContainerService

type Rep UpdateContainerServiceResponse = D1 ('MetaData "UpdateContainerServiceResponse" "Amazonka.Lightsail.UpdateContainerService" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "UpdateContainerServiceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "containerService") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContainerService)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateContainerServiceResponse Source #

Create a value of UpdateContainerServiceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:containerService:UpdateContainerServiceResponse', updateContainerServiceResponse_containerService - An object that describes a container service.

$sel:httpStatus:UpdateContainerServiceResponse', updateContainerServiceResponse_httpStatus - The response's http status code.

Response Lenses