Listener

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Each ALB instance must have at least one listener to function properly. The listener receives client requests and distributes them to backend servers based on your configured forwarding rules and load balancing algorithm. You can create multiple listeners under one ALB instance and configure different protocols for each listener to handle client requests using different protocols.

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  aLBListenerDemo:
    type: volcenginecc:alb:Listener
    name: ALBListenerDemo
    properties:
      loadBalancerId: alb-bdazuxj87hts8dv40noxxxxx
      listenerName: ALBListenerDemo
      protocol: HTTPS
      port: 80
      enabled: on
      serverGroupId: rsp-1pff7rhpf5e68845wfah2xxxx
      aclStatus: on
      aclType: black
      aclIds:
        - acl-xp8avgtjnmrk54ov5fyoxxxx
      customizedCfgId: ccfg-xoblsk63beo054ov5el5xxxx
      description: ALBListenerDemo description
      tags:
        - key: env
          value: test
      certificateSource: cert_center
      certCenterCertificateId: cert-a126f867a19141618ff316a52a50xxxx
      caCertificateSource: pca_root
      pcaRootCaCertificateId: pca_root_xxxxxx
      enableHttp2: on
      enableQuic: off
      domainExtensions:
        - cert_center_certificate_id: cert-7718b7e7afa94e4db38ec9092cxxxxxx
          certificate_source: cert_center
          domain: ""

Create Listener Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Listener(name: string, args: ListenerArgs, opts?: CustomResourceOptions);

