Alibaba Cloud

v3.15.0 published on Thursday, Jan 13, 2022 by Pulumi

Listener

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 in v1.133.0+.

Create a Listener Resource

new Listener(name: string, args: ListenerArgs, opts?: CustomResourceOptions);
@overload
def Listener(resource_name: 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[Sequence[ListenerCertificateArgs]] = 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,
             xforwarded_for_config: Optional[ListenerXforwardedForConfigArgs] = None)
@overload
def Listener(resource_name: str,
             args: ListenerArgs,
             opts: Optional[ResourceOptions] = None)
func NewListener(ctx *Context, name string, args ListenerArgs, opts ...ResourceOption) (*Listener, error)
public Listener(string name, ListenerArgs args, CustomResourceOptions? opts = null)
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.

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:

ListenerPort int
The ALB Instance Front-End, and Those of the Ports Used. Value: 1 to 65535.
ListenerProtocol string
Snooping Protocols. Valid Values: HTTP, HTTPS Or QUIC.
LoadBalancerId string
The ALB Instance Id.
AccessLogRecordCustomizedHeadersEnabled bool
Indicates whether the access log has a custom header field. Valid values: true and false. Default value: false.
AccessLogTracingConfig Pulumi.AliCloud.Alb.Inputs.ListenerAccessLogTracingConfigArgs
Xtrace Configuration Information. See the following Block access_log_tracing_config.
AclConfig Pulumi.AliCloud.Alb.Inputs.ListenerAclConfigArgs
The configurations of the access control lists (ACLs). See the following Block acl_config.
Certificates List<Pulumi.AliCloud.Alb.Inputs.ListenerCertificateArgs>
The Certificate List. See the following Block certificates.
DefaultActions List<Pulumi.AliCloud.Alb.Inputs.ListenerDefaultActionArgs>
The Default Rule Action List. See the following Block default_actions.
DryRun bool
The dry run.
GzipEnabled 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 Or False. Default Value: True.
IdleTimeout int
Specify the Connection Idle Timeout Value: 1 to 60. Unit: Seconds.
ListenerDescription 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}$/.
QuicConfig Pulumi.AliCloud.Alb.Inputs.ListenerQuicConfigArgs
Configuration Associated with the QuIC Listening. See the following Block quic_config.
RequestTimeout int
The Specified Request Timeout Time. Value: 1 to 180. 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.
SecurityPolicyId string
Security Policy.
Status string
The state of the listener. Valid Values: Running Or Stopped. Valid values: Running: The listener is running. Stopped: The listener is stopped.
XforwardedForConfig Pulumi.AliCloud.Alb.Inputs.ListenerXforwardedForConfigArgs
xforwardfor Related Attribute Configuration. See the following Block xforwarded_for_config.
ListenerPort int
The ALB Instance Front-End, and Those of the Ports Used. Value: 1 to 65535.
ListenerProtocol string
Snooping Protocols. Valid Values: HTTP, HTTPS Or QUIC.
LoadBalancerId string
The ALB Instance Id.
AccessLogRecordCustomizedHeadersEnabled bool
Indicates whether the access log has a custom header field. Valid values: true and false. Default value: false.
AccessLogTracingConfig ListenerAccessLogTracingConfigArgs
Xtrace Configuration Information. See the following Block access_log_tracing_config.
AclConfig ListenerAclConfigArgs
The configurations of the access control lists (ACLs). See the following Block acl_config.
Certificates []ListenerCertificateArgs
The Certificate List. See the following Block certificates.
DefaultActions []ListenerDefaultActionArgs
The Default Rule Action List. See the following Block default_actions.
DryRun bool
The dry run.
GzipEnabled 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 Or False. Default Value: True.
IdleTimeout int
Specify the Connection Idle Timeout Value: 1 to 60. Unit: Seconds.
ListenerDescription 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}$/.
QuicConfig ListenerQuicConfigArgs
Configuration Associated with the QuIC Listening. See the following Block quic_config.
RequestTimeout int
The Specified Request Timeout Time. Value: 1 to 180. 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.
SecurityPolicyId string
Security Policy.
Status string
The state of the listener. Valid Values: Running Or Stopped. Valid values: Running: The listener is running. Stopped: The listener is stopped.
XforwardedForConfig ListenerXforwardedForConfigArgs
xforwardfor Related Attribute Configuration. See the following Block xforwarded_for_config.
listenerPort number
The ALB Instance Front-End, and Those of the Ports Used. Value: 1 to 65535.
listenerProtocol string
Snooping Protocols. Valid Values: HTTP, HTTPS Or QUIC.
loadBalancerId string
The ALB Instance Id.
accessLogRecordCustomizedHeadersEnabled boolean
Indicates whether the access log has a custom header field. Valid values: true and false. Default value: false.
accessLogTracingConfig ListenerAccessLogTracingConfigArgs
Xtrace Configuration Information. See the following Block access_log_tracing_config.
aclConfig ListenerAclConfigArgs
The configurations of the access control lists (ACLs). See the following Block acl_config.
certificates ListenerCertificateArgs[]
The Certificate List. See the following Block certificates.
defaultActions ListenerDefaultActionArgs[]
The Default Rule Action List. See the following Block default_actions.
dryRun boolean
The dry run.
gzipEnabled 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 Or False. Default Value: True.
idleTimeout number
Specify the Connection Idle Timeout Value: 1 to 60. Unit: Seconds.
listenerDescription 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}$/.
quicConfig ListenerQuicConfigArgs
Configuration Associated with the QuIC Listening. See the following Block quic_config.
requestTimeout number
The Specified Request Timeout Time. Value: 1 to 180. 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.
securityPolicyId string
Security Policy.
status string
The state of the listener. Valid Values: Running Or Stopped. Valid values: Running: The listener is running. Stopped: The listener is stopped.
xforwardedForConfig ListenerXforwardedForConfigArgs
xforwardfor Related Attribute Configuration. See the following Block xforwarded_for_config.
listener_port int
The ALB Instance Front-End, and Those of the Ports Used. Value: 1 to 65535.
listener_protocol str
Snooping Protocols. Valid Values: HTTP, HTTPS Or QUIC.
load_balancer_id str
The ALB Instance Id.
access_log_record_customized_headers_enabled bool
Indicates whether the access log has a custom header field. Valid values: true and false. Default value: false.
access_log_tracing_config ListenerAccessLogTracingConfigArgs
Xtrace Configuration Information. See the following Block access_log_tracing_config.
acl_config ListenerAclConfigArgs
The configurations of the access control lists (ACLs). See the following Block acl_config.
certificates Sequence[ListenerCertificateArgs]
The Certificate List. See the following Block certificates.
default_actions Sequence[ListenerDefaultActionArgs]
The Default Rule Action List. See the following Block default_actions.
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 Or False. Default Value: True.
idle_timeout int
Specify the Connection Idle Timeout Value: 1 to 60. 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 ListenerQuicConfigArgs
Configuration Associated with the QuIC Listening. See the following Block quic_config.
request_timeout int
The Specified Request Timeout Time. Value: 1 to 180. 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_id str
Security Policy.
status str
The state of the listener. Valid Values: Running Or Stopped. Valid values: Running: The listener is running. Stopped: The listener is stopped.
xforwarded_for_config ListenerXforwardedForConfigArgs
xforwardfor Related Attribute Configuration. See the following Block xforwarded_for_config.

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 str
The provider-assigned unique ID for this managed resource.

