Amazonka.APIGateway.Types.DomainName

Documentation

data DomainName

Represents a custom domain name as a user-friendly host name of an API (RestApi).

See: newDomainName smart constructor.

Constructors

DomainName'

Fields

• certificateArn :: Maybe Text

  The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

• certificateName :: Maybe Text

  The name of the certificate that will be used by edge-optimized endpoint for this domain name.

• certificateUploadDate :: Maybe POSIX

  The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

• distributionDomainName :: Maybe Text

  The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

• distributionHostedZoneId :: Maybe Text

  The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

• domainName :: Maybe Text

  The custom domain name as an API host name, for example, my-api.example.com.

• domainNameStatus :: Maybe DomainNameStatus

  The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

• domainNameStatusMessage :: Maybe Text

  An optional text message containing detailed information about status of the DomainName migration.

• endpointConfiguration :: Maybe EndpointConfiguration

  The endpoint configuration of this DomainName showing the endpoint types of the domain name.

• mutualTlsAuthentication :: Maybe MutualTlsAuthentication

  The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

• ownershipVerificationCertificateArn :: Maybe Text

  The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.

• regionalCertificateArn :: Maybe Text

  The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

• regionalCertificateName :: Maybe Text

  The name of the certificate that will be used for validating the regional domain name.

• regionalDomainName :: Maybe Text

  The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

• regionalHostedZoneId :: Maybe Text

  The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

• securityPolicy :: Maybe SecurityPolicy

  The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

• tags :: Maybe (HashMap Text Text)

  The collection of tags. Each tag element is associated with a given resource.

Instances

FromJSON DomainName

Defined in Amazonka.APIGateway.Types.DomainName

Methods

parseJSON :: Value -> Parser DomainName

parseJSONList :: Value -> Parser [DomainName]

Generic DomainName

Defined in Amazonka.APIGateway.Types.DomainName

Associated Types

type Rep DomainName :: Type -> Type

Methods

from :: DomainName -> Rep DomainName x

to :: Rep DomainName x -> DomainName

Read DomainName

Defined in Amazonka.APIGateway.Types.DomainName

Methods

readsPrec :: Int -> ReadS DomainName

readList :: ReadS [DomainName]

readPrec :: ReadPrec DomainName

readListPrec :: ReadPrec [DomainName]

Show DomainName

Defined in Amazonka.APIGateway.Types.DomainName

Methods

showsPrec :: Int -> DomainName -> ShowS

show :: DomainName -> String

showList :: [DomainName] -> ShowS

NFData DomainName

Defined in Amazonka.APIGateway.Types.DomainName

Methods

rnf :: DomainName -> ()

Eq DomainName

Defined in Amazonka.APIGateway.Types.DomainName

Methods

(==) :: DomainName -> DomainName -> Bool

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

Hashable DomainName

Defined in Amazonka.APIGateway.Types.DomainName

Methods

hashWithSalt :: Int -> DomainName -> Int

hash :: DomainName -> Int

type Rep DomainName

Defined in Amazonka.APIGateway.Types.DomainName

type Rep DomainName = D1 ('MetaData "DomainName" "Amazonka.APIGateway.Types.DomainName" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DomainName'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "certificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "certificateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "certificateUploadDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "distributionDomainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "distributionHostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "domainNameStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainNameStatus)) :*: S1 ('MetaSel ('Just "domainNameStatusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "endpointConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointConfiguration)) :*: S1 ('MetaSel ('Just "mutualTlsAuthentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MutualTlsAuthentication))) :*: (S1 ('MetaSel ('Just "ownershipVerificationCertificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "regionalCertificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "regionalCertificateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "regionalDomainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "regionalHostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "securityPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SecurityPolicy)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))))

newDomainName :: DomainName

Create a value of DomainName 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:certificateArn:DomainName', domainName_certificateArn - The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

$sel:certificateName:DomainName', domainName_certificateName - The name of the certificate that will be used by edge-optimized endpoint for this domain name.

$sel:certificateUploadDate:DomainName', domainName_certificateUploadDate - The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

$sel:distributionDomainName:DomainName', domainName_distributionDomainName - The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

$sel:distributionHostedZoneId:DomainName', domainName_distributionHostedZoneId - The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

$sel:domainName:DomainName', domainName_domainName - The custom domain name as an API host name, for example, my-api.example.com.

$sel:domainNameStatus:DomainName', domainName_domainNameStatus - The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

$sel:domainNameStatusMessage:DomainName', domainName_domainNameStatusMessage - An optional text message containing detailed information about status of the DomainName migration.

$sel:endpointConfiguration:DomainName', domainName_endpointConfiguration - The endpoint configuration of this DomainName showing the endpoint types of the domain name.

$sel:mutualTlsAuthentication:DomainName', domainName_mutualTlsAuthentication - The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

$sel:ownershipVerificationCertificateArn:DomainName', domainName_ownershipVerificationCertificateArn - The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.

$sel:regionalCertificateArn:DomainName', domainName_regionalCertificateArn - The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

$sel:regionalCertificateName:DomainName', domainName_regionalCertificateName - The name of the certificate that will be used for validating the regional domain name.

$sel:regionalDomainName:DomainName', domainName_regionalDomainName - The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

$sel:regionalHostedZoneId:DomainName', domainName_regionalHostedZoneId - The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

$sel:securityPolicy:DomainName', domainName_securityPolicy - The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

$sel:tags:DomainName', domainName_tags - The collection of tags. Each tag element is associated with a given resource.

domainName_certificateArn :: Lens' DomainName (Maybe Text)

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

domainName_certificateName :: Lens' DomainName (Maybe Text)

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

domainName_certificateUploadDate :: Lens' DomainName (Maybe UTCTime)

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

domainName_distributionDomainName :: Lens' DomainName (Maybe Text)

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

domainName_distributionHostedZoneId :: Lens' DomainName (Maybe Text)

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

domainName_domainName :: Lens' DomainName (Maybe Text)

The custom domain name as an API host name, for example, my-api.example.com.

domainName_domainNameStatus :: Lens' DomainName (Maybe DomainNameStatus)

The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

domainName_domainNameStatusMessage :: Lens' DomainName (Maybe Text)

An optional text message containing detailed information about status of the DomainName migration.

domainName_endpointConfiguration :: Lens' DomainName (Maybe EndpointConfiguration)

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

domainName_mutualTlsAuthentication :: Lens' DomainName (Maybe MutualTlsAuthentication)

The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

domainName_ownershipVerificationCertificateArn :: Lens' DomainName (Maybe Text)

The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.

domainName_regionalCertificateArn :: Lens' DomainName (Maybe Text)

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

domainName_regionalCertificateName :: Lens' DomainName (Maybe Text)

The name of the certificate that will be used for validating the regional domain name.

domainName_regionalDomainName :: Lens' DomainName (Maybe Text)

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

domainName_regionalHostedZoneId :: Lens' DomainName (Maybe Text)

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

domainName_securityPolicy :: Lens' DomainName (Maybe SecurityPolicy)

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

domainName_tags :: Lens' DomainName (Maybe (HashMap Text Text))

The collection of tags. Each tag element is associated with a given resource.