1.204.0

interface DomainNameConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.APIGatewayv2.CfnDomainName.DomainNameConfigurationProperty
Javasoftware.amazon.awscdk.services.apigatewayv2.CfnDomainName.DomainNameConfigurationProperty
Pythonaws_cdk.aws_apigatewayv2.CfnDomainName.DomainNameConfigurationProperty
TypeScript @aws-cdk/aws-apigatewayv2 » CfnDomainName » DomainNameConfigurationProperty

The DomainNameConfiguration property type specifies the configuration for a an API's domain name.

DomainNameConfiguration is a property of the AWS::ApiGatewayV2::DomainName resource.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigatewayv2 from '@aws-cdk/aws-apigatewayv2';
const domainNameConfigurationProperty: apigatewayv2.CfnDomainName.DomainNameConfigurationProperty = {
  certificateArn: 'certificateArn',
  certificateName: 'certificateName',
  endpointType: 'endpointType',
  ownershipVerificationCertificateArn: 'ownershipVerificationCertificateArn',
  securityPolicy: 'securityPolicy',
};

Properties

NameTypeDescription
certificateArn?stringAn AWS -managed certificate that will be used by the edge-optimized endpoint for this domain name.
certificateName?stringThe user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
endpointType?stringThe endpoint type.
ownershipVerificationCertificateArn?stringThe Amazon resource name (ARN) for the public certificate issued by AWS Certificate Manager .
securityPolicy?stringThe Transport Layer Security (TLS) version of the security policy for this domain name.

certificateArn?

Type: string (optional)

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.

certificateName?

Type: string (optional)

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

endpointType?

Type: string (optional)

The endpoint type.

ownershipVerificationCertificateArn?

Type: string (optional)

The Amazon resource name (ARN) for the public certificate issued by AWS Certificate Manager .

This ARN is used to validate custom domain ownership. It's required only if you configure mutual TLS and use either an ACM-imported or a private CA certificate ARN as the regionalCertificateArn.

securityPolicy?

Type: string (optional)

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 .

← PreviousNext →