Skip to content

Create Routing Rule

apigatewayv2_create_routing_rule R Documentation

Creates a RoutingRule

Description

Creates a RoutingRule.

Usage

apigatewayv2_create_routing_rule(Actions, Conditions, DomainName,
  DomainNameId, Priority)

Arguments

Actions

[required] Represents a routing rule action. The only supported action is invokeApi.

Conditions

[required] Represents a condition. Conditions can contain up to two matchHeaders conditions and one matchBasePaths conditions. API Gateway evaluates header conditions and base path conditions together. You can only use AND between header and base path conditions.

DomainName

[required] The domain name.

DomainNameId

The domain name ID.

Priority

[required] Represents the priority of the routing rule.

Value

A list with the following syntax:

list(
  Actions = list(
    list(
      InvokeApi = list(
        ApiId = "string",
        Stage = "string",
        StripBasePath = TRUE|FALSE
      )
    )
  ),
  Conditions = list(
    list(
      MatchBasePaths = list(
        AnyOf = list(
          "string"
        )
      ),
      MatchHeaders = list(
        AnyOf = list(
          list(
            Header = "string",
            ValueGlob = "string"
          )
        )
      )
    )
  ),
  Priority = 123,
  RoutingRuleArn = "string",
  RoutingRuleId = "string"
)

Request syntax

svc$create_routing_rule(
  Actions = list(
    list(
      InvokeApi = list(
        ApiId = "string",
        Stage = "string",
        StripBasePath = TRUE|FALSE
      )
    )
  ),
  Conditions = list(
    list(
      MatchBasePaths = list(
        AnyOf = list(
          "string"
        )
      ),
      MatchHeaders = list(
        AnyOf = list(
          list(
            Header = "string",
            ValueGlob = "string"
          )
        )
      )
    )
  ),
  DomainName = "string",
  DomainNameId = "string",
  Priority = 123
)