interface CfnBasePathMappingV2MixinProps

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.ApiGateway.CfnBasePathMappingV2MixinProps
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsapigateway#CfnBasePathMappingV2MixinProps
Java	software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnBasePathMappingV2MixinProps
Python	aws_cdk.cfn_property_mixins.aws_apigateway.CfnBasePathMappingV2MixinProps
TypeScript	@aws-cdk/cfn-property-mixins » aws_apigateway » CfnBasePathMappingV2MixinProps

Properties for CfnBasePathMappingV2PropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from '@aws-cdk/cfn-property-mixins';
const cfnBasePathMappingV2MixinProps: apigateway.CfnBasePathMappingV2MixinProps = {
  basePath: 'basePath',
  domainNameArn: 'domainNameArn',
  restApiId: 'restApiId',
  stage: 'stage',
};

Properties

Name	Type	Description
basePath?	string	The base path name that callers of the private API must provide as part of the URL after the domain name.
domainNameArn?	string	The ARN of the domain name for the BasePathMappingV2 resource to be described.
restApiId?	string	The private API's identifier.
stage?	string	Represents a unique identifier for a version of a deployed private RestApi that is callable by users.

---

basePath?

Type: string (optional)

The base path name that callers of the private API must provide as part of the URL after the domain name.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmappingv2.html#cfn-apigateway-basepathmappingv2-basepath

---

domainNameArn?

Type: string (optional)

The ARN of the domain name for the BasePathMappingV2 resource to be described.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmappingv2.html#cfn-apigateway-basepathmappingv2-domainnamearn

---

restApiId?

Type: string (optional)

The private API's identifier.

This identifier is unique across all of your APIs in API Gateway.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmappingv2.html#cfn-apigateway-basepathmappingv2-restapiid

---

stage?

Type: string (optional)

Represents a unique identifier for a version of a deployed private RestApi that is callable by users.

The Stage must depend on the RestApi 's stage. To create a dependency, add a DependsOn attribute to the BasePathMappingV2 resource.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmappingv2.html#cfn-apigateway-basepathmappingv2-stage