vpclattice_create_listener: Creates a listener for a service

View source: R/vpclattice_operations.R

vpclattice_create_listenerR Documentation

Creates a listener for a service

Description

Creates a listener for a service. Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide.

See https://www.paws-r-sdk.com/docs/vpclattice_create_listener/ for full documentation.

Usage

vpclattice_create_listener(
  clientToken = NULL,
  defaultAction,
  name,
  port = NULL,
  protocol,
  serviceIdentifier,
  tags = NULL
)

Arguments

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.

defaultAction

[required] The action for the default rule. Each listener has a default rule. Each rule consists of a priority, one or more actions, and one or more conditions. The default rule is the rule that's used if no other rules match. Each rule must include exactly one of the following types of actions: forward or fixed-response, and it must be the last action to be performed.

name

[required] The name of the listener. A listener name must be unique within a service. 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.

port

The listener port. You can specify a value from 1 to 65535. For HTTP, the default is 80. For HTTPS, the default is 443.

protocol

[required] The listener protocol HTTP or HTTPS.

serviceIdentifier

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

tags

The tags for the listener.


paws.networking documentation built on May 29, 2024, 10:12 a.m.