pulumi-aws-native-kotlin/com.pulumi.awsnative.dynamodb.kotlin.outputs

Package-level declarations

Types

data class GetGlobalTableResult(val arn: String? = null, val attributeDefinitions: List<GlobalTableAttributeDefinition>? = null, val billingMode: String? = null, val globalSecondaryIndexes: List<GlobalTableGlobalSecondaryIndex>? = null, val replicas: List<GlobalTableReplicaSpecification>? = null, val sseSpecification: GlobalTableSseSpecification? = null, val streamArn: String? = null, val streamSpecification: GlobalTableStreamSpecification? = null, val tableId: String? = null, val timeToLiveSpecification: GlobalTableTimeToLiveSpecification? = null, val warmThroughput: GlobalTableWarmThroughput? = null, val writeOnDemandThroughputSettings: GlobalTableWriteOnDemandThroughputSettings? = null, val writeProvisionedThroughputSettings: GlobalTableWriteProvisionedThroughputSettings? = null)

GetTableResult

data class GetTableResult(val arn: String? = null, val attributeDefinitions: List<TableAttributeDefinition>? = null, val billingMode: String? = null, val contributorInsightsSpecification: TableContributorInsightsSpecification? = null, val deletionProtectionEnabled: Boolean? = null, val globalSecondaryIndexes: List<TableGlobalSecondaryIndex>? = null, val keySchema: Either<List<TableKeySchema>, Any>? = null, val kinesisStreamSpecification: TableKinesisStreamSpecification? = null, val localSecondaryIndexes: List<TableLocalSecondaryIndex>? = null, val onDemandThroughput: TableOnDemandThroughput? = null, val pointInTimeRecoverySpecification: TablePointInTimeRecoverySpecification? = null, val provisionedThroughput: TableProvisionedThroughput? = null, val resourcePolicy: TableResourcePolicy? = null, val sseSpecification: TableSseSpecification? = null, val streamArn: String? = null, val streamSpecification: TableStreamSpecification? = null, val tableClass: String? = null, val tags: List<Tag>? = null, val timeToLiveSpecification: TableTimeToLiveSpecification? = null, val warmThroughput: TableWarmThroughput? = null)

GlobalTableAttributeDefinition

data class GlobalTableAttributeDefinition(val attributeName: String, val attributeType: String)

GlobalTableCapacityAutoScalingSettings

data class GlobalTableCapacityAutoScalingSettings(val maxCapacity: Int, val minCapacity: Int, val seedCapacity: Int? = null, val targetTrackingScalingPolicyConfiguration: GlobalTableTargetTrackingScalingPolicyConfiguration)

GlobalTableContributorInsightsSpecification

data class GlobalTableContributorInsightsSpecification(val enabled: Boolean)

GlobalTableGlobalSecondaryIndex

data class GlobalTableGlobalSecondaryIndex(val indexName: String, val keySchema: List<GlobalTableKeySchema>, val projection: GlobalTableProjection, val warmThroughput: GlobalTableWarmThroughput? = null, val writeOnDemandThroughputSettings: GlobalTableWriteOnDemandThroughputSettings? = null, val writeProvisionedThroughputSettings: GlobalTableWriteProvisionedThroughputSettings? = null)

GlobalTableKeySchema

data class GlobalTableKeySchema(val attributeName: String, val keyType: String)

GlobalTableKinesisStreamSpecification

data class GlobalTableKinesisStreamSpecification(val approximateCreationDateTimePrecision: GlobalTableKinesisStreamSpecificationApproximateCreationDateTimePrecision? = null, val streamArn: String)

GlobalTableLocalSecondaryIndex

data class GlobalTableLocalSecondaryIndex(val indexName: String, val keySchema: List<GlobalTableKeySchema>, val projection: GlobalTableProjection)

GlobalTablePointInTimeRecoverySpecification

data class GlobalTablePointInTimeRecoverySpecification(val pointInTimeRecoveryEnabled: Boolean? = null, val recoveryPeriodInDays: Int? = null)

GlobalTableProjection

data class GlobalTableProjection(val nonKeyAttributes: List<String>? = null, val projectionType: String? = null)

