Skip to content

Instance

This class encapsulates and extends the ROS resource type ALIYUN::AMQP::Instance, which is used to create an ApsaraMQ for RabbitMQ instance.

Initializers

import { Instance } from '@alicloud/ros-cdk-amqp'
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

propsOptional


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-amqp'
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.
attrClassicEndpoint @alicloud/ros-cdk-core.IResolvable Attribute ClassicEndpoint: The classic endpoint of the instance.
attrInstanceId @alicloud/ros-cdk-core.IResolvable Attribute InstanceId: The ID of the instance.
attrPrivateEndpoint @alicloud/ros-cdk-core.IResolvable Attribute PrivateEndpoint: The private endpoint of the instance.
attrPublicEndpoint @alicloud/ros-cdk-core.IResolvable Attribute PublicEndpoint: The public endpoint of the instance.

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

attrClassicEndpointRequired

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

Attribute ClassicEndpoint: The classic endpoint of the instance.


attrInstanceIdRequired

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

Attribute InstanceId: The ID of the instance.


attrPrivateEndpointRequired

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

Attribute PrivateEndpoint: The private endpoint of the instance.


attrPublicEndpointRequired

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

Attribute PublicEndpoint: The public endpoint of the instance.