class Amazonite::DynamoDB::ExportDescription

Overview

Represents the properties of the exported table.

Included Modules

Defined in:

dynamodb/export_description.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(export_arn : String | Nil = nil, export_status : ExportStatus | Nil = nil, start_time : Time | Nil = nil, end_time : Time | Nil = nil, export_manifest : String | Nil = nil, table_arn : String | Nil = nil, table_id : String | Nil = nil, export_time : Time | Nil = nil, client_token : String | Nil = nil, s3_bucket : String | Nil = nil, s3_bucket_owner : String | Nil = nil, s3_prefix : String | Nil = nil, s3_sse_algorithm : S3SseAlgorithm | Nil = nil, s3_sse_kms_key_id : String | Nil = nil, failure_code : String | Nil = nil, failure_message : String | Nil = nil, export_format : ExportFormat | Nil = nil, billed_size_bytes : Int64 | Nil = nil, item_count : Int64 | Nil = nil, export_type : ExportType | Nil = nil, incremental_export_specification : IncrementalExportSpecification | Nil = nil) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def billed_size_bytes : Int64 | Nil #

The billable size of the table export.


[View source]
def billed_size_bytes=(billed_size_bytes : Int64 | Nil) #

The billable size of the table export.


[View source]
def client_token : String | Nil #

The client token that was provided for the export task. A client token makes calls to ExportTableToPointInTimeInput idempotent, meaning that multiple identical calls have the same effect as one single call.


[View source]
def client_token=(client_token : String | Nil) #

The client token that was provided for the export task. A client token makes calls to ExportTableToPointInTimeInput idempotent, meaning that multiple identical calls have the same effect as one single call.


[View source]
def end_time : Time | Nil #

The time at which the export task completed.


[View source]
def end_time=(end_time : Time | Nil) #

The time at which the export task completed.


[View source]
def export_arn : String | Nil #

The Amazon Resource Name (ARN) of the table export.


[View source]
def export_arn=(export_arn : String | Nil) #

The Amazon Resource Name (ARN) of the table export.


[View source]
def export_format : ExportFormat | Nil #

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


[View source]
def export_format=(export_format : ExportFormat | Nil) #

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


[View source]
def export_manifest : String | Nil #

The name of the manifest file for the export task.


[View source]
def export_manifest=(export_manifest : String | Nil) #

The name of the manifest file for the export task.


[View source]
def export_status : ExportStatus | Nil #

Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.


[View source]
def export_status=(export_status : ExportStatus | Nil) #

Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.


[View source]
def export_time : Time | Nil #

Point in time from which table data was exported.


[View source]
def export_time=(export_time : Time | Nil) #

Point in time from which table data was exported.


[View source]
def export_type : ExportType | Nil #

The type of export that was performed. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT.


[View source]
def export_type=(export_type : ExportType | Nil) #

The type of export that was performed. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT.


[View source]
def failure_code : String | Nil #

Status code for the result of the failed export.


[View source]
def failure_code=(failure_code : String | Nil) #

Status code for the result of the failed export.


[View source]
def failure_message : String | Nil #

Export failure reason description.


[View source]
def failure_message=(failure_message : String | Nil) #

Export failure reason description.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def incremental_export_specification : IncrementalExportSpecification | Nil #

Optional object containing the parameters specific to an incremental export.


[View source]
def incremental_export_specification=(incremental_export_specification : IncrementalExportSpecification | Nil) #

Optional object containing the parameters specific to an incremental export.


[View source]
def item_count : Int64 | Nil #

The number of items exported.


[View source]
def item_count=(item_count : Int64 | Nil) #

The number of items exported.


[View source]
def s3_bucket : String | Nil #

The name of the Amazon S3 bucket containing the export.


[View source]
def s3_bucket=(s3_bucket : String | Nil) #

The name of the Amazon S3 bucket containing the export.


[View source]
def s3_bucket_owner : String | Nil #

The ID of the Amazon Web Services account that owns the bucket containing the export.


[View source]
def s3_bucket_owner=(s3_bucket_owner : String | Nil) #

The ID of the Amazon Web Services account that owns the bucket containing the export.


[View source]
def s3_prefix : String | Nil #

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


[View source]
def s3_prefix=(s3_prefix : String | Nil) #

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


[View source]
def s3_sse_algorithm : S3SseAlgorithm | Nil #

Type of encryption used on the bucket where export data is stored. Valid values for S3SseAlgorithm are:

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

  • KMS - server-side encryption with KMS managed keys


[View source]
def s3_sse_algorithm=(s3_sse_algorithm : S3SseAlgorithm | Nil) #

Type of encryption used on the bucket where export data is stored. Valid values for S3SseAlgorithm are:

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

  • KMS - server-side encryption with KMS managed keys


[View source]
def s3_sse_kms_key_id : String | Nil #

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


[View source]
def s3_sse_kms_key_id=(s3_sse_kms_key_id : String | Nil) #

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


[View source]
def start_time : Time | Nil #

The time at which the export task began.


[View source]
def start_time=(start_time : Time | Nil) #

The time at which the export task began.


[View source]
def table_arn : String | Nil #

The Amazon Resource Name (ARN) of the table that was exported.


[View source]
def table_arn=(table_arn : String | Nil) #

The Amazon Resource Name (ARN) of the table that was exported.


[View source]
def table_id : String | Nil #

Unique ID of the table that was exported.


[View source]
def table_id=(table_id : String | Nil) #

Unique ID of the table that was exported.


[View source]
def validate! : Nil #

[View source]