1. Packages
  2. AWS Classic
  3. API Docs
  4. keyspaces
  5. Table

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.30.0 published on Thursday, Apr 11, 2024 by Pulumi

aws.keyspaces.Table

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.30.0 published on Thursday, Apr 11, 2024 by Pulumi

    Provides a Keyspaces Table.

    More information about Keyspaces tables can be found in the Keyspaces Developer Guide.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.keyspaces.Table("example", {
        keyspaceName: exampleAwsKeyspacesKeyspace.name,
        tableName: "my_table",
        schemaDefinition: {
            columns: [{
                name: "Message",
                type: "ASCII",
            }],
            partitionKeys: [{
                name: "Message",
            }],
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.keyspaces.Table("example",
        keyspace_name=example_aws_keyspaces_keyspace["name"],
        table_name="my_table",
        schema_definition=aws.keyspaces.TableSchemaDefinitionArgs(
            columns=[aws.keyspaces.TableSchemaDefinitionColumnArgs(
                name="Message",
                type="ASCII",
            )],
            partition_keys=[aws.keyspaces.TableSchemaDefinitionPartitionKeyArgs(
                name="Message",
            )],
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/keyspaces"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := keyspaces.NewTable(ctx, "example", &keyspaces.TableArgs{
    			KeyspaceName: pulumi.Any(exampleAwsKeyspacesKeyspace.Name),
    			TableName:    pulumi.String("my_table"),
    			SchemaDefinition: &keyspaces.TableSchemaDefinitionArgs{
    				Columns: keyspaces.TableSchemaDefinitionColumnArray{
    					&keyspaces.TableSchemaDefinitionColumnArgs{
    						Name: pulumi.String("Message"),
    						Type: pulumi.String("ASCII"),
    					},
    				},
    				PartitionKeys: keyspaces.TableSchemaDefinitionPartitionKeyArray{
    					&keyspaces.TableSchemaDefinitionPartitionKeyArgs{
    						Name: pulumi.String("Message"),
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Keyspaces.Table("example", new()
        {
            KeyspaceName = exampleAwsKeyspacesKeyspace.Name,
            TableName = "my_table",
            SchemaDefinition = new Aws.Keyspaces.Inputs.TableSchemaDefinitionArgs
            {
                Columns = new[]
                {
                    new Aws.Keyspaces.Inputs.TableSchemaDefinitionColumnArgs
                    {
                        Name = "Message",
                        Type = "ASCII",
                    },
                },
                PartitionKeys = new[]
                {
                    new Aws.Keyspaces.Inputs.TableSchemaDefinitionPartitionKeyArgs
                    {
                        Name = "Message",
                    },
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.keyspaces.Table;
    import com.pulumi.aws.keyspaces.TableArgs;
    import com.pulumi.aws.keyspaces.inputs.TableSchemaDefinitionArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new Table("example", TableArgs.builder()        
                .keyspaceName(exampleAwsKeyspacesKeyspace.name())
                .tableName("my_table")
                .schemaDefinition(TableSchemaDefinitionArgs.builder()
                    .columns(TableSchemaDefinitionColumnArgs.builder()
                        .name("Message")
                        .type("ASCII")
                        .build())
                    .partitionKeys(TableSchemaDefinitionPartitionKeyArgs.builder()
                        .name("Message")
                        .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:keyspaces:Table
        properties:
          keyspaceName: ${exampleAwsKeyspacesKeyspace.name}
          tableName: my_table
          schemaDefinition:
            columns:
              - name: Message
                type: ASCII
            partitionKeys:
              - name: Message
    

    Create Table Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Table(name: string, args: TableArgs, opts?: CustomResourceOptions);
    @overload
    def Table(resource_name: str,
              args: TableArgs,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Table(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              keyspace_name: Optional[str] = None,
              schema_definition: Optional[TableSchemaDefinitionArgs] = None,
              table_name: Optional[str] = None,
              capacity_specification: Optional[TableCapacitySpecificationArgs] = None,
              client_side_timestamps: Optional[TableClientSideTimestampsArgs] = None,
              comment: Optional[TableCommentArgs] = None,
              default_time_to_live: Optional[int] = None,
              encryption_specification: Optional[TableEncryptionSpecificationArgs] = None,
              point_in_time_recovery: Optional[TablePointInTimeRecoveryArgs] = None,
              tags: Optional[Mapping[str, str]] = None,
              ttl: Optional[TableTtlArgs] = None)
    func NewTable(ctx *Context, name string, args TableArgs, opts ...ResourceOption) (*Table, error)
    public Table(string name, TableArgs args, CustomResourceOptions? opts = null)
    public Table(String name, TableArgs args)
    public Table(String name, TableArgs args, CustomResourceOptions options)
    
    type: aws:keyspaces:Table
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args TableArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TableArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TableArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TableArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TableArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var awsTableResource = new Aws.Keyspaces.Table("awsTableResource", new()
    {
        KeyspaceName = "string",
        SchemaDefinition = new Aws.Keyspaces.Inputs.TableSchemaDefinitionArgs
        {
            Columns = new[]
            {
                new Aws.Keyspaces.Inputs.TableSchemaDefinitionColumnArgs
                {
                    Name = "string",
                    Type = "string",
                },
            },
            PartitionKeys = new[]
            {
                new Aws.Keyspaces.Inputs.TableSchemaDefinitionPartitionKeyArgs
                {
                    Name = "string",
                },
            },
            ClusteringKeys = new[]
            {
                new Aws.Keyspaces.Inputs.TableSchemaDefinitionClusteringKeyArgs
                {
                    Name = "string",
                    OrderBy = "string",
                },
            },
            StaticColumns = new[]
            {
                new Aws.Keyspaces.Inputs.TableSchemaDefinitionStaticColumnArgs
                {
                    Name = "string",
                },
            },
        },
        TableName = "string",
        CapacitySpecification = new Aws.Keyspaces.Inputs.TableCapacitySpecificationArgs
        {
            ReadCapacityUnits = 0,
            ThroughputMode = "string",
            WriteCapacityUnits = 0,
        },
        ClientSideTimestamps = new Aws.Keyspaces.Inputs.TableClientSideTimestampsArgs
        {
            Status = "string",
        },
        Comment = new Aws.Keyspaces.Inputs.TableCommentArgs
        {
            Message = "string",
        },
        DefaultTimeToLive = 0,
        EncryptionSpecification = new Aws.Keyspaces.Inputs.TableEncryptionSpecificationArgs
        {
            KmsKeyIdentifier = "string",
            Type = "string",
        },
        PointInTimeRecovery = new Aws.Keyspaces.Inputs.TablePointInTimeRecoveryArgs
        {
            Status = "string",
        },
        Tags = 
        {
            { "string", "string" },
        },
        Ttl = new Aws.Keyspaces.Inputs.TableTtlArgs
        {
            Status = "string",
        },
    });
    
    example, err := keyspaces.NewTable(ctx, "awsTableResource", &keyspaces.TableArgs{
    	KeyspaceName: pulumi.String("string"),
    	SchemaDefinition: &keyspaces.TableSchemaDefinitionArgs{
    		Columns: keyspaces.TableSchemaDefinitionColumnArray{
    			&keyspaces.TableSchemaDefinitionColumnArgs{
    				Name: pulumi.String("string"),
    				Type: pulumi.String("string"),
    			},
    		},
    		PartitionKeys: keyspaces.TableSchemaDefinitionPartitionKeyArray{
    			&keyspaces.TableSchemaDefinitionPartitionKeyArgs{
    				Name: pulumi.String("string"),
    			},
    		},
    		ClusteringKeys: keyspaces.TableSchemaDefinitionClusteringKeyArray{
    			&keyspaces.TableSchemaDefinitionClusteringKeyArgs{
    				Name:    pulumi.String("string"),
    				OrderBy: pulumi.String("string"),
    			},
    		},
    		StaticColumns: keyspaces.TableSchemaDefinitionStaticColumnArray{
    			&keyspaces.TableSchemaDefinitionStaticColumnArgs{
    				Name: pulumi.String("string"),
    			},
    		},
    	},
    	TableName: pulumi.String("string"),
    	CapacitySpecification: &keyspaces.TableCapacitySpecificationArgs{
    		ReadCapacityUnits:  pulumi.Int(0),
    		ThroughputMode:     pulumi.String("string"),
    		WriteCapacityUnits: pulumi.Int(0),
    	},
    	ClientSideTimestamps: &keyspaces.TableClientSideTimestampsArgs{
    		Status: pulumi.String("string"),
    	},
    	Comment: &keyspaces.TableCommentArgs{
    		Message: pulumi.String("string"),
    	},
    	DefaultTimeToLive: pulumi.Int(0),
    	EncryptionSpecification: &keyspaces.TableEncryptionSpecificationArgs{
    		KmsKeyIdentifier: pulumi.String("string"),
    		Type:             pulumi.String("string"),
    	},
    	PointInTimeRecovery: &keyspaces.TablePointInTimeRecoveryArgs{
    		Status: pulumi.String("string"),
    	},
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Ttl: &keyspaces.TableTtlArgs{
    		Status: pulumi.String("string"),
    	},
    })
    
    var awsTableResource = new Table("awsTableResource", TableArgs.builder()        
        .keyspaceName("string")
        .schemaDefinition(TableSchemaDefinitionArgs.builder()
            .columns(TableSchemaDefinitionColumnArgs.builder()
                .name("string")
                .type("string")
                .build())
            .partitionKeys(TableSchemaDefinitionPartitionKeyArgs.builder()
                .name("string")
                .build())
            .clusteringKeys(TableSchemaDefinitionClusteringKeyArgs.builder()
                .name("string")
                .orderBy("string")
                .build())
            .staticColumns(TableSchemaDefinitionStaticColumnArgs.builder()
                .name("string")
                .build())
            .build())
        .tableName("string")
        .capacitySpecification(TableCapacitySpecificationArgs.builder()
            .readCapacityUnits(0)
            .throughputMode("string")
            .writeCapacityUnits(0)
            .build())
        .clientSideTimestamps(TableClientSideTimestampsArgs.builder()
            .status("string")
            .build())
        .comment(TableCommentArgs.builder()
            .message("string")
            .build())
        .defaultTimeToLive(0)
        .encryptionSpecification(TableEncryptionSpecificationArgs.builder()
            .kmsKeyIdentifier("string")
            .type("string")
            .build())
        .pointInTimeRecovery(TablePointInTimeRecoveryArgs.builder()
            .status("string")
            .build())
        .tags(Map.of("string", "string"))
        .ttl(TableTtlArgs.builder()
            .status("string")
            .build())
        .build());
    
    aws_table_resource = aws.keyspaces.Table("awsTableResource",
        keyspace_name="string",
        schema_definition=aws.keyspaces.TableSchemaDefinitionArgs(
            columns=[aws.keyspaces.TableSchemaDefinitionColumnArgs(
                name="string",
                type="string",
            )],
            partition_keys=[aws.keyspaces.TableSchemaDefinitionPartitionKeyArgs(
                name="string",
            )],
            clustering_keys=[aws.keyspaces.TableSchemaDefinitionClusteringKeyArgs(
                name="string",
                order_by="string",
            )],
            static_columns=[aws.keyspaces.TableSchemaDefinitionStaticColumnArgs(
                name="string",
            )],
        ),
        table_name="string",
        capacity_specification=aws.keyspaces.TableCapacitySpecificationArgs(
            read_capacity_units=0,
            throughput_mode="string",
            write_capacity_units=0,
        ),
        client_side_timestamps=aws.keyspaces.TableClientSideTimestampsArgs(
            status="string",
        ),
        comment=aws.keyspaces.TableCommentArgs(
            message="string",
        ),
        default_time_to_live=0,
        encryption_specification=aws.keyspaces.TableEncryptionSpecificationArgs(
            kms_key_identifier="string",
            type="string",
        ),
        point_in_time_recovery=aws.keyspaces.TablePointInTimeRecoveryArgs(
            status="string",
        ),
        tags={
            "string": "string",
        },
        ttl=aws.keyspaces.TableTtlArgs(
            status="string",
        ))
    
    const awsTableResource = new aws.keyspaces.Table("awsTableResource", {
        keyspaceName: "string",
        schemaDefinition: {
            columns: [{
                name: "string",
                type: "string",
            }],
            partitionKeys: [{
                name: "string",
            }],
            clusteringKeys: [{
                name: "string",
                orderBy: "string",
            }],
            staticColumns: [{
                name: "string",
            }],
        },
        tableName: "string",
        capacitySpecification: {
            readCapacityUnits: 0,
            throughputMode: "string",
            writeCapacityUnits: 0,
        },
        clientSideTimestamps: {
            status: "string",
        },
        comment: {
            message: "string",
        },
        defaultTimeToLive: 0,
        encryptionSpecification: {
            kmsKeyIdentifier: "string",
            type: "string",
        },
        pointInTimeRecovery: {
            status: "string",
        },
        tags: {
            string: "string",
        },
        ttl: {
            status: "string",
        },
    });
    
    type: aws:keyspaces:Table
    properties:
        capacitySpecification:
            readCapacityUnits: 0
            throughputMode: string
            writeCapacityUnits: 0
        clientSideTimestamps:
            status: string
        comment:
            message: string
        defaultTimeToLive: 0
        encryptionSpecification:
            kmsKeyIdentifier: string
            type: string
        keyspaceName: string
        pointInTimeRecovery:
            status: string
        schemaDefinition:
            clusteringKeys:
                - name: string
                  orderBy: string
            columns:
                - name: string
                  type: string
            partitionKeys:
                - name: string
            staticColumns:
                - name: string
        tableName: string
        tags:
            string: string
        ttl:
            status: string
    

    Table Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Table resource accepts the following input properties:

    KeyspaceName string
    The name of the keyspace that the table is going to be created in.
    SchemaDefinition TableSchemaDefinition
    Describes the schema of the table.
    TableName string

    The name of the table.

    The following arguments are optional:

    CapacitySpecification TableCapacitySpecification
    Specifies the read/write throughput capacity mode for the table.
    ClientSideTimestamps TableClientSideTimestamps
    Enables client-side timestamps for the table. By default, the setting is disabled.
    Comment TableComment
    A description of the table.
    DefaultTimeToLive int
    The default Time to Live setting in seconds for the table. More information can be found in the Developer Guide.
    EncryptionSpecification TableEncryptionSpecification
    Specifies how the encryption key for encryption at rest is managed for the table. More information can be found in the Developer Guide.
    PointInTimeRecovery TablePointInTimeRecovery
    Specifies if point-in-time recovery is enabled or disabled for the table. More information can be found in the Developer Guide.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Ttl TableTtl
    Enables Time to Live custom settings for the table. More information can be found in the Developer Guide.
    KeyspaceName string
    The name of the keyspace that the table is going to be created in.
    SchemaDefinition TableSchemaDefinitionArgs
    Describes the schema of the table.
    TableName string

    The name of the table.

    The following arguments are optional:

    CapacitySpecification TableCapacitySpecificationArgs
    Specifies the read/write throughput capacity mode for the table.
    ClientSideTimestamps TableClientSideTimestampsArgs
    Enables client-side timestamps for the table. By default, the setting is disabled.
    Comment TableCommentArgs
    A description of the table.
    DefaultTimeToLive int
    The default Time to Live setting in seconds for the table. More information can be found in the Developer Guide.
    EncryptionSpecification TableEncryptionSpecificationArgs
    Specifies how the encryption key for encryption at rest is managed for the table. More information can be found in the Developer Guide.
    PointInTimeRecovery TablePointInTimeRecoveryArgs
    Specifies if point-in-time recovery is enabled or disabled for the table. More information can be found in the Developer Guide.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Ttl TableTtlArgs
    Enables Time to Live custom settings for the table. More information can be found in the Developer Guide.
    keyspaceName String
    The name of the keyspace that the table is going to be created in.
    schemaDefinition TableSchemaDefinition
    Describes the schema of the table.
    tableName String

    The name of the table.

    The following arguments are optional:

    capacitySpecification TableCapacitySpecification
    Specifies the read/write throughput capacity mode for the table.
    clientSideTimestamps TableClientSideTimestamps
    Enables client-side timestamps for the table. By default, the setting is disabled.
    comment TableComment
    A description of the table.
    defaultTimeToLive Integer
    The default Time to Live setting in seconds for the table. More information can be found in the Developer Guide.
    encryptionSpecification TableEncryptionSpecification
    Specifies how the encryption key for encryption at rest is managed for the table. More information can be found in the Developer Guide.
    pointInTimeRecovery TablePointInTimeRecovery
    Specifies if point-in-time recovery is enabled or disabled for the table. More information can be found in the Developer Guide.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    ttl TableTtl
    Enables Time to Live custom settings for the table. More information can be found in the Developer Guide.
    keyspaceName string
    The name of the keyspace that the table is going to be created in.
    schemaDefinition TableSchemaDefinition
    Describes the schema of the table.
    tableName string

    The name of the table.

    The following arguments are optional:

    capacitySpecification TableCapacitySpecification
    Specifies the read/write throughput capacity mode for the table.
    clientSideTimestamps TableClientSideTimestamps
    Enables client-side timestamps for the table. By default, the setting is disabled.
    comment TableComment
    A description of the table.
    defaultTimeToLive number
    The default Time to Live setting in seconds for the table. More information can be found in the Developer Guide.
    encryptionSpecification TableEncryptionSpecification
    Specifies how the encryption key for encryption at rest is managed for the table. More information can be found in the Developer Guide.
    pointInTimeRecovery TablePointInTimeRecovery
    Specifies if point-in-time recovery is enabled or disabled for the table. More information can be found in the Developer Guide.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    ttl TableTtl
    Enables Time to Live custom settings for the table. More information can be found in the Developer Guide.
    keyspace_name str
    The name of the keyspace that the table is going to be created in.
    schema_definition TableSchemaDefinitionArgs
    Describes the schema of the table.
    table_name str

    The name of the table.

    The following arguments are optional:

    capacity_specification TableCapacitySpecificationArgs
    Specifies the read/write throughput capacity mode for the table.
    client_side_timestamps TableClientSideTimestampsArgs
    Enables client-side timestamps for the table. By default, the setting is disabled.
    comment TableCommentArgs
    A description of the table.
    default_time_to_live int
    The default Time to Live setting in seconds for the table. More information can be found in the Developer Guide.
    encryption_specification TableEncryptionSpecificationArgs
    Specifies how the encryption key for encryption at rest is managed for the table. More information can be found in the Developer Guide.
    point_in_time_recovery TablePointInTimeRecoveryArgs
    Specifies if point-in-time recovery is enabled or disabled for the table. More information can be found in the Developer Guide.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    ttl TableTtlArgs
    Enables Time to Live custom settings for the table. More information can be found in the Developer Guide.
    keyspaceName String
    The name of the keyspace that the table is going to be created in.
    schemaDefinition Property Map
    Describes the schema of the table.
    tableName String

    The name of the table.

    The following arguments are optional:

    capacitySpecification Property Map
    Specifies the read/write throughput capacity mode for the table.
    clientSideTimestamps Property Map
    Enables client-side timestamps for the table. By default, the setting is disabled.
    comment Property Map
    A description of the table.
    defaultTimeToLive Number
    The default Time to Live setting in seconds for the table. More information can be found in the Developer Guide.
    encryptionSpecification Property Map
    Specifies how the encryption key for encryption at rest is managed for the table. More information can be found in the Developer Guide.
    pointInTimeRecovery Property Map
    Specifies if point-in-time recovery is enabled or disabled for the table. More information can be found in the Developer Guide.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    ttl Property Map
    Enables Time to Live custom settings for the table. More information can be found in the Developer Guide.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Table resource produces the following output properties:

    Arn string
    The ARN of the table.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The ARN of the table.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the table.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The ARN of the table.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The ARN of the table.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the table.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Table Resource

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

    public static get(name: string, id: Input<ID>, state?: TableState, opts?: CustomResourceOptions): Table
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            capacity_specification: Optional[TableCapacitySpecificationArgs] = None,
            client_side_timestamps: Optional[TableClientSideTimestampsArgs] = None,
            comment: Optional[TableCommentArgs] = None,
            default_time_to_live: Optional[int] = None,
            encryption_specification: Optional[TableEncryptionSpecificationArgs] = None,
            keyspace_name: Optional[str] = None,
            point_in_time_recovery: Optional[TablePointInTimeRecoveryArgs] = None,
            schema_definition: Optional[TableSchemaDefinitionArgs] = None,
            table_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            ttl: Optional[TableTtlArgs] = None) -> Table
    func GetTable(ctx *Context, name string, id IDInput, state *TableState, opts ...ResourceOption) (*Table, error)
    public static Table Get(string name, Input<string> id, TableState? state, CustomResourceOptions? opts = null)
    public static Table get(String name, Output<String> id, TableState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The ARN of the table.
    CapacitySpecification TableCapacitySpecification
    Specifies the read/write throughput capacity mode for the table.
    ClientSideTimestamps TableClientSideTimestamps
    Enables client-side timestamps for the table. By default, the setting is disabled.
    Comment TableComment
    A description of the table.
    DefaultTimeToLive int
    The default Time to Live setting in seconds for the table. More information can be found in the Developer Guide.
    EncryptionSpecification TableEncryptionSpecification
    Specifies how the encryption key for encryption at rest is managed for the table. More information can be found in the Developer Guide.
    KeyspaceName string
    The name of the keyspace that the table is going to be created in.
    PointInTimeRecovery TablePointInTimeRecovery
    Specifies if point-in-time recovery is enabled or disabled for the table. More information can be found in the Developer Guide.
    SchemaDefinition TableSchemaDefinition
    Describes the schema of the table.
    TableName string

    The name of the table.

    The following arguments are optional:

    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Ttl TableTtl
    Enables Time to Live custom settings for the table. More information can be found in the Developer Guide.
    Arn string
    The ARN of the table.
    CapacitySpecification TableCapacitySpecificationArgs
    Specifies the read/write throughput capacity mode for the table.
    ClientSideTimestamps TableClientSideTimestampsArgs
    Enables client-side timestamps for the table. By default, the setting is disabled.
    Comment TableCommentArgs
    A description of the table.
    DefaultTimeToLive int
    The default Time to Live setting in seconds for the table. More information can be found in the Developer Guide.
    EncryptionSpecification TableEncryptionSpecificationArgs
    Specifies how the encryption key for encryption at rest is managed for the table. More information can be found in the Developer Guide.
    KeyspaceName string
    The name of the keyspace that the table is going to be created in.
    PointInTimeRecovery TablePointInTimeRecoveryArgs
    Specifies if point-in-time recovery is enabled or disabled for the table. More information can be found in the Developer Guide.
    SchemaDefinition TableSchemaDefinitionArgs
    Describes the schema of the table.
    TableName string

    The name of the table.

    The following arguments are optional:

    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Ttl TableTtlArgs
    Enables Time to Live custom settings for the table. More information can be found in the Developer Guide.
    arn String
    The ARN of the table.
    capacitySpecification TableCapacitySpecification
    Specifies the read/write throughput capacity mode for the table.
    clientSideTimestamps TableClientSideTimestamps
    Enables client-side timestamps for the table. By default, the setting is disabled.
    comment TableComment
    A description of the table.
    defaultTimeToLive Integer
    The default Time to Live setting in seconds for the table. More information can be found in the Developer Guide.
    encryptionSpecification TableEncryptionSpecification
    Specifies how the encryption key for encryption at rest is managed for the table. More information can be found in the Developer Guide.
    keyspaceName String
    The name of the keyspace that the table is going to be created in.
    pointInTimeRecovery TablePointInTimeRecovery
    Specifies if point-in-time recovery is enabled or disabled for the table. More information can be found in the Developer Guide.
    schemaDefinition TableSchemaDefinition
    Describes the schema of the table.
    tableName String

    The name of the table.

    The following arguments are optional:

    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    ttl TableTtl
    Enables Time to Live custom settings for the table. More information can be found in the Developer Guide.
    arn string
    The ARN of the table.
    capacitySpecification TableCapacitySpecification
    Specifies the read/write throughput capacity mode for the table.
    clientSideTimestamps TableClientSideTimestamps
    Enables client-side timestamps for the table. By default, the setting is disabled.
    comment TableComment
    A description of the table.
    defaultTimeToLive number
    The default Time to Live setting in seconds for the table. More information can be found in the Developer Guide.
    encryptionSpecification TableEncryptionSpecification
    Specifies how the encryption key for encryption at rest is managed for the table. More information can be found in the Developer Guide.
    keyspaceName string
    The name of the keyspace that the table is going to be created in.
    pointInTimeRecovery TablePointInTimeRecovery
    Specifies if point-in-time recovery is enabled or disabled for the table. More information can be found in the Developer Guide.
    schemaDefinition TableSchemaDefinition
    Describes the schema of the table.
    tableName string

    The name of the table.

    The following arguments are optional:

    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    ttl TableTtl
    Enables Time to Live custom settings for the table. More information can be found in the Developer Guide.
    arn str
    The ARN of the table.
    capacity_specification TableCapacitySpecificationArgs
    Specifies the read/write throughput capacity mode for the table.
    client_side_timestamps TableClientSideTimestampsArgs
    Enables client-side timestamps for the table. By default, the setting is disabled.
    comment TableCommentArgs
    A description of the table.
    default_time_to_live int
    The default Time to Live setting in seconds for the table. More information can be found in the Developer Guide.
    encryption_specification TableEncryptionSpecificationArgs
    Specifies how the encryption key for encryption at rest is managed for the table. More information can be found in the Developer Guide.
    keyspace_name str
    The name of the keyspace that the table is going to be created in.
    point_in_time_recovery TablePointInTimeRecoveryArgs
    Specifies if point-in-time recovery is enabled or disabled for the table. More information can be found in the Developer Guide.
    schema_definition TableSchemaDefinitionArgs
    Describes the schema of the table.
    table_name str

    The name of the table.

    The following arguments are optional:

    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    ttl TableTtlArgs
    Enables Time to Live custom settings for the table. More information can be found in the Developer Guide.
    arn String
    The ARN of the table.
    capacitySpecification Property Map
    Specifies the read/write throughput capacity mode for the table.
    clientSideTimestamps Property Map
    Enables client-side timestamps for the table. By default, the setting is disabled.
    comment Property Map
    A description of the table.
    defaultTimeToLive Number
    The default Time to Live setting in seconds for the table. More information can be found in the Developer Guide.
    encryptionSpecification Property Map
    Specifies how the encryption key for encryption at rest is managed for the table. More information can be found in the Developer Guide.
    keyspaceName String
    The name of the keyspace that the table is going to be created in.
    pointInTimeRecovery Property Map
    Specifies if point-in-time recovery is enabled or disabled for the table. More information can be found in the Developer Guide.
    schemaDefinition Property Map
    Describes the schema of the table.
    tableName String

    The name of the table.

    The following arguments are optional:

    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    ttl Property Map
    Enables Time to Live custom settings for the table. More information can be found in the Developer Guide.

    Supporting Types

    TableCapacitySpecification, TableCapacitySpecificationArgs

    ReadCapacityUnits int
    The throughput capacity specified for read operations defined in read capacity units (RCUs).
    ThroughputMode string
    The read/write throughput capacity mode for a table. Valid values: PAY_PER_REQUEST, PROVISIONED. The default value is PAY_PER_REQUEST.
    WriteCapacityUnits int
    The throughput capacity specified for write operations defined in write capacity units (WCUs).
    ReadCapacityUnits int
    The throughput capacity specified for read operations defined in read capacity units (RCUs).
    ThroughputMode string
    The read/write throughput capacity mode for a table. Valid values: PAY_PER_REQUEST, PROVISIONED. The default value is PAY_PER_REQUEST.
    WriteCapacityUnits int
    The throughput capacity specified for write operations defined in write capacity units (WCUs).
    readCapacityUnits Integer
    The throughput capacity specified for read operations defined in read capacity units (RCUs).
    throughputMode String
    The read/write throughput capacity mode for a table. Valid values: PAY_PER_REQUEST, PROVISIONED. The default value is PAY_PER_REQUEST.
    writeCapacityUnits Integer
    The throughput capacity specified for write operations defined in write capacity units (WCUs).
    readCapacityUnits number
    The throughput capacity specified for read operations defined in read capacity units (RCUs).
    throughputMode string
    The read/write throughput capacity mode for a table. Valid values: PAY_PER_REQUEST, PROVISIONED. The default value is PAY_PER_REQUEST.
    writeCapacityUnits number
    The throughput capacity specified for write operations defined in write capacity units (WCUs).
    read_capacity_units int
    The throughput capacity specified for read operations defined in read capacity units (RCUs).
    throughput_mode str
    The read/write throughput capacity mode for a table. Valid values: PAY_PER_REQUEST, PROVISIONED. The default value is PAY_PER_REQUEST.
    write_capacity_units int
    The throughput capacity specified for write operations defined in write capacity units (WCUs).
    readCapacityUnits Number
    The throughput capacity specified for read operations defined in read capacity units (RCUs).
    throughputMode String
    The read/write throughput capacity mode for a table. Valid values: PAY_PER_REQUEST, PROVISIONED. The default value is PAY_PER_REQUEST.
    writeCapacityUnits Number
    The throughput capacity specified for write operations defined in write capacity units (WCUs).

    TableClientSideTimestamps, TableClientSideTimestampsArgs

    Status string
    Shows how to enable client-side timestamps settings for the specified table. Valid values: ENABLED.
    Status string
    Shows how to enable client-side timestamps settings for the specified table. Valid values: ENABLED.
    status String
    Shows how to enable client-side timestamps settings for the specified table. Valid values: ENABLED.
    status string
    Shows how to enable client-side timestamps settings for the specified table. Valid values: ENABLED.
    status str
    Shows how to enable client-side timestamps settings for the specified table. Valid values: ENABLED.
    status String
    Shows how to enable client-side timestamps settings for the specified table. Valid values: ENABLED.

    TableComment, TableCommentArgs

    Message string
    A description of the table.
    Message string
    A description of the table.
    message String
    A description of the table.
    message string
    A description of the table.
    message str
    A description of the table.
    message String
    A description of the table.

    TableEncryptionSpecification, TableEncryptionSpecificationArgs

    KmsKeyIdentifier string
    The Amazon Resource Name (ARN) of the customer managed KMS key.
    Type string
    The encryption option specified for the table. Valid values: AWS_OWNED_KMS_KEY, CUSTOMER_MANAGED_KMS_KEY. The default value is AWS_OWNED_KMS_KEY.
    KmsKeyIdentifier string
    The Amazon Resource Name (ARN) of the customer managed KMS key.
    Type string
    The encryption option specified for the table. Valid values: AWS_OWNED_KMS_KEY, CUSTOMER_MANAGED_KMS_KEY. The default value is AWS_OWNED_KMS_KEY.
    kmsKeyIdentifier String
    The Amazon Resource Name (ARN) of the customer managed KMS key.
    type String
    The encryption option specified for the table. Valid values: AWS_OWNED_KMS_KEY, CUSTOMER_MANAGED_KMS_KEY. The default value is AWS_OWNED_KMS_KEY.
    kmsKeyIdentifier string
    The Amazon Resource Name (ARN) of the customer managed KMS key.
    type string
    The encryption option specified for the table. Valid values: AWS_OWNED_KMS_KEY, CUSTOMER_MANAGED_KMS_KEY. The default value is AWS_OWNED_KMS_KEY.
    kms_key_identifier str
    The Amazon Resource Name (ARN) of the customer managed KMS key.
    type str
    The encryption option specified for the table. Valid values: AWS_OWNED_KMS_KEY, CUSTOMER_MANAGED_KMS_KEY. The default value is AWS_OWNED_KMS_KEY.
    kmsKeyIdentifier String
    The Amazon Resource Name (ARN) of the customer managed KMS key.
    type String
    The encryption option specified for the table. Valid values: AWS_OWNED_KMS_KEY, CUSTOMER_MANAGED_KMS_KEY. The default value is AWS_OWNED_KMS_KEY.

    TablePointInTimeRecovery, TablePointInTimeRecoveryArgs

    Status string
    Valid values: ENABLED, DISABLED. The default value is DISABLED.
    Status string
    Valid values: ENABLED, DISABLED. The default value is DISABLED.
    status String
    Valid values: ENABLED, DISABLED. The default value is DISABLED.
    status string
    Valid values: ENABLED, DISABLED. The default value is DISABLED.
    status str
    Valid values: ENABLED, DISABLED. The default value is DISABLED.
    status String
    Valid values: ENABLED, DISABLED. The default value is DISABLED.

    TableSchemaDefinition, TableSchemaDefinitionArgs

    Columns List<TableSchemaDefinitionColumn>
    The regular columns of the table.
    PartitionKeys List<TableSchemaDefinitionPartitionKey>
    The columns that are part of the partition key of the table .
    ClusteringKeys List<TableSchemaDefinitionClusteringKey>
    The columns that are part of the clustering key of the table.
    StaticColumns List<TableSchemaDefinitionStaticColumn>
    The columns that have been defined as STATIC. Static columns store values that are shared by all rows in the same partition.
    Columns []TableSchemaDefinitionColumn
    The regular columns of the table.
    PartitionKeys []TableSchemaDefinitionPartitionKey
    The columns that are part of the partition key of the table .
    ClusteringKeys []TableSchemaDefinitionClusteringKey
    The columns that are part of the clustering key of the table.
    StaticColumns []TableSchemaDefinitionStaticColumn
    The columns that have been defined as STATIC. Static columns store values that are shared by all rows in the same partition.
    columns List<TableSchemaDefinitionColumn>
    The regular columns of the table.
    partitionKeys List<TableSchemaDefinitionPartitionKey>
    The columns that are part of the partition key of the table .
    clusteringKeys List<TableSchemaDefinitionClusteringKey>
    The columns that are part of the clustering key of the table.
    staticColumns List<TableSchemaDefinitionStaticColumn>
    The columns that have been defined as STATIC. Static columns store values that are shared by all rows in the same partition.
    columns TableSchemaDefinitionColumn[]
    The regular columns of the table.
    partitionKeys TableSchemaDefinitionPartitionKey[]
    The columns that are part of the partition key of the table .
    clusteringKeys TableSchemaDefinitionClusteringKey[]
    The columns that are part of the clustering key of the table.
    staticColumns TableSchemaDefinitionStaticColumn[]
    The columns that have been defined as STATIC. Static columns store values that are shared by all rows in the same partition.
    columns Sequence[TableSchemaDefinitionColumn]
    The regular columns of the table.
    partition_keys Sequence[TableSchemaDefinitionPartitionKey]
    The columns that are part of the partition key of the table .
    clustering_keys Sequence[TableSchemaDefinitionClusteringKey]
    The columns that are part of the clustering key of the table.
    static_columns Sequence[TableSchemaDefinitionStaticColumn]
    The columns that have been defined as STATIC. Static columns store values that are shared by all rows in the same partition.
    columns List<Property Map>
    The regular columns of the table.
    partitionKeys List<Property Map>
    The columns that are part of the partition key of the table .
    clusteringKeys List<Property Map>
    The columns that are part of the clustering key of the table.
    staticColumns List<Property Map>
    The columns that have been defined as STATIC. Static columns store values that are shared by all rows in the same partition.

    TableSchemaDefinitionClusteringKey, TableSchemaDefinitionClusteringKeyArgs

    Name string
    The name of the clustering key column.
    OrderBy string
    The order modifier. Valid values: ASC, DESC.
    Name string
    The name of the clustering key column.
    OrderBy string
    The order modifier. Valid values: ASC, DESC.
    name String
    The name of the clustering key column.
    orderBy String
    The order modifier. Valid values: ASC, DESC.
    name string
    The name of the clustering key column.
    orderBy string
    The order modifier. Valid values: ASC, DESC.
    name str
    The name of the clustering key column.
    order_by str
    The order modifier. Valid values: ASC, DESC.
    name String
    The name of the clustering key column.
    orderBy String
    The order modifier. Valid values: ASC, DESC.

    TableSchemaDefinitionColumn, TableSchemaDefinitionColumnArgs

    Name string
    The name of the column.
    Type string
    The data type of the column. See the Developer Guide for a list of available data types.
    Name string
    The name of the column.
    Type string
    The data type of the column. See the Developer Guide for a list of available data types.
    name String
    The name of the column.
    type String
    The data type of the column. See the Developer Guide for a list of available data types.
    name string
    The name of the column.
    type string
    The data type of the column. See the Developer Guide for a list of available data types.
    name str
    The name of the column.
    type str
    The data type of the column. See the Developer Guide for a list of available data types.
    name String
    The name of the column.
    type String
    The data type of the column. See the Developer Guide for a list of available data types.

    TableSchemaDefinitionPartitionKey, TableSchemaDefinitionPartitionKeyArgs

    Name string
    The name of the partition key column.
    Name string
    The name of the partition key column.
    name String
    The name of the partition key column.
    name string
    The name of the partition key column.
    name str
    The name of the partition key column.
    name String
    The name of the partition key column.

    TableSchemaDefinitionStaticColumn, TableSchemaDefinitionStaticColumnArgs

    Name string
    The name of the static column.
    Name string
    The name of the static column.
    name String
    The name of the static column.
    name string
    The name of the static column.
    name str
    The name of the static column.
    name String
    The name of the static column.

    TableTtl, TableTtlArgs

    Status string
    Valid values: ENABLED.
    Status string
    Valid values: ENABLED.
    status String
    Valid values: ENABLED.
    status string
    Valid values: ENABLED.
    status str
    Valid values: ENABLED.
    status String
    Valid values: ENABLED.

    Import

    Using pulumi import, import a table using the keyspace_name and table_name separated by /. For example:

    $ pulumi import aws:keyspaces/table:Table example my_keyspace/my_table
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.30.0 published on Thursday, Apr 11, 2024 by Pulumi