Package com.pulumi.aws.timestreamwrite

Class Table

  • public class Table
extends com.pulumi.resources.CustomResource
    Provides a Timestream table resource. ## Example Usage ### Basic usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.timestreamwrite.Table;
 import com.pulumi.aws.timestreamwrite.TableArgs;
 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()
             .databaseName(exampleAwsTimestreamwriteDatabase.databaseName())
             .tableName("example")
             .build());
 
     }
 }
    ### Full usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.timestreamwrite.Table;
 import com.pulumi.aws.timestreamwrite.TableArgs;
 import com.pulumi.aws.timestreamwrite.inputs.TableRetentionPropertiesArgs;
 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()
             .retentionProperties(TableRetentionPropertiesArgs.builder()
                 .magneticStoreRetentionPeriodInDays(30)
                 .memoryStoreRetentionPeriodInHours(8)
                 .build())
             .databaseName(exampleAwsTimestreamwriteDatabase.databaseName())
             .tableName("example")
             .tags(Map.of("Name", "example-timestream-table"))
             .build());
 
     }
 }
    ### Customer-defined Partition Key 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.timestreamwrite.Table;
 import com.pulumi.aws.timestreamwrite.TableArgs;
 import com.pulumi.aws.timestreamwrite.inputs.TableSchemaArgs;
 import com.pulumi.aws.timestreamwrite.inputs.TableSchemaCompositePartitionKeyArgs;
 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()
             .schema(TableSchemaArgs.builder()
                 .compositePartitionKey(TableSchemaCompositePartitionKeyArgs.builder()
                     .enforcementInRecord("REQUIRED")
                     .name("attr1")
                     .type("DIMENSION")
                     .build())
                 .build())
             .databaseName(exampleAwsTimestreamwriteDatabase.databaseName())
             .tableName("example")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Timestream tables using the `tableName` and `databaseName` separate by a colon (`:`). For example: ```sh $ pulumi import aws:timestreamwrite/table:Table example ExampleTable:ExampleDatabase ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Table​(java.lang.String name)  
      Table​(java.lang.String name, TableArgs args)  
      Table​(java.lang.String name, TableArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> databaseName()  
      static Table get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, TableState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<TableMagneticStoreWriteProperties> magneticStoreWriteProperties()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<TableRetentionProperties> retentionProperties()  
      com.pulumi.core.Output<TableSchema> schema()  
      com.pulumi.core.Output<java.lang.String> tableName()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Table

        public Table​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Table

        public Table​(java.lang.String name,
             TableArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Table

        public Table​(java.lang.String name,
             TableArgs args,
             @Nullable
             com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN that uniquely identifies this table.

      • databaseName

        public com.pulumi.core.Output<java.lang.String> databaseName()
        Returns:
        Name of the Timestream database.

      • magneticStoreWriteProperties

        public com.pulumi.core.Output<TableMagneticStoreWriteProperties> magneticStoreWriteProperties()
        Returns:
        Properties to set on the table when enabling magnetic store writes. See `magneticStoreWriteProperties` Block below for more details.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        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.

      • retentionProperties

        public com.pulumi.core.Output<TableRetentionProperties> retentionProperties()
        Returns:
        Retention duration for the memory store and magnetic store. See `retentionProperties` Block below for more details. If not provided, `magneticStoreRetentionPeriodInDays` defaults to 73000 and `memoryStoreRetentionPeriodInHours` defaults to 6.

      • schema

        public com.pulumi.core.Output<TableSchema> schema()
        Returns:
        Schema of the table. See `schema` Block below for more details.

      • tableName

        public com.pulumi.core.Output<java.lang.String> tableName()
        Returns:
        Name of the Timestream table.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

        public static Table get​(java.lang.String name,
                        com.pulumi.core.Output<java.lang.String> id,
                        @Nullable
                        TableState state,
                        @Nullable
                        com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.