Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. alb
  5. Listener
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.alb.Listener

Explore with Pulumi AI

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

Provides a Application Load Balancer (ALB) Listener resource.

For information about Application Load Balancer (ALB) Listener and how to use it, see What is Listener.

NOTE: Available since v1.133.0.

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,
             default_actions: Optional[Sequence[ListenerDefaultActionArgs]] = None,
             load_balancer_id: Optional[str] = None,
             listener_protocol: Optional[str] = None,
             listener_port: Optional[int] = None,
             idle_timeout: Optional[int] = None,
             acl_config: Optional[ListenerAclConfigArgs] = None,
             ca_enabled: Optional[bool] = None,
             dry_run: Optional[bool] = None,
             gzip_enabled: Optional[bool] = None,
             http2_enabled: Optional[bool] = None,
             access_log_record_customized_headers_enabled: Optional[bool] = None,
             listener_description: Optional[str] = None,
             ca_certificates: Optional[Sequence[ListenerCaCertificateArgs]] = None,
             certificates: Optional[ListenerCertificatesArgs] = None,
             access_log_tracing_config: Optional[ListenerAccessLogTracingConfigArgs] = None,
             quic_config: Optional[ListenerQuicConfigArgs] = None,
             request_timeout: Optional[int] = None,
             security_policy_id: Optional[str] = None,
             status: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None,
             x_forwarded_for_config: Optional[ListenerXForwardedForConfigArgs] = 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: alicloud:alb:Listener
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ListenerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ListenerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ListenerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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 AliCloud.Alb.Listener("listenerResource", new()
{
    DefaultActions = new[]
    {
        new AliCloud.Alb.Inputs.ListenerDefaultActionArgs
        {
            Type = "string",
            ForwardGroupConfig = new AliCloud.Alb.Inputs.ListenerDefaultActionForwardGroupConfigArgs
            {
                ServerGroupTuples = new[]
                {
                    new AliCloud.Alb.Inputs.ListenerDefaultActionForwardGroupConfigServerGroupTupleArgs
                    {
                        ServerGroupId = "string",
                    },
                },
            },
        },
    },
    LoadBalancerId = "string",
    ListenerProtocol = "string",
    ListenerPort = 0,
    IdleTimeout = 0,
    CaEnabled = false,
    DryRun = false,
    GzipEnabled = false,
    Http2Enabled = false,
    AccessLogRecordCustomizedHeadersEnabled = false,
    ListenerDescription = "string",
    CaCertificates = new[]
    {
        new AliCloud.Alb.Inputs.ListenerCaCertificateArgs
        {
            CertificateId = "string",
        },
    },
    Certificates = new AliCloud.Alb.Inputs.ListenerCertificatesArgs
    {
        CertificateId = "string",
    },
    AccessLogTracingConfig = new AliCloud.Alb.Inputs.ListenerAccessLogTracingConfigArgs
    {
        TracingEnabled = false,
        TracingSample = 0,
        TracingType = "string",
    },
    QuicConfig = new AliCloud.Alb.Inputs.ListenerQuicConfigArgs
    {
        QuicListenerId = "string",
        QuicUpgradeEnabled = false,
    },
    RequestTimeout = 0,
    SecurityPolicyId = "string",
    Status = "string",
    Tags = 
    {
        { "string", "string" },
    },
    XForwardedForConfig = new AliCloud.Alb.Inputs.ListenerXForwardedForConfigArgs
    {
        XForwardedForClientCertClientVerifyAlias = "string",
        XForwardedForClientCertClientVerifyEnabled = false,
        XForwardedForClientCertFingerPrintAlias = "string",
        XForwardedForClientCertFingerPrintEnabled = false,
        XForwardedForClientCertIssuerDnAlias = "string",
        XForwardedForClientCertIssuerDnEnabled = false,
        XForwardedForClientCertSubjectDnAlias = "string",
        XForwardedForClientCertSubjectDnEnabled = false,
        XForwardedForClientSourceIpsEnabled = false,
        XForwardedForClientSourceIpsTrusted = "string",
        XForwardedForClientSrcPortEnabled = false,
        XForwardedForEnabled = false,
        XForwardedForHostEnabled = false,
        XForwardedForProcessingMode = "string",
        XForwardedForProtoEnabled = false,
        XForwardedForSlbIdEnabled = false,
        XForwardedForSlbPortEnabled = false,
    },
});
Copy
example, err := alb.NewListener(ctx, "listenerResource", &alb.ListenerArgs{
	DefaultActions: alb.ListenerDefaultActionArray{
		&alb.ListenerDefaultActionArgs{
			Type: pulumi.String("string"),
			ForwardGroupConfig: &alb.ListenerDefaultActionForwardGroupConfigArgs{
				ServerGroupTuples: alb.ListenerDefaultActionForwardGroupConfigServerGroupTupleArray{
					&alb.ListenerDefaultActionForwardGroupConfigServerGroupTupleArgs{
						ServerGroupId: pulumi.String("string"),
					},
				},
			},
		},
	},
	LoadBalancerId:                          pulumi.String("string"),
	ListenerProtocol:                        pulumi.String("string"),
	ListenerPort:                            pulumi.Int(0),
	IdleTimeout:                             pulumi.Int(0),
	CaEnabled:                               pulumi.Bool(false),
	DryRun:                                  pulumi.Bool(false),
	GzipEnabled:                             pulumi.Bool(false),
	Http2Enabled:                            pulumi.Bool(false),
	AccessLogRecordCustomizedHeadersEnabled: pulumi.Bool(false),
	ListenerDescription:                     pulumi.String("string"),
	CaCertificates: alb.ListenerCaCertificateArray{
		&alb.ListenerCaCertificateArgs{
			CertificateId: pulumi.String("string"),
		},
	},
	Certificates: &alb.ListenerCertificatesArgs{
		CertificateId: pulumi.String("string"),
	},
	AccessLogTracingConfig: &alb.ListenerAccessLogTracingConfigArgs{
		TracingEnabled: pulumi.Bool(false),
		TracingSample:  pulumi.Int(0),
		TracingType:    pulumi.String("string"),
	},
	QuicConfig: &alb.ListenerQuicConfigArgs{
		QuicListenerId:     pulumi.String("string"),
		QuicUpgradeEnabled: pulumi.Bool(false),
	},
	RequestTimeout:   pulumi.Int(0),
	SecurityPolicyId: pulumi.String("string"),
	Status:           pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	XForwardedForConfig: &alb.ListenerXForwardedForConfigArgs{
		XForwardedForClientCertClientVerifyAlias:   pulumi.String("string"),
		XForwardedForClientCertClientVerifyEnabled: pulumi.Bool(false),
		XForwardedForClientCertFingerPrintAlias:    pulumi.String("string"),
		XForwardedForClientCertFingerPrintEnabled:  pulumi.Bool(false),
		XForwardedForClientCertIssuerDnAlias:       pulumi.String("string"),
		XForwardedForClientCertIssuerDnEnabled:     pulumi.Bool(false),
		XForwardedForClientCertSubjectDnAlias:      pulumi.String("string"),
		XForwardedForClientCertSubjectDnEnabled:    pulumi.Bool(false),
		XForwardedForClientSourceIpsEnabled:        pulumi.Bool(false),
		XForwardedForClientSourceIpsTrusted:        pulumi.String("string"),
		XForwardedForClientSrcPortEnabled:          pulumi.Bool(false),
		XForwardedForEnabled:                       pulumi.Bool(false),
		XForwardedForHostEnabled:                   pulumi.Bool(false),
		XForwardedForProcessingMode:                pulumi.String("string"),
		XForwardedForProtoEnabled:                  pulumi.Bool(false),
		XForwardedForSlbIdEnabled:                  pulumi.Bool(false),
		XForwardedForSlbPortEnabled:                pulumi.Bool(false),
	},
})
Copy
var listenerResource = new Listener("listenerResource", ListenerArgs.builder()
    .defaultActions(ListenerDefaultActionArgs.builder()
        .type("string")
        .forwardGroupConfig(ListenerDefaultActionForwardGroupConfigArgs.builder()
            .serverGroupTuples(ListenerDefaultActionForwardGroupConfigServerGroupTupleArgs.builder()
                .serverGroupId("string")
                .build())
            .build())
        .build())
    .loadBalancerId("string")
    .listenerProtocol("string")
    .listenerPort(0)
    .idleTimeout(0)
    .caEnabled(false)
    .dryRun(false)
    .gzipEnabled(false)
    .http2Enabled(false)
    .accessLogRecordCustomizedHeadersEnabled(false)
    .listenerDescription("string")
    .caCertificates(ListenerCaCertificateArgs.builder()
        .certificateId("string")
        .build())
    .certificates(ListenerCertificatesArgs.builder()
        .certificateId("string")
        .build())
    .accessLogTracingConfig(ListenerAccessLogTracingConfigArgs.builder()
        .tracingEnabled(false)
        .tracingSample(0)
        .tracingType("string")
        .build())
    .quicConfig(ListenerQuicConfigArgs.builder()
        .quicListenerId("string")
        .quicUpgradeEnabled(false)
        .build())
    .requestTimeout(0)
    .securityPolicyId("string")
    .status("string")
    .tags(Map.of("string", "string"))
    .xForwardedForConfig(ListenerXForwardedForConfigArgs.builder()
        .xForwardedForClientCertClientVerifyAlias("string")
        .xForwardedForClientCertClientVerifyEnabled(false)
        .xForwardedForClientCertFingerPrintAlias("string")
        .xForwardedForClientCertFingerPrintEnabled(false)
        .xForwardedForClientCertIssuerDnAlias("string")
        .xForwardedForClientCertIssuerDnEnabled(false)
        .xForwardedForClientCertSubjectDnAlias("string")
        .xForwardedForClientCertSubjectDnEnabled(false)
        .xForwardedForClientSourceIpsEnabled(false)
        .xForwardedForClientSourceIpsTrusted("string")
        .xForwardedForClientSrcPortEnabled(false)
        .xForwardedForEnabled(false)
        .xForwardedForHostEnabled(false)
        .xForwardedForProcessingMode("string")
        .xForwardedForProtoEnabled(false)
        .xForwardedForSlbIdEnabled(false)
        .xForwardedForSlbPortEnabled(false)
        .build())
    .build());
