class CfnRule (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.VpcLattice.CfnRule`
Java	`software.amazon.awscdk.services.vpclattice.CfnRule`
Python	`aws_cdk.aws_vpclattice.CfnRule`
TypeScript	`@aws-cdk/aws-vpclattice` » `CfnRule`

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::VpcLattice::Rule.

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 .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as vpclattice from '@aws-cdk/aws-vpclattice';
const cfnRule = new vpclattice.CfnRule(this, 'MyCfnRule', {
  action: {
    fixedResponse: {
      statusCode: 123,
    },
    forward: {
      targetGroups: [{
        targetGroupIdentifier: 'targetGroupIdentifier',

        // the properties below are optional
        weight: 123,
      }],
    },
  },
  match: {
    httpMatch: {
      headerMatches: [{
        match: {
          contains: 'contains',
          exact: 'exact',
          prefix: 'prefix',
        },
        name: 'name',

        // the properties below are optional
        caseSensitive: false,
      }],
      method: 'method',
      pathMatch: {
        match: {
          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: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnRule(scope: Construct, id: string, props: CfnRuleProps)

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnRuleProps — - resource properties.

Create a new AWS::VpcLattice::Rule.

Construct Props

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

action

Type: IResolvable | ActionProperty

Describes the action for a rule.

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.

match

Type: IResolvable | MatchProperty

The rule match.

priority

Type: number

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.

listenerIdentifier?

Type: string (optional)

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

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.

serviceIdentifier?

Type: string (optional)

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

tags?

Type: CfnTag[] (optional)

The tags for the rule.

Properties

Name	Type	Description
action	`IResolvable` `\|` `ActionProperty`	Describes the action for a rule.
attrArn	`string`	The Amazon Resource Name (ARN) of the rule.
attrId	`string`	The ID of the listener.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
match	`IResolvable` `\|` `MatchProperty`	The rule match.
node	`ConstructNode`	The construct tree node associated with this construct.
priority	`number`	The priority assigned to the rule.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	The tags for the rule.
listenerIdentifier?	`string`	The ID or Amazon Resource Name (ARN) of the listener.
name?	`string`	The name of the rule.
serviceIdentifier?	`string`	The ID or Amazon Resource Name (ARN) of the service.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

action

Type: IResolvable | ActionProperty

Describes the action for a rule.

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.

attrArn

Type: string

The Amazon Resource Name (ARN) of the rule.

attrId

Type: string

The ID of the listener.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

match

Type: IResolvable | MatchProperty

The rule match.

node

Type: ConstructNode

The construct tree node associated with this construct.

priority

Type: number

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.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

listenerIdentifier?

Type: string (optional)

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

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.

serviceIdentifier?

Type: string (optional)

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

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }