Get Rule

vpclattice_get_rule

R Documentation

Retrieves information about listener rules

Description

Retrieves information about listener rules. You can also retrieve information about the default listener rule. For more information, see Listener rules in the Amazon VPC Lattice User Guide.

Usage

vpclattice_get_rule(listenerIdentifier, ruleIdentifier,
  serviceIdentifier)

Arguments

listenerIdentifier

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

ruleIdentifier

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

serviceIdentifier

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

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",
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  id = "string",
  isDefault = TRUE|FALSE,
  lastUpdatedAt = as.POSIXct(
    "2015-01-01"
  ),
  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$get_rule(
  listenerIdentifier = "string",
  ruleIdentifier = "string",
  serviceIdentifier = "string"
)