Copy
listener_resource = alicloud.alb.Listener("listenerResource",
    default_actions=[{
        "type": "string",
        "forward_group_config": {
            "server_group_tuples": [{
                "server_group_id": "string",
            }],
        },
    }],
    load_balancer_id="string",
    listener_protocol="string",
    listener_port=0,
    idle_timeout=0,
    ca_enabled=False,
    dry_run=False,
    gzip_enabled=False,
    http2_enabled=False,
    access_log_record_customized_headers_enabled=False,
    listener_description="string",
    ca_certificates=[{
        "certificate_id": "string",
    }],
    certificates={
        "certificate_id": "string",
    },
    access_log_tracing_config={
        "tracing_enabled": False,
        "tracing_sample": 0,
        "tracing_type": "string",
    },
    quic_config={
        "quic_listener_id": "string",
        "quic_upgrade_enabled": False,
    },
    request_timeout=0,
    security_policy_id="string",
    status="string",
    tags={
        "string": "string",
    },
    x_forwarded_for_config={
        "x_forwarded_for_client_cert_client_verify_alias": "string",
        "x_forwarded_for_client_cert_client_verify_enabled": False,
        "x_forwarded_for_client_cert_finger_print_alias": "string",
        "x_forwarded_for_client_cert_finger_print_enabled": False,
        "x_forwarded_for_client_cert_issuer_dn_alias": "string",
        "x_forwarded_for_client_cert_issuer_dn_enabled": False,
        "x_forwarded_for_client_cert_subject_dn_alias": "string",
        "x_forwarded_for_client_cert_subject_dn_enabled": False,
        "x_forwarded_for_client_source_ips_enabled": False,
        "x_forwarded_for_client_source_ips_trusted": "string",
        "x_forwarded_for_client_src_port_enabled": False,
        "x_forwarded_for_enabled": False,
        "x_forwarded_for_host_enabled": False,
        "x_forwarded_for_processing_mode": "string",
        "x_forwarded_for_proto_enabled": False,
        "x_forwarded_for_slb_id_enabled": False,
        "x_forwarded_for_slb_port_enabled": False,
    })
Copy
const listenerResource = new alicloud.alb.Listener("listenerResource", {
    defaultActions: [{
        type: "string",
        forwardGroupConfig: {
            serverGroupTuples: [{
                serverGroupId: "string",
            }],
        },
    }],
    loadBalancerId: "string",
    listenerProtocol: "string",
    listenerPort: 0,
    idleTimeout: 0,
    caEnabled: false,
    dryRun: false,
    gzipEnabled: false,
    http2Enabled: false,
    accessLogRecordCustomizedHeadersEnabled: false,
    listenerDescription: "string",
    caCertificates: [{
        certificateId: "string",
    }],
    certificates: {
        certificateId: "string",
    },
    accessLogTracingConfig: {
        tracingEnabled: false,
        tracingSample: 0,
        tracingType: "string",
    },
    quicConfig: {
        quicListenerId: "string",
        quicUpgradeEnabled: false,
    },
    requestTimeout: 0,
    securityPolicyId: "string",
    status: "string",
    tags: {
        string: "string",
    },
    xForwardedForConfig: {
        xForwardedForClientCertClientVerifyAlias: "string",
        xForwardedForClientCertClientVerifyEnabled: false,
        xForwardedForClientCertFingerPrintAlias: "string",
        xForwardedForClientCertFingerPrintEnabled: false,
        xForwardedForClientCertIssuerDnAlias: "string",
        xForwardedForClientCertIssuerDnEnabled: false,
        xForwardedForClientCertSubjectDnAlias: "string",
        xForwardedForClientCertSubjectDnEnabled: false,
        xForwardedForClientSourceIpsEnabled: false,
        xForwardedForClientSourceIpsTrusted: "string",
        xForwardedForClientSrcPortEnabled: false,
        xForwardedForEnabled: false,
        xForwardedForHostEnabled: false,
        xForwardedForProcessingMode: "string",
        xForwardedForProtoEnabled: false,
        xForwardedForSlbIdEnabled: false,
        xForwardedForSlbPortEnabled: false,
    },
});
Copy
type: alicloud:alb:Listener
properties:
    accessLogRecordCustomizedHeadersEnabled: false
    accessLogTracingConfig:
        tracingEnabled: false
        tracingSample: 0
        tracingType: string
    caCertificates:
        - certificateId: string
    caEnabled: false
    certificates:
        certificateId: string
    defaultActions:
        - forwardGroupConfig:
            serverGroupTuples:
                - serverGroupId: string
          type: string
    dryRun: false
    gzipEnabled: false
    http2Enabled: false
    idleTimeout: 0
    listenerDescription: string
    listenerPort: 0
    listenerProtocol: string
    loadBalancerId: string
    quicConfig:
        quicListenerId: string
        quicUpgradeEnabled: false
    requestTimeout: 0
    securityPolicyId: string
    status: string
    tags:
        string: string
    xForwardedForConfig:
        xForwardedForClientCertClientVerifyAlias: string
        xForwardedForClientCertClientVerifyEnabled: false
        xForwardedForClientCertFingerPrintAlias: string
        xForwardedForClientCertFingerPrintEnabled: false
        xForwardedForClientCertIssuerDnAlias: string
        xForwardedForClientCertIssuerDnEnabled: false
        xForwardedForClientCertSubjectDnAlias: string
        xForwardedForClientCertSubjectDnEnabled: false
        xForwardedForClientSourceIpsEnabled: false
        xForwardedForClientSourceIpsTrusted: string
        xForwardedForClientSrcPortEnabled: false
        xForwardedForEnabled: false
        xForwardedForHostEnabled: false
        xForwardedForProcessingMode: string
        xForwardedForProtoEnabled: false
        xForwardedForSlbIdEnabled: false
        xForwardedForSlbPortEnabled: false
Copy

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:

DefaultActions This property is required. List<Pulumi.AliCloud.Alb.Inputs.ListenerDefaultAction>
The Default Rule Action List See default_actions below.
ListenerPort
This property is required.
Changes to this property will trigger replacement.
int
The SLB Instance Front-End, and Those of the Ports Used. Value: 1~65535.
ListenerProtocol
This property is required.
Changes to this property will trigger replacement.
string
Snooping Protocols. Valid Values: HTTP, HTTPS Or QuIC.
LoadBalancerId
This property is required.
Changes to this property will trigger replacement.
string
The SLB Instance Id.
AccessLogRecordCustomizedHeadersEnabled bool

Access Log Whether to Enable Carry Custom Header Field.

Value: True **** Or False * *.

Default Value: False * *.

NOTE: Only Instances outside the Security Group to Access the Log Switch accesslogenabled Open, in Order to Set This Parameter to the **True * *.

AccessLogTracingConfig Pulumi.AliCloud.Alb.Inputs.ListenerAccessLogTracingConfig
Xtrace Configuration Information. See access_log_tracing_config below.
AclConfig Pulumi.AliCloud.Alb.Inputs.ListenerAclConfig
The configurations of the access control lists (ACLs). See acl_config below for details. NOTE: Field acl_config has been deprecated from provider version 1.163.0, and it will be removed in the future version. Please use the new resource alicloud.alb.ListenerAclAttachment.,

Deprecated: Field 'acl_config' has been deprecated from provider version 1.163.0 and it will be removed in the future version. Please use the new resource 'alicloud_alb_listener_acl_attachment'.

CaCertificates List<Pulumi.AliCloud.Alb.Inputs.ListenerCaCertificate>
The list of certificates. See ca_certificates below.
CaEnabled bool
Whether to turn on two-way authentication. Value:
Certificates Pulumi.AliCloud.Alb.Inputs.ListenerCertificates
The list of certificates. See certificates below.
DryRun bool
Whether to PreCheck only this request. Value:
GzipEnabled bool
Whether to Enable Gzip Compression, as a Specific File Type on a Compression. Valid Values: True Or False. Default Value: TRUE.
Http2Enabled bool
Whether to Enable HTTP/2 Features. Valid Values: True Or False. Default Value: TRUE.
IdleTimeout int
Specify the Connection Idle Timeout Value: 1 to 60 miao.
ListenerDescription string
Set the IP Address of the Listened Description. Length Is from 2 to 256 Characters.
QuicConfig Pulumi.AliCloud.Alb.Inputs.ListenerQuicConfig
Configuration Associated with the QuIC Listening See quic_config below.
RequestTimeout int
The Specified Request Timeout Time. Value: 1~180 Seconds. Default Value: 60 miao. If the Timeout Time Within the Back-End Server Has Not Answered the SLB Will Give up Waiting, the Client Returns the HTTP 504 Error Code.
SecurityPolicyId string
Security Policy
Status string
The Current IP Address of the Listened State
Tags Dictionary<string, string>
The tag of the resource
XForwardedForConfig Pulumi.AliCloud.Alb.Inputs.ListenerXForwardedForConfig
xforwardfor Related Attribute Configuration See x_forwarded_for_config below.
DefaultActions This property is required. []ListenerDefaultActionArgs
The Default Rule Action List See default_actions below.
ListenerPort
This property is required.
Changes to this property will trigger replacement.
int
The SLB Instance Front-End, and Those of the Ports Used. Value: 1~65535.
ListenerProtocol
This property is required.
Changes to this property will trigger replacement.
string
Snooping Protocols. Valid Values: HTTP, HTTPS Or QuIC.
LoadBalancerId
This property is required.
Changes to this property will trigger replacement.
string
The SLB Instance Id.
AccessLogRecordCustomizedHeadersEnabled bool

Access Log Whether to Enable Carry Custom Header Field.

Value: True **** Or False * *.

Default Value: False * *.

NOTE: Only Instances outside the Security Group to Access the Log Switch accesslogenabled Open, in Order to Set This Parameter to the **True * *.

AccessLogTracingConfig ListenerAccessLogTracingConfigArgs
Xtrace Configuration Information. See access_log_tracing_config below.
AclConfig ListenerAclConfigArgs
The configurations of the access control lists (ACLs). See acl_config below for details. NOTE: Field acl_config has been deprecated from provider version 1.163.0, and it will be removed in the future version. Please use the new resource alicloud.alb.ListenerAclAttachment.,

Deprecated: Field 'acl_config' has been deprecated from provider version 1.163.0 and it will be removed in the future version. Please use the new resource 'alicloud_alb_listener_acl_attachment'.

