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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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)


3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 3758

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_formatString

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

Returns:

  • (String)


3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 3758

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_timeTime

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)


3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 3758

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_typeString

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)


3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 3758

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_specificationTypes::IncrementalExportSpecification

Optional object containing the parameters specific to an incremental export.



3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 3758

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_bucketString

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

Returns:

  • (String)


3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 3758

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_ownerString

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

S3BucketOwner is a required parameter when exporting to a S3 bucket in another account.

Returns:

  • (String)


3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 3758

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_prefixString

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

Returns:

  • (String)


3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 3758

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_algorithmString

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)


3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 3758

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_idString

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

Returns:

  • (String)


3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 3758

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_arnString

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

Returns:

  • (String)


3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 3758

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