Listener

• Implements: IListener

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

Initializers

import com.aliyun.ros.cdk.nlb.Listener;
Listener.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .listenerPort(java.lang.Number)
    .listenerPort(IResolvable)
    .listenerProtocol(java.lang.String)
    .listenerProtocol(IResolvable)
    .loadBalancerId(java.lang.String)
    .loadBalancerId(IResolvable)
//  .alpnEnabled(java.lang.Boolean)
//  .alpnEnabled(IResolvable)
//  .alpnPolicy(java.lang.String)
//  .alpnPolicy(IResolvable)
//  .caCertificateIds(IResolvable)
//  .caCertificateIds(java.util.List<java.lang.String)
//  .caCertificateIds(IResolvable>)
//  .caEnabled(java.lang.Boolean)
//  .caEnabled(IResolvable)
//  .certificateIds(IResolvable)
//  .certificateIds(java.util.List<java.lang.String)
//  .certificateIds(IResolvable>)
//  .cps(java.lang.Number)
//  .cps(IResolvable)
//  .enable(java.lang.Boolean)
//  .enable(IResolvable)
//  .endPort(java.lang.Number)
//  .endPort(IResolvable)
//  .idleTimeout(java.lang.Number)
//  .idleTimeout(IResolvable)
//  .listenerDescription(java.lang.String)
//  .listenerDescription(IResolvable)
//  .mss(java.lang.Number)
//  .mss(IResolvable)
//  .proxyProtocolEnabled(java.lang.Boolean)
//  .proxyProtocolEnabled(IResolvable)
//  .proxyProtocolV2Config(IResolvable)
//  .proxyProtocolV2Config(ProxyProtocolV2ConfigProperty)
//  .secSensorEnabled(java.lang.Boolean)
//  .secSensorEnabled(IResolvable)
//  .securityPolicyId(java.lang.String)
//  .securityPolicyId(IResolvable)
//  .serverGroupId(java.lang.String)
//  .serverGroupId(IResolvable)
//  .serverGroupTuples(IResolvable)
//  .serverGroupTuples(java.util.List<IResolvable)
//  .serverGroupTuples(ServerGroupTuplesProperty>)
//  .startPort(java.lang.Number)
//  .startPort(IResolvable)
//  .tags(java.util.List<TagsProperty>)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

listenerPort^Required

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

Property listenerPort: Port of the listener,[0, 65535] the portRange setting need 0.

listenerProtocol^Required

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

Property listenerProtocol: Listening protocol.

Values: TCP, UDP, or TCPSSL.

loadBalancerId^Required

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

Property loadBalancerId: ID of the LoadBalancer.

alpnEnabled^Optional

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

Property alpnEnabled: undefined.

alpnPolicy^Optional

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

Property alpnPolicy: Proxy of alpn.

caCertificateIds^Optional

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

Property caCertificateIds: List of the ca certificate ids.

caEnabled^Optional

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

Property caEnabled: Whether to open CA.

certificateIds^Optional

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

Property certificateIds: List of the certificate ids.

cps^Optional

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

Property cps: New connection rate limit of Instance.

enable^Optional

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

Property enable: Whether to start listener or not.

Default True.

endPort^Optional

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

Property endPort: EndPort of the portRange.

idleTimeout^Optional

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

Property idleTimeout: Specifies the connection idle timeout.

listenerDescription^Optional

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

Property listenerDescription: Description of the listener, [2, 256] characters.

mss^Optional

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

Property mss: Max length of the TCP packet.

proxyProtocolEnabled^Optional

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

Property proxyProtocolEnabled: Whether to enable ppv2 function.

proxyProtocolV2Config^Optional

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

Property proxyProtocolV2Config: ProxyProtocolV2Config of the listener.

secSensorEnabled^Optional

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

Property secSensorEnabled: Whether to enable the second-level monitoring function.

securityPolicyId^Optional

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

Property securityPolicyId: Only valid for TcpSSL protocol monitoring.

serverGroupId^Optional

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

Property serverGroupId: ID of the ServerGroup.

serverGroupTuples^Optional

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

Property serverGroupTuples: Multi-server group list.

When the number of destination server groups is 1, the default value is 100 if no weight is specified. When the number of destination server groups is greater than 1, the user needs to specify the weight value.

startPort^Optional

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

Property startPort: StartPort of the portRange.

tags^Optional

• Type: java.util.List<TagsProperty>

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

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.nlb.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: Id of created Listener.

attrListenerPort^Required

public java.lang.Object getAttrListenerPort();

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

Attribute ListenerPort: ListenerPort of created Listener.

props^Required

public ListenerProps getProps();

• Type: ListenerProps