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

Inherits:
Struct
  • Object
show all
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"],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#export_onlyArray<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>)


23489
23490
23491
23492
23493
23494
23495
23496
23497
23498
23499
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 23489

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_identifierString

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)


23489
23490
23491
23492
23493
23494
23495
23496
23497
23498
23499
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 23489

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_arnString

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

Returns:

  • (String)


23489
23490
23491
23492
23493
23494
23495
23496
23497
23498
23499
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 23489

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_idString

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

  • GrantOperation.Encrypt

  • GrantOperation.Decrypt

  • GrantOperation.GenerateDataKey

  • GrantOperation.GenerateDataKeyWithoutPlaintext

  • GrantOperation.ReEncryptFrom

  • GrantOperation.ReEncryptTo

  • GrantOperation.CreateGrant

  • GrantOperation.DescribeKey

  • GrantOperation.RetireGrant

Returns:

  • (String)


23489
23490
23491
23492
23493
23494
23495
23496
23497
23498
23499
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 23489

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_nameString

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

Returns:

  • (String)


23489
23490
23491
23492
23493
23494
23495
23496
23497
23498
23499
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 23489

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_prefixString

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

Returns:

  • (String)


23489
23490
23491
23492
23493
23494
23495
23496
23497
23498
23499
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 23489

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_arnString

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

Returns:

  • (String)


23489
23490
23491
23492
23493
23494
23495
23496
23497
23498
23499
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 23489

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