This page documents the language specification for the alicloud package. If you're looking for help working with the inputs, outputs, or functions of alicloud resources in a Pulumi program, please see the resource documentation for examples and API reference.

ots

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

class pulumi_alicloud.ots.Instance(resource_name, opts=None, accessed_by=None, description=None, instance_type=None, name=None, tags=None, __props__=None, __name__=None, __opts__=None)

This resource will help you to manager a Table Store Instance. It is foundation of creating data table.

import pulumi
import pulumi_alicloud as alicloud

# Create an OTS instance
foo = alicloud.ots.Instance("foo",
    accessed_by="Vpc",
    description="for table",
    tags={
        "Created": "TF",
        "For": "Building table",
    })
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • accessed_by (pulumi.Input[str]) – The network limitation of accessing instance. Valid values:

  • description (pulumi.Input[str]) – The description of the instance. Currently, it does not support modifying.

  • instance_type (pulumi.Input[str]) – The type of instance. Valid values are “Capacity” and “HighPerformance”. Default to “HighPerformance”.

  • name (pulumi.Input[str]) – The name of the instance.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the instance.

accessed_by: pulumi.Output[str] = None

The network limitation of accessing instance. Valid values:

description: pulumi.Output[str] = None

The description of the instance. Currently, it does not support modifying.

instance_type: pulumi.Output[str] = None

The type of instance. Valid values are “Capacity” and “HighPerformance”. Default to “HighPerformance”.

name: pulumi.Output[str] = None

The name of the instance.

tags: pulumi.Output[dict] = None

A mapping of tags to assign to the instance.

static get(resource_name, id, opts=None, accessed_by=None, description=None, instance_type=None, name=None, tags=None)

Get an existing Instance resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • accessed_by (pulumi.Input[str]) – The network limitation of accessing instance. Valid values:

  • description (pulumi.Input[str]) – The description of the instance. Currently, it does not support modifying.

  • instance_type (pulumi.Input[str]) – The type of instance. Valid values are “Capacity” and “HighPerformance”. Default to “HighPerformance”.

  • name (pulumi.Input[str]) – The name of the instance.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the instance.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_alicloud.ots.InstanceAttachment(resource_name, opts=None, instance_name=None, vpc_name=None, vswitch_id=None, __props__=None, __name__=None, __opts__=None)

This resource will help you to bind a VPC to an OTS instance.

import pulumi
import pulumi_alicloud as alicloud

# Create an OTS instance
foo_instance = alicloud.ots.Instance("fooInstance",
    accessed_by="Vpc",
    description="for table",
    tags={
        "Created": "TF",
        "For": "Building table",
    })
foo_zones = alicloud.get_zones(available_resource_creation="VSwitch")
foo_network = alicloud.vpc.Network("fooNetwork", cidr_block="172.16.0.0/16")
foo_switch = alicloud.vpc.Switch("fooSwitch",
    availability_zone=foo_zones.zones[0]["id"],
    cidr_block="172.16.1.0/24",
    vpc_id=foo_network.id)
foo_instance_attachment = alicloud.ots.InstanceAttachment("fooInstanceAttachment",
    instance_name=foo_instance.name,
    vpc_name="attachment1",
    vswitch_id=foo_switch.id)
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • instance_name (pulumi.Input[str]) – The name of the OTS instance.

  • vpc_name (pulumi.Input[str]) – The name of attaching VPC to instance.

  • vswitch_id (pulumi.Input[str]) – The ID of attaching VSwitch to instance.

instance_name: pulumi.Output[str] = None

The name of the OTS instance.

vpc_id: pulumi.Output[str] = None

The ID of attaching VPC to instance.

vpc_name: pulumi.Output[str] = None

The name of attaching VPC to instance.

vswitch_id: pulumi.Output[str] = None

The ID of attaching VSwitch to instance.

static get(resource_name, id, opts=None, instance_name=None, vpc_id=None, vpc_name=None, vswitch_id=None)

Get an existing InstanceAttachment resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • instance_name (pulumi.Input[str]) – The name of the OTS instance.

  • vpc_id (pulumi.Input[str]) – The ID of attaching VPC to instance.

  • vpc_name (pulumi.Input[str]) – The name of attaching VPC to instance.

  • vswitch_id (pulumi.Input[str]) – The ID of attaching VSwitch to instance.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_alicloud.ots.Table(resource_name, opts=None, deviation_cell_version_in_sec=None, instance_name=None, max_version=None, primary_keys=None, table_name=None, time_to_live=None, __props__=None, __name__=None, __opts__=None)

Create a Table resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] deviation_cell_version_in_sec: The max version offset of the table. The valid value is 1-9223372036854775807. Defaults to 86400. :param pulumi.Input[str] instance_name: The name of the OTS instance in which table will located. :param pulumi.Input[float] max_version: The maximum number of versions stored in this table. The valid value is 1-2147483647. :param pulumi.Input[list] primary_keys: The property of TableMeta which indicates the structure information of a table. It describes the attribute value of primary key. The number of primary_key should not be less than one and not be more than four. :param pulumi.Input[str] table_name: The table name of the OTS instance. If changed, a new table would be created. :param pulumi.Input[float] time_to_live: The retention time of data stored in this table (unit: second). The value maximum is 2147483647 and -1 means never expired.

The primary_keys object supports the following:

  • name (pulumi.Input[str]) - Name for primary key.

  • type (pulumi.Input[str]) - Type for primary key. Only Integer, String or Binary is allowed.

deviation_cell_version_in_sec: pulumi.Output[str] = None

The max version offset of the table. The valid value is 1-9223372036854775807. Defaults to 86400.

instance_name: pulumi.Output[str] = None

The name of the OTS instance in which table will located.

max_version: pulumi.Output[float] = None

The maximum number of versions stored in this table. The valid value is 1-2147483647.

primary_keys: pulumi.Output[list] = None

The property of TableMeta which indicates the structure information of a table. It describes the attribute value of primary key. The number of primary_key should not be less than one and not be more than four.

  • name (str) - Name for primary key.

  • type (str) - Type for primary key. Only Integer, String or Binary is allowed.

table_name: pulumi.Output[str] = None

The table name of the OTS instance. If changed, a new table would be created.

time_to_live: pulumi.Output[float] = None

The retention time of data stored in this table (unit: second). The value maximum is 2147483647 and -1 means never expired.

static get(resource_name, id, opts=None, deviation_cell_version_in_sec=None, instance_name=None, max_version=None, primary_keys=None, table_name=None, time_to_live=None)

Get an existing Table resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • deviation_cell_version_in_sec (pulumi.Input[str]) – The max version offset of the table. The valid value is 1-9223372036854775807. Defaults to 86400.

  • instance_name (pulumi.Input[str]) – The name of the OTS instance in which table will located.

  • max_version (pulumi.Input[float]) – The maximum number of versions stored in this table. The valid value is 1-2147483647.

  • primary_keys (pulumi.Input[list]) – The property of TableMeta which indicates the structure information of a table. It describes the attribute value of primary key. The number of primary_key should not be less than one and not be more than four.

  • table_name (pulumi.Input[str]) – The table name of the OTS instance. If changed, a new table would be created.

  • time_to_live (pulumi.Input[float]) – The retention time of data stored in this table (unit: second). The value maximum is 2147483647 and -1 means never expired.

The primary_keys object supports the following:

  • name (pulumi.Input[str]) - Name for primary key.

  • type (pulumi.Input[str]) - Type for primary key. Only Integer, String or Binary is allowed.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str