Class BasePathMappingProps

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

public class BasePathMappingProps : IBasePathMappingProps, IBasePathMappingOptions

Inheritance

object

BasePathMappingProps

Implements

IBasePathMappingProps

IBasePathMappingOptions

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;

            DomainName domainName;
            RestApi restApi;
            Stage stage;

            var basePathMappingProps = new BasePathMappingProps {
                DomainName = domainName,
                RestApi = restApi,

                // the properties below are optional
                BasePath = "basePath",
                Stage = stage
            };

Remarks

ExampleMetadata: fixture=_generated

Constructors

BasePathMappingProps()

public BasePathMappingProps()

Properties

BasePath

The base path name that callers of the API must provide in the URL after the domain name (e.g. example.com/base-path). If you specify this property, it can't be an empty string.

public string? BasePath { get; set; }

Property Value

string

Remarks

Default: - map requests from the domain root (e.g. example.com). If this is undefined, no additional mappings will be allowed on this domain name.

DomainName

The DomainName to associate with this base path mapping.

public IDomainName DomainName { get; set; }

Property Value

IDomainName

RestApi

The RestApi resource to target.

public IRestApi RestApi { get; set; }

Property Value

IRestApi

Stage

The Deployment stage of API [disable-awslint:ref-via-interface].

public Stage? Stage { get; set; }

Property Value

Stage

Remarks

Default: - map to deploymentStage of restApi otherwise stage needs to pass in URL