This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
azure-native.awsconnector.getDynamoDbTable
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
Get a DynamoDBTable Azure REST API version: 2024-12-01.
Using getDynamoDbTable
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 getDynamoDbTable(args: GetDynamoDbTableArgs, opts?: InvokeOptions): Promise<GetDynamoDbTableResult>
function getDynamoDbTableOutput(args: GetDynamoDbTableOutputArgs, opts?: InvokeOptions): Output<GetDynamoDbTableResult>
def get_dynamo_db_table(name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetDynamoDbTableResult
def get_dynamo_db_table_output(name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetDynamoDbTableResult]
func LookupDynamoDbTable(ctx *Context, args *LookupDynamoDbTableArgs, opts ...InvokeOption) (*LookupDynamoDbTableResult, error)
func LookupDynamoDbTableOutput(ctx *Context, args *LookupDynamoDbTableOutputArgs, opts ...InvokeOption) LookupDynamoDbTableResultOutput
> Note: This function is named LookupDynamoDbTable
in the Go SDK.
public static class GetDynamoDbTable
{
public static Task<GetDynamoDbTableResult> InvokeAsync(GetDynamoDbTableArgs args, InvokeOptions? opts = null)
public static Output<GetDynamoDbTableResult> Invoke(GetDynamoDbTableInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDynamoDbTableResult> getDynamoDbTable(GetDynamoDbTableArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:awsconnector:getDynamoDbTable
arguments:
# arguments dictionary
The following arguments are supported:
- Name string
- Name of DynamoDBTable
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Name string
- Name of DynamoDBTable
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- name String
- Name of DynamoDBTable
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- name string
- Name of DynamoDBTable
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- name str
- Name of DynamoDBTable
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- name String
- Name of DynamoDBTable
- resource
Group StringName - The name of the resource group. The name is case insensitive.
getDynamoDbTable Result
The following output properties are available:
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Location string
- The geo-location where the resource lives
- Name string
- The name of the resource
- Properties
Pulumi.
Azure Native. Aws Connector. Outputs. Dynamo DBTable Properties Response - The resource-specific properties for this resource.
- System
Data Pulumi.Azure Native. Aws Connector. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Dictionary<string, string>
- Resource tags.
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Location string
- The geo-location where the resource lives
- Name string
- The name of the resource
- Properties
Dynamo
DBTable Properties Response - The resource-specific properties for this resource.
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- map[string]string
- Resource tags.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- location String
- The geo-location where the resource lives
- name String
- The name of the resource
- properties
Dynamo
DBTable Properties Response - The resource-specific properties for this resource.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Map<String,String>
- Resource tags.
- id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- location string
- The geo-location where the resource lives
- name string
- The name of the resource
- properties
Dynamo
DBTable Properties Response - The resource-specific properties for this resource.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- {[key: string]: string}
- Resource tags.
- id str
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- location str
- The geo-location where the resource lives
- name str
- The name of the resource
- properties
Dynamo
DBTable Properties Response - The resource-specific properties for this resource.
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Mapping[str, str]
- Resource tags.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- location String
- The geo-location where the resource lives
- name String
- The name of the resource
- properties Property Map
- The resource-specific properties for this resource.
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Map<String>
- Resource tags.
Supporting Types
AttributeDefinitionResponse
- Attribute
Name string - A name for the attribute.
- Attribute
Type string - The data type for the attribute, where: +
S
- the attribute is of type String +N
- the attribute is of type Number +B
- the attribute is of type Binary
- Attribute
Name string - A name for the attribute.
- Attribute
Type string - The data type for the attribute, where: +
S
- the attribute is of type String +N
- the attribute is of type Number +B
- the attribute is of type Binary
- attribute
Name String - A name for the attribute.
- attribute
Type String - The data type for the attribute, where: +
S
- the attribute is of type String +N
- the attribute is of type Number +B
- the attribute is of type Binary
- attribute
Name string - A name for the attribute.
- attribute
Type string - The data type for the attribute, where: +
S
- the attribute is of type String +N
- the attribute is of type Number +B
- the attribute is of type Binary
- attribute_
name str - A name for the attribute.
- attribute_
type str - The data type for the attribute, where: +
S
- the attribute is of type String +N
- the attribute is of type Number +B
- the attribute is of type Binary
- attribute
Name String - A name for the attribute.
- attribute
Type String - The data type for the attribute, where: +
S
- the attribute is of type String +N
- the attribute is of type Number +B
- the attribute is of type Binary
AwsDynamoDBTablePropertiesResponse
- Arn string
- Property arn
- Attribute
Definitions List<Pulumi.Azure Native. Aws Connector. Inputs. Attribute Definition Response> - A list of attributes that describe the key schema for the table and indexes. This property is required to create a DDB table. Update requires: Some interruptions. Replacement if you edit an existing AttributeDefinition.
- Billing
Mode string - Specify how you are charged for read and write throughput and how you manage capacity. Valid values include: +
PROVISIONED
- We recommend usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned Mode. +PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-Demand Mode. If not specified, the default isPROVISIONED
. - Contributor
Insights Pulumi.Specification Azure Native. Aws Connector. Inputs. Contributor Insights Specification Response - The settings used to enable or disable CloudWatch Contributor Insights for the specified table. The settings used to enable or disable CloudWatch Contributor Insights.
- Deletion
Protection boolEnabled - Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see Using deletion protection in the Developer Guide.
- Global
Secondary List<Pulumi.Indexes Azure Native. Aws Connector. Inputs. Global Secondary Index Response> - Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is
ACTIVE
. You can track its status by using the DynamoDB DescribeTable command. If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. Updates are not supported. The following are exceptions: + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption. + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails. - Import
Source Pulumi.Specification Azure Native. Aws Connector. Inputs. Import Source Specification Response - Specifies the properties of data being imported from the S3 bucket source to the table. If you specify the
ImportSourceSpecification
property, and also specify either theStreamSpecification
, theTableClass
property, or theDeletionProtectionEnabled
property, the IAM entity creating/updating stack must haveUpdateTable
permission. Specifies the properties of data being imported from the S3 bucket source to the table. - Key
Schema List<Pulumi.Azure Native. Aws Connector. Inputs. Key Schema Response> - Specifies the attributes that make up the primary key for the table. The attributes in the
KeySchema
property must also be defined in theAttributeDefinitions
property. - Kinesis
Stream Pulumi.Specification Azure Native. Aws Connector. Inputs. Kinesis Stream Specification Response - The Kinesis Data Streams configuration for the specified table. The Kinesis Data Streams configuration for the specified table.
- Local
Secondary List<Pulumi.Indexes Azure Native. Aws Connector. Inputs. Local Secondary Index Response> - Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.
- Point
In Pulumi.Time Recovery Specification Azure Native. Aws Connector. Inputs. Point In Time Recovery Specification Response - The settings used to enable point in time recovery. The settings used to enable point in time recovery.
- Provisioned
Throughput Pulumi.Azure Native. Aws Connector. Inputs. Provisioned Throughput Response - Throughput for the specified table, which consists of values for
ReadCapacityUnits
andWriteCapacityUnits
. For more information about the contents of a provisioned throughput structure, see Amazon DynamoDB Table ProvisionedThroughput. If you setBillingMode
asPROVISIONED
, you must specify this property. If you setBillingMode
asPAY_PER_REQUEST
, you cannot specify this property. Throughput for the specified table, which consists of values forReadCapacityUnits
andWriteCapacityUnits
. For more information about the contents of a provisioned throughput structure, see Table ProvisionedThroughput. - Resource
Policy Pulumi.Azure Native. Aws Connector. Inputs. Resource Policy Response - A resource-based policy document that contains permissions to add to the specified table. 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. When you attach a resource-based policy while creating a table, the policy creation is strongly consistent. For information about the considerations that you should keep in mind while attaching a resource-based policy, see Resource-based policy considerations. 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: + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. + Resource-based policies don't support drift detection. If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes. + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template. For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template. Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template. For a full list of all considerations, see Resource-based policy considerations.
- Sse
Specification Pulumi.Azure Native. Aws Connector. Inputs. SSESpecification Response - Specifies the settings to enable server-side encryption. Represents the settings used to enable server-side encryption.
- Stream
Arn string - Property streamArn
- Stream
Specification Pulumi.Azure Native. Aws Connector. Inputs. Stream Specification Response - The settings for the DDB table stream, which capture changes to items stored in the table. Represents the DynamoDB Streams configuration for a table in DynamoDB.
- Table
Class string - The table class of the new table. Valid values are
STANDARD
andSTANDARD_INFREQUENT_ACCESS
. - Table
Name string - A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see Name Type. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- List<Pulumi.
Azure Native. Aws Connector. Inputs. Tag Response> - An array of key-value pairs to apply to this resource. For more information, see Tag.
- Time
To Pulumi.Live Specification Azure Native. Aws Connector. Inputs. Time To Live Specification Response - Specifies the Time to Live (TTL) settings for the table. For detailed information about the limits in DynamoDB, see Limits in Amazon DynamoDB in the Amazon DynamoDB Developer Guide. Represents the settings used to enable or disable Time to Live (TTL) for the specified table.
- Arn string
- Property arn
- Attribute
Definitions []AttributeDefinition Response - A list of attributes that describe the key schema for the table and indexes. This property is required to create a DDB table. Update requires: Some interruptions. Replacement if you edit an existing AttributeDefinition.
- Billing
Mode string - Specify how you are charged for read and write throughput and how you manage capacity. Valid values include: +
PROVISIONED
- We recommend usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned Mode. +PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-Demand Mode. If not specified, the default isPROVISIONED
. - Contributor
Insights ContributorSpecification Insights Specification Response - The settings used to enable or disable CloudWatch Contributor Insights for the specified table. The settings used to enable or disable CloudWatch Contributor Insights.
- Deletion
Protection boolEnabled - Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see Using deletion protection in the Developer Guide.
- Global
Secondary []GlobalIndexes Secondary Index Response - Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is
ACTIVE
. You can track its status by using the DynamoDB DescribeTable command. If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. Updates are not supported. The following are exceptions: + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption. + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails. - Import
Source ImportSpecification Source Specification Response - Specifies the properties of data being imported from the S3 bucket source to the table. If you specify the
ImportSourceSpecification
property, and also specify either theStreamSpecification
, theTableClass
property, or theDeletionProtectionEnabled
property, the IAM entity creating/updating stack must haveUpdateTable
permission. Specifies the properties of data being imported from the S3 bucket source to the table. - Key
Schema []KeySchema Response - Specifies the attributes that make up the primary key for the table. The attributes in the
KeySchema
property must also be defined in theAttributeDefinitions
property. - Kinesis
Stream KinesisSpecification Stream Specification Response - The Kinesis Data Streams configuration for the specified table. The Kinesis Data Streams configuration for the specified table.
- Local
Secondary []LocalIndexes Secondary Index Response - Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.
- Point
In PointTime Recovery Specification In Time Recovery Specification Response - The settings used to enable point in time recovery. The settings used to enable point in time recovery.
- Provisioned
Throughput ProvisionedThroughput Response - Throughput for the specified table, which consists of values for
ReadCapacityUnits
andWriteCapacityUnits
. For more information about the contents of a provisioned throughput structure, see Amazon DynamoDB Table ProvisionedThroughput. If you setBillingMode
asPROVISIONED
, you must specify this property. If you setBillingMode
asPAY_PER_REQUEST
, you cannot specify this property. Throughput for the specified table, which consists of values forReadCapacityUnits
andWriteCapacityUnits
. For more information about the contents of a provisioned throughput structure, see Table ProvisionedThroughput. - Resource
Policy ResourcePolicy Response - A resource-based policy document that contains permissions to add to the specified table. 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. When you attach a resource-based policy while creating a table, the policy creation is strongly consistent. For information about the considerations that you should keep in mind while attaching a resource-based policy, see Resource-based policy considerations. 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: + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. + Resource-based policies don't support drift detection. If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes. + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template. For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template. Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template. For a full list of all considerations, see Resource-based policy considerations.
- Sse
Specification SSESpecificationResponse - Specifies the settings to enable server-side encryption. Represents the settings used to enable server-side encryption.
- Stream
Arn string - Property streamArn
- Stream
Specification StreamSpecification Response - The settings for the DDB table stream, which capture changes to items stored in the table. Represents the DynamoDB Streams configuration for a table in DynamoDB.
- Table
Class string - The table class of the new table. Valid values are
STANDARD
andSTANDARD_INFREQUENT_ACCESS
. - Table
Name string - A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see Name Type. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- []Tag
Response - An array of key-value pairs to apply to this resource. For more information, see Tag.
- Time
To TimeLive Specification To Live Specification Response - Specifies the Time to Live (TTL) settings for the table. For detailed information about the limits in DynamoDB, see Limits in Amazon DynamoDB in the Amazon DynamoDB Developer Guide. Represents the settings used to enable or disable Time to Live (TTL) for the specified table.
- arn String
- Property arn
- attribute
Definitions List<AttributeDefinition Response> - A list of attributes that describe the key schema for the table and indexes. This property is required to create a DDB table. Update requires: Some interruptions. Replacement if you edit an existing AttributeDefinition.
- billing
Mode String - Specify how you are charged for read and write throughput and how you manage capacity. Valid values include: +
PROVISIONED
- We recommend usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned Mode. +PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-Demand Mode. If not specified, the default isPROVISIONED
. - contributor
Insights ContributorSpecification Insights Specification Response - The settings used to enable or disable CloudWatch Contributor Insights for the specified table. The settings used to enable or disable CloudWatch Contributor Insights.
- deletion
Protection BooleanEnabled - Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see Using deletion protection in the Developer Guide.
- global
Secondary List<GlobalIndexes Secondary Index Response> - Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is
ACTIVE
. You can track its status by using the DynamoDB DescribeTable command. If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. Updates are not supported. The following are exceptions: + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption. + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails. - import
Source ImportSpecification Source Specification Response - Specifies the properties of data being imported from the S3 bucket source to the table. If you specify the
ImportSourceSpecification
property, and also specify either theStreamSpecification
, theTableClass
property, or theDeletionProtectionEnabled
property, the IAM entity creating/updating stack must haveUpdateTable
permission. Specifies the properties of data being imported from the S3 bucket source to the table. - key
Schema List<KeySchema Response> - Specifies the attributes that make up the primary key for the table. The attributes in the
KeySchema
property must also be defined in theAttributeDefinitions
property. - kinesis
Stream KinesisSpecification Stream Specification Response - The Kinesis Data Streams configuration for the specified table. The Kinesis Data Streams configuration for the specified table.
- local
Secondary List<LocalIndexes Secondary Index Response> - Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.
- point
In PointTime Recovery Specification In Time Recovery Specification Response - The settings used to enable point in time recovery. The settings used to enable point in time recovery.
- provisioned
Throughput ProvisionedThroughput Response - Throughput for the specified table, which consists of values for
ReadCapacityUnits
andWriteCapacityUnits
. For more information about the contents of a provisioned throughput structure, see Amazon DynamoDB Table ProvisionedThroughput. If you setBillingMode
asPROVISIONED
, you must specify this property. If you setBillingMode
asPAY_PER_REQUEST
, you cannot specify this property. Throughput for the specified table, which consists of values forReadCapacityUnits
andWriteCapacityUnits
. For more information about the contents of a provisioned throughput structure, see Table ProvisionedThroughput. - resource
Policy ResourcePolicy Response - A resource-based policy document that contains permissions to add to the specified table. 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. When you attach a resource-based policy while creating a table, the policy creation is strongly consistent. For information about the considerations that you should keep in mind while attaching a resource-based policy, see Resource-based policy considerations. 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: + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. + Resource-based policies don't support drift detection. If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes. + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template. For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template. Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template. For a full list of all considerations, see Resource-based policy considerations.
- sse
Specification SSESpecificationResponse - Specifies the settings to enable server-side encryption. Represents the settings used to enable server-side encryption.
- stream
Arn String - Property streamArn
- stream
Specification StreamSpecification Response - The settings for the DDB table stream, which capture changes to items stored in the table. Represents the DynamoDB Streams configuration for a table in DynamoDB.
- table
Class String - The table class of the new table. Valid values are
STANDARD
andSTANDARD_INFREQUENT_ACCESS
. - table
Name String - A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see Name Type. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- List<Tag
Response> - An array of key-value pairs to apply to this resource. For more information, see Tag.
- time
To TimeLive Specification To Live Specification Response - Specifies the Time to Live (TTL) settings for the table. For detailed information about the limits in DynamoDB, see Limits in Amazon DynamoDB in the Amazon DynamoDB Developer Guide. Represents the settings used to enable or disable Time to Live (TTL) for the specified table.
- arn string
- Property arn
- attribute
Definitions AttributeDefinition Response[] - A list of attributes that describe the key schema for the table and indexes. This property is required to create a DDB table. Update requires: Some interruptions. Replacement if you edit an existing AttributeDefinition.
- billing
Mode string - Specify how you are charged for read and write throughput and how you manage capacity. Valid values include: +
PROVISIONED
- We recommend usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned Mode. +PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-Demand Mode. If not specified, the default isPROVISIONED
. - contributor
Insights ContributorSpecification Insights Specification Response - The settings used to enable or disable CloudWatch Contributor Insights for the specified table. The settings used to enable or disable CloudWatch Contributor Insights.
- deletion
Protection booleanEnabled - Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see Using deletion protection in the Developer Guide.
- global
Secondary GlobalIndexes Secondary Index Response[] - Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is
ACTIVE
. You can track its status by using the DynamoDB DescribeTable command. If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. Updates are not supported. The following are exceptions: + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption. + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails. - import
Source ImportSpecification Source Specification Response - Specifies the properties of data being imported from the S3 bucket source to the table. If you specify the
ImportSourceSpecification
property, and also specify either theStreamSpecification
, theTableClass
property, or theDeletionProtectionEnabled
property, the IAM entity creating/updating stack must haveUpdateTable
permission. Specifies the properties of data being imported from the S3 bucket source to the table. - key
Schema KeySchema Response[] - Specifies the attributes that make up the primary key for the table. The attributes in the
KeySchema
property must also be defined in theAttributeDefinitions
property. - kinesis
Stream KinesisSpecification Stream Specification Response - The Kinesis Data Streams configuration for the specified table. The Kinesis Data Streams configuration for the specified table.
- local
Secondary LocalIndexes Secondary Index Response[] - Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.
- point
In PointTime Recovery Specification In Time Recovery Specification Response - The settings used to enable point in time recovery. The settings used to enable point in time recovery.
- provisioned
Throughput ProvisionedThroughput Response - Throughput for the specified table, which consists of values for
ReadCapacityUnits
andWriteCapacityUnits
. For more information about the contents of a provisioned throughput structure, see Amazon DynamoDB Table ProvisionedThroughput. If you setBillingMode
asPROVISIONED
, you must specify this property. If you setBillingMode
asPAY_PER_REQUEST
, you cannot specify this property. Throughput for the specified table, which consists of values forReadCapacityUnits
andWriteCapacityUnits
. For more information about the contents of a provisioned throughput structure, see Table ProvisionedThroughput. - resource
Policy ResourcePolicy Response - A resource-based policy document that contains permissions to add to the specified table. 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. When you attach a resource-based policy while creating a table, the policy creation is strongly consistent. For information about the considerations that you should keep in mind while attaching a resource-based policy, see Resource-based policy considerations. 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: + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. + Resource-based policies don't support drift detection. If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes. + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template. For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template. Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template. For a full list of all considerations, see Resource-based policy considerations.
- sse
Specification SSESpecificationResponse - Specifies the settings to enable server-side encryption. Represents the settings used to enable server-side encryption.
- stream
Arn string - Property streamArn
- stream
Specification StreamSpecification Response - The settings for the DDB table stream, which capture changes to items stored in the table. Represents the DynamoDB Streams configuration for a table in DynamoDB.
- table
Class string - The table class of the new table. Valid values are
STANDARD
andSTANDARD_INFREQUENT_ACCESS
. - table
Name string - A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see Name Type. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- Tag
Response[] - An array of key-value pairs to apply to this resource. For more information, see Tag.
- time
To TimeLive Specification To Live Specification Response - Specifies the Time to Live (TTL) settings for the table. For detailed information about the limits in DynamoDB, see Limits in Amazon DynamoDB in the Amazon DynamoDB Developer Guide. Represents the settings used to enable or disable Time to Live (TTL) for the specified table.
- arn str
- Property arn
- attribute_
definitions Sequence[AttributeDefinition Response] - A list of attributes that describe the key schema for the table and indexes. This property is required to create a DDB table. Update requires: Some interruptions. Replacement if you edit an existing AttributeDefinition.
- billing_
mode str - Specify how you are charged for read and write throughput and how you manage capacity. Valid values include: +
PROVISIONED
- We recommend usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned Mode. +PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-Demand Mode. If not specified, the default isPROVISIONED
. - contributor_
insights_ Contributorspecification Insights Specification Response - The settings used to enable or disable CloudWatch Contributor Insights for the specified table. The settings used to enable or disable CloudWatch Contributor Insights.
- deletion_
protection_ boolenabled - Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see Using deletion protection in the Developer Guide.
- global_
secondary_ Sequence[Globalindexes Secondary Index Response] - Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is
ACTIVE
. You can track its status by using the DynamoDB DescribeTable command. If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. Updates are not supported. The following are exceptions: + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption. + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails. - import_
source_ Importspecification Source Specification Response - Specifies the properties of data being imported from the S3 bucket source to the table. If you specify the
ImportSourceSpecification
property, and also specify either theStreamSpecification
, theTableClass
property, or theDeletionProtectionEnabled
property, the IAM entity creating/updating stack must haveUpdateTable
permission. Specifies the properties of data being imported from the S3 bucket source to the table. - key_
schema Sequence[KeySchema Response] - Specifies the attributes that make up the primary key for the table. The attributes in the
KeySchema
property must also be defined in theAttributeDefinitions
property. - kinesis_
stream_ Kinesisspecification Stream Specification Response - The Kinesis Data Streams configuration for the specified table. The Kinesis Data Streams configuration for the specified table.
- local_
secondary_ Sequence[Localindexes Secondary Index Response] - Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.
- point_
in_ Pointtime_ recovery_ specification In Time Recovery Specification Response - The settings used to enable point in time recovery. The settings used to enable point in time recovery.
- provisioned_
throughput ProvisionedThroughput Response - Throughput for the specified table, which consists of values for
ReadCapacityUnits
andWriteCapacityUnits
. For more information about the contents of a provisioned throughput structure, see Amazon DynamoDB Table ProvisionedThroughput. If you setBillingMode
asPROVISIONED
, you must specify this property. If you setBillingMode
asPAY_PER_REQUEST
, you cannot specify this property. Throughput for the specified table, which consists of values forReadCapacityUnits
andWriteCapacityUnits
. For more information about the contents of a provisioned throughput structure, see Table ProvisionedThroughput. - resource_
policy ResourcePolicy Response - A resource-based policy document that contains permissions to add to the specified table. 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. When you attach a resource-based policy while creating a table, the policy creation is strongly consistent. For information about the considerations that you should keep in mind while attaching a resource-based policy, see Resource-based policy considerations. 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: + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. + Resource-based policies don't support drift detection. If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes. + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template. For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template. Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template. For a full list of all considerations, see Resource-based policy considerations.
- sse_
specification SSESpecificationResponse - Specifies the settings to enable server-side encryption. Represents the settings used to enable server-side encryption.
- stream_
arn str - Property streamArn
- stream_
specification StreamSpecification Response - The settings for the DDB table stream, which capture changes to items stored in the table. Represents the DynamoDB Streams configuration for a table in DynamoDB.
- table_
class str - The table class of the new table. Valid values are
STANDARD
andSTANDARD_INFREQUENT_ACCESS
. - table_
name str - A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see Name Type. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- Sequence[Tag
Response] - An array of key-value pairs to apply to this resource. For more information, see Tag.
- time_
to_ Timelive_ specification To Live Specification Response - Specifies the Time to Live (TTL) settings for the table. For detailed information about the limits in DynamoDB, see Limits in Amazon DynamoDB in the Amazon DynamoDB Developer Guide. Represents the settings used to enable or disable Time to Live (TTL) for the specified table.
- arn String
- Property arn
- attribute
Definitions List<Property Map> - A list of attributes that describe the key schema for the table and indexes. This property is required to create a DDB table. Update requires: Some interruptions. Replacement if you edit an existing AttributeDefinition.
- billing
Mode String - Specify how you are charged for read and write throughput and how you manage capacity. Valid values include: +
PROVISIONED
- We recommend usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned Mode. +PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-Demand Mode. If not specified, the default isPROVISIONED
. - contributor
Insights Property MapSpecification - The settings used to enable or disable CloudWatch Contributor Insights for the specified table. The settings used to enable or disable CloudWatch Contributor Insights.
- deletion
Protection BooleanEnabled - Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see Using deletion protection in the Developer Guide.
- global
Secondary List<Property Map>Indexes - Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is
ACTIVE
. You can track its status by using the DynamoDB DescribeTable command. If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. Updates are not supported. The following are exceptions: + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption. + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails. - import
Source Property MapSpecification - Specifies the properties of data being imported from the S3 bucket source to the table. If you specify the
ImportSourceSpecification
property, and also specify either theStreamSpecification
, theTableClass
property, or theDeletionProtectionEnabled
property, the IAM entity creating/updating stack must haveUpdateTable
permission. Specifies the properties of data being imported from the S3 bucket source to the table. - key
Schema List<Property Map> - Specifies the attributes that make up the primary key for the table. The attributes in the
KeySchema
property must also be defined in theAttributeDefinitions
property. - kinesis
Stream Property MapSpecification - The Kinesis Data Streams configuration for the specified table. The Kinesis Data Streams configuration for the specified table.
- local
Secondary List<Property Map>Indexes - Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.
- point
In Property MapTime Recovery Specification - The settings used to enable point in time recovery. The settings used to enable point in time recovery.
- provisioned
Throughput Property Map - Throughput for the specified table, which consists of values for
ReadCapacityUnits
andWriteCapacityUnits
. For more information about the contents of a provisioned throughput structure, see Amazon DynamoDB Table ProvisionedThroughput. If you setBillingMode
asPROVISIONED
, you must specify this property. If you setBillingMode
asPAY_PER_REQUEST
, you cannot specify this property. Throughput for the specified table, which consists of values forReadCapacityUnits
andWriteCapacityUnits
. For more information about the contents of a provisioned throughput structure, see Table ProvisionedThroughput. - resource
Policy Property Map - A resource-based policy document that contains permissions to add to the specified table. 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. When you attach a resource-based policy while creating a table, the policy creation is strongly consistent. For information about the considerations that you should keep in mind while attaching a resource-based policy, see Resource-based policy considerations. 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: + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. + Resource-based policies don't support drift detection. If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes. + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template. For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template. Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template. For a full list of all considerations, see Resource-based policy considerations.
- sse
Specification Property Map - Specifies the settings to enable server-side encryption. Represents the settings used to enable server-side encryption.
- stream
Arn String - Property streamArn
- stream
Specification Property Map - The settings for the DDB table stream, which capture changes to items stored in the table. Represents the DynamoDB Streams configuration for a table in DynamoDB.
- table
Class String - The table class of the new table. Valid values are
STANDARD
andSTANDARD_INFREQUENT_ACCESS
. - table
Name String - A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see Name Type. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- List<Property Map>
- An array of key-value pairs to apply to this resource. For more information, see Tag.
- time
To Property MapLive Specification - Specifies the Time to Live (TTL) settings for the table. For detailed information about the limits in DynamoDB, see Limits in Amazon DynamoDB in the Amazon DynamoDB Developer Guide. Represents the settings used to enable or disable Time to Live (TTL) for the specified table.
ContributorInsightsSpecificationResponse
- Enabled bool
- Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).
- Enabled bool
- Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).
- enabled Boolean
- Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).
- enabled boolean
- Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).
- enabled bool
- Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).
- enabled Boolean
- Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).
CsvResponse
- Delimiter string
- The delimiter used for separating items in the CSV file being imported.
- Header
List List<string> - List of the headers used to specify a common header for all source CSV files being imported. If this field is specified then the first line of each CSV file is treated as data instead of the header. If this field is not specified the the first line of each CSV file is treated as the header.
- Delimiter string
- The delimiter used for separating items in the CSV file being imported.
- Header
List []string - List of the headers used to specify a common header for all source CSV files being imported. If this field is specified then the first line of each CSV file is treated as data instead of the header. If this field is not specified the the first line of each CSV file is treated as the header.
- delimiter String
- The delimiter used for separating items in the CSV file being imported.
- header
List List<String> - List of the headers used to specify a common header for all source CSV files being imported. If this field is specified then the first line of each CSV file is treated as data instead of the header. If this field is not specified the the first line of each CSV file is treated as the header.
- delimiter string
- The delimiter used for separating items in the CSV file being imported.
- header
List string[] - List of the headers used to specify a common header for all source CSV files being imported. If this field is specified then the first line of each CSV file is treated as data instead of the header. If this field is not specified the the first line of each CSV file is treated as the header.
- delimiter str
- The delimiter used for separating items in the CSV file being imported.
- header_
list Sequence[str] - List of the headers used to specify a common header for all source CSV files being imported. If this field is specified then the first line of each CSV file is treated as data instead of the header. If this field is not specified the the first line of each CSV file is treated as the header.
- delimiter String
- The delimiter used for separating items in the CSV file being imported.
- header
List List<String> - List of the headers used to specify a common header for all source CSV files being imported. If this field is specified then the first line of each CSV file is treated as data instead of the header. If this field is not specified the the first line of each CSV file is treated as the header.
DynamoDBTablePropertiesResponse
- Provisioning
State string - The status of the last operation.
- Arn string
- Amazon Resource Name (ARN)
- Aws
Account stringId - AWS Account ID
- Aws
Properties Pulumi.Azure Native. Aws Connector. Inputs. Aws Dynamo DBTable Properties Response - AWS Properties
- Aws
Region string - AWS Region
- Aws
Source stringSchema - AWS Source Schema
- Dictionary<string, string>
- AWS Tags
- Public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- Public
Cloud stringResource Name - Public Cloud Resource Name
- Provisioning
State string - The status of the last operation.
- Arn string
- Amazon Resource Name (ARN)
- Aws
Account stringId - AWS Account ID
- Aws
Properties AwsDynamo DBTable Properties Response - AWS Properties
- Aws
Region string - AWS Region
- Aws
Source stringSchema - AWS Source Schema
- map[string]string
- AWS Tags
- Public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- Public
Cloud stringResource Name - Public Cloud Resource Name
- provisioning
State String - The status of the last operation.
- arn String
- Amazon Resource Name (ARN)
- aws
Account StringId - AWS Account ID
- aws
Properties AwsDynamo DBTable Properties Response - AWS Properties
- aws
Region String - AWS Region
- aws
Source StringSchema - AWS Source Schema
- Map<String,String>
- AWS Tags
- public
Cloud StringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud StringResource Name - Public Cloud Resource Name
- provisioning
State string - The status of the last operation.
- arn string
- Amazon Resource Name (ARN)
- aws
Account stringId - AWS Account ID
- aws
Properties AwsDynamo DBTable Properties Response - AWS Properties
- aws
Region string - AWS Region
- aws
Source stringSchema - AWS Source Schema
- {[key: string]: string}
- AWS Tags
- public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud stringResource Name - Public Cloud Resource Name
- provisioning_
state str - The status of the last operation.
- arn str
- Amazon Resource Name (ARN)
- aws_
account_ strid - AWS Account ID
- aws_
properties AwsDynamo DBTable Properties Response - AWS Properties
- aws_
region str - AWS Region
- aws_
source_ strschema - AWS Source Schema
- Mapping[str, str]
- AWS Tags
- public_
cloud_ strconnectors_ resource_ id - Public Cloud Connectors Resource ID
- public_
cloud_ strresource_ name - Public Cloud Resource Name
- provisioning
State String - The status of the last operation.
- arn String
- Amazon Resource Name (ARN)
- aws
Account StringId - AWS Account ID
- aws
Properties Property Map - AWS Properties
- aws
Region String - AWS Region
- aws
Source StringSchema - AWS Source Schema
- Map<String>
- AWS Tags
- public
Cloud StringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud StringResource Name - Public Cloud Resource Name
GlobalSecondaryIndexResponse
- Contributor
Insights Pulumi.Specification Azure Native. Aws Connector. Inputs. Contributor Insights Specification Response - The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index. The settings used to enable or disable CloudWatch Contributor Insights.
- Index
Name string - The name of the global secondary index. The name must be unique among all other indexes on this table.
- Key
Schema List<Pulumi.Azure Native. Aws Connector. Inputs. Key Schema Response> - The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: +
HASH
- partition key +RANGE
- sort key The partition key of an item is also known as its hash attribute. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. - Projection
Pulumi.
Azure Native. Aws Connector. Inputs. Projection Response - Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. 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.
- Provisioned
Throughput Pulumi.Azure Native. Aws Connector. Inputs. Provisioned Throughput Response - Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide. Throughput for the specified table, which consists of values for
ReadCapacityUnits
andWriteCapacityUnits
. For more information about the contents of a provisioned throughput structure, see Table ProvisionedThroughput.
- Contributor
Insights ContributorSpecification Insights Specification Response - The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index. The settings used to enable or disable CloudWatch Contributor Insights.
- Index
Name string - The name of the global secondary index. The name must be unique among all other indexes on this table.
- Key
Schema []KeySchema Response - The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: +
HASH
- partition key +RANGE
- sort key The partition key of an item is also known as its hash attribute. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. - Projection
Projection
Response - Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. 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.
- Provisioned
Throughput ProvisionedThroughput Response - Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide. Throughput for the specified table, which consists of values for
ReadCapacityUnits
andWriteCapacityUnits
. For more information about the contents of a provisioned throughput structure, see Table ProvisionedThroughput.
- contributor
Insights ContributorSpecification Insights Specification Response - The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index. The settings used to enable or disable CloudWatch Contributor Insights.
- index
Name String - The name of the global secondary index. The name must be unique among all other indexes on this table.
- key
Schema List<KeySchema Response> - The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: +
HASH
- partition key +RANGE
- sort key The partition key of an item is also known as its hash attribute. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. - projection
Projection
Response - Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. 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.
- provisioned
Throughput ProvisionedThroughput Response - Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide. Throughput for the specified table, which consists of values for
ReadCapacityUnits
andWriteCapacityUnits
. For more information about the contents of a provisioned throughput structure, see Table ProvisionedThroughput.
- contributor
Insights ContributorSpecification Insights Specification Response - The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index. The settings used to enable or disable CloudWatch Contributor Insights.
- index
Name string - The name of the global secondary index. The name must be unique among all other indexes on this table.
- key
Schema KeySchema Response[] - The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: +
HASH
- partition key +RANGE
- sort key The partition key of an item is also known as its hash attribute. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. - projection
Projection
Response - Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. 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.
- provisioned
Throughput ProvisionedThroughput Response - Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide. Throughput for the specified table, which consists of values for
ReadCapacityUnits
andWriteCapacityUnits
. For more information about the contents of a provisioned throughput structure, see Table ProvisionedThroughput.
- contributor_
insights_ Contributorspecification Insights Specification Response - The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index. The settings used to enable or disable CloudWatch Contributor Insights.
- index_
name str - The name of the global secondary index. The name must be unique among all other indexes on this table.
- key_
schema Sequence[KeySchema Response] - The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: +
HASH
- partition key +RANGE
- sort key The partition key of an item is also known as its hash attribute. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. - projection
Projection
Response - Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. 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.
- provisioned_
throughput ProvisionedThroughput Response - Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide. Throughput for the specified table, which consists of values for
ReadCapacityUnits
andWriteCapacityUnits
. For more information about the contents of a provisioned throughput structure, see Table ProvisionedThroughput.
- contributor
Insights Property MapSpecification - The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index. The settings used to enable or disable CloudWatch Contributor Insights.
- index
Name String - The name of the global secondary index. The name must be unique among all other indexes on this table.
- key
Schema List<Property Map> - The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: +
HASH
- partition key +RANGE
- sort key The partition key of an item is also known as its hash attribute. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. - projection Property Map
- Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. 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.
- provisioned
Throughput Property Map - Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide. Throughput for the specified table, which consists of values for
ReadCapacityUnits
andWriteCapacityUnits
. For more information about the contents of a provisioned throughput structure, see Table ProvisionedThroughput.
ImportSourceSpecificationResponse
- Input
Compression stringType - Type of compression to be used on the input coming from the imported table.
- Input
Format string - The format of the source data. Valid values for
ImportFormat
areCSV
,DYNAMODB_JSON
orION
. - Input
Format Pulumi.Options Azure Native. Aws Connector. Inputs. Input Format Options Response - Additional properties that specify how the input is formatted, The format options for the data that was imported into the target table. There is one value, CsvOption.
- S3Bucket
Source Pulumi.Azure Native. Aws Connector. Inputs. S3Bucket Source Response - The S3 bucket that provides the source for the import. The S3 bucket that is being imported from.
- Input
Compression stringType - Type of compression to be used on the input coming from the imported table.
- Input
Format string - The format of the source data. Valid values for
ImportFormat
areCSV
,DYNAMODB_JSON
orION
. - Input
Format InputOptions Format Options Response - Additional properties that specify how the input is formatted, The format options for the data that was imported into the target table. There is one value, CsvOption.
- S3Bucket
Source S3BucketSource Response - The S3 bucket that provides the source for the import. The S3 bucket that is being imported from.
- input
Compression StringType - Type of compression to be used on the input coming from the imported table.
- input
Format String - The format of the source data. Valid values for
ImportFormat
areCSV
,DYNAMODB_JSON
orION
. - input
Format InputOptions Format Options Response - Additional properties that specify how the input is formatted, The format options for the data that was imported into the target table. There is one value, CsvOption.
- s3Bucket
Source S3BucketSource Response - The S3 bucket that provides the source for the import. The S3 bucket that is being imported from.
- input
Compression stringType - Type of compression to be used on the input coming from the imported table.
- input
Format string - The format of the source data. Valid values for
ImportFormat
areCSV
,DYNAMODB_JSON
orION
. - input
Format InputOptions Format Options Response - Additional properties that specify how the input is formatted, The format options for the data that was imported into the target table. There is one value, CsvOption.
- s3Bucket
Source S3BucketSource Response - The S3 bucket that provides the source for the import. The S3 bucket that is being imported from.
- input_
compression_ strtype - Type of compression to be used on the input coming from the imported table.
- input_
format str - The format of the source data. Valid values for
ImportFormat
areCSV
,DYNAMODB_JSON
orION
. - input_
format_ Inputoptions Format Options Response - Additional properties that specify how the input is formatted, The format options for the data that was imported into the target table. There is one value, CsvOption.
- s3_
bucket_ S3Bucketsource Source Response - The S3 bucket that provides the source for the import. The S3 bucket that is being imported from.
- input
Compression StringType - Type of compression to be used on the input coming from the imported table.
- input
Format String - The format of the source data. Valid values for
ImportFormat
areCSV
,DYNAMODB_JSON
orION
. - input
Format Property MapOptions - Additional properties that specify how the input is formatted, The format options for the data that was imported into the target table. There is one value, CsvOption.
- s3Bucket
Source Property Map - The S3 bucket that provides the source for the import. The S3 bucket that is being imported from.
InputFormatOptionsResponse
- Csv
Pulumi.
Azure Native. Aws Connector. Inputs. Csv Response - The options for imported source files in CSV format. The values are Delimiter and HeaderList. The options for imported source files in CSV format. The values are Delimiter and HeaderList.
- Csv
Csv
Response - The options for imported source files in CSV format. The values are Delimiter and HeaderList. The options for imported source files in CSV format. The values are Delimiter and HeaderList.
- csv
Csv
Response - The options for imported source files in CSV format. The values are Delimiter and HeaderList. The options for imported source files in CSV format. The values are Delimiter and HeaderList.
- csv
Csv
Response - The options for imported source files in CSV format. The values are Delimiter and HeaderList. The options for imported source files in CSV format. The values are Delimiter and HeaderList.
- csv
Csv
Response - The options for imported source files in CSV format. The values are Delimiter and HeaderList. The options for imported source files in CSV format. The values are Delimiter and HeaderList.
- csv Property Map
- The options for imported source files in CSV format. The values are Delimiter and HeaderList. The options for imported source files in CSV format. The values are Delimiter and HeaderList.
KeySchemaResponse
- Attribute
Name string - The name of a key attribute.
- Key
Type string - The role that this key attribute will assume: +
HASH
- partition key +RANGE
- sort key The partition key of an item is also known as its hash attribute. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
- Attribute
Name string - The name of a key attribute.
- Key
Type string - The role that this key attribute will assume: +
HASH
- partition key +RANGE
- sort key The partition key of an item is also known as its hash attribute. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
- attribute
Name String - The name of a key attribute.
- key
Type String - The role that this key attribute will assume: +
HASH
- partition key +RANGE
- sort key The partition key of an item is also known as its hash attribute. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
- attribute
Name string - The name of a key attribute.
- key
Type string - The role that this key attribute will assume: +
HASH
- partition key +RANGE
- sort key The partition key of an item is also known as its hash attribute. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
- attribute_
name str - The name of a key attribute.
- key_
type str - The role that this key attribute will assume: +
HASH
- partition key +RANGE
- sort key The partition key of an item is also known as its hash attribute. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
- attribute
Name String - The name of a key attribute.
- key
Type String - The role that this key attribute will assume: +
HASH
- partition key +RANGE
- sort key The partition key of an item is also known as its hash attribute. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
KinesisStreamSpecificationResponse
- Approximate
Creation stringDate Time Precision - The precision for the time and date that the stream was created.
- Stream
Arn string - The ARN for a specific Kinesis data stream. Length Constraints: Minimum length of 37. Maximum length of 1024.
- Approximate
Creation stringDate Time Precision - The precision for the time and date that the stream was created.
- Stream
Arn string - The ARN for a specific Kinesis data stream. Length Constraints: Minimum length of 37. Maximum length of 1024.
- approximate
Creation StringDate Time Precision - The precision for the time and date that the stream was created.
- stream
Arn String - The ARN for a specific Kinesis data stream. Length Constraints: Minimum length of 37. Maximum length of 1024.
- approximate
Creation stringDate Time Precision - The precision for the time and date that the stream was created.
- stream
Arn string - The ARN for a specific Kinesis data stream. Length Constraints: Minimum length of 37. Maximum length of 1024.
- approximate_
creation_ strdate_ time_ precision - The precision for the time and date that the stream was created.
- stream_
arn str - The ARN for a specific Kinesis data stream. Length Constraints: Minimum length of 37. Maximum length of 1024.
- approximate
Creation StringDate Time Precision - The precision for the time and date that the stream was created.
- stream
Arn String - The ARN for a specific Kinesis data stream. Length Constraints: Minimum length of 37. Maximum length of 1024.
LocalSecondaryIndexResponse
- Index
Name string - The name of the local secondary index. The name must be unique among all other indexes on this table.
- Key
Schema List<Pulumi.Azure Native. Aws Connector. Inputs. Key Schema Response> - The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: +
HASH
- partition key +RANGE
- sort key The partition key of an item is also known as its hash attribute. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. - Projection
Pulumi.
Azure Native. Aws Connector. Inputs. Projection Response - Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. 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.
- Index
Name string - The name of the local secondary index. The name must be unique among all other indexes on this table.
- Key
Schema []KeySchema Response - The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: +
HASH
- partition key +RANGE
- sort key The partition key of an item is also known as its hash attribute. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. - Projection
Projection
Response - Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. 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.
- index
Name String - The name of the local secondary index. The name must be unique among all other indexes on this table.
- key
Schema List<KeySchema Response> - The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: +
HASH
- partition key +RANGE
- sort key The partition key of an item is also known as its hash attribute. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. - projection
Projection
Response - Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. 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.
- index
Name string - The name of the local secondary index. The name must be unique among all other indexes on this table.
- key
Schema KeySchema Response[] - The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: +
HASH
- partition key +RANGE
- sort key The partition key of an item is also known as its hash attribute. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. - projection
Projection
Response - Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. 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.
- index_
name str - The name of the local secondary index. The name must be unique among all other indexes on this table.
- key_
schema Sequence[KeySchema Response] - The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: +
HASH
- partition key +RANGE
- sort key The partition key of an item is also known as its hash attribute. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. - projection
Projection
Response - Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. 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.
- index
Name String - The name of the local secondary index. The name must be unique among all other indexes on this table.
- key
Schema List<Property Map> - The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: +
HASH
- partition key +RANGE
- sort key The partition key of an item is also known as its hash attribute. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. - projection Property Map
- Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. 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.
PointInTimeRecoverySpecificationResponse
- Point
In boolTime Recovery Enabled - Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.
- Point
In boolTime Recovery Enabled - Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.
- point
In BooleanTime Recovery Enabled - Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.
- point
In booleanTime Recovery Enabled - Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.
- point_
in_ booltime_ recovery_ enabled - Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.
- point
In BooleanTime Recovery Enabled - Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.
ProjectionResponse
- Non
Key List<string>Attributes - Represents the non-key attribute names which will be projected into the index. For local secondary indexes, the total count of
NonKeyAttributes
summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. - Projection
Type string - The set of attributes that are projected into the index: +
KEYS_ONLY
- Only the index and primary keys are projected into the index. +INCLUDE
- In addition to the attributes described inKEYS_ONLY
, the secondary index will include other non-key attributes that you specify. +ALL
- All of the table attributes are projected into the index. When using the DynamoDB console,ALL
is selected by default.
- Non
Key []stringAttributes - Represents the non-key attribute names which will be projected into the index. For local secondary indexes, the total count of
NonKeyAttributes
summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. - Projection
Type string - The set of attributes that are projected into the index: +
KEYS_ONLY
- Only the index and primary keys are projected into the index. +INCLUDE
- In addition to the attributes described inKEYS_ONLY
, the secondary index will include other non-key attributes that you specify. +ALL
- All of the table attributes are projected into the index. When using the DynamoDB console,ALL
is selected by default.
- non
Key List<String>Attributes - Represents the non-key attribute names which will be projected into the index. For local secondary indexes, the total count of
NonKeyAttributes
summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. - projection
Type String - The set of attributes that are projected into the index: +
KEYS_ONLY
- Only the index and primary keys are projected into the index. +INCLUDE
- In addition to the attributes described inKEYS_ONLY
, the secondary index will include other non-key attributes that you specify. +ALL
- All of the table attributes are projected into the index. When using the DynamoDB console,ALL
is selected by default.
- non
Key string[]Attributes - Represents the non-key attribute names which will be projected into the index. For local secondary indexes, the total count of
NonKeyAttributes
summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. - projection
Type string - The set of attributes that are projected into the index: +
KEYS_ONLY
- Only the index and primary keys are projected into the index. +INCLUDE
- In addition to the attributes described inKEYS_ONLY
, the secondary index will include other non-key attributes that you specify. +ALL
- All of the table attributes are projected into the index. When using the DynamoDB console,ALL
is selected by default.
- non_
key_ Sequence[str]attributes - Represents the non-key attribute names which will be projected into the index. For local secondary indexes, the total count of
NonKeyAttributes
summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. - projection_
type str - The set of attributes that are projected into the index: +
KEYS_ONLY
- Only the index and primary keys are projected into the index. +INCLUDE
- In addition to the attributes described inKEYS_ONLY
, the secondary index will include other non-key attributes that you specify. +ALL
- All of the table attributes are projected into the index. When using the DynamoDB console,ALL
is selected by default.
- non
Key List<String>Attributes - Represents the non-key attribute names which will be projected into the index. For local secondary indexes, the total count of
NonKeyAttributes
summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. - projection
Type String - The set of attributes that are projected into the index: +
KEYS_ONLY
- Only the index and primary keys are projected into the index. +INCLUDE
- In addition to the attributes described inKEYS_ONLY
, the secondary index will include other non-key attributes that you specify. +ALL
- All of the table attributes are projected into the index. When using the DynamoDB console,ALL
is selected by default.
ProvisionedThroughputResponse
- Read
Capacity intUnits - The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
ThrottlingException
. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode isPAY_PER_REQUEST
the value is set to 0. - Write
Capacity intUnits - The maximum number of writes consumed per second before DynamoDB returns a
ThrottlingException
. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode isPAY_PER_REQUEST
the value is set to 0.
- Read
Capacity intUnits - The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
ThrottlingException
. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode isPAY_PER_REQUEST
the value is set to 0. - Write
Capacity intUnits - The maximum number of writes consumed per second before DynamoDB returns a
ThrottlingException
. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode isPAY_PER_REQUEST
the value is set to 0.
- read
Capacity IntegerUnits - The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
ThrottlingException
. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode isPAY_PER_REQUEST
the value is set to 0. - write
Capacity IntegerUnits - The maximum number of writes consumed per second before DynamoDB returns a
ThrottlingException
. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode isPAY_PER_REQUEST
the value is set to 0.
- read
Capacity numberUnits - The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
ThrottlingException
. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode isPAY_PER_REQUEST
the value is set to 0. - write
Capacity numberUnits - The maximum number of writes consumed per second before DynamoDB returns a
ThrottlingException
. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode isPAY_PER_REQUEST
the value is set to 0.
- read_
capacity_ intunits - The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
ThrottlingException
. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode isPAY_PER_REQUEST
the value is set to 0. - write_
capacity_ intunits - The maximum number of writes consumed per second before DynamoDB returns a
ThrottlingException
. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode isPAY_PER_REQUEST
the value is set to 0.
- read
Capacity NumberUnits - The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
ThrottlingException
. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode isPAY_PER_REQUEST
the value is set to 0. - write
Capacity NumberUnits - The maximum number of writes consumed per second before DynamoDB returns a
ThrottlingException
. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode isPAY_PER_REQUEST
the value is set to 0.
ResourcePolicyResponse
- Policy
Document object - A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. 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.
- Policy
Document interface{} - A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. 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.
- policy
Document Object - A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. 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.
- policy
Document any - A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. 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.
- policy_
document Any - A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. 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.
- policy
Document Any - A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. 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.
S3BucketSourceResponse
- S3Bucket string
- The S3 bucket that is being imported from.
- S3Bucket
Owner string - The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional.
- S3Key
Prefix string - The key prefix shared by all S3 Objects that are being imported.
- S3Bucket string
- The S3 bucket that is being imported from.
- S3Bucket
Owner string - The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional.
- S3Key
Prefix string - The key prefix shared by all S3 Objects that are being imported.
- s3Bucket String
- The S3 bucket that is being imported from.
- s3Bucket
Owner String - The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional.
- s3Key
Prefix String - The key prefix shared by all S3 Objects that are being imported.
- s3Bucket string
- The S3 bucket that is being imported from.
- s3Bucket
Owner string - The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional.
- s3Key
Prefix string - The key prefix shared by all S3 Objects that are being imported.
- s3_
bucket str - The S3 bucket that is being imported from.
- s3_
bucket_ strowner - The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional.
- s3_
key_ strprefix - The key prefix shared by all S3 Objects that are being imported.
- s3Bucket String
- The S3 bucket that is being imported from.
- s3Bucket
Owner String - The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional.
- s3Key
Prefix String - The key prefix shared by all S3 Objects that are being imported.
SSESpecificationResponse
- Kms
Master stringKey Id - The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key
alias/aws/dynamodb
. - Sse
Enabled bool - Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to
KMS
and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key. - Sse
Type string - Server-side encryption type. The only supported value is: +
KMS
- Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply).
- Kms
Master stringKey Id - The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key
alias/aws/dynamodb
. - Sse
Enabled bool - Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to
KMS
and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key. - Sse
Type string - Server-side encryption type. The only supported value is: +
KMS
- Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply).
- kms
Master StringKey Id - The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key
alias/aws/dynamodb
. - sse
Enabled Boolean - Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to
KMS
and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key. - sse
Type String - Server-side encryption type. The only supported value is: +
KMS
- Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply).
- kms
Master stringKey Id - The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key
alias/aws/dynamodb
. - sse
Enabled boolean - Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to
KMS
and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key. - sse
Type string - Server-side encryption type. The only supported value is: +
KMS
- Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply).
- kms_
master_ strkey_ id - The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key
alias/aws/dynamodb
. - sse_
enabled bool - Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to
KMS
and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key. - sse_
type str - Server-side encryption type. The only supported value is: +
KMS
- Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply).
- kms
Master StringKey Id - The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key
alias/aws/dynamodb
. - sse
Enabled Boolean - Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to
KMS
and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key. - sse
Type String - Server-side encryption type. The only supported value is: +
KMS
- Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply).
StreamSpecificationResponse
- Resource
Policy Pulumi.Azure Native. Aws Connector. Inputs. Resource Policy Response - Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. 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. 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: + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. + Resource-based policies don't support drift detection. If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes. + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template. For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template. Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template. For a full list of all considerations, see Resource-based policy considerations.
- Stream
View stringType - When an item in the table is modified,
StreamViewType
determines what information is written to the stream for this table. Valid values forStreamViewType
are: +KEYS_ONLY
- Only the key attributes of the modified item are written to the stream. +NEW_IMAGE
- The entire item, as it appears after it was modified, is written to the stream. +OLD_IMAGE
- The entire item, as it appeared before it was modified, is written to the stream. +NEW_AND_OLD_IMAGES
- Both the new and the old item images of the item are written to the stream.
- Resource
Policy ResourcePolicy Response - Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. 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. 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: + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. + Resource-based policies don't support drift detection. If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes. + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template. For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template. Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template. For a full list of all considerations, see Resource-based policy considerations.
- Stream
View stringType - When an item in the table is modified,
StreamViewType
determines what information is written to the stream for this table. Valid values forStreamViewType
are: +KEYS_ONLY
- Only the key attributes of the modified item are written to the stream. +NEW_IMAGE
- The entire item, as it appears after it was modified, is written to the stream. +OLD_IMAGE
- The entire item, as it appeared before it was modified, is written to the stream. +NEW_AND_OLD_IMAGES
- Both the new and the old item images of the item are written to the stream.
- resource
Policy ResourcePolicy Response - Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. 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. 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: + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. + Resource-based policies don't support drift detection. If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes. + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template. For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template. Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template. For a full list of all considerations, see Resource-based policy considerations.
- stream
View StringType - When an item in the table is modified,
StreamViewType
determines what information is written to the stream for this table. Valid values forStreamViewType
are: +KEYS_ONLY
- Only the key attributes of the modified item are written to the stream. +NEW_IMAGE
- The entire item, as it appears after it was modified, is written to the stream. +OLD_IMAGE
- The entire item, as it appeared before it was modified, is written to the stream. +NEW_AND_OLD_IMAGES
- Both the new and the old item images of the item are written to the stream.
- resource
Policy ResourcePolicy Response - Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. 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. 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: + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. + Resource-based policies don't support drift detection. If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes. + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template. For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template. Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template. For a full list of all considerations, see Resource-based policy considerations.
- stream
View stringType - When an item in the table is modified,
StreamViewType
determines what information is written to the stream for this table. Valid values forStreamViewType
are: +KEYS_ONLY
- Only the key attributes of the modified item are written to the stream. +NEW_IMAGE
- The entire item, as it appears after it was modified, is written to the stream. +OLD_IMAGE
- The entire item, as it appeared before it was modified, is written to the stream. +NEW_AND_OLD_IMAGES
- Both the new and the old item images of the item are written to the stream.
- resource_
policy ResourcePolicy Response - Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. 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. 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: + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. + Resource-based policies don't support drift detection. If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes. + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template. For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template. Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template. For a full list of all considerations, see Resource-based policy considerations.
- stream_
view_ strtype - When an item in the table is modified,
StreamViewType
determines what information is written to the stream for this table. Valid values forStreamViewType
are: +KEYS_ONLY
- Only the key attributes of the modified item are written to the stream. +NEW_IMAGE
- The entire item, as it appears after it was modified, is written to the stream. +OLD_IMAGE
- The entire item, as it appeared before it was modified, is written to the stream. +NEW_AND_OLD_IMAGES
- Both the new and the old item images of the item are written to the stream.
- resource
Policy Property Map - Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. 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. 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: + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. + Resource-based policies don't support drift detection. If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes. + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template. For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template. Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template. For a full list of all considerations, see Resource-based policy considerations.
- stream
View StringType - When an item in the table is modified,
StreamViewType
determines what information is written to the stream for this table. Valid values forStreamViewType
are: +KEYS_ONLY
- Only the key attributes of the modified item are written to the stream. +NEW_IMAGE
- The entire item, as it appears after it was modified, is written to the stream. +OLD_IMAGE
- The entire item, as it appeared before it was modified, is written to the stream. +NEW_AND_OLD_IMAGES
- Both the new and the old item images of the item are written to the stream.
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
TagResponse
- Key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key str
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value str
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
TimeToLiveSpecificationResponse
- Attribute
Name string - The name of the TTL attribute used to store the expiration time for items in the table. + The
AttributeName
property is required when enabling the TTL, or when TTL is already enabled. + To update this property, you must first disable TTL and then enable TTL with the new attribute name. - Enabled bool
- Indicates whether TTL is to be enabled (true) or disabled (false) on the table.
- Attribute
Name string - The name of the TTL attribute used to store the expiration time for items in the table. + The
AttributeName
property is required when enabling the TTL, or when TTL is already enabled. + To update this property, you must first disable TTL and then enable TTL with the new attribute name. - Enabled bool
- Indicates whether TTL is to be enabled (true) or disabled (false) on the table.
- attribute
Name String - The name of the TTL attribute used to store the expiration time for items in the table. + The
AttributeName
property is required when enabling the TTL, or when TTL is already enabled. + To update this property, you must first disable TTL and then enable TTL with the new attribute name. - enabled Boolean
- Indicates whether TTL is to be enabled (true) or disabled (false) on the table.
- attribute
Name string - The name of the TTL attribute used to store the expiration time for items in the table. + The
AttributeName
property is required when enabling the TTL, or when TTL is already enabled. + To update this property, you must first disable TTL and then enable TTL with the new attribute name. - enabled boolean
- Indicates whether TTL is to be enabled (true) or disabled (false) on the table.
- attribute_
name str - The name of the TTL attribute used to store the expiration time for items in the table. + The
AttributeName
property is required when enabling the TTL, or when TTL is already enabled. + To update this property, you must first disable TTL and then enable TTL with the new attribute name. - enabled bool
- Indicates whether TTL is to be enabled (true) or disabled (false) on the table.
- attribute
Name String - The name of the TTL attribute used to store the expiration time for items in the table. + The
AttributeName
property is required when enabling the TTL, or when TTL is already enabled. + To update this property, you must first disable TTL and then enable TTL with the new attribute name. - enabled Boolean
- Indicates whether TTL is to be enabled (true) or disabled (false) on the table.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi