Skip to content

Instance

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

Initializers 

import { datasource } from '@alicloud/ros-cdk-redis'
new datasource.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

propsRequired

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 { datasource } from '@alicloud/ros-cdk-redis'
datasource.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: Architecture type.
attrBandwidth @alicloud/ros-cdk-core.IResolvable Attribute Bandwidth: Bandwidth.
attrCapacity @alicloud/ros-cdk-core.IResolvable Attribute Capacity: Capacity.
attrCloudType @alicloud/ros-cdk-core.IResolvable Attribute CloudType: Cloud category.
attrConfig @alicloud/ros-cdk-core.IResolvable Attribute Config: Config.
attrConnectionDomain @alicloud/ros-cdk-core.IResolvable Attribute ConnectionDomain: Connection domain.
attrCreateTime @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: Create time.
attrDbInstanceId @alicloud/ros-cdk-core.IResolvable Attribute DBInstanceId: Database instance id.
attrDbInstanceName @alicloud/ros-cdk-core.IResolvable Attribute DBInstanceName: Instance name.
attrEndTime @alicloud/ros-cdk-core.IResolvable Attribute EndTime: End time.
attrEngineVersion @alicloud/ros-cdk-core.IResolvable Attribute EngineVersion: Engine version.
attrHasRenewChangeOrder @alicloud/ros-cdk-core.IResolvable Attribute HasRenewChangeOrder: Has renew change order.
attrInstanceClass @alicloud/ros-cdk-core.IResolvable Attribute InstanceClass: Instance class.
attrInstanceReleaseProtection @alicloud/ros-cdk-core.IResolvable Attribute InstanceReleaseProtection: Instance release protection.
attrInstanceType @alicloud/ros-cdk-core.IResolvable Attribute InstanceType: Instance type.
attrIsRds @alicloud/ros-cdk-core.IResolvable Attribute IsRds: is RDS.
attrMaintainEndTime @alicloud/ros-cdk-core.IResolvable Attribute MaintainEndTime: Maintain end time.
attrMaintainStartTime @alicloud/ros-cdk-core.IResolvable Attribute MaintainStartTime: Maintain start time.
attrNetworkType @alicloud/ros-cdk-core.IResolvable Attribute NetworkType: Network type.
attrPackageType @alicloud/ros-cdk-core.IResolvable Attribute PackageType: Package type.
attrPaymentType @alicloud/ros-cdk-core.IResolvable Attribute PaymentType: Payment type.
attrPort @alicloud/ros-cdk-core.IResolvable Attribute Port: Port.
attrPrivateIp @alicloud/ros-cdk-core.IResolvable Attribute PrivateIp: Private IP.
attrQps @alicloud/ros-cdk-core.IResolvable Attribute Qps: QPS.
attrReadOnlyCount @alicloud/ros-cdk-core.IResolvable Attribute ReadOnlyCount: The number of read-only nodes.
attrReplacateId @alicloud/ros-cdk-core.IResolvable Attribute ReplacateId: Replacate id.
attrResourceGroupId @alicloud/ros-cdk-core.IResolvable Attribute ResourceGroupId: Resource group id.
attrSecondaryZoneId @alicloud/ros-cdk-core.IResolvable Attribute SecondaryZoneId: The ID of the standby zone.
attrSecurityGroupId @alicloud/ros-cdk-core.IResolvable Attribute SecurityGroupId: Security group id.
attrSecurityIpGroupAttribute @alicloud/ros-cdk-core.IResolvable Attribute SecurityIpGroupAttribute: Security IP group attribute.
attrSecurityIpGroupName @alicloud/ros-cdk-core.IResolvable Attribute SecurityIpGroupName: Security IP group name.
attrSecurityIps @alicloud/ros-cdk-core.IResolvable Attribute SecurityIps: Security IPs.
attrShardCount @alicloud/ros-cdk-core.IResolvable Attribute ShardCount: The number of slices.
attrTags @alicloud/ros-cdk-core.IResolvable Attribute Tags: Tags.
attrVpcAuthMode @alicloud/ros-cdk-core.IResolvable Attribute VpcAuthMode: Vpc auth mode.
attrVpcCloudInstanceId @alicloud/ros-cdk-core.IResolvable Attribute VpcCloudInstanceId: Vpc cloud instance id.
attrVpcId @alicloud/ros-cdk-core.IResolvable Attribute VpcId: Vpc id.
attrVSwitchId @alicloud/ros-cdk-core.IResolvable Attribute VSwitchId: Vswitch id.
attrZoneId @alicloud/ros-cdk-core.IResolvable Attribute ZoneId: Zone id.

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: Architecture type.

