Skip to content

Batch Update Rule

vpclattice_batch_update_rule R Documentation

Updates the listener rules in a batch

Description

Updates the listener rules in a batch. You can use this operation to change the priority of listener rules. This can be useful when bulk updating or swapping rule priority.

Required permissions: vpc-lattice:UpdateRule

For more information, see How Amazon VPC Lattice works with IAM in the Amazon VPC Lattice User Guide.

Usage

vpclattice_batch_update_rule(listenerIdentifier, rules,
  serviceIdentifier)

Arguments

listenerIdentifier

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

rules

[required] The rules for the specified listener.

serviceIdentifier

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

Value

A list with the following syntax:

list(
  successful = list(
    list(
      action = list(
        fixedResponse = list(
          statusCode = 123
        ),
        forward = list(
          targetGroups = list(
            list(
              targetGroupIdentifier = "string",
              weight = 123
            )
          )
        )
      ),
      arn = "string",
      id = "string",
      isDefault = TRUE|FALSE,
      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
    )
  ),
  unsuccessful = list(
    list(
      failureCode = "string",
      failureMessage = "string",
      ruleIdentifier = "string"
    )
  )
)

Request syntax

svc$batch_update_rule(
  listenerIdentifier = "string",
  rules = list(
    list(
      action = list(
        fixedResponse = list(
          statusCode = 123
        ),
        forward = list(
          targetGroups = list(
            list(
              targetGroupIdentifier = "string",
              weight = 123
            )
          )
        )
      ),
      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"
            )
          )
        )
      ),
      priority = 123,
      ruleIdentifier = "string"
    )
  ),
  serviceIdentifier = "string"
)