interface CfnBasePathMappingV2MixinProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins.CfnBasePathMappingV2MixinProps |
 Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsapigateway/mixins#CfnBasePathMappingV2MixinProps |
 Java | software.amazon.awscdk.mixins.preview.services.apigateway.mixins.CfnBasePathMappingV2MixinProps |
 Python | aws_cdk.mixins_preview.aws_apigateway.mixins.CfnBasePathMappingV2MixinProps |
 TypeScript | @aws-cdk/mixins-preview » aws_apigateway » mixins » CfnBasePathMappingV2MixinProps |
Properties for CfnBasePathMappingV2PropsMixin.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as apigateway_mixins } from '@aws-cdk/mixins-preview/aws-apigateway';
const cfnBasePathMappingV2MixinProps: apigateway_mixins.CfnBasePathMappingV2MixinProps = {
basePath: 'basePath',
domainNameArn: 'domainNameArn',
restApiId: 'restApiId',
stage: 'stage',
};
Properties
| Name | Type | Description |
|---|---|---|
| base | string | The base path name that callers of the private API must provide as part of the URL after the domain name. |
| domain | string | The ARN of the domain name for the BasePathMappingV2 resource to be described. |
| rest | 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.
domainNameArn?
Type:
string
(optional)
The ARN of the domain name for the BasePathMappingV2 resource to be described.
restApiId?
Type:
string
(optional)
The private API's identifier.
This identifier is unique across all of your APIs in API Gateway.
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.