AWS Native is in preview. AWS Classic is fully supported.
aws-native.vpclattice.Rule
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
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.
Create Rule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Rule(name: string, args: RuleArgs, opts?: CustomResourceOptions);
@overload
def Rule(resource_name: str,
args: RuleArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Rule(resource_name: str,
opts: Optional[ResourceOptions] = None,
action: Optional[RuleActionArgs] = None,
match: Optional[RuleMatchArgs] = None,
priority: Optional[int] = None,
listener_identifier: Optional[str] = None,
name: Optional[str] = None,
service_identifier: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewRule(ctx *Context, name string, args RuleArgs, opts ...ResourceOption) (*Rule, error)
public Rule(string name, RuleArgs args, CustomResourceOptions? opts = null)
type: aws-native:vpclattice:Rule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args RuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args RuleArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args RuleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RuleArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const exampleruleResourceResourceFromVpclattice = new aws_native.vpclattice.Rule("exampleruleResourceResourceFromVpclattice", {
action: {
fixedResponse: {
statusCode: 0,
},
forward: {
targetGroups: [{
targetGroupIdentifier: "string",
weight: 0,
}],
},
},
match: {
httpMatch: {
headerMatches: [{
match: {
contains: "string",
exact: "string",
prefix: "string",
},
name: "string",
caseSensitive: false,
}],
method: aws_native.vpclattice.RuleHttpMatchMethod.Connect,
pathMatch: {
match: {
exact: "string",
prefix: "string",
},
caseSensitive: false,
},
},
},
priority: 0,
listenerIdentifier: "string",
name: "string",
serviceIdentifier: "string",
tags: [{
key: "string",
value: "string",
}],
});
Coming soon!
Rule Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Rule resource accepts the following input properties:
- Action
Rule
Action Args - Match
Rule
Match Args - Priority int
- Listener
Identifier string - Name string
- Service
Identifier string - Tag
Args
- action
Rule
Action - match
Rule
Match - priority Integer
- listener
Identifier String - name String
- service
Identifier String - List<Tag>
- action
Rule
Action - match
Rule
Match - priority number
- listener
Identifier string - name string
- service
Identifier string - Tag[]
- action Property Map
- match Property Map
- priority Number
- listener
Identifier String - name String
- service
Identifier String - List<Property Map>
Outputs
All input properties are implicitly available as output properties. Additionally, the Rule resource produces the following output properties:
Supporting Types
RuleAction, RuleActionArgs
RuleFixedResponse, RuleFixedResponseArgs
- Status
Code int
- Status
Code int
- status
Code Integer
- status
Code number
- status_
code int
- status
Code Number
RuleForward, RuleForwardArgs
RuleHeaderMatch, RuleHeaderMatchArgs
- Match
Rule
Header Match Type - Name string
- Case
Sensitive bool
- match
Rule
Header Match Type - name String
- case
Sensitive Boolean
- match
Rule
Header Match Type - name string
- case
Sensitive boolean
- match Property Map
- name String
- case
Sensitive Boolean
RuleHeaderMatchType, RuleHeaderMatchTypeArgs
RuleHttpMatch, RuleHttpMatchArgs
RuleHttpMatchMethod, RuleHttpMatchMethodArgs
- Connect
- CONNECT
- Delete
- DELETE
- Get
- GET
- Head
- HEAD
- Options
- OPTIONS
- Post
- POST
- Put
- PUT
- Trace
- TRACE
- Rule
Http Match Method Connect - CONNECT
- Rule
Http Match Method Delete - DELETE
- Rule
Http Match Method Get - GET
- Rule
Http Match Method Head - HEAD
- Rule
Http Match Method Options - OPTIONS
- Rule
Http Match Method Post - POST
- Rule
Http Match Method Put - PUT
- Rule
Http Match Method Trace - TRACE
- Connect
- CONNECT
- Delete
- DELETE
- Get
- GET
- Head
- HEAD
- Options
- OPTIONS
- Post
- POST
- Put
- PUT
- Trace
- TRACE
- Connect
- CONNECT
- Delete
- DELETE
- Get
- GET
- Head
- HEAD
- Options
- OPTIONS
- Post
- POST
- Put
- PUT
- Trace
- TRACE
- CONNECT
- CONNECT
- DELETE
- DELETE
- GET
- GET
- HEAD
- HEAD
- OPTIONS
- OPTIONS
- POST
- POST
- PUT
- PUT
- TRACE
- TRACE
- "CONNECT"
- CONNECT
- "DELETE"
- DELETE
- "GET"
- GET
- "HEAD"
- HEAD
- "OPTIONS"
- OPTIONS
- "POST"
- POST
- "PUT"
- PUT
- "TRACE"
- TRACE
RuleMatch, RuleMatchArgs
RulePathMatch, RulePathMatchArgs
- match
Rule
Path Match Type - case
Sensitive Boolean
- match
Rule
Path Match Type - case
Sensitive boolean
- match Property Map
- case
Sensitive Boolean
RulePathMatchType, RulePathMatchTypeArgs
RuleWeightedTargetGroup, RuleWeightedTargetGroupArgs
- Target
Group stringIdentifier - Weight int
- Target
Group stringIdentifier - Weight int
- target
Group StringIdentifier - weight Integer
- target
Group stringIdentifier - weight number
- target_
group_ stridentifier - weight int
- target
Group StringIdentifier - weight Number
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.