Skip to content

Instance

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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
endpoints typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, EndpointsProperty]]] Property endpoints: List of domain names.
instance_name typing.Union[str, ros_cdk_core.IResolvable] Property instanceName: The name of the resource.
instance_type typing.Union[str, ros_cdk_core.IResolvable] Property instanceType: The instance type.
payment_type typing.Union[str, ros_cdk_core.IResolvable] Property paymentType: The payment type of the resource.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: The zone Id.
auto_pay typing.Union[bool, ros_cdk_core.IResolvable] Property autoPay: Whether to pay automatically.
cold_storage_size typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property coldStorageSize: Instance low-frequency storage space.
cpu typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property cpu: Instance specifications.
duration typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property duration: The buying cycle.
gateway_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property gatewayCount: Number of gateway nodes.
initial_databases typing.Union[str, ros_cdk_core.IResolvable] Property initialDatabases: Initialize the database and split multiple database names ",".
leader_instance_id typing.Union[str, ros_cdk_core.IResolvable] Property leaderInstanceId: The id of leader instance.
pricing_cycle typing.Union[str, ros_cdk_core.IResolvable] Property pricingCycle: Billing cycle.
product_code typing.Union[str, ros_cdk_core.IResolvable] Property productCode: product code.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group.
scale_type typing.Union[str, ros_cdk_core.IResolvable] Property scaleType: Change matching type.
storage_size typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property storageSize: The standard storage space of the instance.
tags typing.List[TagsProperty] Property tags: Tags of instance.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

endpointsRequired

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

Property endpoints: List of domain names.

instance_nameRequired

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

Property instanceName: The name of the resource.

instance_typeRequired

  • 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_typeRequired

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

Property paymentType: The payment type of the resource.

zone_idRequired

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

Property zoneId: The zone Id.

auto_payOptional

  • 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_sizeOptional

  • 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.

cpuOptional

  • 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.

durationOptional

  • 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_countOptional

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

Property gatewayCount: Number of gateway nodes.

initial_databasesOptional

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

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

leader_instance_idOptional

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

Property leaderInstanceId: The id of leader instance.

pricing_cycleOptional

  • 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_codeOptional

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

Property productCode: product code.

resource_group_idOptional

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

Property resourceGroupId: The ID of the resource group.

scale_typeOptional

  • 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_sizeOptional

  • 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.

tagsOptional

Property tags: Tags of instance.

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 

import ros_cdk_hologram
ros_cdk_hologram.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_auto_renewal ros_cdk_core.IResolvable Attribute AutoRenewal: Whether automatic renewal is enabled.
attr_cold_storage_size ros_cdk_core.IResolvable Attribute ColdStorageSize: Instance low-frequency storage space.
attr_commodity_code ros_cdk_core.IResolvable Attribute CommodityCode: The commodity code.
attr_compute_node_count ros_cdk_core.IResolvable Attribute ComputeNodeCount: Number of compute nodes.
attr_cpu ros_cdk_core.IResolvable Attribute Cpu: Instance specifications.
attr_create_time ros_cdk_core.IResolvable Attribute CreateTime: The creation time of the resource.
attr_enable_hive_access ros_cdk_core.IResolvable Attribute EnableHiveAccess: Whether data Lake acceleration is enabled.
attr_endpoints ros_cdk_core.IResolvable Attribute Endpoints: List of domain names.
attr_expiration_time ros_cdk_core.IResolvable Attribute ExpirationTime: Expiration time.
attr_gateway_count ros_cdk_core.IResolvable Attribute GatewayCount: Number of gateway nodes.
attr_gateway_cpu ros_cdk_core.IResolvable Attribute GatewayCpu: Cpu resources of the Gateway.
attr_gateway_memory ros_cdk_core.IResolvable Attribute GatewayMemory: Gateway memory resources.
attr_instance_id ros_cdk_core.IResolvable Attribute InstanceId: Resource attribute fields that represent the resource's primary key.
attr_instance_name ros_cdk_core.IResolvable Attribute InstanceName: The name of the resource.
attr_instance_owner ros_cdk_core.IResolvable Attribute InstanceOwner: The instance owner.
attr_instance_type ros_cdk_core.IResolvable Attribute InstanceType: The instance type.
attr_memory ros_cdk_core.IResolvable Attribute Memory: Memory.
attr_payment_type ros_cdk_core.IResolvable Attribute PaymentType: The payment type of the resource.
attr_resource_group_id ros_cdk_core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attr_storage_size ros_cdk_core.IResolvable Attribute StorageSize: The standard storage space of the instance.
attr_suspend_reason ros_cdk_core.IResolvable Attribute SuspendReason: Reason for suspension.
attr_tags ros_cdk_core.IResolvable Attribute Tags: Instance tag.
attr_version ros_cdk_core.IResolvable Attribute Version: The instance version.
attr_zone_id ros_cdk_core.IResolvable Attribute ZoneId: The 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_auto_renewalRequired 

attr_auto_renewal: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AutoRenewal: Whether automatic renewal is enabled.

attr_cold_storage_sizeRequired 

attr_cold_storage_size: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ColdStorageSize: Instance low-frequency storage space.

Unit: GB.

attr_commodity_codeRequired 

attr_commodity_code: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CommodityCode: The commodity code.

attr_compute_node_countRequired 

attr_compute_node_count: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ComputeNodeCount: Number of compute nodes.

attr_cpuRequired 

attr_cpu: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Cpu: Instance specifications.

attr_create_timeRequired 

attr_create_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTime: The creation time of the resource.

attr_enable_hive_accessRequired 

attr_enable_hive_access: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EnableHiveAccess: Whether data Lake acceleration is enabled.

attr_endpointsRequired 

attr_endpoints: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Endpoints: List of domain names.

attr_expiration_timeRequired 

attr_expiration_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ExpirationTime: Expiration time.

attr_gateway_countRequired 

attr_gateway_count: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute GatewayCount: Number of gateway nodes.

attr_gateway_cpuRequired 

attr_gateway_cpu: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute GatewayCpu: Cpu resources of the Gateway.

attr_gateway_memoryRequired 

attr_gateway_memory: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute GatewayMemory: Gateway memory resources.

attr_instance_idRequired 

attr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_instance_nameRequired 

attr_instance_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceName: The name of the resource.

attr_instance_ownerRequired 

attr_instance_owner: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceOwner: The instance owner.

attr_instance_typeRequired 

attr_instance_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceType: The instance type.

attr_memoryRequired 

attr_memory: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Memory: Memory.

attr_payment_typeRequired 

attr_payment_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PaymentType: The payment type of the resource.

attr_resource_group_idRequired 

attr_resource_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attr_storage_sizeRequired 

attr_storage_size: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute StorageSize: The standard storage space of the instance.

Unit: GB.

attr_suspend_reasonRequired 

attr_suspend_reason: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SuspendReason: Reason for suspension.

attr_tagsRequired 

attr_tags: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Tags: Instance tag.

attr_versionRequired 

attr_version: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Version: The instance version.

attr_zone_idRequired 

attr_zone_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ZoneId: The zone Id.