@overload
def Listener(resource_name: str,
             args: ListenerArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Listener(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             load_balancer_id: Optional[str] = None,
             server_group_id: Optional[str] = None,
             protocol: Optional[str] = None,
             port: Optional[int] = None,
             enable_http2: Optional[str] = None,
             listener_name: Optional[str] = None,
             cert_center_certificate_id: Optional[str] = None,
             certificate_id: Optional[str] = None,
             certificate_source: Optional[str] = None,
             customized_cfg_id: Optional[str] = None,
             description: Optional[str] = None,
             domain_extensions: Optional[Sequence[ListenerDomainExtensionArgs]] = None,
             access_log_record_customized_headers_enabled: Optional[str] = None,
             enable_quic: Optional[str] = None,
             enabled: Optional[str] = None,
             ca_certificate_source: Optional[str] = None,
             ca_certificate_id: Optional[str] = None,
             pca_leaf_certificate_id: Optional[str] = None,
             pca_root_ca_certificate_id: Optional[str] = None,
             pca_sub_ca_certificate_id: Optional[str] = None,
             acl_type: Optional[str] = None,
             acl_status: Optional[str] = None,
             acl_ids: Optional[Sequence[str]] = None,
             server_groups: Optional[Sequence[ListenerServerGroupArgs]] = None,
             tags: Optional[Sequence[ListenerTagArgs]] = None)

func NewListener(ctx *Context, name string, args ListenerArgs, opts ...ResourceOption) (*Listener, error)

public Listener(string name, ListenerArgs args, CustomResourceOptions? opts = null)

public Listener(String name, ListenerArgs args)
public Listener(String name, ListenerArgs args, CustomResourceOptions options)

type: volcenginecc:alb:Listener
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args ListenerArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ListenerArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ListenerArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ListenerArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ListenerArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Listener Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Listener resource accepts the following input properties:

LoadBalancerId string: Load balancer instance ID to which the listener belongs.
Port int: The listener port. Values: 1 - 65535.
Protocol string: Listener protocol. Supports HTTP and HTTPS protocols.
ServerGroupId string: Default server group for the listener.
AccessLogRecordCustomizedHeadersEnabled string: Whether the listener has enabled the 'Log custom header in access logs' feature: on: Feature is enabled. off: Feature is not enabled.
AclIds List<string>: Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.
AclStatus string: Enable access control. Values: on: enabled. off: disabled (default).
AclType string: Access control method. Values: white: allowlist mode. The listener only forwards requests from IP addresses or address ranges set in the selected access control policy group. If no IP is added to the selected policy group, the listener does not forward any requests. black: denylist mode. The listener only rejects requests from IP addresses or address ranges set in the selected access control policy group. If no IP is added to the selected policy group, the listener forwards all requests. When the AclStatus parameter is set to on, AclType is required.
CaCertificateId string: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication in HTTPS listeners. If the certificate source is alb, you must specify the CACertificateId parameter.
CaCertificateSource string: Source of the CA certificate associated with the HTTPS listener, used for mutual authentication. alb (default): Certificate uploaded via ALB. Standard ALB instances do not support certificates from this source. pcaroot: Private root CA certificate purchased or uploaded via Volcano Engine Certificate Center. pcasub: Private subordinate CA certificate purchased or uploaded via Volcano Engine Certificate Center.
CertCenterCertificateId string: Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener with the certificate source set to cert_center.
CertificateId string: Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.
CertificateSource string: The source of the default certificate associated with the HTTPS listener. Values: alb: certificate uploaded via ALB. certcenter: SSL certificate purchased or uploaded through Volcano Engine Certificate Center. pcaleaf: private leaf certificate purchased or uploaded through Volcano Engine Certificate Center.
CustomizedCfgId string: Personalized configuration ID. If not bound, the value is an empty string.
Description string: Listener description. Cannot start with http:// or https://. Must start with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be between 1 and 255 characters. If not specified, defaults to an empty string.
DomainExtensions List<Volcengine.ListenerDomainExtension>
EnableHttp2 string: HTTP2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled. off: disabled (default).
EnableQuic string: QUIC feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled. off: disabled (default). Only standard ALB instances support QUIC.
Enabled string: Listener on/off status. Values: on: On (default). off: Off.
ListenerName string: Listener name. If not specified, named in the format 'protocol-port'. Cannot start with http:// or https://. Must start with a letter or Chinese character and can include numbers, dot (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters.
PcaLeafCertificateId string: Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
PcaRootCaCertificateId string: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication on HTTPS listeners. When the certificate source is pca_root, you must specify the PcaRootCACertificateId parameter.
PcaSubCaCertificateId string: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication on HTTPS listeners. When the certificate source is pca_sub, you must specify the PcaSubCACertificateId parameter.
ServerGroups List<Volcengine.ListenerServerGroup>
Tags List<Volcengine.ListenerTag>

LoadBalancerId string: Load balancer instance ID to which the listener belongs.
Port int: The listener port. Values: 1 - 65535.
Protocol string: Listener protocol. Supports HTTP and HTTPS protocols.
ServerGroupId string: Default server group for the listener.
AccessLogRecordCustomizedHeadersEnabled string: Whether the listener has enabled the 'Log custom header in access logs' feature: on: Feature is enabled. off: Feature is not enabled.
AclIds []string: Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.
AclStatus string: Enable access control. Values: on: enabled. off: disabled (default).
AclType string: Access control method. Values: white: allowlist mode. The listener only forwards requests from IP addresses or address ranges set in the selected access control policy group. If no IP is added to the selected policy group, the listener does not forward any requests. black: denylist mode. The listener only rejects requests from IP addresses or address ranges set in the selected access control policy group. If no IP is added to the selected policy group, the listener forwards all requests. When the AclStatus parameter is set to on, AclType is required.
CaCertificateId string: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication in HTTPS listeners. If the certificate source is alb, you must specify the CACertificateId parameter.
CaCertificateSource string: Source of the CA certificate associated with the HTTPS listener, used for mutual authentication. alb (default): Certificate uploaded via ALB. Standard ALB instances do not support certificates from this source. pcaroot: Private root CA certificate purchased or uploaded via Volcano Engine Certificate Center. pcasub: Private subordinate CA certificate purchased or uploaded via Volcano Engine Certificate Center.
CertCenterCertificateId string: Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener with the certificate source set to cert_center.
CertificateId string: Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.
CertificateSource string: The source of the default certificate associated with the HTTPS listener. Values: alb: certificate uploaded via ALB. certcenter: SSL certificate purchased or uploaded through Volcano Engine Certificate Center. pcaleaf: private leaf certificate purchased or uploaded through Volcano Engine Certificate Center.
CustomizedCfgId string: Personalized configuration ID. If not bound, the value is an empty string.
Description string: Listener description. Cannot start with http:// or https://. Must start with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be between 1 and 255 characters. If not specified, defaults to an empty string.
DomainExtensions []ListenerDomainExtensionArgs
EnableHttp2 string: HTTP2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled. off: disabled (default).
EnableQuic string: QUIC feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled. off: disabled (default). Only standard ALB instances support QUIC.
Enabled string: Listener on/off status. Values: on: On (default). off: Off.
ListenerName string: Listener name. If not specified, named in the format 'protocol-port'. Cannot start with http:// or https://. Must start with a letter or Chinese character and can include numbers, dot (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters.
PcaLeafCertificateId string: Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
PcaRootCaCertificateId string: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication on HTTPS listeners. When the certificate source is pca_root, you must specify the PcaRootCACertificateId parameter.
PcaSubCaCertificateId string: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication on HTTPS listeners. When the certificate source is pca_sub, you must specify the PcaSubCACertificateId parameter.
ServerGroups []ListenerServerGroupArgs
Tags []ListenerTagArgs

loadBalancerId String: Load balancer instance ID to which the listener belongs.
port Integer: The listener port. Values: 1 - 65535.
protocol String: Listener protocol. Supports HTTP and HTTPS protocols.
serverGroupId String: Default server group for the listener.
accessLogRecordCustomizedHeadersEnabled String: Whether the listener has enabled the 'Log custom header in access logs' feature: on: Feature is enabled. off: Feature is not enabled.
aclIds List<String>: Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.
aclStatus String: Enable access control. Values: on: enabled. off: disabled (default).
aclType String: Access control method. Values: white: allowlist mode. The listener only forwards requests from IP addresses or address ranges set in the selected access control policy group. If no IP is added to the selected policy group, the listener does not forward any requests. black: denylist mode. The listener only rejects requests from IP addresses or address ranges set in the selected access control policy group. If no IP is added to the selected policy group, the listener forwards all requests. When the AclStatus parameter is set to on, AclType is required.
caCertificateId String: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication in HTTPS listeners. If the certificate source is alb, you must specify the CACertificateId parameter.
caCertificateSource String: Source of the CA certificate associated with the HTTPS listener, used for mutual authentication. alb (default): Certificate uploaded via ALB. Standard ALB instances do not support certificates from this source. pcaroot: Private root CA certificate purchased or uploaded via Volcano Engine Certificate Center. pcasub: Private subordinate CA certificate purchased or uploaded via Volcano Engine Certificate Center.
certCenterCertificateId String: Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener with the certificate source set to cert_center.
certificateId String: Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.
certificateSource String: The source of the default certificate associated with the HTTPS listener. Values: alb: certificate uploaded via ALB. certcenter: SSL certificate purchased or uploaded through Volcano Engine Certificate Center. pcaleaf: private leaf certificate purchased or uploaded through Volcano Engine Certificate Center.
customizedCfgId String: Personalized configuration ID. If not bound, the value is an empty string.
description String: Listener description. Cannot start with http:// or https://. Must start with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be between 1 and 255 characters. If not specified, defaults to an empty string.
domainExtensions List<ListenerDomainExtension>
enableHttp2 String: HTTP2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled. off: disabled (default).
enableQuic String: QUIC feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled. off: disabled (default). Only standard ALB instances support QUIC.
enabled String: Listener on/off status. Values: on: On (default). off: Off.
listenerName String: Listener name. If not specified, named in the format 'protocol-port'. Cannot start with http:// or https://. Must start with a letter or Chinese character and can include numbers, dot (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters.
pcaLeafCertificateId String: Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
pcaRootCaCertificateId String: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication on HTTPS listeners. When the certificate source is pca_root, you must specify the PcaRootCACertificateId parameter.
pcaSubCaCertificateId String: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication on HTTPS listeners. When the certificate source is pca_sub, you must specify the PcaSubCACertificateId parameter.
serverGroups List<ListenerServerGroup>
tags List<ListenerTag>

loadBalancerId string: Load balancer instance ID to which the listener belongs.
port number: The listener port. Values: 1 - 65535.
protocol string: Listener protocol. Supports HTTP and HTTPS protocols.
serverGroupId string: Default server group for the listener.
accessLogRecordCustomizedHeadersEnabled string: Whether the listener has enabled the 'Log custom header in access logs' feature: on: Feature is enabled. off: Feature is not enabled.
aclIds string[]: Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.
aclStatus string: Enable access control. Values: on: enabled. off: disabled (default).
aclType string: Access control method. Values: white: allowlist mode. The listener only forwards requests from IP addresses or address ranges set in the selected access control policy group. If no IP is added to the selected policy group, the listener does not forward any requests. black: denylist mode. The listener only rejects requests from IP addresses or address ranges set in the selected access control policy group. If no IP is added to the selected policy group, the listener forwards all requests. When the AclStatus parameter is set to on, AclType is required.
caCertificateId string: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication in HTTPS listeners. If the certificate source is alb, you must specify the CACertificateId parameter.
caCertificateSource string: Source of the CA certificate associated with the HTTPS listener, used for mutual authentication. alb (default): Certificate uploaded via ALB. Standard ALB instances do not support certificates from this source. pcaroot: Private root CA certificate purchased or uploaded via Volcano Engine Certificate Center. pcasub: Private subordinate CA certificate purchased or uploaded via Volcano Engine Certificate Center.
certCenterCertificateId string: Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener with the certificate source set to cert_center.
certificateId string: Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.
certificateSource string: The source of the default certificate associated with the HTTPS listener. Values: alb: certificate uploaded via ALB. certcenter: SSL certificate purchased or uploaded through Volcano Engine Certificate Center. pcaleaf: private leaf certificate purchased or uploaded through Volcano Engine Certificate Center.
customizedCfgId string: Personalized configuration ID. If not bound, the value is an empty string.
description string: Listener description. Cannot start with http:// or https://. Must start with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be between 1 and 255 characters. If not specified, defaults to an empty string.
domainExtensions ListenerDomainExtension[]
enableHttp2 string: HTTP2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled. off: disabled (default).
enableQuic string: QUIC feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled. off: disabled (default). Only standard ALB instances support QUIC.
enabled string: Listener on/off status. Values: on: On (default). off: Off.
listenerName string: Listener name. If not specified, named in the format 'protocol-port'. Cannot start with http:// or https://. Must start with a letter or Chinese character and can include numbers, dot (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters.
pcaLeafCertificateId string: Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
pcaRootCaCertificateId string: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication on HTTPS listeners. When the certificate source is pca_root, you must specify the PcaRootCACertificateId parameter.
pcaSubCaCertificateId string: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication on HTTPS listeners. When the certificate source is pca_sub, you must specify the PcaSubCACertificateId parameter.
serverGroups ListenerServerGroup[]
tags ListenerTag[]

load_balancer_id str: Load balancer instance ID to which the listener belongs.
port int: The listener port. Values: 1 - 65535.
protocol str: Listener protocol. Supports HTTP and HTTPS protocols.
server_group_id str: Default server group for the listener.
access_log_record_customized_headers_enabled str: Whether the listener has enabled the 'Log custom header in access logs' feature: on: Feature is enabled. off: Feature is not enabled.
acl_ids Sequence[str]: Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.
acl_status str: Enable access control. Values: on: enabled. off: disabled (default).
acl_type str: Access control method. Values: white: allowlist mode. The listener only forwards requests from IP addresses or address ranges set in the selected access control policy group. If no IP is added to the selected policy group, the listener does not forward any requests. black: denylist mode. The listener only rejects requests from IP addresses or address ranges set in the selected access control policy group. If no IP is added to the selected policy group, the listener forwards all requests. When the AclStatus parameter is set to on, AclType is required.
ca_certificate_id str: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication in HTTPS listeners. If the certificate source is alb, you must specify the CACertificateId parameter.
ca_certificate_source str: Source of the CA certificate associated with the HTTPS listener, used for mutual authentication. alb (default): Certificate uploaded via ALB. Standard ALB instances do not support certificates from this source. pcaroot: Private root CA certificate purchased or uploaded via Volcano Engine Certificate Center. pcasub: Private subordinate CA certificate purchased or uploaded via Volcano Engine Certificate Center.
cert_center_certificate_id str: Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener with the certificate source set to cert_center.
certificate_id str: Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.
certificate_source str: The source of the default certificate associated with the HTTPS listener. Values: alb: certificate uploaded via ALB. certcenter: SSL certificate purchased or uploaded through Volcano Engine Certificate Center. pcaleaf: private leaf certificate purchased or uploaded through Volcano Engine Certificate Center.
customized_cfg_id str: Personalized configuration ID. If not bound, the value is an empty string.
description str: Listener description. Cannot start with http:// or https://. Must start with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be between 1 and 255 characters. If not specified, defaults to an empty string.
domain_extensions Sequence[ListenerDomainExtensionArgs]
enable_http2 str: HTTP2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled. off: disabled (default).
enable_quic str: QUIC feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled. off: disabled (default). Only standard ALB instances support QUIC.
enabled str: Listener on/off status. Values: on: On (default). off: Off.
listener_name str: Listener name. If not specified, named in the format 'protocol-port'. Cannot start with http:// or https://. Must start with a letter or Chinese character and can include numbers, dot (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters.
pca_leaf_certificate_id str: Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
pca_root_ca_certificate_id str: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication on HTTPS listeners. When the certificate source is pca_root, you must specify the PcaRootCACertificateId parameter.
pca_sub_ca_certificate_id str: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication on HTTPS listeners. When the certificate source is pca_sub, you must specify the PcaSubCACertificateId parameter.
server_groups Sequence[ListenerServerGroupArgs]
tags Sequence[ListenerTagArgs]

loadBalancerId String: Load balancer instance ID to which the listener belongs.
port Number: The listener port. Values: 1 - 65535.
protocol String: Listener protocol. Supports HTTP and HTTPS protocols.
serverGroupId String: Default server group for the listener.
accessLogRecordCustomizedHeadersEnabled String: Whether the listener has enabled the 'Log custom header in access logs' feature: on: Feature is enabled. off: Feature is not enabled.
aclIds List<String>: Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.
aclStatus String: Enable access control. Values: on: enabled. off: disabled (default).
aclType String: Access control method. Values: white: allowlist mode. The listener only forwards requests from IP addresses or address ranges set in the selected access control policy group. If no IP is added to the selected policy group, the listener does not forward any requests. black: denylist mode. The listener only rejects requests from IP addresses or address ranges set in the selected access control policy group. If no IP is added to the selected policy group, the listener forwards all requests. When the AclStatus parameter is set to on, AclType is required.
caCertificateId String: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication in HTTPS listeners. If the certificate source is alb, you must specify the CACertificateId parameter.
caCertificateSource String: Source of the CA certificate associated with the HTTPS listener, used for mutual authentication. alb (default): Certificate uploaded via ALB. Standard ALB instances do not support certificates from this source. pcaroot: Private root CA certificate purchased or uploaded via Volcano Engine Certificate Center. pcasub: Private subordinate CA certificate purchased or uploaded via Volcano Engine Certificate Center.
certCenterCertificateId String: Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener with the certificate source set to cert_center.
certificateId String: Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.
certificateSource String: The source of the default certificate associated with the HTTPS listener. Values: alb: certificate uploaded via ALB. certcenter: SSL certificate purchased or uploaded through Volcano Engine Certificate Center. pcaleaf: private leaf certificate purchased or uploaded through Volcano Engine Certificate Center.
customizedCfgId String: Personalized configuration ID. If not bound, the value is an empty string.
description String: Listener description. Cannot start with http:// or https://. Must start with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be between 1 and 255 characters. If not specified, defaults to an empty string.
domainExtensions List<Property Map>
enableHttp2 String: HTTP2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled. off: disabled (default).
enableQuic String: QUIC feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled. off: disabled (default). Only standard ALB instances support QUIC.
enabled String: Listener on/off status. Values: on: On (default). off: Off.
listenerName String: Listener name. If not specified, named in the format 'protocol-port'. Cannot start with http:// or https://. Must start with a letter or Chinese character and can include numbers, dot (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters.
pcaLeafCertificateId String: Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
pcaRootCaCertificateId String: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication on HTTPS listeners. When the certificate source is pca_root, you must specify the PcaRootCACertificateId parameter.
pcaSubCaCertificateId String: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication on HTTPS listeners. When the certificate source is pca_sub, you must specify the PcaSubCACertificateId parameter.
serverGroups List<Property Map>
tags List<Property Map>

Outputs

All input properties are implicitly available as output properties. Additionally, the Listener resource produces the following output properties:

CreatedTime string: Listener creation time.
Id string: The provider-assigned unique ID for this managed resource.
ListenerId string: Listener ID.
ProjectName string: Name of the project to which the listener belongs.
Status string: Listener status. Values: Creating: Creating. Active: Running. Pending: Changing configuration. Disabled: Stopped. Deleting: Deleting.
UpdatedTime string: Time of the listener's most recent operation.

CreatedTime string: Listener creation time.
Id string: The provider-assigned unique ID for this managed resource.
ListenerId string: Listener ID.
ProjectName string: Name of the project to which the listener belongs.
Status string: Listener status. Values: Creating: Creating. Active: Running. Pending: Changing configuration. Disabled: Stopped. Deleting: Deleting.
UpdatedTime string: Time of the listener's most recent operation.

createdTime String: Listener creation time.
id String: The provider-assigned unique ID for this managed resource.
listenerId String: Listener ID.
projectName String: Name of the project to which the listener belongs.
status String: Listener status. Values: Creating: Creating. Active: Running. Pending: Changing configuration. Disabled: Stopped. Deleting: Deleting.
updatedTime String: Time of the listener's most recent operation.

createdTime string: Listener creation time.
id string: The provider-assigned unique ID for this managed resource.
listenerId string: Listener ID.
projectName string: Name of the project to which the listener belongs.
status string: Listener status. Values: Creating: Creating. Active: Running. Pending: Changing configuration. Disabled: Stopped. Deleting: Deleting.
updatedTime string: Time of the listener's most recent operation.

created_time str: Listener creation time.
id str: The provider-assigned unique ID for this managed resource.
listener_id str: Listener ID.
project_name str: Name of the project to which the listener belongs.
status str: Listener status. Values: Creating: Creating. Active: Running. Pending: Changing configuration. Disabled: Stopped. Deleting: Deleting.
updated_time str: Time of the listener's most recent operation.

createdTime String: Listener creation time.
id String: The provider-assigned unique ID for this managed resource.
listenerId String: Listener ID.
projectName String: Name of the project to which the listener belongs.
status String: Listener status. Values: Creating: Creating. Active: Running. Pending: Changing configuration. Disabled: Stopped. Deleting: Deleting.
updatedTime String: Time of the listener's most recent operation.

Look up Existing Listener Resource

Get an existing Listener resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ListenerState, opts?: CustomResourceOptions): Listener

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_log_record_customized_headers_enabled: Optional[str] = None,
        acl_ids: Optional[Sequence[str]] = None,
        acl_status: Optional[str] = None,
        acl_type: Optional[str] = None,
        ca_certificate_id: Optional[str] = None,
        ca_certificate_source: Optional[str] = None,
        cert_center_certificate_id: Optional[str] = None,
        certificate_id: Optional[str] = None,
        certificate_source: Optional[str] = None,
        created_time: Optional[str] = None,
        customized_cfg_id: Optional[str] = None,
        description: Optional[str] = None,
        domain_extensions: Optional[Sequence[ListenerDomainExtensionArgs]] = None,
        enable_http2: Optional[str] = None,
        enable_quic: Optional[str] = None,
        enabled: Optional[str] = None,
        listener_id: Optional[str] = None,
        listener_name: Optional[str] = None,
        load_balancer_id: Optional[str] = None,
        pca_leaf_certificate_id: Optional[str] = None,
        pca_root_ca_certificate_id: Optional[str] = None,
        pca_sub_ca_certificate_id: Optional[str] = None,
        port: Optional[int] = None,
        project_name: Optional[str] = None,
        protocol: Optional[str] = None,
        server_group_id: Optional[str] = None,
        server_groups: Optional[Sequence[ListenerServerGroupArgs]] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[ListenerTagArgs]] = None,
        updated_time: Optional[str] = None) -> Listener