Look up an 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[Sequence[ListenerCertificateArgs]] = 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,
        xforwarded_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)
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.

The following state arguments are supported:

AccessLogRecordCustomizedHeadersEnabled bool
Indicates whether the access log has a custom header field. Valid values: true and false. Default value: false.
AccessLogTracingConfig Pulumi.AliCloud.Alb.Inputs.ListenerAccessLogTracingConfigArgs
Xtrace Configuration Information. See the following Block access_log_tracing_config.
AclConfig Pulumi.AliCloud.Alb.Inputs.ListenerAclConfigArgs
The configurations of the access control lists (ACLs). See the following Block acl_config.
Certificates List<Pulumi.AliCloud.Alb.Inputs.ListenerCertificateArgs>
The Certificate List. See the following Block certificates.
DefaultActions List<Pulumi.AliCloud.Alb.Inputs.ListenerDefaultActionArgs>
The Default Rule Action List. See the following Block default_actions.
DryRun bool
The dry run.
GzipEnabled 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 Or False. Default Value: True.
IdleTimeout int
Specify the Connection Idle Timeout Value: 1 to 60. Unit: Seconds.
ListenerDescription 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}$/.
ListenerPort int
The ALB Instance Front-End, and Those of the Ports Used. Value: 1 to 65535.
ListenerProtocol string
Snooping Protocols. Valid Values: HTTP, HTTPS Or QUIC.
LoadBalancerId string
The ALB Instance Id.
QuicConfig Pulumi.AliCloud.Alb.Inputs.ListenerQuicConfigArgs
Configuration Associated with the QuIC Listening. See the following Block quic_config.
RequestTimeout int
The Specified Request Timeout Time. Value: 1 to 180. 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.
SecurityPolicyId string
Security Policy.
Status string
The state of the listener. Valid Values: Running Or Stopped. Valid values: Running: The listener is running. Stopped: The listener is stopped.
XforwardedForConfig Pulumi.AliCloud.Alb.Inputs.ListenerXforwardedForConfigArgs
xforwardfor Related Attribute Configuration. See the following Block xforwarded_for_config.
AccessLogRecordCustomizedHeadersEnabled bool
Indicates whether the access log has a custom header field. Valid values: true and false. Default value: false.
AccessLogTracingConfig ListenerAccessLogTracingConfigArgs
Xtrace Configuration Information. See the following Block access_log_tracing_config.
AclConfig ListenerAclConfigArgs
The configurations of the access control lists (ACLs). See the following Block acl_config.
Certificates []ListenerCertificateArgs
The Certificate List. See the following Block certificates.
DefaultActions []ListenerDefaultActionArgs
The Default Rule Action List. See the following Block default_actions.
DryRun bool
The dry run.
GzipEnabled 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 Or False. Default Value: True.
IdleTimeout int
Specify the Connection Idle Timeout Value: 1 to 60. Unit: Seconds.
ListenerDescription 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}$/.
ListenerPort int
The ALB Instance Front-End, and Those of the Ports Used. Value: 1 to 65535.
ListenerProtocol string
Snooping Protocols. Valid Values: HTTP, HTTPS Or QUIC.
LoadBalancerId string
The ALB Instance Id.
QuicConfig ListenerQuicConfigArgs
Configuration Associated with the QuIC Listening. See the following Block quic_config.
RequestTimeout int
The Specified Request Timeout Time. Value: 1 to 180. 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.
SecurityPolicyId string
Security Policy.
Status string
The state of the listener. Valid Values: Running Or Stopped. Valid values: Running: The listener is running. Stopped: The listener is stopped.
XforwardedForConfig ListenerXforwardedForConfigArgs
xforwardfor Related Attribute Configuration. See the following Block xforwarded_for_config.
accessLogRecordCustomizedHeadersEnabled boolean
Indicates whether the access log has a custom header field. Valid values: true and false. Default value: false.
accessLogTracingConfig ListenerAccessLogTracingConfigArgs
Xtrace Configuration Information. See the following Block access_log_tracing_config.
aclConfig ListenerAclConfigArgs
The configurations of the access control lists (ACLs). See the following Block acl_config.
certificates ListenerCertificateArgs[]
The Certificate List. See the following Block certificates.
defaultActions ListenerDefaultActionArgs[]
The Default Rule Action List. See the following Block default_actions.
dryRun boolean
The dry run.
gzipEnabled 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 Or False. Default Value: True.
idleTimeout number
Specify the Connection Idle Timeout Value: 1 to 60. Unit: Seconds.
listenerDescription 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}$/.
listenerPort number
The ALB Instance Front-End, and Those of the Ports Used. Value: 1 to 65535.
listenerProtocol string
Snooping Protocols. Valid Values: HTTP, HTTPS Or QUIC.
loadBalancerId string
The ALB Instance Id.
quicConfig ListenerQuicConfigArgs
Configuration Associated with the QuIC Listening. See the following Block quic_config.
requestTimeout number
The Specified Request Timeout Time. Value: 1 to 180. 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.
securityPolicyId string
Security Policy.
status string
The state of the listener. Valid Values: Running Or Stopped. Valid values: Running: The listener is running. Stopped: The listener is stopped.
xforwardedForConfig ListenerXforwardedForConfigArgs
xforwardfor Related Attribute Configuration. See the following Block xforwarded_for_config.
access_log_record_customized_headers_enabled bool
Indicates whether the access log has a custom header field. Valid values: true and false. Default value: false.
access_log_tracing_config ListenerAccessLogTracingConfigArgs
Xtrace Configuration Information. See the following Block access_log_tracing_config.
acl_config ListenerAclConfigArgs
The configurations of the access control lists (ACLs). See the following Block acl_config.
certificates Sequence[ListenerCertificateArgs]
The Certificate List. See the following Block certificates.
default_actions Sequence[ListenerDefaultActionArgs]
The Default Rule Action List. See the following Block default_actions.
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 Or False. Default Value: True.
idle_timeout int
Specify the Connection Idle Timeout Value: 1 to 60. 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 to 65535.
listener_protocol str
Snooping Protocols. Valid Values: HTTP, HTTPS Or QUIC.
load_balancer_id str
The ALB Instance Id.
quic_config ListenerQuicConfigArgs
Configuration Associated with the QuIC Listening. See the following Block quic_config.
request_timeout int
The Specified Request Timeout Time. Value: 1 to 180. 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_id str
Security Policy.
status str
The state of the listener. Valid Values: Running Or Stopped. Valid values: Running: The listener is running. Stopped: The listener is stopped.
xforwarded_for_config ListenerXforwardedForConfigArgs
xforwardfor Related Attribute Configuration. See the following Block xforwarded_for_config.