GlobalTableReadOnDemandThroughputSettings

data class GlobalTableReadOnDemandThroughputSettings(val maxReadRequestUnits: Int? = null)

GlobalTableReadProvisionedThroughputSettings

data class GlobalTableReadProvisionedThroughputSettings(val readCapacityAutoScalingSettings: GlobalTableCapacityAutoScalingSettings? = null, val readCapacityUnits: Int? = null)

GlobalTableReplicaGlobalSecondaryIndexSpecification

data class GlobalTableReplicaGlobalSecondaryIndexSpecification(val contributorInsightsSpecification: GlobalTableContributorInsightsSpecification? = null, val indexName: String, val readOnDemandThroughputSettings: GlobalTableReadOnDemandThroughputSettings? = null, val readProvisionedThroughputSettings: GlobalTableReadProvisionedThroughputSettings? = null)

GlobalTableReplicaSpecification

data class GlobalTableReplicaSpecification(val contributorInsightsSpecification: GlobalTableContributorInsightsSpecification? = null, val deletionProtectionEnabled: Boolean? = null, val globalSecondaryIndexes: List<GlobalTableReplicaGlobalSecondaryIndexSpecification>? = null, val kinesisStreamSpecification: GlobalTableKinesisStreamSpecification? = null, val pointInTimeRecoverySpecification: GlobalTablePointInTimeRecoverySpecification? = null, val readOnDemandThroughputSettings: GlobalTableReadOnDemandThroughputSettings? = null, val readProvisionedThroughputSettings: GlobalTableReadProvisionedThroughputSettings? = null, val region: String, val replicaStreamSpecification: GlobalTableReplicaStreamSpecification? = null, val resourcePolicy: GlobalTableResourcePolicy? = null, val sseSpecification: GlobalTableReplicaSseSpecification? = null, val tableClass: String? = null, val tags: List<GlobalTableTag>? = null)

GlobalTableReplicaSseSpecification

data class GlobalTableReplicaSseSpecification(val kmsMasterKeyId: String)

GlobalTableReplicaStreamSpecification

data class GlobalTableReplicaStreamSpecification(val resourcePolicy: GlobalTableResourcePolicy)

GlobalTableResourcePolicy

data class GlobalTableResourcePolicy(val policyDocument: Any)

GlobalTableSseSpecification

data class GlobalTableSseSpecification(val sseEnabled: Boolean, val sseType: String? = null)

GlobalTableStreamSpecification

data class GlobalTableStreamSpecification(val streamViewType: String)

GlobalTableTag

data class GlobalTableTag(val key: String, val value: String)

GlobalTableTargetTrackingScalingPolicyConfiguration

data class GlobalTableTargetTrackingScalingPolicyConfiguration(val disableScaleIn: Boolean? = null, val scaleInCooldown: Int? = null, val scaleOutCooldown: Int? = null, val targetValue: Double)

GlobalTableTimeToLiveSpecification

data class GlobalTableTimeToLiveSpecification(val attributeName: String? = null, val enabled: Boolean)

GlobalTableWarmThroughput

data class GlobalTableWarmThroughput(val readUnitsPerSecond: Int? = null, val writeUnitsPerSecond: Int? = null)

GlobalTableWriteOnDemandThroughputSettings

data class GlobalTableWriteOnDemandThroughputSettings(val maxWriteRequestUnits: Int? = null)

GlobalTableWriteProvisionedThroughputSettings

data class GlobalTableWriteProvisionedThroughputSettings(val writeCapacityAutoScalingSettings: GlobalTableCapacityAutoScalingSettings? = null)

TableAttributeDefinition

data class TableAttributeDefinition(val attributeName: String, val attributeType: String)

Represents an attribute for describing the schema for the table and indexes.

TableContributorInsightsSpecification

data class TableContributorInsightsSpecification(val enabled: Boolean)

The settings used to enable or disable CloudWatch Contributor Insights.

TableCsv

data class TableCsv(val delimiter: String? = null, val headerList: List<String>? = null)

The options for imported source files in CSV format. The values are Delimiter and HeaderList.

