LoadBalancer
- Implements: ILoadBalancer
This class encapsulates and extends the ROS resource type ALIYUN::SLB::LoadBalancerUse the , which resource type to create an SLB instance.
Initializers
import { LoadBalancer } from '@alicloud/ros-cdk-slb'
new 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 { LoadBalancer } from '@alicloud/ros-cdk-slb'
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: IP version. |
attrAddressType | string | @alicloud/ros-cdk-core.IResolvable | Attribute AddressType: The address type of the load balancer. |
attrBandwidth | string | @alicloud/ros-cdk-core.IResolvable | Attribute Bandwidth: The bandwidth for network. |
attrIpAddress | string | @alicloud/ros-cdk-core.IResolvable | Attribute IpAddress: The ip address of the load balancer. |
attrLoadBalancerId | string | @alicloud/ros-cdk-core.IResolvable | Attribute LoadBalancerId: The id of load balance created. |
attrLoadBalancerName | string | @alicloud/ros-cdk-core.IResolvable | Attribute LoadBalancerName: Name of created load balancer. |
attrLoadBalancerSpec | string | @alicloud/ros-cdk-core.IResolvable | Attribute LoadBalancerSpec: The specification of the Server Load Balancer instance. |
attrMasterZoneId | string | @alicloud/ros-cdk-core.IResolvable | Attribute MasterZoneId: The master zone id to create load balancer instance. |
attrNetworkType | string | @alicloud/ros-cdk-core.IResolvable | Attribute NetworkType: The network type of the load balancer. |
attrOrderId | string | @alicloud/ros-cdk-core.IResolvable | Attribute OrderId: The order ID. |
attrPayType | string | @alicloud/ros-cdk-core.IResolvable | Attribute PayType: The billing method of the instance to be created. |
attrResourceGroupId | string | @alicloud/ros-cdk-core.IResolvable | Attribute ResourceGroupId: Resource group id. |
attrSlaveZoneId | string | @alicloud/ros-cdk-core.IResolvable | Attribute SlaveZoneId: The slave zone id to create load balancer instance. |
attrVpcId | string | @alicloud/ros-cdk-core.IResolvable | Attribute VpcId: Vpc id. |
attrVSwitchId | string | @alicloud/ros-cdk-core.IResolvable | Attribute VSwitchId: VSwitch id. |
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: IP version.
attrAddressTypeRequired
public readonly attrAddressType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute AddressType: The address type of the load balancer.
"intranet" or "internet".
attrBandwidthRequired
public readonly attrBandwidth: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Bandwidth: The bandwidth for network.
attrIpAddressRequired
public readonly attrIpAddress: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute IpAddress: The ip address of the load balancer.
attrLoadBalancerIdRequired
public readonly attrLoadBalancerId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute LoadBalancerId: The id of load balance created.
attrLoadBalancerNameRequired
public readonly attrLoadBalancerName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute LoadBalancerName: Name of created load balancer.
attrLoadBalancerSpecRequired
public readonly attrLoadBalancerSpec: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute LoadBalancerSpec: The specification of the Server Load Balancer instance.
attrMasterZoneIdRequired
public readonly attrMasterZoneId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute MasterZoneId: The master zone id to create load balancer instance.
attrNetworkTypeRequired
public readonly attrNetworkType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute NetworkType: The network type of the load balancer.
"vpc" or "classic" network.
attrOrderIdRequired
public readonly attrOrderId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute OrderId: The order ID.
attrPayTypeRequired
public readonly attrPayType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute PayType: The billing method of the instance to be created.
attrResourceGroupIdRequired
public readonly attrResourceGroupId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ResourceGroupId: Resource group id.
attrSlaveZoneIdRequired
public readonly attrSlaveZoneId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute SlaveZoneId: The slave zone id to create load balancer instance.
attrVpcIdRequired
public readonly attrVpcId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute VpcId: Vpc id.
attrVSwitchIdRequired
public readonly attrVSwitchId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute VSwitchId: VSwitch id.
propsRequired
public readonly props: LoadBalancerProps;
- Type: LoadBalancerProps