@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
203 lines (202 loc) • 8.41 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* ## 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'
*/
export declare class GlobalSecondaryIndex extends pulumi.CustomResource {
/**
* Get an existing GlobalSecondaryIndex resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GlobalSecondaryIndexState, opts?: pulumi.CustomResourceOptions): GlobalSecondaryIndex;
/**
* Returns true if the given object is an instance of GlobalSecondaryIndex. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is GlobalSecondaryIndex;
/**
* ARN of the GSI.
*/
readonly arn: pulumi.Output<string>;
/**
* Name of the index.
*/
readonly indexName: pulumi.Output<string>;
/**
* Set of nested attribute definitions.
* At least 1 element defining a `HASH` is required.
* All elements with the `keyType` of `HASH` must precede elements with `keyType` of `RANGE`.
* Changing any values in `keySchema` will re-create the resource.
* See `keySchema` below.
*/
readonly keySchemas: pulumi.Output<outputs.dynamodb.GlobalSecondaryIndexKeySchema[] | undefined>;
/**
* Sets the maximum number of read and write units for the index.
* See `onDemandThroughput` below.
* Only valid if the table's `billingMode` is `PAY_PER_REQUEST`.
*/
readonly onDemandThroughput: pulumi.Output<outputs.dynamodb.GlobalSecondaryIndexOnDemandThroughput | undefined>;
/**
* Describes which attributes from the table are represented in the index.
* See `projection` below.
*/
readonly projection: pulumi.Output<outputs.dynamodb.GlobalSecondaryIndexProjection | undefined>;
/**
* Provisioned throughput for the index.
* See `provisionedThroughput` below.
* Required if the table's `billingMode` is `PROVISIONED`.
*/
readonly provisionedThroughput: pulumi.Output<outputs.dynamodb.GlobalSecondaryIndexProvisionedThroughput | undefined>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* Name of the table this index belongs to.
*
* The following arguments are optional:
*/
readonly tableName: pulumi.Output<string>;
readonly timeouts: pulumi.Output<outputs.dynamodb.GlobalSecondaryIndexTimeouts | undefined>;
/**
* Sets the number of warm read and write units for this index.
* See `warmThroughput` below.
*/
readonly warmThroughput: pulumi.Output<outputs.dynamodb.GlobalSecondaryIndexWarmThroughput>;
/**
* Create a GlobalSecondaryIndex resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: GlobalSecondaryIndexArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering GlobalSecondaryIndex resources.
*/
export interface GlobalSecondaryIndexState {
/**
* ARN of the GSI.
*/
arn?: pulumi.Input<string>;
/**
* Name of the index.
*/
indexName?: pulumi.Input<string>;
/**
* Set of nested attribute definitions.
* At least 1 element defining a `HASH` is required.
* All elements with the `keyType` of `HASH` must precede elements with `keyType` of `RANGE`.
* Changing any values in `keySchema` will re-create the resource.
* See `keySchema` below.
*/
keySchemas?: pulumi.Input<pulumi.Input<inputs.dynamodb.GlobalSecondaryIndexKeySchema>[]>;
/**
* Sets the maximum number of read and write units for the index.
* See `onDemandThroughput` below.
* Only valid if the table's `billingMode` is `PAY_PER_REQUEST`.
*/
onDemandThroughput?: pulumi.Input<inputs.dynamodb.GlobalSecondaryIndexOnDemandThroughput>;
/**
* Describes which attributes from the table are represented in the index.
* See `projection` below.
*/
projection?: pulumi.Input<inputs.dynamodb.GlobalSecondaryIndexProjection>;
/**
* Provisioned throughput for the index.
* See `provisionedThroughput` below.
* Required if the table's `billingMode` is `PROVISIONED`.
*/
provisionedThroughput?: pulumi.Input<inputs.dynamodb.GlobalSecondaryIndexProvisionedThroughput>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Name of the table this index belongs to.
*
* The following arguments are optional:
*/
tableName?: pulumi.Input<string>;
timeouts?: pulumi.Input<inputs.dynamodb.GlobalSecondaryIndexTimeouts>;
/**
* Sets the number of warm read and write units for this index.
* See `warmThroughput` below.
*/
warmThroughput?: pulumi.Input<inputs.dynamodb.GlobalSecondaryIndexWarmThroughput>;
}
/**
* The set of arguments for constructing a GlobalSecondaryIndex resource.
*/
export interface GlobalSecondaryIndexArgs {
/**
* Name of the index.
*/
indexName: pulumi.Input<string>;
/**
* Set of nested attribute definitions.
* At least 1 element defining a `HASH` is required.
* All elements with the `keyType` of `HASH` must precede elements with `keyType` of `RANGE`.
* Changing any values in `keySchema` will re-create the resource.
* See `keySchema` below.
*/
keySchemas?: pulumi.Input<pulumi.Input<inputs.dynamodb.GlobalSecondaryIndexKeySchema>[]>;
/**
* Sets the maximum number of read and write units for the index.
* See `onDemandThroughput` below.
* Only valid if the table's `billingMode` is `PAY_PER_REQUEST`.
*/
onDemandThroughput?: pulumi.Input<inputs.dynamodb.GlobalSecondaryIndexOnDemandThroughput>;
/**
* Describes which attributes from the table are represented in the index.
* See `projection` below.
*/
projection?: pulumi.Input<inputs.dynamodb.GlobalSecondaryIndexProjection>;
/**
* Provisioned throughput for the index.
* See `provisionedThroughput` below.
* Required if the table's `billingMode` is `PROVISIONED`.
*/
provisionedThroughput?: pulumi.Input<inputs.dynamodb.GlobalSecondaryIndexProvisionedThroughput>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Name of the table this index belongs to.
*
* The following arguments are optional:
*/
tableName: pulumi.Input<string>;
timeouts?: pulumi.Input<inputs.dynamodb.GlobalSecondaryIndexTimeouts>;
/**
* Sets the number of warm read and write units for this index.
* See `warmThroughput` below.
*/
warmThroughput?: pulumi.Input<inputs.dynamodb.GlobalSecondaryIndexWarmThroughput>;
}