Class: MintPress::Aws::RDS::DbSnapshot

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

Properties (Read/Write)

  • #db_snapshot_identifier ⇒ [String]
    'The identifier of the DB snapshot to modify.'
    Property Attributes
    • create_db_snapshot_prop ⇒ 'db_snapshot_identifier'
    • read_only ⇒ false
    • source ⇒ "modify_db_snapshot"
    • delete_db_snapshot_prop ⇒ 'db_snapshot_identifier'
    • describe_db_snapshots_prop ⇒ 'db_snapshot_identifier'
    • modify_db_snapshot_prop ⇒ 'db_snapshot_identifier'
    

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

property :db_snapshot_identifier, create_db_snapshot_prop: 'db_snapshot_identifier', type: [String], read_only: false, source: "modify_db_snapshot", description: 'The identifier of the DB snapshot to modify.', delete_db_snapshot_prop: 'db_snapshot_identifier', describe_db_snapshots_prop: 'db_snapshot_identifier', modify_db_snapshot_prop: 'db_snapshot_identifier'
  • #db_instance_identifier ⇒ [String]
    'The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can"t be used in conjunction with DBSnapshotIdentifier. This parameter isn"t case-sensitive. Constraints: If supplied, must match the identifier of an existing DBInstance. ^'
    Property Attributes
    • create_db_snapshot_prop ⇒ 'db_instance_identifier'
    • read_only ⇒ false
    • source ⇒ "describe_db_snapshots"
    • describe_db_snapshots_prop ⇒ 'db_instance_identifier'
    

26
27
28
29
30
31
32
33
34
35
36
37
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_snapshot.rb', line 26

property :db_instance_identifier, create_db_snapshot_prop: 'db_instance_identifier', type: [String], read_only: false, source: "describe_db_snapshots", description: 'The ID of the DB instance to retrieve the list of DB snapshots for.
This parameter can"t be used in conjunction with
DBSnapshotIdentifier. This parameter isn"t case-sensitive.

Constraints:


If supplied, must match the identifier of an existing DBInstance.



^', describe_db_snapshots_prop: 'db_instance_identifier'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::RDS::Tag]
    'A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.'
    Property Attributes
    • create_db_snapshot_prop ⇒ 'tags'
    • read_only ⇒ false
    • source ⇒ "create_db_snapshot"
    

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

property :tags, create_db_snapshot_prop: 'tags', type: [MintPress::Aws::RDS::Tag], array: false, read_only: false, source: "create_db_snapshot", description: 'A list of tags. For more information, see Tagging Amazon RDS
Resources in the Amazon RDS User Guide.', hash: true
  • #snapshot_type ⇒ [String]
    'The type of snapshots to be returned. You can specify one of the following values: automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account. manual - Return all DB snapshots that have been taken by my AWS account. shared - Return all manual DB snapshots that have been shared to my AWS account. public - Return all DB snapshots that have been marked as public. awsbackup - Return the DB snapshots managed by the AWS Backup service. For information about AWS Backup, see the AWS Backup Developer Guide. The awsbackup type does not apply to Aurora. If you don"t specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter. The IncludeShared and IncludePublic parameters don"t apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn"t apply when SnapshotType is set to shared. The IncludeShared parameter doesn"t apply when SnapshotType is set to public.'
    Property Attributes
    • describe_db_snapshots_prop ⇒ 'snapshot_type'
    • source ⇒ "describe_db_snapshots"
    

40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_snapshot.rb', line 40

property :snapshot_type, describe_db_snapshots_prop: 'snapshot_type', type: [String], source: "describe_db_snapshots", description: 'The type of snapshots to be returned. You can specify one of the
following values:


automated - Return all DB snapshots that have been automatically
taken by Amazon RDS for my AWS account.
manual - Return all DB snapshots that have been taken by my AWS
account.
shared - Return all manual DB snapshots that have been shared to
my AWS account.
public - Return all DB snapshots that have been marked as public.
awsbackup - Return the DB snapshots managed by the AWS Backup
service.

For information about AWS Backup, see the  AWS Backup Developer
Guide. 

The awsbackup type does not apply to Aurora.



If you don"t specify a SnapshotType value, then both automated and
manual snapshots are returned. Shared and public DB snapshots are not
included in the returned results by default. You can include shared
snapshots with these results by enabling the IncludeShared
parameter. You can include public snapshots with these results by
enabling the IncludePublic parameter.

The IncludeShared and IncludePublic parameters don"t apply for
SnapshotType values of manual or automated. The IncludePublic
parameter doesn"t apply when SnapshotType is set to shared. The
IncludeShared parameter doesn"t apply when SnapshotType is set to
public.'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::RDS::Filter]
    'A filter that specifies one or more DB snapshots to describe. Supported filters: db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). db-snapshot-id - Accepts DB snapshot identifiers. dbi-resource-id - Accepts identifiers of source DB instances. snapshot-type - Accepts types of DB snapshots. engine - Accepts names of database engines.'
    Property Attributes
    • describe_db_snapshots_prop ⇒ 'filters'
    • source ⇒ "describe_db_snapshots"
    

