1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. apigatewayv2
  5. getRoutingRule

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

AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi

aws-native.apigatewayv2.getRoutingRule

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi

    Schema for AWS::ApiGatewayV2::RoutingRule

    Using getRoutingRule

    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 getRoutingRule(args: GetRoutingRuleArgs, opts?: InvokeOptions): Promise<GetRoutingRuleResult>
    function getRoutingRuleOutput(args: GetRoutingRuleOutputArgs, opts?: InvokeOptions): Output<GetRoutingRuleResult>
    def get_routing_rule(routing_rule_arn: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetRoutingRuleResult
    def get_routing_rule_output(routing_rule_arn: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetRoutingRuleResult]
    func LookupRoutingRule(ctx *Context, args *LookupRoutingRuleArgs, opts ...InvokeOption) (*LookupRoutingRuleResult, error)
    func LookupRoutingRuleOutput(ctx *Context, args *LookupRoutingRuleOutputArgs, opts ...InvokeOption) LookupRoutingRuleResultOutput

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

    public static class GetRoutingRule 
    {
        public static Task<GetRoutingRuleResult> InvokeAsync(GetRoutingRuleArgs args, InvokeOptions? opts = null)
        public static Output<GetRoutingRuleResult> Invoke(GetRoutingRuleInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRoutingRuleResult> getRoutingRule(GetRoutingRuleArgs args, InvokeOptions options)
    public static Output<GetRoutingRuleResult> getRoutingRule(GetRoutingRuleArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aws-native:apigatewayv2:getRoutingRule
      arguments:
        # arguments dictionary

    The following arguments are supported:

    RoutingRuleArn string
    Amazon Resource Name (ARN) of the resource.
    RoutingRuleArn string
    Amazon Resource Name (ARN) of the resource.
    routingRuleArn String
    Amazon Resource Name (ARN) of the resource.
    routingRuleArn string
    Amazon Resource Name (ARN) of the resource.
    routing_rule_arn str
    Amazon Resource Name (ARN) of the resource.
    routingRuleArn String
    Amazon Resource Name (ARN) of the resource.

    getRoutingRule Result

    The following output properties are available:

    Actions []RoutingRuleAction
    Conditions []RoutingRuleCondition
    Priority int
    RoutingRuleArn string
    Amazon Resource Name (ARN) of the resource.
    RoutingRuleId string
    RoutingRule Id generated by service
    actions List<RoutingRuleAction>
    conditions List<RoutingRuleCondition>
    priority Integer
    routingRuleArn String
    Amazon Resource Name (ARN) of the resource.
    routingRuleId String
    RoutingRule Id generated by service
    actions RoutingRuleAction[]
    conditions RoutingRuleCondition[]
    priority number
    routingRuleArn string
    Amazon Resource Name (ARN) of the resource.
    routingRuleId string
    RoutingRule Id generated by service
    actions Sequence[RoutingRuleAction]
    conditions Sequence[RoutingRuleCondition]
    priority int
    routing_rule_arn str
    Amazon Resource Name (ARN) of the resource.
    routing_rule_id str
    RoutingRule Id generated by service
    actions List<Property Map>
    conditions List<Property Map>
    priority Number
    routingRuleArn String
    Amazon Resource Name (ARN) of the resource.
    routingRuleId String
    RoutingRule Id generated by service

    Supporting Types

    RoutingRuleAction

    RoutingRuleActionInvokeApi

    ApiId string
    Stage string
    StripBasePath bool
    ApiId string
    Stage string
    StripBasePath bool
    apiId String
    stage String
    stripBasePath Boolean
    apiId string
    stage string
    stripBasePath boolean
    apiId String
    stage String
    stripBasePath Boolean

    RoutingRuleCondition

    RoutingRuleMatchBasePaths

    AnyOf List<string>
    AnyOf []string
    anyOf List<String>
    anyOf string[]
    any_of Sequence[str]
    anyOf List<String>

    RoutingRuleMatchHeaderValue

    Header string
    ValueGlob string
    Header string
    ValueGlob string
    header String
    valueGlob String
    header string
    valueGlob string
    header String
    valueGlob String

    RoutingRuleMatchHeaders

    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.28.0 published on Monday, May 19, 2025 by Pulumi