Listener
- Implements: IListener
This class encapsulates and extends the ROS resource type ALIYUN::GWLB::Listener.
Initializers
import com.aliyun.ros.cdk.gwlb.Listener;
Listener.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.loadBalancerId(java.lang.String)
.loadBalancerId(IResolvable)
.serverGroupId(java.lang.String)
.serverGroupId(IResolvable)
// .listenerDescription(java.lang.String)
// .listenerDescription(IResolvable)
// .tags(java.util.List<TagsProperty>)
.build();
| Name | Type | Description |
|---|---|---|
scope | com.aliyun.ros.cdk.core.Construct | No description. |
id | java.lang.String | No description. |
enableResourcePropertyConstraint | java.lang.Boolean | No description. |
loadBalancerId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property loadBalancerId: The ID of the gateway load balancer instance. |
serverGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property serverGroupId: The ID of the server group. |
listenerDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property listenerDescription: The custom listener description. |
tags | java.util.List<TagsProperty> | Property tags: Tags of listener. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
loadBalancerIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property loadBalancerId: The ID of the gateway load balancer instance.
serverGroupIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property serverGroupId: The ID of the server group.
listenerDescriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property listenerDescription: The custom listener description.
The length is limited to 2 to 256 characters. It supports Chinese and English letters and can contain numbers, half-width commas (,), half-width periods (.), half-width semicolons (;), forward slashes (/), at(@), underscores (_), and dashes (-).
tagsOptional
- Type: java.util.List<TagsProperty>
Property tags: Tags of listener.
Methods
| Name | Description |
|---|---|
toString | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
addCondition | No description. |
addCount | No description. |
addDependency | No description. |
addResourceDesc | No description. |
applyRemovalPolicy | No description. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | No description. |
getAtt | No description. |
setMetadata | No description. |
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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- 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)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.gwlb.Listener;
Listener.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
ref | java.lang.String | No description. |
stack | com.aliyun.ros.cdk.core.Stack | The stack in which this resource is defined. |
resource | com.aliyun.ros.cdk.core.RosResource | No description. |
attrListenerDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ListenerDescription: The custom listener description. |
attrListenerId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ListenerId: The ID of listener. |
attrLoadBalancerId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute LoadBalancerId: The ID of the gateway load balancer instance. |
attrServerGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ServerGroupId: The ID of the server group. |
attrTags | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Tags: The list of tags. |
props | ListenerProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
refRequired
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrListenerDescriptionRequired
public java.lang.Object getAttrListenerDescription();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ListenerDescription: The custom listener description.
attrListenerIdRequired
public java.lang.Object getAttrListenerId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ListenerId: The ID of listener.
attrLoadBalancerIdRequired
public java.lang.Object getAttrLoadBalancerId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute LoadBalancerId: The ID of the gateway load balancer instance.
attrServerGroupIdRequired
public java.lang.Object getAttrServerGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ServerGroupId: The ID of the server group.
attrTagsRequired
public java.lang.Object getAttrTags();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Tags: The list of tags.
propsRequired
public ListenerProps getProps();
- Type: ListenerProps