interface CfnRuleProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.VpcLattice.CfnRuleProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsvpclattice#CfnRuleProps |
![]() | software.amazon.awscdk.services.vpclattice.CfnRuleProps |
![]() | aws_cdk.aws_vpclattice.CfnRuleProps |
![]() | aws-cdk-lib » aws_vpclattice » CfnRuleProps |
Properties for defining a CfnRule
.
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-lib';
const cfnRuleProps: vpclattice.CfnRuleProps = {
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',
}],
};
Properties
Name | Type | Description |
---|---|---|
action | IResolvable | Action | Describes the action for a rule. |
match | IResolvable | Match | The rule match. |
priority | number | The priority assigned to the rule. |
listener | string | The ID or ARN of the listener. |
name? | string | The name of the rule. |
service | string | The ID or ARN of the service. |
tags? | Cfn [] | The tags for the rule. |
action
Type:
IResolvable
|
Action
Describes the action for a rule.
match
Type:
IResolvable
|
Match
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 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 ARN of the service.
tags?
Type:
Cfn
[]
(optional)
The tags for the rule.