1. Docs
  2. Reference
  3. API
  4. @pulumi/alicloud
  5. ots

Module ots

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.

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.

Resources

Others

Resources

Resource Instance

class Instance extends CustomResource

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

// Create an OTS instance
const foo = new alicloud.ots.Instance("foo", {
    accessedBy: "Vpc",
    description: "for table",
    tags: {
        Created: "TF",
        For: "Building table",
    },
});

constructor

new Instance(name: string, args?: InstanceArgs, opts?: pulumi.CustomResourceOptions)

Create a Instance resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InstanceState, opts?: pulumi.CustomResourceOptions): Instance

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Instance

Returns true if the given object is an instance of Instance. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accessedBy

public accessedBy: pulumi.Output<string | undefined>;

The network limitation of accessing instance. Valid values:

property description

public description: pulumi.Output<string | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceType

public instanceType: pulumi.Output<string | undefined>;

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

property name

public name: pulumi.Output<string>;

The name of the instance.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A mapping of tags to assign to the instance.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource InstanceAttachment

class InstanceAttachment extends CustomResource

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

// Create an OTS instance
const fooInstance = new alicloud.ots.Instance("foo", {
    accessedBy: "Vpc",
    description: "for table",
    tags: {
        Created: "TF",
        For: "Building table",
    },
});
const fooZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: "VSwitch",
}, { async: true }));
const fooNetwork = new alicloud.vpc.Network("foo", {
    cidrBlock: "172.16.0.0/16",
});
const fooSwitch = new alicloud.vpc.Switch("foo", {
    availabilityZone: fooZones.zones[0].id,
    cidrBlock: "172.16.1.0/24",
    vpcId: fooNetwork.id,
});
const fooInstanceAttachment = new alicloud.ots.InstanceAttachment("foo", {
    instanceName: fooInstance.name,
    vpcName: "attachment1",
    vswitchId: fooSwitch.id,
});

constructor

new InstanceAttachment(name: string, args: InstanceAttachmentArgs, opts?: pulumi.CustomResourceOptions)

Create a InstanceAttachment resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InstanceAttachmentState, opts?: pulumi.CustomResourceOptions): InstanceAttachment

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is InstanceAttachment

Returns true if the given object is an instance of InstanceAttachment. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceName

public instanceName: pulumi.Output<string>;

The name of the OTS instance.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcId

public vpcId: pulumi.Output<string>;

The ID of attaching VPC to instance.

property vpcName

public vpcName: pulumi.Output<string>;

The name of attaching VPC to instance.

property vswitchId

public vswitchId: pulumi.Output<string>;

The ID of attaching VSwitch to instance.

Resource Table

class Table extends CustomResource

constructor

new Table(name: string, args: TableArgs, opts?: pulumi.CustomResourceOptions)

Create a Table resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TableState, opts?: pulumi.CustomResourceOptions): Table

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Table

Returns true if the given object is an instance of Table. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property deviationCellVersionInSec

public deviationCellVersionInSec: pulumi.Output<string | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceName

public instanceName: pulumi.Output<string>;

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

property maxVersion

public maxVersion: pulumi.Output<number>;

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

property primaryKeys

public primaryKeys: pulumi.Output<TablePrimaryKey[]>;

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

property tableName

public tableName: pulumi.Output<string>;

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

property timeToLive

public timeToLive: pulumi.Output<number>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface InstanceArgs

interface InstanceArgs

The set of arguments for constructing a Instance resource.

property accessedBy

accessedBy?: pulumi.Input<string>;

The network limitation of accessing instance. Valid values:

property description

description?: pulumi.Input<string>;

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

property instanceType

instanceType?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

The name of the instance.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the instance.

interface InstanceAttachmentArgs

interface InstanceAttachmentArgs

The set of arguments for constructing a InstanceAttachment resource.

property instanceName

instanceName: pulumi.Input<string>;

The name of the OTS instance.

property vpcName

vpcName: pulumi.Input<string>;

The name of attaching VPC to instance.

property vswitchId

vswitchId: pulumi.Input<string>;

The ID of attaching VSwitch to instance.

interface InstanceAttachmentState

interface InstanceAttachmentState

Input properties used for looking up and filtering InstanceAttachment resources.

property instanceName

instanceName?: pulumi.Input<string>;

The name of the OTS instance.

property vpcId

vpcId?: pulumi.Input<string>;

The ID of attaching VPC to instance.

property vpcName

vpcName?: pulumi.Input<string>;

The name of attaching VPC to instance.

property vswitchId

vswitchId?: pulumi.Input<string>;

The ID of attaching VSwitch to instance.

interface InstanceState

interface InstanceState

Input properties used for looking up and filtering Instance resources.

property accessedBy

accessedBy?: pulumi.Input<string>;

The network limitation of accessing instance. Valid values:

property description

description?: pulumi.Input<string>;

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

property instanceType

instanceType?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

The name of the instance.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the instance.

interface TableArgs

interface TableArgs

The set of arguments for constructing a Table resource.

property deviationCellVersionInSec

deviationCellVersionInSec?: pulumi.Input<string>;

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

property instanceName

instanceName: pulumi.Input<string>;

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

property maxVersion

maxVersion: pulumi.Input<number>;

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

property primaryKeys

primaryKeys: pulumi.Input<pulumi.Input<TablePrimaryKey>[]>;

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

property tableName

tableName: pulumi.Input<string>;

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

property timeToLive

timeToLive: pulumi.Input<number>;

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

interface TableState

interface TableState

Input properties used for looking up and filtering Table resources.

property deviationCellVersionInSec

deviationCellVersionInSec?: pulumi.Input<string>;

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

property instanceName

instanceName?: pulumi.Input<string>;

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

property maxVersion

maxVersion?: pulumi.Input<number>;

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

property primaryKeys

primaryKeys?: pulumi.Input<pulumi.Input<TablePrimaryKey>[]>;

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

property tableName

tableName?: pulumi.Input<string>;

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

property timeToLive

timeToLive?: pulumi.Input<number>;

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