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.CognitoIdentityProvider.Types.DomainDescriptionType

Description

Synopsis

data DomainDescriptionType = DomainDescriptionType' {
- aWSAccountId :: Maybe Text
- cloudFrontDistribution :: Maybe Text
- customDomainConfig :: Maybe CustomDomainConfigType
- domain :: Maybe Text
- s3Bucket :: Maybe Text
- status :: Maybe DomainStatusType
- userPoolId :: Maybe Text
- version :: Maybe Text
}
newDomainDescriptionType :: DomainDescriptionType
domainDescriptionType_aWSAccountId :: Lens' DomainDescriptionType (Maybe Text)
domainDescriptionType_cloudFrontDistribution :: Lens' DomainDescriptionType (Maybe Text)
domainDescriptionType_customDomainConfig :: Lens' DomainDescriptionType (Maybe CustomDomainConfigType)
domainDescriptionType_domain :: Lens' DomainDescriptionType (Maybe Text)
domainDescriptionType_s3Bucket :: Lens' DomainDescriptionType (Maybe Text)
domainDescriptionType_status :: Lens' DomainDescriptionType (Maybe DomainStatusType)
domainDescriptionType_userPoolId :: Lens' DomainDescriptionType (Maybe Text)
domainDescriptionType_version :: Lens' DomainDescriptionType (Maybe Text)

Documentation

data DomainDescriptionType Source #

A container for information about a domain.

See: newDomainDescriptionType smart constructor.

Constructors

DomainDescriptionType'

Fields

aWSAccountId :: Maybe Text
The Amazon Web Services ID for the user pool owner.
cloudFrontDistribution :: Maybe Text
The Amazon Resource Name (ARN) of the Amazon CloudFront distribution.
customDomainConfig :: Maybe CustomDomainConfigType
The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
domain :: Maybe Text
The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
s3Bucket :: Maybe Text
The Amazon S3 bucket where the static files for this domain are stored.
status :: Maybe DomainStatusType
The domain status.
userPoolId :: Maybe Text
The user pool ID.
version :: Maybe Text
The app version.

Instances

Instances details

FromJSON DomainDescriptionType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.DomainDescriptionType Methods parseJSON :: Value -> Parser DomainDescriptionType # parseJSONList :: Value -> Parser [DomainDescriptionType] #
Generic DomainDescriptionType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.DomainDescriptionType Associated Types type Rep DomainDescriptionType :: Type -> Type # Methods from :: DomainDescriptionType -> Rep DomainDescriptionType x # to :: Rep DomainDescriptionType x -> DomainDescriptionType #
Read DomainDescriptionType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.DomainDescriptionType Methods readsPrec :: Int -> ReadS DomainDescriptionType # readList :: ReadS [DomainDescriptionType] # readPrec :: ReadPrec DomainDescriptionType # readListPrec :: ReadPrec [DomainDescriptionType] #
Show DomainDescriptionType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.DomainDescriptionType Methods showsPrec :: Int -> DomainDescriptionType -> ShowS # show :: DomainDescriptionType -> String # showList :: [DomainDescriptionType] -> ShowS #
NFData DomainDescriptionType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.DomainDescriptionType Methods rnf :: DomainDescriptionType -> () #
Eq DomainDescriptionType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.DomainDescriptionType Methods (==) :: DomainDescriptionType -> DomainDescriptionType -> Bool # (/=) :: DomainDescriptionType -> DomainDescriptionType -> Bool #
Hashable DomainDescriptionType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.DomainDescriptionType Methods hashWithSalt :: Int -> DomainDescriptionType -> Int # hash :: DomainDescriptionType -> Int #
type Rep DomainDescriptionType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.DomainDescriptionType type Rep DomainDescriptionType = D1 ('MetaData "DomainDescriptionType" "Amazonka.CognitoIdentityProvider.Types.DomainDescriptionType" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "DomainDescriptionType'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "aWSAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "cloudFrontDistribution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "customDomainConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomDomainConfigType)) :: S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "s3Bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainStatusType))) :: (S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDomainDescriptionType :: DomainDescriptionType Source #

Create a value of DomainDescriptionType 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:aWSAccountId:DomainDescriptionType', domainDescriptionType_aWSAccountId - The Amazon Web Services ID for the user pool owner.

$sel:cloudFrontDistribution:DomainDescriptionType', domainDescriptionType_cloudFrontDistribution - The Amazon Resource Name (ARN) of the Amazon CloudFront distribution.

$sel:customDomainConfig:DomainDescriptionType', domainDescriptionType_customDomainConfig - The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

$sel:domain:DomainDescriptionType', domainDescriptionType_domain - The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

$sel:s3Bucket:DomainDescriptionType', domainDescriptionType_s3Bucket - The Amazon S3 bucket where the static files for this domain are stored.

$sel:status:DomainDescriptionType', domainDescriptionType_status - The domain status.

$sel:userPoolId:DomainDescriptionType', domainDescriptionType_userPoolId - The user pool ID.

$sel:version:DomainDescriptionType', domainDescriptionType_version - The app version.

domainDescriptionType_aWSAccountId :: Lens' DomainDescriptionType (Maybe Text) Source #

The Amazon Web Services ID for the user pool owner.

domainDescriptionType_cloudFrontDistribution :: Lens' DomainDescriptionType (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon CloudFront distribution.

domainDescriptionType_customDomainConfig :: Lens' DomainDescriptionType (Maybe CustomDomainConfigType) Source #

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

domainDescriptionType_domain :: Lens' DomainDescriptionType (Maybe Text) Source #

The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

domainDescriptionType_s3Bucket :: Lens' DomainDescriptionType (Maybe Text) Source #

The Amazon S3 bucket where the static files for this domain are stored.

domainDescriptionType_status :: Lens' DomainDescriptionType (Maybe DomainStatusType) Source #

The domain status.

domainDescriptionType_userPoolId :: Lens' DomainDescriptionType (Maybe Text) Source #

The user pool ID.

domainDescriptionType_version :: Lens' DomainDescriptionType (Maybe Text) Source #

The app version.