interface CfnRuleMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.VpcLattice.Mixins.CfnRuleMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsvpclattice/mixins#CfnRuleMixinProps
Java	software.amazon.awscdk.mixins.preview.services.vpclattice.mixins.CfnRuleMixinProps
Python	aws_cdk.mixins_preview.aws_vpclattice.mixins.CfnRuleMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_vpclattice » mixins » CfnRuleMixinProps

Properties for CfnRulePropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as vpclattice_mixins } from '@aws-cdk/mixins-preview/aws-vpclattice';
const cfnRuleMixinProps: vpclattice_mixins.CfnRuleMixinProps = {
  action: {
    fixedResponse: {
      statusCode: 123,
    },
    forward: {
      targetGroups: [{
        targetGroupIdentifier: 'targetGroupIdentifier',
        weight: 123,
      }],
    },
  },
  listenerIdentifier: 'listenerIdentifier',
  match: {
    httpMatch: {
      headerMatches: [{
        caseSensitive: false,
        match: {
          contains: 'contains',
          exact: 'exact',
          prefix: 'prefix',
        },
        name: 'name',
      }],
      method: 'method',
      pathMatch: {
        caseSensitive: false,
        match: {
          exact: 'exact',
          prefix: 'prefix',
        },
      },
    },
  },
  name: 'name',
  priority: 123,
  serviceIdentifier: 'serviceIdentifier',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
action?	IResolvable | ActionProperty	Describes the action for a rule.
listenerIdentifier?	string	The ID or ARN of the listener.
match?	IResolvable | MatchProperty	The rule match.
name?	string	The name of the rule.
priority?	number	The priority assigned to the rule.
serviceIdentifier?	string	The ID or ARN of the service.
tags?	CfnTag[]	The tags for the rule.

---

action?

Type: IResolvable | ActionProperty (optional)

Describes the action for a rule.

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

---

listenerIdentifier?

Type: string (optional)

The ID or ARN of the listener.

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

---

match?

Type: IResolvable | MatchProperty (optional)

The rule match.

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

---

name?

Type: string (optional)

The name of the rule.

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.

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

---

priority?

Type: number (optional)

The priority assigned to the rule.

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

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

---

serviceIdentifier?

Type: string (optional)

The ID or ARN of the service.

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

---

tags?

Type: CfnTag[] (optional)

The tags for the rule.

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