CaCertificates []ListenerCaCertificateArgs
The list of certificates. See ca_certificates below.
CaEnabled bool
Whether to turn on two-way authentication. Value:
Certificates ListenerCertificatesArgs
The list of certificates. See certificates below.
DryRun bool
Whether to PreCheck only this request. Value:
GzipEnabled bool
Whether to Enable Gzip Compression, as a Specific File Type on a Compression. Valid Values: True Or False. Default Value: TRUE.
Http2Enabled bool
Whether to Enable HTTP/2 Features. Valid Values: True Or False. Default Value: TRUE.
IdleTimeout int
Specify the Connection Idle Timeout Value: 1 to 60 miao.
ListenerDescription string
Set the IP Address of the Listened Description. Length Is from 2 to 256 Characters.
QuicConfig ListenerQuicConfigArgs
Configuration Associated with the QuIC Listening See quic_config below.
RequestTimeout int
The Specified Request Timeout Time. Value: 1~180 Seconds. Default Value: 60 miao. If the Timeout Time Within the Back-End Server Has Not Answered the SLB Will Give up Waiting, the Client Returns the HTTP 504 Error Code.
SecurityPolicyId string
Security Policy
Status string
The Current IP Address of the Listened State
Tags map[string]string
The tag of the resource
XForwardedForConfig ListenerXForwardedForConfigArgs
xforwardfor Related Attribute Configuration See x_forwarded_for_config below.
defaultActions This property is required. List<ListenerDefaultAction>
The Default Rule Action List See default_actions below.
listenerPort
This property is required.
Changes to this property will trigger replacement.
Integer
The SLB Instance Front-End, and Those of the Ports Used. Value: 1~65535.
listenerProtocol
This property is required.
Changes to this property will trigger replacement.
String
Snooping Protocols. Valid Values: HTTP, HTTPS Or QuIC.
loadBalancerId
This property is required.
Changes to this property will trigger replacement.
String
The SLB Instance Id.
accessLogRecordCustomizedHeadersEnabled Boolean

Access Log Whether to Enable Carry Custom Header Field.

Value: True **** Or False * *.

Default Value: False * *.

NOTE: Only Instances outside the Security Group to Access the Log Switch accesslogenabled Open, in Order to Set This Parameter to the **True * *.

accessLogTracingConfig ListenerAccessLogTracingConfig
Xtrace Configuration Information. See access_log_tracing_config below.
aclConfig ListenerAclConfig
The configurations of the access control lists (ACLs). See acl_config below for details. NOTE: Field acl_config has been deprecated from provider version 1.163.0, and it will be removed in the future version. Please use the new resource alicloud.alb.ListenerAclAttachment.,

Deprecated: Field 'acl_config' has been deprecated from provider version 1.163.0 and it will be removed in the future version. Please use the new resource 'alicloud_alb_listener_acl_attachment'.

caCertificates List<ListenerCaCertificate>
The list of certificates. See ca_certificates below.
caEnabled Boolean
Whether to turn on two-way authentication. Value:
certificates ListenerCertificates
The list of certificates. See certificates below.
dryRun Boolean
Whether to PreCheck only this request. Value:
gzipEnabled Boolean
Whether to Enable Gzip Compression, as a Specific File Type on a Compression. Valid Values: True Or False. Default Value: TRUE.
http2Enabled Boolean
Whether to Enable HTTP/2 Features. Valid Values: True Or False. Default Value: TRUE.
idleTimeout Integer
Specify the Connection Idle Timeout Value: 1 to 60 miao.
listenerDescription String
Set the IP Address of the Listened Description. Length Is from 2 to 256 Characters.
quicConfig ListenerQuicConfig
Configuration Associated with the QuIC Listening See quic_config below.
requestTimeout Integer
The Specified Request Timeout Time. Value: 1~180 Seconds. Default Value: 60 miao. If the Timeout Time Within the Back-End Server Has Not Answered the SLB Will Give up Waiting, the Client Returns the HTTP 504 Error Code.
securityPolicyId String
Security Policy
status String
The Current IP Address of the Listened State
tags Map<String,String>
The tag of the resource
xForwardedForConfig ListenerXForwardedForConfig
xforwardfor Related Attribute Configuration See x_forwarded_for_config below.
defaultActions This property is required. ListenerDefaultAction[]
The Default Rule Action List See default_actions below.
listenerPort
This property is required.
Changes to this property will trigger replacement.
number
The SLB Instance Front-End, and Those of the Ports Used. Value: 1~65535.
listenerProtocol
This property is required.
Changes to this property will trigger replacement.
string
Snooping Protocols. Valid Values: HTTP, HTTPS Or QuIC.
loadBalancerId
This property is required.
Changes to this property will trigger replacement.
string
The SLB Instance Id.
accessLogRecordCustomizedHeadersEnabled boolean

Access Log Whether to Enable Carry Custom Header Field.

Value: True **** Or False * *.

Default Value: False * *.

NOTE: Only Instances outside the Security Group to Access the Log Switch accesslogenabled Open, in Order to Set This Parameter to the **True * *.

accessLogTracingConfig ListenerAccessLogTracingConfig
Xtrace Configuration Information. See access_log_tracing_config below.
aclConfig ListenerAclConfig
The configurations of the access control lists (ACLs). See acl_config below for details. NOTE: Field acl_config has been deprecated from provider version 1.163.0, and it will be removed in the future version. Please use the new resource alicloud.alb.ListenerAclAttachment.,

Deprecated: Field 'acl_config' has been deprecated from provider version 1.163.0 and it will be removed in the future version. Please use the new resource 'alicloud_alb_listener_acl_attachment'.

caCertificates ListenerCaCertificate[]
The list of certificates. See ca_certificates below.
caEnabled boolean
Whether to turn on two-way authentication. Value:
certificates ListenerCertificates
The list of certificates. See certificates below.
dryRun boolean
Whether to PreCheck only this request. Value:
gzipEnabled boolean
Whether to Enable Gzip Compression, as a Specific File Type on a Compression. Valid Values: True Or False. Default Value: TRUE.
http2Enabled boolean
Whether to Enable HTTP/2 Features. Valid Values: True Or False. Default Value: TRUE.
idleTimeout number
Specify the Connection Idle Timeout Value: 1 to 60 miao.
listenerDescription string
Set the IP Address of the Listened Description. Length Is from 2 to 256 Characters.
quicConfig ListenerQuicConfig
Configuration Associated with the QuIC Listening See quic_config below.
requestTimeout number
The Specified Request Timeout Time. Value: 1~180 Seconds. Default Value: 60 miao. If the Timeout Time Within the Back-End Server Has Not Answered the SLB Will Give up Waiting, the Client Returns the HTTP 504 Error Code.
securityPolicyId string
Security Policy
status string
The Current IP Address of the Listened State
tags {[key: string]: string}
The tag of the resource
xForwardedForConfig ListenerXForwardedForConfig
xforwardfor Related Attribute Configuration See x_forwarded_for_config below.
default_actions This property is required. Sequence[ListenerDefaultActionArgs]
The Default Rule Action List See default_actions below.
listener_port
This property is required.
Changes to this property will trigger replacement.
int
The SLB Instance Front-End, and Those of the Ports Used. Value: 1~65535.
listener_protocol
This property is required.
Changes to this property will trigger replacement.
str
Snooping Protocols. Valid Values: HTTP, HTTPS Or QuIC.
load_balancer_id
This property is required.
Changes to this property will trigger replacement.
str
The SLB Instance Id.
access_log_record_customized_headers_enabled bool

Access Log Whether to Enable Carry Custom Header Field.

Value: True **** Or False * *.

Default Value: False * *.

NOTE: Only Instances outside the Security Group to Access the Log Switch accesslogenabled Open, in Order to Set This Parameter to the **True * *.

access_log_tracing_config ListenerAccessLogTracingConfigArgs
Xtrace Configuration Information. See access_log_tracing_config below.
acl_config ListenerAclConfigArgs
The configurations of the access control lists (ACLs). See acl_config below for details. NOTE: Field acl_config has been deprecated from provider version 1.163.0, and it will be removed in the future version. Please use the new resource alicloud.alb.ListenerAclAttachment.,

Deprecated: Field 'acl_config' has been deprecated from provider version 1.163.0 and it will be removed in the future version. Please use the new resource 'alicloud_alb_listener_acl_attachment'.

ca_certificates Sequence[ListenerCaCertificateArgs]
The list of certificates. See ca_certificates below.
ca_enabled bool
Whether to turn on two-way authentication. Value:
certificates ListenerCertificatesArgs
The list of certificates. See certificates below.
dry_run bool
Whether to PreCheck only this request. Value:
gzip_enabled bool
Whether to Enable Gzip Compression, as a Specific File Type on a Compression. Valid Values: True Or False. Default Value: TRUE.
http2_enabled bool
Whether to Enable HTTP/2 Features. Valid Values: True Or False. Default Value: TRUE.
idle_timeout int
Specify the Connection Idle Timeout Value: 1 to 60 miao.
listener_description str
Set the IP Address of the Listened Description. Length Is from 2 to 256 Characters.
quic_config ListenerQuicConfigArgs
Configuration Associated with the QuIC Listening See quic_config below.
request_timeout int
The Specified Request Timeout Time. Value: 1~180 Seconds. Default Value: 60 miao. If the Timeout Time Within the Back-End Server Has Not Answered the SLB Will Give up Waiting, the Client Returns the HTTP 504 Error Code.
security_policy_id str
Security Policy
status str
The Current IP Address of the Listened State
tags Mapping[str, str]
The tag of the resource
x_forwarded_for_config ListenerXForwardedForConfigArgs
xforwardfor Related Attribute Configuration See x_forwarded_for_config below.
defaultActions This property is required. List<Property Map>
The Default Rule Action List See default_actions below.
listenerPort
This property is required.
Changes to this property will trigger replacement.
Number
The SLB Instance Front-End, and Those of the Ports Used. Value: 1~65535.
listenerProtocol
This property is required.
Changes to this property will trigger replacement.
String
Snooping Protocols. Valid Values: HTTP, HTTPS Or QuIC.
loadBalancerId
This property is required.
Changes to this property will trigger replacement.
String
The SLB Instance Id.
accessLogRecordCustomizedHeadersEnabled Boolean

Access Log Whether to Enable Carry Custom Header Field.

Value: True **** Or False * *.

Default Value: False * *.

NOTE: Only Instances outside the Security Group to Access the Log Switch accesslogenabled Open, in Order to Set This Parameter to the **True * *.

accessLogTracingConfig Property Map
Xtrace Configuration Information. See access_log_tracing_config below.
aclConfig Property Map
The configurations of the access control lists (ACLs). See acl_config below for details. NOTE: Field acl_config has been deprecated from provider version 1.163.0, and it will be removed in the future version. Please use the new resource alicloud.alb.ListenerAclAttachment.,

Deprecated: Field 'acl_config' has been deprecated from provider version 1.163.0 and it will be removed in the future version. Please use the new resource 'alicloud_alb_listener_acl_attachment'.

