Skip to content

/AWS1/CL_VL=>CREATELISTENER()

About CreateListener

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.

Method Signature

IMPORTING

Required arguments:

IV_SERVICEIDENTIFIER TYPE /AWS1/VL_SERVICEIDENTIFIER /AWS1/VL_SERVICEIDENTIFIER

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

IV_NAME TYPE /AWS1/VL_LISTENERNAME /AWS1/VL_LISTENERNAME

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.

IV_PROTOCOL TYPE /AWS1/VL_LISTENERPROTOCOL /AWS1/VL_LISTENERPROTOCOL

The listener protocol.

IO_DEFAULTACTION TYPE REF TO /AWS1/CL_VL_RULEACTION /AWS1/CL_VL_RULEACTION

The action for the default rule. Each listener has a default rule. The default rule is used if no other rules match.

Optional arguments:

IV_PORT TYPE /AWS1/VL_PORT /AWS1/VL_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.

IV_CLIENTTOKEN TYPE /AWS1/VL_CLIENTTOKEN /AWS1/VL_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.

IT_TAGS TYPE /AWS1/CL_VL_TAGMAP_W=>TT_TAGMAP TT_TAGMAP

The tags for the listener.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_VL_CREATELISTENERRSP /AWS1/CL_VL_CREATELISTENERRSP