Class: MintPress::Aws::RDS::ExportTask

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/export_task.rb

Properties (Read/Write)

  • #export_only ⇒ Array of ⇒ [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.'
    Property Attributes
    • source ⇒ "start_export_task"
    • orig_name ⇒ 'export_only'
    • start_export_task_prop ⇒ 'export_only'
    • read_only ⇒ false
    

20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/export_task.rb', line 20

property :export_only, description: '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.', source: "start_export_task", orig_name: 'export_only', type: [String], array: true, start_export_task_prop: 'export_only', read_only: false
  • #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.'
    Property Attributes
    • source ⇒ "start_export_task"
    • orig_name ⇒ 'export_task_identifier'
    • describe_export_tasks_prop ⇒ 'export_task_identifier'
    • start_export_task_prop ⇒ 'export_task_identifier'
    • read_only ⇒ false
    

35
36
37
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/export_task.rb', line 35

property :export_task_identifier, description: '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.', source: "start_export_task", orig_name: 'export_task_identifier', type: [String], describe_export_tasks_prop: 'export_task_identifier', start_export_task_prop: 'export_task_identifier', read_only: false
  • #failure_cause ⇒ [String]
    'The reason the export failed, if it failed.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "Types::ExportTask"
    • orig_name ⇒ 'failure_cause'
    

38
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/export_task.rb', line 38

property :failure_cause, disposition: :attribute, description: 'The reason the export failed, if it failed.', source: "Types::ExportTask", orig_name: 'failure_cause', type: [String]
  • #iam_role_arn ⇒ [String]
    'The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot.'
    Property Attributes
    • source ⇒ "start_export_task"
    • orig_name ⇒ 'iam_role_arn'
    • start_export_task_prop ⇒ 'iam_role_arn'
    • read_only ⇒ false
    

39
40
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/export_task.rb', line 39

property :iam_role_arn, description: 'The name of the IAM role to use for writing to the Amazon S3 bucket
when exporting a snapshot.', source: "start_export_task", orig_name: 'iam_role_arn', type: [String], start_export_task_prop: 'iam_role_arn', read_only: false
  • #percent_progress ⇒ [Integer]
    'The progress of the snapshot export task as a percentage.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "Types::ExportTask"
    • orig_name ⇒ 'percent_progress'
    

41
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/export_task.rb', line 41

property :percent_progress, disposition: :attribute, description: 'The progress of the snapshot export task as a percentage.', source: "Types::ExportTask", orig_name: 'percent_progress', type: [Integer]
  • #s3_bucket ⇒ [String]
    'The Amazon S3 bucket that the snapshot is exported to.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "Types::ExportTask"
    • orig_name ⇒ 's3_bucket'
    

42
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/export_task.rb', line 42

property :s3_bucket, disposition: :attribute, description: 'The Amazon S3 bucket that the snapshot is exported to.', source: "Types::ExportTask", orig_name: 's3_bucket', type: [String]
  • #s3_prefix ⇒ [String]
    'The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.'
    Property Attributes
    • source ⇒ "start_export_task"
    • orig_name ⇒ 's3_prefix'
    • start_export_task_prop ⇒ 's3_prefix'
    • read_only ⇒ false
    

43
44
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/export_task.rb', line 43

property :s3_prefix, description: 'The Amazon S3 bucket prefix to use as the file name and path of the
exported snapshot.', source: "start_export_task", orig_name: 's3_prefix', type: [String], start_export_task_prop: 's3_prefix', read_only: false
  • #snapshot_time ⇒ [Time]
    'The time that the snapshot was created.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "Types::ExportTask"
    • orig_name ⇒ 'snapshot_time'
    

45
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/export_task.rb', line 45

property :snapshot_time, disposition: :attribute, description: 'The time that the snapshot was created.', source: "Types::ExportTask", orig_name: 'snapshot_time', type: [Time]
  • #source_arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.'
    Property Attributes
    • source ⇒ "start_export_task"
    • orig_name ⇒ 'source_arn'
    • describe_export_tasks_prop ⇒ 'source_arn'
    • start_export_task_prop ⇒ 'source_arn'
    • read_only ⇒ false
    

46
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/export_task.rb', line 46

property :source_arn, description: 'The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.', source: "start_export_task", orig_name: 'source_arn', type: [String], describe_export_tasks_prop: 'source_arn', start_export_task_prop: 'source_arn', read_only: false
  • #status ⇒ [String]
    'The progress status of the export task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "Types::ExportTask"
    • orig_name ⇒ 'status'
    

47
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/export_task.rb', line 47

property :status, disposition: :attribute, description: 'The progress status of the export task.', source: "Types::ExportTask", orig_name: 'status', type: [String]
  • #task_end_time ⇒ [Time]
    'The time that the snapshot export task completed.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "Types::ExportTask"
    • orig_name ⇒ 'task_end_time'
    

48
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/export_task.rb', line 48

property :task_end_time, disposition: :attribute, description: 'The time that the snapshot export task completed.', source: "Types::ExportTask", orig_name: 'task_end_time', type: [Time]
  • #task_start_time ⇒ [Time]
    'The time that the snapshot export task started.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "Types::ExportTask"
    • orig_name ⇒ 'task_start_time'
    

49
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/export_task.rb', line 49

