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 { Instance } from '@alicloud/ros-cdk-hologram'
new Instance(scope: Construct, id: string, props: InstanceProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props InstanceProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

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

idRequired

  • Type: string

propsRequired

enableResourcePropertyConstraintOptional

  • 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.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

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.

sessionRequired

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

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

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

addCount 

public addCount(count: number | IResolvable): void

countRequired

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

addDependency 

public addDependency(resource: Resource): void

resourceRequired

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

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

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

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

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

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

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

isConstruct 

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

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

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

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public readonly ref: string;
  • Type: string

stackRequired 

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resourceOptional 

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrAutoRenewalRequired 

public readonly attrAutoRenewal: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute AutoRenewal: Whether automatic renewal is enabled.

attrColdStorageSizeRequired 

public readonly attrColdStorageSize: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ColdStorageSize: Instance low-frequency storage space.

Unit: GB.

attrCommodityCodeRequired 

public readonly attrCommodityCode: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CommodityCode: The commodity code.

attrComputeNodeCountRequired 

public readonly attrComputeNodeCount: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ComputeNodeCount: Number of compute nodes.

attrCpuRequired 

public readonly attrCpu: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Cpu: Instance specifications.

attrCreateTimeRequired 

public readonly attrCreateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: The creation time of the resource.

attrEnableHiveAccessRequired 

public readonly attrEnableHiveAccess: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute EnableHiveAccess: Whether data Lake acceleration is enabled.

attrEndpointsRequired 

public readonly attrEndpoints: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Endpoints: List of domain names.

attrExpirationTimeRequired 

public readonly attrExpirationTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ExpirationTime: Expiration time.

attrGatewayCountRequired 

public readonly attrGatewayCount: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute GatewayCount: Number of gateway nodes.

attrGatewayCpuRequired 

public readonly attrGatewayCpu: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute GatewayCpu: Cpu resources of the Gateway.

attrGatewayMemoryRequired 

public readonly attrGatewayMemory: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute GatewayMemory: Gateway memory resources.

attrInstanceIdRequired 

public readonly attrInstanceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrInstanceNameRequired 

public readonly attrInstanceName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceName: The name of the resource.

attrInstanceOwnerRequired 

public readonly attrInstanceOwner: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceOwner: The instance owner.

attrInstanceTypeRequired 

public readonly attrInstanceType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceType: The instance type.

attrMemoryRequired 

public readonly attrMemory: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Memory: Memory.

attrPaymentTypeRequired 

public readonly attrPaymentType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PaymentType: The payment type of the resource.

attrResourceGroupIdRequired 

public readonly attrResourceGroupId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attrStorageSizeRequired 

public readonly attrStorageSize: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute StorageSize: The standard storage space of the instance.

Unit: GB.

attrSuspendReasonRequired 

public readonly attrSuspendReason: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SuspendReason: Reason for suspension.

attrTagsRequired 

public readonly attrTags: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Tags: Instance tag.

attrVersionRequired 

public readonly attrVersion: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Version: The instance version.

attrZoneIdRequired 

public readonly attrZoneId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ZoneId: The zone Id.