Supporting Types

ListenerAccessLogTracingConfig

TracingEnabled bool
Xtrace Function. Value: True Or False . Default Value: False.
TracingSample int
Xtrace Sampling Rate. Value: 1 to 10000.
TracingType string
Xtrace Type Value Is Zipkin.
TracingEnabled bool
Xtrace Function. Value: True Or False . Default Value: False.
TracingSample int
Xtrace Sampling Rate. Value: 1 to 10000.
TracingType string
Xtrace Type Value Is Zipkin.
tracingEnabled boolean
Xtrace Function. Value: True Or False . Default Value: False.
tracingSample number
Xtrace Sampling Rate. Value: 1 to 10000.
tracingType string
Xtrace Type Value Is Zipkin.
tracing_enabled bool
Xtrace Function. Value: True Or False . Default Value: False.
tracing_sample int
Xtrace Sampling Rate. Value: 1 to 10000.
tracing_type str
Xtrace Type Value Is Zipkin.

ListenerAclConfig

AclRelations List<Pulumi.AliCloud.Alb.Inputs.ListenerAclConfigAclRelation>
The ACLs that are associated with the listener.
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.
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.
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.
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.

ListenerAclConfigAclRelation

AclId string
Snooping Binding of the Access Policy Group ID List.
Status string
The state of the listener. Valid Values: Running Or Stopped. Valid values: Running: The listener is running. Stopped: The listener is stopped.
AclId string
Snooping Binding of the Access Policy Group ID List.
Status string
The state of the listener. Valid Values: Running Or Stopped. Valid values: Running: The listener is running. Stopped: The listener is stopped.
aclId string
Snooping Binding of the Access Policy Group ID List.
status string
The state of the listener. Valid Values: Running Or Stopped. Valid values: Running: The listener is running. Stopped: The listener is stopped.
acl_id str
Snooping Binding of the Access Policy Group ID List.
status str
The state of the listener. Valid Values: Running Or Stopped. Valid values: Running: The listener is running. Stopped: The listener is stopped.

