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.CreateDomainAssociation

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app

Synopsis

Creating a Request

data CreateDomainAssociation Source #

The request structure for the create domain association request.

See: newCreateDomainAssociation smart constructor.

Constructors

CreateDomainAssociation'

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.
appId :: Text
The unique ID for an Amplify app.
domainName :: Text
The domain name for the domain association.
subDomainSettings :: [SubDomainSetting]
The setting for the subdomain.

Instances

Instances details

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

newCreateDomainAssociation Source #

Arguments

:: Text	`CreateDomainAssociation`
-> Text	`CreateDomainAssociation`
-> CreateDomainAssociation

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

CreateDomainAssociation, createDomainAssociation_autoSubDomainCreationPatterns - Sets the branch patterns for automatic subdomain creation.

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

CreateDomainAssociation, createDomainAssociation_enableAutoSubDomain - Enables the automated creation of subdomains for branches.

CreateDomainAssociation, createDomainAssociation_appId - The unique ID for an Amplify app.

CreateDomainAssociation, createDomainAssociation_domainName - The domain name for the domain association.

$sel:subDomainSettings:CreateDomainAssociation', createDomainAssociation_subDomainSettings - The setting for the subdomain.

Request Lenses

createDomainAssociation_autoSubDomainCreationPatterns :: Lens' CreateDomainAssociation (Maybe [Text]) Source #

Sets the branch patterns for automatic subdomain creation.

createDomainAssociation_autoSubDomainIAMRole :: Lens' CreateDomainAssociation (Maybe Text) Source #

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

createDomainAssociation_enableAutoSubDomain :: Lens' CreateDomainAssociation (Maybe Bool) Source #

Enables the automated creation of subdomains for branches.

createDomainAssociation_appId :: Lens' CreateDomainAssociation Text Source #

The unique ID for an Amplify app.

createDomainAssociation_domainName :: Lens' CreateDomainAssociation Text Source #

The domain name for the domain association.

createDomainAssociation_subDomainSettings :: Lens' CreateDomainAssociation [SubDomainSetting] Source #

The setting for the subdomain.

Destructuring the Response

data CreateDomainAssociationResponse Source #

The result structure for the create domain association request.

See: newCreateDomainAssociationResponse smart constructor.

Constructors

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

Instances

Instances details

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

newCreateDomainAssociationResponse Source #

Arguments

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

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

$sel:domainAssociation:CreateDomainAssociationResponse', createDomainAssociationResponse_domainAssociation - Describes the structure of a domain association, which associates a custom domain with an Amplify app.

Response Lenses

createDomainAssociationResponse_httpStatus :: Lens' CreateDomainAssociationResponse Int Source #

The response's http status code.

createDomainAssociationResponse_domainAssociation :: Lens' CreateDomainAssociationResponse DomainAssociation Source #

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