AWS v6.71.0, Mar 7 25

AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi

aws.dynamodb.TableExport

Explore with Pulumi AI

AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi

pulumi/pulumi-aws

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.s3.BucketV2("example", {
    bucketPrefix: "example",
    forceDestroy: true,
});
const exampleTable = new aws.dynamodb.Table("example", {
    name: "example-table-1",
    billingMode: "PAY_PER_REQUEST",
    hashKey: "user_id",
    attributes: [{
        name: "user_id",
        type: "S",
    }],
    pointInTimeRecovery: {
        enabled: true,
    },
});
const exampleTableExport = new aws.dynamodb.TableExport("example", {
    tableArn: exampleTable.arn,
    s3Bucket: example.id,
});

import pulumi
import pulumi_aws as aws

example = aws.s3.BucketV2("example",
    bucket_prefix="example",
    force_destroy=True)
example_table = aws.dynamodb.Table("example",
    name="example-table-1",
    billing_mode="PAY_PER_REQUEST",
    hash_key="user_id",
    attributes=[{
        "name": "user_id",
        "type": "S",
    }],
    point_in_time_recovery={
        "enabled": True,
    })
example_table_export = aws.dynamodb.TableExport("example",
    table_arn=example_table.arn,
    s3_bucket=example.id)

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/dynamodb"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/s3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := s3.NewBucketV2(ctx, "example", &s3.BucketV2Args{
			BucketPrefix: pulumi.String("example"),
			ForceDestroy: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		exampleTable, err := dynamodb.NewTable(ctx, "example", &dynamodb.TableArgs{
			Name:        pulumi.String("example-table-1"),
			BillingMode: pulumi.String("PAY_PER_REQUEST"),
			HashKey:     pulumi.String("user_id"),
			Attributes: dynamodb.TableAttributeArray{
				&dynamodb.TableAttributeArgs{
					Name: pulumi.String("user_id"),
					Type: pulumi.String("S"),
				},
			},
			PointInTimeRecovery: &dynamodb.TablePointInTimeRecoveryArgs{
				Enabled: pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		_, err = dynamodb.NewTableExport(ctx, "example", &dynamodb.TableExportArgs{
			TableArn: exampleTable.Arn,
			S3Bucket: example.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.S3.BucketV2("example", new()
    {
        BucketPrefix = "example",
        ForceDestroy = true,
    });

    var exampleTable = new Aws.DynamoDB.Table("example", new()
    {
        Name = "example-table-1",
        BillingMode = "PAY_PER_REQUEST",
        HashKey = "user_id",
        Attributes = new[]
        {
            new Aws.DynamoDB.Inputs.TableAttributeArgs
            {
                Name = "user_id",
                Type = "S",
            },
        },
        PointInTimeRecovery = new Aws.DynamoDB.Inputs.TablePointInTimeRecoveryArgs
        {
            Enabled = true,
        },
    });

    var exampleTableExport = new Aws.DynamoDB.TableExport("example", new()
    {
        TableArn = exampleTable.Arn,
        S3Bucket = example.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.BucketV2;
import com.pulumi.aws.s3.BucketV2Args;
import com.pulumi.aws.dynamodb.Table;
import com.pulumi.aws.dynamodb.TableArgs;
import com.pulumi.aws.dynamodb.inputs.TableAttributeArgs;
import com.pulumi.aws.dynamodb.inputs.TablePointInTimeRecoveryArgs;
import com.pulumi.aws.dynamodb.TableExport;
import com.pulumi.aws.dynamodb.TableExportArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new BucketV2("example", BucketV2Args.builder()
            .bucketPrefix("example")
            .forceDestroy(true)
            .build());

        var exampleTable = new Table("exampleTable", TableArgs.builder()
            .name("example-table-1")
            .billingMode("PAY_PER_REQUEST")
            .hashKey("user_id")
            .attributes(TableAttributeArgs.builder()
                .name("user_id")
                .type("S")
                .build())
            .pointInTimeRecovery(TablePointInTimeRecoveryArgs.builder()
                .enabled(true)
                .build())
            .build());

        var exampleTableExport = new TableExport("exampleTableExport", TableExportArgs.builder()
            .tableArn(exampleTable.arn())
            .s3Bucket(example.id())
            .build());

    }
}

resources:
  example:
    type: aws:s3:BucketV2
    properties:
      bucketPrefix: example
      forceDestroy: true
  exampleTable:
    type: aws:dynamodb:Table
    name: example
    properties:
      name: example-table-1
      billingMode: PAY_PER_REQUEST
      hashKey: user_id
      attributes:
        - name: user_id
          type: S
      pointInTimeRecovery:
        enabled: true
  exampleTableExport:
    type: aws:dynamodb:TableExport
    name: example
    properties:
      tableArn: ${exampleTable.arn}
      s3Bucket: ${example.id}

Example with export time

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.dynamodb.TableExport("example", {
    exportTime: "2023-04-02T11:30:13+01:00",
    s3Bucket: exampleAwsS3Bucket.id,
    tableArn: exampleAwsDynamodbTable.arn,
});

import pulumi
import pulumi_aws as aws

example = aws.dynamodb.TableExport("example",
    export_time="2023-04-02T11:30:13+01:00",
    s3_bucket=example_aws_s3_bucket["id"],
    table_arn=example_aws_dynamodb_table["arn"])

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/dynamodb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dynamodb.NewTableExport(ctx, "example", &dynamodb.TableExportArgs{
			ExportTime: pulumi.String("2023-04-02T11:30:13+01:00"),
			S3Bucket:   pulumi.Any(exampleAwsS3Bucket.Id),
			TableArn:   pulumi.Any(exampleAwsDynamodbTable.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.DynamoDB.TableExport("example", new()
    {
        ExportTime = "2023-04-02T11:30:13+01:00",
        S3Bucket = exampleAwsS3Bucket.Id,
        TableArn = exampleAwsDynamodbTable.Arn,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.dynamodb.TableExport;
import com.pulumi.aws.dynamodb.TableExportArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new TableExport("example", TableExportArgs.builder()
            .exportTime("2023-04-02T11:30:13+01:00")
            .s3Bucket(exampleAwsS3Bucket.id())
            .tableArn(exampleAwsDynamodbTable.arn())
            .build());

    }
}

resources:
  example:
    type: aws:dynamodb:TableExport
    properties:
      exportTime: 2023-04-02T11:30:13+01:00
      s3Bucket: ${exampleAwsS3Bucket.id}
      tableArn: ${exampleAwsDynamodbTable.arn}

Incremental export

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.dynamodb.TableExport("example", {
    exportType: "INCREMENTAL_EXPORT",
    s3Bucket: exampleAwsS3Bucket.id,
    tableArn: exampleAwsDynamodbTable.arn,
    incrementalExportSpecification: {
        exportFromTime: "2025-02-09T12:00:00+01:00",
        exportToTime: "2025-02-09T13:00:00+01:00",
    },
});

import pulumi
import pulumi_aws as aws

example = aws.dynamodb.TableExport("example",
    export_type="INCREMENTAL_EXPORT",
    s3_bucket=example_aws_s3_bucket["id"],
    table_arn=example_aws_dynamodb_table["arn"],
    incremental_export_specification={
        "export_from_time": "2025-02-09T12:00:00+01:00",
        "export_to_time": "2025-02-09T13:00:00+01:00",
    })

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/dynamodb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dynamodb.NewTableExport(ctx, "example", &dynamodb.TableExportArgs{
			ExportType: pulumi.String("INCREMENTAL_EXPORT"),
			S3Bucket:   pulumi.Any(exampleAwsS3Bucket.Id),
			TableArn:   pulumi.Any(exampleAwsDynamodbTable.Arn),
			IncrementalExportSpecification: &dynamodb.TableExportIncrementalExportSpecificationArgs{
				ExportFromTime: pulumi.String("2025-02-09T12:00:00+01:00"),
				ExportToTime:   pulumi.String("2025-02-09T13:00:00+01:00"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.DynamoDB.TableExport("example", new()
    {
        ExportType = "INCREMENTAL_EXPORT",
        S3Bucket = exampleAwsS3Bucket.Id,
        TableArn = exampleAwsDynamodbTable.Arn,
        IncrementalExportSpecification = new Aws.DynamoDB.Inputs.TableExportIncrementalExportSpecificationArgs
        {
            ExportFromTime = "2025-02-09T12:00:00+01:00",
            ExportToTime = "2025-02-09T13:00:00+01:00",
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.dynamodb.TableExport;
import com.pulumi.aws.dynamodb.TableExportArgs;
import com.pulumi.aws.dynamodb.inputs.TableExportIncrementalExportSpecificationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new TableExport("example", TableExportArgs.builder()
            .exportType("INCREMENTAL_EXPORT")
            .s3Bucket(exampleAwsS3Bucket.id())
            .tableArn(exampleAwsDynamodbTable.arn())
            .incrementalExportSpecification(TableExportIncrementalExportSpecificationArgs.builder()
                .exportFromTime("2025-02-09T12:00:00+01:00")
                .exportToTime("2025-02-09T13:00:00+01:00")
                .build())
            .build());

    }
}

resources:
  example:
    type: aws:dynamodb:TableExport
    properties:
      exportType: INCREMENTAL_EXPORT
      s3Bucket: ${exampleAwsS3Bucket.id}
      tableArn: ${exampleAwsDynamodbTable.arn}
      incrementalExportSpecification:
        exportFromTime: 2025-02-09T12:00:00+01:00
        exportToTime: 2025-02-09T13:00:00+01:00

Create TableExport Resource

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

Constructor syntax

new TableExport(name: string, args: TableExportArgs, opts?: CustomResourceOptions);

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

@overload
def TableExport(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                s3_bucket: Optional[str] = None,
                table_arn: Optional[str] = None,
                export_format: Optional[str] = None,
                export_time: Optional[str] = None,
                export_type: Optional[str] = None,
                incremental_export_specification: Optional[TableExportIncrementalExportSpecificationArgs] = None,
                s3_bucket_owner: Optional[str] = None,
                s3_prefix: Optional[str] = None,
                s3_sse_algorithm: Optional[str] = None,
                s3_sse_kms_key_id: Optional[str] = None)

func NewTableExport(ctx *Context, name string, args TableExportArgs, opts ...ResourceOption) (*TableExport, error)

public TableExport(string name, TableExportArgs args, CustomResourceOptions? opts = null)

public TableExport(String name, TableExportArgs args)
public TableExport(String name, TableExportArgs args, CustomResourceOptions options)

type: aws:dynamodb:TableExport
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

resource_name str: The unique name of the resource.
args TableExportArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args TableExportArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

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

Constructor example

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

var tableExportResource = new Aws.DynamoDB.TableExport("tableExportResource", new()
{
    S3Bucket = "string",
    TableArn = "string",
    ExportFormat = "string",
    ExportTime = "string",
    ExportType = "string",
    IncrementalExportSpecification = new Aws.DynamoDB.Inputs.TableExportIncrementalExportSpecificationArgs
    {
        ExportFromTime = "string",
        ExportToTime = "string",
        ExportViewType = "string",
    },
    S3BucketOwner = "string",
    S3Prefix = "string",
    S3SseAlgorithm = "string",
    S3SseKmsKeyId = "string",
});

example, err := dynamodb.NewTableExport(ctx, "tableExportResource", &dynamodb.TableExportArgs{
	S3Bucket:     pulumi.String("string"),
	TableArn:     pulumi.String("string"),
	ExportFormat: pulumi.String("string"),
	ExportTime:   pulumi.String("string"),
	ExportType:   pulumi.String("string"),
	IncrementalExportSpecification: &dynamodb.TableExportIncrementalExportSpecificationArgs{
		ExportFromTime: pulumi.String("string"),
		ExportToTime:   pulumi.String("string"),
		ExportViewType: pulumi.String("string"),
	},
	S3BucketOwner:  pulumi.String("string"),
	S3Prefix:       pulumi.String("string"),
	S3SseAlgorithm: pulumi.String("string"),
	S3SseKmsKeyId:  pulumi.String("string"),
})

var tableExportResource = new TableExport("tableExportResource", TableExportArgs.builder()
    .s3Bucket("string")
    .tableArn("string")
    .exportFormat("string")
    .exportTime("string")
    .exportType("string")
    .incrementalExportSpecification(TableExportIncrementalExportSpecificationArgs.builder()
        .exportFromTime("string")
        .exportToTime("string")
        .exportViewType("string")
        .build())
    .s3BucketOwner("string")
    .s3Prefix("string")
    .s3SseAlgorithm("string")
    .s3SseKmsKeyId("string")
    .build());

table_export_resource = aws.dynamodb.TableExport("tableExportResource",
    s3_bucket="string",
    table_arn="string",
    export_format="string",
    export_time="string",
    export_type="string",
    incremental_export_specification={
        "export_from_time": "string",
        "export_to_time": "string",
        "export_view_type": "string",
    },
    s3_bucket_owner="string",
    s3_prefix="string",
    s3_sse_algorithm="string",
    s3_sse_kms_key_id="string")

const tableExportResource = new aws.dynamodb.TableExport("tableExportResource", {
    s3Bucket: "string",
    tableArn: "string",
    exportFormat: "string",
    exportTime: "string",
    exportType: "string",
    incrementalExportSpecification: {
        exportFromTime: "string",
        exportToTime: "string",
        exportViewType: "string",
    },
    s3BucketOwner: "string",
    s3Prefix: "string",
    s3SseAlgorithm: "string",
    s3SseKmsKeyId: "string",
});

type: aws:dynamodb:TableExport
properties:
    exportFormat: string
    exportTime: string
    exportType: string
    incrementalExportSpecification:
        exportFromTime: string
        exportToTime: string
        exportViewType: string
    s3Bucket: string
    s3BucketOwner: string
    s3Prefix: string
    s3SseAlgorithm: string
    s3SseKmsKeyId: string
    tableArn: string

TableExport Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The TableExport resource accepts the following input properties:

S3Bucket string

Name of the Amazon S3 bucket to export the snapshot to. See the AWS Documentation for information on how configure this S3 bucket.

TableArn string

ARN associated with the table to export.

The following arguments are optional:

ExportFormat string

Format for the exported data. Valid values are: DYNAMODB_JSON, ION. See the AWS Documentation for more information on these export formats. Default is DYNAMODB_JSON.

ExportTime string

Time in RFC3339 format from which to export table data. The table export will be a snapshot of the table's state at this point in time. Omitting this value will result in a snapshot from the current time.

ExportType string

Whether to execute as a full export or incremental export. Valid values are: FULL_EXPORT, INCREMENTAL_EXPORT. Defaults to FULL_EXPORT. If INCREMENTAL_EXPORT is provided, the incremental_export_specification argument must also be provided. incremental_export_specification - (Optional, Forces new resource) Parameters specific to an incremental export. See incremental_export_specification Block for details.

IncrementalExportSpecification TableExportIncrementalExportSpecification

S3BucketOwner string

ID of the AWS account that owns the bucket the export will be stored in.

S3Prefix string

Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

S3SseAlgorithm string

Type of encryption used on the bucket where export data will be stored. Valid values are: AES256, KMS.

S3SseKmsKeyId string

ID of the AWS KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).

S3Bucket string

Name of the Amazon S3 bucket to export the snapshot to. See the AWS Documentation for information on how configure this S3 bucket.

TableArn string

ARN associated with the table to export.

The following arguments are optional:

ExportFormat string

Format for the exported data. Valid values are: DYNAMODB_JSON, ION. See the AWS Documentation for more information on these export formats. Default is DYNAMODB_JSON.

ExportTime string

ExportType string

IncrementalExportSpecification TableExportIncrementalExportSpecificationArgs

S3BucketOwner string

ID of the AWS account that owns the bucket the export will be stored in.

S3Prefix string

Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

S3SseAlgorithm string

Type of encryption used on the bucket where export data will be stored. Valid values are: AES256, KMS.

S3SseKmsKeyId string

ID of the AWS KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).

s3Bucket String

Name of the Amazon S3 bucket to export the snapshot to. See the AWS Documentation for information on how configure this S3 bucket.

tableArn String

ARN associated with the table to export.

The following arguments are optional:

exportFormat String

Format for the exported data. Valid values are: DYNAMODB_JSON, ION. See the AWS Documentation for more information on these export formats. Default is DYNAMODB_JSON.

exportTime String

exportType String

incrementalExportSpecification TableExportIncrementalExportSpecification

s3BucketOwner String

ID of the AWS account that owns the bucket the export will be stored in.

s3Prefix String

Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

s3SseAlgorithm String

Type of encryption used on the bucket where export data will be stored. Valid values are: AES256, KMS.

s3SseKmsKeyId String

ID of the AWS KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).

s3Bucket string

Name of the Amazon S3 bucket to export the snapshot to. See the AWS Documentation for information on how configure this S3 bucket.

tableArn string

ARN associated with the table to export.

The following arguments are optional:

exportFormat string

Format for the exported data. Valid values are: DYNAMODB_JSON, ION. See the AWS Documentation for more information on these export formats. Default is DYNAMODB_JSON.

exportTime string

exportType string

incrementalExportSpecification TableExportIncrementalExportSpecification

s3BucketOwner string

ID of the AWS account that owns the bucket the export will be stored in.

s3Prefix string

Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

s3SseAlgorithm string

Type of encryption used on the bucket where export data will be stored. Valid values are: AES256, KMS.

s3SseKmsKeyId string

ID of the AWS KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).

s3_bucket str

Name of the Amazon S3 bucket to export the snapshot to. See the AWS Documentation for information on how configure this S3 bucket.

table_arn str

ARN associated with the table to export.

The following arguments are optional:

export_format str

Format for the exported data. Valid values are: DYNAMODB_JSON, ION. See the AWS Documentation for more information on these export formats. Default is DYNAMODB_JSON.

export_time str

export_type str

incremental_export_specification TableExportIncrementalExportSpecificationArgs

s3_bucket_owner str

ID of the AWS account that owns the bucket the export will be stored in.

s3_prefix str

Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

s3_sse_algorithm str

Type of encryption used on the bucket where export data will be stored. Valid values are: AES256, KMS.

s3_sse_kms_key_id str

ID of the AWS KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).

s3Bucket String

Name of the Amazon S3 bucket to export the snapshot to. See the AWS Documentation for information on how configure this S3 bucket.

tableArn String

ARN associated with the table to export.

The following arguments are optional:

exportFormat String

Format for the exported data. Valid values are: DYNAMODB_JSON, ION. See the AWS Documentation for more information on these export formats. Default is DYNAMODB_JSON.

exportTime String

exportType String

incrementalExportSpecification Property Map

s3BucketOwner String

ID of the AWS account that owns the bucket the export will be stored in.

s3Prefix String

Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

s3SseAlgorithm String

Type of encryption used on the bucket where export data will be stored. Valid values are: AES256, KMS.

s3SseKmsKeyId String

ID of the AWS KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).

Outputs

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

Arn string: ARN of the Table Export.
BilledSizeInBytes int: Billable size of the table export.
EndTime string: Time at which the export task completed.
ExportStatus string: Status of the export - export can be in one of the following states IN_PROGRESS, COMPLETED, or FAILED.
Id string: The provider-assigned unique ID for this managed resource.
ItemCount int: Number of items exported.
ManifestFilesS3Key string: Name of the manifest file for the export task. See the AWS Documentation for more information on this manifest file.
StartTime string: Time at which the export task began.

Arn string: ARN of the Table Export.
BilledSizeInBytes int: Billable size of the table export.
EndTime string: Time at which the export task completed.
ExportStatus string: Status of the export - export can be in one of the following states IN_PROGRESS, COMPLETED, or FAILED.
Id string: The provider-assigned unique ID for this managed resource.
ItemCount int: Number of items exported.
ManifestFilesS3Key string: Name of the manifest file for the export task. See the AWS Documentation for more information on this manifest file.
StartTime string: Time at which the export task began.

arn String: ARN of the Table Export.
billedSizeInBytes Integer: Billable size of the table export.
endTime String: Time at which the export task completed.
exportStatus String: Status of the export - export can be in one of the following states IN_PROGRESS, COMPLETED, or FAILED.
id String: The provider-assigned unique ID for this managed resource.
itemCount Integer: Number of items exported.
manifestFilesS3Key String: Name of the manifest file for the export task. See the AWS Documentation for more information on this manifest file.
startTime String: Time at which the export task began.

arn string: ARN of the Table Export.
billedSizeInBytes number: Billable size of the table export.
endTime string: Time at which the export task completed.
exportStatus string: Status of the export - export can be in one of the following states IN_PROGRESS, COMPLETED, or FAILED.
id string: The provider-assigned unique ID for this managed resource.
itemCount number: Number of items exported.
manifestFilesS3Key string: Name of the manifest file for the export task. See the AWS Documentation for more information on this manifest file.
startTime string: Time at which the export task began.

arn str: ARN of the Table Export.
billed_size_in_bytes int: Billable size of the table export.
end_time str: Time at which the export task completed.
export_status str: Status of the export - export can be in one of the following states IN_PROGRESS, COMPLETED, or FAILED.
id str: The provider-assigned unique ID for this managed resource.
item_count int: Number of items exported.
manifest_files_s3_key str: Name of the manifest file for the export task. See the AWS Documentation for more information on this manifest file.
start_time str: Time at which the export task began.

arn String: ARN of the Table Export.
billedSizeInBytes Number: Billable size of the table export.
endTime String: Time at which the export task completed.
exportStatus String: Status of the export - export can be in one of the following states IN_PROGRESS, COMPLETED, or FAILED.
id String: The provider-assigned unique ID for this managed resource.
itemCount Number: Number of items exported.
manifestFilesS3Key String: Name of the manifest file for the export task. See the AWS Documentation for more information on this manifest file.
startTime String: Time at which the export task began.

Look up Existing TableExport Resource

Get an existing TableExport resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: TableExportState, opts?: CustomResourceOptions): TableExport

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        billed_size_in_bytes: Optional[int] = None,
        end_time: Optional[str] = None,
        export_format: Optional[str] = None,
        export_status: Optional[str] = None,
        export_time: Optional[str] = None,
        export_type: Optional[str] = None,
        incremental_export_specification: Optional[TableExportIncrementalExportSpecificationArgs] = None,
        item_count: Optional[int] = None,
        manifest_files_s3_key: Optional[str] = None,
        s3_bucket: Optional[str] = None,
        s3_bucket_owner: Optional[str] = None,
        s3_prefix: Optional[str] = None,
        s3_sse_algorithm: Optional[str] = None,
        s3_sse_kms_key_id: Optional[str] = None,
        start_time: Optional[str] = None,
        table_arn: Optional[str] = None) -> TableExport

func GetTableExport(ctx *Context, name string, id IDInput, state *TableExportState, opts ...ResourceOption) (*TableExport, error)

public static TableExport Get(string name, Input<string> id, TableExportState? state, CustomResourceOptions? opts = null)

public static TableExport get(String name, Output<String> id, TableExportState state, CustomResourceOptions options)

resources:  _:    type: aws:dynamodb:TableExport    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Arn string

ARN of the Table Export.

BilledSizeInBytes int

Billable size of the table export.

EndTime string

Time at which the export task completed.

ExportFormat string

Format for the exported data. Valid values are: DYNAMODB_JSON, ION. See the AWS Documentation for more information on these export formats. Default is DYNAMODB_JSON.

ExportStatus string

Status of the export - export can be in one of the following states IN_PROGRESS, COMPLETED, or FAILED.

ExportTime string

ExportType string

IncrementalExportSpecification TableExportIncrementalExportSpecification

ItemCount int

Number of items exported.

ManifestFilesS3Key string

Name of the manifest file for the export task. See the AWS Documentation for more information on this manifest file.

S3Bucket string

Name of the Amazon S3 bucket to export the snapshot to. See the AWS Documentation for information on how configure this S3 bucket.

S3BucketOwner string

ID of the AWS account that owns the bucket the export will be stored in.

S3Prefix string

Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

S3SseAlgorithm string

Type of encryption used on the bucket where export data will be stored. Valid values are: AES256, KMS.

S3SseKmsKeyId string

ID of the AWS KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).

StartTime string

Time at which the export task began.

TableArn string

ARN associated with the table to export.

The following arguments are optional:

Arn string

ARN of the Table Export.

BilledSizeInBytes int

Billable size of the table export.

EndTime string

Time at which the export task completed.

ExportFormat string

Format for the exported data. Valid values are: DYNAMODB_JSON, ION. See the AWS Documentation for more information on these export formats. Default is DYNAMODB_JSON.

ExportStatus string

Status of the export - export can be in one of the following states IN_PROGRESS, COMPLETED, or FAILED.

ExportTime string

ExportType string

IncrementalExportSpecification TableExportIncrementalExportSpecificationArgs

ItemCount int

Number of items exported.

ManifestFilesS3Key string

Name of the manifest file for the export task. See the AWS Documentation for more information on this manifest file.

S3Bucket string

Name of the Amazon S3 bucket to export the snapshot to. See the AWS Documentation for information on how configure this S3 bucket.

S3BucketOwner string

ID of the AWS account that owns the bucket the export will be stored in.

S3Prefix string

Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

S3SseAlgorithm string

Type of encryption used on the bucket where export data will be stored. Valid values are: AES256, KMS.

S3SseKmsKeyId string

ID of the AWS KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).

StartTime string

Time at which the export task began.

TableArn string

ARN associated with the table to export.

The following arguments are optional:

arn String

ARN of the Table Export.

billedSizeInBytes Integer

Billable size of the table export.

endTime String

Time at which the export task completed.

exportFormat String

Format for the exported data. Valid values are: DYNAMODB_JSON, ION. See the AWS Documentation for more information on these export formats. Default is DYNAMODB_JSON.

exportStatus String

Status of the export - export can be in one of the following states IN_PROGRESS, COMPLETED, or FAILED.

exportTime String

exportType String

incrementalExportSpecification TableExportIncrementalExportSpecification

itemCount Integer

Number of items exported.

manifestFilesS3Key String

Name of the manifest file for the export task. See the AWS Documentation for more information on this manifest file.

s3Bucket String

Name of the Amazon S3 bucket to export the snapshot to. See the AWS Documentation for information on how configure this S3 bucket.

s3BucketOwner String

ID of the AWS account that owns the bucket the export will be stored in.

s3Prefix String

Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

s3SseAlgorithm String

Type of encryption used on the bucket where export data will be stored. Valid values are: AES256, KMS.

s3SseKmsKeyId String

ID of the AWS KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).

startTime String

Time at which the export task began.

tableArn String

ARN associated with the table to export.

The following arguments are optional:

arn string

ARN of the Table Export.

billedSizeInBytes number

Billable size of the table export.

endTime string

Time at which the export task completed.

exportFormat string

Format for the exported data. Valid values are: DYNAMODB_JSON, ION. See the AWS Documentation for more information on these export formats. Default is DYNAMODB_JSON.

exportStatus string

Status of the export - export can be in one of the following states IN_PROGRESS, COMPLETED, or FAILED.

exportTime string

exportType string

incrementalExportSpecification TableExportIncrementalExportSpecification

itemCount number

Number of items exported.

manifestFilesS3Key string

Name of the manifest file for the export task. See the AWS Documentation for more information on this manifest file.

s3Bucket string

Name of the Amazon S3 bucket to export the snapshot to. See the AWS Documentation for information on how configure this S3 bucket.

s3BucketOwner string

ID of the AWS account that owns the bucket the export will be stored in.

s3Prefix string

Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

s3SseAlgorithm string

Type of encryption used on the bucket where export data will be stored. Valid values are: AES256, KMS.

s3SseKmsKeyId string

ID of the AWS KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).

startTime string

Time at which the export task began.

tableArn string

ARN associated with the table to export.

The following arguments are optional:

arn str

ARN of the Table Export.

billed_size_in_bytes int

Billable size of the table export.

end_time str

Time at which the export task completed.

export_format str

Format for the exported data. Valid values are: DYNAMODB_JSON, ION. See the AWS Documentation for more information on these export formats. Default is DYNAMODB_JSON.

export_status str

Status of the export - export can be in one of the following states IN_PROGRESS, COMPLETED, or FAILED.

export_time str

export_type str

incremental_export_specification TableExportIncrementalExportSpecificationArgs

item_count int

Number of items exported.

manifest_files_s3_key str

Name of the manifest file for the export task. See the AWS Documentation for more information on this manifest file.

s3_bucket str

Name of the Amazon S3 bucket to export the snapshot to. See the AWS Documentation for information on how configure this S3 bucket.

s3_bucket_owner str

ID of the AWS account that owns the bucket the export will be stored in.

s3_prefix str

Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

s3_sse_algorithm str

Type of encryption used on the bucket where export data will be stored. Valid values are: AES256, KMS.

s3_sse_kms_key_id str

ID of the AWS KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).

