Skip to content

Instance

This class encapsulates and extends the ROS resource type ALIYUN::REDIS::Instance, which is used to create a Tair (Redis OSS-compatible) instance.

Initializers 

import { Instance } from '@alicloud/ros-cdk-redis'
new Instance(scope: Construct, id: string, props?: InstanceProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props InstanceProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsOptional

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.
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.

sessionRequired

  • Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount 

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency 

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

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

isConstruct 

import { Instance } from '@alicloud/ros-cdk-redis'
Instance.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
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.
attrArchitectureType @alicloud/ros-cdk-core.IResolvable Attribute ArchitectureType: The architecture.
attrBandwidth @alicloud/ros-cdk-core.IResolvable Attribute Bandwidth: The bandwidth of the instance.
attrCapacity @alicloud/ros-cdk-core.IResolvable Attribute Capacity: The storage capacity of the instance.
attrChargeType @alicloud/ros-cdk-core.IResolvable Attribute ChargeType: The billing method of the instance.
attrClassicInnerConnectionPort @alicloud/ros-cdk-core.IResolvable Attribute ClassicInnerConnectionPort: The classic inner connection port of the instance.
attrClassicInnerConnectionString @alicloud/ros-cdk-core.IResolvable Attribute ClassicInnerConnectionString: The classic inner connection string of the instance.
attrConnectionDomain @alicloud/ros-cdk-core.IResolvable Attribute ConnectionDomain: Connection domain of created instance.
attrConnections @alicloud/ros-cdk-core.IResolvable Attribute Connections: The maximum number of connections supported by the instance.
attrDirectConnectionPort @alicloud/ros-cdk-core.IResolvable Attribute DirectConnectionPort: The direct connection port of the instance.
attrDirectConnectionString @alicloud/ros-cdk-core.IResolvable Attribute DirectConnectionString: The direct connection string of the instance.
attrEngineVersion @alicloud/ros-cdk-core.IResolvable Attribute EngineVersion: The engine version of the instance.
attrHasRenewChangeOrder @alicloud/ros-cdk-core.IResolvable Attribute HasRenewChangeOrder: Indicates whether the Alibaba Cloud account has pending renewal or scaling orders.
attrInstanceClass @alicloud/ros-cdk-core.IResolvable Attribute InstanceClass: Redis instance type.
attrInstanceId @alicloud/ros-cdk-core.IResolvable Attribute InstanceId: Instance id of created redis instance.
attrInstanceName @alicloud/ros-cdk-core.IResolvable Attribute InstanceName: Name of created redis instance.
attrInstanceType @alicloud/ros-cdk-core.IResolvable Attribute InstanceType: The engine type of the instance.
attrNetworkType @alicloud/ros-cdk-core.IResolvable Attribute NetworkType: The network type.
attrNodeType @alicloud/ros-cdk-core.IResolvable Attribute NodeType: The type of node.
attrOrderId @alicloud/ros-cdk-core.IResolvable Attribute OrderId: Order Id of created instance.
attrPackageType @alicloud/ros-cdk-core.IResolvable Attribute PackageType: The plan type.
attrPort @alicloud/ros-cdk-core.IResolvable Attribute Port: Port of created instance.
attrPrivateIp @alicloud/ros-cdk-core.IResolvable Attribute PrivateIp: The internal IP address of the instance.
attrPublicConnectionPort @alicloud/ros-cdk-core.IResolvable Attribute PublicConnectionPort: The public connection port of the instance.
attrPublicConnectionString @alicloud/ros-cdk-core.IResolvable Attribute PublicConnectionString: The public connection string of the instance.
attrQps @alicloud/ros-cdk-core.IResolvable Attribute QPS: The queries per second (QPS) supported by the instance.
attrResourceGroupId @alicloud/ros-cdk-core.IResolvable Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.
attrVpcId @alicloud/ros-cdk-core.IResolvable Attribute VpcId: The ID of the VPC.
attrVpcPrivateConnectionPort @alicloud/ros-cdk-core.IResolvable Attribute VpcPrivateConnectionPort: The vpc private connection port of the instance.
attrVpcPrivateConnectionString @alicloud/ros-cdk-core.IResolvable Attribute VpcPrivateConnectionString: The vpc private connection string of the instance.
attrVSwitchId @alicloud/ros-cdk-core.IResolvable Attribute VSwitchId: The ID of the vSwitch.
attrZoneId @alicloud/ros-cdk-core.IResolvable Attribute ZoneId: The ID of the zone.

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

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

attrArchitectureTypeRequired 

public readonly attrArchitectureType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ArchitectureType: The architecture.

attrBandwidthRequired 

public readonly attrBandwidth: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Bandwidth: The bandwidth of the instance.

Unit: Mbit/s.

attrCapacityRequired 

public readonly attrCapacity: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Capacity: The storage capacity of the instance.

Unit: MB.

attrChargeTypeRequired 

public readonly attrChargeType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ChargeType: The billing method of the instance.

attrClassicInnerConnectionPortRequired 

public readonly attrClassicInnerConnectionPort: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ClassicInnerConnectionPort: The classic inner connection port of the instance.

attrClassicInnerConnectionStringRequired 

public readonly attrClassicInnerConnectionString: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ClassicInnerConnectionString: The classic inner connection string of the instance.

attrConnectionDomainRequired 

public readonly attrConnectionDomain: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ConnectionDomain: Connection domain of created instance.

attrConnectionsRequired 

public readonly attrConnections: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Connections: The maximum number of connections supported by the instance.

attrDirectConnectionPortRequired 

public readonly attrDirectConnectionPort: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DirectConnectionPort: The direct connection port of the instance.

attrDirectConnectionStringRequired 

public readonly attrDirectConnectionString: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DirectConnectionString: The direct connection string of the instance.

attrEngineVersionRequired 

public readonly attrEngineVersion: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute EngineVersion: The engine version of the instance.

attrHasRenewChangeOrderRequired 

public readonly attrHasRenewChangeOrder: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute HasRenewChangeOrder: Indicates whether the Alibaba Cloud account has pending renewal or scaling orders.

attrInstanceClassRequired 

public readonly attrInstanceClass: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceClass: Redis instance type.

attrInstanceIdRequired 

public readonly attrInstanceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceId: Instance id of created redis instance.

attrInstanceNameRequired 

public readonly attrInstanceName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceName: Name of created redis instance.

attrInstanceTypeRequired 

public readonly attrInstanceType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceType: The engine type of the instance.

attrNetworkTypeRequired 

public readonly attrNetworkType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute NetworkType: The network type.

attrNodeTypeRequired 

public readonly attrNodeType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute NodeType: The type of node.

attrOrderIdRequired 

public readonly attrOrderId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute OrderId: Order Id of created instance.

attrPackageTypeRequired 

public readonly attrPackageType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PackageType: The plan type.

attrPortRequired 

public readonly attrPort: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Port: Port of created instance.

attrPrivateIpRequired 

public readonly attrPrivateIp: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PrivateIp: The internal IP address of the instance.

attrPublicConnectionPortRequired 

public readonly attrPublicConnectionPort: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PublicConnectionPort: The public connection port of the instance.

attrPublicConnectionStringRequired 

public readonly attrPublicConnectionString: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PublicConnectionString: The public connection string of the instance.

attrQpsRequired 

public readonly attrQps: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute QPS: The queries per second (QPS) supported by the instance.

attrResourceGroupIdRequired 

public readonly attrResourceGroupId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.

attrVpcIdRequired 

public readonly attrVpcId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VpcId: The ID of the VPC.

attrVpcPrivateConnectionPortRequired 

public readonly attrVpcPrivateConnectionPort: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VpcPrivateConnectionPort: The vpc private connection port of the instance.

attrVpcPrivateConnectionStringRequired 

public readonly attrVpcPrivateConnectionString: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VpcPrivateConnectionString: The vpc private connection string of the instance.

attrVSwitchIdRequired 

public readonly attrVSwitchId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VSwitchId: The ID of the vSwitch.

attrZoneIdRequired 

public readonly attrZoneId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ZoneId: The ID of the zone.