caCertificates List<Property Map>
The list of certificates. See ca_certificates below.
caEnabled Boolean
Whether to turn on two-way authentication. Value:
certificates Property Map
The list of certificates. See certificates below.
dryRun Boolean
Whether to PreCheck only this request. Value:
gzipEnabled Boolean
Whether to Enable Gzip Compression, as a Specific File Type on a Compression. Valid Values: True Or False. Default Value: TRUE.
http2Enabled Boolean
Whether to Enable HTTP/2 Features. Valid Values: True Or False. Default Value: TRUE.
idleTimeout Number
Specify the Connection Idle Timeout Value: 1 to 60 miao.
listenerDescription String
Set the IP Address of the Listened Description. Length Is from 2 to 256 Characters.
quicConfig Property Map
Configuration Associated with the QuIC Listening See quic_config below.
requestTimeout Number
The Specified Request Timeout Time. Value: 1~180 Seconds. Default Value: 60 miao. If the Timeout Time Within the Back-End Server Has Not Answered the SLB Will Give up Waiting, the Client Returns the HTTP 504 Error Code.
securityPolicyId String
Security Policy
status String
The Current IP Address of the Listened State
tags Map<String>
The tag of the resource
xForwardedForConfig Property Map
xforwardfor Related Attribute Configuration See x_forwarded_for_config below.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

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[bool] = None,
        access_log_tracing_config: Optional[ListenerAccessLogTracingConfigArgs] = None,
        acl_config: Optional[ListenerAclConfigArgs] = None,
        ca_certificates: Optional[Sequence[ListenerCaCertificateArgs]] = None,
        ca_enabled: Optional[bool] = None,
        certificates: Optional[ListenerCertificatesArgs] = None,
        default_actions: Optional[Sequence[ListenerDefaultActionArgs]] = None,
        dry_run: Optional[bool] = None,
        gzip_enabled: Optional[bool] = None,
        http2_enabled: Optional[bool] = None,
        idle_timeout: Optional[int] = None,
        listener_description: Optional[str] = None,
        listener_port: Optional[int] = None,
        listener_protocol: Optional[str] = None,
        load_balancer_id: Optional[str] = None,
        quic_config: Optional[ListenerQuicConfigArgs] = None,
        request_timeout: Optional[int] = None,
        security_policy_id: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        x_forwarded_for_config: Optional[ListenerXForwardedForConfigArgs] = None) -> Listener
func GetListener(ctx *Context, name string, id IDInput, state *ListenerState, opts ...ResourceOption) (*Listener, error)
public static Listener Get(string name, Input<string> id, ListenerState? state, CustomResourceOptions? opts = null)
public static Listener get(String name, Output<String> id, ListenerState state, CustomResourceOptions options)
resources:  _:    type: alicloud:alb:Listener    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AccessLogRecordCustomizedHeadersEnabled bool

Access Log Whether to Enable Carry Custom Header Field.

Value: True **** Or False * *.

Default Value: False * *.

NOTE: Only Instances outside the Security Group to Access the Log Switch accesslogenabled Open, in Order to Set This Parameter to the **True * *.

AccessLogTracingConfig Pulumi.AliCloud.Alb.Inputs.ListenerAccessLogTracingConfig
Xtrace Configuration Information. See access_log_tracing_config below.
AclConfig Pulumi.AliCloud.Alb.Inputs.ListenerAclConfig
The configurations of the access control lists (ACLs). See acl_config below for details. NOTE: Field acl_config has been deprecated from provider version 1.163.0, and it will be removed in the future version. Please use the new resource alicloud.alb.ListenerAclAttachment.,

Deprecated: Field 'acl_config' has been deprecated from provider version 1.163.0 and it will be removed in the future version. Please use the new resource 'alicloud_alb_listener_acl_attachment'.

CaCertificates List<Pulumi.AliCloud.Alb.Inputs.ListenerCaCertificate>
The list of certificates. See ca_certificates below.
CaEnabled bool
Whether to turn on two-way authentication. Value:
Certificates Pulumi.AliCloud.Alb.Inputs.ListenerCertificates
The list of certificates. See certificates below.
DefaultActions List<Pulumi.AliCloud.Alb.Inputs.ListenerDefaultAction>
The Default Rule Action List See default_actions below.
DryRun bool
Whether to PreCheck only this request. Value:
GzipEnabled bool
Whether to Enable Gzip Compression, as a Specific File Type on a Compression. Valid Values: True Or False. Default Value: TRUE.
Http2Enabled bool
Whether to Enable HTTP/2 Features. Valid Values: True Or False. Default Value: TRUE.
IdleTimeout int
Specify the Connection Idle Timeout Value: 1 to 60 miao.
ListenerDescription string
Set the IP Address of the Listened Description. Length Is from 2 to 256 Characters.
ListenerPort Changes to this property will trigger replacement. int
The SLB Instance Front-End, and Those of the Ports Used. Value: 1~65535.
ListenerProtocol Changes to this property will trigger replacement. string
Snooping Protocols. Valid Values: HTTP, HTTPS Or QuIC.
LoadBalancerId Changes to this property will trigger replacement. string
The SLB Instance Id.
QuicConfig Pulumi.AliCloud.Alb.Inputs.ListenerQuicConfig
Configuration Associated with the QuIC Listening See quic_config below.
RequestTimeout int
The Specified Request Timeout Time. Value: 1~180 Seconds. Default Value: 60 miao. If the Timeout Time Within the Back-End Server Has Not Answered the SLB Will Give up Waiting, the Client Returns the HTTP 504 Error Code.
SecurityPolicyId string
Security Policy
Status string
The Current IP Address of the Listened State
Tags Dictionary<string, string>
The tag of the resource
XForwardedForConfig Pulumi.AliCloud.Alb.Inputs.ListenerXForwardedForConfig
xforwardfor Related Attribute Configuration See x_forwarded_for_config below.
AccessLogRecordCustomizedHeadersEnabled bool

Access Log Whether to Enable Carry Custom Header Field.

Value: True **** Or False * *.

Default Value: False * *.

NOTE: Only Instances outside the Security Group to Access the Log Switch accesslogenabled Open, in Order to Set This Parameter to the **True * *.

AccessLogTracingConfig ListenerAccessLogTracingConfigArgs
Xtrace Configuration Information. See access_log_tracing_config below.
AclConfig ListenerAclConfigArgs
The configurations of the access control lists (ACLs). See acl_config below for details. NOTE: Field acl_config has been deprecated from provider version 1.163.0, and it will be removed in the future version. Please use the new resource alicloud.alb.ListenerAclAttachment.,

Deprecated: Field 'acl_config' has been deprecated from provider version 1.163.0 and it will be removed in the future version. Please use the new resource 'alicloud_alb_listener_acl_attachment'.

CaCertificates []ListenerCaCertificateArgs
The list of certificates. See ca_certificates below.
CaEnabled bool
Whether to turn on two-way authentication. Value:
Certificates ListenerCertificatesArgs
The list of certificates. See certificates below.
DefaultActions []ListenerDefaultActionArgs
The Default Rule Action List See default_actions below.
DryRun bool
Whether to PreCheck only this request. Value:
GzipEnabled bool
Whether to Enable Gzip Compression, as a Specific File Type on a Compression. Valid Values: True Or False. Default Value: TRUE.
Http2Enabled bool
Whether to Enable HTTP/2 Features. Valid Values: True Or False. Default Value: TRUE.
IdleTimeout int
Specify the Connection Idle Timeout Value: 1 to 60 miao.
ListenerDescription string
Set the IP Address of the Listened Description. Length Is from 2 to 256 Characters.
ListenerPort Changes to this property will trigger replacement. int
The SLB Instance Front-End, and Those of the Ports Used. Value: 1~65535.
ListenerProtocol Changes to this property will trigger replacement. string
Snooping Protocols. Valid Values: HTTP, HTTPS Or QuIC.
LoadBalancerId Changes to this property will trigger replacement. string
The SLB Instance Id.
QuicConfig ListenerQuicConfigArgs
Configuration Associated with the QuIC Listening See quic_config below.
RequestTimeout int
The Specified Request Timeout Time. Value: 1~180 Seconds. Default Value: 60 miao. If the Timeout Time Within the Back-End Server Has Not Answered the SLB Will Give up Waiting, the Client Returns the HTTP 504 Error Code.
SecurityPolicyId string
Security Policy
Status string
The Current IP Address of the Listened State
Tags map[string]string
The tag of the resource
XForwardedForConfig ListenerXForwardedForConfigArgs
xforwardfor Related Attribute Configuration See x_forwarded_for_config below.
accessLogRecordCustomizedHeadersEnabled Boolean

Access Log Whether to Enable Carry Custom Header Field.

Value: True **** Or False * *.

Default Value: False * *.

NOTE: Only Instances outside the Security Group to Access the Log Switch accesslogenabled Open, in Order to Set This Parameter to the **True * *.

accessLogTracingConfig ListenerAccessLogTracingConfig
Xtrace Configuration Information. See access_log_tracing_config below.
aclConfig ListenerAclConfig
The configurations of the access control lists (ACLs). See acl_config below for details. NOTE: Field acl_config has been deprecated from provider version 1.163.0, and it will be removed in the future version. Please use the new resource alicloud.alb.ListenerAclAttachment.,

Deprecated: Field 'acl_config' has been deprecated from provider version 1.163.0 and it will be removed in the future version. Please use the new resource 'alicloud_alb_listener_acl_attachment'.

caCertificates List<ListenerCaCertificate>
The list of certificates. See ca_certificates below.
caEnabled Boolean
Whether to turn on two-way authentication. Value:
certificates ListenerCertificates
The list of certificates. See certificates below.
defaultActions List<ListenerDefaultAction>
The Default Rule Action List See default_actions below.
dryRun Boolean
Whether to PreCheck only this request. Value:
gzipEnabled Boolean
Whether to Enable Gzip Compression, as a Specific File Type on a Compression. Valid Values: True Or False. Default Value: TRUE.
http2Enabled Boolean
Whether to Enable HTTP/2 Features. Valid Values: True Or False. Default Value: TRUE.
idleTimeout Integer
Specify the Connection Idle Timeout Value: 1 to 60 miao.
listenerDescription String
Set the IP Address of the Listened Description. Length Is from 2 to 256 Characters.
listenerPort Changes to this property will trigger replacement. Integer
The SLB Instance Front-End, and Those of the Ports Used. Value: 1~65535.
listenerProtocol Changes to this property will trigger replacement. String
Snooping Protocols. Valid Values: HTTP, HTTPS Or QuIC.
loadBalancerId Changes to this property will trigger replacement. String
The SLB Instance Id.
quicConfig ListenerQuicConfig
Configuration Associated with the QuIC Listening See quic_config below.
requestTimeout Integer
The Specified Request Timeout Time. Value: 1~180 Seconds. Default Value: 60 miao. If the Timeout Time Within the Back-End Server Has Not Answered the SLB Will Give up Waiting, the Client Returns the HTTP 504 Error Code.
securityPolicyId String
Security Policy
status String
The Current IP Address of the Listened State
tags Map<String,String>
The tag of the resource
xForwardedForConfig ListenerXForwardedForConfig
xforwardfor Related Attribute Configuration See x_forwarded_for_config below.
accessLogRecordCustomizedHeadersEnabled boolean

Access Log Whether to Enable Carry Custom Header Field.

Value: True **** Or False * *.

Default Value: False * *.

