Class: Aws::DynamoDB::Types::ExportTableToPointInTimeInput

Inherits:

Struct

• Object
• Struct
• Aws::DynamoDB::Types::ExportTableToPointInTimeInput

Includes:

Structure

Defined in:

lib/aws-sdk-dynamodb/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  Providing a ‘ClientToken` makes the call to `ExportTableToPointInTimeInput` idempotent, meaning that multiple identical calls have the same effect as one single call.

• #export_format ⇒ String

  The format for the exported data.

• #export_time ⇒ Time

  Time in the past from which to export table data, counted in seconds from the start of the Unix epoch.

• #export_type ⇒ String

  Choice of whether to execute as a full export or incremental export.

• #incremental_export_specification ⇒ Types::IncrementalExportSpecification

  Optional object containing the parameters specific to an incremental export.

• #s3_bucket ⇒ String

  The name of the Amazon S3 bucket to export the snapshot to.

• #s3_bucket_owner ⇒ String

  The ID of the Amazon Web Services account that owns the bucket the export will be stored in.

• #s3_prefix ⇒ String

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

• #s3_sse_algorithm ⇒ String

  Type of encryption used on the bucket where export data will be stored.

• #s3_sse_kms_key_id ⇒ String

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

• #table_arn ⇒ String

  The Amazon Resource Name (ARN) associated with the table to export.

Instance Attribute Details

#client_token ⇒ String

Providing a ‘ClientToken` makes the call to `ExportTableToPointInTimeInput` idempotent, meaning that multiple identical calls have the same effect as one single call.

A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 8 hours, or the result might not be idempotent.

If you submit a request with the same client token but a change in other parameters within the 8-hour idempotency window, DynamoDB returns an ‘ImportConflictException`.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 3787

class ExportTableToPointInTimeInput < Struct.new(
  :table_arn,
  :export_time,
  :client_token,
  :s3_bucket,
  :s3_bucket_owner,
  :s3_prefix,
  :s3_sse_algorithm,
  :s3_sse_kms_key_id,
  :export_format,
  :export_type,
  :incremental_export_specification)
  SENSITIVE = []
  include Aws::Structure
end

#export_format ⇒ String

The format for the exported data. Valid values for ‘ExportFormat` are `DYNAMODB_JSON` or `ION`.

Returns:

