Class CfnBasePathMapping
A CloudFormation AWS::ApiGateway::BasePathMapping
.
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
The AWS::ApiGateway::BasePathMapping
resource creates a base path that clients who call your API must use in the invocation URL.
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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnBasePathMapping(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnBasePathMapping(Construct, String, ICfnBasePathMappingProps) | Create a new |
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 | |
DomainName | The domain name of the BasePathMapping resource to be described. |
Id |
|
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>) |
Constructors
CfnBasePathMapping(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnBasePathMapping(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnBasePathMapping(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnBasePathMapping(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnBasePathMapping(Construct, String, ICfnBasePathMappingProps)
Create a new AWS::ApiGateway::BasePathMapping
.
public CfnBasePathMapping(Construct scope, string id, ICfnBasePathMappingProps props)
Parameters
- scope Constructs.Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnBasePathMappingProps
- resource properties.
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
System.String
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DomainName
The domain name of the BasePathMapping resource to be described.
public virtual string DomainName { get; set; }
Property Value
System.String
Remarks
Id
AWS::ApiGateway::BasePathMapping.Id
.
public virtual string Id { get; set; }
Property Value
System.String
Remarks
RestApiId
The string identifier of the associated RestApi.
public virtual string RestApiId { get; set; }
Property Value
System.String
Remarks
Stage
The name of the associated stage.
public virtual string Stage { get; set; }
Property Value
System.String
Remarks
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>