NOTE: Only Instances outside the Security Group to Access the Log Switch accesslogenabled Open, in Order to Set This Parameter to the **True * *.

accessLogTracingConfig ListenerAccessLogTracingConfig
Xtrace Configuration Information. See access_log_tracing_config below.
aclConfig ListenerAclConfig
The configurations of the access control lists (ACLs). See acl_config below for details. NOTE: Field acl_config has been deprecated from provider version 1.163.0, and it will be removed in the future version. Please use the new resource alicloud.alb.ListenerAclAttachment.,

Deprecated: Field 'acl_config' has been deprecated from provider version 1.163.0 and it will be removed in the future version. Please use the new resource 'alicloud_alb_listener_acl_attachment'.

caCertificates ListenerCaCertificate[]
The list of certificates. See ca_certificates below.
caEnabled boolean
Whether to turn on two-way authentication. Value:
certificates ListenerCertificates
The list of certificates. See certificates below.
defaultActions ListenerDefaultAction[]
The Default Rule Action List See default_actions below.
dryRun boolean
Whether to PreCheck only this request. Value:
gzipEnabled boolean
Whether to Enable Gzip Compression, as a Specific File Type on a Compression. Valid Values: True Or False. Default Value: TRUE.
http2Enabled boolean
Whether to Enable HTTP/2 Features. Valid Values: True Or False. Default Value: TRUE.
idleTimeout number
Specify the Connection Idle Timeout Value: 1 to 60 miao.
listenerDescription string
Set the IP Address of the Listened Description. Length Is from 2 to 256 Characters.
listenerPort Changes to this property will trigger replacement. number
The SLB Instance Front-End, and Those of the Ports Used. Value: 1~65535.
listenerProtocol Changes to this property will trigger replacement. string
Snooping Protocols. Valid Values: HTTP, HTTPS Or QuIC.
loadBalancerId Changes to this property will trigger replacement. string
The SLB Instance Id.
quicConfig ListenerQuicConfig
Configuration Associated with the QuIC Listening See quic_config below.
requestTimeout number
The Specified Request Timeout Time. Value: 1~180 Seconds. Default Value: 60 miao. If the Timeout Time Within the Back-End Server Has Not Answered the SLB Will Give up Waiting, the Client Returns the HTTP 504 Error Code.
securityPolicyId string
Security Policy
status string
The Current IP Address of the Listened State
tags {[key: string]: string}
The tag of the resource
xForwardedForConfig ListenerXForwardedForConfig
xforwardfor Related Attribute Configuration See x_forwarded_for_config below.
access_log_record_customized_headers_enabled bool

Access Log Whether to Enable Carry Custom Header Field.

Value: True **** Or False * *.

Default Value: False * *.

NOTE: Only Instances outside the Security Group to Access the Log Switch accesslogenabled Open, in Order to Set This Parameter to the **True * *.

access_log_tracing_config ListenerAccessLogTracingConfigArgs
Xtrace Configuration Information. See access_log_tracing_config below.
acl_config ListenerAclConfigArgs
The configurations of the access control lists (ACLs). See acl_config below for details. NOTE: Field acl_config has been deprecated from provider version 1.163.0, and it will be removed in the future version. Please use the new resource alicloud.alb.ListenerAclAttachment.,

Deprecated: Field 'acl_config' has been deprecated from provider version 1.163.0 and it will be removed in the future version. Please use the new resource 'alicloud_alb_listener_acl_attachment'.

ca_certificates Sequence[ListenerCaCertificateArgs]
The list of certificates. See ca_certificates below.
ca_enabled bool
Whether to turn on two-way authentication. Value:
certificates ListenerCertificatesArgs
The list of certificates. See certificates below.
default_actions Sequence[ListenerDefaultActionArgs]
The Default Rule Action List See default_actions below.
dry_run bool
Whether to PreCheck only this request. Value:
gzip_enabled bool
Whether to Enable Gzip Compression, as a Specific File Type on a Compression. Valid Values: True Or False. Default Value: TRUE.
http2_enabled bool
Whether to Enable HTTP/2 Features. Valid Values: True Or False. Default Value: TRUE.
idle_timeout int
Specify the Connection Idle Timeout Value: 1 to 60 miao.
listener_description str
Set the IP Address of the Listened Description. Length Is from 2 to 256 Characters.
listener_port Changes to this property will trigger replacement. int
The SLB Instance Front-End, and Those of the Ports Used. Value: 1~65535.
listener_protocol Changes to this property will trigger replacement. str
Snooping Protocols. Valid Values: HTTP, HTTPS Or QuIC.
load_balancer_id Changes to this property will trigger replacement. str
The SLB Instance Id.
quic_config ListenerQuicConfigArgs
Configuration Associated with the QuIC Listening See quic_config below.
request_timeout int
The Specified Request Timeout Time. Value: 1~180 Seconds. Default Value: 60 miao. If the Timeout Time Within the Back-End Server Has Not Answered the SLB Will Give up Waiting, the Client Returns the HTTP 504 Error Code.
security_policy_id str
Security Policy
status str
The Current IP Address of the Listened State
tags Mapping[str, str]
The tag of the resource
x_forwarded_for_config ListenerXForwardedForConfigArgs
xforwardfor Related Attribute Configuration See x_forwarded_for_config below.
accessLogRecordCustomizedHeadersEnabled Boolean

Access Log Whether to Enable Carry Custom Header Field.

Value: True **** Or False * *.

Default Value: False * *.

NOTE: Only Instances outside the Security Group to Access the Log Switch accesslogenabled Open, in Order to Set This Parameter to the **True * *.

accessLogTracingConfig Property Map
Xtrace Configuration Information. See access_log_tracing_config below.
aclConfig Property Map
The configurations of the access control lists (ACLs). See acl_config below for details. NOTE: Field acl_config has been deprecated from provider version 1.163.0, and it will be removed in the future version. Please use the new resource alicloud.alb.ListenerAclAttachment.,

Deprecated: Field 'acl_config' has been deprecated from provider version 1.163.0 and it will be removed in the future version. Please use the new resource 'alicloud_alb_listener_acl_attachment'.

caCertificates List<Property Map>
The list of certificates. See ca_certificates below.
caEnabled Boolean
Whether to turn on two-way authentication. Value:
certificates Property Map
The list of certificates. See certificates below.
defaultActions List<Property Map>
The Default Rule Action List See default_actions below.
dryRun Boolean
Whether to PreCheck only this request. Value:
gzipEnabled Boolean
Whether to Enable Gzip Compression, as a Specific File Type on a Compression. Valid Values: True Or False. Default Value: TRUE.
http2Enabled Boolean
Whether to Enable HTTP/2 Features. Valid Values: True Or False. Default Value: TRUE.
idleTimeout Number
Specify the Connection Idle Timeout Value: 1 to 60 miao.
listenerDescription String
Set the IP Address of the Listened Description. Length Is from 2 to 256 Characters.
listenerPort Changes to this property will trigger replacement. Number
The SLB Instance Front-End, and Those of the Ports Used. Value: 1~65535.
listenerProtocol Changes to this property will trigger replacement. String
Snooping Protocols. Valid Values: HTTP, HTTPS Or QuIC.
loadBalancerId Changes to this property will trigger replacement. String
The SLB Instance Id.
quicConfig Property Map
Configuration Associated with the QuIC Listening See quic_config below.
requestTimeout Number
The Specified Request Timeout Time. Value: 1~180 Seconds. Default Value: 60 miao. If the Timeout Time Within the Back-End Server Has Not Answered the SLB Will Give up Waiting, the Client Returns the HTTP 504 Error Code.
securityPolicyId String
Security Policy
status String
The Current IP Address of the Listened State
tags Map<String>
The tag of the resource
xForwardedForConfig Property Map
xforwardfor Related Attribute Configuration See x_forwarded_for_config below.

Supporting Types

ListenerAccessLogTracingConfig
, ListenerAccessLogTracingConfigArgs

TracingEnabled This property is required. bool

Xtrace Function.

Value: True **** Or False * *.

Default Value: False * *.

NOTE: Only Instances outside the Security Group to Access the Log Switch accesslogenabled Open, in Order to Set This Parameter to the **True * *.

TracingSample int
Xtrace Sampling Rate. Value: 1~10000 **.> tracingenabled **True When Effective.
TracingType string

Xtrace Type Value Is **Zipkin * *.

NOTE: tracingenabled **True When Effective.

TracingEnabled This property is required. bool

Xtrace Function.

Value: True **** Or False * *.

Default Value: False * *.

NOTE: Only Instances outside the Security Group to Access the Log Switch accesslogenabled Open, in Order to Set This Parameter to the **True * *.

TracingSample int
Xtrace Sampling Rate. Value: 1~10000 **.> tracingenabled **True When Effective.
TracingType string

Xtrace Type Value Is **Zipkin * *.

NOTE: tracingenabled **True When Effective.

tracingEnabled This property is required. Boolean

Xtrace Function.

Value: True **** Or False * *.

Default Value: False * *.

NOTE: Only Instances outside the Security Group to Access the Log Switch accesslogenabled Open, in Order to Set This Parameter to the **True * *.

tracingSample Integer
Xtrace Sampling Rate. Value: 1~10000 **.> tracingenabled **True When Effective.
tracingType String

Xtrace Type Value Is **Zipkin * *.

NOTE: tracingenabled **True When Effective.

tracingEnabled This property is required. boolean

Xtrace Function.

Value: True **** Or False * *.

Default Value: False * *.

NOTE: Only Instances outside the Security Group to Access the Log Switch accesslogenabled Open, in Order to Set This Parameter to the **True * *.

tracingSample number
Xtrace Sampling Rate. Value: 1~10000 **.> tracingenabled **True When Effective.
tracingType string

Xtrace Type Value Is **Zipkin * *.

NOTE: tracingenabled **True When Effective.

tracing_enabled This property is required. bool

Xtrace Function.

Value: True **** Or False * *.

Default Value: False * *.

NOTE: Only Instances outside the Security Group to Access the Log Switch accesslogenabled Open, in Order to Set This Parameter to the **True * *.

tracing_sample int
Xtrace Sampling Rate. Value: 1~10000 **.> tracingenabled **True When Effective.
tracing_type str

Xtrace Type Value Is **Zipkin * *.

NOTE: tracingenabled **True When Effective.

tracingEnabled This property is required. Boolean

Xtrace Function.

Value: True **** Or False * *.

Default Value: False * *.

NOTE: Only Instances outside the Security Group to Access the Log Switch accesslogenabled Open, in Order to Set This Parameter to the **True * *.

tracingSample Number
Xtrace Sampling Rate. Value: 1~10000 **.> tracingenabled **True When Effective.
tracingType String

Xtrace Type Value Is **Zipkin * *.

NOTE: tracingenabled **True When Effective.

ListenerAclConfig
, ListenerAclConfigArgs

