ots

package
v3.43.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 11, 2023 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetInstanceAttachmentsArgs

type GetInstanceAttachmentsArgs struct {
	// The name of OTS instance.
	InstanceName string `pulumi:"instanceName"`
	// A regex string to filter results by vpc name.
	NameRegex *string `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile *string `pulumi:"outputFile"`
}

A collection of arguments for invoking getInstanceAttachments.

type GetInstanceAttachmentsAttachment

type GetInstanceAttachmentsAttachment struct {
	// The domain of the instance attachment.
	Domain string `pulumi:"domain"`
	// The access endpoint of the instance attachment.
	Endpoint string `pulumi:"endpoint"`
	// The resource ID, the value is same as "instanceName".
	Id string `pulumi:"id"`
	// The name of OTS instance.
	InstanceName string `pulumi:"instanceName"`
	// The region of the instance attachment.
	Region string `pulumi:"region"`
	// The ID of attaching VPC to instance.
	VpcId string `pulumi:"vpcId"`
	// The name of attaching VPC to instance.
	VpcName string `pulumi:"vpcName"`
}

type GetInstanceAttachmentsAttachmentArgs

type GetInstanceAttachmentsAttachmentArgs struct {
	// The domain of the instance attachment.
	Domain pulumi.StringInput `pulumi:"domain"`
	// The access endpoint of the instance attachment.
	Endpoint pulumi.StringInput `pulumi:"endpoint"`
	// The resource ID, the value is same as "instanceName".
	Id pulumi.StringInput `pulumi:"id"`
	// The name of OTS instance.
	InstanceName pulumi.StringInput `pulumi:"instanceName"`
	// The region of the instance attachment.
	Region pulumi.StringInput `pulumi:"region"`
	// The ID of attaching VPC to instance.
	VpcId pulumi.StringInput `pulumi:"vpcId"`
	// The name of attaching VPC to instance.
	VpcName pulumi.StringInput `pulumi:"vpcName"`
}

func (GetInstanceAttachmentsAttachmentArgs) ElementType

func (GetInstanceAttachmentsAttachmentArgs) ToGetInstanceAttachmentsAttachmentOutput

func (i GetInstanceAttachmentsAttachmentArgs) ToGetInstanceAttachmentsAttachmentOutput() GetInstanceAttachmentsAttachmentOutput

func (GetInstanceAttachmentsAttachmentArgs) ToGetInstanceAttachmentsAttachmentOutputWithContext

func (i GetInstanceAttachmentsAttachmentArgs) ToGetInstanceAttachmentsAttachmentOutputWithContext(ctx context.Context) GetInstanceAttachmentsAttachmentOutput

func (GetInstanceAttachmentsAttachmentArgs) ToOutput added in v3.43.1

type GetInstanceAttachmentsAttachmentArray

type GetInstanceAttachmentsAttachmentArray []GetInstanceAttachmentsAttachmentInput

func (GetInstanceAttachmentsAttachmentArray) ElementType

func (GetInstanceAttachmentsAttachmentArray) ToGetInstanceAttachmentsAttachmentArrayOutput

func (i GetInstanceAttachmentsAttachmentArray) ToGetInstanceAttachmentsAttachmentArrayOutput() GetInstanceAttachmentsAttachmentArrayOutput

func (GetInstanceAttachmentsAttachmentArray) ToGetInstanceAttachmentsAttachmentArrayOutputWithContext

func (i GetInstanceAttachmentsAttachmentArray) ToGetInstanceAttachmentsAttachmentArrayOutputWithContext(ctx context.Context) GetInstanceAttachmentsAttachmentArrayOutput

func (GetInstanceAttachmentsAttachmentArray) ToOutput added in v3.43.1

type GetInstanceAttachmentsAttachmentArrayInput

type GetInstanceAttachmentsAttachmentArrayInput interface {
	pulumi.Input

	ToGetInstanceAttachmentsAttachmentArrayOutput() GetInstanceAttachmentsAttachmentArrayOutput
	ToGetInstanceAttachmentsAttachmentArrayOutputWithContext(context.Context) GetInstanceAttachmentsAttachmentArrayOutput
}

GetInstanceAttachmentsAttachmentArrayInput is an input type that accepts GetInstanceAttachmentsAttachmentArray and GetInstanceAttachmentsAttachmentArrayOutput values. You can construct a concrete instance of `GetInstanceAttachmentsAttachmentArrayInput` via:

GetInstanceAttachmentsAttachmentArray{ GetInstanceAttachmentsAttachmentArgs{...} }

type GetInstanceAttachmentsAttachmentArrayOutput

type GetInstanceAttachmentsAttachmentArrayOutput struct{ *pulumi.OutputState }

func (GetInstanceAttachmentsAttachmentArrayOutput) ElementType

func (GetInstanceAttachmentsAttachmentArrayOutput) Index

func (GetInstanceAttachmentsAttachmentArrayOutput) ToGetInstanceAttachmentsAttachmentArrayOutput

func (o GetInstanceAttachmentsAttachmentArrayOutput) ToGetInstanceAttachmentsAttachmentArrayOutput() GetInstanceAttachmentsAttachmentArrayOutput

func (GetInstanceAttachmentsAttachmentArrayOutput) ToGetInstanceAttachmentsAttachmentArrayOutputWithContext

func (o GetInstanceAttachmentsAttachmentArrayOutput) ToGetInstanceAttachmentsAttachmentArrayOutputWithContext(ctx context.Context) GetInstanceAttachmentsAttachmentArrayOutput

func (GetInstanceAttachmentsAttachmentArrayOutput) ToOutput added in v3.43.1

type GetInstanceAttachmentsAttachmentInput

type GetInstanceAttachmentsAttachmentInput interface {
	pulumi.Input

	ToGetInstanceAttachmentsAttachmentOutput() GetInstanceAttachmentsAttachmentOutput
	ToGetInstanceAttachmentsAttachmentOutputWithContext(context.Context) GetInstanceAttachmentsAttachmentOutput
}

GetInstanceAttachmentsAttachmentInput is an input type that accepts GetInstanceAttachmentsAttachmentArgs and GetInstanceAttachmentsAttachmentOutput values. You can construct a concrete instance of `GetInstanceAttachmentsAttachmentInput` via:

GetInstanceAttachmentsAttachmentArgs{...}

type GetInstanceAttachmentsAttachmentOutput

type GetInstanceAttachmentsAttachmentOutput struct{ *pulumi.OutputState }

func (GetInstanceAttachmentsAttachmentOutput) Domain

The domain of the instance attachment.

func (GetInstanceAttachmentsAttachmentOutput) ElementType

func (GetInstanceAttachmentsAttachmentOutput) Endpoint

The access endpoint of the instance attachment.

func (GetInstanceAttachmentsAttachmentOutput) Id

The resource ID, the value is same as "instanceName".

func (GetInstanceAttachmentsAttachmentOutput) InstanceName

The name of OTS instance.

func (GetInstanceAttachmentsAttachmentOutput) Region

The region of the instance attachment.

func (GetInstanceAttachmentsAttachmentOutput) ToGetInstanceAttachmentsAttachmentOutput

func (o GetInstanceAttachmentsAttachmentOutput) ToGetInstanceAttachmentsAttachmentOutput() GetInstanceAttachmentsAttachmentOutput

func (GetInstanceAttachmentsAttachmentOutput) ToGetInstanceAttachmentsAttachmentOutputWithContext

func (o GetInstanceAttachmentsAttachmentOutput) ToGetInstanceAttachmentsAttachmentOutputWithContext(ctx context.Context) GetInstanceAttachmentsAttachmentOutput

func (GetInstanceAttachmentsAttachmentOutput) ToOutput added in v3.43.1

func (GetInstanceAttachmentsAttachmentOutput) VpcId

The ID of attaching VPC to instance.

func (GetInstanceAttachmentsAttachmentOutput) VpcName

The name of attaching VPC to instance.

type GetInstanceAttachmentsOutputArgs added in v3.9.0

type GetInstanceAttachmentsOutputArgs struct {
	// The name of OTS instance.
	InstanceName pulumi.StringInput `pulumi:"instanceName"`
	// A regex string to filter results by vpc name.
	NameRegex pulumi.StringPtrInput `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile pulumi.StringPtrInput `pulumi:"outputFile"`
}

A collection of arguments for invoking getInstanceAttachments.

func (GetInstanceAttachmentsOutputArgs) ElementType added in v3.9.0

type GetInstanceAttachmentsResult

type GetInstanceAttachmentsResult struct {
	// A list of instance attachments. Each element contains the following attributes:
	Attachments []GetInstanceAttachmentsAttachment `pulumi:"attachments"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The instance name.
	InstanceName string  `pulumi:"instanceName"`
	NameRegex    *string `pulumi:"nameRegex"`
	// A list of vpc names.
	Names      []string `pulumi:"names"`
	OutputFile *string  `pulumi:"outputFile"`
	// A list of vpc ids.
	VpcIds []string `pulumi:"vpcIds"`
}

A collection of values returned by getInstanceAttachments.

func GetInstanceAttachments

func GetInstanceAttachments(ctx *pulumi.Context, args *GetInstanceAttachmentsArgs, opts ...pulumi.InvokeOption) (*GetInstanceAttachmentsResult, error)

This data source provides the ots instance attachments of the current Alibaba Cloud user.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ots"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		attachmentsDs, err := ots.GetInstanceAttachments(ctx, &ots.GetInstanceAttachmentsArgs{
			InstanceName: "sample-instance",
			NameRegex:    pulumi.StringRef("testvpc"),
			OutputFile:   pulumi.StringRef("attachments.txt"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("firstOtsAttachmentId", attachmentsDs.Attachments[0].Id)
		return nil
	})
}

```

type GetInstanceAttachmentsResultOutput added in v3.9.0

type GetInstanceAttachmentsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getInstanceAttachments.

func GetInstanceAttachmentsOutput added in v3.9.0

func (GetInstanceAttachmentsResultOutput) Attachments added in v3.9.0

A list of instance attachments. Each element contains the following attributes:

func (GetInstanceAttachmentsResultOutput) ElementType added in v3.9.0

func (GetInstanceAttachmentsResultOutput) Id added in v3.9.0

The provider-assigned unique ID for this managed resource.

func (GetInstanceAttachmentsResultOutput) InstanceName added in v3.9.0

The instance name.

func (GetInstanceAttachmentsResultOutput) NameRegex added in v3.9.0

func (GetInstanceAttachmentsResultOutput) Names added in v3.9.0

A list of vpc names.

func (GetInstanceAttachmentsResultOutput) OutputFile added in v3.9.0

func (GetInstanceAttachmentsResultOutput) ToGetInstanceAttachmentsResultOutput added in v3.9.0

func (o GetInstanceAttachmentsResultOutput) ToGetInstanceAttachmentsResultOutput() GetInstanceAttachmentsResultOutput

func (GetInstanceAttachmentsResultOutput) ToGetInstanceAttachmentsResultOutputWithContext added in v3.9.0

func (o GetInstanceAttachmentsResultOutput) ToGetInstanceAttachmentsResultOutputWithContext(ctx context.Context) GetInstanceAttachmentsResultOutput

func (GetInstanceAttachmentsResultOutput) ToOutput added in v3.43.1

func (GetInstanceAttachmentsResultOutput) VpcIds added in v3.9.0

A list of vpc ids.

type GetInstancesArgs

type GetInstancesArgs struct {
	// A list of instance IDs.
	Ids []string `pulumi:"ids"`
	// A regex string to filter results by instance name.
	NameRegex *string `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile *string `pulumi:"outputFile"`
	// A map of tags assigned to the instance. It must be in the format:
	// “`go
	// package main
	//
	// import (
	// 	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ots"
	// 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	// )
	//
	// func main() {
	// 	pulumi.Run(func(ctx *pulumi.Context) error {
	// 		_, err := ots.GetInstances(ctx, &ots.GetInstancesArgs{
	// 			Tags: map[string]interface{}{
	// 				"tagKey1": "tagValue1",
	// 				"tagKey2": "tagValue2",
	// 			},
	// 		}, nil)
	// 		if err != nil {
	// 			return err
	// 		}
	// 		return nil
	// 	})
	// }
	// “`
	Tags map[string]interface{} `pulumi:"tags"`
}

A collection of arguments for invoking getInstances.

type GetInstancesInstance

type GetInstancesInstance struct {
	// The cluster type of the instance. Possible values: `SSD`, `HYBRID`.
	ClusterType string `pulumi:"clusterType"`
	// The create time of the instance.
	CreateTime string `pulumi:"createTime"`
	// The description of the instance.
	Description string `pulumi:"description"`
	// The instance quota which indicating the maximum number of tables.
	EntityQuota int `pulumi:"entityQuota"`
	// ID of the instance.
	Id string `pulumi:"id"`
	// Instance name.
	Name string `pulumi:"name"`
	// The network type of the instance. Possible values: `NORMAL`, `VPC`, `VPC_CONSOLE`.
	Network string `pulumi:"network"`
	// The maximum adjustable read capacity unit of the instance.
	ReadCapacity int `pulumi:"readCapacity"`
	// Instance status. Possible values: `Running`, `Disabled`, `Deleting`.
	Status string `pulumi:"status"`
	// A map of tags assigned to the instance. It must be in the format:
	// “`go
	// package main
	//
	// import (
	// 	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ots"
	// 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	// )
	//
	// func main() {
	// 	pulumi.Run(func(ctx *pulumi.Context) error {
	// 		_, err := ots.GetInstances(ctx, &ots.GetInstancesArgs{
	// 			Tags: map[string]interface{}{
	// 				"tagKey1": "tagValue1",
	// 				"tagKey2": "tagValue2",
	// 			},
	// 		}, nil)
	// 		if err != nil {
	// 			return err
	// 		}
	// 		return nil
	// 	})
	// }
	// “`
	Tags map[string]interface{} `pulumi:"tags"`
	// The user id of the instance.
	UserId string `pulumi:"userId"`
	// The maximum adjustable write capacity unit of the instance.
	WriteCapacity int `pulumi:"writeCapacity"`
}

type GetInstancesInstanceArgs

type GetInstancesInstanceArgs struct {
	// The cluster type of the instance. Possible values: `SSD`, `HYBRID`.
	ClusterType pulumi.StringInput `pulumi:"clusterType"`
	// The create time of the instance.
	CreateTime pulumi.StringInput `pulumi:"createTime"`
	// The description of the instance.
	Description pulumi.StringInput `pulumi:"description"`
	// The instance quota which indicating the maximum number of tables.
	EntityQuota pulumi.IntInput `pulumi:"entityQuota"`
	// ID of the instance.
	Id pulumi.StringInput `pulumi:"id"`
	// Instance name.
	Name pulumi.StringInput `pulumi:"name"`
	// The network type of the instance. Possible values: `NORMAL`, `VPC`, `VPC_CONSOLE`.
	Network pulumi.StringInput `pulumi:"network"`
	// The maximum adjustable read capacity unit of the instance.
	ReadCapacity pulumi.IntInput `pulumi:"readCapacity"`
	// Instance status. Possible values: `Running`, `Disabled`, `Deleting`.
	Status pulumi.StringInput `pulumi:"status"`
	// A map of tags assigned to the instance. It must be in the format:
	// “`go
	// package main
	//
	// import (
	// 	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ots"
	// 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	// )
	//
	// func main() {
	// 	pulumi.Run(func(ctx *pulumi.Context) error {
	// 		_, err := ots.GetInstances(ctx, &ots.GetInstancesArgs{
	// 			Tags: map[string]interface{}{
	// 				"tagKey1": "tagValue1",
	// 				"tagKey2": "tagValue2",
	// 			},
	// 		}, nil)
	// 		if err != nil {
	// 			return err
	// 		}
	// 		return nil
	// 	})
	// }
	// “`
	Tags pulumi.MapInput `pulumi:"tags"`
	// The user id of the instance.
	UserId pulumi.StringInput `pulumi:"userId"`
	// The maximum adjustable write capacity unit of the instance.
	WriteCapacity pulumi.IntInput `pulumi:"writeCapacity"`
}

func (GetInstancesInstanceArgs) ElementType

func (GetInstancesInstanceArgs) ElementType() reflect.Type

func (GetInstancesInstanceArgs) ToGetInstancesInstanceOutput

func (i GetInstancesInstanceArgs) ToGetInstancesInstanceOutput() GetInstancesInstanceOutput

func (GetInstancesInstanceArgs) ToGetInstancesInstanceOutputWithContext

func (i GetInstancesInstanceArgs) ToGetInstancesInstanceOutputWithContext(ctx context.Context) GetInstancesInstanceOutput

func (GetInstancesInstanceArgs) ToOutput added in v3.43.1

type GetInstancesInstanceArray

type GetInstancesInstanceArray []GetInstancesInstanceInput

func (GetInstancesInstanceArray) ElementType

func (GetInstancesInstanceArray) ElementType() reflect.Type

func (GetInstancesInstanceArray) ToGetInstancesInstanceArrayOutput

func (i GetInstancesInstanceArray) ToGetInstancesInstanceArrayOutput() GetInstancesInstanceArrayOutput

func (GetInstancesInstanceArray) ToGetInstancesInstanceArrayOutputWithContext

func (i GetInstancesInstanceArray) ToGetInstancesInstanceArrayOutputWithContext(ctx context.Context) GetInstancesInstanceArrayOutput

func (GetInstancesInstanceArray) ToOutput added in v3.43.1

type GetInstancesInstanceArrayInput

type GetInstancesInstanceArrayInput interface {
	pulumi.Input

	ToGetInstancesInstanceArrayOutput() GetInstancesInstanceArrayOutput
	ToGetInstancesInstanceArrayOutputWithContext(context.Context) GetInstancesInstanceArrayOutput
}

GetInstancesInstanceArrayInput is an input type that accepts GetInstancesInstanceArray and GetInstancesInstanceArrayOutput values. You can construct a concrete instance of `GetInstancesInstanceArrayInput` via:

GetInstancesInstanceArray{ GetInstancesInstanceArgs{...} }

type GetInstancesInstanceArrayOutput

type GetInstancesInstanceArrayOutput struct{ *pulumi.OutputState }

func (GetInstancesInstanceArrayOutput) ElementType

func (GetInstancesInstanceArrayOutput) Index

func (GetInstancesInstanceArrayOutput) ToGetInstancesInstanceArrayOutput

func (o GetInstancesInstanceArrayOutput) ToGetInstancesInstanceArrayOutput() GetInstancesInstanceArrayOutput

func (GetInstancesInstanceArrayOutput) ToGetInstancesInstanceArrayOutputWithContext

func (o GetInstancesInstanceArrayOutput) ToGetInstancesInstanceArrayOutputWithContext(ctx context.Context) GetInstancesInstanceArrayOutput

func (GetInstancesInstanceArrayOutput) ToOutput added in v3.43.1

type GetInstancesInstanceInput

type GetInstancesInstanceInput interface {
	pulumi.Input

	ToGetInstancesInstanceOutput() GetInstancesInstanceOutput
	ToGetInstancesInstanceOutputWithContext(context.Context) GetInstancesInstanceOutput
}

GetInstancesInstanceInput is an input type that accepts GetInstancesInstanceArgs and GetInstancesInstanceOutput values. You can construct a concrete instance of `GetInstancesInstanceInput` via:

GetInstancesInstanceArgs{...}

type GetInstancesInstanceOutput

type GetInstancesInstanceOutput struct{ *pulumi.OutputState }

func (GetInstancesInstanceOutput) ClusterType

The cluster type of the instance. Possible values: `SSD`, `HYBRID`.

func (GetInstancesInstanceOutput) CreateTime

The create time of the instance.

func (GetInstancesInstanceOutput) Description

The description of the instance.

func (GetInstancesInstanceOutput) ElementType

func (GetInstancesInstanceOutput) ElementType() reflect.Type

func (GetInstancesInstanceOutput) EntityQuota

The instance quota which indicating the maximum number of tables.

func (GetInstancesInstanceOutput) Id

ID of the instance.

func (GetInstancesInstanceOutput) Name

Instance name.

func (GetInstancesInstanceOutput) Network

The network type of the instance. Possible values: `NORMAL`, `VPC`, `VPC_CONSOLE`.

func (GetInstancesInstanceOutput) ReadCapacity

func (o GetInstancesInstanceOutput) ReadCapacity() pulumi.IntOutput

The maximum adjustable read capacity unit of the instance.

func (GetInstancesInstanceOutput) Status

Instance status. Possible values: `Running`, `Disabled`, `Deleting`.

func (GetInstancesInstanceOutput) Tags

A map of tags assigned to the instance. It must be in the format: ```go package main

import (

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ots"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ots.GetInstances(ctx, &ots.GetInstancesArgs{
			Tags: map[string]interface{}{
				"tagKey1": "tagValue1",
				"tagKey2": "tagValue2",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

func (GetInstancesInstanceOutput) ToGetInstancesInstanceOutput

func (o GetInstancesInstanceOutput) ToGetInstancesInstanceOutput() GetInstancesInstanceOutput

func (GetInstancesInstanceOutput) ToGetInstancesInstanceOutputWithContext

func (o GetInstancesInstanceOutput) ToGetInstancesInstanceOutputWithContext(ctx context.Context) GetInstancesInstanceOutput

func (GetInstancesInstanceOutput) ToOutput added in v3.43.1

func (GetInstancesInstanceOutput) UserId

The user id of the instance.

func (GetInstancesInstanceOutput) WriteCapacity

func (o GetInstancesInstanceOutput) WriteCapacity() pulumi.IntOutput

The maximum adjustable write capacity unit of the instance.

type GetInstancesOutputArgs added in v3.9.0

type GetInstancesOutputArgs struct {
	// A list of instance IDs.
	Ids pulumi.StringArrayInput `pulumi:"ids"`
	// A regex string to filter results by instance name.
	NameRegex pulumi.StringPtrInput `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile pulumi.StringPtrInput `pulumi:"outputFile"`
	// A map of tags assigned to the instance. It must be in the format:
	// “`go
	// package main
	//
	// import (
	// 	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ots"
	// 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	// )
	//
	// func main() {
	// 	pulumi.Run(func(ctx *pulumi.Context) error {
	// 		_, err := ots.GetInstances(ctx, &ots.GetInstancesArgs{
	// 			Tags: map[string]interface{}{
	// 				"tagKey1": "tagValue1",
	// 				"tagKey2": "tagValue2",
	// 			},
	// 		}, nil)
	// 		if err != nil {
	// 			return err
	// 		}
	// 		return nil
	// 	})
	// }
	// “`
	Tags pulumi.MapInput `pulumi:"tags"`
}

A collection of arguments for invoking getInstances.

func (GetInstancesOutputArgs) ElementType added in v3.9.0

func (GetInstancesOutputArgs) ElementType() reflect.Type

type GetInstancesResult

type GetInstancesResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// A list of instance IDs.
	Ids []string `pulumi:"ids"`
	// A list of instances. Each element contains the following attributes:
	Instances []GetInstancesInstance `pulumi:"instances"`
	NameRegex *string                `pulumi:"nameRegex"`
	// A list of instance names.
	Names      []string `pulumi:"names"`
	OutputFile *string  `pulumi:"outputFile"`
	// The tags of the instance.
	Tags map[string]interface{} `pulumi:"tags"`
}

A collection of values returned by getInstances.

func GetInstances

func GetInstances(ctx *pulumi.Context, args *GetInstancesArgs, opts ...pulumi.InvokeOption) (*GetInstancesResult, error)

This data source provides the ots instances of the current Alibaba Cloud user.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ots"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		instancesDs, err := ots.GetInstances(ctx, &ots.GetInstancesArgs{
			NameRegex:  pulumi.StringRef("sample-instance"),
			OutputFile: pulumi.StringRef("instances.txt"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("firstInstanceId", instancesDs.Instances[0].Id)
		return nil
	})
}

```

type GetInstancesResultOutput added in v3.9.0

type GetInstancesResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getInstances.

func GetInstancesOutput added in v3.9.0

func GetInstancesOutput(ctx *pulumi.Context, args GetInstancesOutputArgs, opts ...pulumi.InvokeOption) GetInstancesResultOutput

func (GetInstancesResultOutput) ElementType added in v3.9.0

func (GetInstancesResultOutput) ElementType() reflect.Type

func (GetInstancesResultOutput) Id added in v3.9.0

The provider-assigned unique ID for this managed resource.

func (GetInstancesResultOutput) Ids added in v3.9.0

A list of instance IDs.

func (GetInstancesResultOutput) Instances added in v3.9.0

A list of instances. Each element contains the following attributes:

func (GetInstancesResultOutput) NameRegex added in v3.9.0

func (GetInstancesResultOutput) Names added in v3.9.0

A list of instance names.

func (GetInstancesResultOutput) OutputFile added in v3.9.0

func (GetInstancesResultOutput) Tags added in v3.9.0

The tags of the instance.

func (GetInstancesResultOutput) ToGetInstancesResultOutput added in v3.9.0

func (o GetInstancesResultOutput) ToGetInstancesResultOutput() GetInstancesResultOutput

func (GetInstancesResultOutput) ToGetInstancesResultOutputWithContext added in v3.9.0

func (o GetInstancesResultOutput) ToGetInstancesResultOutputWithContext(ctx context.Context) GetInstancesResultOutput

func (GetInstancesResultOutput) ToOutput added in v3.43.1

type GetSearchIndexesArgs added in v3.29.0

type GetSearchIndexesArgs struct {
	// A list of search index IDs.
	Ids []string `pulumi:"ids"`
	// The name of OTS instance.
	InstanceName string `pulumi:"instanceName"`
	// A regex string to filter results by search index name.
	NameRegex *string `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile *string `pulumi:"outputFile"`
	// The name of OTS table.
	TableName string `pulumi:"tableName"`
}

A collection of arguments for invoking getSearchIndexes.

type GetSearchIndexesIndex added in v3.29.0

type GetSearchIndexesIndex struct {
	// The creation time of the index.
	CreateTime int `pulumi:"createTime"`
	// Timestamp for sync phase.
	CurrentSyncTimestamp int `pulumi:"currentSyncTimestamp"`
	// The resource ID. The value is `<instance_name>:<table_name>:<indexName>:<indexType>`.
	Id string `pulumi:"id"`
	// The index name of the OTS Table which could not be changed.
	IndexName string `pulumi:"indexName"`
	// The name of OTS instance.
	InstanceName string `pulumi:"instanceName"`
	// Last update time for metering data..
	MeteringLastUpdateTime int `pulumi:"meteringLastUpdateTime"`
	// Reserve related resources for the index.
	ReservedReadCu int `pulumi:"reservedReadCu"`
	// The number of rows of data for index.
	RowCount int `pulumi:"rowCount"`
	// JSON representation of the schema of index.
	Schema string `pulumi:"schema"`
	// Storage space occupied by index.
	StorageSize int `pulumi:"storageSize"`
	// The synchronization state of the index.
	SyncPhase string `pulumi:"syncPhase"`
	// The name of OTS table.
	TableName string `pulumi:"tableName"`
	// TTL of index.
	TimeToLive int `pulumi:"timeToLive"`
}

type GetSearchIndexesIndexArgs added in v3.29.0

