Package com.pulumi.aws.dynamodb

Class TableReplica

  • public class TableReplica
extends com.pulumi.resources.CustomResource
    Provides a DynamoDB table replica resource for [DynamoDB Global Tables V2 (version 2019.11.21)](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html). > **Note:** Use `lifecycle` `ignoreChanges` for `replica` in the associated aws.dynamodb.Table configuration. > **Note:** Do not use the `replica` configuration block of aws.dynamodb.Table together with this resource as the two configuration options are mutually exclusive. ## Example Usage ### Basic Example 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.dynamodb.Table;
 import com.pulumi.aws.dynamodb.TableArgs;
 import com.pulumi.aws.dynamodb.inputs.TableAttributeArgs;
 import com.pulumi.aws.dynamodb.TableReplica;
 import com.pulumi.aws.dynamodb.TableReplicaArgs;
 import com.pulumi.resources.CustomResourceOptions;
 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()
             .attributes(TableAttributeArgs.builder()
                 .name("BrodoBaggins")
                 .type("S")
                 .build())
             .name("TestTable")
             .hashKey("BrodoBaggins")
             .billingMode("PAY_PER_REQUEST")
             .streamEnabled(true)
             .streamViewType("NEW_AND_OLD_IMAGES")
             .build(), CustomResourceOptions.builder()
                 .ignoreChanges("replicas")
                 .build());
 
         var exampleTableReplica = new TableReplica("exampleTableReplica", TableReplicaArgs.builder()
             .globalTableArn(example.arn())
             .tags(Map.ofEntries(
                 Map.entry("Name", "IZPAWS"),
                 Map.entry("Pozo", "Amargo")
             ))
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import DynamoDB table replicas using the `table-name:main-region`. For example: > **Note:** When importing, use the region where the initial or _main_ global table resides, _not_ the region of the replica. ```sh $ pulumi import aws:dynamodb/tableReplica:TableReplica example TestTable:us-west-2 ```

    • 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

    • 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.Boolean> deletionProtectionEnabled()  
      static TableReplica get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, TableReplicaState 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<java.lang.String> globalTableArn()  
      com.pulumi.core.Output<java.lang.String> kmsKeyArn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> pointInTimeRecovery()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> tableClassOverride()  
      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

      • TableReplica

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

      • TableReplica

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

      • TableReplica

        public TableReplica​(java.lang.String name,
                    TableReplicaArgs 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 of the table replica.

      • deletionProtectionEnabled

        public com.pulumi.core.Output<java.lang.Boolean> deletionProtectionEnabled()
        Returns:
        Whether deletion protection is enabled (true) or disabled (false) on the table replica.

      • globalTableArn

        public com.pulumi.core.Output<java.lang.String> globalTableArn()
        Returns:
        ARN of the _main_ or global table which this resource will replicate. The following arguments are optional:

      • kmsKeyArn

        public com.pulumi.core.Output<java.lang.String> kmsKeyArn()
        Returns:
        ARN of the CMK that should be used for the AWS KMS encryption. This argument should only be used if the key is different from the default KMS-managed DynamoDB key, `alias/aws/dynamodb`. **Note:** This attribute will _not_ be populated with the ARN of _default_ keys.

      • pointInTimeRecovery

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> pointInTimeRecovery()
        Returns:
        Whether to enable Point In Time Recovery for the table replica. Default is `false`.

      • 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.

      • tableClassOverride

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> tableClassOverride()
        Returns:
        Storage class of the table replica. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS`. If not used, the table replica will use the same class as the global 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 populate on the created table. 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 TableReplica get​(java.lang.String name,
                               com.pulumi.core.Output<java.lang.String> id,
                               @Nullable
                               TableReplicaState 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.