Class: MintPress::Aws::RDS::DbInstanceAutomatedBackup

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

Properties (Read/Write)

  • #db_instance_automated_backups_arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.'
    Property Attributes
    • delete_db_instance_automated_backup_prop ⇒ 'db_instance_automated_backups_arn'
    • read_only ⇒ false
    • source ⇒ "describe_db_instance_automated_backups"
    • describe_db_instance_automated_backups_prop ⇒ 'db_instance_automated_backups_arn'
    

20
21
22
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_automated_backup.rb', line 20

property :db_instance_automated_backups_arn, delete_db_instance_automated_backup_prop: 'db_instance_automated_backups_arn', type: [String], read_only: false, source: "describe_db_instance_automated_backups", description: 'The Amazon Resource Name (ARN) of the replicated automated backups,
for example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.', describe_db_instance_automated_backups_prop: 'db_instance_automated_backups_arn'
  • #db_instance_identifier ⇒ [String]
    'The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance" automated backup. This parameter isn"t case-sensitive.'
    Property Attributes
    • describe_db_instance_automated_backups_prop ⇒ 'db_instance_identifier'
    • source ⇒ "describe_db_instance_automated_backups"
    

23
24
25
26
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_automated_backup.rb', line 23

property :db_instance_identifier, describe_db_instance_automated_backups_prop: 'db_instance_identifier', type: [String], source: "describe_db_instance_automated_backups", description: 'The user-supplied instance identifier. If this parameter is
specified, it must match the identifier of an existing DB instance. It
returns information from the specific DB instance" automated backup.
This parameter isn"t case-sensitive.'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::RDS::Filter]
    'A filter that specifies which resources to return based on status. Supported filters are the following: status active - automated backups for current instances retained - automated backups for deleted instances and after backup replication is stopped creating - automated backups that are waiting for the first automated snapshot to be available db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs. dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs. Returns all resources by default. The status for each resource is specified in the response.'
    Property Attributes
    • describe_db_instance_automated_backups_prop ⇒ 'filters'
    • source ⇒ "describe_db_instance_automated_backups"
    

27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_automated_backup.rb', line 27

property :filters, describe_db_instance_automated_backups_prop: 'filters', type: [MintPress::Aws::RDS::Filter], array: false, source: "describe_db_instance_automated_backups", description: 'A filter that specifies which resources to return based on status.

Supported filters are the following:


status


active - automated backups for current instances
retained - automated backups for deleted instances and after
backup replication is stopped
creating - automated backups that are waiting for the first
automated snapshot to be available


db-instance-id - Accepts DB instance identifiers and Amazon
Resource Names (ARNs). The results list includes only information
about the DB instance automated backups identified by these ARNs.
dbi-resource-id - Accepts DB resource identifiers and Amazon
Resource Names (ARNs). The results list includes only information
about the DB instance resources identified by these ARNs.



Returns all resources by default. The status for each resource is
specified in the response.', hash: true
  • #max_records ⇒ [Integer]
    'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.'
    Property Attributes
    • describe_db_instance_automated_backups_prop ⇒ 'max_records'
    • source ⇒ "describe_db_instance_automated_backups"
    

53
54
55
56
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_automated_backup.rb', line 53

property :max_records, describe_db_instance_automated_backups_prop: 'max_records', type: [Integer], source: "describe_db_instance_automated_backups", description: 'The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination
token called a marker is included in the response so that you can
retrieve the remaining results.'
  • #dbi_resource ⇒ [String]
    'The resource ID of the DB instance that is the source of the automated backup. This parameter isn"t case-sensitive.'
    Property Attributes
    • delete_db_instance_automated_backup_prop ⇒ 'dbi_resource_id'
    • read_only ⇒ false
    • source ⇒ "describe_db_instance_automated_backups"
    • describe_db_instance_automated_backups_prop ⇒ 'dbi_resource_id'
    

57
58
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_automated_backup.rb', line 57

property :dbi_resource, delete_db_instance_automated_backup_prop: 'dbi_resource_id', type: [String], read_only: false, source: "describe_db_instance_automated_backups", description: 'The resource ID of the DB instance that is the source of the automated
backup. This parameter isn"t case-sensitive.', describe_db_instance_automated_backups_prop: 'dbi_resource_id'
  • #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 
    

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

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
    

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

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 = {}) ⇒ DbInstanceAutomatedBackup

Returns a new instance of DbInstanceAutomatedBackup.

Instance Method Details

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object