type GetSearchIndexesIndexArgs struct {
	// The creation time of the index.
	CreateTime pulumi.IntInput `pulumi:"createTime"`
	// Timestamp for sync phase.
	CurrentSyncTimestamp pulumi.IntInput `pulumi:"currentSyncTimestamp"`
	// The resource ID. The value is `<instance_name>:<table_name>:<indexName>:<indexType>`.
	Id pulumi.StringInput `pulumi:"id"`
	// The index name of the OTS Table which could not be changed.
	IndexName pulumi.StringInput `pulumi:"indexName"`
	// The name of OTS instance.
	InstanceName pulumi.StringInput `pulumi:"instanceName"`
	// Last update time for metering data..
	MeteringLastUpdateTime pulumi.IntInput `pulumi:"meteringLastUpdateTime"`
	// Reserve related resources for the index.
	ReservedReadCu pulumi.IntInput `pulumi:"reservedReadCu"`
	// The number of rows of data for index.
	RowCount pulumi.IntInput `pulumi:"rowCount"`
	// JSON representation of the schema of index.
	Schema pulumi.StringInput `pulumi:"schema"`
	// Storage space occupied by index.
	StorageSize pulumi.IntInput `pulumi:"storageSize"`
	// The synchronization state of the index.
	SyncPhase pulumi.StringInput `pulumi:"syncPhase"`
	// The name of OTS table.
	TableName pulumi.StringInput `pulumi:"tableName"`
	// TTL of index.
	TimeToLive pulumi.IntInput `pulumi:"timeToLive"`
}

func (GetSearchIndexesIndexArgs) ElementType added in v3.29.0

func (GetSearchIndexesIndexArgs) ElementType() reflect.Type

func (GetSearchIndexesIndexArgs) ToGetSearchIndexesIndexOutput added in v3.29.0

func (i GetSearchIndexesIndexArgs) ToGetSearchIndexesIndexOutput() GetSearchIndexesIndexOutput

func (GetSearchIndexesIndexArgs) ToGetSearchIndexesIndexOutputWithContext added in v3.29.0

func (i GetSearchIndexesIndexArgs) ToGetSearchIndexesIndexOutputWithContext(ctx context.Context) GetSearchIndexesIndexOutput

func (GetSearchIndexesIndexArgs) ToOutput added in v3.43.1

type GetSearchIndexesIndexArray added in v3.29.0

type GetSearchIndexesIndexArray []GetSearchIndexesIndexInput

func (GetSearchIndexesIndexArray) ElementType added in v3.29.0

func (GetSearchIndexesIndexArray) ElementType() reflect.Type

func (GetSearchIndexesIndexArray) ToGetSearchIndexesIndexArrayOutput added in v3.29.0

func (i GetSearchIndexesIndexArray) ToGetSearchIndexesIndexArrayOutput() GetSearchIndexesIndexArrayOutput

func (GetSearchIndexesIndexArray) ToGetSearchIndexesIndexArrayOutputWithContext added in v3.29.0

func (i GetSearchIndexesIndexArray) ToGetSearchIndexesIndexArrayOutputWithContext(ctx context.Context) GetSearchIndexesIndexArrayOutput

func (GetSearchIndexesIndexArray) ToOutput added in v3.43.1

type GetSearchIndexesIndexArrayInput added in v3.29.0

type GetSearchIndexesIndexArrayInput interface {
	pulumi.Input

	ToGetSearchIndexesIndexArrayOutput() GetSearchIndexesIndexArrayOutput
	ToGetSearchIndexesIndexArrayOutputWithContext(context.Context) GetSearchIndexesIndexArrayOutput
}

GetSearchIndexesIndexArrayInput is an input type that accepts GetSearchIndexesIndexArray and GetSearchIndexesIndexArrayOutput values. You can construct a concrete instance of `GetSearchIndexesIndexArrayInput` via:

GetSearchIndexesIndexArray{ GetSearchIndexesIndexArgs{...} }

type GetSearchIndexesIndexArrayOutput added in v3.29.0

type GetSearchIndexesIndexArrayOutput struct{ *pulumi.OutputState }

func (GetSearchIndexesIndexArrayOutput) ElementType added in v3.29.0

func (GetSearchIndexesIndexArrayOutput) Index added in v3.29.0

func (GetSearchIndexesIndexArrayOutput) ToGetSearchIndexesIndexArrayOutput added in v3.29.0

func (o GetSearchIndexesIndexArrayOutput) ToGetSearchIndexesIndexArrayOutput() GetSearchIndexesIndexArrayOutput

func (GetSearchIndexesIndexArrayOutput) ToGetSearchIndexesIndexArrayOutputWithContext added in v3.29.0

func (o GetSearchIndexesIndexArrayOutput) ToGetSearchIndexesIndexArrayOutputWithContext(ctx context.Context) GetSearchIndexesIndexArrayOutput

func (GetSearchIndexesIndexArrayOutput) ToOutput added in v3.43.1

type GetSearchIndexesIndexInput added in v3.29.0

type GetSearchIndexesIndexInput interface {
	pulumi.Input

	ToGetSearchIndexesIndexOutput() GetSearchIndexesIndexOutput
	ToGetSearchIndexesIndexOutputWithContext(context.Context) GetSearchIndexesIndexOutput
}

GetSearchIndexesIndexInput is an input type that accepts GetSearchIndexesIndexArgs and GetSearchIndexesIndexOutput values. You can construct a concrete instance of `GetSearchIndexesIndexInput` via:

GetSearchIndexesIndexArgs{...}

type GetSearchIndexesIndexOutput added in v3.29.0

type GetSearchIndexesIndexOutput struct{ *pulumi.OutputState }

func (GetSearchIndexesIndexOutput) CreateTime added in v3.29.0

The creation time of the index.

func (GetSearchIndexesIndexOutput) CurrentSyncTimestamp added in v3.29.0

func (o GetSearchIndexesIndexOutput) CurrentSyncTimestamp() pulumi.IntOutput

Timestamp for sync phase.

func (GetSearchIndexesIndexOutput) ElementType added in v3.29.0

func (GetSearchIndexesIndexOutput) Id added in v3.29.0

The resource ID. The value is `<instance_name>:<table_name>:<indexName>:<indexType>`.

func (GetSearchIndexesIndexOutput) IndexName added in v3.29.0

The index name of the OTS Table which could not be changed.

func (GetSearchIndexesIndexOutput) InstanceName added in v3.29.0

The name of OTS instance.

func (GetSearchIndexesIndexOutput) MeteringLastUpdateTime added in v3.29.0

func (o GetSearchIndexesIndexOutput) MeteringLastUpdateTime() pulumi.IntOutput

Last update time for metering data..

func (GetSearchIndexesIndexOutput) ReservedReadCu added in v3.29.0

func (o GetSearchIndexesIndexOutput) ReservedReadCu() pulumi.IntOutput

Reserve related resources for the index.

func (GetSearchIndexesIndexOutput) RowCount added in v3.29.0

The number of rows of data for index.

func (GetSearchIndexesIndexOutput) Schema added in v3.29.0

JSON representation of the schema of index.

func (GetSearchIndexesIndexOutput) StorageSize added in v3.29.0

Storage space occupied by index.

func (GetSearchIndexesIndexOutput) SyncPhase added in v3.29.0

The synchronization state of the index.

func (GetSearchIndexesIndexOutput) TableName added in v3.29.0

The name of OTS table.

func (GetSearchIndexesIndexOutput) TimeToLive added in v3.29.0

TTL of index.

func (GetSearchIndexesIndexOutput) ToGetSearchIndexesIndexOutput added in v3.29.0

func (o GetSearchIndexesIndexOutput) ToGetSearchIndexesIndexOutput() GetSearchIndexesIndexOutput

func (GetSearchIndexesIndexOutput) ToGetSearchIndexesIndexOutputWithContext added in v3.29.0

func (o GetSearchIndexesIndexOutput) ToGetSearchIndexesIndexOutputWithContext(ctx context.Context) GetSearchIndexesIndexOutput

func (GetSearchIndexesIndexOutput) ToOutput added in v3.43.1

type GetSearchIndexesOutputArgs added in v3.29.0

type GetSearchIndexesOutputArgs struct {
	// A list of search index IDs.
	Ids pulumi.StringArrayInput `pulumi:"ids"`
	// The name of OTS instance.
	InstanceName pulumi.StringInput `pulumi:"instanceName"`
	// A regex string to filter results by search index name.
	NameRegex pulumi.StringPtrInput `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile pulumi.StringPtrInput `pulumi:"outputFile"`
	// The name of OTS table.
	TableName pulumi.StringInput `pulumi:"tableName"`
}

A collection of arguments for invoking getSearchIndexes.

func (GetSearchIndexesOutputArgs) ElementType added in v3.29.0

func (GetSearchIndexesOutputArgs) ElementType() reflect.Type

type GetSearchIndexesResult added in v3.29.0

type GetSearchIndexesResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// A list of search index IDs.
	Ids []string `pulumi:"ids"`
	// A list of indexes. Each element contains the following attributes:
	Indexes []GetSearchIndexesIndex `pulumi:"indexes"`
	// The OTS instance name.
	InstanceName string  `pulumi:"instanceName"`
	NameRegex    *string `pulumi:"nameRegex"`
	// A list of search index  names.
	Names      []string `pulumi:"names"`
	OutputFile *string  `pulumi:"outputFile"`
	// The table name of the OTS which could not be changed.
	TableName string `pulumi:"tableName"`
}

A collection of values returned by getSearchIndexes.

func GetSearchIndexes added in v3.29.0

func GetSearchIndexes(ctx *pulumi.Context, args *GetSearchIndexesArgs, opts ...pulumi.InvokeOption) (*GetSearchIndexesResult, error)

This data source provides the ots search index of the current Alibaba Cloud user.

For information about OTS search index and how to use it, see [Search index overview](https://www.alibabacloud.com/help/en/tablestore/latest/search-index-overview).

> **NOTE:** Available in v1.187.0+.

type GetSearchIndexesResultOutput added in v3.29.0

type GetSearchIndexesResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getSearchIndexes.

func GetSearchIndexesOutput added in v3.29.0

func (GetSearchIndexesResultOutput) ElementType added in v3.29.0

func (GetSearchIndexesResultOutput) Id added in v3.29.0

The provider-assigned unique ID for this managed resource.

func (GetSearchIndexesResultOutput) Ids added in v3.29.0

A list of search index IDs.

func (GetSearchIndexesResultOutput) Indexes added in v3.29.0

A list of indexes. Each element contains the following attributes:

func (GetSearchIndexesResultOutput) InstanceName added in v3.29.0

The OTS instance name.

func (GetSearchIndexesResultOutput) NameRegex added in v3.29.0

func (GetSearchIndexesResultOutput) Names added in v3.29.0

A list of search index names.

func (GetSearchIndexesResultOutput) OutputFile added in v3.29.0

func (GetSearchIndexesResultOutput) TableName added in v3.29.0

The table name of the OTS which could not be changed.

func (GetSearchIndexesResultOutput) ToGetSearchIndexesResultOutput added in v3.29.0

func (o GetSearchIndexesResultOutput) ToGetSearchIndexesResultOutput() GetSearchIndexesResultOutput

func (GetSearchIndexesResultOutput) ToGetSearchIndexesResultOutputWithContext added in v3.29.0

func (o GetSearchIndexesResultOutput) ToGetSearchIndexesResultOutputWithContext(ctx context.Context) GetSearchIndexesResultOutput

func (GetSearchIndexesResultOutput) ToOutput added in v3.43.1

type GetSecondaryIndexesArgs added in v3.29.0

type GetSecondaryIndexesArgs struct {
	// A list of secondary index IDs.
	Ids []string `pulumi:"ids"`
	// The name of OTS instance.
	InstanceName string `pulumi:"instanceName"`
	// A regex string to filter results by secondary index name.
	NameRegex *string `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile *string `pulumi:"outputFile"`
	// The name of OTS table.
	TableName string `pulumi:"tableName"`
}

A collection of arguments for invoking getSecondaryIndexes.

type GetSecondaryIndexesIndex added in v3.29.0

type GetSecondaryIndexesIndex struct {
	// A list of defined column for index, referenced from Table's primary keys or predefined columns.
	DefinedColumns []string `pulumi:"definedColumns"`
	// The resource ID. The value is `<instance_name>:<table_name>:<indexName>:<indexType>`.
	Id string `pulumi:"id"`
	// The index name of the OTS Table which could not be changed.
	IndexName string `pulumi:"indexName"`
	// The index type of the OTS Table which could not be changed.
	IndexType string `pulumi:"indexType"`
	// The name of OTS instance.
	InstanceName string `pulumi:"instanceName"`
	// A list of primary keys for index, referenced from Table's primary keys or predefined columns.
	PrimaryKeys []string `pulumi:"primaryKeys"`
	// The name of OTS table.
	TableName string `pulumi:"tableName"`
}

type GetSecondaryIndexesIndexArgs added in v3.29.0

type GetSecondaryIndexesIndexArgs struct {
	// A list of defined column for index, referenced from Table's primary keys or predefined columns.
	DefinedColumns pulumi.StringArrayInput `pulumi:"definedColumns"`
	// The resource ID. The value is `<instance_name>:<table_name>:<indexName>:<indexType>`.
	Id pulumi.StringInput `pulumi:"id"`
	// The index name of the OTS Table which could not be changed.
	IndexName pulumi.StringInput `pulumi:"indexName"`
	// The index type of the OTS Table which could not be changed.
	IndexType pulumi.StringInput `pulumi:"indexType"`
	// The name of OTS instance.
	InstanceName pulumi.StringInput `pulumi:"instanceName"`
	// A list of primary keys for index, referenced from Table's primary keys or predefined columns.
	PrimaryKeys pulumi.StringArrayInput `pulumi:"primaryKeys"`
	// The name of OTS table.
	TableName pulumi.StringInput `pulumi:"tableName"`
}

func (GetSecondaryIndexesIndexArgs) ElementType added in v3.29.0

func (GetSecondaryIndexesIndexArgs) ToGetSecondaryIndexesIndexOutput added in v3.29.0

func (i GetSecondaryIndexesIndexArgs) ToGetSecondaryIndexesIndexOutput() GetSecondaryIndexesIndexOutput

func (GetSecondaryIndexesIndexArgs) ToGetSecondaryIndexesIndexOutputWithContext added in v3.29.0

func (i GetSecondaryIndexesIndexArgs) ToGetSecondaryIndexesIndexOutputWithContext(ctx context.Context) GetSecondaryIndexesIndexOutput

func (GetSecondaryIndexesIndexArgs) ToOutput added in v3.43.1

type GetSecondaryIndexesIndexArray added in v3.29.0

type GetSecondaryIndexesIndexArray []GetSecondaryIndexesIndexInput

func (GetSecondaryIndexesIndexArray) ElementType added in v3.29.0

func (GetSecondaryIndexesIndexArray) ToGetSecondaryIndexesIndexArrayOutput added in v3.29.0

func (i GetSecondaryIndexesIndexArray) ToGetSecondaryIndexesIndexArrayOutput() GetSecondaryIndexesIndexArrayOutput

func (GetSecondaryIndexesIndexArray) ToGetSecondaryIndexesIndexArrayOutputWithContext added in v3.29.0

func (i GetSecondaryIndexesIndexArray) ToGetSecondaryIndexesIndexArrayOutputWithContext(ctx context.Context) GetSecondaryIndexesIndexArrayOutput

func (GetSecondaryIndexesIndexArray) ToOutput added in v3.43.1

type GetSecondaryIndexesIndexArrayInput added in v3.29.0

type GetSecondaryIndexesIndexArrayInput interface {
	pulumi.Input

	ToGetSecondaryIndexesIndexArrayOutput() GetSecondaryIndexesIndexArrayOutput
	ToGetSecondaryIndexesIndexArrayOutputWithContext(context.Context) GetSecondaryIndexesIndexArrayOutput
}

GetSecondaryIndexesIndexArrayInput is an input type that accepts GetSecondaryIndexesIndexArray and GetSecondaryIndexesIndexArrayOutput values. You can construct a concrete instance of `GetSecondaryIndexesIndexArrayInput` via:

GetSecondaryIndexesIndexArray{ GetSecondaryIndexesIndexArgs{...} }

type GetSecondaryIndexesIndexArrayOutput added in v3.29.0

type GetSecondaryIndexesIndexArrayOutput struct{ *pulumi.OutputState }

func (GetSecondaryIndexesIndexArrayOutput) ElementType added in v3.29.0

func (GetSecondaryIndexesIndexArrayOutput) Index added in v3.29.0

func (GetSecondaryIndexesIndexArrayOutput) ToGetSecondaryIndexesIndexArrayOutput added in v3.29.0

func (o GetSecondaryIndexesIndexArrayOutput) ToGetSecondaryIndexesIndexArrayOutput() GetSecondaryIndexesIndexArrayOutput

func (GetSecondaryIndexesIndexArrayOutput) ToGetSecondaryIndexesIndexArrayOutputWithContext added in v3.29.0

func (o GetSecondaryIndexesIndexArrayOutput) ToGetSecondaryIndexesIndexArrayOutputWithContext(ctx context.Context) GetSecondaryIndexesIndexArrayOutput

func (GetSecondaryIndexesIndexArrayOutput) ToOutput added in v3.43.1

type GetSecondaryIndexesIndexInput added in v3.29.0

type GetSecondaryIndexesIndexInput interface {
	pulumi.Input

	ToGetSecondaryIndexesIndexOutput() GetSecondaryIndexesIndexOutput
	ToGetSecondaryIndexesIndexOutputWithContext(context.Context) GetSecondaryIndexesIndexOutput
}

GetSecondaryIndexesIndexInput is an input type that accepts GetSecondaryIndexesIndexArgs and GetSecondaryIndexesIndexOutput values. You can construct a concrete instance of `GetSecondaryIndexesIndexInput` via:

GetSecondaryIndexesIndexArgs{...}

type GetSecondaryIndexesIndexOutput added in v3.29.0

type GetSecondaryIndexesIndexOutput struct{ *pulumi.OutputState }

func (GetSecondaryIndexesIndexOutput) DefinedColumns added in v3.29.0

A list of defined column for index, referenced from Table's primary keys or predefined columns.

func (GetSecondaryIndexesIndexOutput) ElementType added in v3.29.0

func (GetSecondaryIndexesIndexOutput) Id added in v3.29.0

The resource ID. The value is `<instance_name>:<table_name>:<indexName>:<indexType>`.

func (GetSecondaryIndexesIndexOutput) IndexName added in v3.29.0

The index name of the OTS Table which could not be changed.

func (GetSecondaryIndexesIndexOutput) IndexType added in v3.29.0

The index type of the OTS Table which could not be changed.

func (GetSecondaryIndexesIndexOutput) InstanceName added in v3.29.0

The name of OTS instance.

func (GetSecondaryIndexesIndexOutput) PrimaryKeys added in v3.29.0

A list of primary keys for index, referenced from Table's primary keys or predefined columns.

func (GetSecondaryIndexesIndexOutput) TableName added in v3.29.0

The name of OTS table.

func (GetSecondaryIndexesIndexOutput) ToGetSecondaryIndexesIndexOutput added in v3.29.0

func (o GetSecondaryIndexesIndexOutput) ToGetSecondaryIndexesIndexOutput() GetSecondaryIndexesIndexOutput

func (GetSecondaryIndexesIndexOutput) ToGetSecondaryIndexesIndexOutputWithContext added in v3.29.0

func (o GetSecondaryIndexesIndexOutput) ToGetSecondaryIndexesIndexOutputWithContext(ctx context.Context) GetSecondaryIndexesIndexOutput

func (GetSecondaryIndexesIndexOutput) ToOutput added in v3.43.1

type GetSecondaryIndexesOutputArgs added in v3.29.0

type GetSecondaryIndexesOutputArgs struct {
	// A list of secondary index IDs.
	Ids pulumi.StringArrayInput `pulumi:"ids"`
	// The name of OTS instance.
	InstanceName pulumi.StringInput `pulumi:"instanceName"`
	// A regex string to filter results by secondary index name.
	NameRegex pulumi.StringPtrInput `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile pulumi.StringPtrInput `pulumi:"outputFile"`
	// The name of OTS table.
	TableName pulumi.StringInput `pulumi:"tableName"`
}

A collection of arguments for invoking getSecondaryIndexes.

func (GetSecondaryIndexesOutputArgs) ElementType added in v3.29.0

type GetSecondaryIndexesResult added in v3.29.0

type GetSecondaryIndexesResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// A list of secondary index IDs.
	Ids []string `pulumi:"ids"`
	// A list of indexes. Each element contains the following attributes:
	Indexes []GetSecondaryIndexesIndex `pulumi:"indexes"`
	// The OTS instance name.
	InstanceName string  `pulumi:"instanceName"`
	NameRegex    *string `pulumi:"nameRegex"`
	// A list of secondary index  names.
	Names      []string `pulumi:"names"`
	OutputFile *string  `pulumi:"outputFile"`
	// The table name of the OTS which could not be changed.
	TableName string `pulumi:"tableName"`
}

A collection of values returned by getSecondaryIndexes.

func GetSecondaryIndexes added in v3.29.0

func GetSecondaryIndexes(ctx *pulumi.Context, args *GetSecondaryIndexesArgs, opts ...pulumi.InvokeOption) (*GetSecondaryIndexesResult, error)

This data source provides the ots secondary index of the current Alibaba Cloud user.

For information about OTS secondary index and how to use it, see [Secondary index overview](https://www.alibabacloud.com/help/en/tablestore/latest/secondary-index-overview).

> **NOTE:** Available in v1.187.0+.

type GetSecondaryIndexesResultOutput added in v3.29.0

type GetSecondaryIndexesResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getSecondaryIndexes.

func GetSecondaryIndexesOutput added in v3.29.0

func (GetSecondaryIndexesResultOutput) ElementType added in v3.29.0

func (GetSecondaryIndexesResultOutput) Id added in v3.29.0

The provider-assigned unique ID for this managed resource.

func (GetSecondaryIndexesResultOutput) Ids added in v3.29.0

A list of secondary index IDs.

func (GetSecondaryIndexesResultOutput) Indexes added in v3.29.0

A list of indexes. Each element contains the following attributes:

func (GetSecondaryIndexesResultOutput) InstanceName added in v3.29.0

The OTS instance name.

func (GetSecondaryIndexesResultOutput) NameRegex added in v3.29.0

func (GetSecondaryIndexesResultOutput) Names added in v3.29.0

A list of secondary index names.

func (GetSecondaryIndexesResultOutput) OutputFile added in v3.29.0

func (GetSecondaryIndexesResultOutput) TableName added in v3.29.0

The table name of the OTS which could not be changed.

func (GetSecondaryIndexesResultOutput) ToGetSecondaryIndexesResultOutput added in v3.29.0

func (o GetSecondaryIndexesResultOutput) ToGetSecondaryIndexesResultOutput() GetSecondaryIndexesResultOutput

func (GetSecondaryIndexesResultOutput) ToGetSecondaryIndexesResultOutputWithContext added in v3.29.0

func (o GetSecondaryIndexesResultOutput) ToGetSecondaryIndexesResultOutputWithContext(ctx context.Context) GetSecondaryIndexesResultOutput

func (GetSecondaryIndexesResultOutput) ToOutput added in v3.43.1

type GetServiceArgs

type GetServiceArgs struct {
	// Setting the value to `On` to enable the service. If has been enabled, return the result. Valid values: "On" or "Off". Default to "Off".
	//
	// > **NOTE:** Setting `enable = "On"` to open the Table Staore service that means you have read and agreed the [Table Staore Terms of Service](https://help.aliyun.com/document_detail/34908.html). The service can not closed once it is opened.
	Enable *string `pulumi:"enable"`
}

A collection of arguments for invoking getService.

type GetServiceOutputArgs added in v3.9.0

type GetServiceOutputArgs struct {
	// Setting the value to `On` to enable the service. If has been enabled, return the result. Valid values: "On" or "Off". Default to "Off".
	//
	// > **NOTE:** Setting `enable = "On"` to open the Table Staore service that means you have read and agreed the [Table Staore Terms of Service](https://help.aliyun.com/document_detail/34908.html). The service can not closed once it is opened.
	Enable pulumi.StringPtrInput `pulumi:"enable"`
}

A collection of arguments for invoking getService.

func (GetServiceOutputArgs) ElementType added in v3.9.0

func (GetServiceOutputArgs) ElementType() reflect.Type

type GetServiceResult

type GetServiceResult struct {
	Enable *string `pulumi:"enable"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The current service enable status.
	Status string `pulumi:"status"`
}

A collection of values returned by getService.

func GetService

func GetService(ctx *pulumi.Context, args *GetServiceArgs, opts ...pulumi.InvokeOption) (*GetServiceResult, error)

Using this data source can enable Table Staore service automatically. If the service has been enabled, it will return `Opened`.

For information about Table Staore and how to use it, see [What is Table Staore](https://www.alibabacloud.com/help/product/27278.htm).

> **NOTE:** Available in v1.97.0+

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ots"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ots.GetService(ctx, &ots.GetServiceArgs{
			Enable: pulumi.StringRef("On"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type GetServiceResultOutput added in v3.9.0

type GetServiceResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getService.

func GetServiceOutput added in v3.9.0

func GetServiceOutput(ctx *pulumi.Context, args GetServiceOutputArgs, opts ...pulumi.InvokeOption) GetServiceResultOutput

func (GetServiceResultOutput) ElementType added in v3.9.0

func (GetServiceResultOutput) ElementType() reflect.Type

func (GetServiceResultOutput) Enable added in v3.9.0

func (GetServiceResultOutput) Id added in v3.9.0

The provider-assigned unique ID for this managed resource.

func (GetServiceResultOutput) Status added in v3.9.0

The current service enable status.

func (GetServiceResultOutput) ToGetServiceResultOutput added in v3.9.0

func (o GetServiceResultOutput) ToGetServiceResultOutput() GetServiceResultOutput

func (GetServiceResultOutput) ToGetServiceResultOutputWithContext added in v3.9.0

func (o GetServiceResultOutput) ToGetServiceResultOutputWithContext(ctx context.Context) GetServiceResultOutput

func (GetServiceResultOutput) ToOutput added in v3.43.1

type GetTablesArgs

type GetTablesArgs struct {
	// A list of table IDs.
	Ids []string `pulumi:"ids"`
	// The name of OTS instance.
	InstanceName string `pulumi:"instanceName"`
	// A regex string to filter results by table name.
	NameRegex *string `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile *string `pulumi:"outputFile"`
}

A collection of arguments for invoking getTables.

type GetTablesOutputArgs added in v3.9.0

type GetTablesOutputArgs struct {
	// A list of table IDs.
	Ids pulumi.StringArrayInput `pulumi:"ids"`
	// The name of OTS instance.
	InstanceName pulumi.StringInput `pulumi:"instanceName"`
	// A regex string to filter results by table name.
	NameRegex pulumi.StringPtrInput `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile pulumi.StringPtrInput `pulumi:"outputFile"`
}

A collection of arguments for invoking getTables.

func (GetTablesOutputArgs) ElementType added in v3.9.0

func (GetTablesOutputArgs) ElementType() reflect.Type

type GetTablesResult

type GetTablesResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// A list of table IDs.
	Ids []string `pulumi:"ids"`
	// The OTS instance name.
	InstanceName string  `pulumi:"instanceName"`
	NameRegex    *string `pulumi:"nameRegex"`
	// A list of table names.
	Names      []string `pulumi:"names"`
	OutputFile *string  `pulumi:"outputFile"`
	// A list of tables. Each element contains the following attributes:
	Tables []GetTablesTable `pulumi:"tables"`
}

A collection of values returned by getTables.

func GetTables

func GetTables(ctx *pulumi.Context, args *GetTablesArgs, opts ...pulumi.InvokeOption) (*GetTablesResult, error)

This data source provides the ots tables of the current Alibaba Cloud user.

> **NOTE:** Available in v1.40.0+.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ots"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tablesDs, err := ots.GetTables(ctx, &ots.GetTablesArgs{
			InstanceName: "sample-instance",
			NameRegex:    pulumi.StringRef("sample-table"),
			OutputFile:   pulumi.StringRef("tables.txt"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("firstTableId", tablesDs.Tables[0].Id)
		return nil
	})
}

