LoadBalancer
- Implements: @alicloud/ros-cdk-nlb.datasource.ILoadBalancer
This class encapsulates and extends the ROS resource type DATASOURCE::NLB::LoadBalancer.
Initializers
import { datasource } from '@alicloud/ros-cdk-nlb'
new datasource.LoadBalancer(scope: Construct, id: string, props?: LoadBalancerProps, enableResourcePropertyConstraint?: boolean)
| Name | Type | Description |
|---|---|---|
scope | @alicloud/ros-cdk-core.Construct | No description. |
id | string | No description. |
props | LoadBalancerProps | No description. |
enableResourcePropertyConstraint | boolean | No description. |
scopeRequired
- Type: @alicloud/ros-cdk-core.Construct
idRequired
- Type: string
propsOptional
- Type: LoadBalancerProps
enableResourcePropertyConstraintOptional
- Type: boolean
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 toString(): string
Returns a string representation of this construct.
synthesize
public synthesize(session: ISynthesisSession): void
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: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
fetchCondition
public fetchCondition(): RosCondition
fetchDependency
public fetchDependency(): string[]
fetchResourceDesc
public fetchResourceDesc(): string
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- Type: any
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import { datasource } from '@alicloud/ros-cdk-nlb'
datasource.LoadBalancer.isConstruct(x: any)
Return whether the given object is a Construct.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node | @alicloud/ros-cdk-core.ConstructNode | The construct tree node associated with this construct. |
env | @alicloud/ros-cdk-core.IResourceEnvironment | The environment this resource belongs to. |
ref | string | No description. |
stack | @alicloud/ros-cdk-core.Stack | The stack in which this resource is defined. |
resource | @alicloud/ros-cdk-core.RosResource | No description. |
attrAddressIpVersion | string | @alicloud/ros-cdk-core.IResolvable | Attribute AddressIpVersion: The protocol version. |
attrAddressType | string | @alicloud/ros-cdk-core.IResolvable | Attribute AddressType: The IPv4 network type of the NLB instance. |
attrBandwidthPackageId | string | @alicloud/ros-cdk-core.IResolvable | Attribute BandwidthPackageId: The ID of the EIP bandwidth plan. |
attrCps | string | @alicloud/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 | string | @alicloud/ros-cdk-core.IResolvable | Attribute CreateTime: The time when the NLB instance was created. |
attrCrossZoneEnabled | string | @alicloud/ros-cdk-core.IResolvable | Attribute CrossZoneEnabled: Indicates whether the NLB instance is accessible across zones. |
attrDeletionProtectionConfig | string | @alicloud/ros-cdk-core.IResolvable | Attribute DeletionProtectionConfig: The configuration of the deletion protection feature. |
attrDnsName | string | @alicloud/ros-cdk-core.IResolvable | Attribute DNSName: The domain name of the NLB instance. |
attrIpv6AddressType | string | @alicloud/ros-cdk-core.IResolvable | Attribute Ipv6AddressType: The IPv6 network type of the NLB instance. |
attrLoadBalancerBillingConfig | string | @alicloud/ros-cdk-core.IResolvable | Attribute LoadBalancerBillingConfig: The billing information of the NLB instance. |
attrLoadBalancerBusinessStatus | string | @alicloud/ros-cdk-core.IResolvable | Attribute LoadBalancerBusinessStatus: The status of workloads on the NLB instance. |
attrLoadBalancerId | string | @alicloud/ros-cdk-core.IResolvable | Attribute LoadBalancerId: ID of the LoadBalancer. |
attrLoadBalancerName | string | @alicloud/ros-cdk-core.IResolvable | Attribute LoadBalancerName: The NLB instance name. |
attrLoadBalancerStatus | string | @alicloud/ros-cdk-core.IResolvable | Attribute LoadBalancerStatus: The NLB instance status. |
attrLoadBalancerType | string | @alicloud/ros-cdk-core.IResolvable | Attribute LoadBalancerType: The type of the Server Load Balancer (SLB) instance. |
attrModificationProtectionConfig | string | @alicloud/ros-cdk-core.IResolvable | Attribute ModificationProtectionConfig: The configuration of the configuration read-only mode. |
attrOperationLocks | string | @alicloud/ros-cdk-core.IResolvable | Attribute OperationLocks: The information about the locked NLB instance. |
attrRegionId | string | @alicloud/ros-cdk-core.IResolvable | Attribute RegionId: The region ID of the NLB instance. |
attrResourceGroupId | string | @alicloud/ros-cdk-core.IResolvable | Attribute ResourceGroupId: The ID of the resource group. |
attrSecurityGroupIds | string | @alicloud/ros-cdk-core.IResolvable | Attribute SecurityGroupIds: The ID of the security group associated with the NLB instance. |
attrTags | string | @alicloud/ros-cdk-core.IResolvable | Attribute Tags: The tags of the resource. |
attrVpcId | string | @alicloud/ros-cdk-core.IResolvable | Attribute VpcId: The VPC ID of the NLB instance. |
attrZoneMappings | string | @alicloud/ros-cdk-core.IResolvable | Attribute ZoneMappings: The list of zones and vSwitches in the zones. |
props | LoadBalancerProps | No description. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
envRequired
public readonly env: IResourceEnvironment;
- Type: @alicloud/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 readonly ref: string;
- Type: string
stackRequired
public readonly stack: Stack;
- Type: @alicloud/ros-cdk-core.Stack
The stack in which this resource is defined.
resourceOptional
public readonly resource: RosResource;
- Type: @alicloud/ros-cdk-core.RosResource
attrAddressIpVersionRequired
public readonly attrAddressIpVersion: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute AddressIpVersion: The protocol version.
attrAddressTypeRequired
public readonly attrAddressType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute AddressType: The IPv4 network type of the NLB instance.
attrBandwidthPackageIdRequired
public readonly attrBandwidthPackageId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute BandwidthPackageId: The ID of the EIP bandwidth plan.
attrCpsRequired
public readonly attrCps: string | IResolvable;
- Type: string | @alicloud/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 readonly attrCreateTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CreateTime: The time when the NLB instance was created.
attrCrossZoneEnabledRequired
public readonly attrCrossZoneEnabled: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CrossZoneEnabled: Indicates whether the NLB instance is accessible across zones.
attrDeletionProtectionConfigRequired
public readonly attrDeletionProtectionConfig: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DeletionProtectionConfig: The configuration of the deletion protection feature.
attrDnsNameRequired
public readonly attrDnsName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DNSName: The domain name of the NLB instance.
attrIpv6AddressTypeRequired
public readonly attrIpv6AddressType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Ipv6AddressType: The IPv6 network type of the NLB instance.
attrLoadBalancerBillingConfigRequired
public readonly attrLoadBalancerBillingConfig: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute LoadBalancerBillingConfig: The billing information of the NLB instance.
attrLoadBalancerBusinessStatusRequired
public readonly attrLoadBalancerBusinessStatus: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute LoadBalancerBusinessStatus: The status of workloads on the NLB instance.
attrLoadBalancerIdRequired
public readonly attrLoadBalancerId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute LoadBalancerId: ID of the LoadBalancer.
attrLoadBalancerNameRequired
public readonly attrLoadBalancerName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute LoadBalancerName: The NLB instance name.
attrLoadBalancerStatusRequired
public readonly attrLoadBalancerStatus: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute LoadBalancerStatus: The NLB instance status.
attrLoadBalancerTypeRequired
public readonly attrLoadBalancerType: string | IResolvable;
- Type: string | @alicloud/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 readonly attrModificationProtectionConfig: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ModificationProtectionConfig: The configuration of the configuration read-only mode.
attrOperationLocksRequired
public readonly attrOperationLocks: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute OperationLocks: The information about the locked NLB instance.
attrRegionIdRequired
public readonly attrRegionId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute RegionId: The region ID of the NLB instance.
attrResourceGroupIdRequired
public readonly attrResourceGroupId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ResourceGroupId: The ID of the resource group.
attrSecurityGroupIdsRequired
public readonly attrSecurityGroupIds: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute SecurityGroupIds: The ID of the security group associated with the NLB instance.
attrTagsRequired
public readonly attrTags: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Tags: The tags of the resource.
attrVpcIdRequired
public readonly attrVpcId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute VpcId: The VPC ID of the NLB instance.
attrZoneMappingsRequired
public readonly attrZoneMappings: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ZoneMappings: The list of zones and vSwitches in the zones.
propsRequired
public readonly props: LoadBalancerProps;
- Type: LoadBalancerProps