Amazonka.Amplify.Types.DomainAssociation

Documentation

data DomainAssociation

Describes a domain association that associates a custom domain with an Amplify app.

See: newDomainAssociation smart constructor.

Constructors

DomainAssociation'

Fields

• autoSubDomainCreationPatterns :: Maybe [Text]

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

• certificateVerificationDNSRecord :: Maybe Text

  The DNS record for certificate verification.

• domainAssociationArn :: Text

  The Amazon Resource Name (ARN) for the domain association.

• domainName :: Text

  The name of the domain.

• enableAutoSubDomain :: Bool

  Enables the automated creation of subdomains for branches.

• domainStatus :: DomainStatus

  The current status of the domain association.

• statusReason :: Text

  The reason for the current status of the domain association.

• subDomains :: [SubDomain]

  The subdomains for the domain association.

Instances

FromJSON DomainAssociation

Defined in Amazonka.Amplify.Types.DomainAssociation

Methods

parseJSON :: Value -> Parser DomainAssociation

parseJSONList :: Value -> Parser [DomainAssociation]

Generic DomainAssociation

Defined in Amazonka.Amplify.Types.DomainAssociation

Associated Types

type Rep DomainAssociation :: Type -> Type

Methods

from :: DomainAssociation -> Rep DomainAssociation x

to :: Rep DomainAssociation x -> DomainAssociation

Read DomainAssociation

Defined in Amazonka.Amplify.Types.DomainAssociation

Methods

readsPrec :: Int -> ReadS DomainAssociation

readList :: ReadS [DomainAssociation]

readPrec :: ReadPrec DomainAssociation

readListPrec :: ReadPrec [DomainAssociation]

Show DomainAssociation

Defined in Amazonka.Amplify.Types.DomainAssociation

Methods

showsPrec :: Int -> DomainAssociation -> ShowS

show :: DomainAssociation -> String

showList :: [DomainAssociation] -> ShowS

NFData DomainAssociation

Defined in Amazonka.Amplify.Types.DomainAssociation

Methods

rnf :: DomainAssociation -> ()

Eq DomainAssociation

Defined in Amazonka.Amplify.Types.DomainAssociation

Methods

(==) :: DomainAssociation -> DomainAssociation -> Bool

(/=) :: DomainAssociation -> DomainAssociation -> Bool

Hashable DomainAssociation

Defined in Amazonka.Amplify.Types.DomainAssociation

Methods

hashWithSalt :: Int -> DomainAssociation -> Int

hash :: DomainAssociation -> Int

type Rep DomainAssociation

Defined in Amazonka.Amplify.Types.DomainAssociation

type Rep DomainAssociation = D1 ('MetaData "DomainAssociation" "Amazonka.Amplify.Types.DomainAssociation" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "DomainAssociation'" '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 "certificateVerificationDNSRecord") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "domainAssociationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "enableAutoSubDomain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "domainStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DomainStatus) :*: (S1 ('MetaSel ('Just "statusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "subDomains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [SubDomain]))))))

newDomainAssociation

Arguments

:: Text

$sel:domainAssociationArn:DomainAssociation'

-> Text

$sel:domainName:DomainAssociation'

-> Bool

$sel:enableAutoSubDomain:DomainAssociation'

-> DomainStatus

$sel:domainStatus:DomainAssociation'

-> Text

$sel:statusReason:DomainAssociation'

-> DomainAssociation

Create a value of DomainAssociation 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:autoSubDomainCreationPatterns:DomainAssociation', domainAssociation_autoSubDomainCreationPatterns - Sets branch patterns for automatic subdomain creation.

$sel:autoSubDomainIAMRole:DomainAssociation', domainAssociation_autoSubDomainIAMRole - The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

$sel:certificateVerificationDNSRecord:DomainAssociation', domainAssociation_certificateVerificationDNSRecord - The DNS record for certificate verification.

$sel:domainAssociationArn:DomainAssociation', domainAssociation_domainAssociationArn - The Amazon Resource Name (ARN) for the domain association.

$sel:domainName:DomainAssociation', domainAssociation_domainName - The name of the domain.

$sel:enableAutoSubDomain:DomainAssociation', domainAssociation_enableAutoSubDomain - Enables the automated creation of subdomains for branches.

$sel:domainStatus:DomainAssociation', domainAssociation_domainStatus - The current status of the domain association.

$sel:statusReason:DomainAssociation', domainAssociation_statusReason - The reason for the current status of the domain association.

$sel:subDomains:DomainAssociation', domainAssociation_subDomains - The subdomains for the domain association.

domainAssociation_autoSubDomainCreationPatterns :: Lens' DomainAssociation (Maybe [Text])

Sets branch patterns for automatic subdomain creation.

domainAssociation_autoSubDomainIAMRole :: Lens' DomainAssociation (Maybe Text)

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

domainAssociation_certificateVerificationDNSRecord :: Lens' DomainAssociation (Maybe Text)

The DNS record for certificate verification.

domainAssociation_domainAssociationArn :: Lens' DomainAssociation Text

The Amazon Resource Name (ARN) for the domain association.

domainAssociation_domainName :: Lens' DomainAssociation Text

The name of the domain.

domainAssociation_enableAutoSubDomain :: Lens' DomainAssociation Bool

Enables the automated creation of subdomains for branches.

domainAssociation_domainStatus :: Lens' DomainAssociation DomainStatus

The current status of the domain association.

domainAssociation_statusReason :: Lens' DomainAssociation Text

The reason for the current status of the domain association.

domainAssociation_subDomains :: Lens' DomainAssociation [SubDomain]

The subdomains for the domain association.