```

type GetTablesResultOutput added in v3.9.0

type GetTablesResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getTables.

func GetTablesOutput added in v3.9.0

func GetTablesOutput(ctx *pulumi.Context, args GetTablesOutputArgs, opts ...pulumi.InvokeOption) GetTablesResultOutput

func (GetTablesResultOutput) ElementType added in v3.9.0

func (GetTablesResultOutput) ElementType() reflect.Type

func (GetTablesResultOutput) Id added in v3.9.0

The provider-assigned unique ID for this managed resource.

func (GetTablesResultOutput) Ids added in v3.9.0

A list of table IDs.

func (GetTablesResultOutput) InstanceName added in v3.9.0

func (o GetTablesResultOutput) InstanceName() pulumi.StringOutput

The OTS instance name.

func (GetTablesResultOutput) NameRegex added in v3.9.0

func (GetTablesResultOutput) Names added in v3.9.0

A list of table names.

func (GetTablesResultOutput) OutputFile added in v3.9.0

func (GetTablesResultOutput) Tables added in v3.9.0

A list of tables. Each element contains the following attributes:

func (GetTablesResultOutput) ToGetTablesResultOutput added in v3.9.0

func (o GetTablesResultOutput) ToGetTablesResultOutput() GetTablesResultOutput

func (GetTablesResultOutput) ToGetTablesResultOutputWithContext added in v3.9.0

func (o GetTablesResultOutput) ToGetTablesResultOutputWithContext(ctx context.Context) GetTablesResultOutput

func (GetTablesResultOutput) ToOutput added in v3.43.1

type GetTablesTable

type GetTablesTable struct {
	DefinedColumns []GetTablesTableDefinedColumn `pulumi:"definedColumns"`
	// ID of the table. The value is `<instance_name>:<table_name>`.
	Id string `pulumi:"id"`
	// The name of OTS instance.
	InstanceName string `pulumi:"instanceName"`
	// The maximum number of versions stored in this table.
	MaxVersion int `pulumi:"maxVersion"`
	// The property of `TableMeta` which indicates the structure information of a table.
	PrimaryKeys []GetTablesTablePrimaryKey `pulumi:"primaryKeys"`
	// The table name of the OTS which could not be changed.
	TableName string `pulumi:"tableName"`
	// The retention time of data stored in this table.
	TimeToLive int `pulumi:"timeToLive"`
}

type GetTablesTableArgs

type GetTablesTableArgs struct {
	DefinedColumns GetTablesTableDefinedColumnArrayInput `pulumi:"definedColumns"`
	// ID of the table. The value is `<instance_name>:<table_name>`.
	Id pulumi.StringInput `pulumi:"id"`
	// The name of OTS instance.
	InstanceName pulumi.StringInput `pulumi:"instanceName"`
	// The maximum number of versions stored in this table.
	MaxVersion pulumi.IntInput `pulumi:"maxVersion"`
	// The property of `TableMeta` which indicates the structure information of a table.
	PrimaryKeys GetTablesTablePrimaryKeyArrayInput `pulumi:"primaryKeys"`
	// The table name of the OTS which could not be changed.
	TableName pulumi.StringInput `pulumi:"tableName"`
	// The retention time of data stored in this table.
	TimeToLive pulumi.IntInput `pulumi:"timeToLive"`
}

func (GetTablesTableArgs) ElementType

func (GetTablesTableArgs) ElementType() reflect.Type

func (GetTablesTableArgs) ToGetTablesTableOutput

func (i GetTablesTableArgs) ToGetTablesTableOutput() GetTablesTableOutput

func (GetTablesTableArgs) ToGetTablesTableOutputWithContext

func (i GetTablesTableArgs) ToGetTablesTableOutputWithContext(ctx context.Context) GetTablesTableOutput

func (GetTablesTableArgs) ToOutput added in v3.43.1

type GetTablesTableArray

type GetTablesTableArray []GetTablesTableInput

func (GetTablesTableArray) ElementType

func (GetTablesTableArray) ElementType() reflect.Type

func (GetTablesTableArray) ToGetTablesTableArrayOutput

func (i GetTablesTableArray) ToGetTablesTableArrayOutput() GetTablesTableArrayOutput

func (GetTablesTableArray) ToGetTablesTableArrayOutputWithContext

func (i GetTablesTableArray) ToGetTablesTableArrayOutputWithContext(ctx context.Context) GetTablesTableArrayOutput

func (GetTablesTableArray) ToOutput added in v3.43.1

type GetTablesTableArrayInput

type GetTablesTableArrayInput interface {
	pulumi.Input

	ToGetTablesTableArrayOutput() GetTablesTableArrayOutput
	ToGetTablesTableArrayOutputWithContext(context.Context) GetTablesTableArrayOutput
}

GetTablesTableArrayInput is an input type that accepts GetTablesTableArray and GetTablesTableArrayOutput values. You can construct a concrete instance of `GetTablesTableArrayInput` via:

GetTablesTableArray{ GetTablesTableArgs{...} }

type GetTablesTableArrayOutput

type GetTablesTableArrayOutput struct{ *pulumi.OutputState }

func (GetTablesTableArrayOutput) ElementType

func (GetTablesTableArrayOutput) ElementType() reflect.Type

func (GetTablesTableArrayOutput) Index

func (GetTablesTableArrayOutput) ToGetTablesTableArrayOutput

func (o GetTablesTableArrayOutput) ToGetTablesTableArrayOutput() GetTablesTableArrayOutput

func (GetTablesTableArrayOutput) ToGetTablesTableArrayOutputWithContext

func (o GetTablesTableArrayOutput) ToGetTablesTableArrayOutputWithContext(ctx context.Context) GetTablesTableArrayOutput

func (GetTablesTableArrayOutput) ToOutput added in v3.43.1

type GetTablesTableDefinedColumn added in v3.29.0

type GetTablesTableDefinedColumn struct {
	Name string `pulumi:"name"`
	Type string `pulumi:"type"`
}

type GetTablesTableDefinedColumnArgs added in v3.29.0

type GetTablesTableDefinedColumnArgs struct {
	Name pulumi.StringInput `pulumi:"name"`
	Type pulumi.StringInput `pulumi:"type"`
}

func (GetTablesTableDefinedColumnArgs) ElementType added in v3.29.0

func (GetTablesTableDefinedColumnArgs) ToGetTablesTableDefinedColumnOutput added in v3.29.0

func (i GetTablesTableDefinedColumnArgs) ToGetTablesTableDefinedColumnOutput() GetTablesTableDefinedColumnOutput

func (GetTablesTableDefinedColumnArgs) ToGetTablesTableDefinedColumnOutputWithContext added in v3.29.0

func (i GetTablesTableDefinedColumnArgs) ToGetTablesTableDefinedColumnOutputWithContext(ctx context.Context) GetTablesTableDefinedColumnOutput

func (GetTablesTableDefinedColumnArgs) ToOutput added in v3.43.1

type GetTablesTableDefinedColumnArray added in v3.29.0

type GetTablesTableDefinedColumnArray []GetTablesTableDefinedColumnInput

func (GetTablesTableDefinedColumnArray) ElementType added in v3.29.0

func (GetTablesTableDefinedColumnArray) ToGetTablesTableDefinedColumnArrayOutput added in v3.29.0

func (i GetTablesTableDefinedColumnArray) ToGetTablesTableDefinedColumnArrayOutput() GetTablesTableDefinedColumnArrayOutput

func (GetTablesTableDefinedColumnArray) ToGetTablesTableDefinedColumnArrayOutputWithContext added in v3.29.0

func (i GetTablesTableDefinedColumnArray) ToGetTablesTableDefinedColumnArrayOutputWithContext(ctx context.Context) GetTablesTableDefinedColumnArrayOutput

func (GetTablesTableDefinedColumnArray) ToOutput added in v3.43.1

type GetTablesTableDefinedColumnArrayInput added in v3.29.0

type GetTablesTableDefinedColumnArrayInput interface {
	pulumi.Input

	ToGetTablesTableDefinedColumnArrayOutput() GetTablesTableDefinedColumnArrayOutput
	ToGetTablesTableDefinedColumnArrayOutputWithContext(context.Context) GetTablesTableDefinedColumnArrayOutput
}

GetTablesTableDefinedColumnArrayInput is an input type that accepts GetTablesTableDefinedColumnArray and GetTablesTableDefinedColumnArrayOutput values. You can construct a concrete instance of `GetTablesTableDefinedColumnArrayInput` via:

GetTablesTableDefinedColumnArray{ GetTablesTableDefinedColumnArgs{...} }

type GetTablesTableDefinedColumnArrayOutput added in v3.29.0

type GetTablesTableDefinedColumnArrayOutput struct{ *pulumi.OutputState }

func (GetTablesTableDefinedColumnArrayOutput) ElementType added in v3.29.0

func (GetTablesTableDefinedColumnArrayOutput) Index added in v3.29.0

func (GetTablesTableDefinedColumnArrayOutput) ToGetTablesTableDefinedColumnArrayOutput added in v3.29.0

func (o GetTablesTableDefinedColumnArrayOutput) ToGetTablesTableDefinedColumnArrayOutput() GetTablesTableDefinedColumnArrayOutput

func (GetTablesTableDefinedColumnArrayOutput) ToGetTablesTableDefinedColumnArrayOutputWithContext added in v3.29.0

func (o GetTablesTableDefinedColumnArrayOutput) ToGetTablesTableDefinedColumnArrayOutputWithContext(ctx context.Context) GetTablesTableDefinedColumnArrayOutput

func (GetTablesTableDefinedColumnArrayOutput) ToOutput added in v3.43.1

type GetTablesTableDefinedColumnInput added in v3.29.0

type GetTablesTableDefinedColumnInput interface {
	pulumi.Input

	ToGetTablesTableDefinedColumnOutput() GetTablesTableDefinedColumnOutput
	ToGetTablesTableDefinedColumnOutputWithContext(context.Context) GetTablesTableDefinedColumnOutput
}

GetTablesTableDefinedColumnInput is an input type that accepts GetTablesTableDefinedColumnArgs and GetTablesTableDefinedColumnOutput values. You can construct a concrete instance of `GetTablesTableDefinedColumnInput` via:

GetTablesTableDefinedColumnArgs{...}

type GetTablesTableDefinedColumnOutput added in v3.29.0

type GetTablesTableDefinedColumnOutput struct{ *pulumi.OutputState }

func (GetTablesTableDefinedColumnOutput) ElementType added in v3.29.0

func (GetTablesTableDefinedColumnOutput) Name added in v3.29.0

func (GetTablesTableDefinedColumnOutput) ToGetTablesTableDefinedColumnOutput added in v3.29.0

func (o GetTablesTableDefinedColumnOutput) ToGetTablesTableDefinedColumnOutput() GetTablesTableDefinedColumnOutput

func (GetTablesTableDefinedColumnOutput) ToGetTablesTableDefinedColumnOutputWithContext added in v3.29.0

func (o GetTablesTableDefinedColumnOutput) ToGetTablesTableDefinedColumnOutputWithContext(ctx context.Context) GetTablesTableDefinedColumnOutput

func (GetTablesTableDefinedColumnOutput) ToOutput added in v3.43.1

func (GetTablesTableDefinedColumnOutput) Type added in v3.29.0

type GetTablesTableInput

type GetTablesTableInput interface {
	pulumi.Input

	ToGetTablesTableOutput() GetTablesTableOutput
	ToGetTablesTableOutputWithContext(context.Context) GetTablesTableOutput
}

GetTablesTableInput is an input type that accepts GetTablesTableArgs and GetTablesTableOutput values. You can construct a concrete instance of `GetTablesTableInput` via:

GetTablesTableArgs{...}

type GetTablesTableOutput

type GetTablesTableOutput struct{ *pulumi.OutputState }

func (GetTablesTableOutput) DefinedColumns added in v3.29.0

func (GetTablesTableOutput) ElementType

func (GetTablesTableOutput) ElementType() reflect.Type

func (GetTablesTableOutput) Id

ID of the table. The value is `<instance_name>:<table_name>`.

func (GetTablesTableOutput) InstanceName

func (o GetTablesTableOutput) InstanceName() pulumi.StringOutput

The name of OTS instance.

func (GetTablesTableOutput) MaxVersion

func (o GetTablesTableOutput) MaxVersion() pulumi.IntOutput

The maximum number of versions stored in this table.

func (GetTablesTableOutput) PrimaryKeys

The property of `TableMeta` which indicates the structure information of a table.

func (GetTablesTableOutput) TableName

The table name of the OTS which could not be changed.

func (GetTablesTableOutput) TimeToLive

func (o GetTablesTableOutput) TimeToLive() pulumi.IntOutput

The retention time of data stored in this table.

func (GetTablesTableOutput) ToGetTablesTableOutput

func (o GetTablesTableOutput) ToGetTablesTableOutput() GetTablesTableOutput

func (GetTablesTableOutput) ToGetTablesTableOutputWithContext

func (o GetTablesTableOutput) ToGetTablesTableOutputWithContext(ctx context.Context) GetTablesTableOutput

func (GetTablesTableOutput) ToOutput added in v3.43.1

type GetTablesTablePrimaryKey

type GetTablesTablePrimaryKey struct {
	Name string `pulumi:"name"`
	Type string `pulumi:"type"`
}

type GetTablesTablePrimaryKeyArgs

type GetTablesTablePrimaryKeyArgs struct {
	Name pulumi.StringInput `pulumi:"name"`
	Type pulumi.StringInput `pulumi:"type"`
}

func (GetTablesTablePrimaryKeyArgs) ElementType

func (GetTablesTablePrimaryKeyArgs) ToGetTablesTablePrimaryKeyOutput

func (i GetTablesTablePrimaryKeyArgs) ToGetTablesTablePrimaryKeyOutput() GetTablesTablePrimaryKeyOutput

func (GetTablesTablePrimaryKeyArgs) ToGetTablesTablePrimaryKeyOutputWithContext

func (i GetTablesTablePrimaryKeyArgs) ToGetTablesTablePrimaryKeyOutputWithContext(ctx context.Context) GetTablesTablePrimaryKeyOutput

func (GetTablesTablePrimaryKeyArgs) ToOutput added in v3.43.1

type GetTablesTablePrimaryKeyArray

type GetTablesTablePrimaryKeyArray []GetTablesTablePrimaryKeyInput

func (GetTablesTablePrimaryKeyArray) ElementType

func (GetTablesTablePrimaryKeyArray) ToGetTablesTablePrimaryKeyArrayOutput

func (i GetTablesTablePrimaryKeyArray) ToGetTablesTablePrimaryKeyArrayOutput() GetTablesTablePrimaryKeyArrayOutput

func (GetTablesTablePrimaryKeyArray) ToGetTablesTablePrimaryKeyArrayOutputWithContext

func (i GetTablesTablePrimaryKeyArray) ToGetTablesTablePrimaryKeyArrayOutputWithContext(ctx context.Context) GetTablesTablePrimaryKeyArrayOutput

func (GetTablesTablePrimaryKeyArray) ToOutput added in v3.43.1

type GetTablesTablePrimaryKeyArrayInput

type GetTablesTablePrimaryKeyArrayInput interface {
	pulumi.Input

	ToGetTablesTablePrimaryKeyArrayOutput() GetTablesTablePrimaryKeyArrayOutput
	ToGetTablesTablePrimaryKeyArrayOutputWithContext(context.Context) GetTablesTablePrimaryKeyArrayOutput
}

GetTablesTablePrimaryKeyArrayInput is an input type that accepts GetTablesTablePrimaryKeyArray and GetTablesTablePrimaryKeyArrayOutput values. You can construct a concrete instance of `GetTablesTablePrimaryKeyArrayInput` via:

GetTablesTablePrimaryKeyArray{ GetTablesTablePrimaryKeyArgs{...} }

type GetTablesTablePrimaryKeyArrayOutput

type GetTablesTablePrimaryKeyArrayOutput struct{ *pulumi.OutputState }

func (GetTablesTablePrimaryKeyArrayOutput) ElementType

func (GetTablesTablePrimaryKeyArrayOutput) Index

func (GetTablesTablePrimaryKeyArrayOutput) ToGetTablesTablePrimaryKeyArrayOutput

func (o GetTablesTablePrimaryKeyArrayOutput) ToGetTablesTablePrimaryKeyArrayOutput() GetTablesTablePrimaryKeyArrayOutput

func (GetTablesTablePrimaryKeyArrayOutput) ToGetTablesTablePrimaryKeyArrayOutputWithContext

func (o GetTablesTablePrimaryKeyArrayOutput) ToGetTablesTablePrimaryKeyArrayOutputWithContext(ctx context.Context) GetTablesTablePrimaryKeyArrayOutput

func (GetTablesTablePrimaryKeyArrayOutput) ToOutput added in v3.43.1

type GetTablesTablePrimaryKeyInput

type GetTablesTablePrimaryKeyInput interface {
	pulumi.Input

	ToGetTablesTablePrimaryKeyOutput() GetTablesTablePrimaryKeyOutput
	ToGetTablesTablePrimaryKeyOutputWithContext(context.Context) GetTablesTablePrimaryKeyOutput
}

GetTablesTablePrimaryKeyInput is an input type that accepts GetTablesTablePrimaryKeyArgs and GetTablesTablePrimaryKeyOutput values. You can construct a concrete instance of `GetTablesTablePrimaryKeyInput` via:

GetTablesTablePrimaryKeyArgs{...}

type GetTablesTablePrimaryKeyOutput

type GetTablesTablePrimaryKeyOutput struct{ *pulumi.OutputState }

func (GetTablesTablePrimaryKeyOutput) ElementType

func (GetTablesTablePrimaryKeyOutput) Name

func (GetTablesTablePrimaryKeyOutput) ToGetTablesTablePrimaryKeyOutput

func (o GetTablesTablePrimaryKeyOutput) ToGetTablesTablePrimaryKeyOutput() GetTablesTablePrimaryKeyOutput

func (GetTablesTablePrimaryKeyOutput) ToGetTablesTablePrimaryKeyOutputWithContext

func (o GetTablesTablePrimaryKeyOutput) ToGetTablesTablePrimaryKeyOutputWithContext(ctx context.Context) GetTablesTablePrimaryKeyOutput

func (GetTablesTablePrimaryKeyOutput) ToOutput added in v3.43.1

func (GetTablesTablePrimaryKeyOutput) Type

type GetTunnelsArgs added in v3.22.0

type GetTunnelsArgs struct {
	// A list of tunnel IDs.
	Ids []string `pulumi:"ids"`
	// The name of OTS instance.
	InstanceName string `pulumi:"instanceName"`
	// A regex string to filter results by tunnel name.
	NameRegex *string `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile *string `pulumi:"outputFile"`
	// The name of OTS table.
	TableName string `pulumi:"tableName"`
}

A collection of arguments for invoking getTunnels.

type GetTunnelsOutputArgs added in v3.22.0

