Skip to content

RosListener

This class is a base encapsulation around the ROS resource type ALIYUN::SLB::Listener, which is used to create a Server Load Balancer (SLB) listener.

Initializers

import com.aliyun.ros.cdk.slb.RosListener;
RosListener.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .bandwidth(java.lang.Number)
    .bandwidth(IResolvable)
    .listenerPort(java.lang.Number)
    .listenerPort(IResolvable)
    .loadBalancerId(java.lang.String)
    .loadBalancerId(IResolvable)
    .protocol(java.lang.String)
    .protocol(IResolvable)
//  .aclId(java.lang.String)
//  .aclId(IResolvable)
//  .aclIds(IResolvable)
//  .aclIds(java.util.List<java.lang.String)
//  .aclIds(IResolvable>)
//  .aclStatus(java.lang.String)
//  .aclStatus(IResolvable)
//  .aclType(java.lang.String)
//  .aclType(IResolvable)
//  .backendServerPort(java.lang.Number)
//  .backendServerPort(IResolvable)
//  .caCertificateId(java.lang.String)
//  .caCertificateId(IResolvable)
//  .connectionDrain(java.lang.String)
//  .connectionDrain(IResolvable)
//  .connectionDrainTimeout(java.lang.Number)
//  .connectionDrainTimeout(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .enableHttp2(java.lang.String)
//  .enableHttp2(IResolvable)
//  .gzip(java.lang.String)
//  .gzip(IResolvable)
//  .healthCheck(IResolvable)
//  .healthCheck(HealthCheckProperty)
//  .httpConfig(IResolvable)
//  .httpConfig(HttpConfigProperty)
//  .idleTimeout(java.lang.Number)
//  .idleTimeout(IResolvable)
//  .masterSlaveServerGroupId(java.lang.String)
//  .masterSlaveServerGroupId(IResolvable)
//  .persistence(IResolvable)
//  .persistence(PersistenceProperty)
//  .portRange(IResolvable)
//  .portRange(java.util.List<IResolvable)
//  .portRange(PortRangeProperty>)
//  .proxyProtocolV2Enabled(java.lang.Boolean)
//  .proxyProtocolV2Enabled(IResolvable)
//  .requestTimeout(java.lang.Number)
//  .requestTimeout(IResolvable)
//  .scheduler(java.lang.String)
//  .scheduler(IResolvable)
//  .serverCertificateId(java.lang.String)
//  .serverCertificateId(IResolvable)
//  .startListener(java.lang.Boolean)
//  .startListener(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .tlsCipherPolicy(java.lang.String)
//  .tlsCipherPolicy(IResolvable)
//  .vServerGroupId(java.lang.String)
//  .vServerGroupId(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct - scope in which this resource is defined.
id java.lang.String - scoped id of the resource.
enableResourcePropertyConstraint java.lang.Boolean No description.
bandwidth java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
listenerPort java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
loadBalancerId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
protocol java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
aclId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
aclIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List No description.
aclStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
aclType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
backendServerPort java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
caCertificateId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
connectionDrain java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
connectionDrainTimeout java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
enableHttp2 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
gzip java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
healthCheck com.aliyun.ros.cdk.core.IResolvable OR HealthCheckProperty No description.
httpConfig com.aliyun.ros.cdk.core.IResolvable OR HttpConfigProperty No description.
idleTimeout java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
masterSlaveServerGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
persistence com.aliyun.ros.cdk.core.IResolvable OR PersistenceProperty No description.
portRange com.aliyun.ros.cdk.core.IResolvable OR java.util.ListPortRangeProperty> No description.
proxyProtocolV2Enabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
requestTimeout java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
scheduler java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
serverCertificateId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
startListener java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
tags java.util.List<TagsProperty> No description.
tlsCipherPolicy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
vServerGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.

scopeRequired

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

scope in which this resource is defined.


idRequired

  • Type: java.lang.String

scoped id of the resource.


enableResourcePropertyConstraintRequired

  • Type: java.lang.Boolean

bandwidthRequired

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

listenerPortRequired

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

loadBalancerIdRequired

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

protocolRequired

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

aclIdOptional

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

aclIdsOptional

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

aclStatusOptional

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

aclTypeOptional

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

backendServerPortOptional

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

caCertificateIdOptional

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

connectionDrainOptional

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

connectionDrainTimeoutOptional

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

descriptionOptional

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

enableHttp2Optional

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

gzipOptional

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

healthCheckOptional


httpConfigOptional


idleTimeoutOptional

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

masterSlaveServerGroupIdOptional

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

persistenceOptional


portRangeOptional

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

proxyProtocolV2EnabledOptional

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

requestTimeoutOptional

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

schedulerOptional

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

serverCertificateIdOptional

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

startListenerOptional

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

tagsOptional


tlsCipherPolicyOptional

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

vServerGroupIdOptional

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

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
addCondition No description.
addCount No description.
addDeletionOverride Syntactic sugar for addOverride(path, undefined).
addDependsOn Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDesc No description.
addMetaData No description.
addOverride Adds an override to the synthesized ROS resource.
addPropertyDeletionOverride Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride Adds an override to a resource property.
addRosDependency No description.
applyRemovalPolicy Sets the deletion policy of the resource based on the removal policy specified.
getAtt Returns a token for an runtime attribute of this resource.

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.

sessionRequired

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

The synthesis session.


overrideLogicalId

public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired

  • Type: java.lang.String

The new logical ID to use for this stack element.


addCondition

public void addCondition(RosCondition con)

conRequired

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

addCount

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

countRequired

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

addDeletionOverride

public void addDeletionOverride(java.lang.String path)

Syntactic sugar for addOverride(path, undefined).

pathRequired

  • Type: java.lang.String

The path of the value to delete.


addDependsOn

public void addDependsOn(RosResource target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

targetRequired

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

addDesc

public void addDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

addMetaData

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

addOverride

public void addOverride(java.lang.String path, java.lang.Object value)

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

pathRequired

  • Type: java.lang.String

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.


valueRequired

  • Type: java.lang.Object

The value.

Could be primitive or complex.


addPropertyDeletionOverride

public void addPropertyDeletionOverride(java.lang.String propertyPath)

Adds an override that deletes the value of a property from the resource definition.

propertyPathRequired

  • Type: java.lang.String

The path to the property.


addPropertyOverride

public void addPropertyOverride(java.lang.String propertyPath, java.lang.Object value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

propertyPathRequired

  • Type: java.lang.String

The path of the property.


valueRequired

  • Type: java.lang.Object

The value.


addRosDependency

public void addRosDependency(java.lang.String target)

targetRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy()
public void applyRemovalPolicy(RemovalPolicy policy)
public void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)

Sets the deletion policy of the resource based on the removal policy specified.

policyOptional

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

optionsOptional

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

getAtt

public Reference getAtt(java.lang.String attributeName)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

attributeNameRequired

  • Type: java.lang.String

The name of the attribute.


Static Functions

Name Description
isConstruct Return whether the given object is a Construct.
isRosElement Returns true if a construct is a stack element (i.e. part of the synthesized template).
isRosResource Check whether the given construct is a RosResource.

isConstruct

import com.aliyun.ros.cdk.slb.RosListener;
RosListener.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

isRosElement

import com.aliyun.ros.cdk.slb.RosListener;
RosListener.isRosElement(java.lang.Object x)

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

xRequired

  • Type: java.lang.Object

isRosResource

import com.aliyun.ros.cdk.slb.RosListener;
RosListener.isRosResource(IConstruct construct)

Check whether the given construct is a RosResource.

constructRequired

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

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
creationStack java.util.List No description.
logicalId java.lang.String The logical ID for this stack element.
stack com.aliyun.ros.cdk.core.Stack The stack in which this element is defined.
ref java.lang.String Return a string that will be resolved to a RosTemplate { Ref } for this element.
rosOptions com.aliyun.ros.cdk.core.IRosResourceOptions Options for this resource, such as condition, update policy etc.
rosResourceType java.lang.String ROS resource type.
attrListenerPortsAndProtocol com.aliyun.ros.cdk.core.IResolvable No description.
attrLoadBalancerId com.aliyun.ros.cdk.core.IResolvable No description.
bandwidth java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
listenerPort java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
loadBalancerId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
protocol java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
aclId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
aclIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List No description.
aclStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
aclType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
backendServerPort java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
caCertificateId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
connectionDrain java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
connectionDrainTimeout java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
enableHttp2 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
gzip java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
healthCheck com.aliyun.ros.cdk.core.IResolvable OR HealthCheckProperty No description.
httpConfig com.aliyun.ros.cdk.core.IResolvable OR HttpConfigProperty No description.
idleTimeout java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
masterSlaveServerGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
persistence com.aliyun.ros.cdk.core.IResolvable OR PersistenceProperty No description.
portRange com.aliyun.ros.cdk.core.IResolvable OR java.util.ListPortRangeProperty> No description.
proxyProtocolV2Enabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
requestTimeout java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
scheduler java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
serverCertificateId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
startListener java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
tags java.util.List<TagsProperty> No description.
tlsCipherPolicy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
vServerGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


creationStackRequired

public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List

logicalIdRequired

public java.lang.String getLogicalId();
  • Type: java.lang.String

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).


stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).


refRequired

public java.lang.String getRef();
  • Type: java.lang.String

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).


rosOptionsRequired

public IRosResourceOptions getRosOptions();
  • Type: com.aliyun.ros.cdk.core.IRosResourceOptions

Options for this resource, such as condition, update policy etc.


rosResourceTypeRequired

public java.lang.String getRosResourceType();
  • Type: java.lang.String

ROS resource type.


attrListenerPortsAndProtocolRequired

public IResolvable getAttrListenerPortsAndProtocol();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrLoadBalancerIdRequired

public IResolvable getAttrLoadBalancerId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

bandwidthRequired

public java.lang.Object getBandwidth();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

enableResourcePropertyConstraintRequired

public java.lang.Boolean getEnableResourcePropertyConstraint();
  • Type: java.lang.Boolean

listenerPortRequired

public java.lang.Object getListenerPort();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

loadBalancerIdRequired

public java.lang.Object getLoadBalancerId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

protocolRequired

public java.lang.Object getProtocol();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

aclIdOptional

public java.lang.Object getAclId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

aclIdsOptional

public java.lang.Object getAclIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

aclStatusOptional

public java.lang.Object getAclStatus();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

aclTypeOptional

public java.lang.Object getAclType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

backendServerPortOptional

public java.lang.Object getBackendServerPort();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

caCertificateIdOptional

public java.lang.Object getCaCertificateId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

connectionDrainOptional

public java.lang.Object getConnectionDrain();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

connectionDrainTimeoutOptional

public java.lang.Object getConnectionDrainTimeout();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

descriptionOptional

public java.lang.Object getDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

enableHttp2Optional

public java.lang.Object getEnableHttp2();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

gzipOptional

public java.lang.Object getGzip();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

healthCheckOptional

public java.lang.Object getHealthCheck();

httpConfigOptional

public java.lang.Object getHttpConfig();

idleTimeoutOptional

public java.lang.Object getIdleTimeout();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

masterSlaveServerGroupIdOptional

public java.lang.Object getMasterSlaveServerGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

persistenceOptional

public java.lang.Object getPersistence();

portRangeOptional

public java.lang.Object getPortRange();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListPortRangeProperty>

proxyProtocolV2EnabledOptional

public java.lang.Object getProxyProtocolV2Enabled();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

requestTimeoutOptional

public java.lang.Object getRequestTimeout();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

schedulerOptional

public java.lang.Object getScheduler();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

serverCertificateIdOptional

public java.lang.Object getServerCertificateId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

startListenerOptional

public java.lang.Object getStartListener();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

tagsOptional

public java.util.List<TagsProperty> getTags();

tlsCipherPolicyOptional

public java.lang.Object getTlsCipherPolicy();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

vServerGroupIdOptional

public java.lang.Object getVServerGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Constants

Name Type Description
ROS_RESOURCE_TYPE_NAME java.lang.String The resource type name for this resource class.

ROS_RESOURCE_TYPE_NAMERequired

public java.lang.String getRosResourceTypeName();
  • Type: java.lang.String

The resource type name for this resource class.