AclRelations List<Pulumi.AliCloud.Alb.Inputs.ListenerAclConfigAclRelation>
The ACLs that are associated with the listener. See acl_relations below for details.
AclType string
The type of the ACL. Valid values: White Or Black. White: specifies the ACL as a whitelist. Only requests from the IP addresses or CIDR blocks in the ACL are forwarded. Whitelists apply to scenarios where only specific IP addresses are allowed to access an application. Risks may occur if the whitelist is improperly set. After you set a whitelist for an Application Load Balancer (ALB) listener, only requests from IP addresses that are added to the whitelist are distributed by the listener. If the whitelist is enabled without IP addresses specified, the ALB listener does not forward requests. Black: All requests from the IP addresses or CIDR blocks in the ACL are denied. The blacklist is used to prevent specified IP addresses from accessing an application. If the blacklist is enabled but the corresponding ACL does not contain IP addresses, the ALB listener forwards all requests.
AclRelations []ListenerAclConfigAclRelation
The ACLs that are associated with the listener. See acl_relations below for details.
AclType string
The type of the ACL. Valid values: White Or Black. White: specifies the ACL as a whitelist. Only requests from the IP addresses or CIDR blocks in the ACL are forwarded. Whitelists apply to scenarios where only specific IP addresses are allowed to access an application. Risks may occur if the whitelist is improperly set. After you set a whitelist for an Application Load Balancer (ALB) listener, only requests from IP addresses that are added to the whitelist are distributed by the listener. If the whitelist is enabled without IP addresses specified, the ALB listener does not forward requests. Black: All requests from the IP addresses or CIDR blocks in the ACL are denied. The blacklist is used to prevent specified IP addresses from accessing an application. If the blacklist is enabled but the corresponding ACL does not contain IP addresses, the ALB listener forwards all requests.
aclRelations List<ListenerAclConfigAclRelation>
The ACLs that are associated with the listener. See acl_relations below for details.
aclType String
The type of the ACL. Valid values: White Or Black. White: specifies the ACL as a whitelist. Only requests from the IP addresses or CIDR blocks in the ACL are forwarded. Whitelists apply to scenarios where only specific IP addresses are allowed to access an application. Risks may occur if the whitelist is improperly set. After you set a whitelist for an Application Load Balancer (ALB) listener, only requests from IP addresses that are added to the whitelist are distributed by the listener. If the whitelist is enabled without IP addresses specified, the ALB listener does not forward requests. Black: All requests from the IP addresses or CIDR blocks in the ACL are denied. The blacklist is used to prevent specified IP addresses from accessing an application. If the blacklist is enabled but the corresponding ACL does not contain IP addresses, the ALB listener forwards all requests.
aclRelations ListenerAclConfigAclRelation[]
The ACLs that are associated with the listener. See acl_relations below for details.
aclType string
The type of the ACL. Valid values: White Or Black. White: specifies the ACL as a whitelist. Only requests from the IP addresses or CIDR blocks in the ACL are forwarded. Whitelists apply to scenarios where only specific IP addresses are allowed to access an application. Risks may occur if the whitelist is improperly set. After you set a whitelist for an Application Load Balancer (ALB) listener, only requests from IP addresses that are added to the whitelist are distributed by the listener. If the whitelist is enabled without IP addresses specified, the ALB listener does not forward requests. Black: All requests from the IP addresses or CIDR blocks in the ACL are denied. The blacklist is used to prevent specified IP addresses from accessing an application. If the blacklist is enabled but the corresponding ACL does not contain IP addresses, the ALB listener forwards all requests.
acl_relations Sequence[ListenerAclConfigAclRelation]
The ACLs that are associated with the listener. See acl_relations below for details.
acl_type str
The type of the ACL. Valid values: White Or Black. White: specifies the ACL as a whitelist. Only requests from the IP addresses or CIDR blocks in the ACL are forwarded. Whitelists apply to scenarios where only specific IP addresses are allowed to access an application. Risks may occur if the whitelist is improperly set. After you set a whitelist for an Application Load Balancer (ALB) listener, only requests from IP addresses that are added to the whitelist are distributed by the listener. If the whitelist is enabled without IP addresses specified, the ALB listener does not forward requests. Black: All requests from the IP addresses or CIDR blocks in the ACL are denied. The blacklist is used to prevent specified IP addresses from accessing an application. If the blacklist is enabled but the corresponding ACL does not contain IP addresses, the ALB listener forwards all requests.
aclRelations List<Property Map>
The ACLs that are associated with the listener. See acl_relations below for details.
aclType String
The type of the ACL. Valid values: White Or Black. White: specifies the ACL as a whitelist. Only requests from the IP addresses or CIDR blocks in the ACL are forwarded. Whitelists apply to scenarios where only specific IP addresses are allowed to access an application. Risks may occur if the whitelist is improperly set. After you set a whitelist for an Application Load Balancer (ALB) listener, only requests from IP addresses that are added to the whitelist are distributed by the listener. If the whitelist is enabled without IP addresses specified, the ALB listener does not forward requests. Black: All requests from the IP addresses or CIDR blocks in the ACL are denied. The blacklist is used to prevent specified IP addresses from accessing an application. If the blacklist is enabled but the corresponding ACL does not contain IP addresses, the ALB listener forwards all requests.

ListenerAclConfigAclRelation
, ListenerAclConfigAclRelationArgs

AclId string
Snooping Binding of the Access Policy Group ID List.
Status string
The Current IP Address of the Listened State
AclId string
Snooping Binding of the Access Policy Group ID List.
Status string
The Current IP Address of the Listened State
aclId String
Snooping Binding of the Access Policy Group ID List.
status String
The Current IP Address of the Listened State
aclId string
Snooping Binding of the Access Policy Group ID List.
status string
The Current IP Address of the Listened State
acl_id str
Snooping Binding of the Access Policy Group ID List.
status str
The Current IP Address of the Listened State
aclId String
Snooping Binding of the Access Policy Group ID List.
status String
The Current IP Address of the Listened State

ListenerCaCertificate
, ListenerCaCertificateArgs

CertificateId string
The ID of the certificate. Currently, only server certificates are supported.
CertificateId string
The ID of the certificate. Currently, only server certificates are supported.
certificateId String
The ID of the certificate. Currently, only server certificates are supported.
certificateId string
The ID of the certificate. Currently, only server certificates are supported.
certificate_id str
The ID of the certificate. Currently, only server certificates are supported.
certificateId String
The ID of the certificate. Currently, only server certificates are supported.

ListenerCertificates
, ListenerCertificatesArgs

CertificateId string
The ID of the certificate. Currently, only server certificates are supported.
CertificateId string
The ID of the certificate. Currently, only server certificates are supported.
certificateId String
The ID of the certificate. Currently, only server certificates are supported.
certificateId string
The ID of the certificate. Currently, only server certificates are supported.
certificate_id str
The ID of the certificate. Currently, only server certificates are supported.
certificateId String
The ID of the certificate. Currently, only server certificates are supported.

ListenerDefaultAction
, ListenerDefaultActionArgs

Type
This property is required.
Changes to this property will trigger replacement.
string
Action Type
ForwardGroupConfig Pulumi.AliCloud.Alb.Inputs.ListenerDefaultActionForwardGroupConfig
Forwarding Action Configurations See forward_group_config below.
Type
This property is required.
Changes to this property will trigger replacement.
string
Action Type
ForwardGroupConfig ListenerDefaultActionForwardGroupConfig
Forwarding Action Configurations See forward_group_config below.
type
This property is required.
Changes to this property will trigger replacement.
String
Action Type
forwardGroupConfig ListenerDefaultActionForwardGroupConfig
Forwarding Action Configurations See forward_group_config below.
type
This property is required.
Changes to this property will trigger replacement.
string
Action Type
forwardGroupConfig ListenerDefaultActionForwardGroupConfig
Forwarding Action Configurations See forward_group_config below.
type
This property is required.
Changes to this property will trigger replacement.
str
Action Type
forward_group_config ListenerDefaultActionForwardGroupConfig
Forwarding Action Configurations See forward_group_config below.
type
This property is required.
Changes to this property will trigger replacement.
String
Action Type
forwardGroupConfig Property Map
Forwarding Action Configurations See forward_group_config below.

ListenerDefaultActionForwardGroupConfig
, ListenerDefaultActionForwardGroupConfigArgs

ServerGroupTuples This property is required. List<Pulumi.AliCloud.Alb.Inputs.ListenerDefaultActionForwardGroupConfigServerGroupTuple>
The Forwarding Destination Server Group See server_group_tuples below.
ServerGroupTuples This property is required. []ListenerDefaultActionForwardGroupConfigServerGroupTuple
The Forwarding Destination Server Group See server_group_tuples below.
serverGroupTuples This property is required. List<ListenerDefaultActionForwardGroupConfigServerGroupTuple>
The Forwarding Destination Server Group See server_group_tuples below.
serverGroupTuples This property is required. ListenerDefaultActionForwardGroupConfigServerGroupTuple[]
The Forwarding Destination Server Group See server_group_tuples below.
server_group_tuples This property is required. Sequence[ListenerDefaultActionForwardGroupConfigServerGroupTuple]
The Forwarding Destination Server Group See server_group_tuples below.
serverGroupTuples This property is required. List<Property Map>
The Forwarding Destination Server Group See server_group_tuples below.

ListenerDefaultActionForwardGroupConfigServerGroupTuple
, ListenerDefaultActionForwardGroupConfigServerGroupTupleArgs

ServerGroupId This property is required. string
Forwarded to the Destination Server Group ID
ServerGroupId This property is required. string
Forwarded to the Destination Server Group ID
serverGroupId This property is required. String
Forwarded to the Destination Server Group ID
serverGroupId This property is required. string
Forwarded to the Destination Server Group ID
server_group_id This property is required. str
Forwarded to the Destination Server Group ID
serverGroupId This property is required. String
Forwarded to the Destination Server Group ID

ListenerQuicConfig
, ListenerQuicConfigArgs

QuicListenerId string
There Is a Need to Correlate the QuIC Listener ID. The Https Listener, in Effect at the Time. quicupgradeenabled True When Required.
QuicUpgradeEnabled bool
Indicates Whether to Enable the QuIC Upgrade
QuicListenerId string
There Is a Need to Correlate the QuIC Listener ID. The Https Listener, in Effect at the Time. quicupgradeenabled True When Required.
QuicUpgradeEnabled bool
Indicates Whether to Enable the QuIC Upgrade
quicListenerId String
There Is a Need to Correlate the QuIC Listener ID. The Https Listener, in Effect at the Time. quicupgradeenabled True When Required.
quicUpgradeEnabled Boolean
Indicates Whether to Enable the QuIC Upgrade
quicListenerId string
There Is a Need to Correlate the QuIC Listener ID. The Https Listener, in Effect at the Time. quicupgradeenabled True When Required.
quicUpgradeEnabled boolean
Indicates Whether to Enable the QuIC Upgrade
quic_listener_id str
There Is a Need to Correlate the QuIC Listener ID. The Https Listener, in Effect at the Time. quicupgradeenabled True When Required.
quic_upgrade_enabled bool
Indicates Whether to Enable the QuIC Upgrade
quicListenerId String
There Is a Need to Correlate the QuIC Listener ID. The Https Listener, in Effect at the Time. quicupgradeenabled True When Required.
quicUpgradeEnabled Boolean
Indicates Whether to Enable the QuIC Upgrade