func GetListener(ctx *Context, name string, id IDInput, state *ListenerState, opts ...ResourceOption) (*Listener, error)

public static Listener Get(string name, Input<string> id, ListenerState? state, CustomResourceOptions? opts = null)

public static Listener get(String name, Output<String> id, ListenerState state, CustomResourceOptions options)

resources:  _:    type: volcenginecc:alb:Listener    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AccessLogRecordCustomizedHeadersEnabled string: Whether the listener has enabled the 'Log custom header in access logs' feature: on: Feature is enabled. off: Feature is not enabled.
AclIds List<string>: Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.
AclStatus string: Enable access control. Values: on: enabled. off: disabled (default).
AclType string: Access control method. Values: white: allowlist mode. The listener only forwards requests from IP addresses or address ranges set in the selected access control policy group. If no IP is added to the selected policy group, the listener does not forward any requests. black: denylist mode. The listener only rejects requests from IP addresses or address ranges set in the selected access control policy group. If no IP is added to the selected policy group, the listener forwards all requests. When the AclStatus parameter is set to on, AclType is required.
CaCertificateId string: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication in HTTPS listeners. If the certificate source is alb, you must specify the CACertificateId parameter.
CaCertificateSource string: Source of the CA certificate associated with the HTTPS listener, used for mutual authentication. alb (default): Certificate uploaded via ALB. Standard ALB instances do not support certificates from this source. pcaroot: Private root CA certificate purchased or uploaded via Volcano Engine Certificate Center. pcasub: Private subordinate CA certificate purchased or uploaded via Volcano Engine Certificate Center.
CertCenterCertificateId string: Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener with the certificate source set to cert_center.
CertificateId string: Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.
CertificateSource string: The source of the default certificate associated with the HTTPS listener. Values: alb: certificate uploaded via ALB. certcenter: SSL certificate purchased or uploaded through Volcano Engine Certificate Center. pcaleaf: private leaf certificate purchased or uploaded through Volcano Engine Certificate Center.
CreatedTime string: Listener creation time.
CustomizedCfgId string: Personalized configuration ID. If not bound, the value is an empty string.
Description string: Listener description. Cannot start with http:// or https://. Must start with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be between 1 and 255 characters. If not specified, defaults to an empty string.
DomainExtensions List<Volcengine.ListenerDomainExtension>
EnableHttp2 string: HTTP2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled. off: disabled (default).
EnableQuic string: QUIC feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled. off: disabled (default). Only standard ALB instances support QUIC.
Enabled string: Listener on/off status. Values: on: On (default). off: Off.
ListenerId string: Listener ID.
ListenerName string: Listener name. If not specified, named in the format 'protocol-port'. Cannot start with http:// or https://. Must start with a letter or Chinese character and can include numbers, dot (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters.
LoadBalancerId string: Load balancer instance ID to which the listener belongs.
PcaLeafCertificateId string: Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
PcaRootCaCertificateId string: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication on HTTPS listeners. When the certificate source is pca_root, you must specify the PcaRootCACertificateId parameter.
PcaSubCaCertificateId string: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication on HTTPS listeners. When the certificate source is pca_sub, you must specify the PcaSubCACertificateId parameter.
Port int: The listener port. Values: 1 - 65535.
ProjectName string: Name of the project to which the listener belongs.
Protocol string: Listener protocol. Supports HTTP and HTTPS protocols.
ServerGroupId string: Default server group for the listener.
ServerGroups List<Volcengine.ListenerServerGroup>
Status string: Listener status. Values: Creating: Creating. Active: Running. Pending: Changing configuration. Disabled: Stopped. Deleting: Deleting.
Tags List<Volcengine.ListenerTag>
UpdatedTime string: Time of the listener's most recent operation.

