Instance

• Implements: IInstance

This class encapsulates and extends the ROS resource type ALIYUN::Hologram::Instance, which is used to create a Hologres instance.

Initializers

import ros_cdk_hologram
ros_cdk_hologram.Instance(
  scope: Construct,
  id: str,
  endpoints: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, EndpointsProperty]]],
  instance_name: typing.Union[str, IResolvable],
  instance_type: typing.Union[str, IResolvable],
  payment_type: typing.Union[str, IResolvable],
  zone_id: typing.Union[str, IResolvable],
  auto_pay: typing.Union[bool, IResolvable] = None,
  cold_storage_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  cpu: typing.Union[typing.Union[int, float], IResolvable] = None,
  duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  gateway_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  initial_databases: typing.Union[str, IResolvable] = None,
  leader_instance_id: typing.Union[str, IResolvable] = None,
  pricing_cycle: typing.Union[str, IResolvable] = None,
  product_code: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  scale_type: typing.Union[str, IResolvable] = None,
  storage_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

endpoints^Required

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, EndpointsProperty]]]

Property endpoints: List of domain names.

instance_name^Required

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

Property instanceName: The name of the resource.

instance_type^Required

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

Property instanceType: The instance type.

Value:

• Standard: Universal.
• Follower: Read-only slave instance.
• Warehouse: calculation group type.
• Shared: Shared.

payment_type^Required

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

Property paymentType: The payment type of the resource.

zone_id^Required

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

Property zoneId: The zone Id.

auto_pay^Optional

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

Property autoPay: Whether to pay automatically.

The default value is true. Value:

• true: automatic payment
• false: only generate orders, not pay

The default value is true. If the balance of your payment method is insufficient, you can set the parameter AutoPay to false, and an unpaid order will be generated. You can log in to the user Center to pay by yourself.

cold_storage_size^Optional

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

Property coldStorageSize: Instance low-frequency storage space.

Unit: GB.

Pay-As-You-Go (PostPaid) instances ignore this parameter.

cpu^Optional

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

Property cpu: Instance specifications.

Value:

• 8 cores 32 GB (number of compute nodes: 1)
• 16 cores 64 GB (number of compute nodes: 1)
• 32 core 128 GB (number of compute nodes: 2)
• 64 core 256 GB (number of compute nodes: 4)
• 96 core 384 GB (number of computing nodes: 6)
• 128 core 512 GB (number of compute nodes: 8)
• Wait

• just fill in the audit number.
• Please submit a work order application for purchasing 1024 or above specifications.
• Shared instance types do not need to specify specifications. The specification of -8 core 32GB (number of computing nodes: 1) is only for experience use and cannot be used for production.

duration^Optional

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

Property duration: The buying cycle.

Buy for 2 months.

If the Payment type is PostPaid, you do not need to specify it.

gateway_count^Optional

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

Property gatewayCount: Number of gateway nodes.

initial_databases^Optional

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

Property initialDatabases: Initialize the database and split multiple database names ",".

leader_instance_id^Optional

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

Property leaderInstanceId: The id of leader instance.

pricing_cycle^Optional

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

Property pricingCycle: Billing cycle.

Value:

• Month: monthly billing
• Hour: hourly billing

• PrePaid only supports Month
• PostPaid only supports Hour
• The Shared type is automatically set to Hour without specifying it.

product_code^Optional

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

Property productCode: product code.

resource_group_id^Optional

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

Property resourceGroupId: The ID of the resource group.

scale_type^Optional

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

Property scaleType: Change matching type.

Value:

• UPGRADE: UPGRADE
• DOWNGRADE: Downgrading

• The upgrade specification cannot be less than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is larger than the original specification.
• The downgrading specification cannot be greater than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is smaller than the original specification.

storage_size^Optional

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

Property storageSize: The standard storage space of the instance.

Unit: GB.

Pay-As-You-Go instances (PostPaid) ignore this parameter.

tags^Optional

• Type: typing.List[TagsProperty]

Property tags: Tags of instance.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_hologram
ros_cdk_hologram.Instance.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_auto_renewal^Required

attr_auto_renewal: typing.Union[str, IResolvable]

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

Attribute AutoRenewal: Whether automatic renewal is enabled.

attr_cold_storage_size^Required

attr_cold_storage_size: typing.Union[str, IResolvable]

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

Attribute ColdStorageSize: Instance low-frequency storage space.

Unit: GB.

attr_commodity_code^Required

attr_commodity_code: typing.Union[str, IResolvable]

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

Attribute CommodityCode: The commodity code.

attr_compute_node_count^Required

attr_compute_node_count: typing.Union[str, IResolvable]

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

Attribute ComputeNodeCount: Number of compute nodes.

attr_cpu^Required

attr_cpu: typing.Union[str, IResolvable]

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

Attribute Cpu: Instance specifications.

attr_create_time^Required

attr_create_time: typing.Union[str, IResolvable]

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

Attribute CreateTime: The creation time of the resource.

attr_enable_hive_access^Required

attr_enable_hive_access: typing.Union[str, IResolvable]

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

Attribute EnableHiveAccess: Whether data Lake acceleration is enabled.

attr_endpoints^Required

attr_endpoints: typing.Union[str, IResolvable]

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

Attribute Endpoints: List of domain names.

attr_expiration_time^Required

attr_expiration_time: typing.Union[str, IResolvable]

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

Attribute ExpirationTime: Expiration time.

attr_gateway_count^Required

attr_gateway_count: typing.Union[str, IResolvable]

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

Attribute GatewayCount: Number of gateway nodes.

attr_gateway_cpu^Required

attr_gateway_cpu: typing.Union[str, IResolvable]

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

Attribute GatewayCpu: Cpu resources of the Gateway.

attr_gateway_memory^Required

attr_gateway_memory: typing.Union[str, IResolvable]

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

Attribute GatewayMemory: Gateway memory resources.

attr_instance_id^Required

attr_instance_id: typing.Union[str, IResolvable]

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

Attribute InstanceId: Resource attribute fields that represent the resource's primary key.

attr_instance_name^Required

attr_instance_name: typing.Union[str, IResolvable]

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

Attribute InstanceName: The name of the resource.

attr_instance_owner^Required

attr_instance_owner: typing.Union[str, IResolvable]

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

Attribute InstanceOwner: The instance owner.

attr_instance_type^Required

attr_instance_type: typing.Union[str, IResolvable]

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

Attribute InstanceType: The instance type.

attr_memory^Required

attr_memory: typing.Union[str, IResolvable]

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

Attribute Memory: Memory.

attr_payment_type^Required

attr_payment_type: typing.Union[str, IResolvable]

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

Attribute PaymentType: The payment type of the resource.

attr_resource_group_id^Required

attr_resource_group_id: typing.Union[str, IResolvable]

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

Attribute ResourceGroupId: The ID of the resource group.

attr_storage_size^Required

attr_storage_size: typing.Union[str, IResolvable]

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

Attribute StorageSize: The standard storage space of the instance.

Unit: GB.

attr_suspend_reason^Required

attr_suspend_reason: typing.Union[str, IResolvable]

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

Attribute SuspendReason: Reason for suspension.

attr_tags^Required

attr_tags: typing.Union[str, IResolvable]

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

Attribute Tags: Instance tag.

attr_version^Required

attr_version: typing.Union[str, IResolvable]

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

Attribute Version: The instance version.

attr_zone_id^Required

attr_zone_id: typing.Union[str, IResolvable]

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

Attribute ZoneId: The zone Id.

props^Required

props: InstanceProps

• Type: InstanceProps