ListenerXForwardedForConfig
, ListenerXForwardedForConfigArgs

XForwardedForClientCertClientVerifyAlias string
The Custom Header Field Names Only When xforwardedforclientcertclientverifyenabled Has a Value of True, this Value Will Not Take Effect until.
XForwardedForClientCertClientVerifyEnabled bool
Indicates Whether the X-Forwarded-Clientcert-clientverify Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate to Verify the Results.
XForwardedForClientCertFingerPrintAlias string
The Custom Header Field Names Only When xforwardedforclientcertfingerprintenabled, Which Evaluates to True When the Entry into Force of.
XForwardedForClientCertFingerPrintEnabled bool
Indicates Whether the X-Forwarded-Clientcert-fingerprint Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate Fingerprint Value.
XForwardedForClientCertIssuerDnAlias string
The Custom Header Field Names Only When xforwardedforclientcertsubjectdnenabled, Which Evaluates to True When the Entry into Force of.
XForwardedForClientCertIssuerDnEnabled bool
Indicates Whether the X-Forwarded-Clientcert-issuerdn Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate after the Manifests Are Signed, the Publisher Information.
XForwardedForClientCertSubjectDnAlias string
The Custom Header Field Name,
XForwardedForClientCertSubjectDnEnabled bool
Indicates Whether the X-Forwarded-Clientcert-subjectdn Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate Owner Information.
XForwardedForClientSourceIpsEnabled bool

Whether to use the X-Forwarded-Client-Ip header to obtain the source IP address of the server load balancer instance. Value:

true: Yes.

false (default): No.

Note HTTP, HTTPS, and QUIC listeners support this parameter. The function corresponding to this parameter is not open by default. Please contact the account manager if you need to use it.

XForwardedForClientSourceIpsTrusted string

Specify the trusted proxy IP.

Application-oriented load balancing ALB will traverse the X-Forwarded-For from back to front, and select the first IP that is not in the trusted IP list as the real client IP, which will be used for the source IP speed limit.

XForwardedForClientSrcPortEnabled bool
Indicates Whether the X-Forwarded-Client-Port Header Field Is Used to Obtain Access to Server Load Balancer Instances to the Client, and Those of the Ports.
XForwardedForEnabled bool
Whether to Enable by X-Forwarded-For Header Field Is Used to Obtain the Client IP Addresses.
XForwardedForHostEnabled bool

Whether to enable the X-Forwarded-Host header field to obtain the domain name of the client accessing the Application Load Balancer. Value:

true: Yes.

false (default): No.

HTTP, HTTPS, and QUIC listeners support this parameter.

XForwardedForProcessingMode string

Schema for processing X-Forwarded-For header fields. This value takes effect only when XForwardedForEnabled is true. Value:

append (default): append.

remove: Delete.

Configure append to add the last hop IP address to the X-Forwarded-For header field before sending the request to the backend service.

Configure remove to delete the X-Forwarded-For header before the request is sent to the backend service, regardless of whether the request carries X-Forwarded-For header fields.

HTTP and HTTPS listeners support this parameter.

XForwardedForProtoEnabled bool
Indicates Whether the X-Forwarded-Proto Header Field Is Used to Obtain the Server Load Balancer Instance Snooping Protocols.
XForwardedForSlbIdEnabled bool
Indicates Whether the SLB-ID Header Field Is Used to Obtain the Load Balancing Instance Id
XForwardedForSlbPortEnabled bool
Indicates Whether the X-Forwarded-Port Header Field Is Used to Obtain the Server Load Balancer Instance Listening Port
XForwardedForClientCertClientVerifyAlias string
The Custom Header Field Names Only When xforwardedforclientcertclientverifyenabled Has a Value of True, this Value Will Not Take Effect until.
XForwardedForClientCertClientVerifyEnabled bool
Indicates Whether the X-Forwarded-Clientcert-clientverify Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate to Verify the Results.
XForwardedForClientCertFingerPrintAlias string
The Custom Header Field Names Only When xforwardedforclientcertfingerprintenabled, Which Evaluates to True When the Entry into Force of.
XForwardedForClientCertFingerPrintEnabled bool
Indicates Whether the X-Forwarded-Clientcert-fingerprint Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate Fingerprint Value.
XForwardedForClientCertIssuerDnAlias string
The Custom Header Field Names Only When xforwardedforclientcertsubjectdnenabled, Which Evaluates to True When the Entry into Force of.
XForwardedForClientCertIssuerDnEnabled bool
Indicates Whether the X-Forwarded-Clientcert-issuerdn Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate after the Manifests Are Signed, the Publisher Information.
XForwardedForClientCertSubjectDnAlias string
The Custom Header Field Name,
XForwardedForClientCertSubjectDnEnabled bool
Indicates Whether the X-Forwarded-Clientcert-subjectdn Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate Owner Information.
XForwardedForClientSourceIpsEnabled bool

Whether to use the X-Forwarded-Client-Ip header to obtain the source IP address of the server load balancer instance. Value:

true: Yes.

false (default): No.

Note HTTP, HTTPS, and QUIC listeners support this parameter. The function corresponding to this parameter is not open by default. Please contact the account manager if you need to use it.

XForwardedForClientSourceIpsTrusted string

Specify the trusted proxy IP.

Application-oriented load balancing ALB will traverse the X-Forwarded-For from back to front, and select the first IP that is not in the trusted IP list as the real client IP, which will be used for the source IP speed limit.

XForwardedForClientSrcPortEnabled bool
Indicates Whether the X-Forwarded-Client-Port Header Field Is Used to Obtain Access to Server Load Balancer Instances to the Client, and Those of the Ports.
XForwardedForEnabled bool
Whether to Enable by X-Forwarded-For Header Field Is Used to Obtain the Client IP Addresses.
XForwardedForHostEnabled bool

Whether to enable the X-Forwarded-Host header field to obtain the domain name of the client accessing the Application Load Balancer. Value:

true: Yes.

false (default): No.

HTTP, HTTPS, and QUIC listeners support this parameter.

XForwardedForProcessingMode string

Schema for processing X-Forwarded-For header fields. This value takes effect only when XForwardedForEnabled is true. Value:

append (default): append.

remove: Delete.

Configure append to add the last hop IP address to the X-Forwarded-For header field before sending the request to the backend service.

Configure remove to delete the X-Forwarded-For header before the request is sent to the backend service, regardless of whether the request carries X-Forwarded-For header fields.

HTTP and HTTPS listeners support this parameter.

XForwardedForProtoEnabled bool
Indicates Whether the X-Forwarded-Proto Header Field Is Used to Obtain the Server Load Balancer Instance Snooping Protocols.
XForwardedForSlbIdEnabled bool
Indicates Whether the SLB-ID Header Field Is Used to Obtain the Load Balancing Instance Id
XForwardedForSlbPortEnabled bool
Indicates Whether the X-Forwarded-Port Header Field Is Used to Obtain the Server Load Balancer Instance Listening Port
xForwardedForClientCertClientVerifyAlias String
The Custom Header Field Names Only When xforwardedforclientcertclientverifyenabled Has a Value of True, this Value Will Not Take Effect until.
xForwardedForClientCertClientVerifyEnabled Boolean
Indicates Whether the X-Forwarded-Clientcert-clientverify Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate to Verify the Results.
xForwardedForClientCertFingerPrintAlias String
The Custom Header Field Names Only When xforwardedforclientcertfingerprintenabled, Which Evaluates to True When the Entry into Force of.
xForwardedForClientCertFingerPrintEnabled Boolean
Indicates Whether the X-Forwarded-Clientcert-fingerprint Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate Fingerprint Value.
xForwardedForClientCertIssuerDnAlias String
The Custom Header Field Names Only When xforwardedforclientcertsubjectdnenabled, Which Evaluates to True When the Entry into Force of.
xForwardedForClientCertIssuerDnEnabled Boolean
Indicates Whether the X-Forwarded-Clientcert-issuerdn Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate after the Manifests Are Signed, the Publisher Information.
xForwardedForClientCertSubjectDnAlias String
The Custom Header Field Name,
xForwardedForClientCertSubjectDnEnabled Boolean
Indicates Whether the X-Forwarded-Clientcert-subjectdn Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate Owner Information.
xForwardedForClientSourceIpsEnabled Boolean

Whether to use the X-Forwarded-Client-Ip header to obtain the source IP address of the server load balancer instance. Value:

true: Yes.

false (default): No.

Note HTTP, HTTPS, and QUIC listeners support this parameter. The function corresponding to this parameter is not open by default. Please contact the account manager if you need to use it.

xForwardedForClientSourceIpsTrusted String

Specify the trusted proxy IP.

Application-oriented load balancing ALB will traverse the X-Forwarded-For from back to front, and select the first IP that is not in the trusted IP list as the real client IP, which will be used for the source IP speed limit.

xForwardedForClientSrcPortEnabled Boolean
Indicates Whether the X-Forwarded-Client-Port Header Field Is Used to Obtain Access to Server Load Balancer Instances to the Client, and Those of the Ports.
xForwardedForEnabled Boolean
Whether to Enable by X-Forwarded-For Header Field Is Used to Obtain the Client IP Addresses.
xForwardedForHostEnabled Boolean

Whether to enable the X-Forwarded-Host header field to obtain the domain name of the client accessing the Application Load Balancer. Value:

true: Yes.

false (default): No.

HTTP, HTTPS, and QUIC listeners support this parameter.

xForwardedForProcessingMode String

Schema for processing X-Forwarded-For header fields. This value takes effect only when XForwardedForEnabled is true. Value:

append (default): append.

remove: Delete.

Configure append to add the last hop IP address to the X-Forwarded-For header field before sending the request to the backend service.

Configure remove to delete the X-Forwarded-For header before the request is sent to the backend service, regardless of whether the request carries X-Forwarded-For header fields.

HTTP and HTTPS listeners support this parameter.

