GlobalSecondaryIndex class
> WARNING: Do not combine aws.dynamodb.GlobalSecondaryIndex resources in conjunction with globalSecondaryIndex on aws.dynamodb.Table. Doing so may cause conflicts, perpertual differences, and Global Secondary Indexes being overwritten.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const exampleTable = new aws.dynamodb.Table("example", {
attributes: [
{
name: "UserId",
type: "S",
},
{
name: "GameTitle",
type: "S",
},
],
name: "example",
billingMode: "PROVISIONED",
readCapacity: 20,
writeCapacity: 20,
hashKey: "UserId",
rangeKey: "GameTitle",
});
const example = new aws.dynamodb.GlobalSecondaryIndex("example", {
projection: {
projectionType: "INCLUDE",
nonKeyAttributes: ["UserId"],
},
provisionedThroughput: {
writeCapacityUnits: 10,
readCapacityUnits: 10,
},
keySchemas: [{
attributeName: "GameTitle",
attributeType: "S",
keyType: "HASH",
}],
tableName: exampleTable.name,
indexName: "GameTitleIndex",
});
import pulumi
import pulumi_aws as aws
example_table = aws.dynamodb.Table("example",
attributes=[
{
"name": "UserId",
"type": "S",
},
{
"name": "GameTitle",
"type": "S",
},
],
name="example",
billing_mode="PROVISIONED",
read_capacity=20,
write_capacity=20,
hash_key="UserId",
range_key="GameTitle")
example = aws.dynamodb.GlobalSecondaryIndex("example",
projection={
"projection_type": "INCLUDE",
"non_key_attributes": ["UserId"],
},
provisioned_throughput={
"write_capacity_units": 10,
"read_capacity_units": 10,
},
key_schemas=[{
"attribute_name": "GameTitle",
"attribute_type": "S",
"key_type": "HASH",
}],
table_name=example_table.name,
index_name="GameTitleIndex")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var exampleTable = new Aws.DynamoDB.Table("example", new()
{
Attributes = new[]
{
new Aws.DynamoDB.Inputs.TableAttributeArgs
{
Name = "UserId",
Type = "S",
},
new Aws.DynamoDB.Inputs.TableAttributeArgs
{
Name = "GameTitle",
Type = "S",
},
},
Name = "example",
BillingMode = "PROVISIONED",
ReadCapacity = 20,
WriteCapacity = 20,
HashKey = "UserId",
RangeKey = "GameTitle",
});
var example = new Aws.DynamoDB.GlobalSecondaryIndex("example", new()
{
Projection = new Aws.DynamoDB.Inputs.GlobalSecondaryIndexProjectionArgs
{
ProjectionType = "INCLUDE",
NonKeyAttributes = new[]
{
"UserId",
},
},
ProvisionedThroughput = new Aws.DynamoDB.Inputs.GlobalSecondaryIndexProvisionedThroughputArgs
{
WriteCapacityUnits = 10,
ReadCapacityUnits = 10,
},
KeySchemas = new[]
{
new Aws.DynamoDB.Inputs.GlobalSecondaryIndexKeySchemaArgs
{
AttributeName = "GameTitle",
AttributeType = "S",
KeyType = "HASH",
},
},
TableName = exampleTable.Name,
IndexName = "GameTitleIndex",
});
});
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 {
exampleTable, err := dynamodb.NewTable(ctx, "example", &dynamodb.TableArgs{
Attributes: dynamodb.TableAttributeArray{
&dynamodb.TableAttributeArgs{
Name: pulumi.String("UserId"),
Type: pulumi.String("S"),
},
&dynamodb.TableAttributeArgs{
Name: pulumi.String("GameTitle"),
Type: pulumi.String("S"),
},
},
Name: pulumi.String("example"),
BillingMode: pulumi.String("PROVISIONED"),
ReadCapacity: pulumi.Int(20),
WriteCapacity: pulumi.Int(20),
HashKey: pulumi.String("UserId"),
RangeKey: pulumi.String("GameTitle"),
})
if err != nil {
return err
}
_, err = dynamodb.NewGlobalSecondaryIndex(ctx, "example", &dynamodb.GlobalSecondaryIndexArgs{
Projection: &dynamodb.GlobalSecondaryIndexProjectionArgs{
ProjectionType: pulumi.String("INCLUDE"),
NonKeyAttributes: pulumi.StringArray{
pulumi.String("UserId"),
},
},
ProvisionedThroughput: &dynamodb.GlobalSecondaryIndexProvisionedThroughputArgs{
WriteCapacityUnits: pulumi.Int(10),
ReadCapacityUnits: pulumi.Int(10),
},
KeySchemas: dynamodb.GlobalSecondaryIndexKeySchemaArray{
&dynamodb.GlobalSecondaryIndexKeySchemaArgs{
AttributeName: pulumi.String("GameTitle"),
AttributeType: pulumi.String("S"),
KeyType: pulumi.String("HASH"),
},
},
TableName: exampleTable.Name,
IndexName: pulumi.String("GameTitleIndex"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_dynamodb_globalsecondaryindex" "example" {
projection = {
projection_type = "INCLUDE"
non_key_attributes = ["UserId"]
}
provisioned_throughput = {
write_capacity_units = 10
read_capacity_units = 10
}
key_schemas {
attribute_name = "GameTitle"
attribute_type = "S"
key_type = "HASH"
}
table_name = aws_dynamodb_table.example.name
index_name = "GameTitleIndex"
}
resource "aws_dynamodb_table" "example" {
attributes {
name = "UserId"
type = "S"
}
attributes {
name = "GameTitle"
type = "S"
}
name = "example"
billing_mode = "PROVISIONED"
read_capacity = 20
write_capacity = 20
hash_key = "UserId"
range_key = "GameTitle"
}
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.GlobalSecondaryIndex;
import com.pulumi.aws.dynamodb.GlobalSecondaryIndexArgs;
import com.pulumi.aws.dynamodb.inputs.GlobalSecondaryIndexProjectionArgs;
import com.pulumi.aws.dynamodb.inputs.GlobalSecondaryIndexProvisionedThroughputArgs;
import com.pulumi.aws.dynamodb.inputs.GlobalSecondaryIndexKeySchemaArgs;
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 exampleTable = new Table("exampleTable", TableArgs.builder()
.attributes(
TableAttributeArgs.builder()
.name("UserId")
.type("S")
.build(),
TableAttributeArgs.builder()
.name("GameTitle")
.type("S")
.build())
.name("example")
.billingMode("PROVISIONED")
.readCapacity(20)
.writeCapacity(20)
.hashKey("UserId")
.rangeKey("GameTitle")
.build());
var example = new GlobalSecondaryIndex("example", GlobalSecondaryIndexArgs.builder()
.projection(GlobalSecondaryIndexProjectionArgs.builder()
.projectionType("INCLUDE")
.nonKeyAttributes("UserId")
.build())
.provisionedThroughput(GlobalSecondaryIndexProvisionedThroughputArgs.builder()
.writeCapacityUnits(10)
.readCapacityUnits(10)
.build())
.keySchemas(GlobalSecondaryIndexKeySchemaArgs.builder()
.attributeName("GameTitle")
.attributeType("S")
.keyType("HASH")
.build())
.tableName(exampleTable.name())
.indexName("GameTitleIndex")
.build());
}
}
resources:
example:
type: aws:dynamodb:GlobalSecondaryIndex
properties:
projection:
projectionType: INCLUDE
nonKeyAttributes:
- UserId
provisionedThroughput:
writeCapacityUnits: 10
readCapacityUnits: 10
keySchemas:
- attributeName: GameTitle
attributeType: S
keyType: HASH
tableName: ${exampleTable.name}
indexName: GameTitleIndex
exampleTable:
type: aws:dynamodb:Table
name: example
properties:
attributes:
- name: UserId
type: S
- name: GameTitle
type: S
name: example
billingMode: PROVISIONED
readCapacity: 20
writeCapacity: 20
hashKey: UserId
rangeKey: GameTitle
Migrating
Use the following steps to migrate existing Global Secondary Indexes defined inline in globalSecondaryIndex on an aws.dynamodb.Table.
For each block globalSecondaryIndex create a new aws.dynamodb.GlobalSecondaryIndex resource with configuration corresponding to the existing block.
For example, starting with the following configuration:
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.dynamodb.Table("example", {
attributes: [
{
name: "example-key",
type: "S",
},
{
name: "example-gsi-key-1",
type: "S",
},
{
name: "example-gsi-key-2",
type: "S",
},
],
globalSecondaryIndexes: [
{
name: "example-index-1",
projectionType: "ALL",
hashKey: "example-gsi-key-1",
readCapacity: 1,
writeCapacity: 1,
},
{
name: "example-index-2",
projectionType: "ALL",
hashKey: "example-gsi-key-2",
readCapacity: 1,
writeCapacity: 1,
},
],
name: "example-table",
hashKey: "example-key",
readCapacity: 1,
writeCapacity: 1,
});
import pulumi
import pulumi_aws as aws
example = aws.dynamodb.Table("example",
attributes=[
{
"name": "example-key",
"type": "S",
},
{
"name": "example-gsi-key-1",
"type": "S",
},
{
"name": "example-gsi-key-2",
"type": "S",
},
],
global_secondary_indexes=[
{
"name": "example-index-1",
"projection_type": "ALL",
"hash_key": "example-gsi-key-1",
"read_capacity": 1,
"write_capacity": 1,
},
{
"name": "example-index-2",
"projection_type": "ALL",
"hash_key": "example-gsi-key-2",
"read_capacity": 1,
"write_capacity": 1,
},
],
name="example-table",
hash_key="example-key",
read_capacity=1,
write_capacity=1)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.DynamoDB.Table("example", new()
{
Attributes = new[]
{
new Aws.DynamoDB.Inputs.TableAttributeArgs
{
Name = "example-key",
Type = "S",
},
new Aws.DynamoDB.Inputs.TableAttributeArgs
{
Name = "example-gsi-key-1",
Type = "S",
},
new Aws.DynamoDB.Inputs.TableAttributeArgs
{
Name = "example-gsi-key-2",
Type = "S",
},
},
GlobalSecondaryIndexes = new[]
{
new Aws.DynamoDB.Inputs.TableGlobalSecondaryIndexArgs
{
Name = "example-index-1",
ProjectionType = "ALL",
HashKey = "example-gsi-key-1",
ReadCapacity = 1,
WriteCapacity = 1,
},
new Aws.DynamoDB.Inputs.TableGlobalSecondaryIndexArgs
{
Name = "example-index-2",
ProjectionType = "ALL",
HashKey = "example-gsi-key-2",
ReadCapacity = 1,
WriteCapacity = 1,
},
},
Name = "example-table",
HashKey = "example-key",
ReadCapacity = 1,
WriteCapacity = 1,
});
});
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 {
_, err := dynamodb.NewTable(ctx, "example", &dynamodb.TableArgs{
Attributes: dynamodb.TableAttributeArray{
&dynamodb.TableAttributeArgs{
Name: pulumi.String("example-key"),
Type: pulumi.String("S"),
},
&dynamodb.TableAttributeArgs{
Name: pulumi.String("example-gsi-key-1"),
Type: pulumi.String("S"),
},
&dynamodb.TableAttributeArgs{
Name: pulumi.String("example-gsi-key-2"),
Type: pulumi.String("S"),
},
},
GlobalSecondaryIndexes: dynamodb.TableGlobalSecondaryIndexArray{
&dynamodb.TableGlobalSecondaryIndexArgs{
Name: pulumi.String("example-index-1"),
ProjectionType: pulumi.String("ALL"),
HashKey: pulumi.String("example-gsi-key-1"),
ReadCapacity: pulumi.Int(1),
WriteCapacity: pulumi.Int(1),
},
&dynamodb.TableGlobalSecondaryIndexArgs{
Name: pulumi.String("example-index-2"),
ProjectionType: pulumi.String("ALL"),
HashKey: pulumi.String("example-gsi-key-2"),
ReadCapacity: pulumi.Int(1),
WriteCapacity: pulumi.Int(1),
},
},
Name: pulumi.String("example-table"),
HashKey: pulumi.String("example-key"),
ReadCapacity: pulumi.Int(1),
WriteCapacity: pulumi.Int(1),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_dynamodb_table" "example" {
attributes {
name = "example-key"
type = "S"
}
attributes {
name = "example-gsi-key-1"
type = "S"
}
attributes {
name = "example-gsi-key-2"
type = "S"
}
global_secondary_indexes {
name = "example-index-1"
projection_type = "ALL"
hash_key = "example-gsi-key-1"
read_capacity = 1
write_capacity = 1
}
global_secondary_indexes {
name = "example-index-2"
projection_type = "ALL"
hash_key = "example-gsi-key-2"
read_capacity = 1
write_capacity = 1
}
name = "example-table"
hash_key = "example-key"
read_capacity = 1
write_capacity = 1
}
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.inputs.TableGlobalSecondaryIndexArgs;
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("example-key")
.type("S")
.build(),
TableAttributeArgs.builder()
.name("example-gsi-key-1")
.type("S")
.build(),
TableAttributeArgs.builder()
.name("example-gsi-key-2")
.type("S")
.build())
.globalSecondaryIndexes(
TableGlobalSecondaryIndexArgs.builder()
.name("example-index-1")
.projectionType("ALL")
.hashKey("example-gsi-key-1")
.readCapacity(1)
.writeCapacity(1)
.build(),
TableGlobalSecondaryIndexArgs.builder()
.name("example-index-2")
.projectionType("ALL")
.hashKey("example-gsi-key-2")
.readCapacity(1)
.writeCapacity(1)
.build())
.name("example-table")
.hashKey("example-key")
.readCapacity(1)
.writeCapacity(1)
.build());
}
}
resources:
example:
type: aws:dynamodb:Table
properties:
attributes:
- name: example-key
type: S
- name: example-gsi-key-1
type: S
- name: example-gsi-key-2
type: S
globalSecondaryIndexes:
- name: example-index-1
projectionType: ALL
hashKey: example-gsi-key-1
readCapacity: 1
writeCapacity: 1
- name: example-index-2
projectionType: ALL
hashKey: example-gsi-key-2
readCapacity: 1
writeCapacity: 1
name: example-table
hashKey: example-key
readCapacity: 1
writeCapacity: 1
Update the configuration to the following. Note that the schema of aws.dynamodb.GlobalSecondaryIndex has some differences with globalSecondaryIndex on aws.dynamodb.Table.
If using Terraform versions prior to v1.5.0, remove the import blocks and use the pulumi import command.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import DynamoDB tables using the tableName and indexName, separated by a comma. For example:
$ pulumi import aws:dynamodb/globalSecondaryIndex:GlobalSecondaryIndex example 'example-table,example-index'
Constructors
- GlobalSecondaryIndex(String name, {GlobalSecondaryIndexArgs? args, CustomResourceOptions? options})
-
Creates a new GlobalSecondaryIndex.
nameThe Pulumi resource name.argsArguments used to configure this GlobalSecondaryIndex. The set of arguments for GlobalSecondaryIndex.optionsResource options controlling this resource's behavior. - GlobalSecondaryIndex.reference(String urn)
- Creates a typed reference to an existing GlobalSecondaryIndex resource.
Properties
-
arn
↔ Output<
String> -
ARN of the GSI.
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
-
indexName
↔ Output<
String> -
Name of the index.
latefinal
- 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
-
keySchemas
↔ Output<
List< GlobalSecondaryIndexKeySchema> > -
Set of nested attribute definitions.
At least 1 element defining a
HASHis required. All elements with thekeyTypeofHASHmust precede elements withkeyTypeofRANGE. Changing any values inkeySchemawill re-create the resource. SeekeySchemabelow.latefinal -
onDemandThroughput
↔ Output<
GlobalSecondaryIndexOnDemandThroughput?> -
Sets the maximum number of read and write units for the index.
See
onDemandThroughputbelow. Only valid if the table'sbillingModeisPAY_PER_REQUEST.latefinal -
projection
↔ Output<
GlobalSecondaryIndexProjection?> -
Describes which attributes from the table are represented in the index.
See
projectionbelow.latefinal -
provisionedThroughput
↔ Output<
GlobalSecondaryIndexProvisionedThroughput?> -
Provisioned throughput for the index.
See
provisionedThroughputbelow. Required if the table'sbillingModeisPROVISIONED.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
-
tableName
↔ Output<
String> -
Name of the table this index belongs to.
latefinal
-
timeouts
↔ Output<
GlobalSecondaryIndexTimeouts?> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
warmThroughput
↔ Output<
GlobalSecondaryIndexWarmThroughput> -
Sets the number of warm read and write units for this index.
See
warmThroughputbelow.latefinal
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, {GlobalSecondaryIndexState? state, CustomResourceOptions? options}) → GlobalSecondaryIndex -
Gets an existing GlobalSecondaryIndex resource's state with the given
nameandid.