73
74
75
76
77
78
79
80
81
82
83
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_snapshot.rb', line 73

property :filters, describe_db_snapshots_prop: 'filters', type: [MintPress::Aws::RDS::Filter], array: false, source: "describe_db_snapshots", description: 'A filter that specifies one or more DB snapshots to describe.

Supported filters:


db-instance-id - Accepts DB instance identifiers and DB instance
Amazon Resource Names (ARNs).
db-snapshot-id - Accepts DB snapshot identifiers.
dbi-resource-id - Accepts identifiers of source DB instances.
snapshot-type - Accepts types of DB snapshots.
engine - Accepts names of database engines.', 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. Default: 100 Constraints: Minimum 20, maximum 100.'
    Property Attributes
    • describe_db_snapshots_prop ⇒ 'max_records'
    • source ⇒ "describe_db_snapshots"
    

84
85
86
87
88
89
90
91
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_snapshot.rb', line 84

property :max_records, describe_db_snapshots_prop: 'max_records', type: [Integer], source: "describe_db_snapshots", 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.

Default: 100

Constraints: Minimum 20, maximum 100.'
  • #include_shared ⇒ [TrueClass,FalseClass]
    'A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included. You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.'
    Property Attributes
    • describe_db_snapshots_prop ⇒ 'include_shared'
    • source ⇒ "describe_db_snapshots"
    

92
93
94
95
96
97
98
99
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_snapshot.rb', line 92

property :include_shared, describe_db_snapshots_prop: 'include_shared', type: [TrueClass,FalseClass], source: "describe_db_snapshots", description: 'A value that indicates whether to include shared manual DB cluster
snapshots from other AWS accounts that this AWS account has been given
permission to copy or restore. By default, these snapshots are not
included.

You can give an AWS account permission to restore a manual DB snapshot
from another AWS account by using the ModifyDBSnapshotAttribute API
action.'
  • #include_public ⇒ [TrueClass,FalseClass]
    'A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included. You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.'
    Property Attributes
    • describe_db_snapshots_prop ⇒ 'include_public'
    • source ⇒ "describe_db_snapshots"
    

100
101
102
103
104
105
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_snapshot.rb', line 100

property :include_public, describe_db_snapshots_prop: 'include_public', type: [TrueClass,FalseClass], source: "describe_db_snapshots", description: 'A value that indicates whether to include manual DB cluster snapshots
that are public and can be copied or restored by any AWS account. By
default, the public snapshots are not included.

You can share a manual DB snapshot as public by using the
ModifyDBSnapshotAttribute API.'
  • #engine_version ⇒ [String]
    'The engine version to upgrade the DB snapshot to. The following are the database engines and engine versions that are available when you upgrade a DB snapshot. MySQL 5.5.46 (supported for 5.1 DB snapshots) ^ Oracle 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots) 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots) 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots) PostgreSQL For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading the PostgreSQL DB Engine for Amazon RDS.'
    Property Attributes
    • modify_db_snapshot_prop ⇒ 'engine_version'
    • read_only ⇒ false
    • source ⇒ "modify_db_snapshot"
    

106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_snapshot.rb', line 106

property :engine_version, modify_db_snapshot_prop: 'engine_version', type: [String], read_only: false, source: "modify_db_snapshot", description: 'The engine version to upgrade the DB snapshot to.

The following are the database engines and engine versions that are
available when you upgrade a DB snapshot.

MySQL


5.5.46 (supported for 5.1 DB snapshots)



^

Oracle


12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)
11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)
11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)



PostgreSQL

For the list of engine versions that are available for upgrading a DB
snapshot, see  Upgrading the PostgreSQL DB Engine for Amazon RDS.'
  • #option_group_name ⇒ [String] (Default Value: Proc.new { self.name })
    'The option group to identify with the upgraded DB snapshot. You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option group considerations in the Amazon RDS User Guide.'
    Property Attributes
    • modify_db_snapshot_prop ⇒ 'option_group_name'
    • read_only ⇒ false
    • source ⇒ "modify_db_snapshot"
    • default ⇒ Proc.new { self.name }
    

133
134
135
136
137
138
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_snapshot.rb', line 133

property :option_group_name, modify_db_snapshot_prop: 'option_group_name', type: [String], read_only: false, source: "modify_db_snapshot", description: 'The option group to identify with the upgraded DB snapshot.

You can specify this parameter when you upgrade an Oracle DB snapshot.
The same option group considerations apply when upgrading a DB
snapshot as when upgrading a DB instance. For more information, see
Option group considerations in the Amazon RDS User Guide.', default: Proc.new { self.name }
  • #dbi_resource ⇒ [String]
    'A specific DB resource ID to describe.'
    Property Attributes
    • describe_db_snapshots_prop ⇒ 'dbi_resource_id'
    • source ⇒ "describe_db_snapshots"
    

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

property :dbi_resource, describe_db_snapshots_prop: 'dbi_resource_id', type: [String], source: "describe_db_snapshots", description: 'A specific DB resource ID to describe.'
  • #name ⇒ [String]

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of DbSnapshot.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#modify ⇒ Object