xForwardedForProtoEnabled Boolean
Indicates Whether the X-Forwarded-Proto Header Field Is Used to Obtain the Server Load Balancer Instance Snooping Protocols.
xForwardedForSlbIdEnabled Boolean
Indicates Whether the SLB-ID Header Field Is Used to Obtain the Load Balancing Instance Id
xForwardedForSlbPortEnabled Boolean
Indicates Whether the X-Forwarded-Port Header Field Is Used to Obtain the Server Load Balancer Instance Listening Port
xForwardedForClientCertClientVerifyAlias string
The Custom Header Field Names Only When xforwardedforclientcertclientverifyenabled Has a Value of True, this Value Will Not Take Effect until.
xForwardedForClientCertClientVerifyEnabled boolean
Indicates Whether the X-Forwarded-Clientcert-clientverify Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate to Verify the Results.
xForwardedForClientCertFingerPrintAlias string
The Custom Header Field Names Only When xforwardedforclientcertfingerprintenabled, Which Evaluates to True When the Entry into Force of.
xForwardedForClientCertFingerPrintEnabled boolean
Indicates Whether the X-Forwarded-Clientcert-fingerprint Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate Fingerprint Value.
xForwardedForClientCertIssuerDnAlias string
The Custom Header Field Names Only When xforwardedforclientcertsubjectdnenabled, Which Evaluates to True When the Entry into Force of.
xForwardedForClientCertIssuerDnEnabled boolean
Indicates Whether the X-Forwarded-Clientcert-issuerdn Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate after the Manifests Are Signed, the Publisher Information.
xForwardedForClientCertSubjectDnAlias string
The Custom Header Field Name,
xForwardedForClientCertSubjectDnEnabled boolean
Indicates Whether the X-Forwarded-Clientcert-subjectdn Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate Owner Information.
xForwardedForClientSourceIpsEnabled boolean

Whether to use the X-Forwarded-Client-Ip header to obtain the source IP address of the server load balancer instance. Value:

true: Yes.

false (default): No.

Note HTTP, HTTPS, and QUIC listeners support this parameter. The function corresponding to this parameter is not open by default. Please contact the account manager if you need to use it.

xForwardedForClientSourceIpsTrusted string

Specify the trusted proxy IP.

Application-oriented load balancing ALB will traverse the X-Forwarded-For from back to front, and select the first IP that is not in the trusted IP list as the real client IP, which will be used for the source IP speed limit.

xForwardedForClientSrcPortEnabled boolean
Indicates Whether the X-Forwarded-Client-Port Header Field Is Used to Obtain Access to Server Load Balancer Instances to the Client, and Those of the Ports.
xForwardedForEnabled boolean
Whether to Enable by X-Forwarded-For Header Field Is Used to Obtain the Client IP Addresses.
xForwardedForHostEnabled boolean

Whether to enable the X-Forwarded-Host header field to obtain the domain name of the client accessing the Application Load Balancer. Value:

true: Yes.

false (default): No.

HTTP, HTTPS, and QUIC listeners support this parameter.

xForwardedForProcessingMode string

Schema for processing X-Forwarded-For header fields. This value takes effect only when XForwardedForEnabled is true. Value:

append (default): append.

remove: Delete.

Configure append to add the last hop IP address to the X-Forwarded-For header field before sending the request to the backend service.

Configure remove to delete the X-Forwarded-For header before the request is sent to the backend service, regardless of whether the request carries X-Forwarded-For header fields.

HTTP and HTTPS listeners support this parameter.

xForwardedForProtoEnabled boolean
Indicates Whether the X-Forwarded-Proto Header Field Is Used to Obtain the Server Load Balancer Instance Snooping Protocols.
xForwardedForSlbIdEnabled boolean
Indicates Whether the SLB-ID Header Field Is Used to Obtain the Load Balancing Instance Id
xForwardedForSlbPortEnabled boolean
Indicates Whether the X-Forwarded-Port Header Field Is Used to Obtain the Server Load Balancer Instance Listening Port
x_forwarded_for_client_cert_client_verify_alias str
The Custom Header Field Names Only When xforwardedforclientcertclientverifyenabled Has a Value of True, this Value Will Not Take Effect until.
x_forwarded_for_client_cert_client_verify_enabled bool
Indicates Whether the X-Forwarded-Clientcert-clientverify Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate to Verify the Results.
x_forwarded_for_client_cert_finger_print_alias str
The Custom Header Field Names Only When xforwardedforclientcertfingerprintenabled, Which Evaluates to True When the Entry into Force of.
x_forwarded_for_client_cert_finger_print_enabled bool
Indicates Whether the X-Forwarded-Clientcert-fingerprint Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate Fingerprint Value.
x_forwarded_for_client_cert_issuer_dn_alias str
The Custom Header Field Names Only When xforwardedforclientcertsubjectdnenabled, Which Evaluates to True When the Entry into Force of.
x_forwarded_for_client_cert_issuer_dn_enabled bool
Indicates Whether the X-Forwarded-Clientcert-issuerdn Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate after the Manifests Are Signed, the Publisher Information.
x_forwarded_for_client_cert_subject_dn_alias str
The Custom Header Field Name,
x_forwarded_for_client_cert_subject_dn_enabled bool
Indicates Whether the X-Forwarded-Clientcert-subjectdn Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate Owner Information.
x_forwarded_for_client_source_ips_enabled bool

Whether to use the X-Forwarded-Client-Ip header to obtain the source IP address of the server load balancer instance. Value:

true: Yes.

false (default): No.

Note HTTP, HTTPS, and QUIC listeners support this parameter. The function corresponding to this parameter is not open by default. Please contact the account manager if you need to use it.

x_forwarded_for_client_source_ips_trusted str

Specify the trusted proxy IP.

Application-oriented load balancing ALB will traverse the X-Forwarded-For from back to front, and select the first IP that is not in the trusted IP list as the real client IP, which will be used for the source IP speed limit.

x_forwarded_for_client_src_port_enabled bool
Indicates Whether the X-Forwarded-Client-Port Header Field Is Used to Obtain Access to Server Load Balancer Instances to the Client, and Those of the Ports.
x_forwarded_for_enabled bool
Whether to Enable by X-Forwarded-For Header Field Is Used to Obtain the Client IP Addresses.
x_forwarded_for_host_enabled bool

Whether to enable the X-Forwarded-Host header field to obtain the domain name of the client accessing the Application Load Balancer. Value:

true: Yes.

false (default): No.

HTTP, HTTPS, and QUIC listeners support this parameter.

x_forwarded_for_processing_mode str

Schema for processing X-Forwarded-For header fields. This value takes effect only when XForwardedForEnabled is true. Value:

append (default): append.

remove: Delete.

Configure append to add the last hop IP address to the X-Forwarded-For header field before sending the request to the backend service.

Configure remove to delete the X-Forwarded-For header before the request is sent to the backend service, regardless of whether the request carries X-Forwarded-For header fields.

HTTP and HTTPS listeners support this parameter.

x_forwarded_for_proto_enabled bool
Indicates Whether the X-Forwarded-Proto Header Field Is Used to Obtain the Server Load Balancer Instance Snooping Protocols.
x_forwarded_for_slb_id_enabled bool
Indicates Whether the SLB-ID Header Field Is Used to Obtain the Load Balancing Instance Id
x_forwarded_for_slb_port_enabled bool
Indicates Whether the X-Forwarded-Port Header Field Is Used to Obtain the Server Load Balancer Instance Listening Port
xForwardedForClientCertClientVerifyAlias String
The Custom Header Field Names Only When xforwardedforclientcertclientverifyenabled Has a Value of True, this Value Will Not Take Effect until.
xForwardedForClientCertClientVerifyEnabled Boolean
Indicates Whether the X-Forwarded-Clientcert-clientverify Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate to Verify the Results.
xForwardedForClientCertFingerPrintAlias String
The Custom Header Field Names Only When xforwardedforclientcertfingerprintenabled, Which Evaluates to True When the Entry into Force of.
xForwardedForClientCertFingerPrintEnabled Boolean
Indicates Whether the X-Forwarded-Clientcert-fingerprint Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate Fingerprint Value.
xForwardedForClientCertIssuerDnAlias String
The Custom Header Field Names Only When xforwardedforclientcertsubjectdnenabled, Which Evaluates to True When the Entry into Force of.
xForwardedForClientCertIssuerDnEnabled Boolean
Indicates Whether the X-Forwarded-Clientcert-issuerdn Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate after the Manifests Are Signed, the Publisher Information.
xForwardedForClientCertSubjectDnAlias String
The Custom Header Field Name,
xForwardedForClientCertSubjectDnEnabled Boolean
Indicates Whether the X-Forwarded-Clientcert-subjectdn Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate Owner Information.
xForwardedForClientSourceIpsEnabled Boolean

Whether to use the X-Forwarded-Client-Ip header to obtain the source IP address of the server load balancer instance. Value:

true: Yes.

false (default): No.

Note HTTP, HTTPS, and QUIC listeners support this parameter. The function corresponding to this parameter is not open by default. Please contact the account manager if you need to use it.

xForwardedForClientSourceIpsTrusted String

Specify the trusted proxy IP.

Application-oriented load balancing ALB will traverse the X-Forwarded-For from back to front, and select the first IP that is not in the trusted IP list as the real client IP, which will be used for the source IP speed limit.

xForwardedForClientSrcPortEnabled Boolean
Indicates Whether the X-Forwarded-Client-Port Header Field Is Used to Obtain Access to Server Load Balancer Instances to the Client, and Those of the Ports.
xForwardedForEnabled Boolean
Whether to Enable by X-Forwarded-For Header Field Is Used to Obtain the Client IP Addresses.
xForwardedForHostEnabled Boolean

Whether to enable the X-Forwarded-Host header field to obtain the domain name of the client accessing the Application Load Balancer. Value:

true: Yes.

false (default): No.

HTTP, HTTPS, and QUIC listeners support this parameter.

xForwardedForProcessingMode String

Schema for processing X-Forwarded-For header fields. This value takes effect only when XForwardedForEnabled is true. Value:

append (default): append.

remove: Delete.

Configure append to add the last hop IP address to the X-Forwarded-For header field before sending the request to the backend service.

Configure remove to delete the X-Forwarded-For header before the request is sent to the backend service, regardless of whether the request carries X-Forwarded-For header fields.

HTTP and HTTPS listeners support this parameter.

xForwardedForProtoEnabled Boolean
Indicates Whether the X-Forwarded-Proto Header Field Is Used to Obtain the Server Load Balancer Instance Snooping Protocols.
xForwardedForSlbIdEnabled Boolean
Indicates Whether the SLB-ID Header Field Is Used to Obtain the Load Balancing Instance Id
xForwardedForSlbPortEnabled Boolean
Indicates Whether the X-Forwarded-Port Header Field Is Used to Obtain the Server Load Balancer Instance Listening Port

Import

Application Load Balancer (ALB) Listener can be imported using the id, e.g.

$ pulumi import alicloud:alb/listener:Listener example <id>
Copy

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

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud