Skip to content

LoadBalancer

  • Implements: com.aliyun.ros.cdk.nlb.datasource.ILoadBalancer

This class encapsulates and extends the ROS resource type DATASOURCE::NLB::LoadBalancer.

Initializers

import com.aliyun.ros.cdk.nlb.datasource.LoadBalancer;
LoadBalancer.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .loadBalancerId(java.lang.String)
//  .loadBalancerId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
    .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: ID of the LoadBalancer.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

loadBalancerIdOptional

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

Property loadBalancerId: ID of the LoadBalancer.


refreshOptionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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.

sessionRequired

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

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • 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

addDependency

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • 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)

nameRequired

  • Type: java.lang.String

setMetadata

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import com.aliyun.ros.cdk.nlb.datasource.LoadBalancer;
LoadBalancer.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • 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.
attrAddressType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AddressType: The IPv4 network type of the NLB instance.
attrBandwidthPackageId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute BandwidthPackageId: The ID of the EIP bandwidth plan.
attrCps java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Cps: The maximum number of new connections per second supported by the NLB instance in each zone (virtual IP address).
attrCreateTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: The time when the NLB instance was created.
attrCrossZoneEnabled java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CrossZoneEnabled: Indicates whether the NLB instance is accessible across zones.
attrDeletionProtectionConfig java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute DeletionProtectionConfig: The configuration of the deletion protection feature.
attrDnsName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute DNSName: The domain name of the NLB instance.
attrIpv6AddressType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Ipv6AddressType: The IPv6 network type of the NLB instance.
attrLoadBalancerBillingConfig java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute LoadBalancerBillingConfig: The billing information of the NLB instance.
attrLoadBalancerBusinessStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute LoadBalancerBusinessStatus: The status of workloads on the NLB instance.
attrLoadBalancerId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute LoadBalancerId: ID of the LoadBalancer.
attrLoadBalancerName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute LoadBalancerName: The NLB instance name.
attrLoadBalancerStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute LoadBalancerStatus: The NLB instance status.
attrLoadBalancerType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute LoadBalancerType: The type of the Server Load Balancer (SLB) instance.
attrModificationProtectionConfig java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ModificationProtectionConfig: The configuration of the configuration read-only mode.
attrOperationLocks java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute OperationLocks: The information about the locked NLB instance.
attrRegionId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RegionId: The region ID of the NLB instance.
attrResourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrSecurityGroupIds java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute SecurityGroupIds: The ID of the security group associated with the NLB instance.
attrTags java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Tags: The tags of the resource.
attrVpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute VpcId: The VPC ID of the NLB instance.
attrZoneMappings java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ZoneMappings: The list of zones and vSwitches in the zones.
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.


attrAddressTypeRequired

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

Attribute AddressType: The IPv4 network type of the NLB instance.


attrBandwidthPackageIdRequired

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

Attribute BandwidthPackageId: The ID of the EIP bandwidth plan.


attrCpsRequired

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

Attribute Cps: The maximum number of new connections per second supported by the NLB instance in each zone (virtual IP address).


attrCreateTimeRequired

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

Attribute CreateTime: The time when the NLB instance was created.


attrCrossZoneEnabledRequired

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

Attribute CrossZoneEnabled: Indicates whether the NLB instance is accessible across zones.


attrDeletionProtectionConfigRequired

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

Attribute DeletionProtectionConfig: The configuration of the deletion protection feature.


attrDnsNameRequired

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

Attribute DNSName: The domain name of the NLB instance.


attrIpv6AddressTypeRequired

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

Attribute Ipv6AddressType: The IPv6 network type of the NLB instance.


attrLoadBalancerBillingConfigRequired

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

Attribute LoadBalancerBillingConfig: The billing information of the NLB instance.


attrLoadBalancerBusinessStatusRequired

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

Attribute LoadBalancerBusinessStatus: The status of workloads on the NLB instance.


attrLoadBalancerIdRequired

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

Attribute LoadBalancerId: ID of the LoadBalancer.


attrLoadBalancerNameRequired

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

Attribute LoadBalancerName: The NLB instance name.


attrLoadBalancerStatusRequired

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

Attribute LoadBalancerStatus: The NLB instance status.


attrLoadBalancerTypeRequired

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

Attribute LoadBalancerType: The type of the Server Load Balancer (SLB) instance.

Set the value to network, which specifies NLB.


attrModificationProtectionConfigRequired

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

Attribute ModificationProtectionConfig: The configuration of the configuration read-only mode.


attrOperationLocksRequired

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

Attribute OperationLocks: The information about the locked NLB instance.


attrRegionIdRequired

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

Attribute RegionId: The region ID of the NLB 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.


attrSecurityGroupIdsRequired

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

Attribute SecurityGroupIds: The ID of the security group associated with the NLB instance.


attrTagsRequired

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

Attribute Tags: The tags of the resource.


attrVpcIdRequired

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

Attribute VpcId: The VPC ID of the NLB instance.


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 in the zones.


propsRequired

public LoadBalancerProps getProps();