TableGlobalSecondaryIndex

data class TableGlobalSecondaryIndex(val contributorInsightsSpecification: TableContributorInsightsSpecification? = null, val indexName: String, val keySchema: List<TableKeySchema>, val onDemandThroughput: TableOnDemandThroughput? = null, val projection: TableProjection, val provisionedThroughput: TableProvisionedThroughput? = null, val warmThroughput: TableWarmThroughput? = null)

Represents the properties of a global secondary index.

TableImportSourceSpecification

data class TableImportSourceSpecification(val inputCompressionType: String? = null, val inputFormat: String, val inputFormatOptions: TableInputFormatOptions? = null, val s3BucketSource: TableS3BucketSource)

Specifies the properties of data being imported from the S3 bucket source to the table.

TableInputFormatOptions

data class TableInputFormatOptions(val csv: TableCsv? = null)

The format options for the data that was imported into the target table. There is one value, CsvOption.

TableKeySchema

data class TableKeySchema(val attributeName: String, val keyType: String)

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index. A `KeySchemaElement` represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one `KeySchemaElement` (for the partition key). A composite primary key would require one `KeySchemaElement` for the partition key, and another `KeySchemaElement` for the sort key. A `KeySchemaElement` must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.

TableKinesisStreamSpecification

data class TableKinesisStreamSpecification(val approximateCreationDateTimePrecision: TableKinesisStreamSpecificationApproximateCreationDateTimePrecision? = null, val streamArn: String)

The Kinesis Data Streams configuration for the specified table.

TableLocalSecondaryIndex

data class TableLocalSecondaryIndex(val indexName: String, val keySchema: List<TableKeySchema>, val projection: TableProjection)

Represents the properties of a local secondary index. A local secondary index can only be created when its parent table is created.

TableOnDemandThroughput

data class TableOnDemandThroughput(val maxReadRequestUnits: Int? = null, val maxWriteRequestUnits: Int? = null)

Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify `MaxReadRequestUnits`, `MaxWriteRequestUnits`, or both.

TablePointInTimeRecoverySpecification

data class TablePointInTimeRecoverySpecification(val pointInTimeRecoveryEnabled: Boolean? = null, val recoveryPeriodInDays: Int? = null)

The settings used to enable point in time recovery.

TableProjection

data class TableProjection(val nonKeyAttributes: List<String>? = null, val projectionType: String? = null)

Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

TableProvisionedThroughput

data class TableProvisionedThroughput(val readCapacityUnits: Int, val writeCapacityUnits: Int)

Throughput for the specified table, which consists of values for `ReadCapacityUnits` and `WriteCapacityUnits`. For more information about the contents of a provisioned throughput structure, see Table ProvisionedThroughput.

TableResourcePolicy

data class TableResourcePolicy(val policyDocument: Any)

Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table, its indexes, and stream. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see Using resource-based policies for and Resource-based policy examples. While defining resource-based policies in your CFNshort templates, the following considerations apply:

TableS3BucketSource

data class TableS3BucketSource(val s3Bucket: String, val s3BucketOwner: String? = null, val s3KeyPrefix: String? = null)

The S3 bucket that is being imported from.

TableSseSpecification

data class TableSseSpecification(val kmsMasterKeyId: String? = null, val sseEnabled: Boolean, val sseType: String? = null)

Represents the settings used to enable server-side encryption.

TableStreamSpecification

data class TableStreamSpecification(val resourcePolicy: TableResourcePolicy? = null, val streamViewType: String)

Represents the DynamoDB Streams configuration for a table in DynamoDB.

TableTimeToLiveSpecification

data class TableTimeToLiveSpecification(val attributeName: String? = null, val enabled: Boolean)

Represents the settings used to enable or disable Time to Live (TTL) for the specified table.

TableWarmThroughput

data class TableWarmThroughput(val readUnitsPerSecond: Int? = null, val writeUnitsPerSecond: Int? = null)

Provides visibility into the number of read and write operations your table or secondary index can instantaneously support. The settings can be modified using the `UpdateTable` operation to meet the throughput requirements of an upcoming peak event.