LoadBalancer
- Implements: ILoadBalancer
This class encapsulates and extends the ROS resource type ALIYUN::GWLB::LoadBalancer.
Initializers
import com.aliyun.ros.cdk.gwlb.LoadBalancer;
LoadBalancer.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.vpcId(java.lang.String)
.vpcId(IResolvable)
.zoneMappings(IResolvable)
.zoneMappings(java.util.List<IResolvable)
.zoneMappings(ZoneMappingsProperty>)
// .addressIpVersion(java.lang.String)
// .addressIpVersion(IResolvable)
// .loadBalancerName(java.lang.String)
// .loadBalancerName(IResolvable)
// .resourceGroupId(java.lang.String)
// .resourceGroupId(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. |
vpcId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property vpcId: The ID of the VPC which the Gateway Load Balancer instance belongs. |
zoneMappings | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property zoneMappings: The List of zones and vSwitches mapped. |
addressIpVersion | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property addressIpVersion: The protocol version. |
loadBalancerName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property loadBalancerName: The name of the Gateway Load Balancer instance. |
resourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property resourceGroupId: The ID of the resource group. |
tags | java.util.List<TagsProperty> | Property tags: Tags of load balancer. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
vpcIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property vpcId: The ID of the VPC which the Gateway Load Balancer instance belongs.
zoneMappingsRequired
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
ZoneMappingsProperty>
Property zoneMappings: The List of zones and vSwitches mapped.
You must add at least one zone and a maximum of 20 zones. If the current region supports two or more zones, we recommend that you add two or more zones.
addressIpVersionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property addressIpVersion: The protocol version.
Value:
- Ipv4: Ipv4 type.
loadBalancerNameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property loadBalancerName: The name of the Gateway Load Balancer instance.
It must be 2 to 128 English or Chinese characters in length. It must start with a letter or a Chinese character and can contain digits, half-width periods (.), underscores (_), and dashes (-).
resourceGroupIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property resourceGroupId: The ID of the resource group.
tagsOptional
- Type: java.util.List<TagsProperty>
Property tags: Tags of load balancer.
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.LoadBalancer;
LoadBalancer.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. |
attrAddressIpVersion | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute AddressIpVersion: The protocol version. |
attrBusinessStatus | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute BusinessStatus: The business status of Gateway Load Balancing. |
attrCreateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: The resource creation time, in Greenwich Mean Time, in the format of yyyy-MM-ddTHH:mm:ssZ. |
attrLoadBalancerId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute LoadBalancerId: The ID of the Gateway Load Balancer instance. |
attrLoadBalancerName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute LoadBalancerName: The name of the Gateway Load Balancer instance. |
attrResourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ResourceGroupId: The ID of the resource group. |
attrTags | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Tags: The list of tags. |
attrVpcId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VpcId: The ID of the VPC which the Gateway Load Balancer instance belongs. |
attrZoneMappings | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ZoneMappings: The List of zones and vSwitches mapped. |
props | LoadBalancerProps | 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
attrAddressIpVersionRequired
public java.lang.Object getAttrAddressIpVersion();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute AddressIpVersion: The protocol version.
attrBusinessStatusRequired
public java.lang.Object getAttrBusinessStatus();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute BusinessStatus: The business status of Gateway Load Balancing.
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The resource creation time, in Greenwich Mean Time, in the format of yyyy-MM-ddTHH:mm:ssZ.
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.
attrLoadBalancerNameRequired
public java.lang.Object getAttrLoadBalancerName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute LoadBalancerName: The name of the Gateway Load Balancer instance.
attrResourceGroupIdRequired
public java.lang.Object getAttrResourceGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ResourceGroupId: The ID of the resource group.
attrTagsRequired
public java.lang.Object getAttrTags();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Tags: The list of tags.
attrVpcIdRequired
public java.lang.Object getAttrVpcId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VpcId: The ID of the VPC which the Gateway Load Balancer instance belongs.
attrZoneMappingsRequired
public java.lang.Object getAttrZoneMappings();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ZoneMappings: The List of zones and vSwitches mapped.
You must add at least one zone and a maximum of 20 zones. If the current region supports two or more zones, we recommend that you add two or more zones.
propsRequired
public LoadBalancerProps getProps();
- Type: LoadBalancerProps