start_time str

Time at which the export task began.

table_arn str

ARN associated with the table to export.

The following arguments are optional:

arn String

ARN of the Table Export.

billedSizeInBytes Number

Billable size of the table export.

endTime String

Time at which the export task completed.

exportFormat String

Format for the exported data. Valid values are: DYNAMODB_JSON, ION. See the AWS Documentation for more information on these export formats. Default is DYNAMODB_JSON.

exportStatus String

Status of the export - export can be in one of the following states IN_PROGRESS, COMPLETED, or FAILED.

exportTime String

exportType String

incrementalExportSpecification Property Map

itemCount Number

Number of items exported.

manifestFilesS3Key String

Name of the manifest file for the export task. See the AWS Documentation for more information on this manifest file.

s3Bucket String

Name of the Amazon S3 bucket to export the snapshot to. See the AWS Documentation for information on how configure this S3 bucket.

s3BucketOwner String

ID of the AWS account that owns the bucket the export will be stored in.

s3Prefix String

Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

s3SseAlgorithm String

Type of encryption used on the bucket where export data will be stored. Valid values are: AES256, KMS.

s3SseKmsKeyId String

ID of the AWS KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).

startTime String

Time at which the export task began.

tableArn String

ARN associated with the table to export.

The following arguments are optional:

Supporting Types

TableExportIncrementalExportSpecification, TableExportIncrementalExportSpecificationArgs

ExportFromTime string
ExportToTime string
ExportViewType string

ExportFromTime string
ExportToTime string
ExportViewType string

exportFromTime String
exportToTime String
exportViewType String

exportFromTime string
exportToTime string
exportViewType string

export_from_time str
export_to_time str
export_view_type str

exportFromTime String
exportToTime String
exportViewType String

Import

Using pulumi import, import DynamoDB table exports using the arn. For example:

$ pulumi import aws:dynamodb/tableExport:TableExport example arn:aws:dynamodb:us-west-2:12345678911:table/my-table-1/export/01580735656614-2c2f422e

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi

pulumi/pulumi-aws

aws.dynamodb.TableExport

On this page

On this page

Example Usage

Basic Usage

Example with export time

Incremental export

Create TableExport Resource

Constructor syntax

Parameters

Constructor example

TableExport Resource Properties

Inputs

Outputs

Look up Existing TableExport Resource

Supporting Types

TableExportIncrementalExportSpecification, TableExportIncrementalExportSpecificationArgs

Import

Package Details

On this page

On this page