Show / Hide Table of Contents

Class CfnBasePathMappingProps

Properties for defining a CfnBasePathMapping.

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()
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnBasePathMappingProps : ICfnBasePathMappingProps
Syntax (vb)
Public Class CfnBasePathMappingProps Implements 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

Constructors

CfnBasePathMappingProps()

Properties for defining a CfnBasePathMapping.

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

Properties for defining a CfnBasePathMapping.

RestApiId

The string identifier of the associated RestApi.

Stage

The name of the associated stage.

Constructors

CfnBasePathMappingProps()

Properties for defining a CfnBasePathMapping.

public CfnBasePathMappingProps()
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"
             };

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

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.

public object DomainName { get; set; }
Property Value

object

Remarks

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

Type union: either string or IDomainNameRef

Id

Properties for defining a CfnBasePathMapping.

public string? Id { get; set; }
Property Value

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.

public object? RestApiId { get; set; }
Property Value

object

Remarks

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

Type union: either string or IRestApiRef

Stage

The name of the associated stage.

public object? Stage { get; set; }
Property Value

object

Remarks

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

Type union: either string or IStageRef

Implements

ICfnBasePathMappingProps
Back to top Generated by DocFX