Skip to content

RosLoadBalancer

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

Initializers

import com.aliyun.ros.cdk.slb.RosLoadBalancer;
RosLoadBalancer.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .addressIpVersion(java.lang.String)
//  .addressIpVersion(IResolvable)
//  .addressType(java.lang.String)
//  .addressType(IResolvable)
//  .autoPay(java.lang.Boolean)
//  .autoPay(IResolvable)
//  .autoRenew(java.lang.Boolean)
//  .autoRenew(IResolvable)
//  .autoRenewPeriod(java.lang.Number)
//  .autoRenewPeriod(IResolvable)
//  .bandwidth(java.lang.Number)
//  .bandwidth(IResolvable)
//  .deletionProtection(java.lang.Boolean)
//  .deletionProtection(IResolvable)
//  .duration(java.lang.Number)
//  .duration(IResolvable)
//  .instanceChargeType(java.lang.String)
//  .instanceChargeType(IResolvable)
//  .internetChargeType(java.lang.String)
//  .internetChargeType(IResolvable)
//  .loadBalancerName(java.lang.String)
//  .loadBalancerName(IResolvable)
//  .loadBalancerSpec(java.lang.String)
//  .loadBalancerSpec(IResolvable)
//  .masterZoneId(java.lang.String)
//  .masterZoneId(IResolvable)
//  .modificationProtectionReason(java.lang.String)
//  .modificationProtectionReason(IResolvable)
//  .modificationProtectionStatus(java.lang.String)
//  .modificationProtectionStatus(IResolvable)
//  .payType(java.lang.String)
//  .payType(IResolvable)
//  .pricingCycle(java.lang.String)
//  .pricingCycle(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .slaveZoneId(java.lang.String)
//  .slaveZoneId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(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.
addressIpVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
addressType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
autoPay java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
autoRenew java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
autoRenewPeriod java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
bandwidth java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
deletionProtection java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
duration java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
instanceChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
internetChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
loadBalancerName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
loadBalancerSpec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
masterZoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
modificationProtectionReason java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
modificationProtectionStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
payType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
pricingCycle java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
slaveZoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
tags java.util.List<TagsProperty> No description.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
vSwitchId 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

addressIpVersionOptional

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

addressTypeOptional

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

autoPayOptional

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

autoRenewOptional

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

autoRenewPeriodOptional

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

bandwidthOptional

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

deletionProtectionOptional

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

durationOptional

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

instanceChargeTypeOptional

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

internetChargeTypeOptional

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

loadBalancerNameOptional

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

loadBalancerSpecOptional

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

masterZoneIdOptional

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

modificationProtectionReasonOptional

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

modificationProtectionStatusOptional

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

payTypeOptional

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

pricingCycleOptional

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

resourceGroupIdOptional

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

slaveZoneIdOptional

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

tagsOptional


vpcIdOptional

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

vSwitchIdOptional

  • 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.RosLoadBalancer;
RosLoadBalancer.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.RosLoadBalancer;
RosLoadBalancer.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.RosLoadBalancer;
RosLoadBalancer.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.
attrAddressIpVersion com.aliyun.ros.cdk.core.IResolvable No description.
attrAddressType com.aliyun.ros.cdk.core.IResolvable No description.
attrBandwidth com.aliyun.ros.cdk.core.IResolvable No description.
attrIpAddress com.aliyun.ros.cdk.core.IResolvable No description.
attrLoadBalancerId com.aliyun.ros.cdk.core.IResolvable No description.
attrLoadBalancerName com.aliyun.ros.cdk.core.IResolvable No description.
attrLoadBalancerSpec com.aliyun.ros.cdk.core.IResolvable No description.
attrMasterZoneId com.aliyun.ros.cdk.core.IResolvable No description.
attrNetworkType com.aliyun.ros.cdk.core.IResolvable No description.
attrOrderId com.aliyun.ros.cdk.core.IResolvable No description.
attrPayType com.aliyun.ros.cdk.core.IResolvable No description.
attrResourceGroupId com.aliyun.ros.cdk.core.IResolvable No description.
attrSlaveZoneId com.aliyun.ros.cdk.core.IResolvable No description.
attrVpcId com.aliyun.ros.cdk.core.IResolvable No description.
attrVSwitchId com.aliyun.ros.cdk.core.IResolvable No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
addressIpVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
addressType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
autoPay java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
autoRenew java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
autoRenewPeriod java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
bandwidth java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
deletionProtection java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
duration java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
instanceChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
internetChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
loadBalancerName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
loadBalancerSpec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
masterZoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
modificationProtectionReason java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
modificationProtectionStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
payType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
pricingCycle java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
slaveZoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
tags java.util.List<TagsProperty> No description.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
vSwitchId 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.


attrAddressIpVersionRequired

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

attrAddressTypeRequired

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

attrBandwidthRequired

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

attrIpAddressRequired

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

attrLoadBalancerIdRequired

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

attrLoadBalancerNameRequired

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

attrLoadBalancerSpecRequired

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

attrMasterZoneIdRequired

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

attrNetworkTypeRequired

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

attrOrderIdRequired

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

attrPayTypeRequired

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

attrResourceGroupIdRequired

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

attrSlaveZoneIdRequired

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

attrVpcIdRequired

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

attrVSwitchIdRequired

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

enableResourcePropertyConstraintRequired

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

addressIpVersionOptional

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

addressTypeOptional

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

autoPayOptional

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

autoRenewOptional

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

autoRenewPeriodOptional

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

bandwidthOptional

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

deletionProtectionOptional

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

durationOptional

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

instanceChargeTypeOptional

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

internetChargeTypeOptional

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

loadBalancerNameOptional

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

loadBalancerSpecOptional

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

masterZoneIdOptional

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

modificationProtectionReasonOptional

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

modificationProtectionStatusOptional

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

payTypeOptional

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

pricingCycleOptional

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

resourceGroupIdOptional

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

slaveZoneIdOptional

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

tagsOptional

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

vpcIdOptional

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

vSwitchIdOptional

public java.lang.Object getVSwitchId();
  • 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.