AccessLogRecordCustomizedHeadersEnabled string: Whether the listener has enabled the 'Log custom header in access logs' feature: on: Feature is enabled. off: Feature is not enabled.
AclIds []string: Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.
AclStatus string: Enable access control. Values: on: enabled. off: disabled (default).
AclType string: Access control method. Values: white: allowlist mode. The listener only forwards requests from IP addresses or address ranges set in the selected access control policy group. If no IP is added to the selected policy group, the listener does not forward any requests. black: denylist mode. The listener only rejects requests from IP addresses or address ranges set in the selected access control policy group. If no IP is added to the selected policy group, the listener forwards all requests. When the AclStatus parameter is set to on, AclType is required.
CaCertificateId string: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication in HTTPS listeners. If the certificate source is alb, you must specify the CACertificateId parameter.
CaCertificateSource string: Source of the CA certificate associated with the HTTPS listener, used for mutual authentication. alb (default): Certificate uploaded via ALB. Standard ALB instances do not support certificates from this source. pcaroot: Private root CA certificate purchased or uploaded via Volcano Engine Certificate Center. pcasub: Private subordinate CA certificate purchased or uploaded via Volcano Engine Certificate Center.
CertCenterCertificateId string: Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener with the certificate source set to cert_center.
CertificateId string: Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.
CertificateSource string: The source of the default certificate associated with the HTTPS listener. Values: alb: certificate uploaded via ALB. certcenter: SSL certificate purchased or uploaded through Volcano Engine Certificate Center. pcaleaf: private leaf certificate purchased or uploaded through Volcano Engine Certificate Center.
CreatedTime string: Listener creation time.
CustomizedCfgId string: Personalized configuration ID. If not bound, the value is an empty string.
Description string: Listener description. Cannot start with http:// or https://. Must start with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be between 1 and 255 characters. If not specified, defaults to an empty string.
DomainExtensions []ListenerDomainExtensionArgs
EnableHttp2 string: HTTP2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled. off: disabled (default).
EnableQuic string: QUIC feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled. off: disabled (default). Only standard ALB instances support QUIC.
Enabled string: Listener on/off status. Values: on: On (default). off: Off.
ListenerId string: Listener ID.
ListenerName string: Listener name. If not specified, named in the format 'protocol-port'. Cannot start with http:// or https://. Must start with a letter or Chinese character and can include numbers, dot (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters.
LoadBalancerId string: Load balancer instance ID to which the listener belongs.
PcaLeafCertificateId string: Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
PcaRootCaCertificateId string: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication on HTTPS listeners. When the certificate source is pca_root, you must specify the PcaRootCACertificateId parameter.
PcaSubCaCertificateId string: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication on HTTPS listeners. When the certificate source is pca_sub, you must specify the PcaSubCACertificateId parameter.
Port int: The listener port. Values: 1 - 65535.
ProjectName string: Name of the project to which the listener belongs.
Protocol string: Listener protocol. Supports HTTP and HTTPS protocols.
ServerGroupId string: Default server group for the listener.
ServerGroups []ListenerServerGroupArgs
Status string: Listener status. Values: Creating: Creating. Active: Running. Pending: Changing configuration. Disabled: Stopped. Deleting: Deleting.
Tags []ListenerTagArgs
UpdatedTime string: Time of the listener's most recent operation.

accessLogRecordCustomizedHeadersEnabled String: Whether the listener has enabled the 'Log custom header in access logs' feature: on: Feature is enabled. off: Feature is not enabled.
aclIds List<String>: Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.
aclStatus String: Enable access control. Values: on: enabled. off: disabled (default).
aclType String: Access control method. Values: white: allowlist mode. The listener only forwards requests from IP addresses or address ranges set in the selected access control policy group. If no IP is added to the selected policy group, the listener does not forward any requests. black: denylist mode. The listener only rejects requests from IP addresses or address ranges set in the selected access control policy group. If no IP is added to the selected policy group, the listener forwards all requests. When the AclStatus parameter is set to on, AclType is required.
caCertificateId String: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication in HTTPS listeners. If the certificate source is alb, you must specify the CACertificateId parameter.
caCertificateSource String: Source of the CA certificate associated with the HTTPS listener, used for mutual authentication. alb (default): Certificate uploaded via ALB. Standard ALB instances do not support certificates from this source. pcaroot: Private root CA certificate purchased or uploaded via Volcano Engine Certificate Center. pcasub: Private subordinate CA certificate purchased or uploaded via Volcano Engine Certificate Center.
certCenterCertificateId String: Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener with the certificate source set to cert_center.
certificateId String: Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.
certificateSource String: The source of the default certificate associated with the HTTPS listener. Values: alb: certificate uploaded via ALB. certcenter: SSL certificate purchased or uploaded through Volcano Engine Certificate Center. pcaleaf: private leaf certificate purchased or uploaded through Volcano Engine Certificate Center.
createdTime String: Listener creation time.
customizedCfgId String: Personalized configuration ID. If not bound, the value is an empty string.
description String: Listener description. Cannot start with http:// or https://. Must start with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be between 1 and 255 characters. If not specified, defaults to an empty string.
domainExtensions List<ListenerDomainExtension>
enableHttp2 String: HTTP2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled. off: disabled (default).
enableQuic String: QUIC feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled. off: disabled (default). Only standard ALB instances support QUIC.
enabled String: Listener on/off status. Values: on: On (default). off: Off.
listenerId String: Listener ID.
listenerName String: Listener name. If not specified, named in the format 'protocol-port'. Cannot start with http:// or https://. Must start with a letter or Chinese character and can include numbers, dot (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters.
loadBalancerId String: Load balancer instance ID to which the listener belongs.
pcaLeafCertificateId String: Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
pcaRootCaCertificateId String: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication on HTTPS listeners. When the certificate source is pca_root, you must specify the PcaRootCACertificateId parameter.
pcaSubCaCertificateId String: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication on HTTPS listeners. When the certificate source is pca_sub, you must specify the PcaSubCACertificateId parameter.
port Integer: The listener port. Values: 1 - 65535.
projectName String: Name of the project to which the listener belongs.
protocol String: Listener protocol. Supports HTTP and HTTPS protocols.
serverGroupId String: Default server group for the listener.
serverGroups List<ListenerServerGroup>
status String: Listener status. Values: Creating: Creating. Active: Running. Pending: Changing configuration. Disabled: Stopped. Deleting: Deleting.
tags List<ListenerTag>
updatedTime String: Time of the listener's most recent operation.

accessLogRecordCustomizedHeadersEnabled string: Whether the listener has enabled the 'Log custom header in access logs' feature: on: Feature is enabled. off: Feature is not enabled.
aclIds string[]: Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.
aclStatus string: Enable access control. Values: on: enabled. off: disabled (default).
aclType string: Access control method. Values: white: allowlist mode. The listener only forwards requests from IP addresses or address ranges set in the selected access control policy group. If no IP is added to the selected policy group, the listener does not forward any requests. black: denylist mode. The listener only rejects requests from IP addresses or address ranges set in the selected access control policy group. If no IP is added to the selected policy group, the listener forwards all requests. When the AclStatus parameter is set to on, AclType is required.
caCertificateId string: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication in HTTPS listeners. If the certificate source is alb, you must specify the CACertificateId parameter.
caCertificateSource string: Source of the CA certificate associated with the HTTPS listener, used for mutual authentication. alb (default): Certificate uploaded via ALB. Standard ALB instances do not support certificates from this source. pcaroot: Private root CA certificate purchased or uploaded via Volcano Engine Certificate Center. pcasub: Private subordinate CA certificate purchased or uploaded via Volcano Engine Certificate Center.
certCenterCertificateId string: Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener with the certificate source set to cert_center.
certificateId string: Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.
certificateSource string: The source of the default certificate associated with the HTTPS listener. Values: alb: certificate uploaded via ALB. certcenter: SSL certificate purchased or uploaded through Volcano Engine Certificate Center. pcaleaf: private leaf certificate purchased or uploaded through Volcano Engine Certificate Center.
createdTime string: Listener creation time.
customizedCfgId string: Personalized configuration ID. If not bound, the value is an empty string.
description string: Listener description. Cannot start with http:// or https://. Must start with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be between 1 and 255 characters. If not specified, defaults to an empty string.
domainExtensions ListenerDomainExtension[]
enableHttp2 string: HTTP2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled. off: disabled (default).
enableQuic string: QUIC feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled. off: disabled (default). Only standard ALB instances support QUIC.
enabled string: Listener on/off status. Values: on: On (default). off: Off.
listenerId string: Listener ID.
listenerName string: Listener name. If not specified, named in the format 'protocol-port'. Cannot start with http:// or https://. Must start with a letter or Chinese character and can include numbers, dot (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters.
loadBalancerId string: Load balancer instance ID to which the listener belongs.
pcaLeafCertificateId string: Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
pcaRootCaCertificateId string: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication on HTTPS listeners. When the certificate source is pca_root, you must specify the PcaRootCACertificateId parameter.
pcaSubCaCertificateId string: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication on HTTPS listeners. When the certificate source is pca_sub, you must specify the PcaSubCACertificateId parameter.
port number: The listener port. Values: 1 - 65535.
projectName string: Name of the project to which the listener belongs.
protocol string: Listener protocol. Supports HTTP and HTTPS protocols.
serverGroupId string: Default server group for the listener.
serverGroups ListenerServerGroup[]
status string: Listener status. Values: Creating: Creating. Active: Running. Pending: Changing configuration. Disabled: Stopped. Deleting: Deleting.
tags ListenerTag[]
updatedTime string: Time of the listener's most recent operation.

access_log_record_customized_headers_enabled str: Whether the listener has enabled the 'Log custom header in access logs' feature: on: Feature is enabled. off: Feature is not enabled.
acl_ids Sequence[str]: Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.
acl_status str: Enable access control. Values: on: enabled. off: disabled (default).
acl_type str: Access control method. Values: white: allowlist mode. The listener only forwards requests from IP addresses or address ranges set in the selected access control policy group. If no IP is added to the selected policy group, the listener does not forward any requests. black: denylist mode. The listener only rejects requests from IP addresses or address ranges set in the selected access control policy group. If no IP is added to the selected policy group, the listener forwards all requests. When the AclStatus parameter is set to on, AclType is required.
ca_certificate_id str: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication in HTTPS listeners. If the certificate source is alb, you must specify the CACertificateId parameter.
ca_certificate_source str: Source of the CA certificate associated with the HTTPS listener, used for mutual authentication. alb (default): Certificate uploaded via ALB. Standard ALB instances do not support certificates from this source. pcaroot: Private root CA certificate purchased or uploaded via Volcano Engine Certificate Center. pcasub: Private subordinate CA certificate purchased or uploaded via Volcano Engine Certificate Center.
cert_center_certificate_id str: Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener with the certificate source set to cert_center.
certificate_id str: Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.
certificate_source str: The source of the default certificate associated with the HTTPS listener. Values: alb: certificate uploaded via ALB. certcenter: SSL certificate purchased or uploaded through Volcano Engine Certificate Center. pcaleaf: private leaf certificate purchased or uploaded through Volcano Engine Certificate Center.
created_time str: Listener creation time.
customized_cfg_id str: Personalized configuration ID. If not bound, the value is an empty string.
description str: Listener description. Cannot start with http:// or https://. Must start with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be between 1 and 255 characters. If not specified, defaults to an empty string.
domain_extensions Sequence[ListenerDomainExtensionArgs]
enable_http2 str: HTTP2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled. off: disabled (default).
enable_quic str: QUIC feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled. off: disabled (default). Only standard ALB instances support QUIC.
enabled str: Listener on/off status. Values: on: On (default). off: Off.
listener_id str: Listener ID.
listener_name str: Listener name. If not specified, named in the format 'protocol-port'. Cannot start with http:// or https://. Must start with a letter or Chinese character and can include numbers, dot (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters.
load_balancer_id str: Load balancer instance ID to which the listener belongs.
pca_leaf_certificate_id str: Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
pca_root_ca_certificate_id str: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication on HTTPS listeners. When the certificate source is pca_root, you must specify the PcaRootCACertificateId parameter.
pca_sub_ca_certificate_id str: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication on HTTPS listeners. When the certificate source is pca_sub, you must specify the PcaSubCACertificateId parameter.
port int: The listener port. Values: 1 - 65535.
project_name str: Name of the project to which the listener belongs.
protocol str: Listener protocol. Supports HTTP and HTTPS protocols.
server_group_id str: Default server group for the listener.
server_groups Sequence[ListenerServerGroupArgs]
status str: Listener status. Values: Creating: Creating. Active: Running. Pending: Changing configuration. Disabled: Stopped. Deleting: Deleting.
tags Sequence[ListenerTagArgs]
updated_time str: Time of the listener's most recent operation.

accessLogRecordCustomizedHeadersEnabled String: Whether the listener has enabled the 'Log custom header in access logs' feature: on: Feature is enabled. off: Feature is not enabled.
aclIds List<String>: Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.
aclStatus String: Enable access control. Values: on: enabled. off: disabled (default).
aclType String: Access control method. Values: white: allowlist mode. The listener only forwards requests from IP addresses or address ranges set in the selected access control policy group. If no IP is added to the selected policy group, the listener does not forward any requests. black: denylist mode. The listener only rejects requests from IP addresses or address ranges set in the selected access control policy group. If no IP is added to the selected policy group, the listener forwards all requests. When the AclStatus parameter is set to on, AclType is required.
caCertificateId String: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication in HTTPS listeners. If the certificate source is alb, you must specify the CACertificateId parameter.
caCertificateSource String: Source of the CA certificate associated with the HTTPS listener, used for mutual authentication. alb (default): Certificate uploaded via ALB. Standard ALB instances do not support certificates from this source. pcaroot: Private root CA certificate purchased or uploaded via Volcano Engine Certificate Center. pcasub: Private subordinate CA certificate purchased or uploaded via Volcano Engine Certificate Center.
certCenterCertificateId String: Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener with the certificate source set to cert_center.
certificateId String: Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.
certificateSource String: The source of the default certificate associated with the HTTPS listener. Values: alb: certificate uploaded via ALB. certcenter: SSL certificate purchased or uploaded through Volcano Engine Certificate Center. pcaleaf: private leaf certificate purchased or uploaded through Volcano Engine Certificate Center.
createdTime String: Listener creation time.
customizedCfgId String: Personalized configuration ID. If not bound, the value is an empty string.
description String: Listener description. Cannot start with http:// or https://. Must start with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be between 1 and 255 characters. If not specified, defaults to an empty string.
domainExtensions List<Property Map>
enableHttp2 String: HTTP2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled. off: disabled (default).
enableQuic String: QUIC feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled. off: disabled (default). Only standard ALB instances support QUIC.
enabled String: Listener on/off status. Values: on: On (default). off: Off.
listenerId String: Listener ID.
listenerName String: Listener name. If not specified, named in the format 'protocol-port'. Cannot start with http:// or https://. Must start with a letter or Chinese character and can include numbers, dot (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters.
loadBalancerId String: Load balancer instance ID to which the listener belongs.
pcaLeafCertificateId String: Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
pcaRootCaCertificateId String: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication on HTTPS listeners. When the certificate source is pca_root, you must specify the PcaRootCACertificateId parameter.
pcaSubCaCertificateId String: CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication on HTTPS listeners. When the certificate source is pca_sub, you must specify the PcaSubCACertificateId parameter.
port Number: The listener port. Values: 1 - 65535.
projectName String: Name of the project to which the listener belongs.
protocol String: Listener protocol. Supports HTTP and HTTPS protocols.
serverGroupId String: Default server group for the listener.
serverGroups List<Property Map>
status String: Listener status. Values: Creating: Creating. Active: Running. Pending: Changing configuration. Disabled: Stopped. Deleting: Deleting.
tags List<Property Map>
updatedTime String: Time of the listener's most recent operation.

Supporting Types

ListenerDomainExtension, ListenerDomainExtensionArgs

CertCenterCertificateId string: Server certificate ID used by the domain. Effective when the certificate source is cert_center.
CertificateId string: Server certificate ID used by the domain. Effective when the certificate source is alb.
CertificateSource string: Source of the server certificate used by the domain. Values: alb: certificate uploaded via ALB. cert_center: SSL certificate purchased or uploaded through Volcano Engine Certificate Center.
Domain string: Domain name. Usually cannot be empty. If the instance supports automatic selection of extended certificates (SniAutoMatch is on), Domain must be an empty string. Must contain at least one '.' and cannot start or end with '.'. Only lowercase letters, digits, '.', '-', and '' are allowed. Length must be between 1 and 128 characters. Wildcard domain: use '' to replace one or more characters. '' must be at the beginning or end of the domain name. '' cannot appear twice in the same domain name. No characters except '.' can be before or after '*'. Exact domain: a domain name that meets domain name specifications. Domain names under the same HTTPS listener cannot be duplicated. Domain matching is case-insensitive.
PcaLeafCertificateId string: Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
San string: If the instance supports automatic selection of extended certificates (SniAutoMatch is on), Domain is an empty string. San refers to the extended domain names of the certificate, separated by commas.

CertCenterCertificateId string: Server certificate ID used by the domain. Effective when the certificate source is cert_center.
CertificateId string: Server certificate ID used by the domain. Effective when the certificate source is alb.
CertificateSource string: Source of the server certificate used by the domain. Values: alb: certificate uploaded via ALB. cert_center: SSL certificate purchased or uploaded through Volcano Engine Certificate Center.
Domain string: Domain name. Usually cannot be empty. If the instance supports automatic selection of extended certificates (SniAutoMatch is on), Domain must be an empty string. Must contain at least one '.' and cannot start or end with '.'. Only lowercase letters, digits, '.', '-', and '' are allowed. Length must be between 1 and 128 characters. Wildcard domain: use '' to replace one or more characters. '' must be at the beginning or end of the domain name. '' cannot appear twice in the same domain name. No characters except '.' can be before or after '*'. Exact domain: a domain name that meets domain name specifications. Domain names under the same HTTPS listener cannot be duplicated. Domain matching is case-insensitive.
PcaLeafCertificateId string: Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
San string: If the instance supports automatic selection of extended certificates (SniAutoMatch is on), Domain is an empty string. San refers to the extended domain names of the certificate, separated by commas.

certCenterCertificateId String: Server certificate ID used by the domain. Effective when the certificate source is cert_center.
certificateId String: Server certificate ID used by the domain. Effective when the certificate source is alb.
certificateSource String: Source of the server certificate used by the domain. Values: alb: certificate uploaded via ALB. cert_center: SSL certificate purchased or uploaded through Volcano Engine Certificate Center.
domain String: Domain name. Usually cannot be empty. If the instance supports automatic selection of extended certificates (SniAutoMatch is on), Domain must be an empty string. Must contain at least one '.' and cannot start or end with '.'. Only lowercase letters, digits, '.', '-', and '' are allowed. Length must be between 1 and 128 characters. Wildcard domain: use '' to replace one or more characters. '' must be at the beginning or end of the domain name. '' cannot appear twice in the same domain name. No characters except '.' can be before or after '*'. Exact domain: a domain name that meets domain name specifications. Domain names under the same HTTPS listener cannot be duplicated. Domain matching is case-insensitive.
pcaLeafCertificateId String: Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
san String: If the instance supports automatic selection of extended certificates (SniAutoMatch is on), Domain is an empty string. San refers to the extended domain names of the certificate, separated by commas.

