Table class

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", {
    schemaDefinition: {
        columns: [{
            name: "Message",
            type: "ASCII",
        }],
        partitionKeys: [{
            name: "Message",
        }],
    },
    keyspaceName: exampleAwsKeyspacesKeyspace.name,
    tableName: "my_table",
});
import pulumi
import pulumi_aws as aws

example = aws.keyspaces.Table("example",
    schema_definition={
        "columns": [{
            "name": "Message",
            "type": "ASCII",
        }],
        "partition_keys": [{
            "name": "Message",
        }],
    },
    keyspace_name=example_aws_keyspaces_keyspace["name"],
    table_name="my_table")
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()
    {
        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",
                },
            },
        },
        KeyspaceName = exampleAwsKeyspacesKeyspace.Name,
        TableName = "my_table",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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{
			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"),
					},
				},
			},
			KeyspaceName: pulumi.Any(exampleAwsKeyspacesKeyspace.Name),
			TableName:    pulumi.String("my_table"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_keyspaces_table" "example" {
  schema_definition = {
    columns = [{
      "name" = "Message"
      "type" = "ASCII"
    }]
    partition_keys = [{
      "name" = "Message"
    }]
  }
  keyspace_name = exampleAwsKeyspacesKeyspace.name
  table_name    = "my_table"
}
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 com.pulumi.aws.keyspaces.inputs.TableSchemaDefinitionColumnArgs;
import com.pulumi.aws.keyspaces.inputs.TableSchemaDefinitionPartitionKeyArgs;
import java.util.ArrayList;
import java.util.Arrays;
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()
            .schemaDefinition(TableSchemaDefinitionArgs.builder()
                .columns(TableSchemaDefinitionColumnArgs.builder()
                    .name("Message")
                    .type("ASCII")
                    .build())
                .partitionKeys(TableSchemaDefinitionPartitionKeyArgs.builder()
                    .name("Message")
                    .build())
                .build())
            .keyspaceName(exampleAwsKeyspacesKeyspace.name())
            .tableName("my_table")
            .build());

    }
}
resources:
  example:
    type: aws:keyspaces:Table
    properties:
      schemaDefinition:
        columns:
          - name: Message
            type: ASCII
        partitionKeys:
          - name: Message
      keyspaceName: ${exampleAwsKeyspacesKeyspace.name}
      tableName: my_table

Import

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

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

Constructors

Table(String name, {TableArgs? args, CustomResourceOptions? options})
Creates a new Table. name The Pulumi resource name. args Arguments used to configure this Table. The set of arguments for Table. options Resource options controlling this resource's behavior.
Table.reference(String urn)
Creates a typed reference to an existing Table resource.

Properties

arn ↔ Output<String>
The ARN of the table.
latefinal
capacitySpecification ↔ Output<TableCapacitySpecification>
Specifies the read/write throughput capacity mode for the table.
latefinal
childResources → Set<Resource>
finalinherited
clientSideTimestamps ↔ Output<TableClientSideTimestamps?>
Enables client-side timestamps for the table. By default, the setting is disabled.
latefinal
comment ↔ Output<TableComment>
A description of the table.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
defaultTimeToLive ↔ Output<int?>
The default Time to Live setting in seconds for the table. More information can be found in the Developer Guide.
latefinal
encryptionSpecification ↔ Output<TableEncryptionSpecification>
Specifies how the encryption key for encryption at rest is managed for the table. More information can be found in the Developer Guide.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
keyspaceName ↔ Output<String>
The name of the keyspace that the table is going to be created in.
latefinal
pointInTimeRecovery ↔ Output<TablePointInTimeRecovery>
Specifies if point-in-time recovery is enabled or disabled for the table. More information can be found in the Developer Guide.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schemaDefinition ↔ Output<TableSchemaDefinition>
Describes the schema of the table.
latefinal
tableName ↔ Output<String>
The name of the table.
latefinal
tags ↔ Output<Map<String, String>?>
A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
ttl ↔ Output<TableTtl?>
Enables Time to Live custom settings for the table. More information can be found in the Developer Guide.
latefinal
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {TableState? state, CustomResourceOptions? options}) → Table
Gets an existing Table resource's state with the given name and id.