class CfnDomainNamePropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins.CfnDomainNamePropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsapigateway/mixins#CfnDomainNamePropsMixin
Java	software.amazon.awscdk.mixins.preview.services.apigateway.mixins.CfnDomainNamePropsMixin
Python	aws_cdk.mixins_preview.aws_apigateway.mixins.CfnDomainNamePropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_apigateway » mixins » CfnDomainNamePropsMixin

Implements IMixin

Extends Mixin

The AWS::ApiGateway::DomainName resource specifies a public custom domain name for your API in API Gateway.

To create a custom domain name for private APIs, use AWS::ApiGateway::DomainNameV2 .

You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway in the API Gateway Developer Guide .

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as apigateway_mixins } from '@aws-cdk/mixins-preview/aws-apigateway';
const cfnDomainNamePropsMixin = new apigateway_mixins.CfnDomainNamePropsMixin({
  certificateArn: 'certificateArn',
  domainName: 'domainName',
  endpointAccessMode: 'endpointAccessMode',
  endpointConfiguration: {
    ipAddressType: 'ipAddressType',
    types: ['types'],
  },
  mutualTlsAuthentication: {
    truststoreUri: 'truststoreUri',
    truststoreVersion: 'truststoreVersion',
  },
  ownershipVerificationCertificateArn: 'ownershipVerificationCertificateArn',
  regionalCertificateArn: 'regionalCertificateArn',
  routingMode: 'routingMode',
  securityPolicy: 'securityPolicy',
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnDomainNamePropsMixin(props: CfnDomainNameMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnDomainNameMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::ApiGateway::DomainName.

Properties

Name	Type	Description
props	CfnDomainNameMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnDomainNameMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.