GlobalTable class
Manages DynamoDB Global Tables V1 (version 2017.11.29). These are layered on top of existing DynamoDB Tables.
> NOTE: To instead manage DynamoDB Global Tables V2 (version 2019.11.21), use the aws.dynamodb.Table resource replica configuration block.
> Note: There are many restrictions before you can properly create DynamoDB Global Tables in multiple regions. See the AWS DynamoDB Global Table Requirements for more information.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const us_east_1 = new aws.dynamodb.Table("us-east-1", {
attributes: [{
name: "myAttribute",
type: "S",
}],
hashKey: "myAttribute",
name: "myTable",
streamEnabled: true,
streamViewType: "NEW_AND_OLD_IMAGES",
readCapacity: 1,
writeCapacity: 1,
});
const us_west_2 = new aws.dynamodb.Table("us-west-2", {
attributes: [{
name: "myAttribute",
type: "S",
}],
hashKey: "myAttribute",
name: "myTable",
streamEnabled: true,
streamViewType: "NEW_AND_OLD_IMAGES",
readCapacity: 1,
writeCapacity: 1,
});
const myTable = new aws.dynamodb.GlobalTable("myTable", {
replicas: [
{
regionName: "us-east-1",
},
{
regionName: "us-west-2",
},
],
name: "myTable",
}, {
dependsOn: [
us_east_1,
us_west_2,
],
});
import pulumi
import pulumi_aws as aws
us_east_1 = aws.dynamodb.Table("us-east-1",
attributes=[{
"name": "myAttribute",
"type": "S",
}],
hash_key="myAttribute",
name="myTable",
stream_enabled=True,
stream_view_type="NEW_AND_OLD_IMAGES",
read_capacity=1,
write_capacity=1)
us_west_2 = aws.dynamodb.Table("us-west-2",
attributes=[{
"name": "myAttribute",
"type": "S",
}],
hash_key="myAttribute",
name="myTable",
stream_enabled=True,
stream_view_type="NEW_AND_OLD_IMAGES",
read_capacity=1,
write_capacity=1)
my_table = aws.dynamodb.GlobalTable("myTable",
replicas=[
{
"region_name": "us-east-1",
},
{
"region_name": "us-west-2",
},
],
name="myTable",
opts = pulumi.ResourceOptions(depends_on=[
us_east_1,
us_west_2,
]))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var us_east_1 = new Aws.DynamoDB.Table("us-east-1", new()
{
Attributes = new[]
{
new Aws.DynamoDB.Inputs.TableAttributeArgs
{
Name = "myAttribute",
Type = "S",
},
},
HashKey = "myAttribute",
Name = "myTable",
StreamEnabled = true,
StreamViewType = "NEW_AND_OLD_IMAGES",
ReadCapacity = 1,
WriteCapacity = 1,
});
var us_west_2 = new Aws.DynamoDB.Table("us-west-2", new()
{
Attributes = new[]
{
new Aws.DynamoDB.Inputs.TableAttributeArgs
{
Name = "myAttribute",
Type = "S",
},
},
HashKey = "myAttribute",
Name = "myTable",
StreamEnabled = true,
StreamViewType = "NEW_AND_OLD_IMAGES",
ReadCapacity = 1,
WriteCapacity = 1,
});
var myTable = new Aws.DynamoDB.GlobalTable("myTable", new()
{
Replicas = new[]
{
new Aws.DynamoDB.Inputs.GlobalTableReplicaArgs
{
RegionName = "us-east-1",
},
new Aws.DynamoDB.Inputs.GlobalTableReplicaArgs
{
RegionName = "us-west-2",
},
},
Name = "myTable",
}, new CustomResourceOptions
{
DependsOn =
{
us_east_1,
us_west_2,
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/dynamodb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
us_east_1, err := dynamodb.NewTable(ctx, "us-east-1", &dynamodb.TableArgs{
Attributes: dynamodb.TableAttributeArray{
&dynamodb.TableAttributeArgs{
Name: pulumi.String("myAttribute"),
Type: pulumi.String("S"),
},
},
HashKey: pulumi.String("myAttribute"),
Name: pulumi.String("myTable"),
StreamEnabled: pulumi.Bool(true),
StreamViewType: pulumi.String("NEW_AND_OLD_IMAGES"),
ReadCapacity: pulumi.Int(1),
WriteCapacity: pulumi.Int(1),
})
if err != nil {
return err
}
us_west_2, err := dynamodb.NewTable(ctx, "us-west-2", &dynamodb.TableArgs{
Attributes: dynamodb.TableAttributeArray{
&dynamodb.TableAttributeArgs{
Name: pulumi.String("myAttribute"),
Type: pulumi.String("S"),
},
},
HashKey: pulumi.String("myAttribute"),
Name: pulumi.String("myTable"),
StreamEnabled: pulumi.Bool(true),
StreamViewType: pulumi.String("NEW_AND_OLD_IMAGES"),
ReadCapacity: pulumi.Int(1),
WriteCapacity: pulumi.Int(1),
})
if err != nil {
return err
}
_, err = dynamodb.NewGlobalTable(ctx, "myTable", &dynamodb.GlobalTableArgs{
Replicas: dynamodb.GlobalTableReplicaArray{
&dynamodb.GlobalTableReplicaArgs{
RegionName: pulumi.String("us-east-1"),
},
&dynamodb.GlobalTableReplicaArgs{
RegionName: pulumi.String("us-west-2"),
},
},
Name: pulumi.String("myTable"),
}, pulumi.DependsOn([]pulumi.Resource{
us_east_1,
us_west_2,
}))
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_dynamodb_table" "us-east-1" {
attributes {
name = "myAttribute"
type = "S"
}
hash_key = "myAttribute"
name = "myTable"
stream_enabled = true
stream_view_type = "NEW_AND_OLD_IMAGES"
read_capacity = 1
write_capacity = 1
}
resource "aws_dynamodb_table" "us-west-2" {
attributes {
name = "myAttribute"
type = "S"
}
hash_key = "myAttribute"
name = "myTable"
stream_enabled = true
stream_view_type = "NEW_AND_OLD_IMAGES"
read_capacity = 1
write_capacity = 1
}
resource "aws_dynamodb_globaltable" "myTable" {
depends_on = [aws_dynamodb_table.us-east-1, aws_dynamodb_table.us-west-2]
replicas {
region_name = "us-east-1"
}
replicas {
region_name = "us-west-2"
}
name = "myTable"
}
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.GlobalTable;
import com.pulumi.aws.dynamodb.GlobalTableArgs;
import com.pulumi.aws.dynamodb.inputs.GlobalTableReplicaArgs;
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 us_east_1 = new Table("us-east-1", TableArgs.builder()
.attributes(TableAttributeArgs.builder()
.name("myAttribute")
.type("S")
.build())
.hashKey("myAttribute")
.name("myTable")
.streamEnabled(true)
.streamViewType("NEW_AND_OLD_IMAGES")
.readCapacity(1)
.writeCapacity(1)
.build());
var us_west_2 = new Table("us-west-2", TableArgs.builder()
.attributes(TableAttributeArgs.builder()
.name("myAttribute")
.type("S")
.build())
.hashKey("myAttribute")
.name("myTable")
.streamEnabled(true)
.streamViewType("NEW_AND_OLD_IMAGES")
.readCapacity(1)
.writeCapacity(1)
.build());
var myTable = new GlobalTable("myTable", GlobalTableArgs.builder()
.replicas(
GlobalTableReplicaArgs.builder()
.regionName("us-east-1")
.build(),
GlobalTableReplicaArgs.builder()
.regionName("us-west-2")
.build())
.name("myTable")
.build(), CustomResourceOptions.builder()
.dependsOn(
us_east_1,
us_west_2)
.build());
}
}
resources:
us-east-1:
type: aws:dynamodb:Table
properties:
attributes:
- name: myAttribute
type: S
hashKey: myAttribute
name: myTable
streamEnabled: true
streamViewType: NEW_AND_OLD_IMAGES
readCapacity: 1
writeCapacity: 1
us-west-2:
type: aws:dynamodb:Table
properties:
attributes:
- name: myAttribute
type: S
hashKey: myAttribute
name: myTable
streamEnabled: true
streamViewType: NEW_AND_OLD_IMAGES
readCapacity: 1
writeCapacity: 1
myTable:
type: aws:dynamodb:GlobalTable
properties:
replicas:
- regionName: us-east-1
- regionName: us-west-2
name: myTable
options:
dependsOn:
- ${["us-east-1"]}
- ${["us-west-2"]}
Import
Using pulumi import, import DynamoDB Global Tables using the global table name. For example:
$ pulumi import aws:dynamodb/globalTable:GlobalTable MyTable MyTable
Constructors
- GlobalTable(String name, {GlobalTableArgs? args, CustomResourceOptions? options})
-
Creates a new GlobalTable.
nameThe Pulumi resource name.argsArguments used to configure this GlobalTable. The set of arguments for GlobalTable.optionsResource options controlling this resource's behavior. - GlobalTable.reference(String urn)
- Creates a typed reference to an existing GlobalTable resource.
Properties
-
arn
↔ Output<
String> -
The ARN of the DynamoDB Global Table
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- 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
-
name
↔ Output<
String> -
The name of the global table. Must match underlying DynamoDB Table names in all regions.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
replicas
↔ Output<
List< GlobalTableReplica> > -
Underlying DynamoDB Table. At least 1 replica must be defined. See below.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
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, {GlobalTableState? state, CustomResourceOptions? options}) → GlobalTable -
Gets an existing GlobalTable resource's state with the given
nameandid.