1. Packages
  2. AWS
  3. API Docs
  4. dynamodb
  5. GlobalSecondaryIndex
AWS v7.16.0 published on Friday, Jan 9, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.dynamodb.GlobalSecondaryIndex

aws logo
AWS v7.16.0 published on Friday, Jan 9, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Import

    Identity Schema

    Required

    • index_name (String) Name of the index.

    • table_name (String) Name of the table this index belongs to.

    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_global_secondary_index.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:

    IndexName string
    Name of the index.
    TableName string

    Name of the table this index belongs to.

    The following arguments are optional:

    KeySchemas List<GlobalSecondaryIndexKeySchema>
    Set of nested attribute definitions. At least 1 element defining a HASH is required. All elements with the key_type of HASH must precede elements with key_type of RANGE. Changing any values in key_schema will re-create the resource. See key_schema below.
    OnDemandThroughput GlobalSecondaryIndexOnDemandThroughput
    Sets the maximum number of read and write units for the index. See on_demand_throughput below. Only valid if the table's billing_mode is PAY_PER_REQUEST.
    Projection GlobalSecondaryIndexProjection
    Describes which attributes from the table are represented in the index. See projection below.
    ProvisionedThroughput GlobalSecondaryIndexProvisionedThroughput
    Provisioned throughput for the index. See provisioned_throughput below. Required if the table's billing_mode is PROVISIONED.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Timeouts GlobalSecondaryIndexTimeouts
    WarmThroughput GlobalSecondaryIndexWarmThroughput
    Sets the number of warm read and write units for this index. See warm_throughput below.
    IndexName string
    Name of the index.
    TableName string

    Name of the table this index belongs to.

    The following arguments are optional:

    KeySchemas []GlobalSecondaryIndexKeySchemaArgs
    Set of nested attribute definitions. At least 1 element defining a HASH is required. All elements with the key_type of HASH must precede elements with key_type of RANGE. Changing any values in key_schema will re-create the resource. See key_schema below.
    OnDemandThroughput GlobalSecondaryIndexOnDemandThroughputArgs
    Sets the maximum number of read and write units for the index. See on_demand_throughput below. Only valid if the table's billing_mode is PAY_PER_REQUEST.
    Projection GlobalSecondaryIndexProjectionArgs
    Describes which attributes from the table are represented in the index. See projection below.
    ProvisionedThroughput GlobalSecondaryIndexProvisionedThroughputArgs
    Provisioned throughput for the index. See provisioned_throughput below. Required if the table's billing_mode is PROVISIONED.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Timeouts GlobalSecondaryIndexTimeoutsArgs
    WarmThroughput GlobalSecondaryIndexWarmThroughputArgs
    Sets the number of warm read and write units for this index. See warm_throughput below.
    indexName String
    Name of the index.
    tableName String

    Name of the table this index belongs to.

    The following arguments are optional:

    keySchemas List<GlobalSecondaryIndexKeySchema>
    Set of nested attribute definitions. At least 1 element defining a HASH is required. All elements with the key_type of HASH must precede elements with key_type of RANGE. Changing any values in key_schema will re-create the resource. See key_schema below.
    onDemandThroughput GlobalSecondaryIndexOnDemandThroughput
    Sets the maximum number of read and write units for the index. See on_demand_throughput below. Only valid if the table's billing_mode is PAY_PER_REQUEST.
    projection GlobalSecondaryIndexProjection
    Describes which attributes from the table are represented in the index. See projection below.
    provisionedThroughput GlobalSecondaryIndexProvisionedThroughput
    Provisioned throughput for the index. See provisioned_throughput below. Required if the table's billing_mode is PROVISIONED.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    timeouts GlobalSecondaryIndexTimeouts
    warmThroughput GlobalSecondaryIndexWarmThroughput
    Sets the number of warm read and write units for this index. See warm_throughput below.
    indexName string
    Name of the index.
    tableName string

    Name of the table this index belongs to.

    The following arguments are optional:

    keySchemas GlobalSecondaryIndexKeySchema[]
    Set of nested attribute definitions. At least 1 element defining a HASH is required. All elements with the key_type of HASH must precede elements with key_type of RANGE. Changing any values in key_schema will re-create the resource. See key_schema below.
    onDemandThroughput GlobalSecondaryIndexOnDemandThroughput
    Sets the maximum number of read and write units for the index. See on_demand_throughput below. Only valid if the table's billing_mode is PAY_PER_REQUEST.
    projection GlobalSecondaryIndexProjection
    Describes which attributes from the table are represented in the index. See projection below.
    provisionedThroughput GlobalSecondaryIndexProvisionedThroughput
    Provisioned throughput for the index. See provisioned_throughput below. Required if the table's billing_mode is PROVISIONED.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    timeouts GlobalSecondaryIndexTimeouts
    warmThroughput GlobalSecondaryIndexWarmThroughput
    Sets the number of warm read and write units for this index. See warm_throughput below.
    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[GlobalSecondaryIndexKeySchemaArgs]
    Set of nested attribute definitions. At least 1 element defining a HASH is required. All elements with the key_type of HASH must precede elements with key_type of RANGE. Changing any values in key_schema will re-create the resource. See key_schema below.
    on_demand_throughput GlobalSecondaryIndexOnDemandThroughputArgs
    Sets the maximum number of read and write units for the index. See on_demand_throughput below. Only valid if the table's billing_mode is PAY_PER_REQUEST.
    projection GlobalSecondaryIndexProjectionArgs
    Describes which attributes from the table are represented in the index. See projection below.
    provisioned_throughput GlobalSecondaryIndexProvisionedThroughputArgs
    Provisioned throughput for the index. See provisioned_throughput below. Required if the table's billing_mode is PROVISIONED.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    timeouts GlobalSecondaryIndexTimeoutsArgs
    warm_throughput GlobalSecondaryIndexWarmThroughputArgs
    Sets the number of warm read and write units for this index. See warm_throughput below.
    indexName String
    Name of the index.
    tableName String

    Name of the table this index belongs to.

    The following arguments are optional:

    keySchemas List<Property Map>
    Set of nested attribute definitions. At least 1 element defining a HASH is required. All elements with the key_type of HASH must precede elements with key_type of RANGE. Changing any values in key_schema will re-create the resource. See key_schema below.
    onDemandThroughput Property Map
    Sets the maximum number of read and write units for the index. See on_demand_throughput below. Only valid if the table's billing_mode is PAY_PER_REQUEST.
    projection Property Map
    Describes which attributes from the table are represented in the index. See projection below.
    provisionedThroughput Property Map
    Provisioned throughput for the index. See provisioned_throughput below. Required if the table's billing_mode is PROVISIONED.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    timeouts Property Map
    warmThroughput Property Map
    Sets the number of warm read and write units for this index. See warm_throughput below.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GlobalSecondaryIndex resource produces the following output properties:

    Arn string
    ARN of the GSI.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    ARN of the GSI.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    ARN of the GSI.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    ARN of the GSI.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    ARN of the GSI.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    ARN of the GSI.
    id String
    The provider-assigned unique ID for this managed resource.

    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) -> GlobalSecondaryIndex
    func 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.
    The following state arguments are supported:
    Arn string
    ARN of the GSI.
    IndexName string
    Name of the index.
    KeySchemas List<GlobalSecondaryIndexKeySchema>
    Set of nested attribute definitions. At least 1 element defining a HASH is required. All elements with the key_type of HASH must precede elements with key_type of RANGE. Changing any values in key_schema will re-create the resource. See key_schema below.
    OnDemandThroughput GlobalSecondaryIndexOnDemandThroughput
    Sets the maximum number of read and write units for the index. See on_demand_throughput below. Only valid if the table's billing_mode is PAY_PER_REQUEST.
    Projection GlobalSecondaryIndexProjection
    Describes which attributes from the table are represented in the index. See projection below.
    ProvisionedThroughput GlobalSecondaryIndexProvisionedThroughput
    Provisioned throughput for the index. See provisioned_throughput below. Required if the table's billing_mode is PROVISIONED.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    TableName string

    Name of the table this index belongs to.

    The following arguments are optional:

    Timeouts GlobalSecondaryIndexTimeouts
    WarmThroughput GlobalSecondaryIndexWarmThroughput
    Sets the number of warm read and write units for this index. See warm_throughput below.
    Arn string
    ARN of the GSI.
    IndexName string
    Name of the index.
    KeySchemas []GlobalSecondaryIndexKeySchemaArgs
    Set of nested attribute definitions. At least 1 element defining a HASH is required. All elements with the key_type of HASH must precede elements with key_type of RANGE. Changing any values in key_schema will re-create the resource. See key_schema below.
    OnDemandThroughput GlobalSecondaryIndexOnDemandThroughputArgs
    Sets the maximum number of read and write units for the index. See on_demand_throughput below. Only valid if the table's billing_mode is PAY_PER_REQUEST.
    Projection GlobalSecondaryIndexProjectionArgs
    Describes which attributes from the table are represented in the index. See projection below.
    ProvisionedThroughput GlobalSecondaryIndexProvisionedThroughputArgs
    Provisioned throughput for the index. See provisioned_throughput below. Required if the table's billing_mode is PROVISIONED.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    TableName string

    Name of the table this index belongs to.

    The following arguments are optional:

    Timeouts GlobalSecondaryIndexTimeoutsArgs
    WarmThroughput GlobalSecondaryIndexWarmThroughputArgs
    Sets the number of warm read and write units for this index. See warm_throughput below.
    arn String
    ARN of the GSI.
    indexName String
    Name of the index.
    keySchemas List<GlobalSecondaryIndexKeySchema>
    Set of nested attribute definitions. At least 1 element defining a HASH is required. All elements with the key_type of HASH must precede elements with key_type of RANGE. Changing any values in key_schema will re-create the resource. See key_schema below.
    onDemandThroughput GlobalSecondaryIndexOnDemandThroughput
    Sets the maximum number of read and write units for the index. See on_demand_throughput below. Only valid if the table's billing_mode is PAY_PER_REQUEST.
    projection GlobalSecondaryIndexProjection
    Describes which attributes from the table are represented in the index. See projection below.
    provisionedThroughput GlobalSecondaryIndexProvisionedThroughput
    Provisioned throughput for the index. See provisioned_throughput below. Required if the table's billing_mode is PROVISIONED.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tableName String

    Name of the table this index belongs to.

    The following arguments are optional:

    timeouts GlobalSecondaryIndexTimeouts
    warmThroughput GlobalSecondaryIndexWarmThroughput
    Sets the number of warm read and write units for this index. See warm_throughput below.
    arn string
    ARN of the GSI.
    indexName string
    Name of the index.
    keySchemas GlobalSecondaryIndexKeySchema[]
    Set of nested attribute definitions. At least 1 element defining a HASH is required. All elements with the key_type of HASH must precede elements with key_type of RANGE. Changing any values in key_schema will re-create the resource. See key_schema below.
    onDemandThroughput GlobalSecondaryIndexOnDemandThroughput
    Sets the maximum number of read and write units for the index. See on_demand_throughput below. Only valid if the table's billing_mode is PAY_PER_REQUEST.
    projection GlobalSecondaryIndexProjection
    Describes which attributes from the table are represented in the index. See projection below.
    provisionedThroughput GlobalSecondaryIndexProvisionedThroughput
    Provisioned throughput for the index. See provisioned_throughput below. Required if the table's billing_mode is PROVISIONED.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tableName string

    Name of the table this index belongs to.

    The following arguments are optional:

    timeouts GlobalSecondaryIndexTimeouts
    warmThroughput GlobalSecondaryIndexWarmThroughput
    Sets the number of warm read and write units for this index. See warm_throughput below.
    arn str
    ARN of the GSI.
    index_name str
    Name of the index.
    key_schemas Sequence[GlobalSecondaryIndexKeySchemaArgs]
    Set of nested attribute definitions. At least 1 element defining a HASH is required. All elements with the key_type of HASH must precede elements with key_type of RANGE. Changing any values in key_schema will re-create the resource. See key_schema below.
    on_demand_throughput GlobalSecondaryIndexOnDemandThroughputArgs
    Sets the maximum number of read and write units for the index. See on_demand_throughput below. Only valid if the table's billing_mode is PAY_PER_REQUEST.
    projection GlobalSecondaryIndexProjectionArgs
    Describes which attributes from the table are represented in the index. See projection below.
    provisioned_throughput GlobalSecondaryIndexProvisionedThroughputArgs
    Provisioned throughput for the index. See provisioned_throughput below. Required if the table's billing_mode is PROVISIONED.
    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 GlobalSecondaryIndexTimeoutsArgs
    warm_throughput GlobalSecondaryIndexWarmThroughputArgs
    Sets the number of warm read and write units for this index. See warm_throughput below.
    arn String
    ARN of the GSI.
    indexName String
    Name of the index.
    keySchemas List<Property Map>
    Set of nested attribute definitions. At least 1 element defining a HASH is required. All elements with the key_type of HASH must precede elements with key_type of RANGE. Changing any values in key_schema will re-create the resource. See key_schema below.
    onDemandThroughput Property Map
    Sets the maximum number of read and write units for the index. See on_demand_throughput below. Only valid if the table's billing_mode is PAY_PER_REQUEST.
    projection Property Map
    Describes which attributes from the table are represented in the index. See projection below.
    provisionedThroughput Property Map
    Provisioned throughput for the index. See provisioned_throughput below. Required if the table's billing_mode is PROVISIONED.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tableName String

    Name of the table this index belongs to.

    The following arguments are optional:

    timeouts Property Map
    warmThroughput Property Map
    Sets the number of warm read and write units for this index. See warm_throughput below.

    Supporting Types

    GlobalSecondaryIndexKeySchema, GlobalSecondaryIndexKeySchemaArgs

    AttributeName string
    Name of the attribute.
    AttributeType string
    Type of the attribute in the index. Valid values are S (string), N (number), or B (binary).
    KeyType string
    Key type. Valid values are HASH or RANGE.
    AttributeName string
    Name of the attribute.
    AttributeType string
    Type of the attribute in the index. Valid values are S (string), N (number), or B (binary).
    KeyType string
    Key type. Valid values are HASH or RANGE.
    attributeName String
    Name of the attribute.
    attributeType String
    Type of the attribute in the index. Valid values are S (string), N (number), or B (binary).
    keyType String
    Key type. Valid values are HASH or RANGE.
    attributeName string
    Name of the attribute.
    attributeType string
    Type of the attribute in the index. Valid values are S (string), N (number), or B (binary).
    keyType string
    Key type. Valid values are HASH or RANGE.
    attribute_name str
    Name of the attribute.
    attribute_type str
    Type of the attribute in the index. Valid values are S (string), N (number), or B (binary).
    key_type str
    Key type. Valid values are HASH or RANGE.
    attributeName String
    Name of the attribute.
    attributeType String
    Type of the attribute in the index. Valid values are S (string), N (number), or B (binary).
    keyType String
    Key type. Valid values are HASH or RANGE.

    GlobalSecondaryIndexOnDemandThroughput, GlobalSecondaryIndexOnDemandThroughputArgs

    MaxReadRequestUnits int
    Maximum number of read request units for this index.
    MaxWriteRequestUnits int
    Maximum number of write request units for this index.
    MaxReadRequestUnits int
    Maximum number of read request units for this index.
    MaxWriteRequestUnits int
    Maximum number of write request units for this index.
    maxReadRequestUnits Integer
    Maximum number of read request units for this index.
    maxWriteRequestUnits Integer
    Maximum number of write request units for this index.
    maxReadRequestUnits number
    Maximum number of read request units for this index.
    maxWriteRequestUnits number
    Maximum number of write request units for this index.
    max_read_request_units int
    Maximum number of read request units for this index.
    max_write_request_units int
    Maximum number of write request units for this index.
    maxReadRequestUnits Number
    Maximum number of read request units for this index.
    maxWriteRequestUnits Number
    Maximum number of write request units for this index.

    GlobalSecondaryIndexProjection, GlobalSecondaryIndexProjectionArgs

    ProjectionType string
    The set of attributes represented in the index. One of ALL, INCLUDE, or KEYS_ONLY.
    NonKeyAttributes List<string>
    Specifies which additional attributes to include in the index. Only valid when projection_type is INCLUDE.`
    ProjectionType string
    The set of attributes represented in the index. One of ALL, INCLUDE, or KEYS_ONLY.
    NonKeyAttributes []string
    Specifies which additional attributes to include in the index. Only valid when projection_type is INCLUDE.`
    projectionType String
    The set of attributes represented in the index. One of ALL, INCLUDE, or KEYS_ONLY.
    nonKeyAttributes List<String>
    Specifies which additional attributes to include in the index. Only valid when projection_type is INCLUDE.`
    projectionType string
    The set of attributes represented in the index. One of ALL, INCLUDE, or KEYS_ONLY.
    nonKeyAttributes string[]
    Specifies which additional attributes to include in the index. Only valid when projection_type is INCLUDE.`
    projection_type str
    The set of attributes represented in the index. One of ALL, INCLUDE, or KEYS_ONLY.
    non_key_attributes Sequence[str]
    Specifies which additional attributes to include in the index. Only valid when projection_type is INCLUDE.`
    projectionType String
    The set of attributes represented in the index. One of ALL, INCLUDE, or KEYS_ONLY.
    nonKeyAttributes List<String>
    Specifies which additional attributes to include in the index. Only valid when projection_type is INCLUDE.`

    GlobalSecondaryIndexProvisionedThroughput, GlobalSecondaryIndexProvisionedThroughputArgs

    ReadCapacityUnits int
    Number of read capacity units for this index.
    WriteCapacityUnits int
    Number of write capacity units for this index.
    ReadCapacityUnits int
    Number of read capacity units for this index.
    WriteCapacityUnits int
    Number of write capacity units for this index.
    readCapacityUnits Integer
    Number of read capacity units for this index.
    writeCapacityUnits Integer
    Number of write capacity units for this index.
    readCapacityUnits number
    Number of read capacity units for this index.
    writeCapacityUnits number
    Number of write capacity units for this index.
    read_capacity_units int
    Number of read capacity units for this index.
    write_capacity_units int
    Number of write capacity units for this index.
    readCapacityUnits Number
    Number of read capacity units for this index.
    writeCapacityUnits Number
    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

    ReadUnitsPerSecond int
    Number of read operations this index can instantaneously support.
    WriteUnitsPerSecond int
    Number of write operations this index can instantaneously support.
    ReadUnitsPerSecond int
    Number of read operations this index can instantaneously support.
    WriteUnitsPerSecond int
    Number of write operations this index can instantaneously support.
    readUnitsPerSecond Integer
    Number of read operations this index can instantaneously support.
    writeUnitsPerSecond Integer
    Number of write operations this index can instantaneously support.
    readUnitsPerSecond number
    Number of read operations this index can instantaneously support.
    writeUnitsPerSecond number
    Number of write operations this index can instantaneously support.
    read_units_per_second int
    Number of read operations this index can instantaneously support.
    write_units_per_second int
    Number of write operations this index can instantaneously support.
    readUnitsPerSecond Number
    Number of read operations this index can instantaneously support.
    writeUnitsPerSecond Number
    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 aws Terraform Provider.
    aws logo
    AWS v7.16.0 published on Friday, Jan 9, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws
      Meet Neo: Your AI Platform Teammate