Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Lightsail.RegisterContainerImage

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Registers a container image to your Amazon Lightsail container service.

This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.

Creating a Request

data RegisterContainerImage Source #

See: newRegisterContainerImage smart constructor.

Constructors

RegisterContainerImage'

Fields

serviceName :: Text
The name of the container service for which to register a container image.
label :: Text
The label for the container image when it's registered to the container service.
Use a descriptive label that you can use to track the different versions of your registered container images.
Use the GetContainerImages action to return the container images registered to a Lightsail container service. The label is the <imagelabel> portion of the following image name example:
- ```
:container-service-1.<imagelabel>.1
```
If the name of your container service is mycontainerservice, and the label that you specify is mystaticwebsite, then the name of the registered container image will be :mycontainerservice.mystaticwebsite.1.
The number at the end of these image name examples represents the version of the registered container image. If you push and register another container image to the same Lightsail container service, with the same label, then the version number for the new registered container image will be 2. If you push and register another container image, the version number will be 3, and so on.
digest :: Text
The digest of the container image to be registered.

Instances

Instances details

Eq RegisterContainerImage Source #
Instance details Defined in Amazonka.Lightsail.RegisterContainerImage Methods (==) :: RegisterContainerImage -> RegisterContainerImage -> Bool # (/=) :: RegisterContainerImage -> RegisterContainerImage -> Bool #
Read RegisterContainerImage Source #
Instance details Defined in Amazonka.Lightsail.RegisterContainerImage Methods readsPrec :: Int -> ReadS RegisterContainerImage # readList :: ReadS [RegisterContainerImage] # readPrec :: ReadPrec RegisterContainerImage # readListPrec :: ReadPrec [RegisterContainerImage] #
Show RegisterContainerImage Source #
Instance details Defined in Amazonka.Lightsail.RegisterContainerImage Methods showsPrec :: Int -> RegisterContainerImage -> ShowS # show :: RegisterContainerImage -> String # showList :: [RegisterContainerImage] -> ShowS #
Generic RegisterContainerImage Source #
Instance details Defined in Amazonka.Lightsail.RegisterContainerImage Associated Types type Rep RegisterContainerImage :: Type -> Type # Methods from :: RegisterContainerImage -> Rep RegisterContainerImage x # to :: Rep RegisterContainerImage x -> RegisterContainerImage #
NFData RegisterContainerImage Source #
Instance details Defined in Amazonka.Lightsail.RegisterContainerImage Methods rnf :: RegisterContainerImage -> () #
Hashable RegisterContainerImage Source #
Instance details Defined in Amazonka.Lightsail.RegisterContainerImage Methods hashWithSalt :: Int -> RegisterContainerImage -> Int # hash :: RegisterContainerImage -> Int #
ToJSON RegisterContainerImage Source #
Instance details Defined in Amazonka.Lightsail.RegisterContainerImage Methods toJSON :: RegisterContainerImage -> Value # toEncoding :: RegisterContainerImage -> Encoding # toJSONList :: [RegisterContainerImage] -> Value # toEncodingList :: [RegisterContainerImage] -> Encoding #
AWSRequest RegisterContainerImage Source #
Instance details Defined in Amazonka.Lightsail.RegisterContainerImage Associated Types type AWSResponse RegisterContainerImage # Methods request :: RegisterContainerImage -> Request RegisterContainerImage # response :: MonadResource m => Logger -> Service -> Proxy RegisterContainerImage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RegisterContainerImage))) #
ToHeaders RegisterContainerImage Source #
Instance details Defined in Amazonka.Lightsail.RegisterContainerImage Methods toHeaders :: RegisterContainerImage -> [Header] #
ToPath RegisterContainerImage Source #
Instance details Defined in Amazonka.Lightsail.RegisterContainerImage Methods toPath :: RegisterContainerImage -> ByteString #
ToQuery RegisterContainerImage Source #
Instance details Defined in Amazonka.Lightsail.RegisterContainerImage Methods toQuery :: RegisterContainerImage -> QueryString #
type Rep RegisterContainerImage Source #
Instance details Defined in Amazonka.Lightsail.RegisterContainerImage type Rep RegisterContainerImage = D1 ('MetaData "RegisterContainerImage" "Amazonka.Lightsail.RegisterContainerImage" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "RegisterContainerImage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "label") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "digest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse RegisterContainerImage Source #
Instance details Defined in Amazonka.Lightsail.RegisterContainerImage type AWSResponse RegisterContainerImage = RegisterContainerImageResponse

newRegisterContainerImage Source #

Arguments

:: Text	`$sel:serviceName:RegisterContainerImage'`
-> Text	`$sel:label:RegisterContainerImage'`
-> Text	`$sel:digest:RegisterContainerImage'`
-> RegisterContainerImage

Create a value of RegisterContainerImage 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:serviceName:RegisterContainerImage', registerContainerImage_serviceName - The name of the container service for which to register a container image.

$sel:label:RegisterContainerImage', registerContainerImage_label - The label for the container image when it's registered to the container service.

Use a descriptive label that you can use to track the different versions of your registered container images.

Use the GetContainerImages action to return the container images registered to a Lightsail container service. The label is the <imagelabel> portion of the following image name example:

```
:container-service-1.<imagelabel>.1
```

If the name of your container service is mycontainerservice, and the label that you specify is mystaticwebsite, then the name of the registered container image will be :mycontainerservice.mystaticwebsite.1.

The number at the end of these image name examples represents the version of the registered container image. If you push and register another container image to the same Lightsail container service, with the same label, then the version number for the new registered container image will be 2. If you push and register another container image, the version number will be 3, and so on.

$sel:digest:RegisterContainerImage', registerContainerImage_digest - The digest of the container image to be registered.

Request Lenses

registerContainerImage_serviceName :: Lens' RegisterContainerImage Text Source #

The name of the container service for which to register a container image.

registerContainerImage_label :: Lens' RegisterContainerImage Text Source #

The label for the container image when it's registered to the container service.

Use a descriptive label that you can use to track the different versions of your registered container images.

Use the GetContainerImages action to return the container images registered to a Lightsail container service. The label is the <imagelabel> portion of the following image name example:

```
:container-service-1.<imagelabel>.1
```

If the name of your container service is mycontainerservice, and the label that you specify is mystaticwebsite, then the name of the registered container image will be :mycontainerservice.mystaticwebsite.1.

The number at the end of these image name examples represents the version of the registered container image. If you push and register another container image to the same Lightsail container service, with the same label, then the version number for the new registered container image will be 2. If you push and register another container image, the version number will be 3, and so on.

registerContainerImage_digest :: Lens' RegisterContainerImage Text Source #

The digest of the container image to be registered.

Destructuring the Response

data RegisterContainerImageResponse Source #

See: newRegisterContainerImageResponse smart constructor.

Constructors

RegisterContainerImageResponse'
Fields containerImage :: Maybe ContainerImage httpStatus :: Int The response's http status code.

Instances

Instances details

Eq RegisterContainerImageResponse Source #
Instance details Defined in Amazonka.Lightsail.RegisterContainerImage Methods (==) :: RegisterContainerImageResponse -> RegisterContainerImageResponse -> Bool # (/=) :: RegisterContainerImageResponse -> RegisterContainerImageResponse -> Bool #
Read RegisterContainerImageResponse Source #
Instance details Defined in Amazonka.Lightsail.RegisterContainerImage Methods readsPrec :: Int -> ReadS RegisterContainerImageResponse # readList :: ReadS [RegisterContainerImageResponse] # readPrec :: ReadPrec RegisterContainerImageResponse # readListPrec :: ReadPrec [RegisterContainerImageResponse] #
Show RegisterContainerImageResponse Source #
Instance details Defined in Amazonka.Lightsail.RegisterContainerImage Methods showsPrec :: Int -> RegisterContainerImageResponse -> ShowS # show :: RegisterContainerImageResponse -> String # showList :: [RegisterContainerImageResponse] -> ShowS #
Generic RegisterContainerImageResponse Source #
Instance details Defined in Amazonka.Lightsail.RegisterContainerImage Associated Types type Rep RegisterContainerImageResponse :: Type -> Type # Methods from :: RegisterContainerImageResponse -> Rep RegisterContainerImageResponse x # to :: Rep RegisterContainerImageResponse x -> RegisterContainerImageResponse #
NFData RegisterContainerImageResponse Source #
Instance details Defined in Amazonka.Lightsail.RegisterContainerImage Methods rnf :: RegisterContainerImageResponse -> () #
type Rep RegisterContainerImageResponse Source #
Instance details Defined in Amazonka.Lightsail.RegisterContainerImage type Rep RegisterContainerImageResponse = D1 ('MetaData "RegisterContainerImageResponse" "Amazonka.Lightsail.RegisterContainerImage" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "RegisterContainerImageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "containerImage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContainerImage)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRegisterContainerImageResponse Source #

Arguments

:: Int	`$sel:httpStatus:RegisterContainerImageResponse'`
-> RegisterContainerImageResponse

Create a value of RegisterContainerImageResponse 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:containerImage:RegisterContainerImageResponse', registerContainerImageResponse_containerImage - Undocumented member.

$sel:httpStatus:RegisterContainerImageResponse', registerContainerImageResponse_httpStatus - The response's http status code.

Response Lenses

registerContainerImageResponse_containerImage :: Lens' RegisterContainerImageResponse (Maybe ContainerImage) Source #

Undocumented member.

registerContainerImageResponse_httpStatus :: Lens' RegisterContainerImageResponse Int Source #

The response's http status code.