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 com.aliyun.ros.cdk.hologram.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .endpoints(IResolvable)
    .endpoints(java.util.List<IResolvable)
    .endpoints(EndpointsProperty>)
    .instanceName(java.lang.String)
    .instanceName(IResolvable)
    .instanceType(java.lang.String)
    .instanceType(IResolvable)
    .paymentType(java.lang.String)
    .paymentType(IResolvable)
    .zoneId(java.lang.String)
    .zoneId(IResolvable)
//  .autoPay(java.lang.Boolean)
//  .autoPay(IResolvable)
//  .coldStorageSize(java.lang.Number)
//  .coldStorageSize(IResolvable)
//  .cpu(java.lang.Number)
//  .cpu(IResolvable)
//  .duration(java.lang.Number)
//  .duration(IResolvable)
//  .gatewayCount(java.lang.Number)
//  .gatewayCount(IResolvable)
//  .initialDatabases(java.lang.String)
//  .initialDatabases(IResolvable)
//  .leaderInstanceId(java.lang.String)
//  .leaderInstanceId(IResolvable)
//  .pricingCycle(java.lang.String)
//  .pricingCycle(IResolvable)
//  .productCode(java.lang.String)
//  .productCode(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .scaleType(java.lang.String)
//  .scaleType(IResolvable)
//  .storageSize(java.lang.Number)
//  .storageSize(IResolvable)
//  .tags(java.util.List<TagsProperty>)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
endpoints com.aliyun.ros.cdk.core.IResolvable OR java.util.ListEndpointsProperty> Property endpoints: List of domain names.
instanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceName: The name of the resource.
instanceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceType: The instance type.
paymentType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property paymentType: The payment type of the resource.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: The zone Id.
autoPay java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property autoPay: Whether to pay automatically.
coldStorageSize java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property coldStorageSize: Instance low-frequency storage space.
cpu java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property cpu: Instance specifications.
duration java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property duration: The buying cycle.
gatewayCount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property gatewayCount: Number of gateway nodes.
initialDatabases java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property initialDatabases: Initialize the database and split multiple database names ",".
leaderInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property leaderInstanceId: The id of leader instance.
pricingCycle java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property pricingCycle: Billing cycle.
productCode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property productCode: product code.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group.
scaleType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property scaleType: Change matching type.
storageSize java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property storageSize: The standard storage space of the instance.
tags java.util.List<TagsProperty> Property tags: Tags of instance.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

endpointsRequired

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListEndpointsProperty>

Property endpoints: List of domain names.

instanceNameRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceName: The name of the resource.

instanceTypeRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceType: The instance type.

Value:

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

paymentTypeRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property paymentType: The payment type of the resource.

zoneIdRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property zoneId: The zone Id.

autoPayOptional

  • Type: java.lang.Boolean OR com.aliyun.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.

coldStorageSizeOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property coldStorageSize: Instance low-frequency storage space.

Unit: GB.

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

cpuOptional

  • Type: java.lang.Number OR com.aliyun.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: java.lang.Number OR com.aliyun.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.

gatewayCountOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property gatewayCount: Number of gateway nodes.

initialDatabasesOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

leaderInstanceIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property leaderInstanceId: The id of leader instance.

pricingCycleOptional

  • Type: java.lang.String OR com.aliyun.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.

productCodeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property productCode: product code.

resourceGroupIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group.

scaleTypeOptional

  • Type: java.lang.String OR com.aliyun.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.

storageSizeOptional

  • Type: java.lang.Number OR com.aliyun.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.

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 java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

