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 ros_cdk_flink
ros_cdk_flink.Instance(
  scope: Construct,
  id: str,
  bucket: typing.Union[str, IResolvable],
  charge_type: typing.Union[str, IResolvable],
  instance_name: typing.Union[str, IResolvable],
  vpc_id: typing.Union[str, IResolvable],
  v_switch_ids: typing.Union[typing.List[typing.Any], IResolvable],
  zone_id: typing.Union[str, IResolvable],
  auto_renew: typing.Union[bool, IResolvable] = None,
  duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  pricing_cycle: typing.Union[str, IResolvable] = None,
  promotion_code: typing.Union[str, IResolvable] = None,
  resource_spec: typing.Union[IResolvable, ResourceSpecProperty] = None,
  use_promotion_code: typing.Union[bool, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
bucket typing.Union[str, ros_cdk_core.IResolvable] Property bucket: OSS bucket name.
charge_type typing.Union[str, ros_cdk_core.IResolvable] Property chargeType: The payment type, the value of the value is as follows: POST: pay as you go.
instance_name typing.Union[str, ros_cdk_core.IResolvable] Property instanceName: The name of instance.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: VPC ID.
v_switch_ids typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable] Property vSwitchIds: Virtual switch ID.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: The available area ID of the instance.
auto_renew typing.Union[bool, 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 typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property duration: Number of order cycle.
pricing_cycle typing.Union[str, ros_cdk_core.IResolvable] Property pricingCycle: The ordering cycle only supports ordering in the year and month.
promotion_code typing.Union[str, ros_cdk_core.IResolvable] Property promotionCode: Promo Code.
resource_spec typing.Union[ros_cdk_core.IResolvable, ResourceSpecProperty] Property resourceSpec: Resource specifications.
use_promotion_code typing.Union[bool, ros_cdk_core.IResolvable] Property usePromotionCode: Whether to use coupons.The value is as follows: true: Use. false: Not in use.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

bucketRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property bucket: OSS bucket name.

charge_typeRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

PRE: subscription.

instance_nameRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceName: The name of instance.

vpc_idRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vpcId: VPC ID.

v_switch_idsRequired

  • Type: typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]

Property vSwitchIds: Virtual switch ID.

zone_idRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property zoneId: The available area ID of the instance.

auto_renewOptional

  • Type: typing.Union[bool, 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: typing.Union[typing.Union[int, float], 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

pricing_cycleOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

promotion_codeOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property promotionCode: Promo Code.

resource_specOptional

Property resourceSpec: Resource specifications.

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

use_promotion_codeOptional

  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

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

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct 

import ros_cdk_flink
ros_cdk_flink.Instance.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_instance_id ros_cdk_core.IResolvable Attribute InstanceId: Instance ID.
attr_order_id ros_cdk_core.IResolvable Attribute OrderId: Order information.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_instance_idRequired 

attr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceId: Instance ID.

attr_order_idRequired 

attr_order_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute OrderId: Order information.