Skip to content

Listener

This class encapsulates and extends the ROS resource type ALIYUN::GA::Listener, which is used to create a listener for a Global Accelerator (GA) instance.

Initializers 

import ros_cdk_ga
ros_cdk_ga.Listener(
  scope: Construct,
  id: str,
  accelerator_id: typing.Union[str, IResolvable],
  port_ranges: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, PortRangesProperty]]],
  protocol: typing.Union[str, IResolvable],
  certificates: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, CertificatesProperty]]] = None,
  client_affinity: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  proxy_protocol: typing.Union[bool, 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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
accelerator_id typing.Union[str, ros_cdk_core.IResolvable] Property acceleratorId: The ID of the Global Accelerator instance to which the listener will be added.
port_ranges typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, PortRangesProperty]]] Property portRanges:.
protocol typing.Union[str, ros_cdk_core.IResolvable] Property protocol: The network transmission protocol of the listener.
certificates typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, CertificatesProperty]]] Property certificates:.
client_affinity typing.Union[str, ros_cdk_core.IResolvable] Property clientAffinity: Specifies whether to enable client affinity for the listener.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the listener.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The name of the listener.
proxy_protocol typing.Union[bool, ros_cdk_core.IResolvable] Property proxyProtocol: Specifies whether to preserve client IP addresses.
security_policy_id typing.Union[str, ros_cdk_core.IResolvable] Property securityPolicyId: The ID of the security policy.
x_forwarded_for_config typing.Union[ros_cdk_core.IResolvable, XForwardedForConfigProperty] Property xForwardedForConfig: The configuration of the XForward field.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

accelerator_idRequired

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

Property acceleratorId: The ID of the Global Accelerator instance to which the listener will be added.

port_rangesRequired

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

Property portRanges:.

protocolRequired

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

Property protocol: The network transmission protocol of the listener.

Valid values: tcp: TCP protocol udp: UDP protocol http: HTTP protocolhttps: HTTPS protocol.

certificatesOptional

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

Property certificates:.

client_affinityOptional

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

Property clientAffinity: Specifies whether to enable client affinity for the listener.

If you do not specify the default value in the parameter, client affinity is disabled. When client affinity is disabled, the connections from a specific source (client) IP address are not always routed to the same endpoint. If you set the value to SOURCE_IP, client affinity is enabled. When client affinity is enabled, the connections from a specific source (client) IP address are always routed to the same endpoint.

descriptionOptional

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

Property description: The description of the listener.

nameOptional

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

Property name: The name of the listener.

The name must be 2 to 128 characters in length and can contain letters, digits, underscores (_), and hyphens (-). It must start with a letter or Chinese character.

proxy_protocolOptional

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

Property proxyProtocol: Specifies whether to preserve client IP addresses.

Valid values: true: preserves client IP addresses. After this feature is enabled, backend servers can retrieve client IP addresses. false (default): does not preserve client IP addresses.

security_policy_idOptional

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

Property securityPolicyId: The ID of the security policy.

Valid values: tls_cipher_policy_1_0 tls_cipher_policy_1_1 tls_cipher_policy_1_2 tls_cipher_policy_1_2_strict tls_cipher_policy_1_2_strict_with_1_3 Note Only HTTPS listeners support this parameter.

x_forwarded_for_configOptional

Property xForwardedForConfig: The configuration of the XForward field.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

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

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_listener_id ros_cdk_core.IResolvable Attribute ListenerId: The ID of the listener.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_listener_idRequired 

attr_listener_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ListenerId: The ID of the listener.