CfnBasePathMappingV2Props Struct
Properties for defining a CfnBasePathMappingV2.
| Source | |
|---|---|
| Type last changed |
Example
ts
// 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-lib';
const cfnBasePathMappingV2Props: apigateway.CfnBasePathMappingV2Props = {
domainNameArn: 'domainNameArn',
restApiId: 'restApiId',
// the properties below are optional
basePath: 'basePath',
stage: 'stage',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_apigateway as apigateway
cfn_base_path_mapping_v2_props = apigateway.CfnBasePathMappingV2Props(
domain_name_arn="domainNameArn",
rest_api_id="restApiId",
# the properties below are optional
base_path="basePath",
stage="stage"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.apigateway.*;
CfnBasePathMappingV2Props cfnBasePathMappingV2Props = CfnBasePathMappingV2Props.builder()
.domainNameArn("domainNameArn")
.restApiId("restApiId")
// the properties below are optional
.basePath("basePath")
.stage("stage")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGateway;
var cfnBasePathMappingV2Props = new CfnBasePathMappingV2Props {
DomainNameArn = "domainNameArn",
RestApiId = "restApiId",
// the properties below are optional
BasePath = "basePath",
Stage = "stage"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnBasePathMappingV2Props := &CfnBasePathMappingV2Props{
DomainNameArn: jsii.String("domainNameArn"),
RestApiId: jsii.String("restApiId"),
// the properties below are optional
BasePath: jsii.String("basePath"),
Stage: jsii.String("stage"),
}
Properties
basePathoptionalstringbase_pathoptionalstrbasePathoptionalStringBasePathoptionalstringBasePathoptional*string #The base path name that callers of the private API must provide as part of the URL after the domain name.
domainNameArnstringdomain_name_arnstrdomainNameArnStringDomainNameArnstringDomainNameArn*string required #The ARN of the domain name for the BasePathMappingV2 resource to be described.
The private API's identifier.
This identifier is unique across all of your APIs in API Gateway.
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.