@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
212 lines (211 loc) • 8.45 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides a Timestream table resource.
*
* ## Example Usage
*
* ### Basic usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.timestreamwrite.Table("example", {
* databaseName: exampleAwsTimestreamwriteDatabase.databaseName,
* tableName: "example",
* });
* ```
*
* ### Full usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.timestreamwrite.Table("example", {
* databaseName: exampleAwsTimestreamwriteDatabase.databaseName,
* tableName: "example",
* retentionProperties: {
* magneticStoreRetentionPeriodInDays: 30,
* memoryStoreRetentionPeriodInHours: 8,
* },
* tags: {
* Name: "example-timestream-table",
* },
* });
* ```
*
* ### Customer-defined Partition Key
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.timestreamwrite.Table("example", {
* databaseName: exampleAwsTimestreamwriteDatabase.databaseName,
* tableName: "example",
* schema: {
* compositePartitionKey: {
* enforcementInRecord: "REQUIRED",
* name: "attr1",
* type: "DIMENSION",
* },
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import Timestream tables using the `table_name` and `database_name` separate by a colon (`:`). For example:
*
* ```sh
* $ pulumi import aws:timestreamwrite/table:Table example ExampleTable:ExampleDatabase
* ```
*/
export declare class Table extends pulumi.CustomResource {
/**
* Get an existing Table resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TableState, opts?: pulumi.CustomResourceOptions): Table;
/**
* Returns true if the given object is an instance of Table. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Table;
/**
* The ARN that uniquely identifies this table.
*/
readonly arn: pulumi.Output<string>;
/**
* The name of the Timestream database.
*/
readonly databaseName: pulumi.Output<string>;
/**
* Contains properties to set on the table when enabling magnetic store writes. See Magnetic Store Write Properties below for more details.
*/
readonly magneticStoreWriteProperties: pulumi.Output<outputs.timestreamwrite.TableMagneticStoreWriteProperties>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* The retention duration for the memory store and magnetic store. See Retention Properties below for more details. If not provided, `magneticStoreRetentionPeriodInDays` default to 73000 and `memoryStoreRetentionPeriodInHours` defaults to 6.
*/
readonly retentionProperties: pulumi.Output<outputs.timestreamwrite.TableRetentionProperties>;
/**
* The schema of the table. See Schema below for more details.
*/
readonly schema: pulumi.Output<outputs.timestreamwrite.TableSchema>;
/**
* The name of the Timestream table.
*/
readonly tableName: pulumi.Output<string>;
/**
* Map of tags to assign to this resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a Table resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: TableArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Table resources.
*/
export interface TableState {
/**
* The ARN that uniquely identifies this table.
*/
arn?: pulumi.Input<string>;
/**
* The name of the Timestream database.
*/
databaseName?: pulumi.Input<string>;
/**
* Contains properties to set on the table when enabling magnetic store writes. See Magnetic Store Write Properties below for more details.
*/
magneticStoreWriteProperties?: pulumi.Input<inputs.timestreamwrite.TableMagneticStoreWriteProperties>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* The retention duration for the memory store and magnetic store. See Retention Properties below for more details. If not provided, `magneticStoreRetentionPeriodInDays` default to 73000 and `memoryStoreRetentionPeriodInHours` defaults to 6.
*/
retentionProperties?: pulumi.Input<inputs.timestreamwrite.TableRetentionProperties>;
/**
* The schema of the table. See Schema below for more details.
*/
schema?: pulumi.Input<inputs.timestreamwrite.TableSchema>;
/**
* The name of the Timestream table.
*/
tableName?: pulumi.Input<string>;
/**
* Map of tags to assign to this resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a Table resource.
*/
export interface TableArgs {
/**
* The name of the Timestream database.
*/
databaseName: pulumi.Input<string>;
/**
* Contains properties to set on the table when enabling magnetic store writes. See Magnetic Store Write Properties below for more details.
*/
magneticStoreWriteProperties?: pulumi.Input<inputs.timestreamwrite.TableMagneticStoreWriteProperties>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* The retention duration for the memory store and magnetic store. See Retention Properties below for more details. If not provided, `magneticStoreRetentionPeriodInDays` default to 73000 and `memoryStoreRetentionPeriodInHours` defaults to 6.
*/
retentionProperties?: pulumi.Input<inputs.timestreamwrite.TableRetentionProperties>;
/**
* The schema of the table. See Schema below for more details.
*/
schema?: pulumi.Input<inputs.timestreamwrite.TableSchema>;
/**
* The name of the Timestream table.
*/
tableName: pulumi.Input<string>;
/**
* Map of tags to assign to this resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}