Class BasePathMappingProps

Inheritance
System.Object
BasePathMappingProps
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class BasePathMappingProps : Object, IBasePathMappingProps, IBasePathMappingOptions
Syntax (vb)
Public Class BasePathMappingProps
    Inherits Object
    Implements IBasePathMappingProps, IBasePathMappingOptions
Remarks

ExampleMetadata: infused

Examples
RestApi api;


var domainName = DomainName.FromDomainNameAttributes(this, "DomainName", new DomainNameAttributes {
    DomainName = "domainName",
    DomainNameAliasHostedZoneId = "domainNameAliasHostedZoneId",
    DomainNameAliasTarget = "domainNameAliasTarget"
});

new BasePathMapping(this, "BasePathMapping", new BasePathMappingProps {
    DomainName = domainName,
    RestApi = api
});

Synopsis

Constructors

BasePathMappingProps()

Properties

AttachToStage

Whether to attach the base path mapping to a stage.
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.
DomainName

The DomainName to associate with this base path mapping.
RestApi

The RestApi resource to target.
Stage

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

Constructors

BasePathMappingProps()

public BasePathMappingProps()

Properties

AttachToStage

Whether to attach the base path mapping to a stage.

public Nullable<bool> AttachToStage { get; set; }
Property Value

System.Nullable<System.Boolean>

Remarks

Use this property to create a base path mapping without attaching it to the Rest API default stage. This property is ignored if stage is provided.

Default: - true

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

System.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

Implements