Skip to content

Instance

  • Implements: @alicloud/ros-cdk-swas.datasource.IInstance

This class encapsulates and extends the ROS resource type DATASOURCE::SWAS::Instance.

Initializers

import { datasource } from '@alicloud/ros-cdk-swas'
new datasource.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 { datasource } from '@alicloud/ros-cdk-swas'
datasource.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.
attrBusinessStatus string | @alicloud/ros-cdk-core.IResolvable Attribute BusinessStatus: The business status of the instance.
attrChargeType string | @alicloud/ros-cdk-core.IResolvable Attribute ChargeType: The billing method of the instance.
attrCombination string | @alicloud/ros-cdk-core.IResolvable Attribute Combination: Indicates whether the instance is a combination instance.
attrCreationTime string | @alicloud/ros-cdk-core.IResolvable Attribute CreationTime: The creation time of the instance.
attrDdosStatus string | @alicloud/ros-cdk-core.IResolvable Attribute DdosStatus: The anti-DDoS status of the instance.
attrDisableReason string | @alicloud/ros-cdk-core.IResolvable Attribute DisableReason: The reason why the instance is disabled.
attrDisks string | @alicloud/ros-cdk-core.IResolvable Attribute Disks: The disks of the instance.
attrExpiredTime string | @alicloud/ros-cdk-core.IResolvable Attribute ExpiredTime: The expiration time of the instance.
attrImage string | @alicloud/ros-cdk-core.IResolvable Attribute Image: The image information of the instance.
attrImageId string | @alicloud/ros-cdk-core.IResolvable Attribute ImageId: The ID of the image used by the instance.
attrInnerIpAddress string | @alicloud/ros-cdk-core.IResolvable Attribute InnerIpAddress: The private IP address of the instance.
attrInstanceId string | @alicloud/ros-cdk-core.IResolvable Attribute InstanceId: The ID of the instance.
attrInstanceName string | @alicloud/ros-cdk-core.IResolvable Attribute InstanceName: The name of the instance.
attrNetworkAttributes string | @alicloud/ros-cdk-core.IResolvable Attribute NetworkAttributes: The network attributes of the instance.
attrPlanId string | @alicloud/ros-cdk-core.IResolvable Attribute PlanId: The plan ID of the instance.
attrPlanType string | @alicloud/ros-cdk-core.IResolvable Attribute PlanType: The plan type of the instance.
attrPublicIpAddress string | @alicloud/ros-cdk-core.IResolvable Attribute PublicIpAddress: The public IP address of the instance.
attrRegionId string | @alicloud/ros-cdk-core.IResolvable Attribute RegionId: The ID of the region where the instance is deployed.
attrResourceGroupId string | @alicloud/ros-cdk-core.IResolvable Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.
attrResourceSpec string | @alicloud/ros-cdk-core.IResolvable Attribute ResourceSpec: The resource specification of the instance.
attrStatus string | @alicloud/ros-cdk-core.IResolvable Attribute Status: The status of the instance.
attrTags string | @alicloud/ros-cdk-core.IResolvable Attribute Tags: The tags of the instance.
attrUuid string | @alicloud/ros-cdk-core.IResolvable Attribute Uuid: The unique identifier of the instance.
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

attrBusinessStatusRequired

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

Attribute BusinessStatus: The business status of the instance.


attrChargeTypeRequired

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

Attribute ChargeType: The billing method of the instance.


attrCombinationRequired

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

Attribute Combination: Indicates whether the instance is a combination instance.


attrCreationTimeRequired

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

Attribute CreationTime: The creation time of the instance.


attrDdosStatusRequired

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

Attribute DdosStatus: The anti-DDoS status of the instance.


attrDisableReasonRequired

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

Attribute DisableReason: The reason why the instance is disabled.


attrDisksRequired

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

Attribute Disks: The disks of the instance.


attrExpiredTimeRequired

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

Attribute ExpiredTime: The expiration time of the instance.


attrImageRequired

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

Attribute Image: The image information of the instance.


attrImageIdRequired

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

Attribute ImageId: The ID of the image used by the instance.


attrInnerIpAddressRequired

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

Attribute InnerIpAddress: The private IP address of the instance.


attrInstanceIdRequired

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

Attribute InstanceId: The ID of the instance.


attrInstanceNameRequired

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

Attribute InstanceName: The name of the instance.


attrNetworkAttributesRequired

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

Attribute NetworkAttributes: The network attributes of the instance.


attrPlanIdRequired

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

Attribute PlanId: The plan ID of the instance.


attrPlanTypeRequired

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

Attribute PlanType: The plan type of the instance.


attrPublicIpAddressRequired

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

Attribute PublicIpAddress: The public IP address of the instance.


attrRegionIdRequired

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

Attribute RegionId: The ID of the region where the instance is deployed.


attrResourceGroupIdRequired

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

Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.


attrResourceSpecRequired

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

Attribute ResourceSpec: The resource specification of the instance.


attrStatusRequired

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

Attribute Status: The status of the instance.


attrTagsRequired

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

Attribute Tags: The tags of the instance.


attrUuidRequired

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

Attribute Uuid: The unique identifier of the instance.


propsRequired

public readonly props: InstanceProps;