• (String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 3787

class ExportTableToPointInTimeInput < Struct.new(
  :table_arn,
  :export_time,
  :client_token,
  :s3_bucket,
  :s3_bucket_owner,
  :s3_prefix,
  :s3_sse_algorithm,
  :s3_sse_kms_key_id,
  :export_format,
  :export_type,
  :incremental_export_specification)
  SENSITIVE = []
  include Aws::Structure
end

#export_time ⇒ Time

Time in the past from which to export table data, counted in seconds from the start of the Unix epoch. The table export will be a snapshot of the table’s state at this point in time.

Returns:

• (Time)

# File 'lib/aws-sdk-dynamodb/types.rb', line 3787

class ExportTableToPointInTimeInput < Struct.new(
  :table_arn,
  :export_time,
  :client_token,
  :s3_bucket,
  :s3_bucket_owner,
  :s3_prefix,
  :s3_sse_algorithm,
  :s3_sse_kms_key_id,
  :export_format,
  :export_type,
  :incremental_export_specification)
  SENSITIVE = []
  include Aws::Structure
end

#export_type ⇒ String

Choice of whether to execute as a full export or incremental export. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be used.

Returns:

• (String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 3787

class ExportTableToPointInTimeInput < Struct.new(
  :table_arn,
  :export_time,
  :client_token,
  :s3_bucket,
  :s3_bucket_owner,
  :s3_prefix,
  :s3_sse_algorithm,
  :s3_sse_kms_key_id,
  :export_format,
  :export_type,
  :incremental_export_specification)
  SENSITIVE = []
  include Aws::Structure
end

#incremental_export_specification ⇒ Types::IncrementalExportSpecification

Optional object containing the parameters specific to an incremental export.

Returns:

• (Types::IncrementalExportSpecification)

# File 'lib/aws-sdk-dynamodb/types.rb', line 3787

class ExportTableToPointInTimeInput < Struct.new(
  :table_arn,
  :export_time,
  :client_token,
  :s3_bucket,
  :s3_bucket_owner,
  :s3_prefix,
  :s3_sse_algorithm,
  :s3_sse_kms_key_id,
  :export_format,
  :export_type,
  :incremental_export_specification)
  SENSITIVE = []
  include Aws::Structure
end

#s3_bucket ⇒ String

The name of the Amazon S3 bucket to export the snapshot to.

Returns:

• (String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 3787

class ExportTableToPointInTimeInput < Struct.new(
  :table_arn,
  :export_time,
  :client_token,
  :s3_bucket,
  :s3_bucket_owner,
  :s3_prefix,
  :s3_sse_algorithm,
  :s3_sse_kms_key_id,
  :export_format,
  :export_type,
  :incremental_export_specification)
  SENSITIVE = []
  include Aws::Structure
end

#s3_bucket_owner ⇒ String

The ID of the Amazon Web Services account that owns the bucket the export will be stored in.

<note markdown=“1”> S3BucketOwner is a required parameter when exporting to a S3 bucket in another account.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 3787

class ExportTableToPointInTimeInput < Struct.new(
  :table_arn,
  :export_time,
  :client_token,
  :s3_bucket,
  :s3_bucket_owner,
  :s3_prefix,
  :s3_sse_algorithm,
  :s3_sse_kms_key_id,
  :export_format,
  :export_type,
  :incremental_export_specification)
  SENSITIVE = []
  include Aws::Structure
end

#s3_prefix ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 3787

class ExportTableToPointInTimeInput < Struct.new(
  :table_arn,
  :export_time,
  :client_token,
  :s3_bucket,
  :s3_bucket_owner,
  :s3_prefix,
  :s3_sse_algorithm,
  :s3_sse_kms_key_id,
  :export_format,
  :export_type,
  :incremental_export_specification)
  SENSITIVE = []
  include Aws::Structure
end

#s3_sse_algorithm ⇒ String

Type of encryption used on the bucket where export data will be stored. Valid values for ‘S3SseAlgorithm` are:

• ‘AES256` - server-side encryption with Amazon S3 managed keys

• ‘KMS` - server-side encryption with KMS managed keys

Returns:

• (String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 3787

class ExportTableToPointInTimeInput < Struct.new(
  :table_arn,
  :export_time,
  :client_token,
  :s3_bucket,
  :s3_bucket_owner,
  :s3_prefix,
  :s3_sse_algorithm,
  :s3_sse_kms_key_id,
  :export_format,
  :export_type,
  :incremental_export_specification)
  SENSITIVE = []
  include Aws::Structure
end

#s3_sse_kms_key_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 3787

class ExportTableToPointInTimeInput < Struct.new(
  :table_arn,
  :export_time,
  :client_token,
  :s3_bucket,
  :s3_bucket_owner,
  :s3_prefix,
  :s3_sse_algorithm,
  :s3_sse_kms_key_id,
  :export_format,
  :export_type,
  :incremental_export_specification)
  SENSITIVE = []
  include Aws::Structure
end

#table_arn ⇒ String

The Amazon Resource Name (ARN) associated with the table to export.

Returns:

• (String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 3787

class ExportTableToPointInTimeInput < Struct.new(
  :table_arn,
  :export_time,
  :client_token,
  :s3_bucket,
  :s3_bucket_owner,
  :s3_prefix,
  :s3_sse_algorithm,
  :s3_sse_kms_key_id,
  :export_format,
  :export_type,
  :incremental_export_specification)
  SENSITIVE = []
  include Aws::Structure
end