Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudFront.AssociateAlias

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.

With this operation you can move an alias that's already in use on a CloudFront distribution to a different distribution in one step. This prevents the downtime that could occur if you first remove the alias from one distribution and then separately add the alias to another distribution.

To use this operation to associate an alias with a distribution, you provide the alias and the ID of the target distribution for the alias. For more information, including how to set up the target distribution, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.

Synopsis

Creating a Request

data AssociateAlias Source #

See: newAssociateAlias smart constructor.

Constructors

AssociateAlias'
Fields targetDistributionId :: Text The ID of the distribution that you're associating the alias with. alias :: Text The alias (also known as a CNAME) to add to the target distribution.

Instances

Instances details

ToHeaders AssociateAlias Source #
Instance details Defined in Amazonka.CloudFront.AssociateAlias Methods toHeaders :: AssociateAlias -> [Header] #
ToPath AssociateAlias Source #
Instance details Defined in Amazonka.CloudFront.AssociateAlias Methods toPath :: AssociateAlias -> ByteString #
ToQuery AssociateAlias Source #
Instance details Defined in Amazonka.CloudFront.AssociateAlias Methods toQuery :: AssociateAlias -> QueryString #
AWSRequest AssociateAlias Source #
Instance details Defined in Amazonka.CloudFront.AssociateAlias Associated Types type AWSResponse AssociateAlias # Methods request :: (Service -> Service) -> AssociateAlias -> Request AssociateAlias # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AssociateAlias -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AssociateAlias))) #
Generic AssociateAlias Source #
Instance details Defined in Amazonka.CloudFront.AssociateAlias Associated Types type Rep AssociateAlias :: Type -> Type # Methods from :: AssociateAlias -> Rep AssociateAlias x # to :: Rep AssociateAlias x -> AssociateAlias #
Read AssociateAlias Source #
Instance details Defined in Amazonka.CloudFront.AssociateAlias Methods readsPrec :: Int -> ReadS AssociateAlias # readList :: ReadS [AssociateAlias] # readPrec :: ReadPrec AssociateAlias # readListPrec :: ReadPrec [AssociateAlias] #
Show AssociateAlias Source #
Instance details Defined in Amazonka.CloudFront.AssociateAlias Methods showsPrec :: Int -> AssociateAlias -> ShowS # show :: AssociateAlias -> String # showList :: [AssociateAlias] -> ShowS #
NFData AssociateAlias Source #
Instance details Defined in Amazonka.CloudFront.AssociateAlias Methods rnf :: AssociateAlias -> () #
Eq AssociateAlias Source #
Instance details Defined in Amazonka.CloudFront.AssociateAlias Methods (==) :: AssociateAlias -> AssociateAlias -> Bool # (/=) :: AssociateAlias -> AssociateAlias -> Bool #
Hashable AssociateAlias Source #
Instance details Defined in Amazonka.CloudFront.AssociateAlias Methods hashWithSalt :: Int -> AssociateAlias -> Int # hash :: AssociateAlias -> Int #
type AWSResponse AssociateAlias Source #
Instance details Defined in Amazonka.CloudFront.AssociateAlias type AWSResponse AssociateAlias = AssociateAliasResponse
type Rep AssociateAlias Source #
Instance details Defined in Amazonka.CloudFront.AssociateAlias type Rep AssociateAlias = D1 ('MetaData "AssociateAlias" "Amazonka.CloudFront.AssociateAlias" "amazonka-cloudfront-2.0-8Jb7luniAuUfLdUxCxW4K" 'False) (C1 ('MetaCons "AssociateAlias'" 'PrefixI 'True) (S1 ('MetaSel ('Just "targetDistributionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "alias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newAssociateAlias Source #

Arguments

:: Text	`$sel:targetDistributionId:AssociateAlias'`
-> Text	`AssociateAlias`
-> AssociateAlias

Create a value of AssociateAlias 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:targetDistributionId:AssociateAlias', associateAlias_targetDistributionId - The ID of the distribution that you're associating the alias with.

AssociateAlias, associateAlias_alias - The alias (also known as a CNAME) to add to the target distribution.

Request Lenses

associateAlias_targetDistributionId :: Lens' AssociateAlias Text Source #

The ID of the distribution that you're associating the alias with.

associateAlias_alias :: Lens' AssociateAlias Text Source #

The alias (also known as a CNAME) to add to the target distribution.

Destructuring the Response

data AssociateAliasResponse Source #

See: newAssociateAliasResponse smart constructor.

Constructors

AssociateAliasResponse'

Instances

Instances details

Generic AssociateAliasResponse Source #
Instance details Defined in Amazonka.CloudFront.AssociateAlias Associated Types type Rep AssociateAliasResponse :: Type -> Type # Methods from :: AssociateAliasResponse -> Rep AssociateAliasResponse x # to :: Rep AssociateAliasResponse x -> AssociateAliasResponse #
Read AssociateAliasResponse Source #
Instance details Defined in Amazonka.CloudFront.AssociateAlias Methods readsPrec :: Int -> ReadS AssociateAliasResponse # readList :: ReadS [AssociateAliasResponse] # readPrec :: ReadPrec AssociateAliasResponse # readListPrec :: ReadPrec [AssociateAliasResponse] #
Show AssociateAliasResponse Source #
Instance details Defined in Amazonka.CloudFront.AssociateAlias Methods showsPrec :: Int -> AssociateAliasResponse -> ShowS # show :: AssociateAliasResponse -> String # showList :: [AssociateAliasResponse] -> ShowS #
NFData AssociateAliasResponse Source #
Instance details Defined in Amazonka.CloudFront.AssociateAlias Methods rnf :: AssociateAliasResponse -> () #
Eq AssociateAliasResponse Source #
Instance details Defined in Amazonka.CloudFront.AssociateAlias Methods (==) :: AssociateAliasResponse -> AssociateAliasResponse -> Bool # (/=) :: AssociateAliasResponse -> AssociateAliasResponse -> Bool #
type Rep AssociateAliasResponse Source #
Instance details Defined in Amazonka.CloudFront.AssociateAlias type Rep AssociateAliasResponse = D1 ('MetaData "AssociateAliasResponse" "Amazonka.CloudFront.AssociateAlias" "amazonka-cloudfront-2.0-8Jb7luniAuUfLdUxCxW4K" 'False) (C1 ('MetaCons "AssociateAliasResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newAssociateAliasResponse :: AssociateAliasResponse Source #

Create a value of AssociateAliasResponse with all optional fields omitted.

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