alicloud.alb.Listener
Explore with Pulumi AI
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,
listener_port: Optional[int] = None,
load_balancer_id: Optional[str] = None,
listener_protocol: Optional[str] = None,
default_actions: Optional[Sequence[ListenerDefaultActionArgs]] = None,
certificates: Optional[ListenerCertificatesArgs] = 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,
access_log_record_customized_headers_enabled: Optional[bool] = None,
acl_config: Optional[ListenerAclConfigArgs] = 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, Any]] = 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 string
- The unique name of the resource.
- args ListenerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ListenerArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ListenerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ListenerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ListenerArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var listenerResource = new AliCloud.Alb.Listener("listenerResource", new()
{
ListenerPort = 0,
LoadBalancerId = "string",
ListenerProtocol = "string",
DefaultActions = new[]
{
new AliCloud.Alb.Inputs.ListenerDefaultActionArgs
{
ForwardGroupConfig = new AliCloud.Alb.Inputs.ListenerDefaultActionForwardGroupConfigArgs
{
ServerGroupTuples = new[]
{
new AliCloud.Alb.Inputs.ListenerDefaultActionForwardGroupConfigServerGroupTupleArgs
{
ServerGroupId = "string",
},
},
},
Type = "string",
},
},
Certificates = new AliCloud.Alb.Inputs.ListenerCertificatesArgs
{
CertificateId = "string",
},
DryRun = false,
GzipEnabled = false,
Http2Enabled = false,
IdleTimeout = 0,
ListenerDescription = "string",
AccessLogRecordCustomizedHeadersEnabled = false,
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", "any" },
},
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,
XForwardedForProtoEnabled = false,
XForwardedForSlbIdEnabled = false,
XForwardedForSlbPortEnabled = false,
},
});
example, err := alb.NewListener(ctx, "listenerResource", &alb.ListenerArgs{
ListenerPort: pulumi.Int(0),
LoadBalancerId: pulumi.String("string"),
ListenerProtocol: pulumi.String("string"),
DefaultActions: alb.ListenerDefaultActionArray{
&alb.ListenerDefaultActionArgs{
ForwardGroupConfig: &alb.ListenerDefaultActionForwardGroupConfigArgs{
ServerGroupTuples: alb.ListenerDefaultActionForwardGroupConfigServerGroupTupleArray{
&alb.ListenerDefaultActionForwardGroupConfigServerGroupTupleArgs{
ServerGroupId: pulumi.String("string"),
},
},
},
Type: pulumi.String("string"),
},
},
Certificates: &alb.ListenerCertificatesArgs{
CertificateId: pulumi.String("string"),
},
DryRun: pulumi.Bool(false),
GzipEnabled: pulumi.Bool(false),
Http2Enabled: pulumi.Bool(false),
IdleTimeout: pulumi.Int(0),
ListenerDescription: pulumi.String("string"),
AccessLogRecordCustomizedHeadersEnabled: pulumi.Bool(false),
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.Map{
"string": pulumi.Any("any"),
},
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),
XForwardedForProtoEnabled: pulumi.Bool(false),
XForwardedForSlbIdEnabled: pulumi.Bool(false),
XForwardedForSlbPortEnabled: pulumi.Bool(false),
},
})
var listenerResource = new Listener("listenerResource", ListenerArgs.builder()
.listenerPort(0)
.loadBalancerId("string")
.listenerProtocol("string")
.defaultActions(ListenerDefaultActionArgs.builder()
.forwardGroupConfig(ListenerDefaultActionForwardGroupConfigArgs.builder()
.serverGroupTuples(ListenerDefaultActionForwardGroupConfigServerGroupTupleArgs.builder()
.serverGroupId("string")
.build())
.build())
.type("string")
.build())
.certificates(ListenerCertificatesArgs.builder()
.certificateId("string")
.build())
.dryRun(false)
.gzipEnabled(false)
.http2Enabled(false)
.idleTimeout(0)
.listenerDescription("string")
.accessLogRecordCustomizedHeadersEnabled(false)
.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", "any"))
.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)
.xForwardedForProtoEnabled(false)
.xForwardedForSlbIdEnabled(false)
.xForwardedForSlbPortEnabled(false)
.build())
.build());
listener_resource = alicloud.alb.Listener("listenerResource",
listener_port=0,
load_balancer_id="string",
listener_protocol="string",
default_actions=[alicloud.alb.ListenerDefaultActionArgs(
forward_group_config=alicloud.alb.ListenerDefaultActionForwardGroupConfigArgs(
server_group_tuples=[alicloud.alb.ListenerDefaultActionForwardGroupConfigServerGroupTupleArgs(
server_group_id="string",
)],
),
type="string",
)],
certificates=alicloud.alb.ListenerCertificatesArgs(
certificate_id="string",
),
dry_run=False,
gzip_enabled=False,
http2_enabled=False,
idle_timeout=0,
listener_description="string",
access_log_record_customized_headers_enabled=False,
access_log_tracing_config=alicloud.alb.ListenerAccessLogTracingConfigArgs(
tracing_enabled=False,
tracing_sample=0,
tracing_type="string",
),
quic_config=alicloud.alb.ListenerQuicConfigArgs(
quic_listener_id="string",
quic_upgrade_enabled=False,
),
request_timeout=0,
security_policy_id="string",
status="string",
tags={
"string": "any",
},
x_forwarded_for_config=alicloud.alb.ListenerXForwardedForConfigArgs(
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_proto_enabled=False,
x_forwarded_for_slb_id_enabled=False,
x_forwarded_for_slb_port_enabled=False,
))
const listenerResource = new alicloud.alb.Listener("listenerResource", {
listenerPort: 0,
loadBalancerId: "string",
listenerProtocol: "string",
defaultActions: [{
forwardGroupConfig: {
serverGroupTuples: [{
serverGroupId: "string",
}],
},
type: "string",
}],
certificates: {
certificateId: "string",
},
dryRun: false,
gzipEnabled: false,
http2Enabled: false,
idleTimeout: 0,
listenerDescription: "string",
accessLogRecordCustomizedHeadersEnabled: false,
accessLogTracingConfig: {
tracingEnabled: false,
tracingSample: 0,
tracingType: "string",
},
quicConfig: {
quicListenerId: "string",
quicUpgradeEnabled: false,
},
requestTimeout: 0,
securityPolicyId: "string",
status: "string",
tags: {
string: "any",
},
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,
xForwardedForProtoEnabled: false,
xForwardedForSlbIdEnabled: false,
xForwardedForSlbPortEnabled: false,
},
});
type: alicloud:alb:Listener
properties:
accessLogRecordCustomizedHeadersEnabled: false
accessLogTracingConfig:
tracingEnabled: false
tracingSample: 0
tracingType: string
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: any
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
xForwardedForProtoEnabled: false
xForwardedForSlbIdEnabled: false
xForwardedForSlbPortEnabled: false
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
The Listener resource accepts the following input properties:
- Listener
Port int - The ALB Instance Front-End, and Those of the Ports Used. Value:
1
to65535
. - Listener
Protocol string - Snooping Protocols. Valid Values:
HTTP
,HTTPS
OrQUIC
. - Load
Balancer stringId - The ALB Instance Id.
- Access
Log boolRecord Customized Headers Enabled Indicates whether the access log has a custom header field. Valid values: true and 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 Pulumi.Tracing Config Ali Cloud. Alb. Inputs. Listener Access Log Tracing Config - Xtrace Configuration Information. See
access_log_tracing_config
below for details. - Acl
Config Pulumi.Ali Cloud. Alb. Inputs. Listener Acl Config - The configurations of the access control lists (ACLs). See
acl_config
below for details. NOTE: Fieldacl_config
has been deprecated from provider version 1.163.0, and it will be removed in the future version. Please use the new resourcealicloud.alb.ListenerAclAttachment
., - Certificates
Pulumi.
Ali Cloud. Alb. Inputs. Listener Certificates - The default certificate of the Listener. See
certificates
below for details. NOTE: Whenlistener_protocol
isHTTPS
, The default certificate must be set one。 - Default
Actions List<Pulumi.Ali Cloud. Alb. Inputs. Listener Default Action> - The Default Rule Action List. See
default_actions
below for details. - Dry
Run bool - The dry run.
- Gzip
Enabled bool - Whether to Enable Gzip Compression, as a Specific File Type on a Compression. Valid values:
false
,true
. Default Value:true
. . - Http2Enabled bool
Whether to Enable HTTP/2 Features. Valid Values:
True
OrFalse
. Default Value:True
.NOTE: The attribute is valid when the attribute
listener_protocol
isHTTPS
.- Idle
Timeout int - Specify the Connection Idle Timeout Value:
1
to60
. Unit: Seconds. - Listener
Description string - The description of the listener. The description must be 2 to 256 characters in length. The name can contain only the characters in the following string:
/^([^\x00-\xff]|[\w.,;/@-]){2,256}$/
. - Quic
Config Pulumi.Ali Cloud. Alb. Inputs. Listener Quic Config - Configuration Associated with the QuIC Listening. See
quic_config
below for details. - Request
Timeout int - The Specified Request Timeout Time. Value:
1
to180
. Unit: Seconds. Default Value:60
. If the Timeout Time Within the Back-End Server Has Not Answered the ALB Will Give up Waiting, the Client Returns the HTTP 504 Error Code. - Security
Policy stringId Security Policy.
NOTE: The attribute is valid when the attribute
listener_protocol
isHTTPS
.- Status string
- The state of the listener. Valid Values:
Running
OrStopped
. Valid values:Running
: The listener is running.Stopped
: The listener is stopped. - Dictionary<string, object>
- A mapping of tags to assign to the resource.
- XForwarded
For Pulumi.Config Ali Cloud. Alb. Inputs. Listener XForwarded For Config - The
x_forward_for
Related Attribute Configuration. Seex_forwarded_for_config
below for details. NOTE: The attribute is valid when the attributelistener_protocol
isHTTPS
.
- Listener
Port int - The ALB Instance Front-End, and Those of the Ports Used. Value:
1
to65535
. - Listener
Protocol string - Snooping Protocols. Valid Values:
HTTP
,HTTPS
OrQUIC
. - Load
Balancer stringId - The ALB Instance Id.
- Access
Log boolRecord Customized Headers Enabled Indicates whether the access log has a custom header field. Valid values: true and 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 ListenerTracing Config Access Log Tracing Config Args - Xtrace Configuration Information. See
access_log_tracing_config
below for details. - Acl
Config ListenerAcl Config Args - The configurations of the access control lists (ACLs). See
acl_config
below for details. NOTE: Fieldacl_config
has been deprecated from provider version 1.163.0, and it will be removed in the future version. Please use the new resourcealicloud.alb.ListenerAclAttachment
., - Certificates
Listener
Certificates Args - The default certificate of the Listener. See
certificates
below for details. NOTE: Whenlistener_protocol
isHTTPS
, The default certificate must be set one。 - Default
Actions []ListenerDefault Action Args - The Default Rule Action List. See
default_actions
below for details. - Dry
Run bool - The dry run.
- Gzip
Enabled bool - Whether to Enable Gzip Compression, as a Specific File Type on a Compression. Valid values:
false
,true
. Default Value:true
. . - Http2Enabled bool
Whether to Enable HTTP/2 Features. Valid Values:
True
OrFalse
. Default Value:True
.NOTE: The attribute is valid when the attribute
listener_protocol
isHTTPS
.- Idle
Timeout int - Specify the Connection Idle Timeout Value:
1
to60
. Unit: Seconds. - Listener
Description string - The description of the listener. The description must be 2 to 256 characters in length. The name can contain only the characters in the following string:
/^([^\x00-\xff]|[\w.,;/@-]){2,256}$/
. - Quic
Config ListenerQuic Config Args - Configuration Associated with the QuIC Listening. See
quic_config
below for details. - Request
Timeout int - The Specified Request Timeout Time. Value:
1
to180
. Unit: Seconds. Default Value:60
. If the Timeout Time Within the Back-End Server Has Not Answered the ALB Will Give up Waiting, the Client Returns the HTTP 504 Error Code. - Security
Policy stringId Security Policy.
NOTE: The attribute is valid when the attribute
listener_protocol
isHTTPS
.- Status string
- The state of the listener. Valid Values:
Running
OrStopped
. Valid values:Running
: The listener is running.Stopped
: The listener is stopped. - map[string]interface{}
- A mapping of tags to assign to the resource.
- XForwarded
For ListenerConfig XForwarded For Config Args - The
x_forward_for
Related Attribute Configuration. Seex_forwarded_for_config
below for details. NOTE: The attribute is valid when the attributelistener_protocol
isHTTPS
.
- listener
Port Integer - The ALB Instance Front-End, and Those of the Ports Used. Value:
1
to65535
. - listener
Protocol String - Snooping Protocols. Valid Values:
HTTP
,HTTPS
OrQUIC
. - load
Balancer StringId - The ALB Instance Id.
- access
Log BooleanRecord Customized Headers Enabled Indicates whether the access log has a custom header field. Valid values: true and 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 ListenerTracing Config Access Log Tracing Config - Xtrace Configuration Information. See
access_log_tracing_config
below for details. - acl
Config ListenerAcl Config - The configurations of the access control lists (ACLs). See
acl_config
below for details. NOTE: Fieldacl_config
has been deprecated from provider version 1.163.0, and it will be removed in the future version. Please use the new resourcealicloud.alb.ListenerAclAttachment
., - certificates
Listener
Certificates - The default certificate of the Listener. See
certificates
below for details. NOTE: Whenlistener_protocol
isHTTPS
, The default certificate must be set one。 - default
Actions List<ListenerDefault Action> - The Default Rule Action List. See
default_actions
below for details. - dry
Run Boolean - The dry run.
- gzip
Enabled Boolean - Whether to Enable Gzip Compression, as a Specific File Type on a Compression. Valid values:
false
,true
. Default Value:true
. . - http2Enabled Boolean
Whether to Enable HTTP/2 Features. Valid Values:
True
OrFalse
. Default Value:True
.NOTE: The attribute is valid when the attribute
listener_protocol
isHTTPS
.- idle
Timeout Integer - Specify the Connection Idle Timeout Value:
1
to60
. Unit: Seconds. - listener
Description String - The description of the listener. The description must be 2 to 256 characters in length. The name can contain only the characters in the following string:
/^([^\x00-\xff]|[\w.,;/@-]){2,256}$/
. - quic
Config ListenerQuic Config - Configuration Associated with the QuIC Listening. See
quic_config
below for details. - request
Timeout Integer - The Specified Request Timeout Time. Value:
1
to180
. Unit: Seconds. Default Value:60
. If the Timeout Time Within the Back-End Server Has Not Answered the ALB Will Give up Waiting, the Client Returns the HTTP 504 Error Code. - security
Policy StringId Security Policy.
NOTE: The attribute is valid when the attribute
listener_protocol
isHTTPS
.- status String
- The state of the listener. Valid Values:
Running
OrStopped
. Valid values:Running
: The listener is running.Stopped
: The listener is stopped. - Map<String,Object>
- A mapping of tags to assign to the resource.
- x
Forwarded ListenerFor Config XForwarded For Config - The
x_forward_for
Related Attribute Configuration. Seex_forwarded_for_config
below for details. NOTE: The attribute is valid when the attributelistener_protocol
isHTTPS
.
- listener
Port number - The ALB Instance Front-End, and Those of the Ports Used. Value:
1
to65535
. - listener
Protocol string - Snooping Protocols. Valid Values:
HTTP
,HTTPS
OrQUIC
. - load
Balancer stringId - The ALB Instance Id.
- access
Log booleanRecord Customized Headers Enabled Indicates whether the access log has a custom header field. Valid values: true and 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 ListenerTracing Config Access Log Tracing Config - Xtrace Configuration Information. See
access_log_tracing_config
below for details. - acl
Config ListenerAcl Config - The configurations of the access control lists (ACLs). See
acl_config
below for details. NOTE: Fieldacl_config
has been deprecated from provider version 1.163.0, and it will be removed in the future version. Please use the new resourcealicloud.alb.ListenerAclAttachment
., - certificates
Listener
Certificates - The default certificate of the Listener. See
certificates
below for details. NOTE: Whenlistener_protocol
isHTTPS
, The default certificate must be set one。 - default
Actions ListenerDefault Action[] - The Default Rule Action List. See
default_actions
below for details. - dry
Run boolean - The dry run.
- gzip
Enabled boolean - Whether to Enable Gzip Compression, as a Specific File Type on a Compression. Valid values:
false
,true
. Default Value:true
. . - http2Enabled boolean
Whether to Enable HTTP/2 Features. Valid Values:
True
OrFalse
. Default Value:True
.NOTE: The attribute is valid when the attribute
listener_protocol
isHTTPS
.- idle
Timeout number - Specify the Connection Idle Timeout Value:
1
to60
. Unit: Seconds. - listener
Description string - The description of the listener. The description must be 2 to 256 characters in length. The name can contain only the characters in the following string:
/^([^\x00-\xff]|[\w.,;/@-]){2,256}$/
. - quic
Config ListenerQuic Config - Configuration Associated with the QuIC Listening. See
quic_config
below for details. - request
Timeout number - The Specified Request Timeout Time. Value:
1
to180
. Unit: Seconds. Default Value:60
. If the Timeout Time Within the Back-End Server Has Not Answered the ALB Will Give up Waiting, the Client Returns the HTTP 504 Error Code. - security
Policy stringId Security Policy.
NOTE: The attribute is valid when the attribute
listener_protocol
isHTTPS
.- status string
- The state of the listener. Valid Values:
Running
OrStopped
. Valid values:Running
: The listener is running.Stopped
: The listener is stopped. - {[key: string]: any}
- A mapping of tags to assign to the resource.
- x
Forwarded ListenerFor Config XForwarded For Config - The
x_forward_for
Related Attribute Configuration. Seex_forwarded_for_config
below for details. NOTE: The attribute is valid when the attributelistener_protocol
isHTTPS
.
- listener_
port int - The ALB Instance Front-End, and Those of the Ports Used. Value:
1
to65535
. - listener_
protocol str - Snooping Protocols. Valid Values:
HTTP
,HTTPS
OrQUIC
. - load_
balancer_ strid - The ALB Instance Id.
- access_
log_ boolrecord_ customized_ headers_ enabled Indicates whether the access log has a custom header field. Valid values: true and 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_ Listenertracing_ config Access Log Tracing Config Args - Xtrace Configuration Information. See
access_log_tracing_config
below for details. - acl_
config ListenerAcl Config Args - The configurations of the access control lists (ACLs). See
acl_config
below for details. NOTE: Fieldacl_config
has been deprecated from provider version 1.163.0, and it will be removed in the future version. Please use the new resourcealicloud.alb.ListenerAclAttachment
., - certificates
Listener
Certificates Args - The default certificate of the Listener. See
certificates
below for details. NOTE: Whenlistener_protocol
isHTTPS
, The default certificate must be set one。 - default_
actions Sequence[ListenerDefault Action Args] - The Default Rule Action List. See
default_actions
below for details. - dry_
run bool - The dry run.
- gzip_
enabled bool - Whether to Enable Gzip Compression, as a Specific File Type on a Compression. Valid values:
false
,true
. Default Value:true
. . - http2_
enabled bool Whether to Enable HTTP/2 Features. Valid Values:
True
OrFalse
. Default Value:True
.NOTE: The attribute is valid when the attribute
listener_protocol
isHTTPS
.- idle_
timeout int - Specify the Connection Idle Timeout Value:
1
to60
. Unit: Seconds. - listener_
description str - The description of the listener. The description must be 2 to 256 characters in length. The name can contain only the characters in the following string:
/^([^\x00-\xff]|[\w.,;/@-]){2,256}$/
. - quic_
config ListenerQuic Config Args - Configuration Associated with the QuIC Listening. See
quic_config
below for details. - request_
timeout int - The Specified Request Timeout Time. Value:
1
to180
. Unit: Seconds. Default Value:60
. If the Timeout Time Within the Back-End Server Has Not Answered the ALB Will Give up Waiting, the Client Returns the HTTP 504 Error Code. - security_
policy_ strid Security Policy.
NOTE: The attribute is valid when the attribute
listener_protocol
isHTTPS
.- status str
- The state of the listener. Valid Values:
Running
OrStopped
. Valid values:Running
: The listener is running.Stopped
: The listener is stopped. - Mapping[str, Any]
- A mapping of tags to assign to the resource.
- x_
forwarded_ Listenerfor_ config XForwarded For Config Args - The
x_forward_for
Related Attribute Configuration. Seex_forwarded_for_config
below for details. NOTE: The attribute is valid when the attributelistener_protocol
isHTTPS
.
- listener
Port Number - The ALB Instance Front-End, and Those of the Ports Used. Value:
1
to65535
. - listener
Protocol String - Snooping Protocols. Valid Values:
HTTP
,HTTPS
OrQUIC
. - load
Balancer StringId - The ALB Instance Id.
- access
Log BooleanRecord Customized Headers Enabled Indicates whether the access log has a custom header field. Valid values: true and 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 Property MapTracing Config - Xtrace Configuration Information. See
access_log_tracing_config
below for details. - acl
Config Property Map - The configurations of the access control lists (ACLs). See
acl_config
below for details. NOTE: Fieldacl_config
has been deprecated from provider version 1.163.0, and it will be removed in the future version. Please use the new resourcealicloud.alb.ListenerAclAttachment
., - certificates Property Map
- The default certificate of the Listener. See
certificates
below for details. NOTE: Whenlistener_protocol
isHTTPS
, The default certificate must be set one。 - default
Actions List<Property Map> - The Default Rule Action List. See
default_actions
below for details. - dry
Run Boolean - The dry run.
- gzip
Enabled Boolean - Whether to Enable Gzip Compression, as a Specific File Type on a Compression. Valid values:
false
,true
. Default Value:true
. . - http2Enabled Boolean
Whether to Enable HTTP/2 Features. Valid Values:
True
OrFalse
. Default Value:True
.NOTE: The attribute is valid when the attribute
listener_protocol
isHTTPS
.- idle
Timeout Number - Specify the Connection Idle Timeout Value:
1
to60
. Unit: Seconds. - listener
Description String - The description of the listener. The description must be 2 to 256 characters in length. The name can contain only the characters in the following string:
/^([^\x00-\xff]|[\w.,;/@-]){2,256}$/
. - quic
Config Property Map - Configuration Associated with the QuIC Listening. See
quic_config
below for details. - request
Timeout Number - The Specified Request Timeout Time. Value:
1
to180
. Unit: Seconds. Default Value:60
. If the Timeout Time Within the Back-End Server Has Not Answered the ALB Will Give up Waiting, the Client Returns the HTTP 504 Error Code. - security
Policy StringId Security Policy.
NOTE: The attribute is valid when the attribute
listener_protocol
isHTTPS
.- status String
- The state of the listener. Valid Values:
Running
OrStopped
. Valid values:Running
: The listener is running.Stopped
: The listener is stopped. - Map<Any>
- A mapping of tags to assign to the resource.
- x
Forwarded Property MapFor Config - The
x_forward_for
Related Attribute Configuration. Seex_forwarded_for_config
below for details. NOTE: The attribute is valid when the attributelistener_protocol
isHTTPS
.
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,
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, Any]] = 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)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Access
Log boolRecord Customized Headers Enabled Indicates whether the access log has a custom header field. Valid values: true and 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 Pulumi.Tracing Config Ali Cloud. Alb. Inputs. Listener Access Log Tracing Config - Xtrace Configuration Information. See
access_log_tracing_config
below for details. - Acl
Config Pulumi.Ali Cloud. Alb. Inputs. Listener Acl Config - The configurations of the access control lists (ACLs). See
acl_config
below for details. NOTE: Fieldacl_config
has been deprecated from provider version 1.163.0, and it will be removed in the future version. Please use the new resourcealicloud.alb.ListenerAclAttachment
., - Certificates
Pulumi.
Ali Cloud. Alb. Inputs. Listener Certificates - The default certificate of the Listener. See
certificates
below for details. NOTE: Whenlistener_protocol
isHTTPS
, The default certificate must be set one。 - Default
Actions List<Pulumi.Ali Cloud. Alb. Inputs. Listener Default Action> - The Default Rule Action List. See
default_actions
below for details. - Dry
Run bool - The dry run.
- Gzip
Enabled bool - Whether to Enable Gzip Compression, as a Specific File Type on a Compression. Valid values:
false
,true
. Default Value:true
. . - Http2Enabled bool
Whether to Enable HTTP/2 Features. Valid Values:
True
OrFalse
. Default Value:True
.NOTE: The attribute is valid when the attribute
listener_protocol
isHTTPS
.- Idle
Timeout int - Specify the Connection Idle Timeout Value:
1
to60
. Unit: Seconds. - Listener
Description string - The description of the listener. The description must be 2 to 256 characters in length. The name can contain only the characters in the following string:
/^([^\x00-\xff]|[\w.,;/@-]){2,256}$/
. - Listener
Port int - The ALB Instance Front-End, and Those of the Ports Used. Value:
1
to65535
. - Listener
Protocol string - Snooping Protocols. Valid Values:
HTTP
,HTTPS
OrQUIC
. - Load
Balancer stringId - The ALB Instance Id.
- Quic
Config Pulumi.Ali Cloud. Alb. Inputs. Listener Quic Config - Configuration Associated with the QuIC Listening. See
quic_config
below for details. - Request
Timeout int - The Specified Request Timeout Time. Value:
1
to180
. Unit: Seconds. Default Value:60
. If the Timeout Time Within the Back-End Server Has Not Answered the ALB Will Give up Waiting, the Client Returns the HTTP 504 Error Code. - Security
Policy stringId Security Policy.
NOTE: The attribute is valid when the attribute
listener_protocol
isHTTPS
.- Status string
- The state of the listener. Valid Values:
Running
OrStopped
. Valid values:Running
: The listener is running.Stopped
: The listener is stopped. - Dictionary<string, object>
- A mapping of tags to assign to the resource.
- XForwarded
For Pulumi.Config Ali Cloud. Alb. Inputs. Listener XForwarded For Config - The
x_forward_for
Related Attribute Configuration. Seex_forwarded_for_config
below for details. NOTE: The attribute is valid when the attributelistener_protocol
isHTTPS
.
- Access
Log boolRecord Customized Headers Enabled Indicates whether the access log has a custom header field. Valid values: true and 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 ListenerTracing Config Access Log Tracing Config Args - Xtrace Configuration Information. See
access_log_tracing_config
below for details. - Acl
Config ListenerAcl Config Args - The configurations of the access control lists (ACLs). See
acl_config
below for details. NOTE: Fieldacl_config
has been deprecated from provider version 1.163.0, and it will be removed in the future version. Please use the new resourcealicloud.alb.ListenerAclAttachment
., - Certificates
Listener
Certificates Args - The default certificate of the Listener. See
certificates
below for details. NOTE: Whenlistener_protocol
isHTTPS
, The default certificate must be set one。 - Default
Actions []ListenerDefault Action Args - The Default Rule Action List. See
default_actions
below for details. - Dry
Run bool - The dry run.
- Gzip
Enabled bool - Whether to Enable Gzip Compression, as a Specific File Type on a Compression. Valid values:
false
,true
. Default Value:true
. . - Http2Enabled bool
Whether to Enable HTTP/2 Features. Valid Values:
True
OrFalse
. Default Value:True
.NOTE: The attribute is valid when the attribute
listener_protocol
isHTTPS
.- Idle
Timeout int - Specify the Connection Idle Timeout Value:
1
to60
. Unit: Seconds. - Listener
Description string - The description of the listener. The description must be 2 to 256 characters in length. The name can contain only the characters in the following string:
/^([^\x00-\xff]|[\w.,;/@-]){2,256}$/
. - Listener
Port int - The ALB Instance Front-End, and Those of the Ports Used. Value:
1
to65535
. - Listener
Protocol string - Snooping Protocols. Valid Values:
HTTP
,HTTPS
OrQUIC
. - Load
Balancer stringId - The ALB Instance Id.
- Quic
Config ListenerQuic Config Args - Configuration Associated with the QuIC Listening. See
quic_config
below for details. - Request
Timeout int - The Specified Request Timeout Time. Value:
1
to180
. Unit: Seconds. Default Value:60
. If the Timeout Time Within the Back-End Server Has Not Answered the ALB Will Give up Waiting, the Client Returns the HTTP 504 Error Code. - Security
Policy stringId Security Policy.
NOTE: The attribute is valid when the attribute
listener_protocol
isHTTPS
.- Status string
- The state of the listener. Valid Values:
Running
OrStopped
. Valid values:Running
: The listener is running.Stopped
: The listener is stopped. - map[string]interface{}
- A mapping of tags to assign to the resource.
- XForwarded
For ListenerConfig XForwarded For Config Args - The
x_forward_for
Related Attribute Configuration. Seex_forwarded_for_config
below for details. NOTE: The attribute is valid when the attributelistener_protocol
isHTTPS
.
- access
Log BooleanRecord Customized Headers Enabled Indicates whether the access log has a custom header field. Valid values: true and 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 ListenerTracing Config Access Log Tracing Config - Xtrace Configuration Information. See
access_log_tracing_config
below for details. - acl
Config ListenerAcl Config - The configurations of the access control lists (ACLs). See
acl_config
below for details. NOTE: Fieldacl_config
has been deprecated from provider version 1.163.0, and it will be removed in the future version. Please use the new resourcealicloud.alb.ListenerAclAttachment
., - certificates
Listener
Certificates - The default certificate of the Listener. See
certificates
below for details. NOTE: Whenlistener_protocol
isHTTPS
, The default certificate must be set one。 - default
Actions List<ListenerDefault Action> - The Default Rule Action List. See
default_actions
below for details. - dry
Run Boolean - The dry run.
- gzip
Enabled Boolean - Whether to Enable Gzip Compression, as a Specific File Type on a Compression. Valid values:
false
,true
. Default Value:true
. . - http2Enabled Boolean
Whether to Enable HTTP/2 Features. Valid Values:
True
OrFalse
. Default Value:True
.NOTE: The attribute is valid when the attribute
listener_protocol
isHTTPS
.- idle
Timeout Integer - Specify the Connection Idle Timeout Value:
1
to60
. Unit: Seconds. - listener
Description String - The description of the listener. The description must be 2 to 256 characters in length. The name can contain only the characters in the following string:
/^([^\x00-\xff]|[\w.,;/@-]){2,256}$/
. - listener
Port Integer - The ALB Instance Front-End, and Those of the Ports Used. Value:
1
to65535
. - listener
Protocol String - Snooping Protocols. Valid Values:
HTTP
,HTTPS
OrQUIC
. - load
Balancer StringId - The ALB Instance Id.
- quic
Config ListenerQuic Config - Configuration Associated with the QuIC Listening. See
quic_config
below for details. - request
Timeout Integer - The Specified Request Timeout Time. Value:
1
to180
. Unit: Seconds. Default Value:60
. If the Timeout Time Within the Back-End Server Has Not Answered the ALB Will Give up Waiting, the Client Returns the HTTP 504 Error Code. - security
Policy StringId Security Policy.
NOTE: The attribute is valid when the attribute
listener_protocol
isHTTPS
.- status String
- The state of the listener. Valid Values:
Running
OrStopped
. Valid values:Running
: The listener is running.Stopped
: The listener is stopped. - Map<String,Object>
- A mapping of tags to assign to the resource.
- x
Forwarded ListenerFor Config XForwarded For Config - The
x_forward_for
Related Attribute Configuration. Seex_forwarded_for_config
below for details. NOTE: The attribute is valid when the attributelistener_protocol
isHTTPS
.
- access
Log booleanRecord Customized Headers Enabled Indicates whether the access log has a custom header field. Valid values: true and 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 ListenerTracing Config Access Log Tracing Config - Xtrace Configuration Information. See
access_log_tracing_config
below for details. - acl
Config ListenerAcl Config - The configurations of the access control lists (ACLs). See
acl_config
below for details. NOTE: Fieldacl_config
has been deprecated from provider version 1.163.0, and it will be removed in the future version. Please use the new resourcealicloud.alb.ListenerAclAttachment
., - certificates
Listener
Certificates - The default certificate of the Listener. See
certificates
below for details. NOTE: Whenlistener_protocol
isHTTPS
, The default certificate must be set one。 - default
Actions ListenerDefault Action[] - The Default Rule Action List. See
default_actions
below for details. - dry
Run boolean - The dry run.
- gzip
Enabled boolean - Whether to Enable Gzip Compression, as a Specific File Type on a Compression. Valid values:
false
,true
. Default Value:true
. . - http2Enabled boolean
Whether to Enable HTTP/2 Features. Valid Values:
True
OrFalse
. Default Value:True
.NOTE: The attribute is valid when the attribute
listener_protocol
isHTTPS
.- idle
Timeout number - Specify the Connection Idle Timeout Value:
1
to60
. Unit: Seconds. - listener
Description string - The description of the listener. The description must be 2 to 256 characters in length. The name can contain only the characters in the following string:
/^([^\x00-\xff]|[\w.,;/@-]){2,256}$/
. - listener
Port number - The ALB Instance Front-End, and Those of the Ports Used. Value:
1
to65535
. - listener
Protocol string - Snooping Protocols. Valid Values:
HTTP
,HTTPS
OrQUIC
. - load
Balancer stringId - The ALB Instance Id.
- quic
Config ListenerQuic Config - Configuration Associated with the QuIC Listening. See
quic_config
below for details. - request
Timeout number - The Specified Request Timeout Time. Value:
1
to180
. Unit: Seconds. Default Value:60
. If the Timeout Time Within the Back-End Server Has Not Answered the ALB Will Give up Waiting, the Client Returns the HTTP 504 Error Code. - security
Policy stringId Security Policy.
NOTE: The attribute is valid when the attribute
listener_protocol
isHTTPS
.- status string
- The state of the listener. Valid Values:
Running
OrStopped
. Valid values:Running
: The listener is running.Stopped
: The listener is stopped. - {[key: string]: any}
- A mapping of tags to assign to the resource.
- x
Forwarded ListenerFor Config XForwarded For Config - The
x_forward_for
Related Attribute Configuration. Seex_forwarded_for_config
below for details. NOTE: The attribute is valid when the attributelistener_protocol
isHTTPS
.
- access_
log_ boolrecord_ customized_ headers_ enabled Indicates whether the access log has a custom header field. Valid values: true and 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_ Listenertracing_ config Access Log Tracing Config Args - Xtrace Configuration Information. See
access_log_tracing_config
below for details. - acl_
config ListenerAcl Config Args - The configurations of the access control lists (ACLs). See
acl_config
below for details. NOTE: Fieldacl_config
has been deprecated from provider version 1.163.0, and it will be removed in the future version. Please use the new resourcealicloud.alb.ListenerAclAttachment
., - certificates
Listener
Certificates Args - The default certificate of the Listener. See
certificates
below for details. NOTE: Whenlistener_protocol
isHTTPS
, The default certificate must be set one。 - default_
actions Sequence[ListenerDefault Action Args] - The Default Rule Action List. See
default_actions
below for details. - dry_
run bool - The dry run.
- gzip_
enabled bool - Whether to Enable Gzip Compression, as a Specific File Type on a Compression. Valid values:
false
,true
. Default Value:true
. . - http2_
enabled bool Whether to Enable HTTP/2 Features. Valid Values:
True
OrFalse
. Default Value:True
.NOTE: The attribute is valid when the attribute
listener_protocol
isHTTPS
.- idle_
timeout int - Specify the Connection Idle Timeout Value:
1
to60
. Unit: Seconds. - listener_
description str - The description of the listener. The description must be 2 to 256 characters in length. The name can contain only the characters in the following string:
/^([^\x00-\xff]|[\w.,;/@-]){2,256}$/
. - listener_
port int - The ALB Instance Front-End, and Those of the Ports Used. Value:
1
to65535
. - listener_
protocol str - Snooping Protocols. Valid Values:
HTTP
,HTTPS
OrQUIC
. - load_
balancer_ strid - The ALB Instance Id.
- quic_
config ListenerQuic Config Args - Configuration Associated with the QuIC Listening. See
quic_config
below for details. - request_
timeout int - The Specified Request Timeout Time. Value:
1
to180
. Unit: Seconds. Default Value:60
. If the Timeout Time Within the Back-End Server Has Not Answered the ALB Will Give up Waiting, the Client Returns the HTTP 504 Error Code. - security_
policy_ strid Security Policy.
NOTE: The attribute is valid when the attribute
listener_protocol
isHTTPS
.- status str
- The state of the listener. Valid Values:
Running
OrStopped
. Valid values:Running
: The listener is running.Stopped
: The listener is stopped. - Mapping[str, Any]
- A mapping of tags to assign to the resource.
- x_
forwarded_ Listenerfor_ config XForwarded For Config Args - The
x_forward_for
Related Attribute Configuration. Seex_forwarded_for_config
below for details. NOTE: The attribute is valid when the attributelistener_protocol
isHTTPS
.
- access
Log BooleanRecord Customized Headers Enabled Indicates whether the access log has a custom header field. Valid values: true and 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 Property MapTracing Config - Xtrace Configuration Information. See
access_log_tracing_config
below for details. - acl
Config Property Map - The configurations of the access control lists (ACLs). See
acl_config
below for details. NOTE: Fieldacl_config
has been deprecated from provider version 1.163.0, and it will be removed in the future version. Please use the new resourcealicloud.alb.ListenerAclAttachment
., - certificates Property Map
- The default certificate of the Listener. See
certificates
below for details. NOTE: Whenlistener_protocol
isHTTPS
, The default certificate must be set one。 - default
Actions List<Property Map> - The Default Rule Action List. See
default_actions
below for details. - dry
Run Boolean - The dry run.
- gzip
Enabled Boolean - Whether to Enable Gzip Compression, as a Specific File Type on a Compression. Valid values:
false
,true
. Default Value:true
. . - http2Enabled Boolean
Whether to Enable HTTP/2 Features. Valid Values:
True
OrFalse
. Default Value:True
.NOTE: The attribute is valid when the attribute
listener_protocol
isHTTPS
.- idle
Timeout Number - Specify the Connection Idle Timeout Value:
1
to60
. Unit: Seconds. - listener
Description String - The description of the listener. The description must be 2 to 256 characters in length. The name can contain only the characters in the following string:
/^([^\x00-\xff]|[\w.,;/@-]){2,256}$/
. - listener
Port Number - The ALB Instance Front-End, and Those of the Ports Used. Value:
1
to65535
. - listener
Protocol String - Snooping Protocols. Valid Values:
HTTP
,HTTPS
OrQUIC
. - load
Balancer StringId - The ALB Instance Id.
- quic
Config Property Map - Configuration Associated with the QuIC Listening. See
quic_config
below for details. - request
Timeout Number - The Specified Request Timeout Time. Value:
1
to180
. Unit: Seconds. Default Value:60
. If the Timeout Time Within the Back-End Server Has Not Answered the ALB Will Give up Waiting, the Client Returns the HTTP 504 Error Code. - security
Policy StringId Security Policy.
NOTE: The attribute is valid when the attribute
listener_protocol
isHTTPS
.- status String
- The state of the listener. Valid Values:
Running
OrStopped
. Valid values:Running
: The listener is running.Stopped
: The listener is stopped. - Map<Any>
- A mapping of tags to assign to the resource.
- x
Forwarded Property MapFor Config - The
x_forward_for
Related Attribute Configuration. Seex_forwarded_for_config
below for details. NOTE: The attribute is valid when the attributelistener_protocol
isHTTPS
.
Supporting Types
ListenerAccessLogTracingConfig, ListenerAccessLogTracingConfigArgs
- Tracing
Enabled bool Xtrace Function. Value:
True
OrFalse
. Default Value:False
.NOTE: Only Instances outside the Security Group to Access the Log Switch
accesslogenabled
Open, in Order to Set This Parameter to theTrue
.- Tracing
Sample int Xtrace Sampling Rate. Value:
1
to10000
.NOTE: This attribute is valid when
tracingenabled
istrue
.- Tracing
Type string Xtrace Type Value Is
Zipkin
.NOTE: This attribute is valid when
tracingenabled
istrue
.
- Tracing
Enabled bool Xtrace Function. Value:
True
OrFalse
. Default Value:False
.NOTE: Only Instances outside the Security Group to Access the Log Switch
accesslogenabled
Open, in Order to Set This Parameter to theTrue
.- Tracing
Sample int Xtrace Sampling Rate. Value:
1
to10000
.NOTE: This attribute is valid when
tracingenabled
istrue
.- Tracing
Type string Xtrace Type Value Is
Zipkin
.NOTE: This attribute is valid when
tracingenabled
istrue
.
- tracing
Enabled Boolean Xtrace Function. Value:
True
OrFalse
. Default Value:False
.NOTE: Only Instances outside the Security Group to Access the Log Switch
accesslogenabled
Open, in Order to Set This Parameter to theTrue
.- tracing
Sample Integer Xtrace Sampling Rate. Value:
1
to10000
.NOTE: This attribute is valid when
tracingenabled
istrue
.- tracing
Type String Xtrace Type Value Is
Zipkin
.NOTE: This attribute is valid when
tracingenabled
istrue
.
- tracing
Enabled boolean Xtrace Function. Value:
True
OrFalse
. Default Value:False
.NOTE: Only Instances outside the Security Group to Access the Log Switch
accesslogenabled
Open, in Order to Set This Parameter to theTrue
.- tracing
Sample number Xtrace Sampling Rate. Value:
1
to10000
.NOTE: This attribute is valid when
tracingenabled
istrue
.- tracing
Type string Xtrace Type Value Is
Zipkin
.NOTE: This attribute is valid when
tracingenabled
istrue
.
- tracing_
enabled bool Xtrace Function. Value:
True
OrFalse
. Default Value:False
.NOTE: Only Instances outside the Security Group to Access the Log Switch
accesslogenabled
Open, in Order to Set This Parameter to theTrue
.- tracing_
sample int Xtrace Sampling Rate. Value:
1
to10000
.NOTE: This attribute is valid when
tracingenabled
istrue
.- tracing_
type str Xtrace Type Value Is
Zipkin
.NOTE: This attribute is valid when
tracingenabled
istrue
.
- tracing
Enabled Boolean Xtrace Function. Value:
True
OrFalse
. Default Value:False
.NOTE: Only Instances outside the Security Group to Access the Log Switch
accesslogenabled
Open, in Order to Set This Parameter to theTrue
.- tracing
Sample Number Xtrace Sampling Rate. Value:
1
to10000
.NOTE: This attribute is valid when
tracingenabled
istrue
.- tracing
Type String Xtrace Type Value Is
Zipkin
.NOTE: This attribute is valid when
tracingenabled
istrue
.
ListenerAclConfig, ListenerAclConfigArgs
- Acl
Relations List<Pulumi.Ali Cloud. Alb. Inputs. Listener Acl Config Acl Relation> - The ACLs that are associated with the listener. See
acl_relations
below for details. - Acl
Type string - The type of the ACL. Valid values:
White
OrBlack
.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 []ListenerAcl Config Acl Relation - The ACLs that are associated with the listener. See
acl_relations
below for details. - Acl
Type string - The type of the ACL. Valid values:
White
OrBlack
.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 List<ListenerAcl Config Acl Relation> - The ACLs that are associated with the listener. See
acl_relations
below for details. - acl
Type String - The type of the ACL. Valid values:
White
OrBlack
.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 ListenerAcl Config Acl Relation[] - The ACLs that are associated with the listener. See
acl_relations
below for details. - acl
Type string - The type of the ACL. Valid values:
White
OrBlack
.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[ListenerAcl Config Acl Relation] - 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
OrBlack
.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 List<Property Map> - The ACLs that are associated with the listener. See
acl_relations
below for details. - acl
Type String - The type of the ACL. Valid values:
White
OrBlack
.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
ListenerCertificates, ListenerCertificatesArgs
- Certificate
Id string - The ID of the Certificate.
- Certificate
Id string - The ID of the Certificate.
- certificate
Id String - The ID of the Certificate.
- certificate
Id string - The ID of the Certificate.
- certificate_
id str - The ID of the Certificate.
- certificate
Id String - The ID of the Certificate.
ListenerDefaultAction, ListenerDefaultActionArgs
- Forward
Group Pulumi.Config Ali Cloud. Alb. Inputs. Listener Default Action Forward Group Config - The configurations of the actions. This parameter is required if Type is set to FowardGroup. See
forward_group_config
below for details. - Type string
- Action Type.
- Forward
Group ListenerConfig Default Action Forward Group Config - The configurations of the actions. This parameter is required if Type is set to FowardGroup. See
forward_group_config
below for details. - Type string
- Action Type.
- forward
Group ListenerConfig Default Action Forward Group Config - The configurations of the actions. This parameter is required if Type is set to FowardGroup. See
forward_group_config
below for details. - type String
- Action Type.
- forward
Group ListenerConfig Default Action Forward Group Config - The configurations of the actions. This parameter is required if Type is set to FowardGroup. See
forward_group_config
below for details. - type string
- Action Type.
- forward_
group_ Listenerconfig Default Action Forward Group Config - The configurations of the actions. This parameter is required if Type is set to FowardGroup. See
forward_group_config
below for details. - type str
- Action Type.
- forward
Group Property MapConfig - The configurations of the actions. This parameter is required if Type is set to FowardGroup. See
forward_group_config
below for details. - type String
- Action Type.
ListenerDefaultActionForwardGroupConfig, ListenerDefaultActionForwardGroupConfigArgs
ListenerDefaultActionForwardGroupConfigServerGroupTuple, ListenerDefaultActionForwardGroupConfigServerGroupTupleArgs
- Server
Group stringId
- Server
Group stringId
- server
Group StringId
- server
Group stringId
- server_
group_ strid
- server
Group StringId
ListenerQuicConfig, ListenerQuicConfigArgs
- Quic
Listener stringId - There Is a Need to Correlate the QuIC Listener ID. The Https Listener, in Effect at the Time. quicupgradeenabled True When Required.
- Quic
Upgrade boolEnabled Indicates Whether to Enable the QuIC Upgrade.
NOTE: The attribute is valid when the attribute
ListenerProtocol
isHTTPS
.
- Quic
Listener stringId - There Is a Need to Correlate the QuIC Listener ID. The Https Listener, in Effect at the Time. quicupgradeenabled True When Required.
- Quic
Upgrade boolEnabled Indicates Whether to Enable the QuIC Upgrade.
NOTE: The attribute is valid when the attribute
ListenerProtocol
isHTTPS
.
- quic
Listener StringId - There Is a Need to Correlate the QuIC Listener ID. The Https Listener, in Effect at the Time. quicupgradeenabled True When Required.
- quic
Upgrade BooleanEnabled Indicates Whether to Enable the QuIC Upgrade.
NOTE: The attribute is valid when the attribute
ListenerProtocol
isHTTPS
.
- quic
Listener stringId - There Is a Need to Correlate the QuIC Listener ID. The Https Listener, in Effect at the Time. quicupgradeenabled True When Required.
- quic
Upgrade booleanEnabled Indicates Whether to Enable the QuIC Upgrade.
NOTE: The attribute is valid when the attribute
ListenerProtocol
isHTTPS
.
- quic_
listener_ strid - There Is a Need to Correlate the QuIC Listener ID. The Https Listener, in Effect at the Time. quicupgradeenabled True When Required.
- quic_
upgrade_ boolenabled Indicates Whether to Enable the QuIC Upgrade.
NOTE: The attribute is valid when the attribute
ListenerProtocol
isHTTPS
.
- quic
Listener StringId - There Is a Need to Correlate the QuIC Listener ID. The Https Listener, in Effect at the Time. quicupgradeenabled True When Required.
- quic
Upgrade BooleanEnabled Indicates Whether to Enable the QuIC Upgrade.
NOTE: The attribute is valid when the attribute
ListenerProtocol
isHTTPS
.
ListenerXForwardedForConfig, ListenerXForwardedForConfigArgs
- XForwarded
For stringClient Cert Client Verify Alias - The Custom Header Field Names Only When
x_forwarded_for_client_cert_client_verify_enabled
Has a Value of True, this Value Will Not Take Effect until.The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits. - XForwarded
For boolClient Cert Client Verify Enabled - 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. - XForwarded
For stringClient Cert Finger Print Alias - The Custom Header Field Names Only When
x_forwarded_for_client_certfingerprint_enabled
, Which Evaluates to True When the Entry into Force of.The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits. - XForwarded
For boolClient Cert Finger Print Enabled - Indicates Whether the
X-Forwarded-client_cert-fingerprint
Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate Fingerprint Value. - XForwarded
For stringClient Cert Issuer Dn Alias - The Custom Header Field Names Only When
x_forwarded_for_client_cert_issuer_dn_enabled
, Which Evaluates to True When the Entry into Force of. - XForwarded
For boolClient Cert Issuer Dn Enabled - 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. - XForwarded
For stringClient Cert Subject Dn Alias - The name of the custom header. This parameter is valid only if
x_forwarded_for_client_certsubjectdn_enabled
is set to true. The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits. - XForwarded
For boolClient Cert Subject Dn Enabled - Specifies whether to use the
X-Forwarded-client_cert-subjectdn
header field to obtain information about the owner of the ALB client certificate. Valid values: true and false. Default value: false. - XForwarded
For boolClient Source Ips Enabled - Whether to use the X-Forwarded-Client-Ip header to obtain the source IP address of the server load balancer instance. Value: true, false. 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.
- XForwarded
For stringClient Source Ips Trusted - 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.
- XForwarded
For boolClient Src Port Enabled - 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.
- XForwarded
For boolEnabled - Whether to Enable by X-Forwarded-For Header Field Is Used to Obtain the Client IP Addresses.
- XForwarded
For boolProto Enabled - Indicates Whether the X-Forwarded-Proto Header Field Is Used to Obtain the Server Load Balancer Instance Snooping Protocols.
- XForwarded
For boolSlb Id Enabled - Indicates Whether the SLB-ID Header Field Is Used to Obtain the Load Balancing Instance Id.
- XForwarded
For boolSlb Port Enabled - Indicates Whether the X-Forwarded-Port Header Field Is Used to Obtain the Server Load Balancer Instance Listening Port.
- XForwarded
For stringClient Cert Client Verify Alias - The Custom Header Field Names Only When
x_forwarded_for_client_cert_client_verify_enabled
Has a Value of True, this Value Will Not Take Effect until.The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits. - XForwarded
For boolClient Cert Client Verify Enabled - 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. - XForwarded
For stringClient Cert Finger Print Alias - The Custom Header Field Names Only When
x_forwarded_for_client_certfingerprint_enabled
, Which Evaluates to True When the Entry into Force of.The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits. - XForwarded
For boolClient Cert Finger Print Enabled - Indicates Whether the
X-Forwarded-client_cert-fingerprint
Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate Fingerprint Value. - XForwarded
For stringClient Cert Issuer Dn Alias - The Custom Header Field Names Only When
x_forwarded_for_client_cert_issuer_dn_enabled
, Which Evaluates to True When the Entry into Force of. - XForwarded
For boolClient Cert Issuer Dn Enabled - 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. - XForwarded
For stringClient Cert Subject Dn Alias - The name of the custom header. This parameter is valid only if
x_forwarded_for_client_certsubjectdn_enabled
is set to true. The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits. - XForwarded
For boolClient Cert Subject Dn Enabled - Specifies whether to use the
X-Forwarded-client_cert-subjectdn
header field to obtain information about the owner of the ALB client certificate. Valid values: true and false. Default value: false. - XForwarded
For boolClient Source Ips Enabled - Whether to use the X-Forwarded-Client-Ip header to obtain the source IP address of the server load balancer instance. Value: true, false. 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.
- XForwarded
For stringClient Source Ips Trusted - 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.
- XForwarded
For boolClient Src Port Enabled - 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.
- XForwarded
For boolEnabled - Whether to Enable by X-Forwarded-For Header Field Is Used to Obtain the Client IP Addresses.
- XForwarded
For boolProto Enabled - Indicates Whether the X-Forwarded-Proto Header Field Is Used to Obtain the Server Load Balancer Instance Snooping Protocols.
- XForwarded
For boolSlb Id Enabled - Indicates Whether the SLB-ID Header Field Is Used to Obtain the Load Balancing Instance Id.
- XForwarded
For boolSlb Port Enabled - Indicates Whether the X-Forwarded-Port Header Field Is Used to Obtain the Server Load Balancer Instance Listening Port.
- x
Forwarded StringFor Client Cert Client Verify Alias - The Custom Header Field Names Only When
x_forwarded_for_client_cert_client_verify_enabled
Has a Value of True, this Value Will Not Take Effect until.The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits. - x
Forwarded BooleanFor Client Cert Client Verify Enabled - 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 StringFor Client Cert Finger Print Alias - The Custom Header Field Names Only When
x_forwarded_for_client_certfingerprint_enabled
, Which Evaluates to True When the Entry into Force of.The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits. - x
Forwarded BooleanFor Client Cert Finger Print Enabled - Indicates Whether the
X-Forwarded-client_cert-fingerprint
Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate Fingerprint Value. - x
Forwarded StringFor Client Cert Issuer Dn Alias - The Custom Header Field Names Only When
x_forwarded_for_client_cert_issuer_dn_enabled
, Which Evaluates to True When the Entry into Force of. - x
Forwarded BooleanFor Client Cert Issuer Dn Enabled - 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 StringFor Client Cert Subject Dn Alias - The name of the custom header. This parameter is valid only if
x_forwarded_for_client_certsubjectdn_enabled
is set to true. The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits. - x
Forwarded BooleanFor Client Cert Subject Dn Enabled - Specifies whether to use the
X-Forwarded-client_cert-subjectdn
header field to obtain information about the owner of the ALB client certificate. Valid values: true and false. Default value: false. - x
Forwarded BooleanFor Client Source Ips Enabled - Whether to use the X-Forwarded-Client-Ip header to obtain the source IP address of the server load balancer instance. Value: true, false. 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 StringFor Client Source Ips Trusted - 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 BooleanFor Client Src Port Enabled - 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 BooleanFor Enabled - Whether to Enable by X-Forwarded-For Header Field Is Used to Obtain the Client IP Addresses.
- x
Forwarded BooleanFor Proto Enabled - Indicates Whether the X-Forwarded-Proto Header Field Is Used to Obtain the Server Load Balancer Instance Snooping Protocols.
- x
Forwarded BooleanFor Slb Id Enabled - Indicates Whether the SLB-ID Header Field Is Used to Obtain the Load Balancing Instance Id.
- x
Forwarded BooleanFor Slb Port Enabled - Indicates Whether the X-Forwarded-Port Header Field Is Used to Obtain the Server Load Balancer Instance Listening Port.
- x
Forwarded stringFor Client Cert Client Verify Alias - The Custom Header Field Names Only When
x_forwarded_for_client_cert_client_verify_enabled
Has a Value of True, this Value Will Not Take Effect until.The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits. - x
Forwarded booleanFor Client Cert Client Verify Enabled - 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 stringFor Client Cert Finger Print Alias - The Custom Header Field Names Only When
x_forwarded_for_client_certfingerprint_enabled
, Which Evaluates to True When the Entry into Force of.The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits. - x
Forwarded booleanFor Client Cert Finger Print Enabled - Indicates Whether the
X-Forwarded-client_cert-fingerprint
Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate Fingerprint Value. - x
Forwarded stringFor Client Cert Issuer Dn Alias - The Custom Header Field Names Only When
x_forwarded_for_client_cert_issuer_dn_enabled
, Which Evaluates to True When the Entry into Force of. - x
Forwarded booleanFor Client Cert Issuer Dn Enabled - 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 stringFor Client Cert Subject Dn Alias - The name of the custom header. This parameter is valid only if
x_forwarded_for_client_certsubjectdn_enabled
is set to true. The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits. - x
Forwarded booleanFor Client Cert Subject Dn Enabled - Specifies whether to use the
X-Forwarded-client_cert-subjectdn
header field to obtain information about the owner of the ALB client certificate. Valid values: true and false. Default value: false. - x
Forwarded booleanFor Client Source Ips Enabled - Whether to use the X-Forwarded-Client-Ip header to obtain the source IP address of the server load balancer instance. Value: true, false. 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 stringFor Client Source Ips Trusted - 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 booleanFor Client Src Port Enabled - 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 booleanFor Enabled - Whether to Enable by X-Forwarded-For Header Field Is Used to Obtain the Client IP Addresses.
- x
Forwarded booleanFor Proto Enabled - Indicates Whether the X-Forwarded-Proto Header Field Is Used to Obtain the Server Load Balancer Instance Snooping Protocols.
- x
Forwarded booleanFor Slb Id Enabled - Indicates Whether the SLB-ID Header Field Is Used to Obtain the Load Balancing Instance Id.
- x
Forwarded booleanFor Slb Port Enabled - Indicates Whether the X-Forwarded-Port Header Field Is Used to Obtain the Server Load Balancer Instance Listening Port.
- x_
forwarded_ strfor_ client_ cert_ client_ verify_ alias - The Custom Header Field Names Only When
x_forwarded_for_client_cert_client_verify_enabled
Has a Value of True, this Value Will Not Take Effect until.The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits. - x_
forwarded_ boolfor_ client_ cert_ client_ verify_ enabled - 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_ strfor_ client_ cert_ finger_ print_ alias - The Custom Header Field Names Only When
x_forwarded_for_client_certfingerprint_enabled
, Which Evaluates to True When the Entry into Force of.The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits. - x_
forwarded_ boolfor_ client_ cert_ finger_ print_ enabled - Indicates Whether the
X-Forwarded-client_cert-fingerprint
Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate Fingerprint Value. - x_
forwarded_ strfor_ client_ cert_ issuer_ dn_ alias - The Custom Header Field Names Only When
x_forwarded_for_client_cert_issuer_dn_enabled
, Which Evaluates to True When the Entry into Force of. - x_
forwarded_ boolfor_ client_ cert_ issuer_ dn_ enabled - 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_ strfor_ client_ cert_ subject_ dn_ alias - The name of the custom header. This parameter is valid only if
x_forwarded_for_client_certsubjectdn_enabled
is set to true. The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits. - x_
forwarded_ boolfor_ client_ cert_ subject_ dn_ enabled - Specifies whether to use the
X-Forwarded-client_cert-subjectdn
header field to obtain information about the owner of the ALB client certificate. Valid values: true and false. Default value: false. - x_
forwarded_ boolfor_ client_ source_ ips_ enabled - Whether to use the X-Forwarded-Client-Ip header to obtain the source IP address of the server load balancer instance. Value: true, false. 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_ strfor_ client_ source_ ips_ trusted - 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_ boolfor_ client_ src_ port_ enabled - 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_ boolfor_ enabled - Whether to Enable by X-Forwarded-For Header Field Is Used to Obtain the Client IP Addresses.
- x_
forwarded_ boolfor_ proto_ enabled - Indicates Whether the X-Forwarded-Proto Header Field Is Used to Obtain the Server Load Balancer Instance Snooping Protocols.
- x_
forwarded_ boolfor_ slb_ id_ enabled - Indicates Whether the SLB-ID Header Field Is Used to Obtain the Load Balancing Instance Id.
- x_
forwarded_ boolfor_ slb_ port_ enabled - Indicates Whether the X-Forwarded-Port Header Field Is Used to Obtain the Server Load Balancer Instance Listening Port.
- x
Forwarded StringFor Client Cert Client Verify Alias - The Custom Header Field Names Only When
x_forwarded_for_client_cert_client_verify_enabled
Has a Value of True, this Value Will Not Take Effect until.The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits. - x
Forwarded BooleanFor Client Cert Client Verify Enabled - 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 StringFor Client Cert Finger Print Alias - The Custom Header Field Names Only When
x_forwarded_for_client_certfingerprint_enabled
, Which Evaluates to True When the Entry into Force of.The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits. - x
Forwarded BooleanFor Client Cert Finger Print Enabled - Indicates Whether the
X-Forwarded-client_cert-fingerprint
Header Field Is Used to Obtain Access to the Server Load Balancer Instance of the Client Certificate Fingerprint Value. - x
Forwarded StringFor Client Cert Issuer Dn Alias - The Custom Header Field Names Only When
x_forwarded_for_client_cert_issuer_dn_enabled
, Which Evaluates to True When the Entry into Force of. - x
Forwarded BooleanFor Client Cert Issuer Dn Enabled - 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 StringFor Client Cert Subject Dn Alias - The name of the custom header. This parameter is valid only if
x_forwarded_for_client_certsubjectdn_enabled
is set to true. The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits. - x
Forwarded BooleanFor Client Cert Subject Dn Enabled - Specifies whether to use the
X-Forwarded-client_cert-subjectdn
header field to obtain information about the owner of the ALB client certificate. Valid values: true and false. Default value: false. - x
Forwarded BooleanFor Client Source Ips Enabled - Whether to use the X-Forwarded-Client-Ip header to obtain the source IP address of the server load balancer instance. Value: true, false. 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 StringFor Client Source Ips Trusted - 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 BooleanFor Client Src Port Enabled - 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 BooleanFor Enabled - Whether to Enable by X-Forwarded-For Header Field Is Used to Obtain the Client IP Addresses.
- x
Forwarded BooleanFor Proto Enabled - Indicates Whether the X-Forwarded-Proto Header Field Is Used to Obtain the Server Load Balancer Instance Snooping Protocols.
- x
Forwarded BooleanFor Slb Id Enabled - Indicates Whether the SLB-ID Header Field Is Used to Obtain the Load Balancing Instance Id.
- x
Forwarded BooleanFor Slb Port Enabled - 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>
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.