1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. alb
  6. getListener
Viewing docs for volcenginecc v0.0.33
published on Thursday, May 7, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.33
published on Thursday, May 7, 2026 by Volcengine

    Data Source schema for Volcengine::ALB::Listener

    Using getListener

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getListener(args: GetListenerArgs, opts?: InvokeOptions): Promise<GetListenerResult>
    function getListenerOutput(args: GetListenerOutputArgs, opts?: InvokeOptions): Output<GetListenerResult>
    def get_listener(id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetListenerResult
    def get_listener_output(id: pulumi.Input[Optional[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetListenerResult]
    func LookupListener(ctx *Context, args *LookupListenerArgs, opts ...InvokeOption) (*LookupListenerResult, error)
    func LookupListenerOutput(ctx *Context, args *LookupListenerOutputArgs, opts ...InvokeOption) LookupListenerResultOutput

    > Note: This function is named LookupListener in the Go SDK.

    public static class GetListener 
    {
        public static Task<GetListenerResult> InvokeAsync(GetListenerArgs args, InvokeOptions? opts = null)
        public static Output<GetListenerResult> Invoke(GetListenerInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetListenerResult> getListener(GetListenerArgs args, InvokeOptions options)
    public static Output<GetListenerResult> getListener(GetListenerArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcenginecc:alb/getListener:getListener
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getListener Result

    The following output properties are available:

    AccessLogRecordCustomizedHeadersEnabled string
    Whether the listener has enabled 'Record custom header in access logs': on: enabled. off: 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
    Whether access control is enabled. Values: on: enabled. off: not enabled (default).
    AclType string
    Access control mode. Available values: white: allowlist mode. The listener only forwards requests from IP addresses or address ranges specified in the selected access control policy group. If no IP addresses are added to the selected policy group, the listener will not forward any requests. black: denylist mode. The listener only rejects requests from IP addresses or address ranges specified in the selected access control policy group. If no IP addresses are added to the selected policy group, the listener will forward all requests. When the AclStatus parameter is set to on, AclType is a required parameter.
    CaCertificateId string
    CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication of the HTTPS listener. When 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 and the certificate source is 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
    Source of the default certificate associated with the HTTPS listener. Values: alb: certificate uploaded via ALB; certcenter: SSL certificate purchased or uploaded via Volcano Engine Certificate Center; pcaleaf: private leaf certificate purchased or uploaded via 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. Can include numbers, commas (,), periods (.), underscores (_), spaces, equals signs (=), hyphens (-), Chinese commas (,), and Chinese periods (。). Length limit: 1 to 255 characters. If not specified, defaults to an empty string.
    DomainExtensions List<Volcengine.GetListenerDomainExtension>
    List of extension domains associated with the HTTPS listener. An HTTPS listener can be associated with up to 20 extension domains.
    EnableHttp2 string
    HTTP 2.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. Available values: on: enabled. off: disabled (default). Only Standard ALB instances support QUIC.
    Enabled string
    Listener on/off status. Values: on: enabled (default); off: disabled.
    Id string
    Uniquely identifies the resource.
    ListenerId string
    Listener ID.
    ListenerName string
    Listener name. If not specified, it is named in the "protocol-port" format. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, periods (.), underscores (_), and hyphens (-). Length limit: 1-128 characters.
    LoadBalancerId string
    Load balancer instance ID associated with the listener.
    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 of the HTTPS listener. 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 two-way authentication on HTTPS listeners. When the certificate source is pca_sub, you must specify the PcaSubCACertificateId parameter.
    Port int
    Listener port. Value range: 1 - 65535.
    ProjectName string
    Project name 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.GetListenerServerGroup>
    All server groups associated with the listener.
    Status string
    Listener status. Values: Creating: creating. Active: running. Pending: configuration changing. Disabled: stopped. Deleting: deleting.
    Tags List<Volcengine.GetListenerTag>
    Tags associated with the listener.
    UpdatedTime string
    The most recent operation time of the listener.
    AccessLogRecordCustomizedHeadersEnabled string
    Whether the listener has enabled 'Record custom header in access logs': on: enabled. off: 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
    Whether access control is enabled. Values: on: enabled. off: not enabled (default).
    AclType string
    Access control mode. Available values: white: allowlist mode. The listener only forwards requests from IP addresses or address ranges specified in the selected access control policy group. If no IP addresses are added to the selected policy group, the listener will not forward any requests. black: denylist mode. The listener only rejects requests from IP addresses or address ranges specified in the selected access control policy group. If no IP addresses are added to the selected policy group, the listener will forward all requests. When the AclStatus parameter is set to on, AclType is a required parameter.
    CaCertificateId string
    CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication of the HTTPS listener. When 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 and the certificate source is 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
    Source of the default certificate associated with the HTTPS listener. Values: alb: certificate uploaded via ALB; certcenter: SSL certificate purchased or uploaded via Volcano Engine Certificate Center; pcaleaf: private leaf certificate purchased or uploaded via 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. Can include numbers, commas (,), periods (.), underscores (_), spaces, equals signs (=), hyphens (-), Chinese commas (,), and Chinese periods (。). Length limit: 1 to 255 characters. If not specified, defaults to an empty string.
    DomainExtensions []GetListenerDomainExtension
    List of extension domains associated with the HTTPS listener. An HTTPS listener can be associated with up to 20 extension domains.
    EnableHttp2 string
    HTTP 2.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. Available values: on: enabled. off: disabled (default). Only Standard ALB instances support QUIC.
    Enabled string
    Listener on/off status. Values: on: enabled (default); off: disabled.
    Id string
    Uniquely identifies the resource.
    ListenerId string
    Listener ID.
    ListenerName string
    Listener name. If not specified, it is named in the "protocol-port" format. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, periods (.), underscores (_), and hyphens (-). Length limit: 1-128 characters.
    LoadBalancerId string
    Load balancer instance ID associated with the listener.
    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 of the HTTPS listener. 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 two-way authentication on HTTPS listeners. When the certificate source is pca_sub, you must specify the PcaSubCACertificateId parameter.
    Port int
    Listener port. Value range: 1 - 65535.
    ProjectName string
    Project name to which the listener belongs.
    Protocol string
    Listener protocol. Supports HTTP and HTTPS protocols.
    ServerGroupId string
    Default server group for the listener.
    ServerGroups []GetListenerServerGroup
    All server groups associated with the listener.
    Status string
    Listener status. Values: Creating: creating. Active: running. Pending: configuration changing. Disabled: stopped. Deleting: deleting.
    Tags []GetListenerTag
    Tags associated with the listener.
    UpdatedTime string
    The most recent operation time of the listener.
    accessLogRecordCustomizedHeadersEnabled String
    Whether the listener has enabled 'Record custom header in access logs': on: enabled. off: 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
    Whether access control is enabled. Values: on: enabled. off: not enabled (default).
    aclType String
    Access control mode. Available values: white: allowlist mode. The listener only forwards requests from IP addresses or address ranges specified in the selected access control policy group. If no IP addresses are added to the selected policy group, the listener will not forward any requests. black: denylist mode. The listener only rejects requests from IP addresses or address ranges specified in the selected access control policy group. If no IP addresses are added to the selected policy group, the listener will forward all requests. When the AclStatus parameter is set to on, AclType is a required parameter.
    caCertificateId String
    CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication of the HTTPS listener. When 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 and the certificate source is 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
    Source of the default certificate associated with the HTTPS listener. Values: alb: certificate uploaded via ALB; certcenter: SSL certificate purchased or uploaded via Volcano Engine Certificate Center; pcaleaf: private leaf certificate purchased or uploaded via 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. Can include numbers, commas (,), periods (.), underscores (_), spaces, equals signs (=), hyphens (-), Chinese commas (,), and Chinese periods (。). Length limit: 1 to 255 characters. If not specified, defaults to an empty string.
    domainExtensions List<GetListenerDomainExtension>
    List of extension domains associated with the HTTPS listener. An HTTPS listener can be associated with up to 20 extension domains.
    enableHttp2 String
    HTTP 2.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. Available values: on: enabled. off: disabled (default). Only Standard ALB instances support QUIC.
    enabled String
    Listener on/off status. Values: on: enabled (default); off: disabled.
    id String
    Uniquely identifies the resource.
    listenerId String
    Listener ID.
    listenerName String
    Listener name. If not specified, it is named in the "protocol-port" format. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, periods (.), underscores (_), and hyphens (-). Length limit: 1-128 characters.
    loadBalancerId String
    Load balancer instance ID associated with the listener.
    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 of the HTTPS listener. 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 two-way authentication on HTTPS listeners. When the certificate source is pca_sub, you must specify the PcaSubCACertificateId parameter.
    port Integer
    Listener port. Value range: 1 - 65535.
    projectName String
    Project name to which the listener belongs.
    protocol String
    Listener protocol. Supports HTTP and HTTPS protocols.
    serverGroupId String
    Default server group for the listener.
    serverGroups List<GetListenerServerGroup>
    All server groups associated with the listener.
    status String
    Listener status. Values: Creating: creating. Active: running. Pending: configuration changing. Disabled: stopped. Deleting: deleting.
    tags List<GetListenerTag>
    Tags associated with the listener.
    updatedTime String
    The most recent operation time of the listener.
    accessLogRecordCustomizedHeadersEnabled string
    Whether the listener has enabled 'Record custom header in access logs': on: enabled. off: 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
    Whether access control is enabled. Values: on: enabled. off: not enabled (default).
    aclType string
    Access control mode. Available values: white: allowlist mode. The listener only forwards requests from IP addresses or address ranges specified in the selected access control policy group. If no IP addresses are added to the selected policy group, the listener will not forward any requests. black: denylist mode. The listener only rejects requests from IP addresses or address ranges specified in the selected access control policy group. If no IP addresses are added to the selected policy group, the listener will forward all requests. When the AclStatus parameter is set to on, AclType is a required parameter.
    caCertificateId string
    CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication of the HTTPS listener. When 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 and the certificate source is 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
    Source of the default certificate associated with the HTTPS listener. Values: alb: certificate uploaded via ALB; certcenter: SSL certificate purchased or uploaded via Volcano Engine Certificate Center; pcaleaf: private leaf certificate purchased or uploaded via 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. Can include numbers, commas (,), periods (.), underscores (_), spaces, equals signs (=), hyphens (-), Chinese commas (,), and Chinese periods (。). Length limit: 1 to 255 characters. If not specified, defaults to an empty string.
    domainExtensions GetListenerDomainExtension[]
    List of extension domains associated with the HTTPS listener. An HTTPS listener can be associated with up to 20 extension domains.
    enableHttp2 string
    HTTP 2.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. Available values: on: enabled. off: disabled (default). Only Standard ALB instances support QUIC.
    enabled string
    Listener on/off status. Values: on: enabled (default); off: disabled.
    id string
    Uniquely identifies the resource.
    listenerId string
    Listener ID.
    listenerName string
    Listener name. If not specified, it is named in the "protocol-port" format. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, periods (.), underscores (_), and hyphens (-). Length limit: 1-128 characters.
    loadBalancerId string
    Load balancer instance ID associated with the listener.
    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 of the HTTPS listener. 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 two-way authentication on HTTPS listeners. When the certificate source is pca_sub, you must specify the PcaSubCACertificateId parameter.
    port number
    Listener port. Value range: 1 - 65535.
    projectName string
    Project name to which the listener belongs.
    protocol string
    Listener protocol. Supports HTTP and HTTPS protocols.
    serverGroupId string
    Default server group for the listener.
    serverGroups GetListenerServerGroup[]
    All server groups associated with the listener.
    status string
    Listener status. Values: Creating: creating. Active: running. Pending: configuration changing. Disabled: stopped. Deleting: deleting.
    tags GetListenerTag[]
    Tags associated with the listener.
    updatedTime string
    The most recent operation time of the listener.
    access_log_record_customized_headers_enabled str
    Whether the listener has enabled 'Record custom header in access logs': on: enabled. off: 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
    Whether access control is enabled. Values: on: enabled. off: not enabled (default).
    acl_type str
    Access control mode. Available values: white: allowlist mode. The listener only forwards requests from IP addresses or address ranges specified in the selected access control policy group. If no IP addresses are added to the selected policy group, the listener will not forward any requests. black: denylist mode. The listener only rejects requests from IP addresses or address ranges specified in the selected access control policy group. If no IP addresses are added to the selected policy group, the listener will forward all requests. When the AclStatus parameter is set to on, AclType is a required parameter.
    ca_certificate_id str
    CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication of the HTTPS listener. When 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 and the certificate source is 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
    Source of the default certificate associated with the HTTPS listener. Values: alb: certificate uploaded via ALB; certcenter: SSL certificate purchased or uploaded via Volcano Engine Certificate Center; pcaleaf: private leaf certificate purchased or uploaded via 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. Can include numbers, commas (,), periods (.), underscores (_), spaces, equals signs (=), hyphens (-), Chinese commas (,), and Chinese periods (。). Length limit: 1 to 255 characters. If not specified, defaults to an empty string.
    domain_extensions Sequence[GetListenerDomainExtension]
    List of extension domains associated with the HTTPS listener. An HTTPS listener can be associated with up to 20 extension domains.
    enable_http2 str
    HTTP 2.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. Available values: on: enabled. off: disabled (default). Only Standard ALB instances support QUIC.
    enabled str
    Listener on/off status. Values: on: enabled (default); off: disabled.
    id str
    Uniquely identifies the resource.
    listener_id str
    Listener ID.
    listener_name str
    Listener name. If not specified, it is named in the "protocol-port" format. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, periods (.), underscores (_), and hyphens (-). Length limit: 1-128 characters.
    load_balancer_id str
    Load balancer instance ID associated with the listener.
    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 of the HTTPS listener. 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 two-way authentication on HTTPS listeners. When the certificate source is pca_sub, you must specify the PcaSubCACertificateId parameter.
    port int
    Listener port. Value range: 1 - 65535.
    project_name str
    Project name 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[GetListenerServerGroup]
    All server groups associated with the listener.
    status str
    Listener status. Values: Creating: creating. Active: running. Pending: configuration changing. Disabled: stopped. Deleting: deleting.
    tags Sequence[GetListenerTag]
    Tags associated with the listener.
    updated_time str
    The most recent operation time of the listener.
    accessLogRecordCustomizedHeadersEnabled String
    Whether the listener has enabled 'Record custom header in access logs': on: enabled. off: 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
    Whether access control is enabled. Values: on: enabled. off: not enabled (default).
    aclType String
    Access control mode. Available values: white: allowlist mode. The listener only forwards requests from IP addresses or address ranges specified in the selected access control policy group. If no IP addresses are added to the selected policy group, the listener will not forward any requests. black: denylist mode. The listener only rejects requests from IP addresses or address ranges specified in the selected access control policy group. If no IP addresses are added to the selected policy group, the listener will forward all requests. When the AclStatus parameter is set to on, AclType is a required parameter.
    caCertificateId String
    CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication of the HTTPS listener. When 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 and the certificate source is 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
    Source of the default certificate associated with the HTTPS listener. Values: alb: certificate uploaded via ALB; certcenter: SSL certificate purchased or uploaded via Volcano Engine Certificate Center; pcaleaf: private leaf certificate purchased or uploaded via 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. Can include numbers, commas (,), periods (.), underscores (_), spaces, equals signs (=), hyphens (-), Chinese commas (,), and Chinese periods (。). Length limit: 1 to 255 characters. If not specified, defaults to an empty string.
    domainExtensions List<Property Map>
    List of extension domains associated with the HTTPS listener. An HTTPS listener can be associated with up to 20 extension domains.
    enableHttp2 String
    HTTP 2.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. Available values: on: enabled. off: disabled (default). Only Standard ALB instances support QUIC.
    enabled String
    Listener on/off status. Values: on: enabled (default); off: disabled.
    id String
    Uniquely identifies the resource.
    listenerId String
    Listener ID.
    listenerName String
    Listener name. If not specified, it is named in the "protocol-port" format. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, periods (.), underscores (_), and hyphens (-). Length limit: 1-128 characters.
    loadBalancerId String
    Load balancer instance ID associated with the listener.
    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 of the HTTPS listener. 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 two-way authentication on HTTPS listeners. When the certificate source is pca_sub, you must specify the PcaSubCACertificateId parameter.
    port Number
    Listener port. Value range: 1 - 65535.
    projectName String
    Project name 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>
    All server groups associated with the listener.
    status String
    Listener status. Values: Creating: creating. Active: running. Pending: configuration changing. Disabled: stopped. Deleting: deleting.
    tags List<Property Map>
    Tags associated with the listener.
    updatedTime String
    The most recent operation time of the listener.

    Supporting Types

    GetListenerDomainExtension

    CertCenterCertificateId string
    Server certificate ID used by the domain name. 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 via Volcano Engine Certificate Center.
    Domain string
    Domain name. Usually cannot be empty. If the instance supports automatic selection of extension certificates (SniAutoMatch is on), Domain must be set to an empty string. Must contain at least one '.' and cannot start or end with '.'. Only lowercase letters, digits, '.', '-', and '' are allowed. Length limit: 1–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 other than '.' can appear before or after '*'. Exact domain: an exact domain name that complies with domain name specifications. Domain names under the same HTTPS listener cannot be duplicated. Domain name matching is case-insensitive.
    DomainExtensionId string
    Extension domain name ID.
    ListenerId string
    Listener ID associated with the extended domain name.
    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 extension certificates, that is, when SniAutoMatch is set to on, Domain is an empty string. San refers to the certificate's extension domain names, separated by commas.
    CertCenterCertificateId string
    Server certificate ID used by the domain name. 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 via Volcano Engine Certificate Center.
    Domain string
    Domain name. Usually cannot be empty. If the instance supports automatic selection of extension certificates (SniAutoMatch is on), Domain must be set to an empty string. Must contain at least one '.' and cannot start or end with '.'. Only lowercase letters, digits, '.', '-', and '' are allowed. Length limit: 1–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 other than '.' can appear before or after '*'. Exact domain: an exact domain name that complies with domain name specifications. Domain names under the same HTTPS listener cannot be duplicated. Domain name matching is case-insensitive.
    DomainExtensionId string
    Extension domain name ID.
    ListenerId string
    Listener ID associated with the extended domain name.
    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 extension certificates, that is, when SniAutoMatch is set to on, Domain is an empty string. San refers to the certificate's extension domain names, separated by commas.
    certCenterCertificateId String
    Server certificate ID used by the domain name. 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 via Volcano Engine Certificate Center.
    domain String
    Domain name. Usually cannot be empty. If the instance supports automatic selection of extension certificates (SniAutoMatch is on), Domain must be set to an empty string. Must contain at least one '.' and cannot start or end with '.'. Only lowercase letters, digits, '.', '-', and '' are allowed. Length limit: 1–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 other than '.' can appear before or after '*'. Exact domain: an exact domain name that complies with domain name specifications. Domain names under the same HTTPS listener cannot be duplicated. Domain name matching is case-insensitive.
    domainExtensionId String
    Extension domain name ID.
    listenerId String
    Listener ID associated with the extended domain name.
    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 extension certificates, that is, when SniAutoMatch is set to on, Domain is an empty string. San refers to the certificate's extension domain names, separated by commas.
    certCenterCertificateId string
    Server certificate ID used by the domain name. 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 via Volcano Engine Certificate Center.
    domain string
    Domain name. Usually cannot be empty. If the instance supports automatic selection of extension certificates (SniAutoMatch is on), Domain must be set to an empty string. Must contain at least one '.' and cannot start or end with '.'. Only lowercase letters, digits, '.', '-', and '' are allowed. Length limit: 1–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 other than '.' can appear before or after '*'. Exact domain: an exact domain name that complies with domain name specifications. Domain names under the same HTTPS listener cannot be duplicated. Domain name matching is case-insensitive.
    domainExtensionId string
    Extension domain name ID.
    listenerId string
    Listener ID associated with the extended domain name.
    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 extension certificates, that is, when SniAutoMatch is set to on, Domain is an empty string. San refers to the certificate's extension domain names, separated by commas.
    cert_center_certificate_id str
    Server certificate ID used by the domain name. 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 via Volcano Engine Certificate Center.
    domain str
    Domain name. Usually cannot be empty. If the instance supports automatic selection of extension certificates (SniAutoMatch is on), Domain must be set to an empty string. Must contain at least one '.' and cannot start or end with '.'. Only lowercase letters, digits, '.', '-', and '' are allowed. Length limit: 1–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 other than '.' can appear before or after '*'. Exact domain: an exact domain name that complies with domain name specifications. Domain names under the same HTTPS listener cannot be duplicated. Domain name matching is case-insensitive.
    domain_extension_id str
    Extension domain name ID.
    listener_id str
    Listener ID associated with the extended domain name.
    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 extension certificates, that is, when SniAutoMatch is set to on, Domain is an empty string. San refers to the certificate's extension domain names, separated by commas.
    certCenterCertificateId String
    Server certificate ID used by the domain name. 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 via Volcano Engine Certificate Center.
    domain String
    Domain name. Usually cannot be empty. If the instance supports automatic selection of extension certificates (SniAutoMatch is on), Domain must be set to an empty string. Must contain at least one '.' and cannot start or end with '.'. Only lowercase letters, digits, '.', '-', and '' are allowed. Length limit: 1–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 other than '.' can appear before or after '*'. Exact domain: an exact domain name that complies with domain name specifications. Domain names under the same HTTPS listener cannot be duplicated. Domain name matching is case-insensitive.
    domainExtensionId String
    Extension domain name ID.
    listenerId String
    Listener ID associated with the extended domain name.
    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 extension certificates, that is, when SniAutoMatch is set to on, Domain is an empty string. San refers to the certificate's extension domain names, separated by commas.

    GetListenerServerGroup

    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.

    GetListenerTag

    Key string
    User tag key. Rules: 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. Allowed characters include all languages, numbers, spaces, parentheses (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @. Tag keys for the same resource cannot be duplicated.
    Value string
    User tag value. Rules: Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. Allowed characters include all languages, numbers, spaces, parentheses (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @.
    Key string
    User tag key. Rules: 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. Allowed characters include all languages, numbers, spaces, parentheses (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @. Tag keys for the same resource cannot be duplicated.
    Value string
    User tag value. Rules: Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. Allowed characters include all languages, numbers, spaces, parentheses (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @.
    key String
    User tag key. Rules: 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. Allowed characters include all languages, numbers, spaces, parentheses (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @. Tag keys for the same resource cannot be duplicated.
    value String
    User tag value. Rules: Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. Allowed characters include all languages, numbers, spaces, parentheses (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @.
    key string
    User tag key. Rules: 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. Allowed characters include all languages, numbers, spaces, parentheses (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @. Tag keys for the same resource cannot be duplicated.
    value string
    User tag value. Rules: Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. Allowed characters include all languages, numbers, spaces, parentheses (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @.
    key str
    User tag key. Rules: 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. Allowed characters include all languages, numbers, spaces, parentheses (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @. Tag keys for the same resource cannot be duplicated.
    value str
    User tag value. Rules: Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. Allowed characters include all languages, numbers, spaces, parentheses (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @.
    key String
    User tag key. Rules: 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. Allowed characters include all languages, numbers, spaces, parentheses (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @. Tag keys for the same resource cannot be duplicated.
    value String
    User tag value. Rules: Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. Allowed characters include all languages, numbers, spaces, parentheses (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.33
    published on Thursday, May 7, 2026 by Volcengine
      Try Pulumi Cloud free. Your team will thank you.