LoadBalancer
- Implements: com.aliyun.ros.cdk.slb.datasource.ILoadBalancer
This class encapsulates and extends the ROS resource type DATASOURCE::SLB::LoadBalancer, which is used to query the information about a Classic Load Balancer (CLB) instance.
Initializers
import com.aliyun.ros.cdk.slb.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: The CLB instance ID. |
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
loadBalancerIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property loadBalancerId: The CLB instance ID.
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.
- 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.slb.datasource.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. |
attrAddress | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Address: The service IP address of the CLB instance. |
attrAddressIpVersion | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute AddressIpVersion: The version of the IP address. |
attrAddressType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute AddressType: The address type of the CLB instance. |
attrAutoReleaseTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute AutoReleaseTime: The timestamp generated when the CLB instance is released. |
attrBackendServers | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute BackendServers: The backend servers of the CLB instance. |
attrBandwidth | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Bandwidth: The maximum bandwidth of the Internet-facing CLB instance that is billed on a pay-by-bandwidth basis. |
attrCreateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: The time when the CLB instance was created. |
attrCreateTimeStamp | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTimeStamp: The timestamp generated when the CA certificate is uploaded. |
attrDeleteProtection | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DeleteProtection: Indicates whether deletion protection is enabled for the CLB instance. |
attrEndTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute EndTime: The time when the CLB instance expires. |
attrEndTimeStamp | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute EndTimeStamp: The timestamp that indicates the expiration time of the CLB instance. |
attrInstanceChargeType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InstanceChargeType: Instance billing method. |
attrInternetChargeType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InternetChargeType: The metering method of the Internet-facing CLB instance. |
attrListenerPortsAndProtocal | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ListenerPortsAndProtocal: The ports or protocols of the listeners. |
attrListenerPortsAndProtocol | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ListenerPortsAndProtocol: The ports or protocols of the listeners. |
attrLoadBalancerId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute LoadBalancerId: The CLB instance ID. |
attrLoadBalancerName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute LoadBalancerName: The name of the CLB instance. |
attrLoadBalancerSpec | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute LoadBalancerSpec: The specification of the CLB instance. |
attrMasterZoneId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute MasterZoneId: The ID of the primary zone to which the CLB instance belongs. |
attrModificationProtectionReason | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ModificationProtectionReason: The reason why the configuration read-only mode is enabled. |
attrModificationProtectionStatus | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ModificationProtectionStatus: Load balancing modifies the protection state. |
attrNetworkType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute NetworkType: The network type of the CLB instance. |
attrPaymentType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PaymentType: Load balancing instance payment type. |
attrRegionIdAlias | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute RegionIdAlias: The alias of the region to which the CLB instance belongs. |
attrRenewalCycUnit | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute RenewalCycUnit: The auto-renewal cycle. |
attrRenewalDuration | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute RenewalDuration: The auto-renewal duration. |
attrRenewalStatus | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute RenewalStatus: Indicates whether auto-renewal is enabled. |
attrResourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ResourceGroupId: The resource group ID. |
attrSlaveZoneId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SlaveZoneId: The ID of the secondary zone to which the CLB instance belongs. |
attrTags | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Tags: The tags of the CLB instance. |
attrVpcId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VpcId: The ID of the virtual private cloud (VPC) where the internal-facing CLB instance is deployed. |
attrVSwitchId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VSwitchId: The ID of the vSwitch to which the internal-facing CLB instance belongs. |
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
attrAddressRequired
public java.lang.Object getAttrAddress();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Address: The service IP address of the CLB instance.
attrAddressIpVersionRequired
public java.lang.Object getAttrAddressIpVersion();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute AddressIpVersion: The version of the IP address.
Valid values: ipv4 and ipv6.
attrAddressTypeRequired
public java.lang.Object getAttrAddressType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute AddressType: The address type of the CLB instance.
attrAutoReleaseTimeRequired
public java.lang.Object getAttrAutoReleaseTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute AutoReleaseTime: The timestamp generated when the CLB instance is released.
attrBackendServersRequired
public java.lang.Object getAttrBackendServers();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute BackendServers: The backend servers of the CLB instance.
attrBandwidthRequired
public java.lang.Object getAttrBandwidth();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Bandwidth: The maximum bandwidth of the Internet-facing CLB instance that is billed on a pay-by-bandwidth basis.
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The time when the CLB instance was created.
attrCreateTimeStampRequired
public java.lang.Object getAttrCreateTimeStamp();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTimeStamp: The timestamp generated when the CA certificate is uploaded.
attrDeleteProtectionRequired
public java.lang.Object getAttrDeleteProtection();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DeleteProtection: Indicates whether deletion protection is enabled for the CLB instance.
attrEndTimeRequired
public java.lang.Object getAttrEndTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute EndTime: The time when the CLB instance expires.
attrEndTimeStampRequired
public java.lang.Object getAttrEndTimeStamp();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute EndTimeStamp: The timestamp that indicates the expiration time of the CLB instance.
attrInstanceChargeTypeRequired
public java.lang.Object getAttrInstanceChargeType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InstanceChargeType: Instance billing method.
attrInternetChargeTypeRequired
public java.lang.Object getAttrInternetChargeType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InternetChargeType: The metering method of the Internet-facing CLB instance.
attrListenerPortsAndProtocalRequired
public java.lang.Object getAttrListenerPortsAndProtocal();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ListenerPortsAndProtocal: The ports or protocols of the listeners.
attrListenerPortsAndProtocolRequired
public java.lang.Object getAttrListenerPortsAndProtocol();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ListenerPortsAndProtocol: The ports or protocols of the listeners.
attrLoadBalancerIdRequired
public java.lang.Object getAttrLoadBalancerId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute LoadBalancerId: The CLB instance ID.
attrLoadBalancerNameRequired
public java.lang.Object getAttrLoadBalancerName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute LoadBalancerName: The name of the CLB instance.
attrLoadBalancerSpecRequired
public java.lang.Object getAttrLoadBalancerSpec();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute LoadBalancerSpec: The specification of the CLB instance.
attrMasterZoneIdRequired
public java.lang.Object getAttrMasterZoneId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute MasterZoneId: The ID of the primary zone to which the CLB instance belongs.
attrModificationProtectionReasonRequired
public java.lang.Object getAttrModificationProtectionReason();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ModificationProtectionReason: The reason why the configuration read-only mode is enabled.
attrModificationProtectionStatusRequired
public java.lang.Object getAttrModificationProtectionStatus();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ModificationProtectionStatus: Load balancing modifies the protection state.
attrNetworkTypeRequired
public java.lang.Object getAttrNetworkType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute NetworkType: The network type of the CLB instance.
attrPaymentTypeRequired
public java.lang.Object getAttrPaymentType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PaymentType: Load balancing instance payment type.
attrRegionIdAliasRequired
public java.lang.Object getAttrRegionIdAlias();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute RegionIdAlias: The alias of the region to which the CLB instance belongs.
attrRenewalCycUnitRequired
public java.lang.Object getAttrRenewalCycUnit();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute RenewalCycUnit: The auto-renewal cycle.
Valid values: Year and Month. Default value: Month.
attrRenewalDurationRequired
public java.lang.Object getAttrRenewalDuration();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute RenewalDuration: The auto-renewal duration.
This parameter is valid only if RenewalStatus is set to AutoRenewal.
attrRenewalStatusRequired
public java.lang.Object getAttrRenewalStatus();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute RenewalStatus: Indicates whether auto-renewal is enabled.
attrResourceGroupIdRequired
public java.lang.Object getAttrResourceGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ResourceGroupId: The resource group ID.
attrSlaveZoneIdRequired
public java.lang.Object getAttrSlaveZoneId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SlaveZoneId: The ID of the secondary zone to which the CLB instance belongs.
attrTagsRequired
public java.lang.Object getAttrTags();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Tags: The tags of the CLB instance.
attrVpcIdRequired
public java.lang.Object getAttrVpcId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VpcId: The ID of the virtual private cloud (VPC) where the internal-facing CLB instance is deployed.
attrVSwitchIdRequired
public java.lang.Object getAttrVSwitchId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VSwitchId: The ID of the vSwitch to which the internal-facing CLB instance belongs.
propsRequired
public LoadBalancerProps getProps();
- Type: LoadBalancerProps