Class CfnRoutingRulePropsMixin

Represents a routing rule.

Inheritance

object

Mixin

CfnRoutingRulePropsMixin

Implements

IMixin

Inherited Members

Mixin.IsMixin(object)

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.ApiGatewayV2

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnRoutingRulePropsMixin : Mixin, IMixin

Syntax (vb)

Public Class CfnRoutingRulePropsMixin Inherits Mixin Implements IMixin

Remarks

When the incoming request to a domain name matches the conditions for a rule, API Gateway invokes a stage of a target API. Supported only for REST APIs.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routingrule.html

CloudformationResource: AWS::ApiGatewayV2::RoutingRule

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.CfnPropertyMixins.AWS.ApiGatewayV2;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnRoutingRulePropsMixin = new CfnRoutingRulePropsMixin(new CfnRoutingRuleMixinProps {
                 Actions = new [] { new ActionProperty {
                     InvokeApi = new ActionInvokeApiProperty {
                         ApiId = "apiId",
                         Stage = "stage",
                         StripBasePath = false
                     }
                 } },
                 Conditions = new [] { new ConditionProperty {
                     MatchBasePaths = new MatchBasePathsProperty {
                         AnyOf = new [] { "anyOf" }
                     },
                     MatchHeaders = new MatchHeadersProperty {
                         AnyOf = new [] { new MatchHeaderValueProperty {
                             Header = "header",
                             ValueGlob = "valueGlob"
                         } }
                     }
                 } },
                 DomainNameArn = "domainNameArn",
                 Priority = 123
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Synopsis

Constructors

CfnRoutingRulePropsMixin(ICfnRoutingRuleMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::ApiGatewayV2::RoutingRule.

Properties

CFN_PROPERTY_KEYS	Represents a routing rule.
Props	Represents a routing rule.
Strategy	Represents a routing rule.

Methods

ApplyTo(IConstruct)	Apply the mixin properties to the construct.
Supports(IConstruct)	Check if this mixin supports the given construct.

Constructors

CfnRoutingRulePropsMixin(ICfnRoutingRuleMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::ApiGatewayV2::RoutingRule.

public CfnRoutingRulePropsMixin(ICfnRoutingRuleMixinProps props, ICfnPropertyMixinOptions? options = null)

Parameters

props ICfnRoutingRuleMixinProps

L1 properties to apply.

options ICfnPropertyMixinOptions

Mixin options.

Remarks

When the incoming request to a domain name matches the conditions for a rule, API Gateway invokes a stage of a target API. Supported only for REST APIs.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routingrule.html

CloudformationResource: AWS::ApiGatewayV2::RoutingRule

Mixin: true

ExampleMetadata: fixture=_generated

Properties

CFN_PROPERTY_KEYS

Represents a routing rule.

protected static string[] CFN_PROPERTY_KEYS { get; }

Property Value

string[]

Remarks

When the incoming request to a domain name matches the conditions for a rule, API Gateway invokes a stage of a target API. Supported only for REST APIs.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routingrule.html

CloudformationResource: AWS::ApiGatewayV2::RoutingRule

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.CfnPropertyMixins.AWS.ApiGatewayV2;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnRoutingRulePropsMixin = new CfnRoutingRulePropsMixin(new CfnRoutingRuleMixinProps {
                 Actions = new [] { new ActionProperty {
                     InvokeApi = new ActionInvokeApiProperty {
                         ApiId = "apiId",
                         Stage = "stage",
                         StripBasePath = false
                     }
                 } },
                 Conditions = new [] { new ConditionProperty {
                     MatchBasePaths = new MatchBasePathsProperty {
                         AnyOf = new [] { "anyOf" }
                     },
                     MatchHeaders = new MatchHeadersProperty {
                         AnyOf = new [] { new MatchHeaderValueProperty {
                             Header = "header",
                             ValueGlob = "valueGlob"
                         } }
                     }
                 } },
                 DomainNameArn = "domainNameArn",
                 Priority = 123
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Props

Represents a routing rule.

protected virtual ICfnRoutingRuleMixinProps Props { get; }

Property Value

ICfnRoutingRuleMixinProps

Remarks

When the incoming request to a domain name matches the conditions for a rule, API Gateway invokes a stage of a target API. Supported only for REST APIs.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routingrule.html

CloudformationResource: AWS::ApiGatewayV2::RoutingRule

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.CfnPropertyMixins.AWS.ApiGatewayV2;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnRoutingRulePropsMixin = new CfnRoutingRulePropsMixin(new CfnRoutingRuleMixinProps {
                 Actions = new [] { new ActionProperty {
                     InvokeApi = new ActionInvokeApiProperty {
                         ApiId = "apiId",
                         Stage = "stage",
                         StripBasePath = false
                     }
                 } },
                 Conditions = new [] { new ConditionProperty {
                     MatchBasePaths = new MatchBasePathsProperty {
                         AnyOf = new [] { "anyOf" }
                     },
                     MatchHeaders = new MatchHeadersProperty {
                         AnyOf = new [] { new MatchHeaderValueProperty {
                             Header = "header",
                             ValueGlob = "valueGlob"
                         } }
                     }
                 } },
                 DomainNameArn = "domainNameArn",
                 Priority = 123
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Strategy

Represents a routing rule.

protected virtual IMergeStrategy Strategy { get; }

Property Value

IMergeStrategy

Remarks

When the incoming request to a domain name matches the conditions for a rule, API Gateway invokes a stage of a target API. Supported only for REST APIs.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routingrule.html

CloudformationResource: AWS::ApiGatewayV2::RoutingRule

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.CfnPropertyMixins.AWS.ApiGatewayV2;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnRoutingRulePropsMixin = new CfnRoutingRulePropsMixin(new CfnRoutingRuleMixinProps {
                 Actions = new [] { new ActionProperty {
                     InvokeApi = new ActionInvokeApiProperty {
                         ApiId = "apiId",
                         Stage = "stage",
                         StripBasePath = false
                     }
                 } },
                 Conditions = new [] { new ConditionProperty {
                     MatchBasePaths = new MatchBasePathsProperty {
                         AnyOf = new [] { "anyOf" }
                     },
                     MatchHeaders = new MatchHeadersProperty {
                         AnyOf = new [] { new MatchHeaderValueProperty {
                             Header = "header",
                             ValueGlob = "valueGlob"
                         } }
                     }
                 } },
                 DomainNameArn = "domainNameArn",
                 Priority = 123
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

public override void ApplyTo(IConstruct construct)

Parameters

construct IConstruct

Overrides

Mixin.ApplyTo(IConstruct)

Remarks

When the incoming request to a domain name matches the conditions for a rule, API Gateway invokes a stage of a target API. Supported only for REST APIs.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routingrule.html

CloudformationResource: AWS::ApiGatewayV2::RoutingRule

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

Mixin.Supports(IConstruct)

Remarks

When the incoming request to a domain name matches the conditions for a rule, API Gateway invokes a stage of a target API. Supported only for REST APIs.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routingrule.html

CloudformationResource: AWS::ApiGatewayV2::RoutingRule

Mixin: true

ExampleMetadata: fixture=_generated

Implements

Constructs.IMixin