Class CfnBasePathMappingV2PropsMixin

The AWS::ApiGateway::BasePathMappingV2 resource creates a base path that clients who call your API must use in the invocation URL.

Inheritance
object
Mixin
CfnBasePathMappingV2PropsMixin
Implements
Inherited Members
Namespace: Amazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public class CfnBasePathMappingV2PropsMixin : Mixin, IMixin
Syntax (vb)
Public Class CfnBasePathMappingV2PropsMixin Inherits Mixin Implements IMixin
Remarks

Supported only for private custom domain names.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmappingv2.html

CloudformationResource: AWS::ApiGateway::BasePathMappingV2

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins;

             var cfnBasePathMappingV2PropsMixin = new CfnBasePathMappingV2PropsMixin(new CfnBasePathMappingV2MixinProps {
                 BasePath = "basePath",
                 DomainNameArn = "domainNameArn",
                 RestApiId = "restApiId",
                 Stage = "stage"
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Synopsis

Constructors

CfnBasePathMappingV2PropsMixin(ICfnBasePathMappingV2MixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::ApiGateway::BasePathMappingV2.

Properties

CFN_PROPERTY_KEYS

The AWS::ApiGateway::BasePathMappingV2 resource creates a base path that clients who call your API must use in the invocation URL.
Props

The AWS::ApiGateway::BasePathMappingV2 resource creates a base path that clients who call your API must use in the invocation URL.
Strategy

The AWS::ApiGateway::BasePathMappingV2 resource creates a base path that clients who call your API must use in the invocation URL.

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.
Supports(IConstruct)

Check if this mixin supports the given construct.

Constructors

CfnBasePathMappingV2PropsMixin(ICfnBasePathMappingV2MixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::ApiGateway::BasePathMappingV2.

public CfnBasePathMappingV2PropsMixin(ICfnBasePathMappingV2MixinProps props, ICfnPropertyMixinOptions? options = null)
Parameters
props ICfnBasePathMappingV2MixinProps

L1 properties to apply.

options ICfnPropertyMixinOptions

Mixin options.

Remarks

Supported only for private custom domain names.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmappingv2.html

CloudformationResource: AWS::ApiGateway::BasePathMappingV2

Mixin: true

ExampleMetadata: fixture=_generated

Properties

CFN_PROPERTY_KEYS

The AWS::ApiGateway::BasePathMappingV2 resource creates a base path that clients who call your API must use in the invocation URL.

protected static string[] CFN_PROPERTY_KEYS { get; }
Property Value

string[]

Remarks

Supported only for private custom domain names.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmappingv2.html

CloudformationResource: AWS::ApiGateway::BasePathMappingV2

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins;

             var cfnBasePathMappingV2PropsMixin = new CfnBasePathMappingV2PropsMixin(new CfnBasePathMappingV2MixinProps {
                 BasePath = "basePath",
                 DomainNameArn = "domainNameArn",
                 RestApiId = "restApiId",
                 Stage = "stage"
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Props

The AWS::ApiGateway::BasePathMappingV2 resource creates a base path that clients who call your API must use in the invocation URL.

protected virtual ICfnBasePathMappingV2MixinProps Props { get; }
Property Value

ICfnBasePathMappingV2MixinProps

Remarks

Supported only for private custom domain names.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmappingv2.html

CloudformationResource: AWS::ApiGateway::BasePathMappingV2

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins;

             var cfnBasePathMappingV2PropsMixin = new CfnBasePathMappingV2PropsMixin(new CfnBasePathMappingV2MixinProps {
                 BasePath = "basePath",
                 DomainNameArn = "domainNameArn",
                 RestApiId = "restApiId",
                 Stage = "stage"
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Strategy

The AWS::ApiGateway::BasePathMappingV2 resource creates a base path that clients who call your API must use in the invocation URL.

protected virtual PropertyMergeStrategy Strategy { get; }
Property Value

PropertyMergeStrategy

Remarks

Supported only for private custom domain names.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmappingv2.html

CloudformationResource: AWS::ApiGateway::BasePathMappingV2

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins;

             var cfnBasePathMappingV2PropsMixin = new CfnBasePathMappingV2PropsMixin(new CfnBasePathMappingV2MixinProps {
                 BasePath = "basePath",
                 DomainNameArn = "domainNameArn",
                 RestApiId = "restApiId",
                 Stage = "stage"
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

public override IConstruct ApplyTo(IConstruct construct)
Parameters
construct IConstruct
Returns

IConstruct

Overrides
Remarks

Supported only for private custom domain names.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmappingv2.html

CloudformationResource: AWS::ApiGateway::BasePathMappingV2

Mixin: true

ExampleMetadata: fixture=_generated

Supports(IConstruct)

Check if this mixin supports the given construct.

public override bool Supports(IConstruct construct)
Parameters
construct IConstruct
Returns

bool

Overrides
Remarks

Supported only for private custom domain names.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmappingv2.html

CloudformationResource: AWS::ApiGateway::BasePathMappingV2

Mixin: true

ExampleMetadata: fixture=_generated

Implements