property :task_start_time, disposition: :attribute, description: 'The time that the snapshot export task started.', source: "Types::ExportTask", orig_name: 'task_start_time', type: [Time]
  • #total_extracted_data_in_gb ⇒ [Integer]
    'The total amount of data exported, in gigabytes.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "Types::ExportTask"
    • orig_name ⇒ 'total_extracted_data_in_gb'
    

50
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/export_task.rb', line 50

property :total_extracted_data_in_gb, disposition: :attribute, description: 'The total amount of data exported, in gigabytes.', source: "Types::ExportTask", orig_name: 'total_extracted_data_in_gb', type: [Integer]
  • #warning_message ⇒ [String]
    'A warning about the snapshot export task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "Types::ExportTask"
    • orig_name ⇒ 'warning_message'
    

51
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/export_task.rb', line 51

property :warning_message, disposition: :attribute, description: 'A warning about the snapshot export task.', source: "Types::ExportTask", orig_name: 'warning_message', type: [String]
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::RDS::Filter]
    'Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive. Supported filters include the following: export-task-identifier - An identifier for the snapshot export task. s3-bucket - The Amazon S3 bucket the snapshot is exported to. source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3 status - The status of the export task. Must be lowercase, for example, complete.'
    Property Attributes
    • describe_export_tasks_prop ⇒ 'filters'
    • source ⇒ "describe_export_tasks"
    

52
53
54
55
56
57
58
59
60
61
62
63
64
65
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/export_task.rb', line 52

property :filters, describe_export_tasks_prop: 'filters', type: [MintPress::Aws::RDS::Filter], array: false, source: "describe_export_tasks", description: 'Filters specify one or more snapshot exports to describe. The filters
are specified as name-value pairs that define what to include in the
output. Filter names and values are case-sensitive.

Supported filters include the following:


export-task-identifier - An identifier for the snapshot export
task.
s3-bucket - The Amazon S3 bucket the snapshot is exported to.
source-arn - The Amazon Resource Name (ARN) of the snapshot
exported to Amazon S3
status - The status of the export task. Must be lowercase, for
example, complete.', hash: true
  • #max_records ⇒ [Integer]
    'The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.'
    Property Attributes
    • describe_export_tasks_prop ⇒ 'max_records'
    • source ⇒ "describe_export_tasks"
    

66
67
68
69
70
71
72
73
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/export_task.rb', line 66

property :max_records, describe_export_tasks_prop: 'max_records', type: [Integer], source: "describe_export_tasks", description: 'The maximum number of records to include in the response. If more
records exist than the specified value, a pagination token called a
marker is included in the response. You can use the marker in a later
DescribeExportTasks request to retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.'
  • #s3_bucket_name ⇒ [String] (Default Value: Proc.new { self.name })
    'The name of the Amazon S3 bucket to export the snapshot to.'
    Property Attributes
    • start_export_task_prop ⇒ 's3_bucket_name'
    • read_only ⇒ false
    • source ⇒ "start_export_task"
    • default ⇒ Proc.new { self.name }
    

74
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/export_task.rb', line 74

property :s3_bucket_name, start_export_task_prop: 's3_bucket_name', type: [String], read_only: false, source: "start_export_task", description: 'The name of the Amazon S3 bucket to export the snapshot to.', default: Proc.new { self.name }
  • #kms_key ⇒ [String]
    'The ID of the AWS KMS customer master key (CMK) to use to encrypt the snapshot exported to Amazon S3. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). The caller of this operation must be authorized to execute the following operations. These can be set in the AWS KMS key policy: GrantOperation.Encrypt GrantOperation.Decrypt GrantOperation.GenerateDataKey GrantOperation.GenerateDataKeyWithoutPlaintext GrantOperation.ReEncryptFrom GrantOperation.ReEncryptTo GrantOperation.CreateGrant GrantOperation.DescribeKey GrantOperation.RetireGrant'
    Property Attributes
    • source ⇒ "start_export_task"
    • orig_name ⇒ 'kms_key_id'
    • start_export_task_prop ⇒ 'kms_key_id'
    • read_only ⇒ false
    

75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/export_task.rb', line 75

property :kms_key, description: 'The ID of the AWS KMS customer master key (CMK) to use to encrypt the
snapshot exported to Amazon S3. The AWS KMS key identifier is the key
ARN, key ID, alias ARN, or alias name for the AWS KMS customer master
key (CMK). The caller of this operation must be authorized to execute
the following operations. These can be set in the AWS KMS key policy:


GrantOperation.Encrypt
GrantOperation.Decrypt
GrantOperation.GenerateDataKey
GrantOperation.GenerateDataKeyWithoutPlaintext
GrantOperation.ReEncryptFrom
GrantOperation.ReEncryptTo
GrantOperation.CreateGrant
GrantOperation.DescribeKey
GrantOperation.RetireGrant', source: "start_export_task", orig_name: 'kms_key_id', type: [String], start_export_task_prop: 'kms_key_id', read_only: false
  • #name ⇒ [String]

    Property Attributes 
    

91
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/export_task.rb', line 91

property :name, type: [String]
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

95
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/export_task.rb', line 95

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

98
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/export_task.rb', line 98

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ ExportTask

Returns a new instance of ExportTask.

Instance Method Details

#describe ⇒ Object

#start ⇒ Object