AWS Native v0.102.0, Apr 16 24

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.dynamodb.GlobalTable

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

pulumi/pulumi-aws-native

Create GlobalTable Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new GlobalTable(name: string, args: GlobalTableArgs, opts?: CustomResourceOptions);

@overload
def GlobalTable(resource_name: str,
                args: GlobalTableArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def GlobalTable(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                attribute_definitions: Optional[Sequence[GlobalTableAttributeDefinitionArgs]] = None,
                key_schema: Optional[Sequence[GlobalTableKeySchemaArgs]] = None,
                replicas: Optional[Sequence[GlobalTableReplicaSpecificationArgs]] = None,
                billing_mode: Optional[str] = None,
                global_secondary_indexes: Optional[Sequence[GlobalTableGlobalSecondaryIndexArgs]] = None,
                local_secondary_indexes: Optional[Sequence[GlobalTableLocalSecondaryIndexArgs]] = None,
                sse_specification: Optional[GlobalTableSseSpecificationArgs] = None,
                stream_specification: Optional[GlobalTableStreamSpecificationArgs] = None,
                table_name: Optional[str] = None,
                time_to_live_specification: Optional[GlobalTableTimeToLiveSpecificationArgs] = None,
                write_provisioned_throughput_settings: Optional[GlobalTableWriteProvisionedThroughputSettingsArgs] = None)

func NewGlobalTable(ctx *Context, name string, args GlobalTableArgs, opts ...ResourceOption) (*GlobalTable, error)

public GlobalTable(string name, GlobalTableArgs args, CustomResourceOptions? opts = null)

public GlobalTable(String name, GlobalTableArgs args)
public GlobalTable(String name, GlobalTableArgs args, CustomResourceOptions options)

type: aws-native:dynamodb:GlobalTable
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 GlobalTableArgs: 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 GlobalTableArgs: 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 GlobalTableArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GlobalTableArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args GlobalTableArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Example

The following reference example uses placeholder values for all input properties.

Coming soon!

Coming soon!

Coming soon!

Coming soon!

const globalTableResource = new aws_native.dynamodb.GlobalTable("globalTableResource", {
    attributeDefinitions: [{
        attributeName: "string",
        attributeType: "string",
    }],
    keySchema: [{
        attributeName: "string",
        keyType: "string",
    }],
    replicas: [{
        region: "string",
        contributorInsightsSpecification: {
            enabled: false,
        },
        deletionProtectionEnabled: false,
        globalSecondaryIndexes: [{
            indexName: "string",
            contributorInsightsSpecification: {
                enabled: false,
            },
            readProvisionedThroughputSettings: {
                readCapacityAutoScalingSettings: {
                    maxCapacity: 0,
                    minCapacity: 0,
                    targetTrackingScalingPolicyConfiguration: {
                        targetValue: 0,
                        disableScaleIn: false,
                        scaleInCooldown: 0,
                        scaleOutCooldown: 0,
                    },
                    seedCapacity: 0,
                },
                readCapacityUnits: 0,
            },
        }],
        kinesisStreamSpecification: {
            streamArn: "string",
            approximateCreationDateTimePrecision: aws_native.dynamodb.GlobalTableKinesisStreamSpecificationApproximateCreationDateTimePrecision.Microsecond,
        },
        pointInTimeRecoverySpecification: {
            pointInTimeRecoveryEnabled: false,
        },
        readProvisionedThroughputSettings: {
            readCapacityAutoScalingSettings: {
                maxCapacity: 0,
                minCapacity: 0,
                targetTrackingScalingPolicyConfiguration: {
                    targetValue: 0,
                    disableScaleIn: false,
                    scaleInCooldown: 0,
                    scaleOutCooldown: 0,
                },
                seedCapacity: 0,
            },
            readCapacityUnits: 0,
        },
        replicaStreamSpecification: {
            resourcePolicy: {
                policyDocument: "any",
            },
        },
        resourcePolicy: {
            policyDocument: "any",
        },
        sseSpecification: {
            kmsMasterKeyId: "string",
        },
        tableClass: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
    }],
    billingMode: "string",
    globalSecondaryIndexes: [{
        indexName: "string",
        keySchema: [{
            attributeName: "string",
            keyType: "string",
        }],
        projection: {
            nonKeyAttributes: ["string"],
            projectionType: "string",
        },
        writeProvisionedThroughputSettings: {
            writeCapacityAutoScalingSettings: {
                maxCapacity: 0,
                minCapacity: 0,
                targetTrackingScalingPolicyConfiguration: {
                    targetValue: 0,
                    disableScaleIn: false,
                    scaleInCooldown: 0,
                    scaleOutCooldown: 0,
                },
                seedCapacity: 0,
            },
        },
    }],
    localSecondaryIndexes: [{
        indexName: "string",
        keySchema: [{
            attributeName: "string",
            keyType: "string",
        }],
        projection: {
            nonKeyAttributes: ["string"],
            projectionType: "string",
        },
    }],
    sseSpecification: {
        sseEnabled: false,
        sseType: "string",
    },
    streamSpecification: {
        streamViewType: "string",
    },
    tableName: "string",
    timeToLiveSpecification: {
        enabled: false,
        attributeName: "string",
    },
    writeProvisionedThroughputSettings: {
        writeCapacityAutoScalingSettings: {
            maxCapacity: 0,
            minCapacity: 0,
            targetTrackingScalingPolicyConfiguration: {
                targetValue: 0,
                disableScaleIn: false,
                scaleInCooldown: 0,
                scaleOutCooldown: 0,
            },
            seedCapacity: 0,
        },
    },
});

Coming soon!

GlobalTable Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The GlobalTable resource accepts the following input properties:

AttributeDefinitions List<Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableAttributeDefinition>
KeySchema List<Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableKeySchema>
Replicas List<Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableReplicaSpecification>
BillingMode string
GlobalSecondaryIndexes List<Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableGlobalSecondaryIndex>
LocalSecondaryIndexes List<Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableLocalSecondaryIndex>
SseSpecification Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableSseSpecification
StreamSpecification Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableStreamSpecification
TableName string
TimeToLiveSpecification Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableTimeToLiveSpecification
WriteProvisionedThroughputSettings Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableWriteProvisionedThroughputSettings

Outputs

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

Arn string
Id string: The provider-assigned unique ID for this managed resource.
StreamArn string
TableId string

Arn string
Id string: The provider-assigned unique ID for this managed resource.
StreamArn string
TableId string

arn String
id String: The provider-assigned unique ID for this managed resource.
streamArn String
tableId String

arn string
id string: The provider-assigned unique ID for this managed resource.
streamArn string
tableId string

arn str
id str: The provider-assigned unique ID for this managed resource.
stream_arn str
table_id str

arn String
id String: The provider-assigned unique ID for this managed resource.
streamArn String
tableId String

Supporting Types

GlobalTableAttributeDefinition, GlobalTableAttributeDefinitionArgs

AttributeName string
AttributeType string

AttributeName string
AttributeType string

attributeName String
attributeType String

attributeName string
attributeType string

attribute_name str
attribute_type str

attributeName String
attributeType String

GlobalTableCapacityAutoScalingSettings, GlobalTableCapacityAutoScalingSettingsArgs

MaxCapacity int
MinCapacity int
TargetTrackingScalingPolicyConfiguration Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableTargetTrackingScalingPolicyConfiguration
SeedCapacity int

MaxCapacity int
MinCapacity int
TargetTrackingScalingPolicyConfiguration GlobalTableTargetTrackingScalingPolicyConfiguration
SeedCapacity int

maxCapacity Integer
minCapacity Integer
targetTrackingScalingPolicyConfiguration GlobalTableTargetTrackingScalingPolicyConfiguration
seedCapacity Integer

maxCapacity number
minCapacity number
targetTrackingScalingPolicyConfiguration GlobalTableTargetTrackingScalingPolicyConfiguration
seedCapacity number

max_capacity int
min_capacity int
target_tracking_scaling_policy_configuration GlobalTableTargetTrackingScalingPolicyConfiguration
seed_capacity int

maxCapacity Number
minCapacity Number
targetTrackingScalingPolicyConfiguration Property Map
seedCapacity Number

GlobalTableContributorInsightsSpecification, GlobalTableContributorInsightsSpecificationArgs

Enabled bool

Enabled bool

enabled Boolean

enabled boolean

enabled bool

enabled Boolean

GlobalTableGlobalSecondaryIndex, GlobalTableGlobalSecondaryIndexArgs

IndexName string
KeySchema List<Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableKeySchema>
Projection Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableProjection
WriteProvisionedThroughputSettings Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableWriteProvisionedThroughputSettings

IndexName string
KeySchema []GlobalTableKeySchema
Projection GlobalTableProjection
WriteProvisionedThroughputSettings GlobalTableWriteProvisionedThroughputSettings

indexName String
keySchema List<GlobalTableKeySchema>
projection GlobalTableProjection
writeProvisionedThroughputSettings GlobalTableWriteProvisionedThroughputSettings

indexName string
keySchema GlobalTableKeySchema[]
projection GlobalTableProjection
writeProvisionedThroughputSettings GlobalTableWriteProvisionedThroughputSettings

index_name str
key_schema Sequence[GlobalTableKeySchema]
projection GlobalTableProjection
write_provisioned_throughput_settings GlobalTableWriteProvisionedThroughputSettings

indexName String
keySchema List<Property Map>
projection Property Map
writeProvisionedThroughputSettings Property Map

GlobalTableKeySchema, GlobalTableKeySchemaArgs

AttributeName string
KeyType string

AttributeName string
KeyType string

attributeName String
keyType String

attributeName string
keyType string

attribute_name str
key_type str

attributeName String
keyType String

GlobalTableKinesisStreamSpecification, GlobalTableKinesisStreamSpecificationArgs

StreamArn string
ApproximateCreationDateTimePrecision Pulumi.AwsNative.DynamoDb.GlobalTableKinesisStreamSpecificationApproximateCreationDateTimePrecision

StreamArn string
ApproximateCreationDateTimePrecision GlobalTableKinesisStreamSpecificationApproximateCreationDateTimePrecision

streamArn String
approximateCreationDateTimePrecision GlobalTableKinesisStreamSpecificationApproximateCreationDateTimePrecision

streamArn string
approximateCreationDateTimePrecision GlobalTableKinesisStreamSpecificationApproximateCreationDateTimePrecision

stream_arn str
approximate_creation_date_time_precision GlobalTableKinesisStreamSpecificationApproximateCreationDateTimePrecision

streamArn String
approximateCreationDateTimePrecision "MICROSECOND" | "MILLISECOND"

GlobalTableKinesisStreamSpecificationApproximateCreationDateTimePrecision, GlobalTableKinesisStreamSpecificationApproximateCreationDateTimePrecisionArgs

Microsecond: MICROSECOND
Millisecond: MILLISECOND

GlobalTableKinesisStreamSpecificationApproximateCreationDateTimePrecisionMicrosecond: MICROSECOND
GlobalTableKinesisStreamSpecificationApproximateCreationDateTimePrecisionMillisecond: MILLISECOND

Microsecond: MICROSECOND
Millisecond: MILLISECOND