Instance

• Implements: IInstance

This class encapsulates and extends the ROS resource type ALIYUN::ROCKETMQ5::InstanceThe , which resource type creates an ApsaraMQ for RocketMQ 5.0 instance.

Initializers

import com.aliyun.ros.cdk.rocketmq5.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .internetInfo(IResolvable)
    .internetInfo(InternetInfoProperty)
    .productInfo(IResolvable)
    .productInfo(ProductInfoProperty)
    .seriesCode(java.lang.String)
    .seriesCode(IResolvable)
    .subSeriesCode(java.lang.String)
    .subSeriesCode(IResolvable)
    .vpcInfo(IResolvable)
    .vpcInfo(VpcInfoProperty)
//  .autoRenew(java.lang.Boolean)
//  .autoRenew(IResolvable)
//  .autoRenewPeriod(java.lang.Number)
//  .autoRenewPeriod(IResolvable)
//  .instanceName(java.lang.String)
//  .instanceName(IResolvable)
//  .paymentType(java.lang.String)
//  .paymentType(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodUnit(java.lang.String)
//  .periodUnit(IResolvable)
//  .remark(java.lang.String)
//  .remark(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

internetInfo^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR InternetInfoProperty

Property internetInfo: Public network configuration information.

productInfo^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR ProductInfoProperty

Property productInfo: Instance specification information.

seriesCode^Required

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

Property seriesCode: The primary series code of the instance.

subSeriesCode^Required

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

Property subSeriesCode: The sub series code of the instance.

vpcInfo^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR VpcInfoProperty

Property vpcInfo: Private network configuration information.

autoRenew^Optional

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

Property autoRenew: Whether to auto-renew.

This parameter takes effect only when the PaymentType=Subscription.

autoRenewPeriod^Optional

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

Property autoRenewPeriod: Automatic renewal period.

This parameter is valid only when automatic renewal is enabled. Unit: Month.

instanceName^Optional

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

Property instanceName: The name of the instance to be created.

paymentType^Optional

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

Property paymentType: The sub series code of the instance.

period^Optional

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

Property period: The subscription duration.

Valid values: When Period is Month, it could be from 1 to 6, 12, 24, 36. When Period is Year, it could be from 1 to 3.

periodUnit^Optional

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

Property periodUnit: The period unit for the duration of the instance.

remark^Optional

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

Property remark: The remark of instance.

resourceGroupId^Optional

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

Property resourceGroupId: Resource group ID.

Methods

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.

session^Required

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

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

addCount

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

count^Required

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

addDependency

public void addDependency(Resource resource)

resource^Required

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

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

attrInstanceId^Required

public java.lang.Object getAttrInstanceId();

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

Attribute InstanceId: Instance ID created.

attrInstanceName^Required

public java.lang.Object getAttrInstanceName();

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

Attribute InstanceName: Instance name.

attrInternetEndpoint^Required

public java.lang.Object getAttrInternetEndpoint();

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

Attribute InternetEndpoint: Internet endpoint.

attrVpcEndpoint^Required

public java.lang.Object getAttrVpcEndpoint();

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

Attribute VpcEndpoint: VPC endpoint.

props^Required

public InstanceProps getProps();

• Type: InstanceProps