Interface ICfnBasePathMappingProps

Properties for defining a CfnBasePathMapping.

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnBasePathMappingProps

Syntax (vb)

Public Interface ICfnBasePathMappingProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.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 cfnBasePathMappingProps = new CfnBasePathMappingProps {
    DomainName = "domainName",

    // the properties below are optional
    BasePath = "basePath",
    Id = "id",
    RestApiId = "restApiId",
    Stage = "stage"
};

Synopsis

Properties

BasePath	The base path name that callers of the API must provide as part of the URL after the domain name.
DomainName	The domain name of the BasePathMapping resource to be described.
Id
RestApiId	The string identifier of the associated RestApi.
Stage	The name of the associated stage.

Properties

BasePath

The base path name that callers of the 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-basepathmapping.html#cfn-apigateway-basepathmapping-basepath

DomainName

The domain name of the BasePathMapping resource to be described.

string DomainName { get; }

Property Value

System.String

Remarks

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

Id

virtual string Id { get; }

Property Value

System.String

Remarks

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

RestApiId

The string identifier of the associated RestApi.

virtual string RestApiId { get; }

Property Value

System.String

Remarks

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

Stage

The name of the associated stage.

virtual string Stage { get; }

Property Value

System.String

Remarks

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