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.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc 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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

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.
env @alicloud/ros-cdk-core.IResourceEnvironment The environment this resource belongs to.
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 string | @alicloud/ros-cdk-core.IResolvable Attribute AutoRenewal: Whether automatic renewal is enabled.
attrColdStorageSize string | @alicloud/ros-cdk-core.IResolvable Attribute ColdStorageSize: Instance low-frequency storage space.
attrCommodityCode string | @alicloud/ros-cdk-core.IResolvable Attribute CommodityCode: The commodity code.
attrComputeNodeCount string | @alicloud/ros-cdk-core.IResolvable Attribute ComputeNodeCount: Number of compute nodes.
attrCpu string | @alicloud/ros-cdk-core.IResolvable Attribute Cpu: Instance specifications.
attrCreateTime string | @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: The creation time of the resource.
attrEnableHiveAccess string | @alicloud/ros-cdk-core.IResolvable Attribute EnableHiveAccess: Whether data Lake acceleration is enabled.
attrEndpoints string | @alicloud/ros-cdk-core.IResolvable Attribute Endpoints: List of domain names.
attrExpirationTime string | @alicloud/ros-cdk-core.IResolvable Attribute ExpirationTime: Expiration time.
attrGatewayCount string | @alicloud/ros-cdk-core.IResolvable Attribute GatewayCount: Number of gateway nodes.
attrGatewayCpu string | @alicloud/ros-cdk-core.IResolvable Attribute GatewayCpu: Cpu resources of the Gateway.
attrGatewayMemory string | @alicloud/ros-cdk-core.IResolvable Attribute GatewayMemory: Gateway memory resources.
attrInstanceId string | @alicloud/ros-cdk-core.IResolvable Attribute InstanceId: Resource attribute fields that represent the resource's primary key.
attrInstanceName string | @alicloud/ros-cdk-core.IResolvable Attribute InstanceName: The name of the resource.
attrInstanceOwner string | @alicloud/ros-cdk-core.IResolvable Attribute InstanceOwner: The instance owner.
attrInstanceType string | @alicloud/ros-cdk-core.IResolvable Attribute InstanceType: The instance type.
attrMemory string | @alicloud/ros-cdk-core.IResolvable Attribute Memory: Memory.
attrPaymentType string | @alicloud/ros-cdk-core.IResolvable Attribute PaymentType: The payment type of the resource.
attrResourceGroupId string | @alicloud/ros-cdk-core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrStorageSize string | @alicloud/ros-cdk-core.IResolvable Attribute StorageSize: The standard storage space of the instance.
attrSuspendReason string | @alicloud/ros-cdk-core.IResolvable Attribute SuspendReason: Reason for suspension.
attrTags string | @alicloud/ros-cdk-core.IResolvable Attribute Tags: Instance tag.
attrVersion string | @alicloud/ros-cdk-core.IResolvable Attribute Version: The instance version.
attrZoneId string | @alicloud/ros-cdk-core.IResolvable Attribute ZoneId: The zone Id.
props InstanceProps No description.

nodeRequired

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

The construct tree node associated with this construct.


envRequired

public readonly env: IResourceEnvironment;
  • Type: @alicloud/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.


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: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute AutoRenewal: Whether automatic renewal is enabled.


attrColdStorageSizeRequired

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

Attribute ColdStorageSize: Instance low-frequency storage space.

Unit: GB.


attrCommodityCodeRequired

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

Attribute CommodityCode: The commodity code.


attrComputeNodeCountRequired

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

Attribute ComputeNodeCount: Number of compute nodes.


attrCpuRequired

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

Attribute Cpu: Instance specifications.


attrCreateTimeRequired

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

Attribute CreateTime: The creation time of the resource.


attrEnableHiveAccessRequired

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

Attribute EnableHiveAccess: Whether data Lake acceleration is enabled.


attrEndpointsRequired

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

Attribute Endpoints: List of domain names.


attrExpirationTimeRequired

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

Attribute ExpirationTime: Expiration time.


attrGatewayCountRequired

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

Attribute GatewayCount: Number of gateway nodes.


attrGatewayCpuRequired

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

Attribute GatewayCpu: Cpu resources of the Gateway.


attrGatewayMemoryRequired

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

Attribute GatewayMemory: Gateway memory resources.


attrInstanceIdRequired

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

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


attrInstanceNameRequired

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

Attribute InstanceName: The name of the resource.


attrInstanceOwnerRequired

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

Attribute InstanceOwner: The instance owner.


attrInstanceTypeRequired

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

Attribute InstanceType: The instance type.


attrMemoryRequired

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

Attribute Memory: Memory.


attrPaymentTypeRequired

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

Attribute PaymentType: The payment type of the resource.


attrResourceGroupIdRequired

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

Attribute ResourceGroupId: The ID of the resource group.


attrStorageSizeRequired

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

Attribute StorageSize: The standard storage space of the instance.

Unit: GB.


attrSuspendReasonRequired

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

Attribute SuspendReason: Reason for suspension.


attrTagsRequired

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

Attribute Tags: Instance tag.


attrVersionRequired

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

Attribute Version: The instance version.


attrZoneIdRequired

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

Attribute ZoneId: The zone Id.


propsRequired

public readonly props: InstanceProps;