Class CfnBasePathMapping
The AWS::ApiGateway::BasePathMapping
resource creates a base path that clients who call your API must use in the invocation URL.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnBasePathMapping : CfnResource, IInspectable
Syntax (vb)
Public Class CfnBasePathMapping Inherits CfnResource Implements IInspectable
Remarks
Supported only for public custom domain names.
CloudformationResource: AWS::ApiGateway::BasePathMapping
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 cfnBasePathMapping = new CfnBasePathMapping(this, "MyCfnBasePathMapping", new CfnBasePathMappingProps {
DomainName = "domainName",
// the properties below are optional
BasePath = "basePath",
Id = "id",
RestApiId = "restApiId",
Stage = "stage"
});
Synopsis
Constructors
CfnBasePathMapping(Construct, string, ICfnBasePathMappingProps) | The |
Properties
BasePath | The base path name that callers of the API must provide as part of the URL after the domain name. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | The |
DomainName | The domain name of the BasePathMapping resource to be described. |
Id | The |
RestApiId | The string identifier of the associated RestApi. |
Stage | The name of the associated stage. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<string, object>) | The |
Constructors
CfnBasePathMapping(Construct, string, ICfnBasePathMappingProps)
The AWS::ApiGateway::BasePathMapping
resource creates a base path that clients who call your API must use in the invocation URL.
public CfnBasePathMapping(Construct scope, string id, ICfnBasePathMappingProps props)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnBasePathMappingProps
Resource properties.
Remarks
Supported only for public custom domain names.
CloudformationResource: AWS::ApiGateway::BasePathMapping
ExampleMetadata: fixture=_generated
Properties
BasePath
The base path name that callers of the API must provide as part of the URL after the domain name.
public virtual string? BasePath { get; set; }
Property Value
Remarks
Supported only for public custom domain names.
CloudformationResource: AWS::ApiGateway::BasePathMapping
ExampleMetadata: fixture=_generated
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
Remarks
Supported only for public custom domain names.
CloudformationResource: AWS::ApiGateway::BasePathMapping
ExampleMetadata: fixture=_generated
CfnProperties
The AWS::ApiGateway::BasePathMapping
resource creates a base path that clients who call your API must use in the invocation URL.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
Supported only for public custom domain names.
CloudformationResource: AWS::ApiGateway::BasePathMapping
ExampleMetadata: fixture=_generated
DomainName
The domain name of the BasePathMapping resource to be described.
public virtual string DomainName { get; set; }
Property Value
Remarks
Supported only for public custom domain names.
CloudformationResource: AWS::ApiGateway::BasePathMapping
ExampleMetadata: fixture=_generated
Id
The AWS::ApiGateway::BasePathMapping
resource creates a base path that clients who call your API must use in the invocation URL.
public virtual string? Id { get; set; }
Property Value
Remarks
Supported only for public custom domain names.
CloudformationResource: AWS::ApiGateway::BasePathMapping
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 cfnBasePathMapping = new CfnBasePathMapping(this, "MyCfnBasePathMapping", new CfnBasePathMappingProps {
DomainName = "domainName",
// the properties below are optional
BasePath = "basePath",
Id = "id",
RestApiId = "restApiId",
Stage = "stage"
});
RestApiId
The string identifier of the associated RestApi.
public virtual string? RestApiId { get; set; }
Property Value
Remarks
Supported only for public custom domain names.
CloudformationResource: AWS::ApiGateway::BasePathMapping
ExampleMetadata: fixture=_generated
Stage
The name of the associated stage.
public virtual string? Stage { get; set; }
Property Value
Remarks
Supported only for public custom domain names.
CloudformationResource: AWS::ApiGateway::BasePathMapping
ExampleMetadata: fixture=_generated
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
Remarks
Supported only for public custom domain names.
CloudformationResource: AWS::ApiGateway::BasePathMapping
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
The AWS::ApiGateway::BasePathMapping
resource creates a base path that clients who call your API must use in the invocation URL.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
Supported only for public custom domain names.
CloudformationResource: AWS::ApiGateway::BasePathMapping
ExampleMetadata: fixture=_generated