attrBandwidthRequired 

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

Attribute Bandwidth: Bandwidth.

attrCapacityRequired 

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

Attribute Capacity: Capacity.

attrCloudTypeRequired 

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

Attribute CloudType: Cloud category.

attrConfigRequired 

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

Attribute Config: Config.

attrConnectionDomainRequired 

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

Attribute ConnectionDomain: Connection domain.

attrCreateTimeRequired 

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

Attribute CreateTime: Create time.

attrDbInstanceIdRequired 

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

Attribute DBInstanceId: Database instance id.

attrDbInstanceNameRequired 

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

Attribute DBInstanceName: Instance name.

attrEndTimeRequired 

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

Attribute EndTime: End time.

attrEngineVersionRequired 

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

Attribute EngineVersion: Engine version.

attrHasRenewChangeOrderRequired 

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

Attribute HasRenewChangeOrder: Has renew change order.

attrInstanceClassRequired 

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

Attribute InstanceClass: Instance class.

attrInstanceReleaseProtectionRequired 

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

Attribute InstanceReleaseProtection: Instance release protection.

attrInstanceTypeRequired 

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

Attribute InstanceType: Instance type.

attrIsRdsRequired 

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

Attribute IsRds: is RDS.

attrMaintainEndTimeRequired 

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

Attribute MaintainEndTime: Maintain end time.

attrMaintainStartTimeRequired 

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

Attribute MaintainStartTime: Maintain start time.

attrNetworkTypeRequired 

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

Attribute NetworkType: Network type.

attrPackageTypeRequired 

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

Attribute PackageType: Package type.

attrPaymentTypeRequired 

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

Attribute PaymentType: Payment type.

attrPortRequired 

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

Attribute Port: Port.

attrPrivateIpRequired 

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

Attribute PrivateIp: Private IP.

attrQpsRequired 

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

Attribute Qps: QPS.

attrReadOnlyCountRequired 

public readonly attrReadOnlyCount: IResolvable;
  • Type: @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.

attrReplacateIdRequired 

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

Attribute ReplacateId: Replacate id.

attrResourceGroupIdRequired 

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

Attribute ResourceGroupId: Resource group id.

attrSecondaryZoneIdRequired 

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

Attribute SecondaryZoneId: The ID of the standby zone.

attrSecurityGroupIdRequired 

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

Attribute SecurityGroupId: Security group id.

attrSecurityIpGroupAttributeRequired 

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

Attribute SecurityIpGroupAttribute: Security IP group attribute.

attrSecurityIpGroupNameRequired 

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

Attribute SecurityIpGroupName: Security IP group name.

attrSecurityIpsRequired 

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

Attribute SecurityIps: Security IPs.

attrShardCountRequired 

public readonly attrShardCount: IResolvable;
  • Type: @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.

attrTagsRequired 

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

Attribute Tags: Tags.

attrVpcAuthModeRequired 

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

Attribute VpcAuthMode: Vpc auth mode.

attrVpcCloudInstanceIdRequired 

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

Attribute VpcCloudInstanceId: Vpc cloud instance id.

attrVpcIdRequired 

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

Attribute VpcId: Vpc id.

attrVSwitchIdRequired 

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

Attribute VSwitchId: Vswitch id.

attrZoneIdRequired 

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

Attribute ZoneId: Zone id.