RosInstance

This class is a base encapsulation around the ROS resource type ALIYUN::REDIS::Instance, which is used to create an ApsaraDB for Redis instance.

Initializers

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

Name	Type	Description
scope	@alicloud/ros-cdk-core.Construct	- scope in which this resource is defined.
id	string	- scoped id of the resource.
props	RosInstanceProps	- resource properties.
enableResourcePropertyConstraint	boolean	No description.

---

scope^Required

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

scope in which this resource is defined.

---

id^Required

• Type: string

scoped id of the resource.

---

props^Required

• Type: RosInstanceProps

resource properties.

---

enableResourcePropertyConstraint^Required

• 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.
overrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
addCondition	No description.
addCount	No description.
addDeletionOverride	Syntactic sugar for addOverride(path, undefined).
addDependsOn	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDesc	No description.
addMetaData	No description.
addOverride	Adds an override to the synthesized ROS resource.
addPropertyDeletionOverride	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride	Adds an override to a resource property.
addRosDependency	No description.
applyRemovalPolicy	Sets the deletion policy of the resource based on the removal policy specified.
getAtt	Returns a token for an runtime attribute of this resource.

---

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.

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

addCondition

public addCondition(con: RosCondition): void

con^Required

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

---

addCount

public addCount(count: number | IResolvable): void

count^Required

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

---

addDeletionOverride

public addDeletionOverride(path: string): void

Syntactic sugar for addOverride(path, undefined).

path^Required

• Type: string

The path of the value to delete.

---

addDependsOn

public addDependsOn(target: RosResource): void

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

target^Required

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

---

addDesc

public addDesc(desc: string): void

desc^Required

• Type: string

---

addMetaData

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

key^Required

• Type: string

---

value^Required

• Type: any

---

addOverride

public addOverride(path: string, value: any): void

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

path^Required

• Type: string

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.

---

value^Required

• Type: any

The value.

Could be primitive or complex.

---

addPropertyDeletionOverride

public addPropertyDeletionOverride(propertyPath: string): void

Adds an override that deletes the value of a property from the resource definition.

propertyPath^Required

• Type: string

The path to the property.

---

addPropertyOverride

public addPropertyOverride(propertyPath: string, value: any): void

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

propertyPath^Required

• Type: string

The path of the property.

---

value^Required

• Type: any

The value.

---

addRosDependency

public addRosDependency(target: string): void

target^Required

• Type: string

---

applyRemovalPolicy

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Sets the deletion policy of the resource based on the removal policy specified.

policy^Optional

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

---

options^Optional

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

---

getAtt

public getAtt(attributeName: string): Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

attributeName^Required

• Type: string

The name of the attribute.

---

Static Functions

Name	Description
isConstruct	Return whether the given object is a Construct.
isRosElement	Returns true if a construct is a stack element (i.e. part of the synthesized template).
isRosResource	Check whether the given construct is a RosResource.

---

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: any

---

isRosElement

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

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

x^Required

• Type: any

---

isRosResource

import { RosInstance } from '@alicloud/ros-cdk-redis'
RosInstance.isRosResource(construct: IConstruct)

Check whether the given construct is a RosResource.

construct^Required

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

---

Properties

