Interface ICfnBasePathMappingV2Props

Properties for defining a CfnBasePathMappingV2.

Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnBasePathMappingV2Props
Syntax (vb)
Public Interface ICfnBasePathMappingV2Props
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// 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"
};

Synopsis

Properties

BasePath

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

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

The private API's identifier.
Stage

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

Properties

BasePath

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

virtual string BasePath { get; }
Property Value

System.String

Remarks

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

DomainNameArn

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

string DomainNameArn { get; }
Property Value

System.String

Remarks

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

RestApiId

The private API's identifier.

string RestApiId { get; }
Property Value

System.String

Remarks

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

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

Stage

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

virtual string Stage { get; }
Property Value

System.String

Remarks

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

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