NAME
Paws::ApiGateway::DomainName
ATTRIBUTES
CertificateArn => Str
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 => Str
The name of the certificate that will be used by edge-optimized endpoint for this domain name.
CertificateUploadDate => Str
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
DistributionDomainName => Str
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 (https://aws.amazon.com/documentation/cloudfront/).
DistributionHostedZoneId => Str
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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) and AWS Regions and Endpoints for API Gateway (https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region).
DomainName => Str
The custom domain name as an API host name, for example, my-api.example.com
.
DomainNameStatus => Str
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.
Valid values are: "AVAILABLE"
, "UPDATING"
, "PENDING"
=head2 DomainNameStatusMessage => Str
An optional text message containing detailed information about status of the DomainName migration.
EndpointConfiguration => Paws::ApiGateway::EndpointConfiguration
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
MutualTlsAuthentication => Paws::ApiGateway::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.
RegionalCertificateArn => Str
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 => Str
The name of the certificate that will be used for validating the regional domain name.
RegionalDomainName => Str
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 => Str
The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) and AWS Regions and Endpoints for API Gateway (https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region).
SecurityPolicy => Str
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0
and TLS_1_2
.
Valid values are: "TLS_1_0"
, "TLS_1_2"
=head2 Tags => Paws::ApiGateway::MapOfStringToString
The collection of tags. Each tag element is associated with a given resource.