certCenterCertificateId string: Server certificate ID used by the domain. Effective when the certificate source is cert_center.
certificateId string: Server certificate ID used by the domain. Effective when the certificate source is alb.
certificateSource string: Source of the server certificate used by the domain. Values: alb: certificate uploaded via ALB. cert_center: SSL certificate purchased or uploaded through Volcano Engine Certificate Center.
domain string: Domain name. Usually cannot be empty. If the instance supports automatic selection of extended certificates (SniAutoMatch is on), Domain must be an empty string. Must contain at least one '.' and cannot start or end with '.'. Only lowercase letters, digits, '.', '-', and '' are allowed. Length must be between 1 and 128 characters. Wildcard domain: use '' to replace one or more characters. '' must be at the beginning or end of the domain name. '' cannot appear twice in the same domain name. No characters except '.' can be before or after '*'. Exact domain: a domain name that meets domain name specifications. Domain names under the same HTTPS listener cannot be duplicated. Domain matching is case-insensitive.
pcaLeafCertificateId string: Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
san string: If the instance supports automatic selection of extended certificates (SniAutoMatch is on), Domain is an empty string. San refers to the extended domain names of the certificate, separated by commas.

cert_center_certificate_id str: Server certificate ID used by the domain. Effective when the certificate source is cert_center.
certificate_id str: Server certificate ID used by the domain. Effective when the certificate source is alb.
certificate_source str: Source of the server certificate used by the domain. Values: alb: certificate uploaded via ALB. cert_center: SSL certificate purchased or uploaded through Volcano Engine Certificate Center.
domain str: Domain name. Usually cannot be empty. If the instance supports automatic selection of extended certificates (SniAutoMatch is on), Domain must be an empty string. Must contain at least one '.' and cannot start or end with '.'. Only lowercase letters, digits, '.', '-', and '' are allowed. Length must be between 1 and 128 characters. Wildcard domain: use '' to replace one or more characters. '' must be at the beginning or end of the domain name. '' cannot appear twice in the same domain name. No characters except '.' can be before or after '*'. Exact domain: a domain name that meets domain name specifications. Domain names under the same HTTPS listener cannot be duplicated. Domain matching is case-insensitive.
pca_leaf_certificate_id str: Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
san str: If the instance supports automatic selection of extended certificates (SniAutoMatch is on), Domain is an empty string. San refers to the extended domain names of the certificate, separated by commas.

certCenterCertificateId String: Server certificate ID used by the domain. Effective when the certificate source is cert_center.
certificateId String: Server certificate ID used by the domain. Effective when the certificate source is alb.
certificateSource String: Source of the server certificate used by the domain. Values: alb: certificate uploaded via ALB. cert_center: SSL certificate purchased or uploaded through Volcano Engine Certificate Center.
domain String: Domain name. Usually cannot be empty. If the instance supports automatic selection of extended certificates (SniAutoMatch is on), Domain must be an empty string. Must contain at least one '.' and cannot start or end with '.'. Only lowercase letters, digits, '.', '-', and '' are allowed. Length must be between 1 and 128 characters. Wildcard domain: use '' to replace one or more characters. '' must be at the beginning or end of the domain name. '' cannot appear twice in the same domain name. No characters except '.' can be before or after '*'. Exact domain: a domain name that meets domain name specifications. Domain names under the same HTTPS listener cannot be duplicated. Domain matching is case-insensitive.
pcaLeafCertificateId String: Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
san String: If the instance supports automatic selection of extended certificates (SniAutoMatch is on), Domain is an empty string. San refers to the extended domain names of the certificate, separated by commas.

ListenerServerGroup, ListenerServerGroupArgs

ServerGroupId string: Server group ID.
ServerGroupName string: Server group name.

ServerGroupId string: Server group ID.
ServerGroupName string: Server group name.

serverGroupId String: Server group ID.
serverGroupName String: Server group name.

serverGroupId string: Server group ID.
serverGroupName string: Server group name.

server_group_id str: Server group ID.
server_group_name str: Server group name.

serverGroupId String: Server group ID.
serverGroupName String: Server group name.

ListenerTag, ListenerTagArgs

Key string: Tag key for user tags. Rules are as follows: Length must be between 1 and 128 characters. Case sensitive. Cannot start with any case combination of volc:. Cannot start or end with a space. Can include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @. Tag keys for the same resource must be unique.
Value string: The value of the user tag. Rules: Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. May include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @.

Key string: Tag key for user tags. Rules are as follows: Length must be between 1 and 128 characters. Case sensitive. Cannot start with any case combination of volc:. Cannot start or end with a space. Can include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @. Tag keys for the same resource must be unique.
Value string: The value of the user tag. Rules: Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. May include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @.

key String: Tag key for user tags. Rules are as follows: Length must be between 1 and 128 characters. Case sensitive. Cannot start with any case combination of volc:. Cannot start or end with a space. Can include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @. Tag keys for the same resource must be unique.
value String: The value of the user tag. Rules: Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. May include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @.

key string: Tag key for user tags. Rules are as follows: Length must be between 1 and 128 characters. Case sensitive. Cannot start with any case combination of volc:. Cannot start or end with a space. Can include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @. Tag keys for the same resource must be unique.
value string: The value of the user tag. Rules: Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. May include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @.

key str: Tag key for user tags. Rules are as follows: Length must be between 1 and 128 characters. Case sensitive. Cannot start with any case combination of volc:. Cannot start or end with a space. Can include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @. Tag keys for the same resource must be unique.
value str: The value of the user tag. Rules: Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. May include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @.

key String: Tag key for user tags. Rules are as follows: Length must be between 1 and 128 characters. Case sensitive. Cannot start with any case combination of volc:. Cannot start or end with a space. Can include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @. Tag keys for the same resource must be unique.
value String: The value of the user tag. Rules: Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. May include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @.

Import

$ pulumi import volcenginecc:alb/listener:Listener example "listener_id"

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.alb.Listener

On this page

On this page

Example Usage

Create Listener Resource

Constructor syntax

Parameters

Listener Resource Properties

Inputs

Outputs

Look up Existing Listener Resource

Supporting Types

ListenerDomainExtension, ListenerDomainExtensionArgs

ListenerServerGroup, ListenerServerGroupArgs

ListenerTag, ListenerTagArgs

Import

Package Details

On this page

On this page