published on Thursday, May 7, 2026 by Byteplus
published on Thursday, May 7, 2026 by Byteplus
Each ALB instance requires 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 a single ALB instance and configure different listening 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: bytepluscc: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: bytepluscc: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.
Constructor example
The following reference example uses placeholder values for all input properties.
var listenerResource = new Bytepluscc.Alb.Listener("listenerResource", new()
{
LoadBalancerId = "string",
ServerGroupId = "string",
Protocol = "string",
Port = 0,
EnableHttp2 = "string",
ListenerName = "string",
CertCenterCertificateId = "string",
CertificateId = "string",
CertificateSource = "string",
CustomizedCfgId = "string",
Description = "string",
DomainExtensions = new[]
{
new Bytepluscc.Alb.Inputs.ListenerDomainExtensionArgs
{
CertCenterCertificateId = "string",
CertificateId = "string",
CertificateSource = "string",
Domain = "string",
PcaLeafCertificateId = "string",
San = "string",
},
},
AccessLogRecordCustomizedHeadersEnabled = "string",
EnableQuic = "string",
Enabled = "string",
CaCertificateSource = "string",
CaCertificateId = "string",
PcaLeafCertificateId = "string",
PcaRootCaCertificateId = "string",
PcaSubCaCertificateId = "string",
AclType = "string",
AclStatus = "string",
AclIds = new[]
{
"string",
},
ServerGroups = new[]
{
new Bytepluscc.Alb.Inputs.ListenerServerGroupArgs
{
ServerGroupId = "string",
ServerGroupName = "string",
},
},
Tags = new[]
{
new Bytepluscc.Alb.Inputs.ListenerTagArgs
{
Key = "string",
Value = "string",
},
},
});
example, err := alb.NewListener(ctx, "listenerResource", &alb.ListenerArgs{
LoadBalancerId: pulumi.String("string"),
ServerGroupId: pulumi.String("string"),
Protocol: pulumi.String("string"),
Port: pulumi.Int(0),
EnableHttp2: pulumi.String("string"),
ListenerName: pulumi.String("string"),
CertCenterCertificateId: pulumi.String("string"),
CertificateId: pulumi.String("string"),
CertificateSource: pulumi.String("string"),
CustomizedCfgId: pulumi.String("string"),
Description: pulumi.String("string"),
DomainExtensions: alb.ListenerDomainExtensionArray{
&alb.ListenerDomainExtensionArgs{
CertCenterCertificateId: pulumi.String("string"),
CertificateId: pulumi.String("string"),
CertificateSource: pulumi.String("string"),
Domain: pulumi.String("string"),
PcaLeafCertificateId: pulumi.String("string"),
San: pulumi.String("string"),
},
},
AccessLogRecordCustomizedHeadersEnabled: pulumi.String("string"),
EnableQuic: pulumi.String("string"),
Enabled: pulumi.String("string"),
CaCertificateSource: pulumi.String("string"),
CaCertificateId: pulumi.String("string"),
PcaLeafCertificateId: pulumi.String("string"),
PcaRootCaCertificateId: pulumi.String("string"),
PcaSubCaCertificateId: pulumi.String("string"),
AclType: pulumi.String("string"),
AclStatus: pulumi.String("string"),
AclIds: pulumi.StringArray{
pulumi.String("string"),
},
ServerGroups: alb.ListenerServerGroupArray{
&alb.ListenerServerGroupArgs{
ServerGroupId: pulumi.String("string"),
ServerGroupName: pulumi.String("string"),
},
},
Tags: alb.ListenerTagArray{
&alb.ListenerTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
})
var listenerResource = new com.byteplus.bytepluscc.alb.Listener("listenerResource", com.byteplus.bytepluscc.alb.ListenerArgs.builder()
.loadBalancerId("string")
.serverGroupId("string")
.protocol("string")
.port(0)
.enableHttp2("string")
.listenerName("string")
.certCenterCertificateId("string")
.certificateId("string")
.certificateSource("string")
.customizedCfgId("string")
.description("string")
.domainExtensions(ListenerDomainExtensionArgs.builder()
.certCenterCertificateId("string")
.certificateId("string")
.certificateSource("string")
.domain("string")
.pcaLeafCertificateId("string")
.san("string")
.build())
.accessLogRecordCustomizedHeadersEnabled("string")
.enableQuic("string")
.enabled("string")
.caCertificateSource("string")
.caCertificateId("string")
.pcaLeafCertificateId("string")
.pcaRootCaCertificateId("string")
.pcaSubCaCertificateId("string")
.aclType("string")
.aclStatus("string")
.aclIds("string")
.serverGroups(ListenerServerGroupArgs.builder()
.serverGroupId("string")
.serverGroupName("string")
.build())
.tags(ListenerTagArgs.builder()
.key("string")
.value("string")
.build())
.build());
listener_resource = bytepluscc.alb.Listener("listenerResource",
load_balancer_id="string",
server_group_id="string",
protocol="string",
port=0,
enable_http2="string",
listener_name="string",
cert_center_certificate_id="string",
certificate_id="string",
certificate_source="string",
customized_cfg_id="string",
description="string",
domain_extensions=[{
"cert_center_certificate_id": "string",
"certificate_id": "string",
"certificate_source": "string",
"domain": "string",
"pca_leaf_certificate_id": "string",
"san": "string",
}],
access_log_record_customized_headers_enabled="string",
enable_quic="string",
enabled="string",
ca_certificate_source="string",
ca_certificate_id="string",
pca_leaf_certificate_id="string",
pca_root_ca_certificate_id="string",
pca_sub_ca_certificate_id="string",
acl_type="string",
acl_status="string",
acl_ids=["string"],
server_groups=[{
"server_group_id": "string",
"server_group_name": "string",
}],
tags=[{
"key": "string",
"value": "string",
}])
const listenerResource = new bytepluscc.alb.Listener("listenerResource", {
loadBalancerId: "string",
serverGroupId: "string",
protocol: "string",
port: 0,
enableHttp2: "string",
listenerName: "string",
certCenterCertificateId: "string",
certificateId: "string",
certificateSource: "string",
customizedCfgId: "string",
description: "string",
domainExtensions: [{
certCenterCertificateId: "string",
certificateId: "string",
certificateSource: "string",
domain: "string",
pcaLeafCertificateId: "string",
san: "string",
}],
accessLogRecordCustomizedHeadersEnabled: "string",
enableQuic: "string",
enabled: "string",
caCertificateSource: "string",
caCertificateId: "string",
pcaLeafCertificateId: "string",
pcaRootCaCertificateId: "string",
pcaSubCaCertificateId: "string",
aclType: "string",
aclStatus: "string",
aclIds: ["string"],
serverGroups: [{
serverGroupId: "string",
serverGroupName: "string",
}],
tags: [{
key: "string",
value: "string",
}],
});
type: bytepluscc:alb:Listener
properties:
accessLogRecordCustomizedHeadersEnabled: string
aclIds:
- string
aclStatus: string
aclType: string
caCertificateId: string
caCertificateSource: string
certCenterCertificateId: string
certificateId: string
certificateSource: string
customizedCfgId: string
description: string
domainExtensions:
- certCenterCertificateId: string
certificateId: string
certificateSource: string
domain: string
pcaLeafCertificateId: string
san: string
enableHttp2: string
enableQuic: string
enabled: string
listenerName: string
loadBalancerId: string
pcaLeafCertificateId: string
pcaRootCaCertificateId: string
pcaSubCaCertificateId: string
port: 0
protocol: string
serverGroupId: string
serverGroups:
- serverGroupId: string
serverGroupName: string
tags:
- key: string
value: string
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:
- Load
Balancer stringId - Load balancer instance ID associated with the listener.
- Port int
- Listener port. Value range: 1 - 65535.
- Protocol string
- Listener protocol. Supports HTTP and HTTPS protocols.
- Server
Group stringId - Default server group for the listener.
- Access
Log stringRecord Customized Headers Enabled - Whether the listener has enabled 'Record custom header in access logs': on: enabled. off: not enabled.
- Acl
Ids List<string> - Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.
- Acl
Status string - Whether access control is enabled. Values: on: enabled. off: not enabled (default).
- Acl
Type 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.
- Ca
Certificate stringId - 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 stringSource - 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 stringCertificate Id - Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is cert_center.
- Certificate
Id string - Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.
- Certificate
Source 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.
- Customized
Cfg stringId - 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.
- Domain
Extensions List<Byteplus.Listener Domain Extension> - Enable
Http2 string - HTTP 2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled; off: disabled (default).
- Enable
Quic 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.
- Listener
Name 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.
- Pca
Leaf stringCertificate Id - Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
- Pca
Root stringCa Certificate Id - 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 stringCa Certificate Id - 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.
- Server
Groups List<Byteplus.Listener Server Group> -
List<Byteplus.
Listener Tag>
- Load
Balancer stringId - Load balancer instance ID associated with the listener.
- Port int
- Listener port. Value range: 1 - 65535.
- Protocol string
- Listener protocol. Supports HTTP and HTTPS protocols.
- Server
Group stringId - Default server group for the listener.
- Access
Log stringRecord Customized Headers Enabled - Whether the listener has enabled 'Record custom header in access logs': on: enabled. off: not enabled.
- Acl
Ids []string - Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.
- Acl
Status string - Whether access control is enabled. Values: on: enabled. off: not enabled (default).
- Acl
Type 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.
- Ca
Certificate stringId - 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 stringSource - 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 stringCertificate Id - Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is cert_center.
- Certificate
Id string - Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.
- Certificate
Source 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.
- Customized
Cfg stringId - 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.
- Domain
Extensions []ListenerDomain Extension Args - Enable
Http2 string - HTTP 2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled; off: disabled (default).
- Enable
Quic 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.
- Listener
Name 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.
- Pca
Leaf stringCertificate Id - Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
- Pca
Root stringCa Certificate Id - 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 stringCa Certificate Id - 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.
- Server
Groups []ListenerServer Group Args -
[]Listener
Tag Args
- load
Balancer StringId - Load balancer instance ID associated with the listener.
- port Integer
- Listener port. Value range: 1 - 65535.
- protocol String
- Listener protocol. Supports HTTP and HTTPS protocols.
- server
Group StringId - Default server group for the listener.
- access
Log StringRecord Customized Headers Enabled - Whether the listener has enabled 'Record custom header in access logs': on: enabled. off: not enabled.
- acl
Ids List<String> - Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.
- acl
Status String - Whether access control is enabled. Values: on: enabled. off: not enabled (default).
- acl
Type 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.
- ca
Certificate StringId - 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 StringSource - 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 StringCertificate Id - Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is cert_center.
- certificate
Id String - Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.
- certificate
Source 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.
- customized
Cfg StringId - 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.
- domain
Extensions List<ListenerDomain Extension> - enable
Http2 String - HTTP 2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled; off: disabled (default).
- enable
Quic 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.
- listener
Name 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.
- pca
Leaf StringCertificate Id - Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
- pca
Root StringCa Certificate Id - 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 StringCa Certificate Id - 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.
- server
Groups List<ListenerServer Group> -
List<Listener
Tag>
- load
Balancer stringId - Load balancer instance ID associated with the listener.
- port number
- Listener port. Value range: 1 - 65535.
- protocol string
- Listener protocol. Supports HTTP and HTTPS protocols.
- server
Group stringId - Default server group for the listener.
- access
Log stringRecord Customized Headers Enabled - Whether the listener has enabled 'Record custom header in access logs': on: enabled. off: not enabled.
- acl
Ids string[] - Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.
- acl
Status string - Whether access control is enabled. Values: on: enabled. off: not enabled (default).
- acl
Type 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.
- ca
Certificate stringId - 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 stringSource - 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 stringCertificate Id - Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is cert_center.
- certificate
Id string - Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.
- certificate
Source 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.
- customized
Cfg stringId - 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.
- domain
Extensions ListenerDomain Extension[] - enable
Http2 string - HTTP 2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled; off: disabled (default).
- enable
Quic 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.
- listener
Name 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.
- pca
Leaf stringCertificate Id - Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
- pca
Root stringCa Certificate Id - 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 stringCa Certificate Id - 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.
- server
Groups ListenerServer Group[] -
Listener
Tag[]
- load_
balancer_ strid - Load balancer instance ID associated with the listener.
- port int
- Listener port. Value range: 1 - 65535.
- protocol str
- Listener protocol. Supports HTTP and HTTPS protocols.
- server_
group_ strid - Default server group for the listener.
- access_
log_ strrecord_ customized_ headers_ enabled - 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_ strid - 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_ strsource - 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_ strcertificate_ id - 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.
- customized_
cfg_ strid - 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[ListenerDomain Extension Args] - 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.
- 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.
- pca_
leaf_ strcertificate_ id - Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
- pca_
root_ strca_ certificate_ id - 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_ strca_ certificate_ id - 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.
- server_
groups Sequence[ListenerServer Group Args] -
Sequence[Listener
Tag Args]
- load
Balancer StringId - Load balancer instance ID associated with the listener.
- port Number
- Listener port. Value range: 1 - 65535.
- protocol String
- Listener protocol. Supports HTTP and HTTPS protocols.
- server
Group StringId - Default server group for the listener.
- access
Log StringRecord Customized Headers Enabled - Whether the listener has enabled 'Record custom header in access logs': on: enabled. off: not enabled.
- acl
Ids List<String> - Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.
- acl
Status String - Whether access control is enabled. Values: on: enabled. off: not enabled (default).
- acl
Type 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.
- ca
Certificate StringId - 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 StringSource - 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 StringCertificate Id - Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is cert_center.
- certificate
Id String - Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.
- certificate
Source 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.
- customized
Cfg StringId - 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.
- domain
Extensions List<Property Map> - enable
Http2 String - HTTP 2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled; off: disabled (default).
- enable
Quic 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.
- listener
Name 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.
- pca
Leaf StringCertificate Id - Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
- pca
Root StringCa Certificate Id - 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 StringCa Certificate Id - 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.
- server
Groups List<Property Map> - List<Property Map>
Outputs
All input properties are implicitly available as output properties. Additionally, the Listener resource produces the following output properties:
- Created
Time string - Listener creation time.
- Id string
- The provider-assigned unique ID for this managed resource.
- Listener
Id string - Listener ID.
- Project
Name string - Project name to which the listener belongs.
- Status string
- Listener status. Values: Creating: creating. Active: running. Pending: configuration changing. Disabled: stopped. Deleting: deleting.
- Updated
Time string - The most recent operation time of the listener.
- Created
Time string - Listener creation time.
- Id string
- The provider-assigned unique ID for this managed resource.
- Listener
Id string - Listener ID.
- Project
Name string - Project name to which the listener belongs.
- Status string
- Listener status. Values: Creating: creating. Active: running. Pending: configuration changing. Disabled: stopped. Deleting: deleting.
- Updated
Time string - The most recent operation time of the listener.
- created
Time String - Listener creation time.
- id String
- The provider-assigned unique ID for this managed resource.
- listener
Id String - Listener ID.
- project
Name String - Project name to which the listener belongs.
- status String
- Listener status. Values: Creating: creating. Active: running. Pending: configuration changing. Disabled: stopped. Deleting: deleting.
- updated
Time String - The most recent operation time of the listener.
- created
Time string - Listener creation time.
- id string
- The provider-assigned unique ID for this managed resource.
- listener
Id string - Listener ID.
- project
Name string - Project name to which the listener belongs.
- status string
- Listener status. Values: Creating: creating. Active: running. Pending: configuration changing. Disabled: stopped. Deleting: deleting.
- updated
Time string - The most recent operation time of the listener.
- 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 - Project name to which the listener belongs.
- status str
- Listener status. Values: Creating: creating. Active: running. Pending: configuration changing. Disabled: stopped. Deleting: deleting.
- updated_
time str - The most recent operation time of the listener.
- created
Time String - Listener creation time.
- id String
- The provider-assigned unique ID for this managed resource.
- listener
Id String - Listener ID.
- project
Name String - Project name to which the listener belongs.
- status String
- Listener status. Values: Creating: creating. Active: running. Pending: configuration changing. Disabled: stopped. Deleting: deleting.
- updated
Time String - The most recent operation time of the listener.
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) -> Listenerfunc 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: bytepluscc: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.
- Access
Log stringRecord Customized Headers Enabled - Whether the listener has enabled 'Record custom header in access logs': on: enabled. off: not enabled.
- Acl
Ids List<string> - Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.
- Acl
Status string - Whether access control is enabled. Values: on: enabled. off: not enabled (default).
- Acl
Type 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.
- Ca
Certificate stringId - 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 stringSource - 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 stringCertificate Id - Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is cert_center.
- Certificate
Id string - Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.
- Certificate
Source 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.
- Created
Time string - Listener creation time.
- Customized
Cfg stringId - 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.
- Domain
Extensions List<Byteplus.Listener Domain Extension> - Enable
Http2 string - HTTP 2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled; off: disabled (default).
- Enable
Quic 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.
- Listener
Id string - Listener ID.
- Listener
Name 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.
- Load
Balancer stringId - Load balancer instance ID associated with the listener.
- Pca
Leaf stringCertificate Id - Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
- Pca
Root stringCa Certificate Id - 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 stringCa Certificate Id - 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 string - Project name to which the listener belongs.
- Protocol string
- Listener protocol. Supports HTTP and HTTPS protocols.
- Server
Group stringId - Default server group for the listener.
- Server
Groups List<Byteplus.Listener Server Group> - Status string
- Listener status. Values: Creating: creating. Active: running. Pending: configuration changing. Disabled: stopped. Deleting: deleting.
-
List<Byteplus.
Listener Tag> - Updated
Time string - The most recent operation time of the listener.
- Access
Log stringRecord Customized Headers Enabled - Whether the listener has enabled 'Record custom header in access logs': on: enabled. off: not enabled.
- Acl
Ids []string - Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.
- Acl
Status string - Whether access control is enabled. Values: on: enabled. off: not enabled (default).
- Acl
Type 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.
- Ca
Certificate stringId - 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 stringSource - 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 stringCertificate Id - Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is cert_center.
- Certificate
Id string - Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.
- Certificate
Source 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.
- Created
Time string - Listener creation time.
- Customized
Cfg stringId - 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.
- Domain
Extensions []ListenerDomain Extension Args - Enable
Http2 string - HTTP 2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled; off: disabled (default).
- Enable
Quic 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.
- Listener
Id string - Listener ID.
- Listener
Name 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.
- Load
Balancer stringId - Load balancer instance ID associated with the listener.
- Pca
Leaf stringCertificate Id - Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
- Pca
Root stringCa Certificate Id - 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 stringCa Certificate Id - 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 string - Project name to which the listener belongs.
- Protocol string
- Listener protocol. Supports HTTP and HTTPS protocols.
- Server
Group stringId - Default server group for the listener.
- Server
Groups []ListenerServer Group Args - Status string
- Listener status. Values: Creating: creating. Active: running. Pending: configuration changing. Disabled: stopped. Deleting: deleting.
-
[]Listener
Tag Args - Updated
Time string - The most recent operation time of the listener.
- access
Log StringRecord Customized Headers Enabled - Whether the listener has enabled 'Record custom header in access logs': on: enabled. off: not enabled.
- acl
Ids List<String> - Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.
- acl
Status String - Whether access control is enabled. Values: on: enabled. off: not enabled (default).
- acl
Type 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.
- ca
Certificate StringId - 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 StringSource - 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 StringCertificate Id - Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is cert_center.
- certificate
Id String - Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.
- certificate
Source 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.
- created
Time String - Listener creation time.
- customized
Cfg StringId - 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.
- domain
Extensions List<ListenerDomain Extension> - enable
Http2 String - HTTP 2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled; off: disabled (default).
- enable
Quic 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.
- listener
Id String - Listener ID.
- listener
Name 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.
- load
Balancer StringId - Load balancer instance ID associated with the listener.
- pca
Leaf StringCertificate Id - Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
- pca
Root StringCa Certificate Id - 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 StringCa Certificate Id - 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.
- project
Name String - Project name to which the listener belongs.
- protocol String
- Listener protocol. Supports HTTP and HTTPS protocols.
- server
Group StringId - Default server group for the listener.
- server
Groups List<ListenerServer Group> - status String
- Listener status. Values: Creating: creating. Active: running. Pending: configuration changing. Disabled: stopped. Deleting: deleting.
-
List<Listener
Tag> - updated
Time String - The most recent operation time of the listener.
- access
Log stringRecord Customized Headers Enabled - Whether the listener has enabled 'Record custom header in access logs': on: enabled. off: not enabled.
- acl
Ids string[] - Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.
- acl
Status string - Whether access control is enabled. Values: on: enabled. off: not enabled (default).
- acl
Type 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.
- ca
Certificate stringId - 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 stringSource - 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 stringCertificate Id - Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is cert_center.
- certificate
Id string - Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.
- certificate
Source 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.
- created
Time string - Listener creation time.
- customized
Cfg stringId - 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.
- domain
Extensions ListenerDomain Extension[] - enable
Http2 string - HTTP 2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled; off: disabled (default).
- enable
Quic 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.
- listener
Id string - Listener ID.
- listener
Name 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.
- load
Balancer stringId - Load balancer instance ID associated with the listener.
- pca
Leaf stringCertificate Id - Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
- pca
Root stringCa Certificate Id - 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 stringCa Certificate Id - 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.
- project
Name string - Project name to which the listener belongs.
- protocol string
- Listener protocol. Supports HTTP and HTTPS protocols.
- server
Group stringId - Default server group for the listener.
- server
Groups ListenerServer Group[] - status string
- Listener status. Values: Creating: creating. Active: running. Pending: configuration changing. Disabled: stopped. Deleting: deleting.
-
Listener
Tag[] - updated
Time string - The most recent operation time of the listener.
- access_
log_ strrecord_ customized_ headers_ enabled - 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_ strid - 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_ strsource - 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_ strcertificate_ id - 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_ strid - 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[ListenerDomain Extension Args] - 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.
- 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_ strid - Load balancer instance ID associated with the listener.
- pca_
leaf_ strcertificate_ id - Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
- pca_
root_ strca_ certificate_ id - 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_ strca_ certificate_ id - 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_ strid - Default server group for the listener.
- server_
groups Sequence[ListenerServer Group Args] - status str
- Listener status. Values: Creating: creating. Active: running. Pending: configuration changing. Disabled: stopped. Deleting: deleting.
-
Sequence[Listener
Tag Args] - updated_
time str - The most recent operation time of the listener.
- access
Log StringRecord Customized Headers Enabled - Whether the listener has enabled 'Record custom header in access logs': on: enabled. off: not enabled.
- acl
Ids List<String> - Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.
- acl
Status String - Whether access control is enabled. Values: on: enabled. off: not enabled (default).
- acl
Type 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.
- ca
Certificate StringId - 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 StringSource - 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 StringCertificate Id - Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is cert_center.
- certificate
Id String - Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.
- certificate
Source 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.
- created
Time String - Listener creation time.
- customized
Cfg StringId - 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.
- domain
Extensions List<Property Map> - enable
Http2 String - HTTP 2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled; off: disabled (default).
- enable
Quic 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.
- listener
Id String - Listener ID.
- listener
Name 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.
- load
Balancer StringId - Load balancer instance ID associated with the listener.
- pca
Leaf StringCertificate Id - Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.
- pca
Root StringCa Certificate Id - 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 StringCa Certificate Id - 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.
- project
Name String - Project name to which the listener belongs.
- protocol String
- Listener protocol. Supports HTTP and HTTPS protocols.
- server
Group StringId - Default server group for the listener.
- server
Groups List<Property Map> - status String
- Listener status. Values: Creating: creating. Active: running. Pending: configuration changing. Disabled: stopped. Deleting: deleting.
- List<Property Map>
- updated
Time String - The most recent operation time of the listener.
Supporting Types
ListenerDomainExtension, ListenerDomainExtensionArgs
- Cert
Center stringCertificate Id - Server certificate ID used by the domain name. Effective when the certificate source is cert_center.
- Certificate
Id string - Server certificate ID used by the domain. Effective when the certificate source is alb.
- Certificate
Source 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.
- Pca
Leaf stringCertificate Id - 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 stringCertificate Id - Server certificate ID used by the domain name. Effective when the certificate source is cert_center.
- Certificate
Id string - Server certificate ID used by the domain. Effective when the certificate source is alb.
- Certificate
Source 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.
- Pca
Leaf stringCertificate Id - 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 StringCertificate Id - Server certificate ID used by the domain name. Effective when the certificate source is cert_center.
- certificate
Id String - Server certificate ID used by the domain. Effective when the certificate source is alb.
- certificate
Source 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.
- pca
Leaf StringCertificate Id - 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 stringCertificate Id - Server certificate ID used by the domain name. Effective when the certificate source is cert_center.
- certificate
Id string - Server certificate ID used by the domain. Effective when the certificate source is alb.
- certificate
Source 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.
- pca
Leaf stringCertificate Id - 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_ strcertificate_ id - 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.
- pca_
leaf_ strcertificate_ id - 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.
- cert
Center StringCertificate Id - Server certificate ID used by the domain name. Effective when the certificate source is cert_center.
- certificate
Id String - Server certificate ID used by the domain. Effective when the certificate source is alb.
- certificate
Source 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.
- pca
Leaf StringCertificate Id - 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.
ListenerServerGroup, ListenerServerGroupArgs
- Server
Group stringId - Server group ID.
- Server
Group stringName - Server group name.
- Server
Group stringId - Server group ID.
- Server
Group stringName - Server group name.
- server
Group StringId - Server group ID.
- server
Group StringName - Server group name.
- server
Group stringId - Server group ID.
- server
Group stringName - Server group name.
- server_
group_ strid - Server group ID.
- server_
group_ strname - Server group name.
- server
Group StringId - Server group ID.
- server
Group StringName - Server group name.
ListenerTag, ListenerTagArgs
- 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 @.
Import
$ pulumi import bytepluscc:alb/listener:Listener example "listener_id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- bytepluscc byteplus-sdk/pulumi-bytepluscc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
byteplusccTerraform Provider.
published on Thursday, May 7, 2026 by Byteplus
