Skip to content

Instance

This class encapsulates and extends the ROS resource type ALIYUN::Flink::Instance, which is used to create a subscription or pay-as-you-go Realtime Compute for Apache Flink instance.

Initializers 

import com.aliyun.ros.cdk.flink.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .bucket(java.lang.String)
    .bucket(IResolvable)
    .chargeType(java.lang.String)
    .chargeType(IResolvable)
    .instanceName(java.lang.String)
    .instanceName(IResolvable)
    .vpcId(java.lang.String)
    .vpcId(IResolvable)
    .vSwitchIds(java.util.List<java.lang.Object>)
    .vSwitchIds(IResolvable)
    .zoneId(java.lang.String)
    .zoneId(IResolvable)
//  .autoRenew(java.lang.Boolean)
//  .autoRenew(IResolvable)
//  .duration(java.lang.Number)
//  .duration(IResolvable)
//  .pricingCycle(java.lang.String)
//  .pricingCycle(IResolvable)
//  .promotionCode(java.lang.String)
//  .promotionCode(IResolvable)
//  .resourceSpec(IResolvable)
//  .resourceSpec(ResourceSpecProperty)
//  .usePromotionCode(java.lang.Boolean)
//  .usePromotionCode(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.
bucket java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property bucket: OSS bucket name.
chargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property chargeType: The payment type, the value of the value is as follows: POST: pay as you go.
instanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceName: The name of instance.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: VPC ID.
vSwitchIds java.util.List OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchIds: Virtual switch ID.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: The available area ID of the instance.
autoRenew java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property autoRenew: When the payment type is the monthly package, the value of the value is as follows: true: Automatic renewal.
duration java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property duration: Number of order cycle.
pricingCycle java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property pricingCycle: The ordering cycle only supports ordering in the year and month.
promotionCode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property promotionCode: Promo Code.
resourceSpec com.aliyun.ros.cdk.core.IResolvable OR ResourceSpecProperty Property resourceSpec: Resource specifications.
usePromotionCode java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property usePromotionCode: Whether to use coupons.The value is as follows: true: Use. false: Not in use.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

bucketRequired

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

Property bucket: OSS bucket name.

chargeTypeRequired

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

Property chargeType: The payment type, the value of the value is as follows: POST: pay as you go.

PRE: subscription.

instanceNameRequired

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

Property instanceName: The name of instance.

vpcIdRequired

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

Property vpcId: VPC ID.

vSwitchIdsRequired

  • Type: java.util.List OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchIds: Virtual switch ID.

zoneIdRequired

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

Property zoneId: The available area ID of the instance.

autoRenewOptional

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

Property autoRenew: When the payment type is the monthly package, the value of the value is as follows: true: Automatic renewal.

false: Manual renewal.

durationOptional

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

Property duration: Number of order cycle.

When ChargeType is configured as PRE, the duration parameter must be filled. If PricingCycle is Month, the valid range is 1, 2, 3, 6, 7, 8, 9, 12, 24, 36 If PricingCycle is year, the valid range is 1 to 3

pricingCycleOptional

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

Property pricingCycle: The ordering cycle only supports ordering in the year and month.

promotionCodeOptional

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

Property promotionCode: Promo Code.

resourceSpecOptional

Property resourceSpec: Resource specifications.

When ChargeType is configured as PRE, the resource specification parameters must be filled.

usePromotionCodeOptional

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

Property usePromotionCode: Whether to use coupons.The value is as follows: true: Use. false: Not in use.

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.flink.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.
attrOrderId com.aliyun.ros.cdk.core.IResolvable Attribute OrderId: Order information.

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.

attrOrderIdRequired 

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

Attribute OrderId: Order information.