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 

from ros_cdk_redis import datasource
datasource.Instance(
  scope: Construct,
  id: str,
  db_instance_id: typing.Union[str, IResolvable],
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
db_instance_id typing.Union[str, ros_cdk_core.IResolvable] Property dbInstanceId: Database instance id.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

db_instance_idRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property dbInstanceId: Database instance id.

refresh_optionsOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct 

from ros_cdk_redis import datasource
datasource.Instance.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_architecture_type ros_cdk_core.IResolvable Attribute ArchitectureType: Architecture type.
attr_bandwidth ros_cdk_core.IResolvable Attribute Bandwidth: Bandwidth.
attr_capacity ros_cdk_core.IResolvable Attribute Capacity: Capacity.
attr_cloud_type ros_cdk_core.IResolvable Attribute CloudType: Cloud category.
attr_config ros_cdk_core.IResolvable Attribute Config: Config.
attr_connection_domain ros_cdk_core.IResolvable Attribute ConnectionDomain: Connection domain.
attr_create_time ros_cdk_core.IResolvable Attribute CreateTime: Create time.
attr_db_instance_id ros_cdk_core.IResolvable Attribute DBInstanceId: Database instance id.
attr_db_instance_name ros_cdk_core.IResolvable Attribute DBInstanceName: Instance name.
attr_end_time ros_cdk_core.IResolvable Attribute EndTime: End time.
attr_engine_version ros_cdk_core.IResolvable Attribute EngineVersion: Engine version.
attr_has_renew_change_order ros_cdk_core.IResolvable Attribute HasRenewChangeOrder: Has renew change order.
attr_instance_class ros_cdk_core.IResolvable Attribute InstanceClass: Instance class.
attr_instance_release_protection ros_cdk_core.IResolvable Attribute InstanceReleaseProtection: Instance release protection.
attr_instance_type ros_cdk_core.IResolvable Attribute InstanceType: Instance type.
attr_is_rds ros_cdk_core.IResolvable Attribute IsRds: is RDS.
attr_maintain_end_time ros_cdk_core.IResolvable Attribute MaintainEndTime: Maintain end time.
attr_maintain_start_time ros_cdk_core.IResolvable Attribute MaintainStartTime: Maintain start time.
attr_network_type ros_cdk_core.IResolvable Attribute NetworkType: Network type.
attr_package_type ros_cdk_core.IResolvable Attribute PackageType: Package type.
attr_payment_type ros_cdk_core.IResolvable Attribute PaymentType: Payment type.
attr_port ros_cdk_core.IResolvable Attribute Port: Port.
attr_private_ip ros_cdk_core.IResolvable Attribute PrivateIp: Private IP.
attr_qps ros_cdk_core.IResolvable Attribute Qps: QPS.
attr_read_only_count ros_cdk_core.IResolvable Attribute ReadOnlyCount: The number of read-only nodes.
attr_replacate_id ros_cdk_core.IResolvable Attribute ReplacateId: Replacate id.
attr_resource_group_id ros_cdk_core.IResolvable Attribute ResourceGroupId: Resource group id.
attr_secondary_zone_id ros_cdk_core.IResolvable Attribute SecondaryZoneId: The ID of the standby zone.
attr_security_group_id ros_cdk_core.IResolvable Attribute SecurityGroupId: Security group id.
attr_security_ip_group_attribute ros_cdk_core.IResolvable Attribute SecurityIpGroupAttribute: Security IP group attribute.
attr_security_ip_group_name ros_cdk_core.IResolvable Attribute SecurityIpGroupName: Security IP group name.
attr_security_ips ros_cdk_core.IResolvable Attribute SecurityIps: Security IPs.
attr_shard_count ros_cdk_core.IResolvable Attribute ShardCount: The number of slices.
attr_tags ros_cdk_core.IResolvable Attribute Tags: Tags.
attr_vpc_auth_mode ros_cdk_core.IResolvable Attribute VpcAuthMode: Vpc auth mode.
attr_vpc_cloud_instance_id ros_cdk_core.IResolvable Attribute VpcCloudInstanceId: Vpc cloud instance id.
attr_vpc_id ros_cdk_core.IResolvable Attribute VpcId: Vpc id.
attr_v_switch_id ros_cdk_core.IResolvable Attribute VSwitchId: Vswitch id.
attr_zone_id ros_cdk_core.IResolvable Attribute ZoneId: Zone id.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_architecture_typeRequired 

attr_architecture_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ArchitectureType: Architecture type.

attr_bandwidthRequired 

attr_bandwidth: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Bandwidth: Bandwidth.

attr_capacityRequired 

attr_capacity: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Capacity: Capacity.

attr_cloud_typeRequired 

attr_cloud_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CloudType: Cloud category.

attr_configRequired 

attr_config: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Config: Config.

attr_connection_domainRequired 

attr_connection_domain: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ConnectionDomain: Connection domain.

attr_create_timeRequired 

attr_create_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTime: Create time.

attr_db_instance_idRequired 

attr_db_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DBInstanceId: Database instance id.

attr_db_instance_nameRequired 

attr_db_instance_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DBInstanceName: Instance name.

attr_end_timeRequired 

attr_end_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EndTime: End time.

attr_engine_versionRequired 

attr_engine_version: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EngineVersion: Engine version.

attr_has_renew_change_orderRequired 

attr_has_renew_change_order: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute HasRenewChangeOrder: Has renew change order.

attr_instance_classRequired 

attr_instance_class: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceClass: Instance class.

attr_instance_release_protectionRequired 

attr_instance_release_protection: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceReleaseProtection: Instance release protection.

attr_instance_typeRequired 

attr_instance_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceType: Instance type.

attr_is_rdsRequired 

attr_is_rds: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute IsRds: is RDS.

attr_maintain_end_timeRequired 

attr_maintain_end_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute MaintainEndTime: Maintain end time.

attr_maintain_start_timeRequired 

attr_maintain_start_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute MaintainStartTime: Maintain start time.

attr_network_typeRequired 

attr_network_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute NetworkType: Network type.

attr_package_typeRequired 

attr_package_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PackageType: Package type.

attr_payment_typeRequired 

attr_payment_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PaymentType: Payment type.

attr_portRequired 

attr_port: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Port: Port.

attr_private_ipRequired 

attr_private_ip: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PrivateIp: Private IP.

attr_qpsRequired 

attr_qps: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Qps: QPS.

attr_read_only_countRequired 

attr_read_only_count: IResolvable
  • Type: 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.

attr_replacate_idRequired 

attr_replacate_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ReplacateId: Replacate id.

attr_resource_group_idRequired 

attr_resource_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ResourceGroupId: Resource group id.

attr_secondary_zone_idRequired 

attr_secondary_zone_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SecondaryZoneId: The ID of the standby zone.

attr_security_group_idRequired 

attr_security_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SecurityGroupId: Security group id.

attr_security_ip_group_attributeRequired 

attr_security_ip_group_attribute: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SecurityIpGroupAttribute: Security IP group attribute.

attr_security_ip_group_nameRequired 

attr_security_ip_group_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SecurityIpGroupName: Security IP group name.

attr_security_ipsRequired 

attr_security_ips: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SecurityIps: Security IPs.

attr_shard_countRequired 

attr_shard_count: IResolvable
  • Type: 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.

attr_tagsRequired 

attr_tags: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Tags: Tags.

attr_vpc_auth_modeRequired 

attr_vpc_auth_mode: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpcAuthMode: Vpc auth mode.

attr_vpc_cloud_instance_idRequired 

attr_vpc_cloud_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpcCloudInstanceId: Vpc cloud instance id.

attr_vpc_idRequired 

attr_vpc_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpcId: Vpc id.

attr_v_switch_idRequired 

attr_v_switch_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VSwitchId: Vswitch id.

attr_zone_idRequired 

attr_zone_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ZoneId: Zone id.