!> The resource type aws.dynamodb.GlobalSecondaryIndex is an experimental feature. The schema or behavior may change without notice, and it is not subject to the backwards compatibility guarantee of the provider.
The resource type
aws.dynamodb.GlobalSecondaryIndexcan be enabled by setting the environment variableTF_AWS_EXPERIMENT_dynamodb_global_secondary_indexto any value. If not enabled, use ofaws.dynamodb.GlobalSecondaryIndexwill result in an error when running Terraform.
Please provide feedback, positive or negative, at https://github.com/hashicorp/terraform-provider-aws/issues/45640. User feedback will determine if this experiment is a success.
!> WARNING: Do not combine aws.dynamodb.GlobalSecondaryIndex resources in conjunction with global_secondary_index 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", {
name: "example",
billingMode: "PROVISIONED",
readCapacity: 20,
writeCapacity: 20,
hashKey: "UserId",
rangeKey: "GameTitle",
attributes: [
{
name: "UserId",
type: "S",
},
{
name: "GameTitle",
type: "S",
},
],
});
const example = new aws.dynamodb.GlobalSecondaryIndex("example", {
tableName: exampleTable.name,
indexName: "GameTitleIndex",
projection: {
projectionType: "INCLUDE",
nonKeyAttributes: ["UserId"],
},
provisionedThroughput: {
writeCapacityUnits: 10,
readCapacityUnits: 10,
},
keySchemas: [{
attributeName: "GameTitle",
attributeType: "S",
keyType: "HASH",
}],
});
import pulumi
import pulumi_aws as aws
example_table = aws.dynamodb.Table("example",
name="example",
billing_mode="PROVISIONED",
read_capacity=20,
write_capacity=20,
hash_key="UserId",
range_key="GameTitle",
attributes=[
{
"name": "UserId",
"type": "S",
},
{
"name": "GameTitle",
"type": "S",
},
])
example = aws.dynamodb.GlobalSecondaryIndex("example",
table_name=example_table.name,
index_name="GameTitleIndex",
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",
}])
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{
Name: pulumi.String("example"),
BillingMode: pulumi.String("PROVISIONED"),
ReadCapacity: pulumi.Int(20),
WriteCapacity: pulumi.Int(20),
HashKey: pulumi.String("UserId"),
RangeKey: pulumi.String("GameTitle"),
Attributes: dynamodb.TableAttributeArray{
&dynamodb.TableAttributeArgs{
Name: pulumi.String("UserId"),
Type: pulumi.String("S"),
},
&dynamodb.TableAttributeArgs{
Name: pulumi.String("GameTitle"),
Type: pulumi.String("S"),
},
},
})
if err != nil {
return err
}
_, err = dynamodb.NewGlobalSecondaryIndex(ctx, "example", &dynamodb.GlobalSecondaryIndexArgs{
TableName: exampleTable.Name,
IndexName: pulumi.String("GameTitleIndex"),
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"),
},
},
})
if err != nil {
return err
}
return nil
})
}
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()
{
Name = "example",
BillingMode = "PROVISIONED",
ReadCapacity = 20,
WriteCapacity = 20,
HashKey = "UserId",
RangeKey = "GameTitle",
Attributes = new[]
{
new Aws.DynamoDB.Inputs.TableAttributeArgs
{
Name = "UserId",
Type = "S",
},
new Aws.DynamoDB.Inputs.TableAttributeArgs
{
Name = "GameTitle",
Type = "S",
},
},
});
var example = new Aws.DynamoDB.GlobalSecondaryIndex("example", new()
{
TableName = exampleTable.Name,
IndexName = "GameTitleIndex",
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",
},
},
});
});
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.List;
import java.util.ArrayList;
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()
.name("example")
.billingMode("PROVISIONED")
.readCapacity(20)
.writeCapacity(20)
.hashKey("UserId")
.rangeKey("GameTitle")
.attributes(
TableAttributeArgs.builder()
.name("UserId")
.type("S")
.build(),
TableAttributeArgs.builder()
.name("GameTitle")
.type("S")
.build())
.build());
var example = new GlobalSecondaryIndex("example", GlobalSecondaryIndexArgs.builder()
.tableName(exampleTable.name())
.indexName("GameTitleIndex")
.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())
.build());
}
}
resources:
example:
type: aws:dynamodb:GlobalSecondaryIndex
properties:
tableName: ${exampleTable.name}
indexName: GameTitleIndex
projection:
projectionType: INCLUDE
nonKeyAttributes:
- UserId
provisionedThroughput:
writeCapacityUnits: 10
readCapacityUnits: 10
keySchemas:
- attributeName: GameTitle
attributeType: S
keyType: HASH
exampleTable:
type: aws:dynamodb:Table
name: example
properties:
name: example
billingMode: PROVISIONED
readCapacity: 20
writeCapacity: 20
hashKey: UserId
rangeKey: GameTitle
attributes:
- name: UserId
type: S
- name: GameTitle
type: S
Migrating
Use the following steps to migrate existing Global Secondary Indexes defined inline in global_secondary_index on an aws.dynamodb.Table.
For each block global_secondary_index 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", {
name: "example-table",
hashKey: "example-key",
readCapacity: 1,
writeCapacity: 1,
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,
},
],
attributes: [
{
name: "example-key",
type: "S",
},
{
name: "example-gsi-key-1",
type: "S",
},
{
name: "example-gsi-key-2",
type: "S",
},
],
});
import pulumi
import pulumi_aws as aws
example = aws.dynamodb.Table("example",
name="example-table",
hash_key="example-key",
read_capacity=1,
write_capacity=1,
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,
},
],
attributes=[
{
"name": "example-key",
"type": "S",
},
{
"name": "example-gsi-key-1",
"type": "S",
},
{
"name": "example-gsi-key-2",
"type": "S",
},
])
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{
Name: pulumi.String("example-table"),
HashKey: pulumi.String("example-key"),
ReadCapacity: pulumi.Int(1),
WriteCapacity: pulumi.Int(1),
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),
},
},
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"),
},
},
})
if err != nil {
return err
}
return nil
})
}
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()
{
Name = "example-table",
HashKey = "example-key",
ReadCapacity = 1,
WriteCapacity = 1,
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,
},
},
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",
},
},
});
});
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.TableGlobalSecondaryIndexArgs;
import com.pulumi.aws.dynamodb.inputs.TableAttributeArgs;
import java.util.List;
import java.util.ArrayList;
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()
.name("example-table")
.hashKey("example-key")
.readCapacity(1)
.writeCapacity(1)
.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())
.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())
.build());
}
}
resources:
example:
type: aws:dynamodb:Table
properties:
name: example-table
hashKey: example-key
readCapacity: 1
writeCapacity: 1
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
attributes:
- name: example-key
type: S
- name: example-gsi-key-1
type: S
- name: example-gsi-key-2
type: S
Update the configuration to the following. Note that the schema of aws.dynamodb.GlobalSecondaryIndex has some differences with global_secondary_index on aws.dynamodb.Table.
If using Terraform versions prior to v1.5.0, remove the import blocks and use the pulumi import command.
Optional
account_id(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import DynamoDB tables using the table_name and index_name, separated by a comma. For example:
$ pulumi import aws:dynamodb/globalSecondaryIndex:GlobalSecondaryIndex example 'example-table,example-index'
Create GlobalSecondaryIndex Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GlobalSecondaryIndex(name: string, args: GlobalSecondaryIndexArgs, opts?: CustomResourceOptions);@overload
def GlobalSecondaryIndex(resource_name: str,
args: GlobalSecondaryIndexArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GlobalSecondaryIndex(resource_name: str,
opts: Optional[ResourceOptions] = None,
index_name: Optional[str] = None,
table_name: Optional[str] = None,
key_schemas: Optional[Sequence[GlobalSecondaryIndexKeySchemaArgs]] = None,
on_demand_throughput: Optional[GlobalSecondaryIndexOnDemandThroughputArgs] = None,
projection: Optional[GlobalSecondaryIndexProjectionArgs] = None,
provisioned_throughput: Optional[GlobalSecondaryIndexProvisionedThroughputArgs] = None,
region: Optional[str] = None,
timeouts: Optional[GlobalSecondaryIndexTimeoutsArgs] = None,
warm_throughput: Optional[GlobalSecondaryIndexWarmThroughputArgs] = None)func NewGlobalSecondaryIndex(ctx *Context, name string, args GlobalSecondaryIndexArgs, opts ...ResourceOption) (*GlobalSecondaryIndex, error)public GlobalSecondaryIndex(string name, GlobalSecondaryIndexArgs args, CustomResourceOptions? opts = null)
public GlobalSecondaryIndex(String name, GlobalSecondaryIndexArgs args)
public GlobalSecondaryIndex(String name, GlobalSecondaryIndexArgs args, CustomResourceOptions options)
type: aws:dynamodb:GlobalSecondaryIndex
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args GlobalSecondaryIndexArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args GlobalSecondaryIndexArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args GlobalSecondaryIndexArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GlobalSecondaryIndexArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GlobalSecondaryIndexArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var globalSecondaryIndexResource = new Aws.DynamoDB.GlobalSecondaryIndex("globalSecondaryIndexResource", new()
{
IndexName = "string",
TableName = "string",
KeySchemas = new[]
{
new Aws.DynamoDB.Inputs.GlobalSecondaryIndexKeySchemaArgs
{
AttributeName = "string",
AttributeType = "string",
KeyType = "string",
},
},
OnDemandThroughput = new Aws.DynamoDB.Inputs.GlobalSecondaryIndexOnDemandThroughputArgs
{
MaxReadRequestUnits = 0,
MaxWriteRequestUnits = 0,
},
Projection = new Aws.DynamoDB.Inputs.GlobalSecondaryIndexProjectionArgs
{
ProjectionType = "string",
NonKeyAttributes = new[]
{
"string",
},
},
ProvisionedThroughput = new Aws.DynamoDB.Inputs.GlobalSecondaryIndexProvisionedThroughputArgs
{
ReadCapacityUnits = 0,
WriteCapacityUnits = 0,
},
Region = "string",
Timeouts = new Aws.DynamoDB.Inputs.GlobalSecondaryIndexTimeoutsArgs
{
Create = "string",
Delete = "string",
Update = "string",
},
WarmThroughput = new Aws.DynamoDB.Inputs.GlobalSecondaryIndexWarmThroughputArgs
{
ReadUnitsPerSecond = 0,
WriteUnitsPerSecond = 0,
},
});
example, err := dynamodb.NewGlobalSecondaryIndex(ctx, "globalSecondaryIndexResource", &dynamodb.GlobalSecondaryIndexArgs{
IndexName: pulumi.String("string"),
TableName: pulumi.String("string"),
KeySchemas: dynamodb.GlobalSecondaryIndexKeySchemaArray{
&dynamodb.GlobalSecondaryIndexKeySchemaArgs{
AttributeName: pulumi.String("string"),
AttributeType: pulumi.String("string"),
KeyType: pulumi.String("string"),
},
},
OnDemandThroughput: &dynamodb.GlobalSecondaryIndexOnDemandThroughputArgs{
MaxReadRequestUnits: pulumi.Int(0),
MaxWriteRequestUnits: pulumi.Int(0),
},
Projection: &dynamodb.GlobalSecondaryIndexProjectionArgs{
ProjectionType: pulumi.String("string"),
NonKeyAttributes: pulumi.StringArray{
pulumi.String("string"),
},
},
ProvisionedThroughput: &dynamodb.GlobalSecondaryIndexProvisionedThroughputArgs{
ReadCapacityUnits: pulumi.Int(0),
WriteCapacityUnits: pulumi.Int(0),
},
Region: pulumi.String("string"),
Timeouts: &dynamodb.GlobalSecondaryIndexTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
WarmThroughput: &dynamodb.GlobalSecondaryIndexWarmThroughputArgs{
ReadUnitsPerSecond: pulumi.Int(0),
WriteUnitsPerSecond: pulumi.Int(0),
},
})
var globalSecondaryIndexResource = new GlobalSecondaryIndex("globalSecondaryIndexResource", GlobalSecondaryIndexArgs.builder()
.indexName("string")
.tableName("string")
.keySchemas(GlobalSecondaryIndexKeySchemaArgs.builder()
.attributeName("string")
.attributeType("string")
.keyType("string")
.build())
.onDemandThroughput(GlobalSecondaryIndexOnDemandThroughputArgs.builder()
.maxReadRequestUnits(0)
.maxWriteRequestUnits(0)
.build())
.projection(GlobalSecondaryIndexProjectionArgs.builder()
.projectionType("string")
.nonKeyAttributes("string")
.build())
.provisionedThroughput(GlobalSecondaryIndexProvisionedThroughputArgs.builder()
.readCapacityUnits(0)
.writeCapacityUnits(0)
.build())
.region("string")
.timeouts(GlobalSecondaryIndexTimeoutsArgs.builder()
.create("string")
.delete("string")
.update("string")
.build())
.warmThroughput(GlobalSecondaryIndexWarmThroughputArgs.builder()
.readUnitsPerSecond(0)
.writeUnitsPerSecond(0)
.build())
.build());
global_secondary_index_resource = aws.dynamodb.GlobalSecondaryIndex("globalSecondaryIndexResource",
index_name="string",
table_name="string",
key_schemas=[{
"attribute_name": "string",
"attribute_type": "string",
"key_type": "string",
}],
on_demand_throughput={
"max_read_request_units": 0,
"max_write_request_units": 0,
},
projection={
"projection_type": "string",
"non_key_attributes": ["string"],
},
provisioned_throughput={
"read_capacity_units": 0,
"write_capacity_units": 0,
},
region="string",
timeouts={
"create": "string",
"delete": "string",
"update": "string",
},
warm_throughput={
"read_units_per_second": 0,
"write_units_per_second": 0,
})
const globalSecondaryIndexResource = new aws.dynamodb.GlobalSecondaryIndex("globalSecondaryIndexResource", {
indexName: "string",
tableName: "string",
keySchemas: [{
attributeName: "string",
attributeType: "string",
keyType: "string",
}],
onDemandThroughput: {
maxReadRequestUnits: 0,
maxWriteRequestUnits: 0,
},
projection: {
projectionType: "string",
nonKeyAttributes: ["string"],
},
provisionedThroughput: {
readCapacityUnits: 0,
writeCapacityUnits: 0,
},
region: "string",
timeouts: {
create: "string",
"delete": "string",
update: "string",
},
warmThroughput: {
readUnitsPerSecond: 0,
writeUnitsPerSecond: 0,
},
});
type: aws:dynamodb:GlobalSecondaryIndex
properties:
indexName: string
keySchemas:
- attributeName: string
attributeType: string
keyType: string
onDemandThroughput:
maxReadRequestUnits: 0
maxWriteRequestUnits: 0
projection:
nonKeyAttributes:
- string
projectionType: string
provisionedThroughput:
readCapacityUnits: 0
writeCapacityUnits: 0
region: string
tableName: string
timeouts:
create: string
delete: string
update: string
warmThroughput:
readUnitsPerSecond: 0
writeUnitsPerSecond: 0
GlobalSecondaryIndex Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The GlobalSecondaryIndex resource accepts the following input properties:
- Index
Name string - Name of the index.
- Table
Name string Name of the table this index belongs to.
The following arguments are optional:
- Key
Schemas List<GlobalSecondary Index Key Schema> - Set of nested attribute definitions.
At least 1 element defining a
HASHis required. All elements with thekey_typeofHASHmust precede elements withkey_typeofRANGE. Changing any values inkey_schemawill re-create the resource. Seekey_schemabelow. - On
Demand GlobalThroughput Secondary Index On Demand Throughput - Sets the maximum number of read and write units for the index.
See
on_demand_throughputbelow. Only valid if the table'sbilling_modeisPAY_PER_REQUEST. - Projection
Global
Secondary Index Projection - Describes which attributes from the table are represented in the index.
See
projectionbelow. - Provisioned
Throughput GlobalSecondary Index Provisioned Throughput - Provisioned throughput for the index.
See
provisioned_throughputbelow. Required if the table'sbilling_modeisPROVISIONED. - Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Timeouts
Global
Secondary Index Timeouts - Warm
Throughput GlobalSecondary Index Warm Throughput - Sets the number of warm read and write units for this index.
See
warm_throughputbelow.
- Index
Name string - Name of the index.
- Table
Name string Name of the table this index belongs to.
The following arguments are optional:
- Key
Schemas []GlobalSecondary Index Key Schema Args - Set of nested attribute definitions.
At least 1 element defining a
HASHis required. All elements with thekey_typeofHASHmust precede elements withkey_typeofRANGE. Changing any values inkey_schemawill re-create the resource. Seekey_schemabelow. - On
Demand GlobalThroughput Secondary Index On Demand Throughput Args - Sets the maximum number of read and write units for the index.
See
on_demand_throughputbelow. Only valid if the table'sbilling_modeisPAY_PER_REQUEST. - Projection
Global
Secondary Index Projection Args - Describes which attributes from the table are represented in the index.
See
projectionbelow. - Provisioned
Throughput GlobalSecondary Index Provisioned Throughput Args - Provisioned throughput for the index.
See
provisioned_throughputbelow. Required if the table'sbilling_modeisPROVISIONED. - Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Timeouts
Global
Secondary Index Timeouts Args - Warm
Throughput GlobalSecondary Index Warm Throughput Args - Sets the number of warm read and write units for this index.
See
warm_throughputbelow.
- index
Name String - Name of the index.
- table
Name String Name of the table this index belongs to.
The following arguments are optional:
- key
Schemas List<GlobalSecondary Index Key Schema> - Set of nested attribute definitions.
At least 1 element defining a
HASHis required. All elements with thekey_typeofHASHmust precede elements withkey_typeofRANGE. Changing any values inkey_schemawill re-create the resource. Seekey_schemabelow. - on
Demand GlobalThroughput Secondary Index On Demand Throughput - Sets the maximum number of read and write units for the index.
See
on_demand_throughputbelow. Only valid if the table'sbilling_modeisPAY_PER_REQUEST. - projection
Global
Secondary Index Projection - Describes which attributes from the table are represented in the index.
See
projectionbelow. - provisioned
Throughput GlobalSecondary Index Provisioned Throughput - Provisioned throughput for the index.
See
provisioned_throughputbelow. Required if the table'sbilling_modeisPROVISIONED. - region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- timeouts
Global
Secondary Index Timeouts - warm
Throughput GlobalSecondary Index Warm Throughput - Sets the number of warm read and write units for this index.
See
warm_throughputbelow.
- index
Name string - Name of the index.
- table
Name string Name of the table this index belongs to.
The following arguments are optional:
- key
Schemas GlobalSecondary Index Key Schema[] - Set of nested attribute definitions.
At least 1 element defining a
HASHis required. All elements with thekey_typeofHASHmust precede elements withkey_typeofRANGE. Changing any values inkey_schemawill re-create the resource. Seekey_schemabelow. - on
Demand GlobalThroughput Secondary Index On Demand Throughput - Sets the maximum number of read and write units for the index.
See
on_demand_throughputbelow. Only valid if the table'sbilling_modeisPAY_PER_REQUEST. - projection
Global
Secondary Index Projection - Describes which attributes from the table are represented in the index.
See
projectionbelow. - provisioned
Throughput GlobalSecondary Index Provisioned Throughput - Provisioned throughput for the index.
See
provisioned_throughputbelow. Required if the table'sbilling_modeisPROVISIONED. - region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- timeouts
Global
Secondary Index Timeouts - warm
Throughput GlobalSecondary Index Warm Throughput - Sets the number of warm read and write units for this index.
See
warm_throughputbelow.
- index_
name str - Name of the index.
- table_
name str Name of the table this index belongs to.
The following arguments are optional:
- key_
schemas Sequence[GlobalSecondary Index Key Schema Args] - Set of nested attribute definitions.
At least 1 element defining a
HASHis required. All elements with thekey_typeofHASHmust precede elements withkey_typeofRANGE. Changing any values inkey_schemawill re-create the resource. Seekey_schemabelow. - on_
demand_ Globalthroughput Secondary Index On Demand Throughput Args - Sets the maximum number of read and write units for the index.
See
on_demand_throughputbelow. Only valid if the table'sbilling_modeisPAY_PER_REQUEST. - projection
Global
Secondary Index Projection Args - Describes which attributes from the table are represented in the index.
See
projectionbelow. - provisioned_
throughput GlobalSecondary Index Provisioned Throughput Args - Provisioned throughput for the index.
See
provisioned_throughputbelow. Required if the table'sbilling_modeisPROVISIONED. - region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- timeouts
Global
Secondary Index Timeouts Args - warm_
throughput GlobalSecondary Index Warm Throughput Args - Sets the number of warm read and write units for this index.
See
warm_throughputbelow.
- index
Name String - Name of the index.
- table
Name String Name of the table this index belongs to.
The following arguments are optional:
- key
Schemas List<Property Map> - Set of nested attribute definitions.
At least 1 element defining a
HASHis required. All elements with thekey_typeofHASHmust precede elements withkey_typeofRANGE. Changing any values inkey_schemawill re-create the resource. Seekey_schemabelow. - on
Demand Property MapThroughput - Sets the maximum number of read and write units for the index.
See
on_demand_throughputbelow. Only valid if the table'sbilling_modeisPAY_PER_REQUEST. - projection Property Map
- Describes which attributes from the table are represented in the index.
See
projectionbelow. - provisioned
Throughput Property Map - Provisioned throughput for the index.
See
provisioned_throughputbelow. Required if the table'sbilling_modeisPROVISIONED. - region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- timeouts Property Map
- warm
Throughput Property Map - Sets the number of warm read and write units for this index.
See
warm_throughputbelow.
Outputs
All input properties are implicitly available as output properties. Additionally, the GlobalSecondaryIndex resource produces the following output properties:
Look up Existing GlobalSecondaryIndex Resource
Get an existing GlobalSecondaryIndex resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: GlobalSecondaryIndexState, opts?: CustomResourceOptions): GlobalSecondaryIndex@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
index_name: Optional[str] = None,
key_schemas: Optional[Sequence[GlobalSecondaryIndexKeySchemaArgs]] = None,
on_demand_throughput: Optional[GlobalSecondaryIndexOnDemandThroughputArgs] = None,
projection: Optional[GlobalSecondaryIndexProjectionArgs] = None,
provisioned_throughput: Optional[GlobalSecondaryIndexProvisionedThroughputArgs] = None,
region: Optional[str] = None,
table_name: Optional[str] = None,
timeouts: Optional[GlobalSecondaryIndexTimeoutsArgs] = None,
warm_throughput: Optional[GlobalSecondaryIndexWarmThroughputArgs] = None) -> GlobalSecondaryIndexfunc GetGlobalSecondaryIndex(ctx *Context, name string, id IDInput, state *GlobalSecondaryIndexState, opts ...ResourceOption) (*GlobalSecondaryIndex, error)public static GlobalSecondaryIndex Get(string name, Input<string> id, GlobalSecondaryIndexState? state, CustomResourceOptions? opts = null)public static GlobalSecondaryIndex get(String name, Output<String> id, GlobalSecondaryIndexState state, CustomResourceOptions options)resources: _: type: aws:dynamodb:GlobalSecondaryIndex get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- ARN of the GSI.
- Index
Name string - Name of the index.
- Key
Schemas List<GlobalSecondary Index Key Schema> - Set of nested attribute definitions.
At least 1 element defining a
HASHis required. All elements with thekey_typeofHASHmust precede elements withkey_typeofRANGE. Changing any values inkey_schemawill re-create the resource. Seekey_schemabelow. - On
Demand GlobalThroughput Secondary Index On Demand Throughput - Sets the maximum number of read and write units for the index.
See
on_demand_throughputbelow. Only valid if the table'sbilling_modeisPAY_PER_REQUEST. - Projection
Global
Secondary Index Projection - Describes which attributes from the table are represented in the index.
See
projectionbelow. - Provisioned
Throughput GlobalSecondary Index Provisioned Throughput - Provisioned throughput for the index.
See
provisioned_throughputbelow. Required if the table'sbilling_modeisPROVISIONED. - Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Table
Name string Name of the table this index belongs to.
The following arguments are optional:
- Timeouts
Global
Secondary Index Timeouts - Warm
Throughput GlobalSecondary Index Warm Throughput - Sets the number of warm read and write units for this index.
See
warm_throughputbelow.
- Arn string
- ARN of the GSI.
- Index
Name string - Name of the index.
- Key
Schemas []GlobalSecondary Index Key Schema Args - Set of nested attribute definitions.
At least 1 element defining a
HASHis required. All elements with thekey_typeofHASHmust precede elements withkey_typeofRANGE. Changing any values inkey_schemawill re-create the resource. Seekey_schemabelow. - On
Demand GlobalThroughput Secondary Index On Demand Throughput Args - Sets the maximum number of read and write units for the index.
See
on_demand_throughputbelow. Only valid if the table'sbilling_modeisPAY_PER_REQUEST. - Projection
Global
Secondary Index Projection Args - Describes which attributes from the table are represented in the index.
See
projectionbelow. - Provisioned
Throughput GlobalSecondary Index Provisioned Throughput Args - Provisioned throughput for the index.
See
provisioned_throughputbelow. Required if the table'sbilling_modeisPROVISIONED. - Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Table
Name string Name of the table this index belongs to.
The following arguments are optional:
- Timeouts
Global
Secondary Index Timeouts Args - Warm
Throughput GlobalSecondary Index Warm Throughput Args - Sets the number of warm read and write units for this index.
See
warm_throughputbelow.
- arn String
- ARN of the GSI.
- index
Name String - Name of the index.
- key
Schemas List<GlobalSecondary Index Key Schema> - Set of nested attribute definitions.
At least 1 element defining a
HASHis required. All elements with thekey_typeofHASHmust precede elements withkey_typeofRANGE. Changing any values inkey_schemawill re-create the resource. Seekey_schemabelow. - on
Demand GlobalThroughput Secondary Index On Demand Throughput - Sets the maximum number of read and write units for the index.
See
on_demand_throughputbelow. Only valid if the table'sbilling_modeisPAY_PER_REQUEST. - projection
Global
Secondary Index Projection - Describes which attributes from the table are represented in the index.
See
projectionbelow. - provisioned
Throughput GlobalSecondary Index Provisioned Throughput - Provisioned throughput for the index.
See
provisioned_throughputbelow. Required if the table'sbilling_modeisPROVISIONED. - region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- table
Name String Name of the table this index belongs to.
The following arguments are optional:
- timeouts
Global
Secondary Index Timeouts - warm
Throughput GlobalSecondary Index Warm Throughput - Sets the number of warm read and write units for this index.
See
warm_throughputbelow.
- arn string
- ARN of the GSI.
- index
Name string - Name of the index.
- key
Schemas GlobalSecondary Index Key Schema[] - Set of nested attribute definitions.
At least 1 element defining a
HASHis required. All elements with thekey_typeofHASHmust precede elements withkey_typeofRANGE. Changing any values inkey_schemawill re-create the resource. Seekey_schemabelow. - on
Demand GlobalThroughput Secondary Index On Demand Throughput - Sets the maximum number of read and write units for the index.
See
on_demand_throughputbelow. Only valid if the table'sbilling_modeisPAY_PER_REQUEST. - projection
Global
Secondary Index Projection - Describes which attributes from the table are represented in the index.
See
projectionbelow. - provisioned
Throughput GlobalSecondary Index Provisioned Throughput - Provisioned throughput for the index.
See
provisioned_throughputbelow. Required if the table'sbilling_modeisPROVISIONED. - region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- table
Name string Name of the table this index belongs to.
The following arguments are optional:
- timeouts
Global
Secondary Index Timeouts - warm
Throughput GlobalSecondary Index Warm Throughput - Sets the number of warm read and write units for this index.
See
warm_throughputbelow.
- arn str
- ARN of the GSI.
- index_
name str - Name of the index.
- key_
schemas Sequence[GlobalSecondary Index Key Schema Args] - Set of nested attribute definitions.
At least 1 element defining a
HASHis required. All elements with thekey_typeofHASHmust precede elements withkey_typeofRANGE. Changing any values inkey_schemawill re-create the resource. Seekey_schemabelow. - on_
demand_ Globalthroughput Secondary Index On Demand Throughput Args - Sets the maximum number of read and write units for the index.
See
on_demand_throughputbelow. Only valid if the table'sbilling_modeisPAY_PER_REQUEST. - projection
Global
Secondary Index Projection Args - Describes which attributes from the table are represented in the index.
See
projectionbelow. - provisioned_
throughput GlobalSecondary Index Provisioned Throughput Args - Provisioned throughput for the index.
See
provisioned_throughputbelow. Required if the table'sbilling_modeisPROVISIONED. - region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- table_
name str Name of the table this index belongs to.
The following arguments are optional:
- timeouts
Global
Secondary Index Timeouts Args - warm_
throughput GlobalSecondary Index Warm Throughput Args - Sets the number of warm read and write units for this index.
See
warm_throughputbelow.
- arn String
- ARN of the GSI.
- index
Name String - Name of the index.
- key
Schemas List<Property Map> - Set of nested attribute definitions.
At least 1 element defining a
HASHis required. All elements with thekey_typeofHASHmust precede elements withkey_typeofRANGE. Changing any values inkey_schemawill re-create the resource. Seekey_schemabelow. - on
Demand Property MapThroughput - Sets the maximum number of read and write units for the index.
See
on_demand_throughputbelow. Only valid if the table'sbilling_modeisPAY_PER_REQUEST. - projection Property Map
- Describes which attributes from the table are represented in the index.
See
projectionbelow. - provisioned
Throughput Property Map - Provisioned throughput for the index.
See
provisioned_throughputbelow. Required if the table'sbilling_modeisPROVISIONED. - region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- table
Name String Name of the table this index belongs to.
The following arguments are optional:
- timeouts Property Map
- warm
Throughput Property Map - Sets the number of warm read and write units for this index.
See
warm_throughputbelow.
Supporting Types
GlobalSecondaryIndexKeySchema, GlobalSecondaryIndexKeySchemaArgs
- Attribute
Name string - Name of the attribute.
- Attribute
Type string - Type of the attribute in the index.
Valid values are
S(string),N(number), orB(binary). - Key
Type string - Key type.
Valid values are
HASHorRANGE.
- Attribute
Name string - Name of the attribute.
- Attribute
Type string - Type of the attribute in the index.
Valid values are
S(string),N(number), orB(binary). - Key
Type string - Key type.
Valid values are
HASHorRANGE.
- attribute
Name String - Name of the attribute.
- attribute
Type String - Type of the attribute in the index.
Valid values are
S(string),N(number), orB(binary). - key
Type String - Key type.
Valid values are
HASHorRANGE.
- attribute
Name string - Name of the attribute.
- attribute
Type string - Type of the attribute in the index.
Valid values are
S(string),N(number), orB(binary). - key
Type string - Key type.
Valid values are
HASHorRANGE.
- attribute_
name str - Name of the attribute.
- attribute_
type str - Type of the attribute in the index.
Valid values are
S(string),N(number), orB(binary). - key_
type str - Key type.
Valid values are
HASHorRANGE.
- attribute
Name String - Name of the attribute.
- attribute
Type String - Type of the attribute in the index.
Valid values are
S(string),N(number), orB(binary). - key
Type String - Key type.
Valid values are
HASHorRANGE.
GlobalSecondaryIndexOnDemandThroughput, GlobalSecondaryIndexOnDemandThroughputArgs
- Max
Read intRequest Units - Maximum number of read request units for this index.
- Max
Write intRequest Units - Maximum number of write request units for this index.
- Max
Read intRequest Units - Maximum number of read request units for this index.
- Max
Write intRequest Units - Maximum number of write request units for this index.
- max
Read IntegerRequest Units - Maximum number of read request units for this index.
- max
Write IntegerRequest Units - Maximum number of write request units for this index.
- max
Read numberRequest Units - Maximum number of read request units for this index.
- max
Write numberRequest Units - Maximum number of write request units for this index.
- max_
read_ intrequest_ units - Maximum number of read request units for this index.
- max_
write_ intrequest_ units - Maximum number of write request units for this index.
- max
Read NumberRequest Units - Maximum number of read request units for this index.
- max
Write NumberRequest Units - Maximum number of write request units for this index.
GlobalSecondaryIndexProjection, GlobalSecondaryIndexProjectionArgs
- Projection
Type string - The set of attributes represented in the index.
One of
ALL,INCLUDE, orKEYS_ONLY. - Non
Key List<string>Attributes - Specifies which additional attributes to include in the index.
Only valid when
projection_typeisINCLUDE.`
- Projection
Type string - The set of attributes represented in the index.
One of
ALL,INCLUDE, orKEYS_ONLY. - Non
Key []stringAttributes - Specifies which additional attributes to include in the index.
Only valid when
projection_typeisINCLUDE.`
- projection
Type String - The set of attributes represented in the index.
One of
ALL,INCLUDE, orKEYS_ONLY. - non
Key List<String>Attributes - Specifies which additional attributes to include in the index.
Only valid when
projection_typeisINCLUDE.`
- projection
Type string - The set of attributes represented in the index.
One of
ALL,INCLUDE, orKEYS_ONLY. - non
Key string[]Attributes - Specifies which additional attributes to include in the index.
Only valid when
projection_typeisINCLUDE.`
- projection_
type str - The set of attributes represented in the index.
One of
ALL,INCLUDE, orKEYS_ONLY. - non_
key_ Sequence[str]attributes - Specifies which additional attributes to include in the index.
Only valid when
projection_typeisINCLUDE.`
- projection
Type String - The set of attributes represented in the index.
One of
ALL,INCLUDE, orKEYS_ONLY. - non
Key List<String>Attributes - Specifies which additional attributes to include in the index.
Only valid when
projection_typeisINCLUDE.`
GlobalSecondaryIndexProvisionedThroughput, GlobalSecondaryIndexProvisionedThroughputArgs
- Read
Capacity intUnits - Number of read capacity units for this index.
- Write
Capacity intUnits - Number of write capacity units for this index.
- Read
Capacity intUnits - Number of read capacity units for this index.
- Write
Capacity intUnits - Number of write capacity units for this index.
- read
Capacity IntegerUnits - Number of read capacity units for this index.
- write
Capacity IntegerUnits - Number of write capacity units for this index.
- read
Capacity numberUnits - Number of read capacity units for this index.
- write
Capacity numberUnits - Number of write capacity units for this index.
- read_
capacity_ intunits - Number of read capacity units for this index.
- write_
capacity_ intunits - Number of write capacity units for this index.
- read
Capacity NumberUnits - Number of read capacity units for this index.
- write
Capacity NumberUnits - Number of write capacity units for this index.
GlobalSecondaryIndexTimeouts, GlobalSecondaryIndexTimeoutsArgs
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- Update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- Update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- update String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- update str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- update String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
GlobalSecondaryIndexWarmThroughput, GlobalSecondaryIndexWarmThroughputArgs
- Read
Units intPer Second - Number of read operations this index can instantaneously support.
- Write
Units intPer Second - Number of write operations this index can instantaneously support.
- Read
Units intPer Second - Number of read operations this index can instantaneously support.
- Write
Units intPer Second - Number of write operations this index can instantaneously support.
- read
Units IntegerPer Second - Number of read operations this index can instantaneously support.
- write
Units IntegerPer Second - Number of write operations this index can instantaneously support.
- read
Units numberPer Second - Number of read operations this index can instantaneously support.
- write
Units numberPer Second - Number of write operations this index can instantaneously support.
- read_
units_ intper_ second - Number of read operations this index can instantaneously support.
- write_
units_ intper_ second - Number of write operations this index can instantaneously support.
- read
Units NumberPer Second - Number of read operations this index can instantaneously support.
- write
Units NumberPer Second - Number of write operations this index can instantaneously support.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.