type GetTunnelsOutputArgs struct {
	// A list of tunnel IDs.
	Ids pulumi.StringArrayInput `pulumi:"ids"`
	// The name of OTS instance.
	InstanceName pulumi.StringInput `pulumi:"instanceName"`
	// A regex string to filter results by tunnel name.
	NameRegex pulumi.StringPtrInput `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile pulumi.StringPtrInput `pulumi:"outputFile"`
	// The name of OTS table.
	TableName pulumi.StringInput `pulumi:"tableName"`
}

A collection of arguments for invoking getTunnels.

func (GetTunnelsOutputArgs) ElementType added in v3.22.0

func (GetTunnelsOutputArgs) ElementType() reflect.Type

type GetTunnelsResult added in v3.22.0

type GetTunnelsResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// A list of tunnel IDs.
	Ids []string `pulumi:"ids"`
	// The OTS instance name.
	InstanceName string  `pulumi:"instanceName"`
	NameRegex    *string `pulumi:"nameRegex"`
	// A list of tunnel names.
	Names      []string `pulumi:"names"`
	OutputFile *string  `pulumi:"outputFile"`
	// The table name of the OTS which could not be changed.
	TableName string `pulumi:"tableName"`
	// A list of tunnels. Each element contains the following attributes:
	Tunnels []GetTunnelsTunnel `pulumi:"tunnels"`
}

A collection of values returned by getTunnels.

func GetTunnels added in v3.22.0

func GetTunnels(ctx *pulumi.Context, args *GetTunnelsArgs, opts ...pulumi.InvokeOption) (*GetTunnelsResult, error)

This data source provides the ots tunnels of the current Alibaba Cloud user.

For information about OTS tunnel and how to use it, see [Tunnel overview](https://www.alibabacloud.com/help/en/tablestore/latest/tunnel-service-overview).

> **NOTE:** Available in v1.172.0+.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ots"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tunnelsDs, err := ots.GetTunnels(ctx, &ots.GetTunnelsArgs{
			InstanceName: "sample-instance",
			NameRegex:    pulumi.StringRef("sample-tunnel"),
			OutputFile:   pulumi.StringRef("tunnels.txt"),
			TableName:    "sample-table",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("firstTunnelId", tunnelsDs.Tunnels[0].Id)
		return nil
	})
}

```

type GetTunnelsResultOutput added in v3.22.0

type GetTunnelsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getTunnels.

func GetTunnelsOutput added in v3.22.0

func GetTunnelsOutput(ctx *pulumi.Context, args GetTunnelsOutputArgs, opts ...pulumi.InvokeOption) GetTunnelsResultOutput

func (GetTunnelsResultOutput) ElementType added in v3.22.0

func (GetTunnelsResultOutput) ElementType() reflect.Type

func (GetTunnelsResultOutput) Id added in v3.22.0

The provider-assigned unique ID for this managed resource.

func (GetTunnelsResultOutput) Ids added in v3.22.0

A list of tunnel IDs.

func (GetTunnelsResultOutput) InstanceName added in v3.22.0

func (o GetTunnelsResultOutput) InstanceName() pulumi.StringOutput

The OTS instance name.

func (GetTunnelsResultOutput) NameRegex added in v3.22.0

func (GetTunnelsResultOutput) Names added in v3.22.0

A list of tunnel names.

func (GetTunnelsResultOutput) OutputFile added in v3.22.0

func (GetTunnelsResultOutput) TableName added in v3.22.0

The table name of the OTS which could not be changed.

func (GetTunnelsResultOutput) ToGetTunnelsResultOutput added in v3.22.0

func (o GetTunnelsResultOutput) ToGetTunnelsResultOutput() GetTunnelsResultOutput

func (GetTunnelsResultOutput) ToGetTunnelsResultOutputWithContext added in v3.22.0

func (o GetTunnelsResultOutput) ToGetTunnelsResultOutputWithContext(ctx context.Context) GetTunnelsResultOutput

func (GetTunnelsResultOutput) ToOutput added in v3.43.1

func (GetTunnelsResultOutput) Tunnels added in v3.22.0

A list of tunnels. Each element contains the following attributes:

type GetTunnelsTunnel added in v3.22.0

type GetTunnelsTunnel struct {
	// The channels of OTS tunnel. Each element contains the following attributes:
	Channels []GetTunnelsTunnelChannel `pulumi:"channels"`
	// The creation time of the Tunnel.
	CreateTime int `pulumi:"createTime"`
	// Whether the tunnel has expired.
	Expired bool `pulumi:"expired"`
	// The resource ID. The value is `<instance_name>:<table_name>:<tunnel_name>`.
	Id string `pulumi:"id"`
	// The name of OTS instance.
	InstanceName string `pulumi:"instanceName"`
	// The name of OTS table.
	TableName string `pulumi:"tableName"`
	// The tunnel id of the OTS which could not be changed.
	TunnelId string `pulumi:"tunnelId"`
	// The tunnel name of the OTS which could not be changed.
	TunnelName string `pulumi:"tunnelName"`
	// The latest consumption time of the tunnel, unix time in nanosecond.
	TunnelRpo int `pulumi:"tunnelRpo"`
	// The stage of OTS tunnel, valid values: `InitBaseDataAndStreamShard`, `ProcessBaseData`, `ProcessStream`.
	TunnelStage string `pulumi:"tunnelStage"`
	// The type of the OTS tunnel, valid values: `BaseAndStream`, `BaseData`, `Stream`.
	TunnelType string `pulumi:"tunnelType"`
}

type GetTunnelsTunnelArgs added in v3.22.0

type GetTunnelsTunnelArgs struct {
	// The channels of OTS tunnel. Each element contains the following attributes:
	Channels GetTunnelsTunnelChannelArrayInput `pulumi:"channels"`
	// The creation time of the Tunnel.
	CreateTime pulumi.IntInput `pulumi:"createTime"`
	// Whether the tunnel has expired.
	Expired pulumi.BoolInput `pulumi:"expired"`
	// The resource ID. The value is `<instance_name>:<table_name>:<tunnel_name>`.
	Id pulumi.StringInput `pulumi:"id"`
	// The name of OTS instance.
	InstanceName pulumi.StringInput `pulumi:"instanceName"`
	// The name of OTS table.
	TableName pulumi.StringInput `pulumi:"tableName"`
	// The tunnel id of the OTS which could not be changed.
	TunnelId pulumi.StringInput `pulumi:"tunnelId"`
	// The tunnel name of the OTS which could not be changed.
	TunnelName pulumi.StringInput `pulumi:"tunnelName"`
	// The latest consumption time of the tunnel, unix time in nanosecond.
	TunnelRpo pulumi.IntInput `pulumi:"tunnelRpo"`
	// The stage of OTS tunnel, valid values: `InitBaseDataAndStreamShard`, `ProcessBaseData`, `ProcessStream`.
	TunnelStage pulumi.StringInput `pulumi:"tunnelStage"`
	// The type of the OTS tunnel, valid values: `BaseAndStream`, `BaseData`, `Stream`.
	TunnelType pulumi.StringInput `pulumi:"tunnelType"`
}

func (GetTunnelsTunnelArgs) ElementType added in v3.22.0

func (GetTunnelsTunnelArgs) ElementType() reflect.Type

func (GetTunnelsTunnelArgs) ToGetTunnelsTunnelOutput added in v3.22.0

func (i GetTunnelsTunnelArgs) ToGetTunnelsTunnelOutput() GetTunnelsTunnelOutput

func (GetTunnelsTunnelArgs) ToGetTunnelsTunnelOutputWithContext added in v3.22.0

func (i GetTunnelsTunnelArgs) ToGetTunnelsTunnelOutputWithContext(ctx context.Context) GetTunnelsTunnelOutput

func (GetTunnelsTunnelArgs) ToOutput added in v3.43.1

type GetTunnelsTunnelArray added in v3.22.0

type GetTunnelsTunnelArray []GetTunnelsTunnelInput

func (GetTunnelsTunnelArray) ElementType added in v3.22.0

func (GetTunnelsTunnelArray) ElementType() reflect.Type

func (GetTunnelsTunnelArray) ToGetTunnelsTunnelArrayOutput added in v3.22.0

func (i GetTunnelsTunnelArray) ToGetTunnelsTunnelArrayOutput() GetTunnelsTunnelArrayOutput

func (GetTunnelsTunnelArray) ToGetTunnelsTunnelArrayOutputWithContext added in v3.22.0

func (i GetTunnelsTunnelArray) ToGetTunnelsTunnelArrayOutputWithContext(ctx context.Context) GetTunnelsTunnelArrayOutput

func (GetTunnelsTunnelArray) ToOutput added in v3.43.1

type GetTunnelsTunnelArrayInput added in v3.22.0

type GetTunnelsTunnelArrayInput interface {
	pulumi.Input

	ToGetTunnelsTunnelArrayOutput() GetTunnelsTunnelArrayOutput
	ToGetTunnelsTunnelArrayOutputWithContext(context.Context) GetTunnelsTunnelArrayOutput
}

GetTunnelsTunnelArrayInput is an input type that accepts GetTunnelsTunnelArray and GetTunnelsTunnelArrayOutput values. You can construct a concrete instance of `GetTunnelsTunnelArrayInput` via:

GetTunnelsTunnelArray{ GetTunnelsTunnelArgs{...} }

type GetTunnelsTunnelArrayOutput added in v3.22.0

type GetTunnelsTunnelArrayOutput struct{ *pulumi.OutputState }

func (GetTunnelsTunnelArrayOutput) ElementType added in v3.22.0

func (GetTunnelsTunnelArrayOutput) Index added in v3.22.0

func (GetTunnelsTunnelArrayOutput) ToGetTunnelsTunnelArrayOutput added in v3.22.0

func (o GetTunnelsTunnelArrayOutput) ToGetTunnelsTunnelArrayOutput() GetTunnelsTunnelArrayOutput

func (GetTunnelsTunnelArrayOutput) ToGetTunnelsTunnelArrayOutputWithContext added in v3.22.0

func (o GetTunnelsTunnelArrayOutput) ToGetTunnelsTunnelArrayOutputWithContext(ctx context.Context) GetTunnelsTunnelArrayOutput

func (GetTunnelsTunnelArrayOutput) ToOutput added in v3.43.1

type GetTunnelsTunnelChannel added in v3.22.0

type GetTunnelsTunnelChannel struct {
	// The id of the channel.
	ChannelId string `pulumi:"channelId"`
	// The latest consumption time of the channel, unix time in nanosecond
	ChannelRpo int `pulumi:"channelRpo"`
	// The status of the channel, valid values: `WAIT`, `OPEN`, `CLOSING`, `CLOSE`, `TERMINATED`.
	ChannelStatus string `pulumi:"channelStatus"`
	// The type of the channel, valid values: `BaseData`, `Stream`.
	ChannelType string `pulumi:"channelType"`
	// The client id of the channel.
	ClientId string `pulumi:"clientId"`
}

type GetTunnelsTunnelChannelArgs added in v3.22.0

type GetTunnelsTunnelChannelArgs struct {
	// The id of the channel.
	ChannelId pulumi.StringInput `pulumi:"channelId"`
	// The latest consumption time of the channel, unix time in nanosecond
	ChannelRpo pulumi.IntInput `pulumi:"channelRpo"`
	// The status of the channel, valid values: `WAIT`, `OPEN`, `CLOSING`, `CLOSE`, `TERMINATED`.
	ChannelStatus pulumi.StringInput `pulumi:"channelStatus"`
	// The type of the channel, valid values: `BaseData`, `Stream`.
	ChannelType pulumi.StringInput `pulumi:"channelType"`
	// The client id of the channel.
	ClientId pulumi.StringInput `pulumi:"clientId"`
}

func (GetTunnelsTunnelChannelArgs) ElementType added in v3.22.0

func (GetTunnelsTunnelChannelArgs) ToGetTunnelsTunnelChannelOutput added in v3.22.0

func (i GetTunnelsTunnelChannelArgs) ToGetTunnelsTunnelChannelOutput() GetTunnelsTunnelChannelOutput

func (GetTunnelsTunnelChannelArgs) ToGetTunnelsTunnelChannelOutputWithContext added in v3.22.0

func (i GetTunnelsTunnelChannelArgs) ToGetTunnelsTunnelChannelOutputWithContext(ctx context.Context) GetTunnelsTunnelChannelOutput

func (GetTunnelsTunnelChannelArgs) ToOutput added in v3.43.1

type GetTunnelsTunnelChannelArray added in v3.22.0

type GetTunnelsTunnelChannelArray []GetTunnelsTunnelChannelInput

func (GetTunnelsTunnelChannelArray) ElementType added in v3.22.0

func (GetTunnelsTunnelChannelArray) ToGetTunnelsTunnelChannelArrayOutput added in v3.22.0

func (i GetTunnelsTunnelChannelArray) ToGetTunnelsTunnelChannelArrayOutput() GetTunnelsTunnelChannelArrayOutput

func (GetTunnelsTunnelChannelArray) ToGetTunnelsTunnelChannelArrayOutputWithContext added in v3.22.0

func (i GetTunnelsTunnelChannelArray) ToGetTunnelsTunnelChannelArrayOutputWithContext(ctx context.Context) GetTunnelsTunnelChannelArrayOutput

func (GetTunnelsTunnelChannelArray) ToOutput added in v3.43.1

type GetTunnelsTunnelChannelArrayInput added in v3.22.0

type GetTunnelsTunnelChannelArrayInput interface {
	pulumi.Input

	ToGetTunnelsTunnelChannelArrayOutput() GetTunnelsTunnelChannelArrayOutput
	ToGetTunnelsTunnelChannelArrayOutputWithContext(context.Context) GetTunnelsTunnelChannelArrayOutput
}

GetTunnelsTunnelChannelArrayInput is an input type that accepts GetTunnelsTunnelChannelArray and GetTunnelsTunnelChannelArrayOutput values. You can construct a concrete instance of `GetTunnelsTunnelChannelArrayInput` via:

GetTunnelsTunnelChannelArray{ GetTunnelsTunnelChannelArgs{...} }

type GetTunnelsTunnelChannelArrayOutput added in v3.22.0

type GetTunnelsTunnelChannelArrayOutput struct{ *pulumi.OutputState }

func (GetTunnelsTunnelChannelArrayOutput) ElementType added in v3.22.0

func (GetTunnelsTunnelChannelArrayOutput) Index added in v3.22.0

func (GetTunnelsTunnelChannelArrayOutput) ToGetTunnelsTunnelChannelArrayOutput added in v3.22.0

func (o GetTunnelsTunnelChannelArrayOutput) ToGetTunnelsTunnelChannelArrayOutput() GetTunnelsTunnelChannelArrayOutput

func (GetTunnelsTunnelChannelArrayOutput) ToGetTunnelsTunnelChannelArrayOutputWithContext added in v3.22.0

func (o GetTunnelsTunnelChannelArrayOutput) ToGetTunnelsTunnelChannelArrayOutputWithContext(ctx context.Context) GetTunnelsTunnelChannelArrayOutput

func (GetTunnelsTunnelChannelArrayOutput) ToOutput added in v3.43.1

type GetTunnelsTunnelChannelInput added in v3.22.0

type GetTunnelsTunnelChannelInput interface {
	pulumi.Input

	ToGetTunnelsTunnelChannelOutput() GetTunnelsTunnelChannelOutput
	ToGetTunnelsTunnelChannelOutputWithContext(context.Context) GetTunnelsTunnelChannelOutput
}

GetTunnelsTunnelChannelInput is an input type that accepts GetTunnelsTunnelChannelArgs and GetTunnelsTunnelChannelOutput values. You can construct a concrete instance of `GetTunnelsTunnelChannelInput` via:

GetTunnelsTunnelChannelArgs{...}

type GetTunnelsTunnelChannelOutput added in v3.22.0

type GetTunnelsTunnelChannelOutput struct{ *pulumi.OutputState }

func (GetTunnelsTunnelChannelOutput) ChannelId added in v3.22.0

The id of the channel.

func (GetTunnelsTunnelChannelOutput) ChannelRpo added in v3.22.0

The latest consumption time of the channel, unix time in nanosecond

func (GetTunnelsTunnelChannelOutput) ChannelStatus added in v3.22.0

The status of the channel, valid values: `WAIT`, `OPEN`, `CLOSING`, `CLOSE`, `TERMINATED`.

func (GetTunnelsTunnelChannelOutput) ChannelType added in v3.22.0

The type of the channel, valid values: `BaseData`, `Stream`.

func (GetTunnelsTunnelChannelOutput) ClientId added in v3.22.0

The client id of the channel.

func (GetTunnelsTunnelChannelOutput) ElementType added in v3.22.0

func (GetTunnelsTunnelChannelOutput) ToGetTunnelsTunnelChannelOutput added in v3.22.0

func (o GetTunnelsTunnelChannelOutput) ToGetTunnelsTunnelChannelOutput() GetTunnelsTunnelChannelOutput

func (GetTunnelsTunnelChannelOutput) ToGetTunnelsTunnelChannelOutputWithContext added in v3.22.0

func (o GetTunnelsTunnelChannelOutput) ToGetTunnelsTunnelChannelOutputWithContext(ctx context.Context) GetTunnelsTunnelChannelOutput

func (GetTunnelsTunnelChannelOutput) ToOutput added in v3.43.1

type GetTunnelsTunnelInput added in v3.22.0

type GetTunnelsTunnelInput interface {
	pulumi.Input

	ToGetTunnelsTunnelOutput() GetTunnelsTunnelOutput
	ToGetTunnelsTunnelOutputWithContext(context.Context) GetTunnelsTunnelOutput
}

GetTunnelsTunnelInput is an input type that accepts GetTunnelsTunnelArgs and GetTunnelsTunnelOutput values. You can construct a concrete instance of `GetTunnelsTunnelInput` via:

GetTunnelsTunnelArgs{...}

type GetTunnelsTunnelOutput added in v3.22.0

type GetTunnelsTunnelOutput struct{ *pulumi.OutputState }

func (GetTunnelsTunnelOutput) Channels added in v3.22.0

The channels of OTS tunnel. Each element contains the following attributes:

func (GetTunnelsTunnelOutput) CreateTime added in v3.22.0

func (o GetTunnelsTunnelOutput) CreateTime() pulumi.IntOutput

The creation time of the Tunnel.

func (GetTunnelsTunnelOutput) ElementType added in v3.22.0

func (GetTunnelsTunnelOutput) ElementType() reflect.Type

func (GetTunnelsTunnelOutput) Expired added in v3.22.0

Whether the tunnel has expired.

func (GetTunnelsTunnelOutput) Id added in v3.22.0

The resource ID. The value is `<instance_name>:<table_name>:<tunnel_name>`.

func (GetTunnelsTunnelOutput) InstanceName added in v3.22.0

func (o GetTunnelsTunnelOutput) InstanceName() pulumi.StringOutput

The name of OTS instance.

func (GetTunnelsTunnelOutput) TableName added in v3.22.0

The name of OTS table.

func (GetTunnelsTunnelOutput) ToGetTunnelsTunnelOutput added in v3.22.0

func (o GetTunnelsTunnelOutput) ToGetTunnelsTunnelOutput() GetTunnelsTunnelOutput

func (GetTunnelsTunnelOutput) ToGetTunnelsTunnelOutputWithContext added in v3.22.0

func (o GetTunnelsTunnelOutput) ToGetTunnelsTunnelOutputWithContext(ctx context.Context) GetTunnelsTunnelOutput

func (GetTunnelsTunnelOutput) ToOutput added in v3.43.1

func (GetTunnelsTunnelOutput) TunnelId added in v3.22.0

The tunnel id of the OTS which could not be changed.

func (GetTunnelsTunnelOutput) TunnelName added in v3.22.0

The tunnel name of the OTS which could not be changed.

func (GetTunnelsTunnelOutput) TunnelRpo added in v3.22.0

func (o GetTunnelsTunnelOutput) TunnelRpo() pulumi.IntOutput

The latest consumption time of the tunnel, unix time in nanosecond.

func (GetTunnelsTunnelOutput) TunnelStage added in v3.22.0

func (o GetTunnelsTunnelOutput) TunnelStage() pulumi.StringOutput

The stage of OTS tunnel, valid values: `InitBaseDataAndStreamShard`, `ProcessBaseData`, `ProcessStream`.

func (GetTunnelsTunnelOutput) TunnelType added in v3.22.0

The type of the OTS tunnel, valid values: `BaseAndStream`, `BaseData`, `Stream`.

type Instance

type Instance struct {
	pulumi.CustomResourceState

	// The network limitation of accessing instance. Valid values:
	AccessedBy pulumi.StringPtrOutput `pulumi:"accessedBy"`
	// The description of the instance. Currently, it does not support modifying.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The type of instance. Valid values are "Capacity" and "HighPerformance". Default to "HighPerformance".
	InstanceType pulumi.StringPtrOutput `pulumi:"instanceType"`
	// The name of the instance.
	Name pulumi.StringOutput `pulumi:"name"`
	// A mapping of tags to assign to the instance.
	Tags pulumi.MapOutput `pulumi:"tags"`
}

This resource will help you to manager a [Table Store](https://www.alibabacloud.com/help/doc-detail/27280.htm) Instance. It is foundation of creating data table.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ots"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ots.NewInstance(ctx, "foo", &ots.InstanceArgs{
			AccessedBy:  pulumi.String("Vpc"),
			Description: pulumi.String("for table"),
			Tags: pulumi.AnyMap{
				"Created": pulumi.Any("TF"),
				"For":     pulumi.Any("Building table"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

OTS instance can be imported using instance id or name, e.g.

```sh

$ pulumi import alicloud:ots/instance:Instance foo "my-ots-instance"

```

func GetInstance

func GetInstance(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *InstanceState, opts ...pulumi.ResourceOption) (*Instance, error)

GetInstance gets an existing Instance resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewInstance

func NewInstance(ctx *pulumi.Context,
	name string, args *InstanceArgs, opts ...pulumi.ResourceOption) (*Instance, error)

NewInstance registers a new resource with the given unique name, arguments, and options.

func (*Instance) ElementType

func (*Instance) ElementType() reflect.Type

func (*Instance) ToInstanceOutput

func (i *Instance) ToInstanceOutput() InstanceOutput

func (*Instance) ToInstanceOutputWithContext

func (i *Instance) ToInstanceOutputWithContext(ctx context.Context) InstanceOutput

func (*Instance) ToOutput added in v3.43.1

func (i *Instance) ToOutput(ctx context.Context) pulumix.Output[*Instance]

type InstanceArgs

type InstanceArgs struct {
	// The network limitation of accessing instance. Valid values:
	AccessedBy pulumi.StringPtrInput
	// The description of the instance. Currently, it does not support modifying.
	Description pulumi.StringPtrInput
	// The type of instance. Valid values are "Capacity" and "HighPerformance". Default to "HighPerformance".
	InstanceType pulumi.StringPtrInput
	// The name of the instance.
	Name pulumi.StringPtrInput
	// A mapping of tags to assign to the instance.
	Tags pulumi.MapInput
}

The set of arguments for constructing a Instance resource.

func (InstanceArgs) ElementType

func (InstanceArgs) ElementType() reflect.Type

type InstanceArray

type InstanceArray []InstanceInput

func (InstanceArray) ElementType

func (InstanceArray) ElementType() reflect.Type

func (InstanceArray) ToInstanceArrayOutput

func (i InstanceArray) ToInstanceArrayOutput() InstanceArrayOutput

func (InstanceArray) ToInstanceArrayOutputWithContext

func (i InstanceArray) ToInstanceArrayOutputWithContext(ctx context.Context) InstanceArrayOutput

func (InstanceArray) ToOutput added in v3.43.1

func (i InstanceArray) ToOutput(ctx context.Context) pulumix.Output[[]*Instance]

type InstanceArrayInput

type InstanceArrayInput interface {
	pulumi.Input

	ToInstanceArrayOutput() InstanceArrayOutput
	ToInstanceArrayOutputWithContext(context.Context) InstanceArrayOutput
}

InstanceArrayInput is an input type that accepts InstanceArray and InstanceArrayOutput values. You can construct a concrete instance of `InstanceArrayInput` via:

InstanceArray{ InstanceArgs{...} }

type InstanceArrayOutput

type InstanceArrayOutput struct{ *pulumi.OutputState }

func (InstanceArrayOutput) ElementType

func (InstanceArrayOutput) ElementType() reflect.Type

func (InstanceArrayOutput) Index

func (InstanceArrayOutput) ToInstanceArrayOutput

func (o InstanceArrayOutput) ToInstanceArrayOutput() InstanceArrayOutput

func (InstanceArrayOutput) ToInstanceArrayOutputWithContext

func (o InstanceArrayOutput) ToInstanceArrayOutputWithContext(ctx context.Context) InstanceArrayOutput

func (InstanceArrayOutput) ToOutput added in v3.43.1

type InstanceAttachment

type InstanceAttachment struct {
	pulumi.CustomResourceState

	// The name of the OTS instance.
	InstanceName pulumi.StringOutput `pulumi:"instanceName"`
	// The ID of attaching VPC to instance.
	VpcId pulumi.StringOutput `pulumi:"vpcId"`
	// The name of attaching VPC to instance.
	VpcName pulumi.StringOutput `pulumi:"vpcName"`
	// The ID of attaching VSwitch to instance.
	VswitchId pulumi.StringOutput `pulumi:"vswitchId"`
}

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

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ots"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooInstance, err := ots.NewInstance(ctx, "fooInstance", &ots.InstanceArgs{
			Description: pulumi.String("for table"),
			AccessedBy:  pulumi.String("Vpc"),
			Tags: pulumi.AnyMap{
				"Created": pulumi.Any("TF"),
				"For":     pulumi.Any("Building table"),
			},
		})
		if err != nil {
			return err
		}
		fooZones, err := alicloud.GetZones(ctx, &alicloud.GetZonesArgs{
			AvailableResourceCreation: pulumi.StringRef("VSwitch"),
		}, nil)
		if err != nil {
			return err
		}
		fooNetwork, err := vpc.NewNetwork(ctx, "fooNetwork", &vpc.NetworkArgs{
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		fooSwitch, err := vpc.NewSwitch(ctx, "fooSwitch", &vpc.SwitchArgs{
			VpcId:       fooNetwork.ID(),
			VswitchName: pulumi.String("for-ots-instance"),
			CidrBlock:   pulumi.String("172.16.1.0/24"),
			ZoneId:      *pulumi.String(fooZones.Zones[0].Id),
		})
		if err != nil {
			return err
		}
		_, err = ots.NewInstanceAttachment(ctx, "fooInstanceAttachment", &ots.InstanceAttachmentArgs{
			InstanceName: fooInstance.Name,
			VpcName:      pulumi.String("attachment1"),
			VswitchId:    fooSwitch.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetInstanceAttachment

func GetInstanceAttachment(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *InstanceAttachmentState, opts ...pulumi.ResourceOption) (*InstanceAttachment, error)

GetInstanceAttachment gets an existing InstanceAttachment resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewInstanceAttachment

func NewInstanceAttachment(ctx *pulumi.Context,
	name string, args *InstanceAttachmentArgs, opts ...pulumi.ResourceOption) (*InstanceAttachment, error)

NewInstanceAttachment registers a new resource with the given unique name, arguments, and options.

func (*InstanceAttachment) ElementType

func (*InstanceAttachment) ElementType() reflect.Type

func (*InstanceAttachment) ToInstanceAttachmentOutput

func (i *InstanceAttachment) ToInstanceAttachmentOutput() InstanceAttachmentOutput

func (*InstanceAttachment) ToInstanceAttachmentOutputWithContext

func (i *InstanceAttachment) ToInstanceAttachmentOutputWithContext(ctx context.Context) InstanceAttachmentOutput

func (*InstanceAttachment) ToOutput added in v3.43.1

type InstanceAttachmentArgs

type InstanceAttachmentArgs struct {
	// The name of the OTS instance.
	InstanceName pulumi.StringInput
	// The name of attaching VPC to instance.
	VpcName pulumi.StringInput
	// The ID of attaching VSwitch to instance.
	VswitchId pulumi.StringInput
}

The set of arguments for constructing a InstanceAttachment resource.

func (InstanceAttachmentArgs) ElementType

func (InstanceAttachmentArgs) ElementType() reflect.Type

type InstanceAttachmentArray

type InstanceAttachmentArray []InstanceAttachmentInput

func (InstanceAttachmentArray) ElementType

func (InstanceAttachmentArray) ElementType() reflect.Type

func (InstanceAttachmentArray) ToInstanceAttachmentArrayOutput

func (i InstanceAttachmentArray) ToInstanceAttachmentArrayOutput() InstanceAttachmentArrayOutput

func (InstanceAttachmentArray) ToInstanceAttachmentArrayOutputWithContext

func (i InstanceAttachmentArray) ToInstanceAttachmentArrayOutputWithContext(ctx context.Context) InstanceAttachmentArrayOutput

func (InstanceAttachmentArray) ToOutput added in v3.43.1

type InstanceAttachmentArrayInput

type InstanceAttachmentArrayInput interface {
	pulumi.Input

	ToInstanceAttachmentArrayOutput() InstanceAttachmentArrayOutput
	ToInstanceAttachmentArrayOutputWithContext(context.Context) InstanceAttachmentArrayOutput
}

InstanceAttachmentArrayInput is an input type that accepts InstanceAttachmentArray and InstanceAttachmentArrayOutput values. You can construct a concrete instance of `InstanceAttachmentArrayInput` via:

InstanceAttachmentArray{ InstanceAttachmentArgs{...} }

type InstanceAttachmentArrayOutput

type InstanceAttachmentArrayOutput struct{ *pulumi.OutputState }

func (InstanceAttachmentArrayOutput) ElementType

func (InstanceAttachmentArrayOutput) Index

func (InstanceAttachmentArrayOutput) ToInstanceAttachmentArrayOutput

func (o InstanceAttachmentArrayOutput) ToInstanceAttachmentArrayOutput() InstanceAttachmentArrayOutput

func (InstanceAttachmentArrayOutput) ToInstanceAttachmentArrayOutputWithContext

func (o InstanceAttachmentArrayOutput) ToInstanceAttachmentArrayOutputWithContext(ctx context.Context) InstanceAttachmentArrayOutput

func (InstanceAttachmentArrayOutput) ToOutput added in v3.43.1

type InstanceAttachmentInput

type InstanceAttachmentInput interface {
	pulumi.Input

	ToInstanceAttachmentOutput() InstanceAttachmentOutput
	ToInstanceAttachmentOutputWithContext(ctx context.Context) InstanceAttachmentOutput
}

type InstanceAttachmentMap

type InstanceAttachmentMap map[string]InstanceAttachmentInput

func (InstanceAttachmentMap) ElementType

func (InstanceAttachmentMap) ElementType() reflect.Type

func (InstanceAttachmentMap) ToInstanceAttachmentMapOutput

func (i InstanceAttachmentMap) ToInstanceAttachmentMapOutput() InstanceAttachmentMapOutput

func (InstanceAttachmentMap) ToInstanceAttachmentMapOutputWithContext

func (i InstanceAttachmentMap) ToInstanceAttachmentMapOutputWithContext(ctx context.Context) InstanceAttachmentMapOutput

func (InstanceAttachmentMap) ToOutput added in v3.43.1

type InstanceAttachmentMapInput

type InstanceAttachmentMapInput interface {
	pulumi.Input

	ToInstanceAttachmentMapOutput() InstanceAttachmentMapOutput
	ToInstanceAttachmentMapOutputWithContext(context.Context) InstanceAttachmentMapOutput
}

InstanceAttachmentMapInput is an input type that accepts InstanceAttachmentMap and InstanceAttachmentMapOutput values. You can construct a concrete instance of `InstanceAttachmentMapInput` via:

InstanceAttachmentMap{ "key": InstanceAttachmentArgs{...} }

type InstanceAttachmentMapOutput

type InstanceAttachmentMapOutput struct{ *pulumi.OutputState }

func (InstanceAttachmentMapOutput) ElementType

func (InstanceAttachmentMapOutput) MapIndex

func (InstanceAttachmentMapOutput) ToInstanceAttachmentMapOutput

func (o InstanceAttachmentMapOutput) ToInstanceAttachmentMapOutput() InstanceAttachmentMapOutput

func (InstanceAttachmentMapOutput) ToInstanceAttachmentMapOutputWithContext

func (o InstanceAttachmentMapOutput) ToInstanceAttachmentMapOutputWithContext(ctx context.Context) InstanceAttachmentMapOutput

func (InstanceAttachmentMapOutput) ToOutput added in v3.43.1

type InstanceAttachmentOutput

type InstanceAttachmentOutput struct{ *pulumi.OutputState }

func (InstanceAttachmentOutput) ElementType

func (InstanceAttachmentOutput) ElementType() reflect.Type

func (InstanceAttachmentOutput) InstanceName added in v3.27.0

func (o InstanceAttachmentOutput) InstanceName() pulumi.StringOutput

The name of the OTS instance.

func (InstanceAttachmentOutput) ToInstanceAttachmentOutput

func (o InstanceAttachmentOutput) ToInstanceAttachmentOutput() InstanceAttachmentOutput

func (InstanceAttachmentOutput) ToInstanceAttachmentOutputWithContext

func (o InstanceAttachmentOutput) ToInstanceAttachmentOutputWithContext(ctx context.Context) InstanceAttachmentOutput

func (InstanceAttachmentOutput) ToOutput added in v3.43.1

func (InstanceAttachmentOutput) VpcId added in v3.27.0

The ID of attaching VPC to instance.

func (InstanceAttachmentOutput) VpcName added in v3.27.0

The name of attaching VPC to instance.

func (InstanceAttachmentOutput) VswitchId added in v3.27.0

The ID of attaching VSwitch to instance.

type InstanceAttachmentState

type InstanceAttachmentState struct {
	// The name of the OTS instance.
	InstanceName pulumi.StringPtrInput
	// The ID of attaching VPC to instance.
	VpcId pulumi.StringPtrInput
	// The name of attaching VPC to instance.
	VpcName pulumi.StringPtrInput
	// The ID of attaching VSwitch to instance.
	VswitchId pulumi.StringPtrInput
}

func (InstanceAttachmentState) ElementType

func (InstanceAttachmentState) ElementType() reflect.Type

type InstanceInput

type InstanceInput interface {
	pulumi.Input

	ToInstanceOutput() InstanceOutput
	ToInstanceOutputWithContext(ctx context.Context) InstanceOutput
}

type InstanceMap

type InstanceMap map[string]InstanceInput

func (InstanceMap) ElementType

func (InstanceMap) ElementType() reflect.Type

func (InstanceMap) ToInstanceMapOutput

func (i InstanceMap) ToInstanceMapOutput() InstanceMapOutput

func (InstanceMap) ToInstanceMapOutputWithContext

func (i InstanceMap) ToInstanceMapOutputWithContext(ctx context.Context) InstanceMapOutput

func (InstanceMap) ToOutput added in v3.43.1

func (i InstanceMap) ToOutput(ctx context.Context) pulumix.Output[map[string]*Instance]

type InstanceMapInput

type InstanceMapInput interface {
	pulumi.Input

	ToInstanceMapOutput() InstanceMapOutput
	ToInstanceMapOutputWithContext(context.Context) InstanceMapOutput
}

InstanceMapInput is an input type that accepts InstanceMap and InstanceMapOutput values. You can construct a concrete instance of `InstanceMapInput` via:

InstanceMap{ "key": InstanceArgs{...} }

type InstanceMapOutput

type InstanceMapOutput struct{ *pulumi.OutputState }

func (InstanceMapOutput) ElementType

func (InstanceMapOutput) ElementType() reflect.Type

func (InstanceMapOutput) MapIndex

func (InstanceMapOutput) ToInstanceMapOutput

func (o InstanceMapOutput) ToInstanceMapOutput() InstanceMapOutput

func (InstanceMapOutput) ToInstanceMapOutputWithContext

func (o InstanceMapOutput) ToInstanceMapOutputWithContext(ctx context.Context) InstanceMapOutput

func (InstanceMapOutput) ToOutput added in v3.43.1

type InstanceOutput

type InstanceOutput struct{ *pulumi.OutputState }

func (InstanceOutput) AccessedBy added in v3.27.0

func (o InstanceOutput) AccessedBy() pulumi.StringPtrOutput

The network limitation of accessing instance. Valid values:

func (InstanceOutput) Description added in v3.27.0

func (o InstanceOutput) Description() pulumi.StringPtrOutput

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

func (InstanceOutput) ElementType

func (InstanceOutput) ElementType() reflect.Type

func (InstanceOutput) InstanceType added in v3.27.0

func (o InstanceOutput) InstanceType() pulumi.StringPtrOutput

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

func (InstanceOutput) Name added in v3.27.0

The name of the instance.

func (InstanceOutput) Tags added in v3.27.0

func (o InstanceOutput) Tags() pulumi.MapOutput

A mapping of tags to assign to the instance.

func (InstanceOutput) ToInstanceOutput

func (o InstanceOutput) ToInstanceOutput() InstanceOutput

func (InstanceOutput) ToInstanceOutputWithContext

func (o InstanceOutput) ToInstanceOutputWithContext(ctx context.Context) InstanceOutput

func (InstanceOutput) ToOutput added in v3.43.1

type InstanceState

type InstanceState struct {
	// The network limitation of accessing instance. Valid values:
	AccessedBy pulumi.StringPtrInput
	// The description of the instance. Currently, it does not support modifying.
	Description pulumi.StringPtrInput
	// The type of instance. Valid values are "Capacity" and "HighPerformance". Default to "HighPerformance".
	InstanceType pulumi.StringPtrInput
	// The name of the instance.
	Name pulumi.StringPtrInput
	// A mapping of tags to assign to the instance.
	Tags pulumi.MapInput
}

func (InstanceState) ElementType

func (InstanceState) ElementType() reflect.Type

type SearchIndex added in v3.29.0

type SearchIndex struct {
	pulumi.CustomResourceState

	// The search index create time.
	CreateTime pulumi.IntOutput `pulumi:"createTime"`
	// The timestamp for sync phase.
	CurrentSyncTimestamp pulumi.IntOutput `pulumi:"currentSyncTimestamp"`
	// The index id of the search index which could not be changed.
	IndexId pulumi.StringOutput `pulumi:"indexId"`
	// The index name of the OTS Table. If changed, a new index would be created.
	IndexName pulumi.StringOutput `pulumi:"indexName"`
	// The name of the OTS instance in which table will located.
	InstanceName pulumi.StringOutput `pulumi:"instanceName"`
	// The schema of the search index. If changed, a new index would be created.
	Schemas SearchIndexSchemaArrayOutput `pulumi:"schemas"`
	// The search index sync phase. possible values: `Full`, `Incr`.
	SyncPhase pulumi.StringOutput `pulumi:"syncPhase"`
	// The name of the OTS table. If changed, a new table would be created.
	TableName pulumi.StringOutput `pulumi:"tableName"`
	// The index type of the OTS Table. Specifies the retention period of data in the search index. Unit: seconds. Default value: -1.
	// If the retention period exceeds the TTL value, OTS automatically deletes expired data.
	TimeToLive pulumi.IntPtrOutput `pulumi:"timeToLive"`
}

Provides an OTS search index resource.

For information about OTS search index and how to use it, see [Search index overview](https://www.alibabacloud.com/help/en/tablestore/latest/search-index-overview).

> **NOTE:** Available in v1.187.0+.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ots"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "terraformtest"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		instance1, err := ots.NewInstance(ctx, "instance1", &ots.InstanceArgs{
			Description: pulumi.String(name),
			AccessedBy:  pulumi.String("Any"),
			Tags: pulumi.AnyMap{
				"Created": pulumi.Any("TF"),
				"For":     pulumi.Any("acceptance test"),
			},
		})
		if err != nil {
			return err
		}
		table1, err := ots.NewTable(ctx, "table1", &ots.TableArgs{
			InstanceName: instance1.Name,
			TableName:    pulumi.String(name),
			PrimaryKeys: ots.TablePrimaryKeyArray{
				&ots.TablePrimaryKeyArgs{
					Name: pulumi.String("pk1"),
					Type: pulumi.String("Integer"),
				},
				&ots.TablePrimaryKeyArgs{
					Name: pulumi.String("pk2"),
					Type: pulumi.String("String"),
				},
			},
			DefinedColumns: ots.TableDefinedColumnArray{
				&ots.TableDefinedColumnArgs{
					Name: pulumi.String("col1"),
					Type: pulumi.String("String"),
				},
				&ots.TableDefinedColumnArgs{
					Name: pulumi.String("col2"),
					Type: pulumi.String("Integer"),
				},
			},
			TimeToLive:                -1,
			MaxVersion:                pulumi.Int(1),
			DeviationCellVersionInSec: pulumi.String("1"),
		})
		if err != nil {
			return err
		}
		_, err = ots.NewSearchIndex(ctx, "default", &ots.SearchIndexArgs{
			InstanceName: instance1.Name,
			TableName:    table1.TableName,
			IndexName:    pulumi.String(name),
			TimeToLive:   -1,
			Schemas: ots.SearchIndexSchemaArray{
				&ots.SearchIndexSchemaArgs{
					FieldSchemas: ots.SearchIndexSchemaFieldSchemaArray{
						&ots.SearchIndexSchemaFieldSchemaArgs{
							FieldName: pulumi.String("col1"),
							FieldType: pulumi.String("Text"),
							IsArray:   pulumi.Bool(false),
							Index:     pulumi.Bool(true),
							Analyzer:  pulumi.String("Split"),
							Store:     pulumi.Bool(true),
						},
						&ots.SearchIndexSchemaFieldSchemaArgs{
							FieldName:        pulumi.String("col2"),
							FieldType:        pulumi.String("Long"),
							EnableSortAndAgg: pulumi.Bool(true),
						},
						&ots.SearchIndexSchemaFieldSchemaArgs{
							FieldName: pulumi.String("pk1"),
							FieldType: pulumi.String("Long"),
						},
						&ots.SearchIndexSchemaFieldSchemaArgs{
							FieldName: pulumi.String("pk2"),
							FieldType: pulumi.String("Text"),
						},
					},
					IndexSettings: ots.SearchIndexSchemaIndexSettingArray{
						&ots.SearchIndexSchemaIndexSettingArgs{
							RoutingFields: pulumi.StringArray{
								pulumi.String("pk1"),
								pulumi.String("pk2"),
							},
						},
					},
					IndexSorts: ots.SearchIndexSchemaIndexSortArray{
						&ots.SearchIndexSchemaIndexSortArgs{
							Sorters: ots.SearchIndexSchemaIndexSortSorterArray{
								&ots.SearchIndexSchemaIndexSortSorterArgs{
									SorterType: pulumi.String("PrimaryKeySort"),
									Order:      pulumi.String("Asc"),
								},
								&ots.SearchIndexSchemaIndexSortSorterArgs{
									SorterType: pulumi.String("FieldSort"),
									Order:      pulumi.String("Desc"),
									FieldName:  pulumi.String("col2"),
									Mode:       pulumi.String("Max"),
								},
							},
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

OTS search index can be imported using id, e.g.

```sh

$ pulumi import alicloud:ots/searchIndex:SearchIndex index1 <instance_name>:<table_name>:<index_name>:<index_type>

```

func GetSearchIndex added in v3.29.0

func GetSearchIndex(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *SearchIndexState, opts ...pulumi.ResourceOption) (*SearchIndex, error)

GetSearchIndex gets an existing SearchIndex resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSearchIndex added in v3.29.0

func NewSearchIndex(ctx *pulumi.Context,
	name string, args *SearchIndexArgs, opts ...pulumi.ResourceOption) (*SearchIndex, error)

NewSearchIndex registers a new resource with the given unique name, arguments, and options.

func (*SearchIndex) ElementType added in v3.29.0

func (*SearchIndex) ElementType() reflect.Type

func (*SearchIndex) ToOutput added in v3.43.1

func (i *SearchIndex) ToOutput(ctx context.Context) pulumix.Output[*SearchIndex]

func (*SearchIndex) ToSearchIndexOutput added in v3.29.0

func (i *SearchIndex) ToSearchIndexOutput() SearchIndexOutput

func (*SearchIndex) ToSearchIndexOutputWithContext added in v3.29.0

func (i *SearchIndex) ToSearchIndexOutputWithContext(ctx context.Context) SearchIndexOutput

type SearchIndexArgs added in v3.29.0

type SearchIndexArgs struct {
	// The index name of the OTS Table. If changed, a new index would be created.
	IndexName pulumi.StringInput
	// The name of the OTS instance in which table will located.
	InstanceName pulumi.StringInput
	// The schema of the search index. If changed, a new index would be created.
	Schemas SearchIndexSchemaArrayInput
	// The name of the OTS table. If changed, a new table would be created.
	TableName pulumi.StringInput
	// The index type of the OTS Table. Specifies the retention period of data in the search index. Unit: seconds. Default value: -1.
	// If the retention period exceeds the TTL value, OTS automatically deletes expired data.
	TimeToLive pulumi.IntPtrInput
}

The set of arguments for constructing a SearchIndex resource.

func (SearchIndexArgs) ElementType added in v3.29.0

func (SearchIndexArgs) ElementType() reflect.Type

type SearchIndexArray added in v3.29.0

type SearchIndexArray []SearchIndexInput

func (SearchIndexArray) ElementType added in v3.29.0

func (SearchIndexArray) ElementType() reflect.Type

func (SearchIndexArray) ToOutput added in v3.43.1

func (SearchIndexArray) ToSearchIndexArrayOutput added in v3.29.0

func (i SearchIndexArray) ToSearchIndexArrayOutput() SearchIndexArrayOutput

func (SearchIndexArray) ToSearchIndexArrayOutputWithContext added in v3.29.0

func (i SearchIndexArray) ToSearchIndexArrayOutputWithContext(ctx context.Context) SearchIndexArrayOutput

type SearchIndexArrayInput added in v3.29.0

type SearchIndexArrayInput interface {
	pulumi.Input

	ToSearchIndexArrayOutput() SearchIndexArrayOutput
	ToSearchIndexArrayOutputWithContext(context.Context) SearchIndexArrayOutput
}

SearchIndexArrayInput is an input type that accepts SearchIndexArray and SearchIndexArrayOutput values. You can construct a concrete instance of `SearchIndexArrayInput` via:

SearchIndexArray{ SearchIndexArgs{...} }

type SearchIndexArrayOutput added in v3.29.0

type SearchIndexArrayOutput struct{ *pulumi.OutputState }

func (SearchIndexArrayOutput) ElementType added in v3.29.0

func (SearchIndexArrayOutput) ElementType() reflect.Type

func (SearchIndexArrayOutput) Index added in v3.29.0

func (SearchIndexArrayOutput) ToOutput added in v3.43.1

func (SearchIndexArrayOutput) ToSearchIndexArrayOutput added in v3.29.0

func (o SearchIndexArrayOutput) ToSearchIndexArrayOutput() SearchIndexArrayOutput

func (SearchIndexArrayOutput) ToSearchIndexArrayOutputWithContext added in v3.29.0

func (o SearchIndexArrayOutput) ToSearchIndexArrayOutputWithContext(ctx context.Context) SearchIndexArrayOutput

type SearchIndexInput added in v3.29.0

type SearchIndexInput interface {
	pulumi.Input

	ToSearchIndexOutput() SearchIndexOutput
	ToSearchIndexOutputWithContext(ctx context.Context) SearchIndexOutput
}

type SearchIndexMap added in v3.29.0

type SearchIndexMap map[string]SearchIndexInput

func (SearchIndexMap) ElementType added in v3.29.0

func (SearchIndexMap) ElementType() reflect.Type

func (SearchIndexMap) ToOutput added in v3.43.1

func (SearchIndexMap) ToSearchIndexMapOutput added in v3.29.0

func (i SearchIndexMap) ToSearchIndexMapOutput() SearchIndexMapOutput

func (SearchIndexMap) ToSearchIndexMapOutputWithContext added in v3.29.0

func (i SearchIndexMap) ToSearchIndexMapOutputWithContext(ctx context.Context) SearchIndexMapOutput

type SearchIndexMapInput added in v3.29.0

type SearchIndexMapInput interface {
	pulumi.Input

	ToSearchIndexMapOutput() SearchIndexMapOutput
	ToSearchIndexMapOutputWithContext(context.Context) SearchIndexMapOutput
}

SearchIndexMapInput is an input type that accepts SearchIndexMap and SearchIndexMapOutput values. You can construct a concrete instance of `SearchIndexMapInput` via:

SearchIndexMap{ "key": SearchIndexArgs{...} }

type SearchIndexMapOutput added in v3.29.0

type SearchIndexMapOutput struct{ *pulumi.OutputState }

func (SearchIndexMapOutput) ElementType added in v3.29.0

func (SearchIndexMapOutput) ElementType() reflect.Type

func (SearchIndexMapOutput) MapIndex added in v3.29.0

func (SearchIndexMapOutput) ToOutput added in v3.43.1

func (SearchIndexMapOutput) ToSearchIndexMapOutput added in v3.29.0

func (o SearchIndexMapOutput) ToSearchIndexMapOutput() SearchIndexMapOutput

func (SearchIndexMapOutput) ToSearchIndexMapOutputWithContext added in v3.29.0

func (o SearchIndexMapOutput) ToSearchIndexMapOutputWithContext(ctx context.Context) SearchIndexMapOutput

type SearchIndexOutput added in v3.29.0

type SearchIndexOutput struct{ *pulumi.OutputState }

func (SearchIndexOutput) CreateTime added in v3.29.0

func (o SearchIndexOutput) CreateTime() pulumi.IntOutput

The search index create time.

func (SearchIndexOutput) CurrentSyncTimestamp added in v3.29.0

func (o SearchIndexOutput) CurrentSyncTimestamp() pulumi.IntOutput

The timestamp for sync phase.

func (SearchIndexOutput) ElementType added in v3.29.0

func (SearchIndexOutput) ElementType() reflect.Type

func (SearchIndexOutput) IndexId added in v3.29.0

The index id of the search index which could not be changed.

func (SearchIndexOutput) IndexName added in v3.29.0

func (o SearchIndexOutput) IndexName() pulumi.StringOutput

The index name of the OTS Table. If changed, a new index would be created.

func (SearchIndexOutput) InstanceName added in v3.29.0

func (o SearchIndexOutput) InstanceName() pulumi.StringOutput

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

func (SearchIndexOutput) Schemas added in v3.29.0

The schema of the search index. If changed, a new index would be created.

func (SearchIndexOutput) SyncPhase added in v3.29.0

func (o SearchIndexOutput) SyncPhase() pulumi.StringOutput

The search index sync phase. possible values: `Full`, `Incr`.

func (SearchIndexOutput) TableName added in v3.29.0

func (o SearchIndexOutput) TableName() pulumi.StringOutput

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

func (SearchIndexOutput) TimeToLive added in v3.29.0

func (o SearchIndexOutput) TimeToLive() pulumi.IntPtrOutput

The index type of the OTS Table. Specifies the retention period of data in the search index. Unit: seconds. Default value: -1. If the retention period exceeds the TTL value, OTS automatically deletes expired data.

func (SearchIndexOutput) ToOutput added in v3.43.1

func (SearchIndexOutput) ToSearchIndexOutput added in v3.29.0

func (o SearchIndexOutput) ToSearchIndexOutput() SearchIndexOutput

func (SearchIndexOutput) ToSearchIndexOutputWithContext added in v3.29.0

func (o SearchIndexOutput) ToSearchIndexOutputWithContext(ctx context.Context) SearchIndexOutput

type SearchIndexSchema added in v3.29.0

type SearchIndexSchema struct {
	// A list of field schemas. Each field schema contains the following parameters:
	FieldSchemas []SearchIndexSchemaFieldSchema `pulumi:"fieldSchemas"`
	// The settings of the search index, including routingFields.
	IndexSettings []SearchIndexSchemaIndexSetting `pulumi:"indexSettings"`
	// The presorting settings of the search index, including sorters. If no value is specified for the indexSort parameter, field values are sorted by primary key by default.
	IndexSorts []SearchIndexSchemaIndexSort `pulumi:"indexSorts"`
}

type SearchIndexSchemaArgs added in v3.29.0

type SearchIndexSchemaArgs struct {
	// A list of field schemas. Each field schema contains the following parameters:
	FieldSchemas SearchIndexSchemaFieldSchemaArrayInput `pulumi:"fieldSchemas"`
	// The settings of the search index, including routingFields.
	IndexSettings SearchIndexSchemaIndexSettingArrayInput `pulumi:"indexSettings"`
	// The presorting settings of the search index, including sorters. If no value is specified for the indexSort parameter, field values are sorted by primary key by default.
	IndexSorts SearchIndexSchemaIndexSortArrayInput `pulumi:"indexSorts"`
}

func (SearchIndexSchemaArgs) ElementType added in v3.29.0

func (SearchIndexSchemaArgs) ElementType() reflect.Type

func (SearchIndexSchemaArgs) ToOutput added in v3.43.1

func (SearchIndexSchemaArgs) ToSearchIndexSchemaOutput added in v3.29.0

func (i SearchIndexSchemaArgs) ToSearchIndexSchemaOutput() SearchIndexSchemaOutput

func (SearchIndexSchemaArgs) ToSearchIndexSchemaOutputWithContext added in v3.29.0

func (i SearchIndexSchemaArgs) ToSearchIndexSchemaOutputWithContext(ctx context.Context) SearchIndexSchemaOutput

type SearchIndexSchemaArray added in v3.29.0

type SearchIndexSchemaArray []SearchIndexSchemaInput

func (SearchIndexSchemaArray) ElementType added in v3.29.0

func (SearchIndexSchemaArray) ElementType() reflect.Type

func (SearchIndexSchemaArray) ToOutput added in v3.43.1

func (SearchIndexSchemaArray) ToSearchIndexSchemaArrayOutput added in v3.29.0

func (i SearchIndexSchemaArray) ToSearchIndexSchemaArrayOutput() SearchIndexSchemaArrayOutput

func (SearchIndexSchemaArray) ToSearchIndexSchemaArrayOutputWithContext added in v3.29.0

func (i SearchIndexSchemaArray) ToSearchIndexSchemaArrayOutputWithContext(ctx context.Context) SearchIndexSchemaArrayOutput

type SearchIndexSchemaArrayInput added in v3.29.0

type SearchIndexSchemaArrayInput interface {
	pulumi.Input

	ToSearchIndexSchemaArrayOutput() SearchIndexSchemaArrayOutput
	ToSearchIndexSchemaArrayOutputWithContext(context.Context) SearchIndexSchemaArrayOutput
}

SearchIndexSchemaArrayInput is an input type that accepts SearchIndexSchemaArray and SearchIndexSchemaArrayOutput values. You can construct a concrete instance of `SearchIndexSchemaArrayInput` via:

SearchIndexSchemaArray{ SearchIndexSchemaArgs{...} }

type SearchIndexSchemaArrayOutput added in v3.29.0

type SearchIndexSchemaArrayOutput struct{ *pulumi.OutputState }

func (SearchIndexSchemaArrayOutput) ElementType added in v3.29.0

func (SearchIndexSchemaArrayOutput) Index added in v3.29.0

func (SearchIndexSchemaArrayOutput) ToOutput added in v3.43.1

func (SearchIndexSchemaArrayOutput) ToSearchIndexSchemaArrayOutput added in v3.29.0

func (o SearchIndexSchemaArrayOutput) ToSearchIndexSchemaArrayOutput() SearchIndexSchemaArrayOutput

func (SearchIndexSchemaArrayOutput) ToSearchIndexSchemaArrayOutputWithContext added in v3.29.0

func (o SearchIndexSchemaArrayOutput) ToSearchIndexSchemaArrayOutputWithContext(ctx context.Context) SearchIndexSchemaArrayOutput

type SearchIndexSchemaFieldSchema added in v3.29.0

type SearchIndexSchemaFieldSchema struct {
	// Specifies the type of the analyzer that you want to use. If fieldType is set to Text, you can configure this parameter. Otherwise, the default analyzer type single-word tokenization is used.
	Analyzer *string `pulumi:"analyzer"`
	// Specifies whether to enable sorting and aggregation. Type: Boolean. Sorting can be enabled only for fields for which enableSortAndAgg is set to true.
	EnableSortAndAgg *bool `pulumi:"enableSortAndAgg"`
	// The name of the field that is used to sort data. only required if sorterType is FieldSort.
	FieldName string `pulumi:"fieldName"`
	// Specifies the type of the field. Use FieldType.XXX to set the type.
	FieldType string `pulumi:"fieldType"`
	// Specifies whether to enable indexing for the column. Type: Boolean.
	Index *bool `pulumi:"index"`
	// Specifies whether the value is an array. Type: Boolean.
	IsArray *bool `pulumi:"isArray"`
	// Specifies whether to store the value of the field in the search index. Type: Boolean. If you set store to true, you can read the value of the field from the search index without querying the data table. This improves query performance.
	Store *bool `pulumi:"store"`
}

type SearchIndexSchemaFieldSchemaArgs added in v3.29.0

type SearchIndexSchemaFieldSchemaArgs struct {
	// Specifies the type of the analyzer that you want to use. If fieldType is set to Text, you can configure this parameter. Otherwise, the default analyzer type single-word tokenization is used.
	Analyzer pulumi.StringPtrInput `pulumi:"analyzer"`
	// Specifies whether to enable sorting and aggregation. Type: Boolean. Sorting can be enabled only for fields for which enableSortAndAgg is set to true.
	EnableSortAndAgg pulumi.BoolPtrInput `pulumi:"enableSortAndAgg"`
	// The name of the field that is used to sort data. only required if sorterType is FieldSort.
	FieldName pulumi.StringInput `pulumi:"fieldName"`
	// Specifies the type of the field. Use FieldType.XXX to set the type.
	FieldType pulumi.StringInput `pulumi:"fieldType"`
	// Specifies whether to enable indexing for the column. Type: Boolean.
	Index pulumi.BoolPtrInput `pulumi:"index"`
	// Specifies whether the value is an array. Type: Boolean.
	IsArray pulumi.BoolPtrInput `pulumi:"isArray"`
	// Specifies whether to store the value of the field in the search index. Type: Boolean. If you set store to true, you can read the value of the field from the search index without querying the data table. This improves query performance.
	Store pulumi.BoolPtrInput `pulumi:"store"`
}

func (SearchIndexSchemaFieldSchemaArgs) ElementType added in v3.29.0

func (SearchIndexSchemaFieldSchemaArgs) ToOutput added in v3.43.1

func (SearchIndexSchemaFieldSchemaArgs) ToSearchIndexSchemaFieldSchemaOutput added in v3.29.0

func (i SearchIndexSchemaFieldSchemaArgs) ToSearchIndexSchemaFieldSchemaOutput() SearchIndexSchemaFieldSchemaOutput

func (SearchIndexSchemaFieldSchemaArgs) ToSearchIndexSchemaFieldSchemaOutputWithContext added in v3.29.0

func (i SearchIndexSchemaFieldSchemaArgs) ToSearchIndexSchemaFieldSchemaOutputWithContext(ctx context.Context) SearchIndexSchemaFieldSchemaOutput

type SearchIndexSchemaFieldSchemaArray added in v3.29.0

type SearchIndexSchemaFieldSchemaArray []SearchIndexSchemaFieldSchemaInput

func (SearchIndexSchemaFieldSchemaArray) ElementType added in v3.29.0

func (SearchIndexSchemaFieldSchemaArray) ToOutput added in v3.43.1

func (SearchIndexSchemaFieldSchemaArray) ToSearchIndexSchemaFieldSchemaArrayOutput added in v3.29.0

func (i SearchIndexSchemaFieldSchemaArray) ToSearchIndexSchemaFieldSchemaArrayOutput() SearchIndexSchemaFieldSchemaArrayOutput

func (SearchIndexSchemaFieldSchemaArray) ToSearchIndexSchemaFieldSchemaArrayOutputWithContext added in v3.29.0

func (i SearchIndexSchemaFieldSchemaArray) ToSearchIndexSchemaFieldSchemaArrayOutputWithContext(ctx context.Context) SearchIndexSchemaFieldSchemaArrayOutput

type SearchIndexSchemaFieldSchemaArrayInput added in v3.29.0

type SearchIndexSchemaFieldSchemaArrayInput interface {
	pulumi.Input

	ToSearchIndexSchemaFieldSchemaArrayOutput() SearchIndexSchemaFieldSchemaArrayOutput
	ToSearchIndexSchemaFieldSchemaArrayOutputWithContext(context.Context) SearchIndexSchemaFieldSchemaArrayOutput
}

SearchIndexSchemaFieldSchemaArrayInput is an input type that accepts SearchIndexSchemaFieldSchemaArray and SearchIndexSchemaFieldSchemaArrayOutput values. You can construct a concrete instance of `SearchIndexSchemaFieldSchemaArrayInput` via:

SearchIndexSchemaFieldSchemaArray{ SearchIndexSchemaFieldSchemaArgs{...} }

type SearchIndexSchemaFieldSchemaArrayOutput added in v3.29.0

type SearchIndexSchemaFieldSchemaArrayOutput struct{ *pulumi.OutputState }

func (SearchIndexSchemaFieldSchemaArrayOutput) ElementType added in v3.29.0

func (SearchIndexSchemaFieldSchemaArrayOutput) Index added in v3.29.0

func (SearchIndexSchemaFieldSchemaArrayOutput) ToOutput added in v3.43.1

func (SearchIndexSchemaFieldSchemaArrayOutput) ToSearchIndexSchemaFieldSchemaArrayOutput added in v3.29.0

func (o SearchIndexSchemaFieldSchemaArrayOutput) ToSearchIndexSchemaFieldSchemaArrayOutput() SearchIndexSchemaFieldSchemaArrayOutput

func (SearchIndexSchemaFieldSchemaArrayOutput) ToSearchIndexSchemaFieldSchemaArrayOutputWithContext added in v3.29.0

func (o SearchIndexSchemaFieldSchemaArrayOutput) ToSearchIndexSchemaFieldSchemaArrayOutputWithContext(ctx context.Context) SearchIndexSchemaFieldSchemaArrayOutput

type SearchIndexSchemaFieldSchemaInput added in v3.29.0

type SearchIndexSchemaFieldSchemaInput interface {
	pulumi.Input

	ToSearchIndexSchemaFieldSchemaOutput() SearchIndexSchemaFieldSchemaOutput
	ToSearchIndexSchemaFieldSchemaOutputWithContext(context.Context) SearchIndexSchemaFieldSchemaOutput
}

SearchIndexSchemaFieldSchemaInput is an input type that accepts SearchIndexSchemaFieldSchemaArgs and SearchIndexSchemaFieldSchemaOutput values. You can construct a concrete instance of `SearchIndexSchemaFieldSchemaInput` via:

SearchIndexSchemaFieldSchemaArgs{...}

type SearchIndexSchemaFieldSchemaOutput added in v3.29.0

type SearchIndexSchemaFieldSchemaOutput struct{ *pulumi.OutputState }

func (SearchIndexSchemaFieldSchemaOutput) Analyzer added in v3.29.0

Specifies the type of the analyzer that you want to use. If fieldType is set to Text, you can configure this parameter. Otherwise, the default analyzer type single-word tokenization is used.

func (SearchIndexSchemaFieldSchemaOutput) ElementType added in v3.29.0

func (SearchIndexSchemaFieldSchemaOutput) EnableSortAndAgg added in v3.29.0

Specifies whether to enable sorting and aggregation. Type: Boolean. Sorting can be enabled only for fields for which enableSortAndAgg is set to true.

func (SearchIndexSchemaFieldSchemaOutput) FieldName added in v3.29.0

The name of the field that is used to sort data. only required if sorterType is FieldSort.

func (SearchIndexSchemaFieldSchemaOutput) FieldType added in v3.29.0

Specifies the type of the field. Use FieldType.XXX to set the type.

func (SearchIndexSchemaFieldSchemaOutput) Index added in v3.29.0

Specifies whether to enable indexing for the column. Type: Boolean.

func (SearchIndexSchemaFieldSchemaOutput) IsArray added in v3.29.0

Specifies whether the value is an array. Type: Boolean.

func (SearchIndexSchemaFieldSchemaOutput) Store added in v3.29.0

Specifies whether to store the value of the field in the search index. Type: Boolean. If you set store to true, you can read the value of the field from the search index without querying the data table. This improves query performance.

func (SearchIndexSchemaFieldSchemaOutput) ToOutput added in v3.43.1

func (SearchIndexSchemaFieldSchemaOutput) ToSearchIndexSchemaFieldSchemaOutput added in v3.29.0

func (o SearchIndexSchemaFieldSchemaOutput) ToSearchIndexSchemaFieldSchemaOutput() SearchIndexSchemaFieldSchemaOutput

func (SearchIndexSchemaFieldSchemaOutput) ToSearchIndexSchemaFieldSchemaOutputWithContext added in v3.29.0

func (o SearchIndexSchemaFieldSchemaOutput) ToSearchIndexSchemaFieldSchemaOutputWithContext(ctx context.Context) SearchIndexSchemaFieldSchemaOutput

type SearchIndexSchemaIndexSetting added in v3.29.0

type SearchIndexSchemaIndexSetting struct {
	// Specifies custom routing fields. You can specify some primary key columns as routing fields. Tablestore distributes data that is written to a search index across different partitions based on the specified routing fields. The data whose routing field values are the same is distributed to the same partition.
	RoutingFields []string `pulumi:"routingFields"`
}

type SearchIndexSchemaIndexSettingArgs added in v3.29.0

type SearchIndexSchemaIndexSettingArgs struct {
	// Specifies custom routing fields. You can specify some primary key columns as routing fields. Tablestore distributes data that is written to a search index across different partitions based on the specified routing fields. The data whose routing field values are the same is distributed to the same partition.
	RoutingFields pulumi.StringArrayInput `pulumi:"routingFields"`
}

func (SearchIndexSchemaIndexSettingArgs) ElementType added in v3.29.0

func (SearchIndexSchemaIndexSettingArgs) ToOutput added in v3.43.1

func (SearchIndexSchemaIndexSettingArgs) ToSearchIndexSchemaIndexSettingOutput added in v3.29.0

func (i SearchIndexSchemaIndexSettingArgs) ToSearchIndexSchemaIndexSettingOutput() SearchIndexSchemaIndexSettingOutput

func (SearchIndexSchemaIndexSettingArgs) ToSearchIndexSchemaIndexSettingOutputWithContext added in v3.29.0

func (i SearchIndexSchemaIndexSettingArgs) ToSearchIndexSchemaIndexSettingOutputWithContext(ctx context.Context) SearchIndexSchemaIndexSettingOutput

type SearchIndexSchemaIndexSettingArray added in v3.29.0

type SearchIndexSchemaIndexSettingArray []SearchIndexSchemaIndexSettingInput

func (SearchIndexSchemaIndexSettingArray) ElementType added in v3.29.0

func (SearchIndexSchemaIndexSettingArray) ToOutput added in v3.43.1

func (SearchIndexSchemaIndexSettingArray) ToSearchIndexSchemaIndexSettingArrayOutput added in v3.29.0

func (i SearchIndexSchemaIndexSettingArray) ToSearchIndexSchemaIndexSettingArrayOutput() SearchIndexSchemaIndexSettingArrayOutput

func (SearchIndexSchemaIndexSettingArray) ToSearchIndexSchemaIndexSettingArrayOutputWithContext added in v3.29.0

func (i SearchIndexSchemaIndexSettingArray) ToSearchIndexSchemaIndexSettingArrayOutputWithContext(ctx context.Context) SearchIndexSchemaIndexSettingArrayOutput

type SearchIndexSchemaIndexSettingArrayInput added in v3.29.0

type SearchIndexSchemaIndexSettingArrayInput interface {
	pulumi.Input

	ToSearchIndexSchemaIndexSettingArrayOutput() SearchIndexSchemaIndexSettingArrayOutput
	ToSearchIndexSchemaIndexSettingArrayOutputWithContext(context.Context) SearchIndexSchemaIndexSettingArrayOutput
}

SearchIndexSchemaIndexSettingArrayInput is an input type that accepts SearchIndexSchemaIndexSettingArray and SearchIndexSchemaIndexSettingArrayOutput values. You can construct a concrete instance of `SearchIndexSchemaIndexSettingArrayInput` via:

SearchIndexSchemaIndexSettingArray{ SearchIndexSchemaIndexSettingArgs{...} }

type SearchIndexSchemaIndexSettingArrayOutput added in v3.29.0

type SearchIndexSchemaIndexSettingArrayOutput struct{ *pulumi.OutputState }

func (SearchIndexSchemaIndexSettingArrayOutput) ElementType added in v3.29.0

func (SearchIndexSchemaIndexSettingArrayOutput) Index added in v3.29.0

func (SearchIndexSchemaIndexSettingArrayOutput) ToOutput added in v3.43.1

func (SearchIndexSchemaIndexSettingArrayOutput) ToSearchIndexSchemaIndexSettingArrayOutput added in v3.29.0

func (o SearchIndexSchemaIndexSettingArrayOutput) ToSearchIndexSchemaIndexSettingArrayOutput() SearchIndexSchemaIndexSettingArrayOutput

func (SearchIndexSchemaIndexSettingArrayOutput) ToSearchIndexSchemaIndexSettingArrayOutputWithContext added in v3.29.0

func (o SearchIndexSchemaIndexSettingArrayOutput) ToSearchIndexSchemaIndexSettingArrayOutputWithContext(ctx context.Context) SearchIndexSchemaIndexSettingArrayOutput

type SearchIndexSchemaIndexSettingInput added in v3.29.0

type SearchIndexSchemaIndexSettingInput interface {
	pulumi.Input

	ToSearchIndexSchemaIndexSettingOutput() SearchIndexSchemaIndexSettingOutput
	ToSearchIndexSchemaIndexSettingOutputWithContext(context.Context) SearchIndexSchemaIndexSettingOutput
}

SearchIndexSchemaIndexSettingInput is an input type that accepts SearchIndexSchemaIndexSettingArgs and SearchIndexSchemaIndexSettingOutput values. You can construct a concrete instance of `SearchIndexSchemaIndexSettingInput` via:

SearchIndexSchemaIndexSettingArgs{...}

type SearchIndexSchemaIndexSettingOutput added in v3.29.0

type SearchIndexSchemaIndexSettingOutput struct{ *pulumi.OutputState }

func (SearchIndexSchemaIndexSettingOutput) ElementType added in v3.29.0

func (SearchIndexSchemaIndexSettingOutput) RoutingFields added in v3.29.0

Specifies custom routing fields. You can specify some primary key columns as routing fields. Tablestore distributes data that is written to a search index across different partitions based on the specified routing fields. The data whose routing field values are the same is distributed to the same partition.

func (SearchIndexSchemaIndexSettingOutput) ToOutput added in v3.43.1

func (SearchIndexSchemaIndexSettingOutput) ToSearchIndexSchemaIndexSettingOutput added in v3.29.0

func (o SearchIndexSchemaIndexSettingOutput) ToSearchIndexSchemaIndexSettingOutput() SearchIndexSchemaIndexSettingOutput

func (SearchIndexSchemaIndexSettingOutput) ToSearchIndexSchemaIndexSettingOutputWithContext added in v3.29.0

func (o SearchIndexSchemaIndexSettingOutput) ToSearchIndexSchemaIndexSettingOutputWithContext(ctx context.Context) SearchIndexSchemaIndexSettingOutput

type SearchIndexSchemaIndexSort added in v3.29.0

type SearchIndexSchemaIndexSort struct {
	// Specifies the presorting method for the search index. PrimaryKeySort and FieldSort are supported.
	Sorters []SearchIndexSchemaIndexSortSorter `pulumi:"sorters"`
}

type SearchIndexSchemaIndexSortArgs added in v3.29.0

type SearchIndexSchemaIndexSortArgs struct {
	// Specifies the presorting method for the search index. PrimaryKeySort and FieldSort are supported.
	Sorters SearchIndexSchemaIndexSortSorterArrayInput `pulumi:"sorters"`
}

func (SearchIndexSchemaIndexSortArgs) ElementType added in v3.29.0

func (SearchIndexSchemaIndexSortArgs) ToOutput added in v3.43.1

func (SearchIndexSchemaIndexSortArgs) ToSearchIndexSchemaIndexSortOutput added in v3.29.0

func (i SearchIndexSchemaIndexSortArgs) ToSearchIndexSchemaIndexSortOutput() SearchIndexSchemaIndexSortOutput

func (SearchIndexSchemaIndexSortArgs) ToSearchIndexSchemaIndexSortOutputWithContext added in v3.29.0

func (i SearchIndexSchemaIndexSortArgs) ToSearchIndexSchemaIndexSortOutputWithContext(ctx context.Context) SearchIndexSchemaIndexSortOutput

type SearchIndexSchemaIndexSortArray added in v3.29.0

type SearchIndexSchemaIndexSortArray []SearchIndexSchemaIndexSortInput

func (SearchIndexSchemaIndexSortArray) ElementType added in v3.29.0

func (SearchIndexSchemaIndexSortArray) ToOutput added in v3.43.1

func (SearchIndexSchemaIndexSortArray) ToSearchIndexSchemaIndexSortArrayOutput added in v3.29.0

func (i SearchIndexSchemaIndexSortArray) ToSearchIndexSchemaIndexSortArrayOutput() SearchIndexSchemaIndexSortArrayOutput

func (SearchIndexSchemaIndexSortArray) ToSearchIndexSchemaIndexSortArrayOutputWithContext added in v3.29.0

func (i SearchIndexSchemaIndexSortArray) ToSearchIndexSchemaIndexSortArrayOutputWithContext(ctx context.Context) SearchIndexSchemaIndexSortArrayOutput

type SearchIndexSchemaIndexSortArrayInput added in v3.29.0

type SearchIndexSchemaIndexSortArrayInput interface {
	pulumi.Input

	ToSearchIndexSchemaIndexSortArrayOutput() SearchIndexSchemaIndexSortArrayOutput
	ToSearchIndexSchemaIndexSortArrayOutputWithContext(context.Context) SearchIndexSchemaIndexSortArrayOutput
}

SearchIndexSchemaIndexSortArrayInput is an input type that accepts SearchIndexSchemaIndexSortArray and SearchIndexSchemaIndexSortArrayOutput values. You can construct a concrete instance of `SearchIndexSchemaIndexSortArrayInput` via:

SearchIndexSchemaIndexSortArray{ SearchIndexSchemaIndexSortArgs{...} }

type SearchIndexSchemaIndexSortArrayOutput added in v3.29.0

type SearchIndexSchemaIndexSortArrayOutput struct{ *pulumi.OutputState }

func (SearchIndexSchemaIndexSortArrayOutput) ElementType added in v3.29.0

func (SearchIndexSchemaIndexSortArrayOutput) Index added in v3.29.0

func (SearchIndexSchemaIndexSortArrayOutput) ToOutput added in v3.43.1

func (SearchIndexSchemaIndexSortArrayOutput) ToSearchIndexSchemaIndexSortArrayOutput added in v3.29.0

func (o SearchIndexSchemaIndexSortArrayOutput) ToSearchIndexSchemaIndexSortArrayOutput() SearchIndexSchemaIndexSortArrayOutput

func (SearchIndexSchemaIndexSortArrayOutput) ToSearchIndexSchemaIndexSortArrayOutputWithContext added in v3.29.0

func (o SearchIndexSchemaIndexSortArrayOutput) ToSearchIndexSchemaIndexSortArrayOutputWithContext(ctx context.Context) SearchIndexSchemaIndexSortArrayOutput

type SearchIndexSchemaIndexSortInput added in v3.29.0

type SearchIndexSchemaIndexSortInput interface {
	pulumi.Input

	ToSearchIndexSchemaIndexSortOutput() SearchIndexSchemaIndexSortOutput
	ToSearchIndexSchemaIndexSortOutputWithContext(context.Context) SearchIndexSchemaIndexSortOutput
}

SearchIndexSchemaIndexSortInput is an input type that accepts SearchIndexSchemaIndexSortArgs and SearchIndexSchemaIndexSortOutput values. You can construct a concrete instance of `SearchIndexSchemaIndexSortInput` via:

SearchIndexSchemaIndexSortArgs{...}

type SearchIndexSchemaIndexSortOutput added in v3.29.0

type SearchIndexSchemaIndexSortOutput struct{ *pulumi.OutputState }

func (SearchIndexSchemaIndexSortOutput) ElementType added in v3.29.0

func (SearchIndexSchemaIndexSortOutput) Sorters added in v3.29.0

Specifies the presorting method for the search index. PrimaryKeySort and FieldSort are supported.

func (SearchIndexSchemaIndexSortOutput) ToOutput added in v3.43.1

func (SearchIndexSchemaIndexSortOutput) ToSearchIndexSchemaIndexSortOutput added in v3.29.0

func (o SearchIndexSchemaIndexSortOutput) ToSearchIndexSchemaIndexSortOutput() SearchIndexSchemaIndexSortOutput

func (SearchIndexSchemaIndexSortOutput) ToSearchIndexSchemaIndexSortOutputWithContext added in v3.29.0

func (o SearchIndexSchemaIndexSortOutput) ToSearchIndexSchemaIndexSortOutputWithContext(ctx context.Context) SearchIndexSchemaIndexSortOutput

type SearchIndexSchemaIndexSortSorter added in v3.29.0

type SearchIndexSchemaIndexSortSorter struct {
	// The name of the field that is used to sort data. only required if sorterType is FieldSort.
	FieldName *string `pulumi:"fieldName"`
	// The sorting method that is used when the field contains multiple values. valid values: `Min`, `Max`, `Avg`. only required if sorterType is FieldSort.
	Mode *string `pulumi:"mode"`
	// The sort order. Data can be sorted in ascending(`Asc`) or descending(`Desc`) order. Default value: `Asc`.
	Order *string `pulumi:"order"`
	// Data is sorted by Which fields or keys. valid values: `PrimaryKeySort`, `FieldSort`.
	SorterType *string `pulumi:"sorterType"`
}

type SearchIndexSchemaIndexSortSorterArgs added in v3.29.0

type SearchIndexSchemaIndexSortSorterArgs struct {
	// The name of the field that is used to sort data. only required if sorterType is FieldSort.
	FieldName pulumi.StringPtrInput `pulumi:"fieldName"`
	// The sorting method that is used when the field contains multiple values. valid values: `Min`, `Max`, `Avg`. only required if sorterType is FieldSort.
	Mode pulumi.StringPtrInput `pulumi:"mode"`
	// The sort order. Data can be sorted in ascending(`Asc`) or descending(`Desc`) order. Default value: `Asc`.
	Order pulumi.StringPtrInput `pulumi:"order"`
	// Data is sorted by Which fields or keys. valid values: `PrimaryKeySort`, `FieldSort`.
	SorterType pulumi.StringPtrInput `pulumi:"sorterType"`
}

func (SearchIndexSchemaIndexSortSorterArgs) ElementType added in v3.29.0

func (SearchIndexSchemaIndexSortSorterArgs) ToOutput added in v3.43.1

func (SearchIndexSchemaIndexSortSorterArgs) ToSearchIndexSchemaIndexSortSorterOutput added in v3.29.0

func (i SearchIndexSchemaIndexSortSorterArgs) ToSearchIndexSchemaIndexSortSorterOutput() SearchIndexSchemaIndexSortSorterOutput

func (SearchIndexSchemaIndexSortSorterArgs) ToSearchIndexSchemaIndexSortSorterOutputWithContext added in v3.29.0

func (i SearchIndexSchemaIndexSortSorterArgs) ToSearchIndexSchemaIndexSortSorterOutputWithContext(ctx context.Context) SearchIndexSchemaIndexSortSorterOutput

type SearchIndexSchemaIndexSortSorterArray added in v3.29.0

type SearchIndexSchemaIndexSortSorterArray []SearchIndexSchemaIndexSortSorterInput

func (SearchIndexSchemaIndexSortSorterArray) ElementType added in v3.29.0

func (SearchIndexSchemaIndexSortSorterArray) ToOutput added in v3.43.1

func (SearchIndexSchemaIndexSortSorterArray) ToSearchIndexSchemaIndexSortSorterArrayOutput added in v3.29.0

func (i SearchIndexSchemaIndexSortSorterArray) ToSearchIndexSchemaIndexSortSorterArrayOutput() SearchIndexSchemaIndexSortSorterArrayOutput

func (SearchIndexSchemaIndexSortSorterArray) ToSearchIndexSchemaIndexSortSorterArrayOutputWithContext added in v3.29.0

func (i SearchIndexSchemaIndexSortSorterArray) ToSearchIndexSchemaIndexSortSorterArrayOutputWithContext(ctx context.Context) SearchIndexSchemaIndexSortSorterArrayOutput

type SearchIndexSchemaIndexSortSorterArrayInput added in v3.29.0

type SearchIndexSchemaIndexSortSorterArrayInput interface {
	pulumi.Input

	ToSearchIndexSchemaIndexSortSorterArrayOutput() SearchIndexSchemaIndexSortSorterArrayOutput
	ToSearchIndexSchemaIndexSortSorterArrayOutputWithContext(context.Context) SearchIndexSchemaIndexSortSorterArrayOutput
}

SearchIndexSchemaIndexSortSorterArrayInput is an input type that accepts SearchIndexSchemaIndexSortSorterArray and SearchIndexSchemaIndexSortSorterArrayOutput values. You can construct a concrete instance of `SearchIndexSchemaIndexSortSorterArrayInput` via:

SearchIndexSchemaIndexSortSorterArray{ SearchIndexSchemaIndexSortSorterArgs{...} }

type SearchIndexSchemaIndexSortSorterArrayOutput added in v3.29.0

type SearchIndexSchemaIndexSortSorterArrayOutput struct{ *pulumi.OutputState }

func (SearchIndexSchemaIndexSortSorterArrayOutput) ElementType added in v3.29.0

func (SearchIndexSchemaIndexSortSorterArrayOutput) Index added in v3.29.0

func (SearchIndexSchemaIndexSortSorterArrayOutput) ToOutput added in v3.43.1

func (SearchIndexSchemaIndexSortSorterArrayOutput) ToSearchIndexSchemaIndexSortSorterArrayOutput added in v3.29.0

func (o SearchIndexSchemaIndexSortSorterArrayOutput) ToSearchIndexSchemaIndexSortSorterArrayOutput() SearchIndexSchemaIndexSortSorterArrayOutput

func (SearchIndexSchemaIndexSortSorterArrayOutput) ToSearchIndexSchemaIndexSortSorterArrayOutputWithContext added in v3.29.0

func (o SearchIndexSchemaIndexSortSorterArrayOutput) ToSearchIndexSchemaIndexSortSorterArrayOutputWithContext(ctx context.Context) SearchIndexSchemaIndexSortSorterArrayOutput

type SearchIndexSchemaIndexSortSorterInput added in v3.29.0

type SearchIndexSchemaIndexSortSorterInput interface {
	pulumi.Input

	ToSearchIndexSchemaIndexSortSorterOutput() SearchIndexSchemaIndexSortSorterOutput
	ToSearchIndexSchemaIndexSortSorterOutputWithContext(context.Context) SearchIndexSchemaIndexSortSorterOutput
}

SearchIndexSchemaIndexSortSorterInput is an input type that accepts SearchIndexSchemaIndexSortSorterArgs and SearchIndexSchemaIndexSortSorterOutput values. You can construct a concrete instance of `SearchIndexSchemaIndexSortSorterInput` via:

SearchIndexSchemaIndexSortSorterArgs{...}

type SearchIndexSchemaIndexSortSorterOutput added in v3.29.0

type SearchIndexSchemaIndexSortSorterOutput struct{ *pulumi.OutputState }

func (SearchIndexSchemaIndexSortSorterOutput) ElementType added in v3.29.0

func (SearchIndexSchemaIndexSortSorterOutput) FieldName added in v3.29.0

The name of the field that is used to sort data. only required if sorterType is FieldSort.

func (SearchIndexSchemaIndexSortSorterOutput) Mode added in v3.29.0

The sorting method that is used when the field contains multiple values. valid values: `Min`, `Max`, `Avg`. only required if sorterType is FieldSort.

func (SearchIndexSchemaIndexSortSorterOutput) Order added in v3.29.0

The sort order. Data can be sorted in ascending(`Asc`) or descending(`Desc`) order. Default value: `Asc`.

func (SearchIndexSchemaIndexSortSorterOutput) SorterType added in v3.29.0

Data is sorted by Which fields or keys. valid values: `PrimaryKeySort`, `FieldSort`.

func (SearchIndexSchemaIndexSortSorterOutput) ToOutput added in v3.43.1

func (SearchIndexSchemaIndexSortSorterOutput) ToSearchIndexSchemaIndexSortSorterOutput added in v3.29.0

func (o SearchIndexSchemaIndexSortSorterOutput) ToSearchIndexSchemaIndexSortSorterOutput() SearchIndexSchemaIndexSortSorterOutput

func (SearchIndexSchemaIndexSortSorterOutput) ToSearchIndexSchemaIndexSortSorterOutputWithContext added in v3.29.0

func (o SearchIndexSchemaIndexSortSorterOutput) ToSearchIndexSchemaIndexSortSorterOutputWithContext(ctx context.Context) SearchIndexSchemaIndexSortSorterOutput

type SearchIndexSchemaInput added in v3.29.0

type SearchIndexSchemaInput interface {
	pulumi.Input

	ToSearchIndexSchemaOutput() SearchIndexSchemaOutput
	ToSearchIndexSchemaOutputWithContext(context.Context) SearchIndexSchemaOutput
}

SearchIndexSchemaInput is an input type that accepts SearchIndexSchemaArgs and SearchIndexSchemaOutput values. You can construct a concrete instance of `SearchIndexSchemaInput` via:

SearchIndexSchemaArgs{...}

type SearchIndexSchemaOutput added in v3.29.0

type SearchIndexSchemaOutput struct{ *pulumi.OutputState }

func (SearchIndexSchemaOutput) ElementType added in v3.29.0

func (SearchIndexSchemaOutput) ElementType() reflect.Type

func (SearchIndexSchemaOutput) FieldSchemas added in v3.29.0

A list of field schemas. Each field schema contains the following parameters:

func (SearchIndexSchemaOutput) IndexSettings added in v3.29.0

The settings of the search index, including routingFields.

func (SearchIndexSchemaOutput) IndexSorts added in v3.29.0

The presorting settings of the search index, including sorters. If no value is specified for the indexSort parameter, field values are sorted by primary key by default.

func (SearchIndexSchemaOutput) ToOutput added in v3.43.1

func (SearchIndexSchemaOutput) ToSearchIndexSchemaOutput added in v3.29.0

func (o SearchIndexSchemaOutput) ToSearchIndexSchemaOutput() SearchIndexSchemaOutput

func (SearchIndexSchemaOutput) ToSearchIndexSchemaOutputWithContext added in v3.29.0

func (o SearchIndexSchemaOutput) ToSearchIndexSchemaOutputWithContext(ctx context.Context) SearchIndexSchemaOutput

type SearchIndexState added in v3.29.0

type SearchIndexState struct {
	// The search index create time.
	CreateTime pulumi.IntPtrInput
	// The timestamp for sync phase.
	CurrentSyncTimestamp pulumi.IntPtrInput
	// The index id of the search index which could not be changed.
	IndexId pulumi.StringPtrInput
	// The index name of the OTS Table. If changed, a new index would be created.
	IndexName pulumi.StringPtrInput
	// The name of the OTS instance in which table will located.
	InstanceName pulumi.StringPtrInput
	// The schema of the search index. If changed, a new index would be created.
	Schemas SearchIndexSchemaArrayInput
	// The search index sync phase. possible values: `Full`, `Incr`.
	SyncPhase pulumi.StringPtrInput
	// The name of the OTS table. If changed, a new table would be created.
	TableName pulumi.StringPtrInput
	// The index type of the OTS Table. Specifies the retention period of data in the search index. Unit: seconds. Default value: -1.
	// If the retention period exceeds the TTL value, OTS automatically deletes expired data.
	TimeToLive pulumi.IntPtrInput
}

func (SearchIndexState) ElementType added in v3.29.0

func (SearchIndexState) ElementType() reflect.Type

type SecondaryIndex added in v3.29.0

type SecondaryIndex struct {
	pulumi.CustomResourceState

	// A list of defined column for index, referenced from Table's primary keys or predefined columns.
	DefinedColumns pulumi.StringArrayOutput `pulumi:"definedColumns"`
	// whether the index contains data that already exists in the data table. When includeBaseData is set to true, it means that stock data is included.
	IncludeBaseData pulumi.BoolOutput `pulumi:"includeBaseData"`
	// The index name of the OTS Table. If changed, a new index would be created.
	IndexName pulumi.StringOutput `pulumi:"indexName"`
	// The index type of the OTS Table. If changed, a new index would be created, only `Global` or `Local` is allowed.
	IndexType pulumi.StringOutput `pulumi:"indexType"`
	// The name of the OTS instance in which table will located.
	InstanceName pulumi.StringOutput `pulumi:"instanceName"`
	// A list of primary keys for index, referenced from Table's primary keys or predefined columns.
	PrimaryKeys pulumi.StringArrayOutput `pulumi:"primaryKeys"`
	// The name of the OTS table. If changed, a new table would be created.
	TableName pulumi.StringOutput `pulumi:"tableName"`
}

Provides an OTS secondary index resource.

For information about OTS secondary index and how to use it, see [Secondary index overview](https://www.alibabacloud.com/help/en/tablestore/latest/secondary-index-overview).

> **NOTE:** Available in v1.187.0+.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ots"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "terraformtest"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		pks := []string{
			"pk1",
			"pk2",
			"pk3",
		}
		if param := cfg.GetBool("pks"); param != nil {
			pks = param
		}
		definedCols := []string{
			"col1",
			"col2",
			"col3",
		}
		if param := cfg.GetBool("definedCols"); param != nil {
			definedCols = param
		}
		instance1, err := ots.NewInstance(ctx, "instance1", &ots.InstanceArgs{
			Description: pulumi.String(name),
			AccessedBy:  pulumi.String("Any"),
			Tags: pulumi.AnyMap{
				"Created": pulumi.Any("TF"),
				"For":     pulumi.Any("acceptance test"),
			},
		})
		if err != nil {
			return err
		}
		table1, err := ots.NewTable(ctx, "table1", &ots.TableArgs{
			InstanceName: instance1.Name,
			TableName:    pulumi.String(name),
			PrimaryKeys: ots.TablePrimaryKeyArray{
				&ots.TablePrimaryKeyArgs{
					Name: pulumi.String("pk1"),
					Type: pulumi.String("Integer"),
				},
				&ots.TablePrimaryKeyArgs{
					Name: pulumi.String("pk2"),
					Type: pulumi.String("String"),
				},
				&ots.TablePrimaryKeyArgs{
					Name: pulumi.String("pk3"),
					Type: pulumi.String("Binary"),
				},
			},
			DefinedColumns: ots.TableDefinedColumnArray{
				&ots.TableDefinedColumnArgs{
					Name: pulumi.String("col1"),
					Type: pulumi.String("Integer"),
				},
				&ots.TableDefinedColumnArgs{
					Name: pulumi.String("col2"),
					Type: pulumi.String("String"),
				},
				&ots.TableDefinedColumnArgs{
					Name: pulumi.String("col3"),
					Type: pulumi.String("Binary"),
				},
			},
			TimeToLive:                -1,
			MaxVersion:                pulumi.Int(1),
			DeviationCellVersionInSec: pulumi.String("1"),
		})
		if err != nil {
			return err
		}
		_, err = ots.NewSecondaryIndex(ctx, "index1", &ots.SecondaryIndexArgs{
			InstanceName:    instance1.Name,
			TableName:       table1.TableName,
			IndexName:       pulumi.String(name),
			IndexType:       pulumi.String("Global"),
			IncludeBaseData: pulumi.Bool(true),
			PrimaryKeys:     pks,
			DefinedColumns:  definedCols,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

OTS secondary index can be imported using id, e.g.

```sh

$ pulumi import alicloud:ots/secondaryIndex:SecondaryIndex index1 <instance_name>:<table_name>:<index_name>:<index_type>

```

func GetSecondaryIndex added in v3.29.0

func GetSecondaryIndex(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *SecondaryIndexState, opts ...pulumi.ResourceOption) (*SecondaryIndex, error)

GetSecondaryIndex gets an existing SecondaryIndex resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSecondaryIndex added in v3.29.0

func NewSecondaryIndex(ctx *pulumi.Context,
	name string, args *SecondaryIndexArgs, opts ...pulumi.ResourceOption) (*SecondaryIndex, error)

NewSecondaryIndex registers a new resource with the given unique name, arguments, and options.

func (*SecondaryIndex) ElementType added in v3.29.0

func (*SecondaryIndex) ElementType() reflect.Type

func (*SecondaryIndex) ToOutput added in v3.43.1

func (*SecondaryIndex) ToSecondaryIndexOutput added in v3.29.0

func (i *SecondaryIndex) ToSecondaryIndexOutput() SecondaryIndexOutput

func (*SecondaryIndex) ToSecondaryIndexOutputWithContext added in v3.29.0

func (i *SecondaryIndex) ToSecondaryIndexOutputWithContext(ctx context.Context) SecondaryIndexOutput

type SecondaryIndexArgs added in v3.29.0

type SecondaryIndexArgs struct {
	// A list of defined column for index, referenced from Table's primary keys or predefined columns.
	DefinedColumns pulumi.StringArrayInput
	// whether the index contains data that already exists in the data table. When includeBaseData is set to true, it means that stock data is included.
	IncludeBaseData pulumi.BoolInput
	// The index name of the OTS Table. If changed, a new index would be created.
	IndexName pulumi.StringInput
	// The index type of the OTS Table. If changed, a new index would be created, only `Global` or `Local` is allowed.
	IndexType pulumi.StringInput
	// The name of the OTS instance in which table will located.
	InstanceName pulumi.StringInput
	// A list of primary keys for index, referenced from Table's primary keys or predefined columns.
	PrimaryKeys pulumi.StringArrayInput
	// The name of the OTS table. If changed, a new table would be created.
	TableName pulumi.StringInput
}

The set of arguments for constructing a SecondaryIndex resource.

func (SecondaryIndexArgs) ElementType added in v3.29.0

func (SecondaryIndexArgs) ElementType() reflect.Type

type SecondaryIndexArray added in v3.29.0

type SecondaryIndexArray []SecondaryIndexInput

func (SecondaryIndexArray) ElementType added in v3.29.0

func (SecondaryIndexArray) ElementType() reflect.Type

func (SecondaryIndexArray) ToOutput added in v3.43.1

func (SecondaryIndexArray) ToSecondaryIndexArrayOutput added in v3.29.0

func (i SecondaryIndexArray) ToSecondaryIndexArrayOutput() SecondaryIndexArrayOutput

func (SecondaryIndexArray) ToSecondaryIndexArrayOutputWithContext added in v3.29.0

func (i SecondaryIndexArray) ToSecondaryIndexArrayOutputWithContext(ctx context.Context) SecondaryIndexArrayOutput

type SecondaryIndexArrayInput added in v3.29.0

type SecondaryIndexArrayInput interface {
	pulumi.Input

	ToSecondaryIndexArrayOutput() SecondaryIndexArrayOutput
	ToSecondaryIndexArrayOutputWithContext(context.Context) SecondaryIndexArrayOutput
}

SecondaryIndexArrayInput is an input type that accepts SecondaryIndexArray and SecondaryIndexArrayOutput values. You can construct a concrete instance of `SecondaryIndexArrayInput` via:

SecondaryIndexArray{ SecondaryIndexArgs{...} }

type SecondaryIndexArrayOutput added in v3.29.0

type SecondaryIndexArrayOutput struct{ *pulumi.OutputState }

func (SecondaryIndexArrayOutput) ElementType added in v3.29.0

func (SecondaryIndexArrayOutput) ElementType() reflect.Type

func (SecondaryIndexArrayOutput) Index added in v3.29.0

func (SecondaryIndexArrayOutput) ToOutput added in v3.43.1

func (SecondaryIndexArrayOutput) ToSecondaryIndexArrayOutput added in v3.29.0

func (o SecondaryIndexArrayOutput) ToSecondaryIndexArrayOutput() SecondaryIndexArrayOutput

func (SecondaryIndexArrayOutput) ToSecondaryIndexArrayOutputWithContext added in v3.29.0

func (o SecondaryIndexArrayOutput) ToSecondaryIndexArrayOutputWithContext(ctx context.Context) SecondaryIndexArrayOutput

type SecondaryIndexInput added in v3.29.0

type SecondaryIndexInput interface {
	pulumi.Input

	ToSecondaryIndexOutput() SecondaryIndexOutput
	ToSecondaryIndexOutputWithContext(ctx context.Context) SecondaryIndexOutput
}

type SecondaryIndexMap added in v3.29.0

type SecondaryIndexMap map[string]SecondaryIndexInput

func (SecondaryIndexMap) ElementType added in v3.29.0

func (SecondaryIndexMap) ElementType() reflect.Type

func (SecondaryIndexMap) ToOutput added in v3.43.1

func (SecondaryIndexMap) ToSecondaryIndexMapOutput added in v3.29.0

func (i SecondaryIndexMap) ToSecondaryIndexMapOutput() SecondaryIndexMapOutput

func (SecondaryIndexMap) ToSecondaryIndexMapOutputWithContext added in v3.29.0

func (i SecondaryIndexMap) ToSecondaryIndexMapOutputWithContext(ctx context.Context) SecondaryIndexMapOutput

type SecondaryIndexMapInput added in v3.29.0

type SecondaryIndexMapInput interface {
	pulumi.Input

	ToSecondaryIndexMapOutput() SecondaryIndexMapOutput
	ToSecondaryIndexMapOutputWithContext(context.Context) SecondaryIndexMapOutput
}

SecondaryIndexMapInput is an input type that accepts SecondaryIndexMap and SecondaryIndexMapOutput values. You can construct a concrete instance of `SecondaryIndexMapInput` via:

SecondaryIndexMap{ "key": SecondaryIndexArgs{...} }

type SecondaryIndexMapOutput added in v3.29.0

type SecondaryIndexMapOutput struct{ *pulumi.OutputState }

func (SecondaryIndexMapOutput) ElementType added in v3.29.0

func (SecondaryIndexMapOutput) ElementType() reflect.Type

func (SecondaryIndexMapOutput) MapIndex added in v3.29.0

func (SecondaryIndexMapOutput) ToOutput added in v3.43.1

func (SecondaryIndexMapOutput) ToSecondaryIndexMapOutput added in v3.29.0

func (o SecondaryIndexMapOutput) ToSecondaryIndexMapOutput() SecondaryIndexMapOutput

func (SecondaryIndexMapOutput) ToSecondaryIndexMapOutputWithContext added in v3.29.0

func (o SecondaryIndexMapOutput) ToSecondaryIndexMapOutputWithContext(ctx context.Context) SecondaryIndexMapOutput

type SecondaryIndexOutput added in v3.29.0

type SecondaryIndexOutput struct{ *pulumi.OutputState }

func (SecondaryIndexOutput) DefinedColumns added in v3.29.0

func (o SecondaryIndexOutput) DefinedColumns() pulumi.StringArrayOutput

A list of defined column for index, referenced from Table's primary keys or predefined columns.

func (SecondaryIndexOutput) ElementType added in v3.29.0

func (SecondaryIndexOutput) ElementType() reflect.Type

func (SecondaryIndexOutput) IncludeBaseData added in v3.29.0

func (o SecondaryIndexOutput) IncludeBaseData() pulumi.BoolOutput

whether the index contains data that already exists in the data table. When includeBaseData is set to true, it means that stock data is included.

func (SecondaryIndexOutput) IndexName added in v3.29.0

The index name of the OTS Table. If changed, a new index would be created.

func (SecondaryIndexOutput) IndexType added in v3.29.0

The index type of the OTS Table. If changed, a new index would be created, only `Global` or `Local` is allowed.

func (SecondaryIndexOutput) InstanceName added in v3.29.0

func (o SecondaryIndexOutput) InstanceName() pulumi.StringOutput

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

func (SecondaryIndexOutput) PrimaryKeys added in v3.29.0

A list of primary keys for index, referenced from Table's primary keys or predefined columns.

func (SecondaryIndexOutput) TableName added in v3.29.0

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

func (SecondaryIndexOutput) ToOutput added in v3.43.1

func (SecondaryIndexOutput) ToSecondaryIndexOutput added in v3.29.0

func (o SecondaryIndexOutput) ToSecondaryIndexOutput() SecondaryIndexOutput

func (SecondaryIndexOutput) ToSecondaryIndexOutputWithContext added in v3.29.0

func (o SecondaryIndexOutput) ToSecondaryIndexOutputWithContext(ctx context.Context) SecondaryIndexOutput

type SecondaryIndexState added in v3.29.0

type SecondaryIndexState struct {
	// A list of defined column for index, referenced from Table's primary keys or predefined columns.
	DefinedColumns pulumi.StringArrayInput
	// whether the index contains data that already exists in the data table. When includeBaseData is set to true, it means that stock data is included.
	IncludeBaseData pulumi.BoolPtrInput
	// The index name of the OTS Table. If changed, a new index would be created.
	IndexName pulumi.StringPtrInput
	// The index type of the OTS Table. If changed, a new index would be created, only `Global` or `Local` is allowed.
	IndexType pulumi.StringPtrInput
	// The name of the OTS instance in which table will located.
	InstanceName pulumi.StringPtrInput
	// A list of primary keys for index, referenced from Table's primary keys or predefined columns.
	PrimaryKeys pulumi.StringArrayInput
	// The name of the OTS table. If changed, a new table would be created.
	TableName pulumi.StringPtrInput
}

func (SecondaryIndexState) ElementType added in v3.29.0

func (SecondaryIndexState) ElementType() reflect.Type

type Table

type Table struct {
	pulumi.CustomResourceState

	// The property of `TableMeta` which indicates the structure information of a table. It describes the attribute value of defined column. The number of `definedColumn` should not be more than 32.
	DefinedColumns TableDefinedColumnArrayOutput `pulumi:"definedColumns"`
	// The max version offset of the table. The valid value is 1-9223372036854775807. Defaults to 86400.
	DeviationCellVersionInSec pulumi.StringPtrOutput `pulumi:"deviationCellVersionInSec"`
	// Whether enable OTS server side encryption. Default value is false.
	EnableSse pulumi.BoolPtrOutput `pulumi:"enableSse"`
	// The name of the OTS instance in which table will located.
	InstanceName pulumi.StringOutput `pulumi:"instanceName"`
	// The maximum number of versions stored in this table. The valid value is 1-2147483647.
	MaxVersion pulumi.IntOutput `pulumi:"maxVersion"`
	// 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.
	PrimaryKeys TablePrimaryKeyArrayOutput `pulumi:"primaryKeys"`
	// The key type of OTS server side encryption. Only `SSE_KMS_SERVICE` is allowed.
	SseKeyType pulumi.StringPtrOutput `pulumi:"sseKeyType"`
	// The table name of the OTS instance. If changed, a new table would be created.
	TableName pulumi.StringOutput `pulumi:"tableName"`
	// The retention time of data stored in this table (unit: second). The value maximum is 2147483647 and -1 means never expired.
	TimeToLive pulumi.IntOutput `pulumi:"timeToLive"`
}

Provides an OTS table resource.

> **NOTE:** From Provider version 1.10.0, the provider field 'ots_instance_name' has been deprecated and you should use resource alicloud_ots_table's new field 'instance_name' and 'table_name' to re-import this resource.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ots"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "terraformtest"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		foo, err := ots.NewInstance(ctx, "foo", &ots.InstanceArgs{
			Description: pulumi.String(name),
			AccessedBy:  pulumi.String("Any"),
			Tags: pulumi.AnyMap{
				"Created": pulumi.Any("TF"),
				"For":     pulumi.Any("acceptance test"),
			},
		})
		if err != nil {
			return err
		}
		_, err = ots.NewTable(ctx, "basic", &ots.TableArgs{
			InstanceName: foo.Name,
			TableName:    pulumi.String(name),
			PrimaryKeys: ots.TablePrimaryKeyArray{
				&ots.TablePrimaryKeyArgs{
					Name: pulumi.String("pk1"),
					Type: pulumi.String("Integer"),
				},
				&ots.TablePrimaryKeyArgs{
					Name: pulumi.String("pk2"),
					Type: pulumi.String("String"),
				},
				&ots.TablePrimaryKeyArgs{
					Name: pulumi.String("pk3"),
					Type: pulumi.String("Binary"),
				},
			},
			DefinedColumns: ots.TableDefinedColumnArray{
				&ots.TableDefinedColumnArgs{
					Name: pulumi.String("col1"),
					Type: pulumi.String("Integer"),
				},
				&ots.TableDefinedColumnArgs{
					Name: pulumi.String("col2"),
					Type: pulumi.String("String"),
				},
				&ots.TableDefinedColumnArgs{
					Name: pulumi.String("col3"),
					Type: pulumi.String("Binary"),
				},
			},
			TimeToLive:                -1,
			MaxVersion:                pulumi.Int(1),
			DeviationCellVersionInSec: pulumi.String("1"),
			EnableSse:                 pulumi.Bool(true),
			SseKeyType:                pulumi.String("SSE_KMS_SERVICE"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

OTS table can be imported using id, e.g.

```sh

$ pulumi import alicloud:ots/table:Table table my-ots:ots_table

```

func GetTable

func GetTable(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *TableState, opts ...pulumi.ResourceOption) (*Table, error)

GetTable gets an existing Table resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewTable

func NewTable(ctx *pulumi.Context,
	name string, args *TableArgs, opts ...pulumi.ResourceOption) (*Table, error)

NewTable registers a new resource with the given unique name, arguments, and options.

func (*Table) ElementType

func (*Table) ElementType() reflect.Type

func (*Table) ToOutput added in v3.43.1

func (i *Table) ToOutput(ctx context.Context) pulumix.Output[*Table]

func (*Table) ToTableOutput

func (i *Table) ToTableOutput() TableOutput

func (*Table) ToTableOutputWithContext

func (i *Table) ToTableOutputWithContext(ctx context.Context) TableOutput

type TableArgs

type TableArgs struct {
	// The property of `TableMeta` which indicates the structure information of a table. It describes the attribute value of defined column. The number of `definedColumn` should not be more than 32.
	DefinedColumns TableDefinedColumnArrayInput
	// The max version offset of the table. The valid value is 1-9223372036854775807. Defaults to 86400.
	DeviationCellVersionInSec pulumi.StringPtrInput
	// Whether enable OTS server side encryption. Default value is false.
	EnableSse pulumi.BoolPtrInput
	// The name of the OTS instance in which table will located.
	InstanceName pulumi.StringInput
	// The maximum number of versions stored in this table. The valid value is 1-2147483647.
	MaxVersion pulumi.IntInput
	// 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.
	PrimaryKeys TablePrimaryKeyArrayInput
	// The key type of OTS server side encryption. Only `SSE_KMS_SERVICE` is allowed.
	SseKeyType pulumi.StringPtrInput
	// The table name of the OTS instance. If changed, a new table would be created.
	TableName pulumi.StringInput
	// The retention time of data stored in this table (unit: second). The value maximum is 2147483647 and -1 means never expired.
	TimeToLive pulumi.IntInput
}

The set of arguments for constructing a Table resource.

func (TableArgs) ElementType

func (TableArgs) ElementType() reflect.Type

type TableArray

type TableArray []TableInput

func (TableArray) ElementType

func (TableArray) ElementType() reflect.Type

func (TableArray) ToOutput added in v3.43.1

func (i TableArray) ToOutput(ctx context.Context) pulumix.Output[[]*Table]

func (TableArray) ToTableArrayOutput

func (i TableArray) ToTableArrayOutput() TableArrayOutput

func (TableArray) ToTableArrayOutputWithContext

func (i TableArray) ToTableArrayOutputWithContext(ctx context.Context) TableArrayOutput

type TableArrayInput

type TableArrayInput interface {
	pulumi.Input

	ToTableArrayOutput() TableArrayOutput
	ToTableArrayOutputWithContext(context.Context) TableArrayOutput
}

TableArrayInput is an input type that accepts TableArray and TableArrayOutput values. You can construct a concrete instance of `TableArrayInput` via:

TableArray{ TableArgs{...} }

type TableArrayOutput

type TableArrayOutput struct{ *pulumi.OutputState }

func (TableArrayOutput) ElementType

func (TableArrayOutput) ElementType() reflect.Type

func (TableArrayOutput) Index

func (TableArrayOutput) ToOutput added in v3.43.1

func (o TableArrayOutput) ToOutput(ctx context.Context) pulumix.Output[[]*Table]

func (TableArrayOutput) ToTableArrayOutput

func (o TableArrayOutput) ToTableArrayOutput() TableArrayOutput

func (TableArrayOutput) ToTableArrayOutputWithContext

func (o TableArrayOutput) ToTableArrayOutputWithContext(ctx context.Context) TableArrayOutput

type TableDefinedColumn added in v3.29.0

type TableDefinedColumn struct {
	// Name for defined column.
	Name string `pulumi:"name"`
	// Type for defined column. `Integer`, `String`, `Binary`, `Double`, `Boolean` is allowed.
	Type string `pulumi:"type"`
}

type TableDefinedColumnArgs added in v3.29.0

type TableDefinedColumnArgs struct {
	// Name for defined column.
	Name pulumi.StringInput `pulumi:"name"`
	// Type for defined column. `Integer`, `String`, `Binary`, `Double`, `Boolean` is allowed.
	Type pulumi.StringInput `pulumi:"type"`
}

func (TableDefinedColumnArgs) ElementType added in v3.29.0

func (TableDefinedColumnArgs) ElementType() reflect.Type

func (TableDefinedColumnArgs) ToOutput added in v3.43.1

func (TableDefinedColumnArgs) ToTableDefinedColumnOutput added in v3.29.0

func (i TableDefinedColumnArgs) ToTableDefinedColumnOutput() TableDefinedColumnOutput

func (TableDefinedColumnArgs) ToTableDefinedColumnOutputWithContext added in v3.29.0

func (i TableDefinedColumnArgs) ToTableDefinedColumnOutputWithContext(ctx context.Context) TableDefinedColumnOutput

type TableDefinedColumnArray added in v3.29.0

type TableDefinedColumnArray []TableDefinedColumnInput

func (TableDefinedColumnArray) ElementType added in v3.29.0

func (TableDefinedColumnArray) ElementType() reflect.Type

func (TableDefinedColumnArray) ToOutput added in v3.43.1

func (TableDefinedColumnArray) ToTableDefinedColumnArrayOutput added in v3.29.0

func (i TableDefinedColumnArray) ToTableDefinedColumnArrayOutput() TableDefinedColumnArrayOutput

func (TableDefinedColumnArray) ToTableDefinedColumnArrayOutputWithContext added in v3.29.0

func (i TableDefinedColumnArray) ToTableDefinedColumnArrayOutputWithContext(ctx context.Context) TableDefinedColumnArrayOutput

type TableDefinedColumnArrayInput added in v3.29.0

type TableDefinedColumnArrayInput interface {
	pulumi.Input

	ToTableDefinedColumnArrayOutput() TableDefinedColumnArrayOutput
	ToTableDefinedColumnArrayOutputWithContext(context.Context) TableDefinedColumnArrayOutput
}

TableDefinedColumnArrayInput is an input type that accepts TableDefinedColumnArray and TableDefinedColumnArrayOutput values. You can construct a concrete instance of `TableDefinedColumnArrayInput` via:

TableDefinedColumnArray{ TableDefinedColumnArgs{...} }

type TableDefinedColumnArrayOutput added in v3.29.0

type TableDefinedColumnArrayOutput struct{ *pulumi.OutputState }

func (TableDefinedColumnArrayOutput) ElementType added in v3.29.0

func (TableDefinedColumnArrayOutput) Index added in v3.29.0

func (TableDefinedColumnArrayOutput) ToOutput added in v3.43.1

func (TableDefinedColumnArrayOutput) ToTableDefinedColumnArrayOutput added in v3.29.0

func (o TableDefinedColumnArrayOutput) ToTableDefinedColumnArrayOutput() TableDefinedColumnArrayOutput

func (TableDefinedColumnArrayOutput) ToTableDefinedColumnArrayOutputWithContext added in v3.29.0

func (o TableDefinedColumnArrayOutput) ToTableDefinedColumnArrayOutputWithContext(ctx context.Context) TableDefinedColumnArrayOutput

type TableDefinedColumnInput added in v3.29.0

type TableDefinedColumnInput interface {
	pulumi.Input

	ToTableDefinedColumnOutput() TableDefinedColumnOutput
	ToTableDefinedColumnOutputWithContext(context.Context) TableDefinedColumnOutput
}

TableDefinedColumnInput is an input type that accepts TableDefinedColumnArgs and TableDefinedColumnOutput values. You can construct a concrete instance of `TableDefinedColumnInput` via:

TableDefinedColumnArgs{...}

type TableDefinedColumnOutput added in v3.29.0

type TableDefinedColumnOutput struct{ *pulumi.OutputState }

func (TableDefinedColumnOutput) ElementType added in v3.29.0

func (TableDefinedColumnOutput) ElementType() reflect.Type

func (TableDefinedColumnOutput) Name added in v3.29.0

Name for defined column.

func (TableDefinedColumnOutput) ToOutput added in v3.43.1

func (TableDefinedColumnOutput) ToTableDefinedColumnOutput added in v3.29.0

func (o TableDefinedColumnOutput) ToTableDefinedColumnOutput() TableDefinedColumnOutput

func (TableDefinedColumnOutput) ToTableDefinedColumnOutputWithContext added in v3.29.0

func (o TableDefinedColumnOutput) ToTableDefinedColumnOutputWithContext(ctx context.Context) TableDefinedColumnOutput

func (TableDefinedColumnOutput) Type added in v3.29.0

Type for defined column. `Integer`, `String`, `Binary`, `Double`, `Boolean` is allowed.

type TableInput

type TableInput interface {
	pulumi.Input

	ToTableOutput() TableOutput
	ToTableOutputWithContext(ctx context.Context) TableOutput
}

type TableMap

type TableMap map[string]TableInput

func (TableMap) ElementType

func (TableMap) ElementType() reflect.Type

func (TableMap) ToOutput added in v3.43.1

func (i TableMap) ToOutput(ctx context.Context) pulumix.Output[map[string]*Table]

func (TableMap) ToTableMapOutput

func (i TableMap) ToTableMapOutput() TableMapOutput

func (TableMap) ToTableMapOutputWithContext

func (i TableMap) ToTableMapOutputWithContext(ctx context.Context) TableMapOutput

type TableMapInput

type TableMapInput interface {
	pulumi.Input

	ToTableMapOutput() TableMapOutput
	ToTableMapOutputWithContext(context.Context) TableMapOutput
}

TableMapInput is an input type that accepts TableMap and TableMapOutput values. You can construct a concrete instance of `TableMapInput` via:

TableMap{ "key": TableArgs{...} }

type TableMapOutput

type TableMapOutput struct{ *pulumi.OutputState }

func (TableMapOutput) ElementType

func (TableMapOutput) ElementType() reflect.Type

func (TableMapOutput) MapIndex

func (TableMapOutput) ToOutput added in v3.43.1

func (o TableMapOutput) ToOutput(ctx context.Context) pulumix.Output[map[string]*Table]

func (TableMapOutput) ToTableMapOutput

func (o TableMapOutput) ToTableMapOutput() TableMapOutput

func (TableMapOutput) ToTableMapOutputWithContext

func (o TableMapOutput) ToTableMapOutputWithContext(ctx context.Context) TableMapOutput

type TableOutput

type TableOutput struct{ *pulumi.OutputState }

func (TableOutput) DefinedColumns added in v3.29.0

func (o TableOutput) DefinedColumns() TableDefinedColumnArrayOutput

The property of `TableMeta` which indicates the structure information of a table. It describes the attribute value of defined column. The number of `definedColumn` should not be more than 32.

func (TableOutput) DeviationCellVersionInSec added in v3.27.0

func (o TableOutput) DeviationCellVersionInSec() pulumi.StringPtrOutput

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

func (TableOutput) ElementType

func (TableOutput) ElementType() reflect.Type

func (TableOutput) EnableSse added in v3.27.0

func (o TableOutput) EnableSse() pulumi.BoolPtrOutput

Whether enable OTS server side encryption. Default value is false.

func (TableOutput) InstanceName added in v3.27.0

func (o TableOutput) InstanceName() pulumi.StringOutput

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

func (TableOutput) MaxVersion added in v3.27.0

func (o TableOutput) MaxVersion() pulumi.IntOutput

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

func (TableOutput) PrimaryKeys added in v3.27.0

func (o TableOutput) PrimaryKeys() TablePrimaryKeyArrayOutput

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.

func (TableOutput) SseKeyType added in v3.27.0

func (o TableOutput) SseKeyType() pulumi.StringPtrOutput

The key type of OTS server side encryption. Only `SSE_KMS_SERVICE` is allowed.

func (TableOutput) TableName added in v3.27.0

func (o TableOutput) TableName() pulumi.StringOutput

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

func (TableOutput) TimeToLive added in v3.27.0

func (o TableOutput) TimeToLive() pulumi.IntOutput

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

func (TableOutput) ToOutput added in v3.43.1

func (o TableOutput) ToOutput(ctx context.Context) pulumix.Output[*Table]

func (TableOutput) ToTableOutput

func (o TableOutput) ToTableOutput() TableOutput

func (TableOutput) ToTableOutputWithContext

func (o TableOutput) ToTableOutputWithContext(ctx context.Context) TableOutput

type TablePrimaryKey

type TablePrimaryKey struct {
	// Name for defined column.
	Name string `pulumi:"name"`
	// Type for defined column. `Integer`, `String`, `Binary`, `Double`, `Boolean` is allowed.
	Type string `pulumi:"type"`
}

type TablePrimaryKeyArgs

type TablePrimaryKeyArgs struct {
	// Name for defined column.
	Name pulumi.StringInput `pulumi:"name"`
	// Type for defined column. `Integer`, `String`, `Binary`, `Double`, `Boolean` is allowed.
	Type pulumi.StringInput `pulumi:"type"`
}

func (TablePrimaryKeyArgs) ElementType

func (TablePrimaryKeyArgs) ElementType() reflect.Type

func (TablePrimaryKeyArgs) ToOutput added in v3.43.1

func (TablePrimaryKeyArgs) ToTablePrimaryKeyOutput

func (i TablePrimaryKeyArgs) ToTablePrimaryKeyOutput() TablePrimaryKeyOutput

func (TablePrimaryKeyArgs) ToTablePrimaryKeyOutputWithContext

func (i TablePrimaryKeyArgs) ToTablePrimaryKeyOutputWithContext(ctx context.Context) TablePrimaryKeyOutput

type TablePrimaryKeyArray

type TablePrimaryKeyArray []TablePrimaryKeyInput

func (TablePrimaryKeyArray) ElementType

func (TablePrimaryKeyArray) ElementType() reflect.Type

func (TablePrimaryKeyArray) ToOutput added in v3.43.1

func (TablePrimaryKeyArray) ToTablePrimaryKeyArrayOutput

func (i TablePrimaryKeyArray) ToTablePrimaryKeyArrayOutput() TablePrimaryKeyArrayOutput

func (TablePrimaryKeyArray) ToTablePrimaryKeyArrayOutputWithContext

func (i TablePrimaryKeyArray) ToTablePrimaryKeyArrayOutputWithContext(ctx context.Context) TablePrimaryKeyArrayOutput

type TablePrimaryKeyArrayInput

type TablePrimaryKeyArrayInput interface {
	pulumi.Input

	ToTablePrimaryKeyArrayOutput() TablePrimaryKeyArrayOutput
	ToTablePrimaryKeyArrayOutputWithContext(context.Context) TablePrimaryKeyArrayOutput
}

TablePrimaryKeyArrayInput is an input type that accepts TablePrimaryKeyArray and TablePrimaryKeyArrayOutput values. You can construct a concrete instance of `TablePrimaryKeyArrayInput` via:

TablePrimaryKeyArray{ TablePrimaryKeyArgs{...} }

type TablePrimaryKeyArrayOutput

type TablePrimaryKeyArrayOutput struct{ *pulumi.OutputState }

func (TablePrimaryKeyArrayOutput) ElementType

func (TablePrimaryKeyArrayOutput) ElementType() reflect.Type

func (TablePrimaryKeyArrayOutput) Index

func (TablePrimaryKeyArrayOutput) ToOutput added in v3.43.1

func (TablePrimaryKeyArrayOutput) ToTablePrimaryKeyArrayOutput

func (o TablePrimaryKeyArrayOutput) ToTablePrimaryKeyArrayOutput() TablePrimaryKeyArrayOutput

func (TablePrimaryKeyArrayOutput) ToTablePrimaryKeyArrayOutputWithContext

func (o TablePrimaryKeyArrayOutput) ToTablePrimaryKeyArrayOutputWithContext(ctx context.Context) TablePrimaryKeyArrayOutput

type TablePrimaryKeyInput

type TablePrimaryKeyInput interface {
	pulumi.Input

	ToTablePrimaryKeyOutput() TablePrimaryKeyOutput
	ToTablePrimaryKeyOutputWithContext(context.Context) TablePrimaryKeyOutput
}

TablePrimaryKeyInput is an input type that accepts TablePrimaryKeyArgs and TablePrimaryKeyOutput values. You can construct a concrete instance of `TablePrimaryKeyInput` via:

TablePrimaryKeyArgs{...}

type TablePrimaryKeyOutput

type TablePrimaryKeyOutput struct{ *pulumi.OutputState }

func (TablePrimaryKeyOutput) ElementType

func (TablePrimaryKeyOutput) ElementType() reflect.Type

func (TablePrimaryKeyOutput) Name

Name for defined column.

func (TablePrimaryKeyOutput) ToOutput added in v3.43.1

func (TablePrimaryKeyOutput) ToTablePrimaryKeyOutput

func (o TablePrimaryKeyOutput) ToTablePrimaryKeyOutput() TablePrimaryKeyOutput

func (TablePrimaryKeyOutput) ToTablePrimaryKeyOutputWithContext

func (o TablePrimaryKeyOutput) ToTablePrimaryKeyOutputWithContext(ctx context.Context) TablePrimaryKeyOutput

func (TablePrimaryKeyOutput) Type

Type for defined column. `Integer`, `String`, `Binary`, `Double`, `Boolean` is allowed.

type TableState

type TableState struct {
	// The property of `TableMeta` which indicates the structure information of a table. It describes the attribute value of defined column. The number of `definedColumn` should not be more than 32.
	DefinedColumns TableDefinedColumnArrayInput
	// The max version offset of the table. The valid value is 1-9223372036854775807. Defaults to 86400.
	DeviationCellVersionInSec pulumi.StringPtrInput
	// Whether enable OTS server side encryption. Default value is false.
	EnableSse pulumi.BoolPtrInput
	// The name of the OTS instance in which table will located.
	InstanceName pulumi.StringPtrInput
	// The maximum number of versions stored in this table. The valid value is 1-2147483647.
	MaxVersion pulumi.IntPtrInput
	// 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.
	PrimaryKeys TablePrimaryKeyArrayInput
	// The key type of OTS server side encryption. Only `SSE_KMS_SERVICE` is allowed.
	SseKeyType pulumi.StringPtrInput
	// The table name of the OTS instance. If changed, a new table would be created.
	TableName pulumi.StringPtrInput
	// The retention time of data stored in this table (unit: second). The value maximum is 2147483647 and -1 means never expired.
	TimeToLive pulumi.IntPtrInput
}

func (TableState) ElementType

func (TableState) ElementType() reflect.Type

type Tunnel added in v3.22.0

type Tunnel struct {
	pulumi.CustomResourceState

	// The channels of OTS tunnel. Each element contains the following attributes:
	Channels TunnelChannelArrayOutput `pulumi:"channels"`
	// The creation time of the Tunnel.
	CreateTime pulumi.IntOutput `pulumi:"createTime"`
	// Whether the tunnel has expired.
	Expired pulumi.BoolOutput `pulumi:"expired"`
	// The name of the OTS instance in which table will located.
	InstanceName pulumi.StringOutput `pulumi:"instanceName"`
	// The name of the OTS table. If changed, a new table would be created.
	TableName pulumi.StringOutput `pulumi:"tableName"`
	// The tunnel id of the OTS which could not be changed.
	TunnelId pulumi.StringOutput `pulumi:"tunnelId"`
	// The name of the OTS tunnel. If changed, a new tunnel would be created.
	TunnelName pulumi.StringOutput `pulumi:"tunnelName"`
	// The latest consumption time of the tunnel, unix time in nanosecond.
	TunnelRpo pulumi.IntOutput `pulumi:"tunnelRpo"`
	// The stage of OTS tunnel, valid values: `InitBaseDataAndStreamShard`, `ProcessBaseData`, `ProcessStream`.
	TunnelStage pulumi.StringOutput `pulumi:"tunnelStage"`
	// The type of the OTS tunnel. Only `BaseAndStream`, `BaseData` or `Stream` is allowed.
	TunnelType pulumi.StringOutput `pulumi:"tunnelType"`
}

Provides an OTS tunnel resource.

For information about OTS tunnel and how to use it, see [Tunnel overview](https://www.alibabacloud.com/help/en/tablestore/latest/tunnel-service-overview).

> **NOTE:** Available in v1.172.0+.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ots"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "terraformtest"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		fooInstance, err := ots.NewInstance(ctx, "fooInstance", &ots.InstanceArgs{
			Description: pulumi.String(name),
			AccessedBy:  pulumi.String("Any"),
			Tags: pulumi.AnyMap{
				"Created": pulumi.Any("TF"),
				"For":     pulumi.Any("acceptance test"),
			},
		})
		if err != nil {
			return err
		}
		fooTable, err := ots.NewTable(ctx, "fooTable", &ots.TableArgs{
			InstanceName: fooInstance.Name,
			TableName:    pulumi.String(name),
			PrimaryKeys: ots.TablePrimaryKeyArray{
				&ots.TablePrimaryKeyArgs{
					Name: pulumi.String("pk1"),
					Type: pulumi.String("Integer"),
				},
				&ots.TablePrimaryKeyArgs{
					Name: pulumi.String("pk2"),
					Type: pulumi.String("String"),
				},
				&ots.TablePrimaryKeyArgs{
					Name: pulumi.String("pk3"),
					Type: pulumi.String("Binary"),
				},
			},
			TimeToLive:                -1,
			MaxVersion:                pulumi.Int(1),
			DeviationCellVersionInSec: pulumi.String("1"),
		})
		if err != nil {
			return err
		}
		_, err = ots.NewTunnel(ctx, "fooTunnel", &ots.TunnelArgs{
			InstanceName: fooInstance.Name,
			TableName:    fooTable.TableName,
			TunnelName:   pulumi.String(name),
			TunnelType:   pulumi.String("BaseAndStream"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

OTS tunnel can be imported using id, e.g.

```sh

$ pulumi import alicloud:ots/tunnel:Tunnel foo <instance_name>:<table_name>:<tunnel_name>

```

func GetTunnel added in v3.22.0

func GetTunnel(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *TunnelState, opts ...pulumi.ResourceOption) (*Tunnel, error)

GetTunnel gets an existing Tunnel resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewTunnel added in v3.22.0

func NewTunnel(ctx *pulumi.Context,
	name string, args *TunnelArgs, opts ...pulumi.ResourceOption) (*Tunnel, error)

NewTunnel registers a new resource with the given unique name, arguments, and options.

func (*Tunnel) ElementType added in v3.22.0

func (*Tunnel) ElementType() reflect.Type

func (*Tunnel) ToOutput added in v3.43.1

func (i *Tunnel) ToOutput(ctx context.Context) pulumix.Output[*Tunnel]

func (*Tunnel) ToTunnelOutput added in v3.22.0

func (i *Tunnel) ToTunnelOutput() TunnelOutput

func (*Tunnel) ToTunnelOutputWithContext added in v3.22.0

func (i *Tunnel) ToTunnelOutputWithContext(ctx context.Context) TunnelOutput

type TunnelArgs added in v3.22.0

type TunnelArgs struct {
	// The name of the OTS instance in which table will located.
	InstanceName pulumi.StringInput
	// The name of the OTS table. If changed, a new table would be created.
	TableName pulumi.StringInput
	// The name of the OTS tunnel. If changed, a new tunnel would be created.
	TunnelName pulumi.StringInput
	// The type of the OTS tunnel. Only `BaseAndStream`, `BaseData` or `Stream` is allowed.
	TunnelType pulumi.StringInput
}

The set of arguments for constructing a Tunnel resource.

func (TunnelArgs) ElementType added in v3.22.0

func (TunnelArgs) ElementType() reflect.Type

type TunnelArray added in v3.22.0

type TunnelArray []TunnelInput

func (TunnelArray) ElementType added in v3.22.0

func (TunnelArray) ElementType() reflect.Type

func (TunnelArray) ToOutput added in v3.43.1

func (i TunnelArray) ToOutput(ctx context.Context) pulumix.Output[[]*Tunnel]

func (TunnelArray) ToTunnelArrayOutput added in v3.22.0

func (i TunnelArray) ToTunnelArrayOutput() TunnelArrayOutput

func (TunnelArray) ToTunnelArrayOutputWithContext added in v3.22.0

func (i TunnelArray) ToTunnelArrayOutputWithContext(ctx context.Context) TunnelArrayOutput

type TunnelArrayInput added in v3.22.0

type TunnelArrayInput interface {
	pulumi.Input

	ToTunnelArrayOutput() TunnelArrayOutput
	ToTunnelArrayOutputWithContext(context.Context) TunnelArrayOutput
}

TunnelArrayInput is an input type that accepts TunnelArray and TunnelArrayOutput values. You can construct a concrete instance of `TunnelArrayInput` via:

TunnelArray{ TunnelArgs{...} }

type TunnelArrayOutput added in v3.22.0

type TunnelArrayOutput struct{ *pulumi.OutputState }

func (TunnelArrayOutput) ElementType added in v3.22.0

func (TunnelArrayOutput) ElementType() reflect.Type

func (TunnelArrayOutput) Index added in v3.22.0

func (TunnelArrayOutput) ToOutput added in v3.43.1

func (o TunnelArrayOutput) ToOutput(ctx context.Context) pulumix.Output[[]*Tunnel]

func (TunnelArrayOutput) ToTunnelArrayOutput added in v3.22.0

func (o TunnelArrayOutput) ToTunnelArrayOutput() TunnelArrayOutput

func (TunnelArrayOutput) ToTunnelArrayOutputWithContext added in v3.22.0

func (o TunnelArrayOutput) ToTunnelArrayOutputWithContext(ctx context.Context) TunnelArrayOutput

type TunnelChannel added in v3.22.0

type TunnelChannel struct {
	// The id of the channel.
	ChannelId *string `pulumi:"channelId"`
	// The latest consumption time of the channel, unix time in nanosecond.
	ChannelRpo *int `pulumi:"channelRpo"`
	// The status of the channel, valid values: `WAIT`, `OPEN`, `CLOSING`, `CLOSE`, `TERMINATED`.
	ChannelStatus *string `pulumi:"channelStatus"`
	// The type of the channel, valid values: `BaseData`, `Stream`.
	ChannelType *string `pulumi:"channelType"`
	// The client id of the channel.
	ClientId *string `pulumi:"clientId"`
}

type TunnelChannelArgs added in v3.22.0

type TunnelChannelArgs struct {
	// The id of the channel.
	ChannelId pulumi.StringPtrInput `pulumi:"channelId"`
	// The latest consumption time of the channel, unix time in nanosecond.
	ChannelRpo pulumi.IntPtrInput `pulumi:"channelRpo"`
	// The status of the channel, valid values: `WAIT`, `OPEN`, `CLOSING`, `CLOSE`, `TERMINATED`.
	ChannelStatus pulumi.StringPtrInput `pulumi:"channelStatus"`
	// The type of the channel, valid values: `BaseData`, `Stream`.
	ChannelType pulumi.StringPtrInput `pulumi:"channelType"`
	// The client id of the channel.
	ClientId pulumi.StringPtrInput `pulumi:"clientId"`
}

func (TunnelChannelArgs) ElementType added in v3.22.0

func (TunnelChannelArgs) ElementType() reflect.Type

func (TunnelChannelArgs) ToOutput added in v3.43.1

func (TunnelChannelArgs) ToTunnelChannelOutput added in v3.22.0

func (i TunnelChannelArgs) ToTunnelChannelOutput() TunnelChannelOutput

func (TunnelChannelArgs) ToTunnelChannelOutputWithContext added in v3.22.0

func (i TunnelChannelArgs) ToTunnelChannelOutputWithContext(ctx context.Context) TunnelChannelOutput

type TunnelChannelArray added in v3.22.0

type TunnelChannelArray []TunnelChannelInput

func (TunnelChannelArray) ElementType added in v3.22.0

func (TunnelChannelArray) ElementType() reflect.Type

func (TunnelChannelArray) ToOutput added in v3.43.1

func (TunnelChannelArray) ToTunnelChannelArrayOutput added in v3.22.0

func (i TunnelChannelArray) ToTunnelChannelArrayOutput() TunnelChannelArrayOutput

func (TunnelChannelArray) ToTunnelChannelArrayOutputWithContext added in v3.22.0

func (i TunnelChannelArray) ToTunnelChannelArrayOutputWithContext(ctx context.Context) TunnelChannelArrayOutput

type TunnelChannelArrayInput added in v3.22.0

type TunnelChannelArrayInput interface {
	pulumi.Input

	ToTunnelChannelArrayOutput() TunnelChannelArrayOutput
	ToTunnelChannelArrayOutputWithContext(context.Context) TunnelChannelArrayOutput
}

TunnelChannelArrayInput is an input type that accepts TunnelChannelArray and TunnelChannelArrayOutput values. You can construct a concrete instance of `TunnelChannelArrayInput` via:

TunnelChannelArray{ TunnelChannelArgs{...} }

type TunnelChannelArrayOutput added in v3.22.0

type TunnelChannelArrayOutput struct{ *pulumi.OutputState }

func (TunnelChannelArrayOutput) ElementType added in v3.22.0

func (TunnelChannelArrayOutput) ElementType() reflect.Type

func (TunnelChannelArrayOutput) Index added in v3.22.0

func (TunnelChannelArrayOutput) ToOutput added in v3.43.1

func (TunnelChannelArrayOutput) ToTunnelChannelArrayOutput added in v3.22.0

func (o TunnelChannelArrayOutput) ToTunnelChannelArrayOutput() TunnelChannelArrayOutput

func (TunnelChannelArrayOutput) ToTunnelChannelArrayOutputWithContext added in v3.22.0

func (o TunnelChannelArrayOutput) ToTunnelChannelArrayOutputWithContext(ctx context.Context) TunnelChannelArrayOutput

type TunnelChannelInput added in v3.22.0

type TunnelChannelInput interface {
	pulumi.Input

	ToTunnelChannelOutput() TunnelChannelOutput
	ToTunnelChannelOutputWithContext(context.Context) TunnelChannelOutput
}

TunnelChannelInput is an input type that accepts TunnelChannelArgs and TunnelChannelOutput values. You can construct a concrete instance of `TunnelChannelInput` via:

TunnelChannelArgs{...}

type TunnelChannelOutput added in v3.22.0

type TunnelChannelOutput struct{ *pulumi.OutputState }

func (TunnelChannelOutput) ChannelId added in v3.22.0

The id of the channel.

func (TunnelChannelOutput) ChannelRpo added in v3.22.0

func (o TunnelChannelOutput) ChannelRpo() pulumi.IntPtrOutput

The latest consumption time of the channel, unix time in nanosecond.

func (TunnelChannelOutput) ChannelStatus added in v3.22.0

func (o TunnelChannelOutput) ChannelStatus() pulumi.StringPtrOutput

The status of the channel, valid values: `WAIT`, `OPEN`, `CLOSING`, `CLOSE`, `TERMINATED`.

func (TunnelChannelOutput) ChannelType added in v3.22.0

func (o TunnelChannelOutput) ChannelType() pulumi.StringPtrOutput

The type of the channel, valid values: `BaseData`, `Stream`.

func (TunnelChannelOutput) ClientId added in v3.22.0

The client id of the channel.

func (TunnelChannelOutput) ElementType added in v3.22.0

func (TunnelChannelOutput) ElementType() reflect.Type

func (TunnelChannelOutput) ToOutput added in v3.43.1

func (TunnelChannelOutput) ToTunnelChannelOutput added in v3.22.0

func (o TunnelChannelOutput) ToTunnelChannelOutput() TunnelChannelOutput

func (TunnelChannelOutput) ToTunnelChannelOutputWithContext added in v3.22.0

func (o TunnelChannelOutput) ToTunnelChannelOutputWithContext(ctx context.Context) TunnelChannelOutput

type TunnelInput added in v3.22.0

type TunnelInput interface {
	pulumi.Input

	ToTunnelOutput() TunnelOutput
	ToTunnelOutputWithContext(ctx context.Context) TunnelOutput
}

type TunnelMap added in v3.22.0

type TunnelMap map[string]TunnelInput

func (TunnelMap) ElementType added in v3.22.0

func (TunnelMap) ElementType() reflect.Type

func (TunnelMap) ToOutput added in v3.43.1

func (i TunnelMap) ToOutput(ctx context.Context) pulumix.Output[map[string]*Tunnel]

func (TunnelMap) ToTunnelMapOutput added in v3.22.0

func (i TunnelMap) ToTunnelMapOutput() TunnelMapOutput

func (TunnelMap) ToTunnelMapOutputWithContext added in v3.22.0

func (i TunnelMap) ToTunnelMapOutputWithContext(ctx context.Context) TunnelMapOutput

type TunnelMapInput added in v3.22.0

type TunnelMapInput interface {
	pulumi.Input

	ToTunnelMapOutput() TunnelMapOutput
	ToTunnelMapOutputWithContext(context.Context) TunnelMapOutput
}

TunnelMapInput is an input type that accepts TunnelMap and TunnelMapOutput values. You can construct a concrete instance of `TunnelMapInput` via:

TunnelMap{ "key": TunnelArgs{...} }

type TunnelMapOutput added in v3.22.0

type TunnelMapOutput struct{ *pulumi.OutputState }

func (TunnelMapOutput) ElementType added in v3.22.0

func (TunnelMapOutput) ElementType() reflect.Type

func (TunnelMapOutput) MapIndex added in v3.22.0

func (TunnelMapOutput) ToOutput added in v3.43.1

func (o TunnelMapOutput) ToOutput(ctx context.Context) pulumix.Output[map[string]*Tunnel]

func (TunnelMapOutput) ToTunnelMapOutput added in v3.22.0

func (o TunnelMapOutput) ToTunnelMapOutput() TunnelMapOutput

func (TunnelMapOutput) ToTunnelMapOutputWithContext added in v3.22.0

func (o TunnelMapOutput) ToTunnelMapOutputWithContext(ctx context.Context) TunnelMapOutput

type TunnelOutput added in v3.22.0

type TunnelOutput struct{ *pulumi.OutputState }

func (TunnelOutput) Channels added in v3.27.0

The channels of OTS tunnel. Each element contains the following attributes:

func (TunnelOutput) CreateTime added in v3.27.0

func (o TunnelOutput) CreateTime() pulumi.IntOutput

The creation time of the Tunnel.

func (TunnelOutput) ElementType added in v3.22.0

func (TunnelOutput) ElementType() reflect.Type

func (TunnelOutput) Expired added in v3.27.0

func (o TunnelOutput) Expired() pulumi.BoolOutput

Whether the tunnel has expired.

func (TunnelOutput) InstanceName added in v3.27.0

func (o TunnelOutput) InstanceName() pulumi.StringOutput

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

func (TunnelOutput) TableName added in v3.27.0

func (o TunnelOutput) TableName() pulumi.StringOutput

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

func (TunnelOutput) ToOutput added in v3.43.1

func (o TunnelOutput) ToOutput(ctx context.Context) pulumix.Output[*Tunnel]

func (TunnelOutput) ToTunnelOutput added in v3.22.0

func (o TunnelOutput) ToTunnelOutput() TunnelOutput

func (TunnelOutput) ToTunnelOutputWithContext added in v3.22.0

func (o TunnelOutput) ToTunnelOutputWithContext(ctx context.Context) TunnelOutput

func (TunnelOutput) TunnelId added in v3.27.0

func (o TunnelOutput) TunnelId() pulumi.StringOutput

The tunnel id of the OTS which could not be changed.

func (TunnelOutput) TunnelName added in v3.27.0

func (o TunnelOutput) TunnelName() pulumi.StringOutput

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

func (TunnelOutput) TunnelRpo added in v3.27.0

func (o TunnelOutput) TunnelRpo() pulumi.IntOutput

The latest consumption time of the tunnel, unix time in nanosecond.

func (TunnelOutput) TunnelStage added in v3.27.0

func (o TunnelOutput) TunnelStage() pulumi.StringOutput

The stage of OTS tunnel, valid values: `InitBaseDataAndStreamShard`, `ProcessBaseData`, `ProcessStream`.

func (TunnelOutput) TunnelType added in v3.27.0

func (o TunnelOutput) TunnelType() pulumi.StringOutput

The type of the OTS tunnel. Only `BaseAndStream`, `BaseData` or `Stream` is allowed.

type TunnelState added in v3.22.0

type TunnelState struct {
	// The channels of OTS tunnel. Each element contains the following attributes:
	Channels TunnelChannelArrayInput
	// The creation time of the Tunnel.
	CreateTime pulumi.IntPtrInput
	// Whether the tunnel has expired.
	Expired pulumi.BoolPtrInput
	// The name of the OTS instance in which table will located.
	InstanceName pulumi.StringPtrInput
	// The name of the OTS table. If changed, a new table would be created.
	TableName pulumi.StringPtrInput
	// The tunnel id of the OTS which could not be changed.
	TunnelId pulumi.StringPtrInput
	// The name of the OTS tunnel. If changed, a new tunnel would be created.
	TunnelName pulumi.StringPtrInput
	// The latest consumption time of the tunnel, unix time in nanosecond.
	TunnelRpo pulumi.IntPtrInput
	// The stage of OTS tunnel, valid values: `InitBaseDataAndStreamShard`, `ProcessBaseData`, `ProcessStream`.
	TunnelStage pulumi.StringPtrInput
	// The type of the OTS tunnel. Only `BaseAndStream`, `BaseData` or `Stream` is allowed.
	TunnelType pulumi.StringPtrInput
}

func (TunnelState) ElementType added in v3.22.0

func (TunnelState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL