Class CfnBasePathMappingProps

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

Properties for defining a CfnBasePathMapping.

public class CfnBasePathMappingProps : ICfnBasePathMappingProps

Inheritance

object

CfnBasePathMappingProps

Implements

ICfnBasePathMappingProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html

ExampleMetadata: fixture=_generated

Constructors

CfnBasePathMappingProps()

public CfnBasePathMappingProps()

Properties

BasePath

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

public string? BasePath { get; set; }

Property Value

string

Remarks

Link: 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.

public string DomainName { get; set; }

Property Value

string

Remarks

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

Id

AWS::ApiGateway::BasePathMapping.Id.

public string? Id { get; set; }

Property Value

string

Remarks

Link: 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.

public string? RestApiId { get; set; }

Property Value

string

Remarks

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

Stage

The name of the associated stage.

public string? Stage { get; set; }

Property Value

string

Remarks

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