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 |
Synopsis
- data DomainNameConfiguration = DomainNameConfiguration' {
- apiGatewayDomainName :: Maybe Text
- certificateArn :: Maybe Text
- certificateName :: Maybe Text
- certificateUploadDate :: Maybe ISO8601
- domainNameStatus :: Maybe DomainNameStatus
- domainNameStatusMessage :: Maybe Text
- endpointType :: Maybe EndpointType
- hostedZoneId :: Maybe Text
- ownershipVerificationCertificateArn :: Maybe Text
- securityPolicy :: Maybe SecurityPolicy
- newDomainNameConfiguration :: DomainNameConfiguration
- domainNameConfiguration_apiGatewayDomainName :: Lens' DomainNameConfiguration (Maybe Text)
- domainNameConfiguration_certificateArn :: Lens' DomainNameConfiguration (Maybe Text)
- domainNameConfiguration_certificateName :: Lens' DomainNameConfiguration (Maybe Text)
- domainNameConfiguration_certificateUploadDate :: Lens' DomainNameConfiguration (Maybe UTCTime)
- domainNameConfiguration_domainNameStatus :: Lens' DomainNameConfiguration (Maybe DomainNameStatus)
- domainNameConfiguration_domainNameStatusMessage :: Lens' DomainNameConfiguration (Maybe Text)
- domainNameConfiguration_endpointType :: Lens' DomainNameConfiguration (Maybe EndpointType)
- domainNameConfiguration_hostedZoneId :: Lens' DomainNameConfiguration (Maybe Text)
- domainNameConfiguration_ownershipVerificationCertificateArn :: Lens' DomainNameConfiguration (Maybe Text)
- domainNameConfiguration_securityPolicy :: Lens' DomainNameConfiguration (Maybe SecurityPolicy)
Documentation
data DomainNameConfiguration Source #
The domain name configuration.
See: newDomainNameConfiguration
smart constructor.
DomainNameConfiguration' | |
|
Instances
newDomainNameConfiguration :: DomainNameConfiguration Source #
Create a value of DomainNameConfiguration
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:apiGatewayDomainName:DomainNameConfiguration'
, domainNameConfiguration_apiGatewayDomainName
- A domain name for the API.
$sel:certificateArn:DomainNameConfiguration'
, domainNameConfiguration_certificateArn
- An AWS-managed certificate that will be used by the edge-optimized
endpoint for this domain name. AWS Certificate Manager is the only
supported source.
$sel:certificateName:DomainNameConfiguration'
, domainNameConfiguration_certificateName
- The user-friendly name of the certificate that will be used by the
edge-optimized endpoint for this domain name.
$sel:certificateUploadDate:DomainNameConfiguration'
, domainNameConfiguration_certificateUploadDate
- The timestamp when the certificate that was used by edge-optimized
endpoint for this domain name was uploaded.
$sel:domainNameStatus:DomainNameConfiguration'
, domainNameConfiguration_domainNameStatus
- The status of the domain name migration. The valid values are AVAILABLE,
UPDATING, PENDING_CERTIFICATE_REIMPORT, and
PENDING_OWNERSHIP_VERIFICATION. 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:DomainNameConfiguration'
, domainNameConfiguration_domainNameStatusMessage
- An optional text message containing detailed information about status of
the domain name migration.
$sel:endpointType:DomainNameConfiguration'
, domainNameConfiguration_endpointType
- The endpoint type.
$sel:hostedZoneId:DomainNameConfiguration'
, domainNameConfiguration_hostedZoneId
- The Amazon Route 53 Hosted Zone ID of the endpoint.
$sel:ownershipVerificationCertificateArn:DomainNameConfiguration'
, domainNameConfiguration_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:securityPolicy:DomainNameConfiguration'
, domainNameConfiguration_securityPolicy
- The Transport Layer Security (TLS) version of the security policy for
this domain name. The valid values are TLS_1_0 and TLS_1_2.
domainNameConfiguration_apiGatewayDomainName :: Lens' DomainNameConfiguration (Maybe Text) Source #
A domain name for the API.
domainNameConfiguration_certificateArn :: Lens' DomainNameConfiguration (Maybe Text) Source #
An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
domainNameConfiguration_certificateName :: Lens' DomainNameConfiguration (Maybe Text) Source #
The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
domainNameConfiguration_certificateUploadDate :: Lens' DomainNameConfiguration (Maybe UTCTime) Source #
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
domainNameConfiguration_domainNameStatus :: Lens' DomainNameConfiguration (Maybe DomainNameStatus) Source #
The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. 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.
domainNameConfiguration_domainNameStatusMessage :: Lens' DomainNameConfiguration (Maybe Text) Source #
An optional text message containing detailed information about status of the domain name migration.
domainNameConfiguration_endpointType :: Lens' DomainNameConfiguration (Maybe EndpointType) Source #
The endpoint type.
domainNameConfiguration_hostedZoneId :: Lens' DomainNameConfiguration (Maybe Text) Source #
The Amazon Route 53 Hosted Zone ID of the endpoint.
domainNameConfiguration_ownershipVerificationCertificateArn :: Lens' DomainNameConfiguration (Maybe Text) Source #
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
domainNameConfiguration_securityPolicy :: Lens' DomainNameConfiguration (Maybe SecurityPolicy) Source #
The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.