Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. vpclattice
  5. getRule

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.vpclattice.getRule

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    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.

    Using getRule

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRule(args: GetRuleArgs, opts?: InvokeOptions): Promise<GetRuleResult>
function getRuleOutput(args: GetRuleOutputArgs, opts?: InvokeOptions): Output<GetRuleResult>
    def get_rule(arn: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetRuleResult
def get_rule_output(arn: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetRuleResult]
    func LookupRule(ctx *Context, args *LookupRuleArgs, opts ...InvokeOption) (*LookupRuleResult, error)
func LookupRuleOutput(ctx *Context, args *LookupRuleOutputArgs, opts ...InvokeOption) LookupRuleResultOutput

    > Note: This function is named LookupRule in the Go SDK.

    public static class GetRule 
{
    public static Task<GetRuleResult> InvokeAsync(GetRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetRuleResult> Invoke(GetRuleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRuleResult> getRule(GetRuleArgs args, InvokeOptions options)
public static Output<GetRuleResult> getRule(GetRuleArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:vpclattice:getRule
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    The Amazon Resource Name (ARN) of the rule.
    Arn string
    The Amazon Resource Name (ARN) of the rule.
    arn String
    The Amazon Resource Name (ARN) of the rule.
    arn string
    The Amazon Resource Name (ARN) of the rule.
    arn str
    The Amazon Resource Name (ARN) of the rule.
    arn String
    The Amazon Resource Name (ARN) of the rule.

    getRule Result

    The following output properties are available:

    Action Pulumi.AwsNative.VpcLattice.Outputs.RuleAction
    Describes the action for a rule.
    Arn string
    The Amazon Resource Name (ARN) of the rule.
    Id string
    The ID of the listener.
    Match Pulumi.AwsNative.VpcLattice.Outputs.RuleMatch
    The rule match.
    Priority int
    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.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The tags for the rule.
    Action RuleAction
    Describes the action for a rule.
    Arn string
    The Amazon Resource Name (ARN) of the rule.
    Id string
    The ID of the listener.
    Match RuleMatch
    The rule match.
    Priority int
    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.
    Tags Tag
    The tags for the rule.
    action RuleAction
    Describes the action for a rule.
    arn String
    The Amazon Resource Name (ARN) of the rule.
    id String
    The ID of the listener.
    match RuleMatch
    The rule match.
    priority Integer
    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.
    tags List<Tag>
    The tags for the rule.
    action RuleAction
    Describes the action for a rule.
    arn string
    The Amazon Resource Name (ARN) of the rule.
    id string
    The ID of the listener.
    match RuleMatch
    The rule match.
    priority 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.
    tags Tag[]
    The tags for the rule.
    action RuleAction
    Describes the action for a rule.
    arn str
    The Amazon Resource Name (ARN) of the rule.
    id str
    The ID of the listener.
    match RuleMatch
    The rule match.
    priority int
    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.
    tags Sequence[root_Tag]
    The tags for the rule.
    action Property Map
    Describes the action for a rule.
    arn String
    The Amazon Resource Name (ARN) of the rule.
    id String
    The ID of the listener.
    match Property Map
    The rule match.
    priority 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.
    tags List<Property Map>
    The tags for the rule.

    Supporting Types

    RuleAction

    FixedResponse Pulumi.AwsNative.VpcLattice.Inputs.RuleFixedResponse
    The fixed response action. The rule returns a custom HTTP response.
    Forward Pulumi.AwsNative.VpcLattice.Inputs.RuleForward
    The forward action. Traffic that matches the rule is forwarded to the specified target groups.
    FixedResponse RuleFixedResponse
    The fixed response action. The rule returns a custom HTTP response.
    Forward RuleForward
    The forward action. Traffic that matches the rule is forwarded to the specified target groups.
    fixedResponse RuleFixedResponse
    The fixed response action. The rule returns a custom HTTP response.
    forward RuleForward
    The forward action. Traffic that matches the rule is forwarded to the specified target groups.
    fixedResponse RuleFixedResponse
    The fixed response action. The rule returns a custom HTTP response.
    forward RuleForward
    The forward action. Traffic that matches the rule is forwarded to the specified target groups.
    fixed_response RuleFixedResponse
    The fixed response action. The rule returns a custom HTTP response.
    forward RuleForward
    The forward action. Traffic that matches the rule is forwarded to the specified target groups.
    fixedResponse Property Map
    The fixed response action. The rule returns a custom HTTP response.
    forward Property Map
    The forward action. Traffic that matches the rule is forwarded to the specified target groups.

    RuleFixedResponse

    StatusCode int
    The HTTP response code.
    StatusCode int
    The HTTP response code.
    statusCode Integer
    The HTTP response code.
    statusCode number
    The HTTP response code.
    status_code int
    The HTTP response code.
    statusCode Number
    The HTTP response code.

    RuleForward

    TargetGroups List<Pulumi.AwsNative.VpcLattice.Inputs.RuleWeightedTargetGroup>

    The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

    The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group.

    TargetGroups []RuleWeightedTargetGroup

    The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

    The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group.

    targetGroups List<RuleWeightedTargetGroup>

    The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

    The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group.

    targetGroups RuleWeightedTargetGroup[]

    The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

    The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group.

    target_groups Sequence[RuleWeightedTargetGroup]

    The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

    The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group.

    targetGroups List<Property Map>

    The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

    The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group.

    RuleHeaderMatch

    Match Pulumi.AwsNative.VpcLattice.Inputs.RuleHeaderMatchType
    The header match type.
    Name string
    The name of the header.
    CaseSensitive bool
    Indicates whether the match is case sensitive.
    Match RuleHeaderMatchType
    The header match type.
    Name string
    The name of the header.
    CaseSensitive bool
    Indicates whether the match is case sensitive.
    match RuleHeaderMatchType
    The header match type.
    name String
    The name of the header.
    caseSensitive Boolean
    Indicates whether the match is case sensitive.
    match RuleHeaderMatchType
    The header match type.
    name string
    The name of the header.
    caseSensitive boolean
    Indicates whether the match is case sensitive.
    match RuleHeaderMatchType
    The header match type.
    name str
    The name of the header.
    case_sensitive bool
    Indicates whether the match is case sensitive.
    match Property Map
    The header match type.
    name String
    The name of the header.
    caseSensitive Boolean
    Indicates whether the match is case sensitive.

    RuleHeaderMatchType

    Contains string
    A contains type match.
    Exact string
    An exact type match.
    Prefix string
    A prefix type match. Matches the value with the prefix.
    Contains string
    A contains type match.
    Exact string
    An exact type match.
    Prefix string
    A prefix type match. Matches the value with the prefix.
    contains String
    A contains type match.
    exact String
    An exact type match.
    prefix String
    A prefix type match. Matches the value with the prefix.
    contains string
    A contains type match.
    exact string
    An exact type match.
    prefix string
    A prefix type match. Matches the value with the prefix.
    contains str
    A contains type match.
    exact str
    An exact type match.
    prefix str
    A prefix type match. Matches the value with the prefix.
    contains String
    A contains type match.
    exact String
    An exact type match.
    prefix String
    A prefix type match. Matches the value with the prefix.

    RuleHttpMatch

    HeaderMatches List<Pulumi.AwsNative.VpcLattice.Inputs.RuleHeaderMatch>
    The header matches. Matches incoming requests with rule based on request header value before applying rule action.
    Method Pulumi.AwsNative.VpcLattice.RuleHttpMatchMethod
    The HTTP method type.
    PathMatch Pulumi.AwsNative.VpcLattice.Inputs.RulePathMatch
    The path match.
    HeaderMatches []RuleHeaderMatch
    The header matches. Matches incoming requests with rule based on request header value before applying rule action.
    Method RuleHttpMatchMethod
    The HTTP method type.
    PathMatch RulePathMatch
    The path match.
    headerMatches List<RuleHeaderMatch>
    The header matches. Matches incoming requests with rule based on request header value before applying rule action.
    method RuleHttpMatchMethod
    The HTTP method type.
    pathMatch RulePathMatch
    The path match.
    headerMatches RuleHeaderMatch[]
    The header matches. Matches incoming requests with rule based on request header value before applying rule action.
    method RuleHttpMatchMethod
    The HTTP method type.
    pathMatch RulePathMatch
    The path match.
    header_matches Sequence[RuleHeaderMatch]
    The header matches. Matches incoming requests with rule based on request header value before applying rule action.
    method RuleHttpMatchMethod
    The HTTP method type.
    path_match RulePathMatch
    The path match.
    headerMatches List<Property Map>
    The header matches. Matches incoming requests with rule based on request header value before applying rule action.
    method "CONNECT" | "DELETE" | "GET" | "HEAD" | "OPTIONS" | "POST" | "PUT" | "TRACE"
    The HTTP method type.
    pathMatch Property Map
    The path match.

    RuleHttpMatchMethod

    RuleMatch

    HttpMatch Pulumi.AwsNative.VpcLattice.Inputs.RuleHttpMatch
    The HTTP criteria that a rule must match.
    HttpMatch RuleHttpMatch
    The HTTP criteria that a rule must match.
    httpMatch RuleHttpMatch
    The HTTP criteria that a rule must match.
    httpMatch RuleHttpMatch
    The HTTP criteria that a rule must match.
    http_match RuleHttpMatch
    The HTTP criteria that a rule must match.
    httpMatch Property Map
    The HTTP criteria that a rule must match.

    RulePathMatch

    Match Pulumi.AwsNative.VpcLattice.Inputs.RulePathMatchType
    The type of path match.
    CaseSensitive bool
    Indicates whether the match is case sensitive.
    Match RulePathMatchType
    The type of path match.
    CaseSensitive bool
    Indicates whether the match is case sensitive.
    match RulePathMatchType
    The type of path match.
    caseSensitive Boolean
    Indicates whether the match is case sensitive.
    match RulePathMatchType
    The type of path match.
    caseSensitive boolean
    Indicates whether the match is case sensitive.
    match RulePathMatchType
    The type of path match.
    case_sensitive bool
    Indicates whether the match is case sensitive.
    match Property Map
    The type of path match.
    caseSensitive Boolean
    Indicates whether the match is case sensitive.

    RulePathMatchType

    Exact string
    An exact match of the path.
    Prefix string
    A prefix match of the path.
    Exact string
    An exact match of the path.
    Prefix string
    A prefix match of the path.
    exact String
    An exact match of the path.
    prefix String
    A prefix match of the path.
    exact string
    An exact match of the path.
    prefix string
    A prefix match of the path.
    exact str
    An exact match of the path.
    prefix str
    A prefix match of the path.
    exact String
    An exact match of the path.
    prefix String
    A prefix match of the path.

    RuleWeightedTargetGroup

    TargetGroupIdentifier string
    The ID of the target group.
    Weight int
    Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.
    TargetGroupIdentifier string
    The ID of the target group.
    Weight int
    Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.
    targetGroupIdentifier String
    The ID of the target group.
    weight Integer
    Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.
    targetGroupIdentifier string
    The ID of the target group.
    weight number
    Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.
    target_group_identifier str
    The ID of the target group.
    weight int
    Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.
    targetGroupIdentifier String
    The ID of the target group.
    weight Number
    Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native