Skip to content

Instance

This class encapsulates and extends the ROS resource type ALIYUN::ROCKETMQ5::Instance, which is used to create 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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
internetInfo com.aliyun.ros.cdk.core.IResolvable OR InternetInfoProperty Property internetInfo: Public network configuration information.
productInfo com.aliyun.ros.cdk.core.IResolvable OR ProductInfoProperty Property productInfo: Instance specification information.
seriesCode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property seriesCode: The primary series code of the instance.
subSeriesCode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property subSeriesCode: The sub series code of the instance.
vpcInfo com.aliyun.ros.cdk.core.IResolvable OR VpcInfoProperty Property vpcInfo: Private network configuration information.
autoRenew java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property autoRenew: Whether to auto-renew.
autoRenewPeriod java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property autoRenewPeriod: Automatic renewal period.
instanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceName: The name of the instance to be created.
paymentType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property paymentType: The sub series code of the instance.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property period: The subscription duration.
periodUnit java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property periodUnit: The period unit for the duration of the instance.
remark java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property remark: The remark of instance.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: Resource group ID.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

internetInfoRequired

Property internetInfo: Public network configuration information.

productInfoRequired

Property productInfo: Instance specification information.

seriesCodeRequired

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

Property seriesCode: The primary series code of the instance.

subSeriesCodeRequired

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

Property subSeriesCode: The sub series code of the instance.

vpcInfoRequired

Property vpcInfo: Private network configuration information.

autoRenewOptional

  • 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.

autoRenewPeriodOptional

  • 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.

instanceNameOptional

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

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

paymentTypeOptional

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

Property paymentType: The sub series code of the instance.

periodOptional

  • 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.

periodUnitOptional

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

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

remarkOptional

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

Property remark: The remark of instance.

resourceGroupIdOptional

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

Property resourceGroupId: Resource group ID.

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 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.

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

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

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

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

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute InstanceId: Instance ID created.
attrInstanceName com.aliyun.ros.cdk.core.IResolvable Attribute InstanceName: Instance name.
attrInternetEndpoint com.aliyun.ros.cdk.core.IResolvable Attribute InternetEndpoint: Internet endpoint.
attrVpcEndpoint com.aliyun.ros.cdk.core.IResolvable Attribute VpcEndpoint: VPC endpoint.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrInstanceIdRequired 

public IResolvable getAttrInstanceId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceId: Instance ID created.

attrInstanceNameRequired 

public IResolvable getAttrInstanceName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceName: Instance name.

attrInternetEndpointRequired 

public IResolvable getAttrInternetEndpoint();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InternetEndpoint: Internet endpoint.

attrVpcEndpointRequired 

public IResolvable getAttrVpcEndpoint();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute VpcEndpoint: VPC endpoint.