Class: Aws::RDS::Types::StartExportTaskMessage

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::StartExportTaskMessage

Defined in:

gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

Note:

When making an API call, you may pass StartExportTaskMessage data as a hash:

{
  export_task_identifier: "String", # required
  source_arn: "String", # required
  s3_bucket_name: "String", # required
  iam_role_arn: "String", # required
  kms_key_id: "String", # required
  s3_prefix: "String",
  export_only: ["String"],
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #export_only ⇒ Array<String>

  The data to be exported from the snapshot.

• #export_task_identifier ⇒ String

  A unique identifier for the snapshot export task.

• #iam_role_arn ⇒ String

  The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot.

• #kms_key_id ⇒ String

  The ID of the AWS KMS key to use to encrypt the snapshot exported to Amazon S3.

• #s3_bucket_name ⇒ String

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

• #s3_prefix ⇒ String

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

• #source_arn ⇒ String

  The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.

Instance Attribute Details

#export_only ⇒ Array<String>

The data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are the following:

• database - Export all the data from a specified database.

• database.table table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

• database.schema schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

• database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19586

class StartExportTaskMessage < Struct.new(
  :export_task_identifier,
  :source_arn,
  :s3_bucket_name,
  :iam_role_arn,
  :kms_key_id,
  :s3_prefix,
  :export_only)
  SENSITIVE = []
  include Aws::Structure
end

#export_task_identifier ⇒ String

A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is to be exported to.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19586

class StartExportTaskMessage < Struct.new(
  :export_task_identifier,
  :source_arn,
  :s3_bucket_name,
  :iam_role_arn,
  :kms_key_id,
  :s3_prefix,
  :export_only)
  SENSITIVE = []
  include Aws::Structure
end

#iam_role_arn ⇒ String

The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19586

class StartExportTaskMessage < Struct.new(
  :export_task_identifier,
  :source_arn,
  :s3_bucket_name,
  :iam_role_arn,
  :kms_key_id,
  :s3_prefix,
  :export_only)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

The ID of the AWS KMS key to use to encrypt the snapshot exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. The caller of this operation must be authorized to execute the following operations. These can be set in the KMS key policy:

• GrantOperation.Encrypt

• GrantOperation.Decrypt

• GrantOperation.GenerateDataKey

• GrantOperation.GenerateDataKeyWithoutPlaintext

• GrantOperation.ReEncryptFrom

• GrantOperation.ReEncryptTo

• GrantOperation.CreateGrant

• GrantOperation.DescribeKey

• GrantOperation.RetireGrant

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19586

class StartExportTaskMessage < Struct.new(
  :export_task_identifier,
  :source_arn,
  :s3_bucket_name,
  :iam_role_arn,
  :kms_key_id,
  :s3_prefix,
  :export_only)
  SENSITIVE = []
  include Aws::Structure
end

#s3_bucket_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19586

class StartExportTaskMessage < Struct.new(
  :export_task_identifier,
  :source_arn,
  :s3_bucket_name,
  :iam_role_arn,
  :kms_key_id,
  :s3_prefix,
  :export_only)
  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 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19586

class StartExportTaskMessage < Struct.new(
  :export_task_identifier,
  :source_arn,
  :s3_bucket_name,
  :iam_role_arn,
  :kms_key_id,
  :s3_prefix,
  :export_only)
  SENSITIVE = []
  include Aws::Structure
end

#source_arn ⇒ String

The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19586

class StartExportTaskMessage < Struct.new(
  :export_task_identifier,
  :source_arn,
  :s3_bucket_name,
  :iam_role_arn,
  :kms_key_id,
  :s3_prefix,
  :export_only)
  SENSITIVE = []
  include Aws::Structure
end