class CfnRulePropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.VpcLattice.CfnRulePropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsvpclattice#CfnRulePropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.vpclattice.CfnRulePropsMixin
Python	aws_cdk.cfn_property_mixins.aws_vpclattice.CfnRulePropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_vpclattice » CfnRulePropsMixin

Implements IMixin

Extends Mixin

Creates a listener rule.

Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions. For more information, see Listener rules in the Amazon VPC Lattice User Guide .

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 { aws_vpclattice as vpclattice } from '@aws-cdk/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnRulePropsMixin = new vpclattice.CfnRulePropsMixin({
  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',
  }],
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnRulePropsMixin(props: CfnRuleMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnRuleMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::VpcLattice::Rule.

Properties

Name	Type	Description
props	CfnRuleMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnRuleMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.