Instance

• Implements: IInstance

This class encapsulates and extends the ROS resource type ALIYUN::ApiGateway::Instance.

Initializers

import com.aliyun.ros.cdk.apigateway.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .httpsPolicy(java.lang.String)
    .httpsPolicy(IResolvable)
    .instanceName(java.lang.String)
    .instanceName(IResolvable)
    .instanceSpec(java.lang.String)
    .instanceSpec(IResolvable)
    .zoneId(java.lang.String)
    .zoneId(IResolvable)
//  .autoPay(java.lang.Boolean)
//  .autoPay(IResolvable)
//  .chargeType(java.lang.String)
//  .chargeType(IResolvable)
//  .deletionForce(java.lang.Boolean)
//  .deletionForce(IResolvable)
//  .duration(java.lang.Number)
//  .duration(IResolvable)
//  .pricingCycle(java.lang.String)
//  .pricingCycle(IResolvable)
//  .tags(java.util.List<TagsProperty>)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

httpsPolicy^Required

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

Property httpsPolicy: HTTPS security policy.

Valid values: HTTPS2_TLS1_0, HTTPS2_TLS1_2, HTTPS1_1_TLS1_0

instanceName^Required

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

Property instanceName: Instance name.

instanceSpec^Required

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

Property instanceSpec: Instance specification.

For example: api.s1.small

zoneId^Required

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

Property zoneId: Zone to which the instance belongs.

For example: cn-beijing-MAZ2(f,g). Pleas call DescribeZones to get supported zone list.

autoPay^Optional

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

Property autoPay: Specifies whether to enable auto-payment for renewals.

Valid values:

• True: Auto-payment is enabled. Make sure that your account has a sufficient balance.
• False: Manual payment is required. To pay for an order, log on to the console. In the upper-right corner, choose Billing > User Center. On the Order Management page, find the order and complete the payment. Default value: False.

chargeType^Optional

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

Property chargeType: The billing method of the router interface.

Valid values: PrePaid (Subscription), PostPaid (default, Pay-As-You-Go). Default value: PostPaid.

deletionForce^Optional

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

Property deletionForce: Whether force delete the instance even if its status is START_FAILED.

Default value is false.

duration^Optional

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

Property duration: The subscription duration of the instance.

Valid values:

• If PricingCycle is set to Month, the valid values are 1 to 9.
• If PricingCycle is set to Year, the valid values are 1 to 3.

This parameter is required and takes effect only if you set ChargeType to PrePaid.

pricingCycle^Optional

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

Property pricingCycle: The billing cycle of the subscription instance.

Valid values:

• year
• month

This parameter is required if you set ChargeType to PrePaid.

tags^Optional

• Type: java.util.List<TagsProperty>

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

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

attrArn^Required

public java.lang.Object getAttrArn();

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

Attribute Arn: The Alibaba Cloud Resource Name (ARN).

attrEgressIpv6Enable^Required

public java.lang.Object getAttrEgressIpv6Enable();

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

Attribute EgressIpv6Enable: Whether enable egress IPV6.

attrInstanceId^Required

public java.lang.Object getAttrInstanceId();

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

Attribute InstanceId: Instance ID.

attrInstanceType^Required

public java.lang.Object getAttrInstanceType();

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

Attribute InstanceType: Instance type.

attrInternetEgressAddress^Required

public java.lang.Object getAttrInternetEgressAddress();

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

Attribute InternetEgressAddress: Internet egress dddress.

attrSupportIpv6^Required

public java.lang.Object getAttrSupportIpv6();

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

Attribute SupportIpv6: Whether support IPV6.

attrVpcEgressAddress^Required

public java.lang.Object getAttrVpcEgressAddress();

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

Attribute VpcEgressAddress: VPC network egress address.

attrVpcIntranetEnable^Required

public java.lang.Object getAttrVpcIntranetEnable();

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

Attribute VpcIntranetEnable: Whether enable VPC intranet.

attrVpcSlbIntranetEnable^Required

public java.lang.Object getAttrVpcSlbIntranetEnable();

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

Attribute VpcSlbIntranetEnable: Whether enable VPC SLB intranet.

props^Required

public InstanceProps getProps();

• Type: InstanceProps