ListenerCertificate

CertificateId string
The ID of the Certificate.
CertificateId string
The ID of the Certificate.
certificateId string
The ID of the Certificate.
certificate_id str
The ID of the Certificate.

ListenerDefaultAction

ForwardGroupConfig Pulumi.AliCloud.Alb.Inputs.ListenerDefaultActionForwardGroupConfig
The configurations of the actions. This parameter is required if Type is set to FowardGroup.
Type string
Action Type.
ForwardGroupConfig ListenerDefaultActionForwardGroupConfig
The configurations of the actions. This parameter is required if Type is set to FowardGroup.
Type string
Action Type.
forwardGroupConfig ListenerDefaultActionForwardGroupConfig
The configurations of the actions. This parameter is required if Type is set to FowardGroup.
type string
Action Type.
forward_group_config ListenerDefaultActionForwardGroupConfig
The configurations of the actions. This parameter is required if Type is set to FowardGroup.
type str
Action Type.

ListenerDefaultActionForwardGroupConfig

ServerGroupTuples []ListenerDefaultActionForwardGroupConfigServerGroupTuple
The destination server group to which requests are forwarded.
serverGroupTuples ListenerDefaultActionForwardGroupConfigServerGroupTuple[]
The destination server group to which requests are forwarded.
server_group_tuples Sequence[ListenerDefaultActionForwardGroupConfigServerGroupTuple]
The destination server group to which requests are forwarded.