Name	Type	Description
node	@alicloud/ros-cdk-core.ConstructNode	The construct tree node associated with this construct.
creationStack	string[]	No description.
logicalId	string	The logical ID for this stack element.
stack	@alicloud/ros-cdk-core.Stack	The stack in which this element is defined.
ref	string	Return a string that will be resolved to a RosTemplate { Ref } for this element.
rosOptions	@alicloud/ros-cdk-core.IRosResourceOptions	Options for this resource, such as condition, update policy etc.
rosResourceType	string	ROS resource type.
attrArchitectureType	@alicloud/ros-cdk-core.IResolvable	No description.
attrBandwidth	@alicloud/ros-cdk-core.IResolvable	No description.
attrCapacity	@alicloud/ros-cdk-core.IResolvable	No description.
attrChargeType	@alicloud/ros-cdk-core.IResolvable	No description.
attrClassicInnerConnectionPort	@alicloud/ros-cdk-core.IResolvable	No description.
attrClassicInnerConnectionString	@alicloud/ros-cdk-core.IResolvable	No description.
attrConnectionDomain	@alicloud/ros-cdk-core.IResolvable	No description.
attrConnections	@alicloud/ros-cdk-core.IResolvable	No description.
attrDirectConnectionPort	@alicloud/ros-cdk-core.IResolvable	No description.
attrDirectConnectionString	@alicloud/ros-cdk-core.IResolvable	No description.
attrEngineVersion	@alicloud/ros-cdk-core.IResolvable	No description.
attrHasRenewChangeOrder	@alicloud/ros-cdk-core.IResolvable	No description.
attrInstanceClass	@alicloud/ros-cdk-core.IResolvable	No description.
attrInstanceId	@alicloud/ros-cdk-core.IResolvable	No description.
attrInstanceName	@alicloud/ros-cdk-core.IResolvable	No description.
attrInstanceType	@alicloud/ros-cdk-core.IResolvable	No description.
attrNetworkType	@alicloud/ros-cdk-core.IResolvable	No description.
attrNodeType	@alicloud/ros-cdk-core.IResolvable	No description.
attrOrderId	@alicloud/ros-cdk-core.IResolvable	No description.
attrPackageType	@alicloud/ros-cdk-core.IResolvable	No description.
attrPort	@alicloud/ros-cdk-core.IResolvable	No description.
attrPrivateIp	@alicloud/ros-cdk-core.IResolvable	No description.
attrPublicConnectionPort	@alicloud/ros-cdk-core.IResolvable	No description.
attrPublicConnectionString	@alicloud/ros-cdk-core.IResolvable	No description.
attrQps	@alicloud/ros-cdk-core.IResolvable	No description.
attrResourceGroupId	@alicloud/ros-cdk-core.IResolvable	No description.
attrVpcId	@alicloud/ros-cdk-core.IResolvable	No description.
attrVpcPrivateConnectionPort	@alicloud/ros-cdk-core.IResolvable	No description.
attrVpcPrivateConnectionString	@alicloud/ros-cdk-core.IResolvable	No description.
attrVSwitchId	@alicloud/ros-cdk-core.IResolvable	No description.
attrZoneId	@alicloud/ros-cdk-core.IResolvable	No description.
enableResourcePropertyConstraint	boolean	No description.
autoRenewDuration	number | @alicloud/ros-cdk-core.IResolvable	No description.
backupPolicy	@alicloud/ros-cdk-core.IResolvable | BackupPolicyProperty	No description.
chargeType	string | @alicloud/ros-cdk-core.IResolvable	No description.
connections	@alicloud/ros-cdk-core.IResolvable | ConnectionsProperty	No description.
deletionForce	boolean | @alicloud/ros-cdk-core.IResolvable	No description.
engineVersion	string | @alicloud/ros-cdk-core.IResolvable	No description.
evictionPolicy	string | @alicloud/ros-cdk-core.IResolvable	No description.
instanceClass	string | @alicloud/ros-cdk-core.IResolvable	No description.
instanceMaintainTime	@alicloud/ros-cdk-core.IResolvable | InstanceMaintainTimeProperty	No description.
instanceName	string | @alicloud/ros-cdk-core.IResolvable	No description.
nodeType	string | @alicloud/ros-cdk-core.IResolvable	No description.
password	string | @alicloud/ros-cdk-core.IResolvable	No description.
period	number | @alicloud/ros-cdk-core.IResolvable	No description.
periodUnit	string | @alicloud/ros-cdk-core.IResolvable	No description.
productType	string | @alicloud/ros-cdk-core.IResolvable	No description.
resourceGroupId	string | @alicloud/ros-cdk-core.IResolvable	No description.
secondaryZoneId	string | @alicloud/ros-cdk-core.IResolvable	No description.
securityGroupId	string | @alicloud/ros-cdk-core.IResolvable	No description.
shardCount	number | @alicloud/ros-cdk-core.IResolvable	No description.
sslEnabled	string | @alicloud/ros-cdk-core.IResolvable	No description.
tags	TagsProperty[]	No description.
tairConfig	@alicloud/ros-cdk-core.IResolvable | TairConfigProperty	No description.
vpcId	string | @alicloud/ros-cdk-core.IResolvable	No description.
vpcPasswordFree	boolean | @alicloud/ros-cdk-core.IResolvable	No description.
vSwitchId	string | @alicloud/ros-cdk-core.IResolvable	No description.
zoneId	string | @alicloud/ros-cdk-core.IResolvable	No description.

---

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

---

logicalId^Required

public readonly logicalId: string;

• Type: string

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

stack^Required

public readonly stack: Stack;

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

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).

---

ref^Required

public readonly ref: string;

• Type: string

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

rosOptions^Required

public readonly rosOptions: IRosResourceOptions;

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

Options for this resource, such as condition, update policy etc.

---

rosResourceType^Required

public readonly rosResourceType: string;

• Type: string

ROS resource type.

---

attrArchitectureType^Required

public readonly attrArchitectureType: IResolvable;

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

---

attrBandwidth^Required

public readonly attrBandwidth: IResolvable;

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

---

attrCapacity^Required

public readonly attrCapacity: IResolvable;

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

---

attrChargeType^Required

public readonly attrChargeType: IResolvable;

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

---

attrClassicInnerConnectionPort^Required

public readonly attrClassicInnerConnectionPort: IResolvable;

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

---

attrClassicInnerConnectionString^Required

public readonly attrClassicInnerConnectionString: IResolvable;

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

---

attrConnectionDomain^Required

public readonly attrConnectionDomain: IResolvable;

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

---

