Instance

• Implements: @alicloud/ros-cdk-redis.datasource.IInstance

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

Initializers

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

scope^Required

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

id^Required

• Type: string

props^Required

• 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 { datasource } from '@alicloud/ros-cdk-redis'
datasource.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: Architecture type.

attrBandwidth^Required

public readonly attrBandwidth: string | IResolvable;

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

Attribute Bandwidth: Bandwidth.

attrCapacity^Required

public readonly attrCapacity: string | IResolvable;

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

Attribute Capacity: Capacity.

attrCloudType^Required

public readonly attrCloudType: string | IResolvable;

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

Attribute CloudType: Cloud category.

attrConfig^Required

public readonly attrConfig: string | IResolvable;

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

Attribute Config: Config.

attrConnectionDomain^Required

public readonly attrConnectionDomain: string | IResolvable;

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

Attribute ConnectionDomain: Connection domain.

attrCreateTime^Required

public readonly attrCreateTime: string | IResolvable;

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

Attribute CreateTime: Create time.

attrDbInstanceId^Required

public readonly attrDbInstanceId: string | IResolvable;

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

Attribute DBInstanceId: Database instance id.

attrDbInstanceName^Required

public readonly attrDbInstanceName: string | IResolvable;

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

Attribute DBInstanceName: Instance name.

attrEndTime^Required

public readonly attrEndTime: string | IResolvable;

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

Attribute EndTime: End time.

attrEngineVersion^Required

public readonly attrEngineVersion: string | IResolvable;

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

Attribute EngineVersion: Engine version.

attrHasRenewChangeOrder^Required

public readonly attrHasRenewChangeOrder: string | IResolvable;

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

Attribute HasRenewChangeOrder: Has renew change order.

attrInstanceClass^Required

public readonly attrInstanceClass: string | IResolvable;

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

Attribute InstanceClass: Instance class.

attrInstanceReleaseProtection^Required

public readonly attrInstanceReleaseProtection: string | IResolvable;

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

Attribute InstanceReleaseProtection: Instance release protection.

attrInstanceType^Required

public readonly attrInstanceType: string | IResolvable;

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

Attribute InstanceType: Instance type.

attrIsRds^Required

public readonly attrIsRds: string | IResolvable;

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

Attribute IsRds: is RDS.

attrMaintainEndTime^Required

public readonly attrMaintainEndTime: string | IResolvable;

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

Attribute MaintainEndTime: Maintain end time.

attrMaintainStartTime^Required

public readonly attrMaintainStartTime: string | IResolvable;

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

Attribute MaintainStartTime: Maintain start time.

attrNetworkType^Required

public readonly attrNetworkType: string | IResolvable;

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

Attribute NetworkType: Network type.

attrPackageType^Required

public readonly attrPackageType: string | IResolvable;

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

Attribute PackageType: Package type.

attrPaymentType^Required

public readonly attrPaymentType: string | IResolvable;

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

Attribute PaymentType: Payment type.

attrPort^Required

public readonly attrPort: string | IResolvable;

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

Attribute Port: Port.

attrPrivateIp^Required

public readonly attrPrivateIp: string | IResolvable;

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

Attribute PrivateIp: Private IP.

attrQps^Required

public readonly attrQps: string | IResolvable;

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

Attribute Qps: QPS.

attrReadOnlyCount^Required

public readonly attrReadOnlyCount: string | IResolvable;

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

Attribute ReadOnlyCount: The number of read-only nodes.

This parameter is only applicable to the creation of read-write splitting instances in the cloud disk version. You can use this parameter to customize the number of read-only nodes. Valid values: 1 to 5.

attrReplacateId^Required

public readonly attrReplacateId: string | IResolvable;

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

Attribute ReplacateId: Replacate id.

attrResourceGroupId^Required

public readonly attrResourceGroupId: string | IResolvable;

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

Attribute ResourceGroupId: Resource group id.

attrSecondaryZoneId^Required

public readonly attrSecondaryZoneId: string | IResolvable;

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

Attribute SecondaryZoneId: The ID of the standby zone.

attrSecurityGroupId^Required

public readonly attrSecurityGroupId: string | IResolvable;

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

Attribute SecurityGroupId: Security group id.

attrSecurityIpGroupAttribute^Required

public readonly attrSecurityIpGroupAttribute: string | IResolvable;

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

Attribute SecurityIpGroupAttribute: Security IP group attribute.

attrSecurityIpGroupName^Required

public readonly attrSecurityIpGroupName: string | IResolvable;

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

Attribute SecurityIpGroupName: Security IP group name.

attrSecurityIps^Required

public readonly attrSecurityIps: string | IResolvable;

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

Attribute SecurityIps: Security IPs.

attrShardCount^Required

public readonly attrShardCount: string | IResolvable;

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

Attribute ShardCount: The number of slices.

This parameter is only applicable to creating a cloud disk cluster architecture instance. You can use this parameter to customize the number of slices.

attrTags^Required

public readonly attrTags: string | IResolvable;

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

Attribute Tags: Tags.

attrVpcAuthMode^Required

public readonly attrVpcAuthMode: string | IResolvable;

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

Attribute VpcAuthMode: Vpc auth mode.

attrVpcCloudInstanceId^Required

public readonly attrVpcCloudInstanceId: string | IResolvable;

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

Attribute VpcCloudInstanceId: Vpc cloud instance id.

attrVpcId^Required

public readonly attrVpcId: string | IResolvable;

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

Attribute VpcId: Vpc id.

attrVSwitchId^Required

public readonly attrVSwitchId: string | IResolvable;

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

Attribute VSwitchId: Vswitch id.

attrZoneId^Required

public readonly attrZoneId: string | IResolvable;

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

Attribute ZoneId: Zone id.

props^Required

public readonly props: InstanceProps;

• Type: InstanceProps