Listener

• Implements: IListener

This class encapsulates and extends the ROS resource type ALIYUN::GA::ListenerCreates a listener for a Global Accelerator (GA) instance.

Initializers

import com.aliyun.ros.cdk.ga.Listener;
Listener.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .acceleratorId(java.lang.String)
    .acceleratorId(IResolvable)
    .portRanges(IResolvable)
    .portRanges(java.util.List<IResolvable)
    .portRanges(PortRangesProperty>)
    .protocol(java.lang.String)
    .protocol(IResolvable)
//  .certificates(IResolvable)
//  .certificates(java.util.List<IResolvable)
//  .certificates(CertificatesProperty>)
//  .clientAffinity(java.lang.String)
//  .clientAffinity(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .httpVersion(java.lang.String)
//  .httpVersion(IResolvable)
//  .idleTimeout(java.lang.Number)
//  .idleTimeout(IResolvable)
//  .name(java.lang.String)
//  .name(IResolvable)
//  .proxyProtocol(java.lang.Boolean)
//  .proxyProtocol(IResolvable)
//  .requestTimeout(java.lang.Number)
//  .requestTimeout(IResolvable)
//  .securityPolicyId(java.lang.String)
//  .securityPolicyId(IResolvable)
//  .type(java.lang.String)
//  .type(IResolvable)
//  .xForwardedForConfig(IResolvable)
//  .xForwardedForConfig(XForwardedForConfigProperty)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

acceleratorId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

portRanges^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListPortRangesProperty>

Property portRanges:.

protocol^Required

• Type: java.lang.String OR com.aliyun.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.

certificates^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListCertificatesProperty>

Property certificates:.

clientAffinity^Optional

• Type: java.lang.String OR com.aliyun.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.

description^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: The description of the listener.

httpVersion^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property httpVersion: The maximum version of the HTTP protocol.

Valid values: http1.1 http2 http3 Note Only HTTPS listeners support this parameter.

idleTimeout^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property idleTimeout: The connection idle timeout period.

Unit: seconds. Valid values: TCP listener: 10 to 900 UDP listener: 10 to 20 HTTP or HTTPS listener: 1 to 60 Note Only listeners support this parameter.

name^Optional

• Type: java.lang.String OR com.aliyun.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.

proxyProtocol^Optional

• Type: java.lang.Boolean OR com.aliyun.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.

requestTimeout^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property requestTimeout: The HTTP request timeout period.

Unit: seconds. Valid values: 1 to 180. Default value: 60. Note Only HTTP and HTTPS listeners support this parameter.

securityPolicyId^Optional

• Type: java.lang.String OR com.aliyun.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.

type^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property type: The listener routing type.

Valid values: Standard: the standard routing type CustomRouting: the custom routing type

xForwardedForConfig^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR XForwardedForConfigProperty

Property xForwardedForConfig: The configuration of the XForward field.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.ga.Listener;
Listener.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrListenerId^Required

public java.lang.Object getAttrListenerId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ListenerId: The ID of the listener.

props^Required

public ListenerProps getProps();

• Type: ListenerProps