Listener

• Implements: IListener

This class encapsulates and extends the ROS resource type ALIYUN::ALB::Listener.

Initializers

import ros_cdk_alb
ros_cdk_alb.Listener(
  scope: Construct,
  id: str,
  default_actions: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, DefaultActionsProperty]]],
  listener_port: typing.Union[typing.Union[int, float], IResolvable],
  listener_protocol: typing.Union[str, IResolvable],
  load_balancer_id: typing.Union[str, IResolvable],
  ca_certificates: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, CaCertificatesProperty]]] = None,
  ca_enabled: typing.Union[bool, IResolvable] = None,
  certificates: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, CertificatesProperty]]] = None,
  gzip_enabled: typing.Union[bool, IResolvable] = None,
  http2_enabled: typing.Union[bool, IResolvable] = None,
  idle_timeout: typing.Union[typing.Union[int, float], IResolvable] = None,
  listener_description: typing.Union[str, IResolvable] = None,
  listener_status: typing.Union[str, IResolvable] = None,
  log_config: typing.Union[IResolvable, LogConfigProperty] = None,
  quic_config: typing.Union[IResolvable, QuicConfigProperty] = None,
  request_timeout: typing.Union[typing.Union[int, float], IResolvable] = None,
  security_policy_id: typing.Union[str, IResolvable] = None,
  x_forwarded_for_config: typing.Union[IResolvable, XForwardedForConfigProperty] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

default_actions^Required

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DefaultActionsProperty]]]

Property defaultActions: The default actions for the listener.

listener_port^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property listenerPort: The frontend port that is used by the ALB instance.

Valid values: 1 to 65535.

listener_protocol^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property listenerProtocol: The listener protocol.

Valid values: HTTP, HTTPS, and QUIC.

load_balancer_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property loadBalancerId: The ID of the ALB instance.

ca_certificates^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, CaCertificatesProperty]]]

Property caCertificates: A list of CA certificates for the listener.

Only one CA certificate is supported.

ca_enabled^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property caEnabled: Specifies whether to enable mutual authentication.

Default false.

certificates^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, CertificatesProperty]]]

Property certificates: A list of server certificates.

gzip_enabled^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property gzipEnabled: Specifies whether to enable gzip compression to compress files of a specific type.

Valid values: true and false. Default value: true.

http2_enabled^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property http2Enabled: Specifies whether to enable HTTP\/2.

Default value: on. Valid values: true and false. Default value: true. Note: Only HTTPS listeners support this parameter.

idle_timeout^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property idleTimeout: The idle timeout in seconds.

Valid values: 1 to 600. Default value: 15. If no requests are received on a connection within the idle timeout, the load balancer closes the connection. A new connection is established for the next request.

You can request a quota increase to a maximum of 3,600 seconds.

listener_description^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property listenerDescription: A custom name for the listener.

The name must be 2 to 256 characters long and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), underscores (_), and Chinese characters.

listener_status^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property listenerStatus: The status of the listener.

log_config^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, LogConfigProperty]

Property logConfig: The configuration information about the access log.

quic_config^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, QuicConfigProperty]

Property quicConfig: Select a QUIC listener and associate it with the ALB instance.

request_timeout^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property requestTimeout: The request timeout in seconds.

Valid values: 1 to 600. Default value: 60. If a backend server does not respond within the timeout period, the load balancer returns an HTTP 504 error to the client.

You can request a quota increase to a maximum of 3,600 seconds.

security_policy_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property securityPolicyId: The ID of the security policy.

System security policies and custom security policies are supported. Default value: tls_cipher_policy_1_0. This value indicates a system security policy. Note: Only HTTPS listeners support this parameter.

x_forwarded_for_config^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, XForwardedForConfigProperty]

Property xForwardedForConfig: The configuration of X-Forwarded-* headers.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_alb
ros_cdk_alb.Listener.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_listener_id^Required

attr_listener_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ListenerId: The ID of the listener.

attr_load_balancer_id^Required

attr_load_balancer_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute LoadBalancerId: The ID of the ALB instance.

props^Required

props: ListenerProps

• Type: ListenerProps