import com.aliyun.ros.cdk.hologram.Instance;
Instance.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrAutoRenewal com.aliyun.ros.cdk.core.IResolvable Attribute AutoRenewal: Whether automatic renewal is enabled.
attrColdStorageSize com.aliyun.ros.cdk.core.IResolvable Attribute ColdStorageSize: Instance low-frequency storage space.
attrCommodityCode com.aliyun.ros.cdk.core.IResolvable Attribute CommodityCode: The commodity code.
attrComputeNodeCount com.aliyun.ros.cdk.core.IResolvable Attribute ComputeNodeCount: Number of compute nodes.
attrCpu com.aliyun.ros.cdk.core.IResolvable Attribute Cpu: Instance specifications.
attrCreateTime com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: The creation time of the resource.
attrEnableHiveAccess com.aliyun.ros.cdk.core.IResolvable Attribute EnableHiveAccess: Whether data Lake acceleration is enabled.
attrEndpoints com.aliyun.ros.cdk.core.IResolvable Attribute Endpoints: List of domain names.
attrExpirationTime com.aliyun.ros.cdk.core.IResolvable Attribute ExpirationTime: Expiration time.
attrGatewayCount com.aliyun.ros.cdk.core.IResolvable Attribute GatewayCount: Number of gateway nodes.
attrGatewayCpu com.aliyun.ros.cdk.core.IResolvable Attribute GatewayCpu: Cpu resources of the Gateway.
attrGatewayMemory com.aliyun.ros.cdk.core.IResolvable Attribute GatewayMemory: Gateway memory resources.
attrInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute InstanceId: Resource attribute fields that represent the resource's primary key.
attrInstanceName com.aliyun.ros.cdk.core.IResolvable Attribute InstanceName: The name of the resource.
attrInstanceOwner com.aliyun.ros.cdk.core.IResolvable Attribute InstanceOwner: The instance owner.
attrInstanceType com.aliyun.ros.cdk.core.IResolvable Attribute InstanceType: The instance type.
attrMemory com.aliyun.ros.cdk.core.IResolvable Attribute Memory: Memory.
attrPaymentType com.aliyun.ros.cdk.core.IResolvable Attribute PaymentType: The payment type of the resource.
attrResourceGroupId com.aliyun.ros.cdk.core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrStorageSize com.aliyun.ros.cdk.core.IResolvable Attribute StorageSize: The standard storage space of the instance.
attrSuspendReason com.aliyun.ros.cdk.core.IResolvable Attribute SuspendReason: Reason for suspension.
attrTags com.aliyun.ros.cdk.core.IResolvable Attribute Tags: Instance tag.
attrVersion com.aliyun.ros.cdk.core.IResolvable Attribute Version: The instance version.
attrZoneId com.aliyun.ros.cdk.core.IResolvable Attribute ZoneId: The zone Id.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrAutoRenewalRequired 

public IResolvable getAttrAutoRenewal();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute AutoRenewal: Whether automatic renewal is enabled.

attrColdStorageSizeRequired 

public IResolvable getAttrColdStorageSize();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ColdStorageSize: Instance low-frequency storage space.

Unit: GB.

attrCommodityCodeRequired 

public IResolvable getAttrCommodityCode();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CommodityCode: The commodity code.

attrComputeNodeCountRequired 

public IResolvable getAttrComputeNodeCount();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ComputeNodeCount: Number of compute nodes.

attrCpuRequired 

public IResolvable getAttrCpu();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Cpu: Instance specifications.

attrCreateTimeRequired 

public IResolvable getAttrCreateTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CreateTime: The creation time of the resource.

attrEnableHiveAccessRequired 

public IResolvable getAttrEnableHiveAccess();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute EnableHiveAccess: Whether data Lake acceleration is enabled.

attrEndpointsRequired 

public IResolvable getAttrEndpoints();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Endpoints: List of domain names.

attrExpirationTimeRequired 

public IResolvable getAttrExpirationTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ExpirationTime: Expiration time.

attrGatewayCountRequired 

public IResolvable getAttrGatewayCount();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute GatewayCount: Number of gateway nodes.

attrGatewayCpuRequired 

public IResolvable getAttrGatewayCpu();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute GatewayCpu: Cpu resources of the Gateway.

attrGatewayMemoryRequired 

public IResolvable getAttrGatewayMemory();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute GatewayMemory: Gateway memory resources.

attrInstanceIdRequired 

public IResolvable getAttrInstanceId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrInstanceNameRequired 

public IResolvable getAttrInstanceName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceName: The name of the resource.

attrInstanceOwnerRequired 

public IResolvable getAttrInstanceOwner();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceOwner: The instance owner.

attrInstanceTypeRequired 

public IResolvable getAttrInstanceType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceType: The instance type.

attrMemoryRequired 

public IResolvable getAttrMemory();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Memory: Memory.

attrPaymentTypeRequired 

public IResolvable getAttrPaymentType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PaymentType: The payment type of the resource.

attrResourceGroupIdRequired 

public IResolvable getAttrResourceGroupId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attrStorageSizeRequired 

public IResolvable getAttrStorageSize();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute StorageSize: The standard storage space of the instance.

Unit: GB.

attrSuspendReasonRequired 

public IResolvable getAttrSuspendReason();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SuspendReason: Reason for suspension.

attrTagsRequired 

public IResolvable getAttrTags();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Tags: Instance tag.

attrVersionRequired 

public IResolvable getAttrVersion();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Version: The instance version.

attrZoneIdRequired 

public IResolvable getAttrZoneId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ZoneId: The zone Id.