interface CfnDomainNameMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.ApiGatewayV2.Mixins.CfnDomainNameMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsapigatewayv2/mixins#CfnDomainNameMixinProps
Java	software.amazon.awscdk.mixins.preview.services.apigatewayv2.mixins.CfnDomainNameMixinProps
Python	aws_cdk.mixins_preview.aws_apigatewayv2.mixins.CfnDomainNameMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_apigatewayv2 » mixins » CfnDomainNameMixinProps

Properties for CfnDomainNamePropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as apigatewayv2_mixins } from '@aws-cdk/mixins-preview/aws-apigatewayv2';
const cfnDomainNameMixinProps: apigatewayv2_mixins.CfnDomainNameMixinProps = {
  domainName: 'domainName',
  domainNameConfigurations: [{
    certificateArn: 'certificateArn',
    certificateName: 'certificateName',
    endpointType: 'endpointType',
    ipAddressType: 'ipAddressType',
    ownershipVerificationCertificateArn: 'ownershipVerificationCertificateArn',
    securityPolicy: 'securityPolicy',
  }],
  mutualTlsAuthentication: {
    truststoreUri: 'truststoreUri',
    truststoreVersion: 'truststoreVersion',
  },
  routingMode: 'routingMode',
  tags: {
    tagsKey: 'tags',
  },
};

Properties

Name	Type	Description
domainName?	string	The custom domain name for your API in Amazon API Gateway.
domainNameConfigurations?	IResolvable | (IResolvable | DomainNameConfigurationProperty)[]	The domain name configurations.
mutualTlsAuthentication?	IResolvable | MutualTlsAuthenticationProperty	The mutual TLS authentication configuration for a custom domain name.
routingMode?	string	The routing mode API Gateway uses to route traffic to your APIs.
tags?	{ [string]: string }	The collection of tags associated with a domain name.

---

domainName?

Type: string (optional)

The custom domain name for your API in Amazon API Gateway.

Uppercase letters and the underscore ( _ ) character are not supported.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-domainname

---

domainNameConfigurations?

Type: IResolvable | (IResolvable | DomainNameConfigurationProperty)[] (optional)

The domain name configurations.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-domainnameconfigurations

---

mutualTlsAuthentication?

Type: IResolvable | MutualTlsAuthenticationProperty (optional)

The mutual TLS authentication configuration for a custom domain name.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-mutualtlsauthentication

---

routingMode?

Type: string (optional, default: "API_MAPPING_ONLY")

The routing mode API Gateway uses to route traffic to your APIs.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-routingmode

---

tags?

Type: { [string]: string } (optional)

The collection of tags associated with a domain name.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-tags