ListenerDefaultActionForwardGroupConfigServerGroupTuple

ServerGroupId string
The ID of the destination server group to which requests are forwarded.
ServerGroupId string
The ID of the destination server group to which requests are forwarded.
serverGroupId string
The ID of the destination server group to which requests are forwarded.
server_group_id str
The ID of the destination server group to which requests are forwarded.

ListenerQuicConfig

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.
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.

ListenerXforwardedForConfig

XforwardedforclientcertIssuerdnalias string
The Custom Header Field Names Only When xforwardedforclientcert_issuerdnenabled, 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.
Xforwardedforclientcertclientverifyalias string
The Custom Header Field Names Only When xforwardedforclientcertclientverifyenabled 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.
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.The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits.
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.
Xforwardedforclientcertsubjectdnalias string
The name of the custom header. This parameter is valid only if xforwardedforclientcertsubjectdnenabled is set to true. The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits.
Xforwardedforclientcertsubjectdnenabled bool
Specifies whether to use the X-Forwarded-Clientcert-subjectdn header field to obtain information about the owner of the ALB client certificate. Valid values: true and false. Default value: false.
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.
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.
XforwardedforclientcertIssuerdnalias string
The Custom Header Field Names Only When xforwardedforclientcert_issuerdnenabled, 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.
Xforwardedforclientcertclientverifyalias string
The Custom Header Field Names Only When xforwardedforclientcertclientverifyenabled 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.
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.The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits.
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.
Xforwardedforclientcertsubjectdnalias string
The name of the custom header. This parameter is valid only if xforwardedforclientcertsubjectdnenabled is set to true. The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits.
Xforwardedforclientcertsubjectdnenabled bool
Specifies whether to use the X-Forwarded-Clientcert-subjectdn header field to obtain information about the owner of the ALB client certificate. Valid values: true and false. Default value: false.
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.
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.
xforwardedforclientcertIssuerdnalias string
The Custom Header Field Names Only When xforwardedforclientcert_issuerdnenabled, 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.
xforwardedforclientcertclientverifyalias string
The Custom Header Field Names Only When xforwardedforclientcertclientverifyenabled 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.
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.The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits.
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.
xforwardedforclientcertsubjectdnalias string
The name of the custom header. This parameter is valid only if xforwardedforclientcertsubjectdnenabled is set to true. The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits.
xforwardedforclientcertsubjectdnenabled boolean
Specifies whether to use the X-Forwarded-Clientcert-subjectdn header field to obtain information about the owner of the ALB client certificate. Valid values: true and false. Default value: false.
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.
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.
xforwardedforclientcert_issuerdnalias str
The Custom Header Field Names Only When xforwardedforclientcert_issuerdnenabled, Which Evaluates to True When the Entry into Force of.
xforwardedforclientcert_issuerdnenabled 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.
xforwardedforclientcertclientverifyalias str
The Custom Header Field Names Only When xforwardedforclientcertclientverifyenabled 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.
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 str
The Custom Header Field Names Only When xforwardedforclientcertfingerprintenabled, 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.
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.
xforwardedforclientcertsubjectdnalias str
The name of the custom header. This parameter is valid only if xforwardedforclientcertsubjectdnenabled is set to true. The name must be 1 to 40 characters in length, and can contain letters, hyphens (-), underscores (_), and digits.
xforwardedforclientcertsubjectdnenabled bool
Specifies whether to use the X-Forwarded-Clientcert-subjectdn header field to obtain information about the owner of the ALB client certificate. Valid values: true and false. Default value: false.
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.
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.

Import

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

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

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.