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.Amplify.Types.DomainAssociation

Description

Synopsis

data DomainAssociation = DomainAssociation' {
- certificateVerificationDNSRecord :: Maybe Text
- autoSubDomainCreationPatterns :: Maybe [Text]
- autoSubDomainIAMRole :: Maybe Text
- domainAssociationArn :: Text
- domainName :: Text
- enableAutoSubDomain :: Bool
- domainStatus :: DomainStatus
- statusReason :: Text
- subDomains :: [SubDomain]
}
newDomainAssociation :: Text -> Text -> Bool -> DomainStatus -> Text -> DomainAssociation
domainAssociation_certificateVerificationDNSRecord :: Lens' DomainAssociation (Maybe Text)
domainAssociation_autoSubDomainCreationPatterns :: Lens' DomainAssociation (Maybe [Text])
domainAssociation_autoSubDomainIAMRole :: Lens' DomainAssociation (Maybe Text)
domainAssociation_domainAssociationArn :: Lens' DomainAssociation Text
domainAssociation_domainName :: Lens' DomainAssociation Text
domainAssociation_enableAutoSubDomain :: Lens' DomainAssociation Bool
domainAssociation_domainStatus :: Lens' DomainAssociation DomainStatus
domainAssociation_statusReason :: Lens' DomainAssociation Text
domainAssociation_subDomains :: Lens' DomainAssociation [SubDomain]

Documentation

data DomainAssociation Source #

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

See: newDomainAssociation smart constructor.

Constructors

DomainAssociation'

Fields

certificateVerificationDNSRecord :: Maybe Text
The DNS record for certificate verification.
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.
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

Instances details

Eq DomainAssociation Source #
Instance details Defined in Amazonka.Amplify.Types.DomainAssociation Methods (==) :: DomainAssociation -> DomainAssociation -> Bool # (/=) :: DomainAssociation -> DomainAssociation -> Bool #
Read DomainAssociation Source #
Instance details Defined in Amazonka.Amplify.Types.DomainAssociation Methods readsPrec :: Int -> ReadS DomainAssociation # readList :: ReadS [DomainAssociation] # readPrec :: ReadPrec DomainAssociation # readListPrec :: ReadPrec [DomainAssociation] #
Show DomainAssociation Source #
Instance details Defined in Amazonka.Amplify.Types.DomainAssociation Methods showsPrec :: Int -> DomainAssociation -> ShowS # show :: DomainAssociation -> String # showList :: [DomainAssociation] -> ShowS #
Generic DomainAssociation Source #
Instance details Defined in Amazonka.Amplify.Types.DomainAssociation Associated Types type Rep DomainAssociation :: Type -> Type # Methods from :: DomainAssociation -> Rep DomainAssociation x # to :: Rep DomainAssociation x -> DomainAssociation #
NFData DomainAssociation Source #
Instance details Defined in Amazonka.Amplify.Types.DomainAssociation Methods rnf :: DomainAssociation -> () #
Hashable DomainAssociation Source #
Instance details Defined in Amazonka.Amplify.Types.DomainAssociation Methods hashWithSalt :: Int -> DomainAssociation -> Int # hash :: DomainAssociation -> Int #
FromJSON DomainAssociation Source #
Instance details Defined in Amazonka.Amplify.Types.DomainAssociation Methods parseJSON :: Value -> Parser DomainAssociation # parseJSONList :: Value -> Parser [DomainAssociation] #
type Rep DomainAssociation Source #
Instance details Defined in Amazonka.Amplify.Types.DomainAssociation type Rep DomainAssociation = D1 ('MetaData "DomainAssociation" "Amazonka.Amplify.Types.DomainAssociation" "libZSservicesZSamazonka-amplifyZSamazonka-amplify" 'False) (C1 ('MetaCons "DomainAssociation'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "certificateVerificationDNSRecord") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "autoSubDomainCreationPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "autoSubDomainIAMRole") '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 Source #

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:certificateVerificationDNSRecord:DomainAssociation', domainAssociation_certificateVerificationDNSRecord - The DNS record for certificate verification.

$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: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_certificateVerificationDNSRecord :: Lens' DomainAssociation (Maybe Text) Source #

The DNS record for certificate verification.

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

Sets branch patterns for automatic subdomain creation.

domainAssociation_autoSubDomainIAMRole :: Lens' DomainAssociation (Maybe Text) Source #

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

domainAssociation_domainAssociationArn :: Lens' DomainAssociation Text Source #

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

domainAssociation_domainName :: Lens' DomainAssociation Text Source #

The name of the domain.

domainAssociation_enableAutoSubDomain :: Lens' DomainAssociation Bool Source #

Enables the automated creation of subdomains for branches.

domainAssociation_domainStatus :: Lens' DomainAssociation DomainStatus Source #

The current status of the domain association.

domainAssociation_statusReason :: Lens' DomainAssociation Text Source #

The reason for the current status of the domain association.

domainAssociation_subDomains :: Lens' DomainAssociation [SubDomain] Source #

The subdomains for the domain association.