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.Amplify.UpdateDomainAssociation

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new domain association for an Amplify app.

Synopsis

Creating a Request

data UpdateDomainAssociation Source #

The request structure for the update domain association request.

See: newUpdateDomainAssociation smart constructor.

Constructors

UpdateDomainAssociation'

Fields

autoSubDomainCreationPatterns :: Maybe [Text]
Sets the branch patterns for automatic subdomain creation.
autoSubDomainIAMRole :: Maybe Text
The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
enableAutoSubDomain :: Maybe Bool
Enables the automated creation of subdomains for branches.
subDomainSettings :: Maybe [SubDomainSetting]
Describes the settings for the subdomain.
appId :: Text
The unique ID for an Amplify app.
domainName :: Text
The name of the domain.

Instances

Instances details

ToJSON UpdateDomainAssociation Source #
Instance details Defined in Amazonka.Amplify.UpdateDomainAssociation Methods toJSON :: UpdateDomainAssociation -> Value # toEncoding :: UpdateDomainAssociation -> Encoding # toJSONList :: [UpdateDomainAssociation] -> Value # toEncodingList :: [UpdateDomainAssociation] -> Encoding #
ToHeaders UpdateDomainAssociation Source #
Instance details Defined in Amazonka.Amplify.UpdateDomainAssociation Methods toHeaders :: UpdateDomainAssociation -> [Header] #
ToPath UpdateDomainAssociation Source #
Instance details Defined in Amazonka.Amplify.UpdateDomainAssociation Methods toPath :: UpdateDomainAssociation -> ByteString #
ToQuery UpdateDomainAssociation Source #
Instance details Defined in Amazonka.Amplify.UpdateDomainAssociation Methods toQuery :: UpdateDomainAssociation -> QueryString #
AWSRequest UpdateDomainAssociation Source #
Instance details Defined in Amazonka.Amplify.UpdateDomainAssociation Associated Types type AWSResponse UpdateDomainAssociation # Methods request :: (Service -> Service) -> UpdateDomainAssociation -> Request UpdateDomainAssociation # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateDomainAssociation -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDomainAssociation))) #
Generic UpdateDomainAssociation Source #
Instance details Defined in Amazonka.Amplify.UpdateDomainAssociation Associated Types type Rep UpdateDomainAssociation :: Type -> Type # Methods from :: UpdateDomainAssociation -> Rep UpdateDomainAssociation x # to :: Rep UpdateDomainAssociation x -> UpdateDomainAssociation #
Read UpdateDomainAssociation Source #
Instance details Defined in Amazonka.Amplify.UpdateDomainAssociation Methods readsPrec :: Int -> ReadS UpdateDomainAssociation # readList :: ReadS [UpdateDomainAssociation] # readPrec :: ReadPrec UpdateDomainAssociation # readListPrec :: ReadPrec [UpdateDomainAssociation] #
Show UpdateDomainAssociation Source #
Instance details Defined in Amazonka.Amplify.UpdateDomainAssociation Methods showsPrec :: Int -> UpdateDomainAssociation -> ShowS # show :: UpdateDomainAssociation -> String # showList :: [UpdateDomainAssociation] -> ShowS #
NFData UpdateDomainAssociation Source #
Instance details Defined in Amazonka.Amplify.UpdateDomainAssociation Methods rnf :: UpdateDomainAssociation -> () #
Eq UpdateDomainAssociation Source #
Instance details Defined in Amazonka.Amplify.UpdateDomainAssociation Methods (==) :: UpdateDomainAssociation -> UpdateDomainAssociation -> Bool # (/=) :: UpdateDomainAssociation -> UpdateDomainAssociation -> Bool #
Hashable UpdateDomainAssociation Source #
Instance details Defined in Amazonka.Amplify.UpdateDomainAssociation Methods hashWithSalt :: Int -> UpdateDomainAssociation -> Int # hash :: UpdateDomainAssociation -> Int #
type AWSResponse UpdateDomainAssociation Source #
Instance details Defined in Amazonka.Amplify.UpdateDomainAssociation type AWSResponse UpdateDomainAssociation = UpdateDomainAssociationResponse
type Rep UpdateDomainAssociation Source #
Instance details Defined in Amazonka.Amplify.UpdateDomainAssociation type Rep UpdateDomainAssociation = D1 ('MetaData "UpdateDomainAssociation" "Amazonka.Amplify.UpdateDomainAssociation" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "UpdateDomainAssociation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "autoSubDomainCreationPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "autoSubDomainIAMRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "enableAutoSubDomain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "subDomainSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SubDomainSetting])) :: (S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateDomainAssociation Source #

Arguments

:: Text	`UpdateDomainAssociation`
-> Text	`UpdateDomainAssociation`
-> UpdateDomainAssociation

Create a value of UpdateDomainAssociation 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:

UpdateDomainAssociation, updateDomainAssociation_autoSubDomainCreationPatterns - Sets the branch patterns for automatic subdomain creation.

UpdateDomainAssociation, updateDomainAssociation_autoSubDomainIAMRole - The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

UpdateDomainAssociation, updateDomainAssociation_enableAutoSubDomain - Enables the automated creation of subdomains for branches.

$sel:subDomainSettings:UpdateDomainAssociation', updateDomainAssociation_subDomainSettings - Describes the settings for the subdomain.

UpdateDomainAssociation, updateDomainAssociation_appId - The unique ID for an Amplify app.

UpdateDomainAssociation, updateDomainAssociation_domainName - The name of the domain.

Request Lenses

updateDomainAssociation_autoSubDomainCreationPatterns :: Lens' UpdateDomainAssociation (Maybe [Text]) Source #

Sets the branch patterns for automatic subdomain creation.

updateDomainAssociation_autoSubDomainIAMRole :: Lens' UpdateDomainAssociation (Maybe Text) Source #

The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

updateDomainAssociation_enableAutoSubDomain :: Lens' UpdateDomainAssociation (Maybe Bool) Source #

Enables the automated creation of subdomains for branches.

updateDomainAssociation_subDomainSettings :: Lens' UpdateDomainAssociation (Maybe [SubDomainSetting]) Source #

Describes the settings for the subdomain.

updateDomainAssociation_appId :: Lens' UpdateDomainAssociation Text Source #

The unique ID for an Amplify app.

updateDomainAssociation_domainName :: Lens' UpdateDomainAssociation Text Source #

The name of the domain.

Destructuring the Response

data UpdateDomainAssociationResponse Source #

The result structure for the update domain association request.

See: newUpdateDomainAssociationResponse smart constructor.

Constructors

UpdateDomainAssociationResponse'
Fields httpStatus :: Int The response's http status code. domainAssociation :: DomainAssociation Describes a domain association, which associates a custom domain with an Amplify app.

Instances

Instances details

Generic UpdateDomainAssociationResponse Source #
Instance details Defined in Amazonka.Amplify.UpdateDomainAssociation Associated Types type Rep UpdateDomainAssociationResponse :: Type -> Type # Methods from :: UpdateDomainAssociationResponse -> Rep UpdateDomainAssociationResponse x # to :: Rep UpdateDomainAssociationResponse x -> UpdateDomainAssociationResponse #
Read UpdateDomainAssociationResponse Source #
Instance details Defined in Amazonka.Amplify.UpdateDomainAssociation Methods readsPrec :: Int -> ReadS UpdateDomainAssociationResponse # readList :: ReadS [UpdateDomainAssociationResponse] # readPrec :: ReadPrec UpdateDomainAssociationResponse # readListPrec :: ReadPrec [UpdateDomainAssociationResponse] #
Show UpdateDomainAssociationResponse Source #
Instance details Defined in Amazonka.Amplify.UpdateDomainAssociation Methods showsPrec :: Int -> UpdateDomainAssociationResponse -> ShowS # show :: UpdateDomainAssociationResponse -> String # showList :: [UpdateDomainAssociationResponse] -> ShowS #
NFData UpdateDomainAssociationResponse Source #
Instance details Defined in Amazonka.Amplify.UpdateDomainAssociation Methods rnf :: UpdateDomainAssociationResponse -> () #
Eq UpdateDomainAssociationResponse Source #
Instance details Defined in Amazonka.Amplify.UpdateDomainAssociation Methods (==) :: UpdateDomainAssociationResponse -> UpdateDomainAssociationResponse -> Bool # (/=) :: UpdateDomainAssociationResponse -> UpdateDomainAssociationResponse -> Bool #
type Rep UpdateDomainAssociationResponse Source #
Instance details Defined in Amazonka.Amplify.UpdateDomainAssociation type Rep UpdateDomainAssociationResponse = D1 ('MetaData "UpdateDomainAssociationResponse" "Amazonka.Amplify.UpdateDomainAssociation" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "UpdateDomainAssociationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "domainAssociation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DomainAssociation)))

newUpdateDomainAssociationResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateDomainAssociationResponse'`
-> DomainAssociation	`$sel:domainAssociation:UpdateDomainAssociationResponse'`
-> UpdateDomainAssociationResponse

Create a value of UpdateDomainAssociationResponse 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:httpStatus:UpdateDomainAssociationResponse', updateDomainAssociationResponse_httpStatus - The response's http status code.

$sel:domainAssociation:UpdateDomainAssociationResponse', updateDomainAssociationResponse_domainAssociation - Describes a domain association, which associates a custom domain with an Amplify app.

Response Lenses

updateDomainAssociationResponse_httpStatus :: Lens' UpdateDomainAssociationResponse Int Source #

The response's http status code.

updateDomainAssociationResponse_domainAssociation :: Lens' UpdateDomainAssociationResponse DomainAssociation Source #

Describes a domain association, which associates a custom domain with an Amplify app.