Create Rule

vpclattice_create_rule

R Documentation

Creates a listener rule

Description

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. For more information, see Listener rules in the Amazon VPC Lattice User Guide.

Usage

vpclattice_create_rule(action, clientToken, listenerIdentifier, match,
  name, priority, serviceIdentifier, tags)

Arguments

action

[required] The action for the default rule.

clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

listenerIdentifier

[required] The ID or Amazon Resource Name (ARN) of the listener.

match

[required] The rule match.

name

[required] 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.

priority

[required] 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.

serviceIdentifier

[required] The ID or Amazon Resource Name (ARN) of the service.

tags

The tags for the rule.

Value

A list with the following syntax:

list(
  action = list(
    fixedResponse = list(
      statusCode = 123
    ),
    forward = list(
      targetGroups = list(
        list(
          targetGroupIdentifier = "string",
          weight = 123
        )
      )
    )
  ),
  arn = "string",
  id = "string",
  match = list(
    httpMatch = list(
      headerMatches = list(
        list(
          caseSensitive = TRUE|FALSE,
          match = list(
            contains = "string",
            exact = "string",
            prefix = "string"
          ),
          name = "string"
        )
      ),
      method = "string",
      pathMatch = list(
        caseSensitive = TRUE|FALSE,
        match = list(
          exact = "string",
          prefix = "string"
        )
      )
    )
  ),
  name = "string",
  priority = 123
)

Request syntax

svc$create_rule(
  action = list(
    fixedResponse = list(
      statusCode = 123
    ),
    forward = list(
      targetGroups = list(
        list(
          targetGroupIdentifier = "string",
          weight = 123
        )
      )
    )
  ),
  clientToken = "string",
  listenerIdentifier = "string",
  match = list(
    httpMatch = list(
      headerMatches = list(
        list(
          caseSensitive = TRUE|FALSE,
          match = list(
            contains = "string",
            exact = "string",
            prefix = "string"
          ),
          name = "string"
        )
      ),
      method = "string",
      pathMatch = list(
        caseSensitive = TRUE|FALSE,
        match = list(
          exact = "string",
          prefix = "string"
        )
      )
    )
  ),
  name = "string",
  priority = 123,
  serviceIdentifier = "string",
  tags = list(
    "string"
  )
)