AWS Native v0.54.0, Mar 21 23

aws-native.dynamodb.getGlobalTable

Version: None. Resource Type definition for AWS::DynamoDB::GlobalTable

Using getGlobalTable

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGlobalTable(args: GetGlobalTableArgs, opts?: InvokeOptions): Promise<GetGlobalTableResult>
function getGlobalTableOutput(args: GetGlobalTableOutputArgs, opts?: InvokeOptions): Output<GetGlobalTableResult>

def get_global_table(table_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetGlobalTableResult
def get_global_table_output(table_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetGlobalTableResult]

func LookupGlobalTable(ctx *Context, args *LookupGlobalTableArgs, opts ...InvokeOption) (*LookupGlobalTableResult, error)
func LookupGlobalTableOutput(ctx *Context, args *LookupGlobalTableOutputArgs, opts ...InvokeOption) LookupGlobalTableResultOutput

> Note: This function is named LookupGlobalTable in the Go SDK.

public static class GetGlobalTable 
{
    public static Task<GetGlobalTableResult> InvokeAsync(GetGlobalTableArgs args, InvokeOptions? opts = null)
    public static Output<GetGlobalTableResult> Invoke(GetGlobalTableInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGlobalTableResult> getGlobalTable(GetGlobalTableArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:dynamodb:getGlobalTable
  arguments:
    # arguments dictionary

The following arguments are supported:

TableName string

TableName string

tableName String

tableName string

table_name str

tableName String

getGlobalTable Result

The following output properties are available:

Arn string
AttributeDefinitions List<Pulumi.AwsNative.DynamoDB.Outputs.GlobalTableAttributeDefinition>
BillingMode string
GlobalSecondaryIndexes List<Pulumi.AwsNative.DynamoDB.Outputs.GlobalTableGlobalSecondaryIndex>
Replicas List<Pulumi.AwsNative.DynamoDB.Outputs.GlobalTableReplicaSpecification>
SSESpecification Pulumi.AwsNative.DynamoDB.Outputs.GlobalTableSSESpecification
StreamArn string
StreamSpecification Pulumi.AwsNative.DynamoDB.Outputs.GlobalTableStreamSpecification
TableId string
TimeToLiveSpecification Pulumi.AwsNative.DynamoDB.Outputs.GlobalTableTimeToLiveSpecification
WriteProvisionedThroughputSettings Pulumi.AwsNative.DynamoDB.Outputs.GlobalTableWriteProvisionedThroughputSettings

Arn string
AttributeDefinitions []GlobalTableAttributeDefinition
BillingMode string
GlobalSecondaryIndexes []GlobalTableGlobalSecondaryIndex
Replicas []GlobalTableReplicaSpecification
SSESpecification GlobalTableSSESpecification
StreamArn string
StreamSpecification GlobalTableStreamSpecification
TableId string
TimeToLiveSpecification GlobalTableTimeToLiveSpecification
WriteProvisionedThroughputSettings GlobalTableWriteProvisionedThroughputSettings

arn String
attributeDefinitions List<GlobalTableAttributeDefinition>
billingMode String
globalSecondaryIndexes List<GlobalTableGlobalSecondaryIndex>
replicas List<GlobalTableReplicaSpecification>
sSESpecification GlobalTableSSESpecification
streamArn String
streamSpecification GlobalTableStreamSpecification
tableId String
timeToLiveSpecification GlobalTableTimeToLiveSpecification
writeProvisionedThroughputSettings GlobalTableWriteProvisionedThroughputSettings

arn string
attributeDefinitions GlobalTableAttributeDefinition[]
billingMode string
globalSecondaryIndexes GlobalTableGlobalSecondaryIndex[]
replicas GlobalTableReplicaSpecification[]
sSESpecification GlobalTableSSESpecification
streamArn string
streamSpecification GlobalTableStreamSpecification
tableId string
timeToLiveSpecification GlobalTableTimeToLiveSpecification
writeProvisionedThroughputSettings GlobalTableWriteProvisionedThroughputSettings

arn str
attribute_definitions Sequence[GlobalTableAttributeDefinition]
billing_mode str
global_secondary_indexes Sequence[GlobalTableGlobalSecondaryIndex]
replicas Sequence[GlobalTableReplicaSpecification]
s_se_specification GlobalTableSSESpecification
stream_arn str
stream_specification GlobalTableStreamSpecification
table_id str
time_to_live_specification GlobalTableTimeToLiveSpecification
write_provisioned_throughput_settings GlobalTableWriteProvisionedThroughputSettings

arn String
attributeDefinitions List<Property Map>
billingMode String
globalSecondaryIndexes List<Property Map>
replicas List<Property Map>
sSESpecification Property Map
streamArn String
streamSpecification Property Map
tableId String
timeToLiveSpecification Property Map
writeProvisionedThroughputSettings Property Map

Supporting Types

enabled Boolean

enabled boolean

enabled bool

enabled Boolean

GlobalTableGlobalSecondaryIndex

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

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

StreamArn string

StreamArn string

streamArn String

streamArn string

stream_arn str

streamArn String

GlobalTablePointInTimeRecoverySpecification

PointInTimeRecoveryEnabled bool

PointInTimeRecoveryEnabled bool

pointInTimeRecoveryEnabled Boolean

pointInTimeRecoveryEnabled boolean

point_in_time_recovery_enabled bool

pointInTimeRecoveryEnabled Boolean

GlobalTableProjection

NonKeyAttributes List<string>
ProjectionType string

NonKeyAttributes []string
ProjectionType string

nonKeyAttributes List<String>
projectionType String

nonKeyAttributes string[]
projectionType string

non_key_attributes Sequence[str]
projection_type str

nonKeyAttributes List<String>
projectionType String

GlobalTableReadProvisionedThroughputSettings

ReadCapacityAutoScalingSettings Pulumi.AwsNative.DynamoDB.Inputs.GlobalTableCapacityAutoScalingSettings
ReadCapacityUnits int

ReadCapacityAutoScalingSettings GlobalTableCapacityAutoScalingSettings
ReadCapacityUnits int

readCapacityAutoScalingSettings GlobalTableCapacityAutoScalingSettings
readCapacityUnits Integer

readCapacityAutoScalingSettings GlobalTableCapacityAutoScalingSettings
readCapacityUnits number

read_capacity_auto_scaling_settings GlobalTableCapacityAutoScalingSettings
read_capacity_units int

readCapacityAutoScalingSettings Property Map
readCapacityUnits Number

GlobalTableReplicaGlobalSecondaryIndexSpecification

IndexName string
ContributorInsightsSpecification Pulumi.AwsNative.DynamoDB.Inputs.GlobalTableContributorInsightsSpecification
ReadProvisionedThroughputSettings Pulumi.AwsNative.DynamoDB.Inputs.GlobalTableReadProvisionedThroughputSettings

IndexName string
ContributorInsightsSpecification GlobalTableContributorInsightsSpecification
ReadProvisionedThroughputSettings GlobalTableReadProvisionedThroughputSettings

indexName String
contributorInsightsSpecification GlobalTableContributorInsightsSpecification
readProvisionedThroughputSettings GlobalTableReadProvisionedThroughputSettings

indexName string
contributorInsightsSpecification GlobalTableContributorInsightsSpecification
readProvisionedThroughputSettings GlobalTableReadProvisionedThroughputSettings

index_name str
contributor_insights_specification GlobalTableContributorInsightsSpecification
read_provisioned_throughput_settings GlobalTableReadProvisionedThroughputSettings

indexName String
contributorInsightsSpecification Property Map
readProvisionedThroughputSettings Property Map

GlobalTableReplicaSSESpecification

KMSMasterKeyId string

KMSMasterKeyId string

kMSMasterKeyId String

kMSMasterKeyId string

k_ms_master_key_id str

kMSMasterKeyId String

GlobalTableReplicaSpecification

Region string
ContributorInsightsSpecification Pulumi.AwsNative.DynamoDB.Inputs.GlobalTableContributorInsightsSpecification
DeletionProtectionEnabled bool
GlobalSecondaryIndexes List<Pulumi.AwsNative.DynamoDB.Inputs.GlobalTableReplicaGlobalSecondaryIndexSpecification>
KinesisStreamSpecification Pulumi.AwsNative.DynamoDB.Inputs.GlobalTableKinesisStreamSpecification
PointInTimeRecoverySpecification Pulumi.AwsNative.DynamoDB.Inputs.GlobalTablePointInTimeRecoverySpecification
ReadProvisionedThroughputSettings Pulumi.AwsNative.DynamoDB.Inputs.GlobalTableReadProvisionedThroughputSettings
SSESpecification Pulumi.AwsNative.DynamoDB.Inputs.GlobalTableReplicaSSESpecification
TableClass string
Tags List<Pulumi.AwsNative.DynamoDB.Inputs.GlobalTableTag>

Region string
ContributorInsightsSpecification GlobalTableContributorInsightsSpecification
DeletionProtectionEnabled bool
GlobalSecondaryIndexes []GlobalTableReplicaGlobalSecondaryIndexSpecification
KinesisStreamSpecification GlobalTableKinesisStreamSpecification
PointInTimeRecoverySpecification GlobalTablePointInTimeRecoverySpecification
ReadProvisionedThroughputSettings GlobalTableReadProvisionedThroughputSettings
SSESpecification GlobalTableReplicaSSESpecification
TableClass string
Tags []GlobalTableTag

region String
contributorInsightsSpecification GlobalTableContributorInsightsSpecification
deletionProtectionEnabled Boolean
globalSecondaryIndexes List<GlobalTableReplicaGlobalSecondaryIndexSpecification>
kinesisStreamSpecification GlobalTableKinesisStreamSpecification
pointInTimeRecoverySpecification GlobalTablePointInTimeRecoverySpecification
readProvisionedThroughputSettings GlobalTableReadProvisionedThroughputSettings
sSESpecification GlobalTableReplicaSSESpecification
tableClass String
tags List<GlobalTableTag>

region string
contributorInsightsSpecification GlobalTableContributorInsightsSpecification
deletionProtectionEnabled boolean
globalSecondaryIndexes GlobalTableReplicaGlobalSecondaryIndexSpecification[]
kinesisStreamSpecification GlobalTableKinesisStreamSpecification
pointInTimeRecoverySpecification GlobalTablePointInTimeRecoverySpecification
readProvisionedThroughputSettings GlobalTableReadProvisionedThroughputSettings
sSESpecification GlobalTableReplicaSSESpecification
tableClass string
tags GlobalTableTag[]

region str
contributor_insights_specification GlobalTableContributorInsightsSpecification
deletion_protection_enabled bool
global_secondary_indexes Sequence[GlobalTableReplicaGlobalSecondaryIndexSpecification]
kinesis_stream_specification GlobalTableKinesisStreamSpecification
point_in_time_recovery_specification GlobalTablePointInTimeRecoverySpecification
read_provisioned_throughput_settings GlobalTableReadProvisionedThroughputSettings
s_se_specification GlobalTableReplicaSSESpecification
table_class str
tags Sequence[GlobalTableTag]

region String
contributorInsightsSpecification Property Map
deletionProtectionEnabled Boolean
globalSecondaryIndexes List<Property Map>
kinesisStreamSpecification Property Map
pointInTimeRecoverySpecification Property Map
readProvisionedThroughputSettings Property Map
sSESpecification Property Map
tableClass String
tags List<Property Map>

GlobalTableSSESpecification

SSEEnabled bool
SSEType string

SSEEnabled bool
SSEType string

sSEEnabled Boolean
sSEType String

sSEEnabled boolean
sSEType string

s_se_enabled bool
s_se_type str

sSEEnabled Boolean
sSEType String

GlobalTableStreamSpecification

StreamViewType string

StreamViewType string

streamViewType String

streamViewType string

stream_view_type str

streamViewType String

GlobalTableTag

Key string
Value string

Key string
Value string

key String
value String

key string
value string

key str
value str

key String
value String

GlobalTableTargetTrackingScalingPolicyConfiguration

TargetValue double
DisableScaleIn bool
ScaleInCooldown int
ScaleOutCooldown int

TargetValue float64
DisableScaleIn bool
ScaleInCooldown int
ScaleOutCooldown int

targetValue Double
disableScaleIn Boolean
scaleInCooldown Integer
scaleOutCooldown Integer

targetValue number
disableScaleIn boolean
scaleInCooldown number
scaleOutCooldown number

target_value float
disable_scale_in bool
scale_in_cooldown int
scale_out_cooldown int

targetValue Number
disableScaleIn Boolean
scaleInCooldown Number
scaleOutCooldown Number

GlobalTableTimeToLiveSpecification

Enabled bool
AttributeName string

Enabled bool
AttributeName string

enabled Boolean
attributeName String

enabled boolean
attributeName string

enabled bool
attribute_name str

enabled Boolean
attributeName String

GlobalTableWriteProvisionedThroughputSettings

WriteCapacityAutoScalingSettings Pulumi.AwsNative.DynamoDB.Inputs.GlobalTableCapacityAutoScalingSettings

WriteCapacityAutoScalingSettings GlobalTableCapacityAutoScalingSettings

writeCapacityAutoScalingSettings GlobalTableCapacityAutoScalingSettings

writeCapacityAutoScalingSettings GlobalTableCapacityAutoScalingSettings

write_capacity_auto_scaling_settings GlobalTableCapacityAutoScalingSettings

writeCapacityAutoScalingSettings Property Map

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0