attrConnections^Required

public readonly attrConnections: IResolvable;

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

---

attrDirectConnectionPort^Required

public readonly attrDirectConnectionPort: IResolvable;

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

---

attrDirectConnectionString^Required

public readonly attrDirectConnectionString: IResolvable;

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

---

attrEngineVersion^Required

public readonly attrEngineVersion: IResolvable;

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

---

attrHasRenewChangeOrder^Required

public readonly attrHasRenewChangeOrder: IResolvable;

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

---

attrInstanceClass^Required

public readonly attrInstanceClass: IResolvable;

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

---

attrInstanceId^Required

public readonly attrInstanceId: IResolvable;

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

---

attrInstanceName^Required

public readonly attrInstanceName: IResolvable;

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

---

attrInstanceType^Required

public readonly attrInstanceType: IResolvable;

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

---

attrNetworkType^Required

public readonly attrNetworkType: IResolvable;

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

---

attrNodeType^Required

public readonly attrNodeType: IResolvable;

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

---

attrOrderId^Required

public readonly attrOrderId: IResolvable;

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

---

attrPackageType^Required

public readonly attrPackageType: IResolvable;

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

---

attrPort^Required

public readonly attrPort: IResolvable;

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

---

attrPrivateIp^Required

public readonly attrPrivateIp: IResolvable;

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

---

attrPublicConnectionPort^Required

public readonly attrPublicConnectionPort: IResolvable;

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

---

attrPublicConnectionString^Required

public readonly attrPublicConnectionString: IResolvable;

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

---

attrQps^Required

public readonly attrQps: IResolvable;

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

---

attrResourceGroupId^Required

public readonly attrResourceGroupId: IResolvable;

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

---

attrVpcId^Required

public readonly attrVpcId: IResolvable;

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

---

attrVpcPrivateConnectionPort^Required

public readonly attrVpcPrivateConnectionPort: IResolvable;

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

---

attrVpcPrivateConnectionString^Required

public readonly attrVpcPrivateConnectionString: IResolvable;

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

---

attrVSwitchId^Required

public readonly attrVSwitchId: IResolvable;

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

---

attrZoneId^Required

public readonly attrZoneId: IResolvable;

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

---

enableResourcePropertyConstraint^Required

public readonly enableResourcePropertyConstraint: boolean;

• Type: boolean

---

autoRenewDuration^Optional

public readonly autoRenewDuration: number | IResolvable;

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

---

backupPolicy^Optional

public readonly backupPolicy: IResolvable | BackupPolicyProperty;

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

---

chargeType^Optional

public readonly chargeType: string | IResolvable;

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

---

connections^Optional

public readonly connections: IResolvable | ConnectionsProperty;

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

---

deletionForce^Optional

public readonly deletionForce: boolean | IResolvable;

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

---

engineVersion^Optional

public readonly engineVersion: string | IResolvable;

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

---

evictionPolicy^Optional

public readonly evictionPolicy: string | IResolvable;

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

---

instanceClass^Optional

public readonly instanceClass: string | IResolvable;

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

---

instanceMaintainTime^Optional

public readonly instanceMaintainTime: IResolvable | InstanceMaintainTimeProperty;

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

---

instanceName^Optional

public readonly instanceName: string | IResolvable;

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

---

nodeType^Optional

public readonly nodeType: string | IResolvable;

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

---

password^Optional

public readonly password: string | IResolvable;

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

---

period^Optional

public readonly period: number | IResolvable;

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

---

periodUnit^Optional

public readonly periodUnit: string | IResolvable;

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

---

productType^Optional

public readonly productType: string | IResolvable;

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

---

resourceGroupId^Optional

public readonly resourceGroupId: string | IResolvable;

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

---

secondaryZoneId^Optional

public readonly secondaryZoneId: string | IResolvable;

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

---

securityGroupId^Optional

public readonly securityGroupId: string | IResolvable;

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

---

shardCount^Optional

public readonly shardCount: number | IResolvable;

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

---

sslEnabled^Optional

public readonly sslEnabled: string | IResolvable;

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

---

tags^Optional

public readonly tags: TagsProperty[];

• Type: TagsProperty[]

---

tairConfig^Optional

public readonly tairConfig: IResolvable | TairConfigProperty;

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

---

vpcId^Optional

public readonly vpcId: string | IResolvable;

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

---

vpcPasswordFree^Optional

public readonly vpcPasswordFree: boolean | IResolvable;

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

---

vSwitchId^Optional

public readonly vSwitchId: string | IResolvable;

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

---

zoneId^Optional

public readonly zoneId: string | IResolvable;

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

---

Constants

Name	Type	Description
ROS_RESOURCE_TYPE_NAME	string	The resource type name for this resource class.

---

ROS_RESOURCE_TYPE_NAME^Required

public readonly ROS_RESOURCE_TYPE_NAME: string;

• Type: string

The resource type name for this resource class.

---