Instance

• Implements: IInstance

This class encapsulates and extends the ROS resource type ALIYUN::REDIS::Instance.

Initializers

import { Instance } from '@alicloud/ros-cdk-redis'
new Instance(scope: Construct, id: string, props?: InstanceProps, enableResourcePropertyConstraint?: boolean)

scope^Required

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

id^Required

• Type: string

props^Optional

• Type: InstanceProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

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.

session^Required

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

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

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

addCount

public addCount(count: number | IResolvable): void

count^Required

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

addDependency

public addDependency(resource: Resource): void

resource^Required

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

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

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

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

env^Required

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.

ref^Required

public readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

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

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

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

attrArchitectureType^Required

public readonly attrArchitectureType: string | IResolvable;

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

Attribute ArchitectureType: The architecture.

attrBandwidth^Required

public readonly attrBandwidth: string | IResolvable;

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

Attribute Bandwidth: The bandwidth of the instance.

Unit: Mbit/s.

attrCapacity^Required

public readonly attrCapacity: string | IResolvable;

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

Attribute Capacity: The storage capacity of the instance.

Unit: MB.

attrChargeType^Required

public readonly attrChargeType: string | IResolvable;

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

Attribute ChargeType: The billing method of the instance.

attrClassicInnerConnectionPort^Required

public readonly attrClassicInnerConnectionPort: string | IResolvable;

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

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

attrClassicInnerConnectionString^Required

public readonly attrClassicInnerConnectionString: string | IResolvable;

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

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

attrConnectionDomain^Required

public readonly attrConnectionDomain: string | IResolvable;

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

Attribute ConnectionDomain: Connection domain of created instance.

attrConnections^Required

public readonly attrConnections: string | IResolvable;

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

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

attrDirectConnectionPort^Required

public readonly attrDirectConnectionPort: string | IResolvable;

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

Attribute DirectConnectionPort: The direct connection port of the instance.

attrDirectConnectionString^Required

public readonly attrDirectConnectionString: string | IResolvable;

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

Attribute DirectConnectionString: The direct connection string of the instance.

attrEngineVersion^Required

public readonly attrEngineVersion: string | IResolvable;

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

Attribute EngineVersion: The engine version of the instance.

attrHasRenewChangeOrder^Required

public readonly attrHasRenewChangeOrder: string | IResolvable;

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

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

attrInstanceClass^Required

public readonly attrInstanceClass: string | IResolvable;

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

Attribute InstanceClass: Redis instance type.

attrInstanceId^Required

public readonly attrInstanceId: string | IResolvable;

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

Attribute InstanceId: Instance id of created redis instance.

attrInstanceName^Required

public readonly attrInstanceName: string | IResolvable;

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

Attribute InstanceName: Name of created redis instance.

attrInstanceType^Required

public readonly attrInstanceType: string | IResolvable;

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

Attribute InstanceType: The engine type of the instance.

attrNetworkType^Required

public readonly attrNetworkType: string | IResolvable;

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

Attribute NetworkType: The network type.

attrNodeType^Required

public readonly attrNodeType: string | IResolvable;

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

Attribute NodeType: The type of node.

attrOrderId^Required

public readonly attrOrderId: string | IResolvable;

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

Attribute OrderId: Order Id of created instance.

attrPackageType^Required

public readonly attrPackageType: string | IResolvable;

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

Attribute PackageType: The plan type.

attrPort^Required

public readonly attrPort: string | IResolvable;

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

Attribute Port: Port of created instance.

attrPrivateIp^Required

public readonly attrPrivateIp: string | IResolvable;

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

Attribute PrivateIp: The internal IP address of the instance.

attrPublicConnectionPort^Required

public readonly attrPublicConnectionPort: string | IResolvable;

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

Attribute PublicConnectionPort: The public connection port of the instance.

attrPublicConnectionString^Required

public readonly attrPublicConnectionString: string | IResolvable;

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

Attribute PublicConnectionString: The public connection string of the instance.

attrQps^Required

public readonly attrQps: string | IResolvable;

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

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

attrResourceGroupId^Required

public readonly attrResourceGroupId: string | IResolvable;

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

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

attrVpcId^Required

public readonly attrVpcId: string | IResolvable;

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

Attribute VpcId: The ID of the VPC.

attrVpcPrivateConnectionPort^Required

public readonly attrVpcPrivateConnectionPort: string | IResolvable;

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

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

attrVpcPrivateConnectionString^Required

public readonly attrVpcPrivateConnectionString: string | IResolvable;

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

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

attrVSwitchId^Required

public readonly attrVSwitchId: string | IResolvable;

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

Attribute VSwitchId: The ID of the vSwitch.

attrZoneId^Required

public readonly attrZoneId: string | IResolvable;

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

Attribute ZoneId: The ID of the zone.

props^Required

public readonly props: InstanceProps;

• Type: InstanceProps