Show / Hide Table of Contents

Class CfnRuleProps

Properties for defining a CfnRule.

Inheritance
System.Object
CfnRuleProps
Implements
ICfnRuleProps
Namespace: Amazon.CDK.AWS.VpcLattice
Assembly: Amazon.CDK.AWS.VpcLattice.dll
Syntax (csharp)
public class CfnRuleProps : Object, ICfnRuleProps
Syntax (vb)
Public Class CfnRuleProps
    Inherits Object
    Implements ICfnRuleProps
Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html

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.VpcLattice;

var cfnRuleProps = new CfnRuleProps {
    Action = new ActionProperty {
        FixedResponse = new FixedResponseProperty {
            StatusCode = 123
        },
        Forward = new ForwardProperty {
            TargetGroups = new [] { new WeightedTargetGroupProperty {
                TargetGroupIdentifier = "targetGroupIdentifier",

                // the properties below are optional
                Weight = 123
            } }
        }
    },
    Match = new MatchProperty {
        HttpMatch = new HttpMatchProperty {
            HeaderMatches = new [] { new HeaderMatchProperty {
                Match = new HeaderMatchTypeProperty {
                    Contains = "contains",
                    Exact = "exact",
                    Prefix = "prefix"
                },
                Name = "name",

                // the properties below are optional
                CaseSensitive = false
            } },
            Method = "method",
            PathMatch = new PathMatchProperty {
                Match = new PathMatchTypeProperty {
                    Exact = "exact",
                    Prefix = "prefix"
                },

                // the properties below are optional
                CaseSensitive = false
            }
        }
    },
    Priority = 123,

    // the properties below are optional
    ListenerIdentifier = "listenerIdentifier",
    Name = "name",
    ServiceIdentifier = "serviceIdentifier",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};

Synopsis

Constructors

CfnRuleProps()

Properties

Action

Describes the action for a rule.

ListenerIdentifier

The ID or Amazon Resource Name (ARN) of the listener.

Match

The rule match.

Name

The name of the rule.

Priority

The priority assigned to the rule.

ServiceIdentifier

The ID or Amazon Resource Name (ARN) of the service.

Tags

The tags for the rule.

Constructors

CfnRuleProps()

public CfnRuleProps()

Properties

Action

Describes the action for a rule.

public object Action { get; set; }
Property Value

System.Object

Remarks

Each rule must include exactly one of the following types of actions: forward or fixed-response , and it must be the last action to be performed.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html#cfn-vpclattice-rule-action

ListenerIdentifier

The ID or Amazon Resource Name (ARN) of the listener.

public string ListenerIdentifier { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html#cfn-vpclattice-rule-listeneridentifier

Match

The rule match.

public object Match { get; set; }
Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html#cfn-vpclattice-rule-match

Name

The name of the rule.

public string Name { get; set; }
Property Value

System.String

Remarks

The name must be unique within the listener. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

If you don't specify a name, CloudFormation generates one. However, if you specify a name, and later want to replace the resource, you must specify a new name.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html#cfn-vpclattice-rule-name

Priority

The priority assigned to the rule.

public double Priority { get; set; }
Property Value

System.Double

Remarks

Each rule for a specific listener must have a unique priority. The lower the priority number the higher the priority.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html#cfn-vpclattice-rule-priority

ServiceIdentifier

The ID or Amazon Resource Name (ARN) of the service.

public string ServiceIdentifier { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html#cfn-vpclattice-rule-serviceidentifier

Tags

The tags for the rule.

public ICfnTag[] Tags { get; set; }
Property Value

ICfnTag[]

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html#cfn-vpclattice-rule-tags

Implements

ICfnRuleProps
Back to top Generated by DocFX