Class: MintPress::Aws::RDS::DbClusterSnapshot

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

Properties (Read/Write)

  • #db_cluster_snapshot_identifier ⇒ [String]
    'A specific DB cluster snapshot identifier to describe. This parameter can"t be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string. Constraints: If supplied, must match the identifier of an existing DBClusterSnapshot. If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.'
    Property Attributes
    • create_db_cluster_snapshot_prop ⇒ 'db_cluster_snapshot_identifier'
    • read_only ⇒ false
    • source ⇒ "describe_db_cluster_snapshots"
    • delete_db_cluster_snapshot_prop ⇒ 'db_cluster_snapshot_identifier'
    • describe_db_cluster_snapshots_prop ⇒ 'db_cluster_snapshot_identifier'
    

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

property :db_cluster_snapshot_identifier, create_db_cluster_snapshot_prop: 'db_cluster_snapshot_identifier', type: [String], read_only: false, source: "describe_db_cluster_snapshots", description: 'A specific DB cluster snapshot identifier to describe. This parameter
can"t be used in conjunction with the DBClusterIdentifier
parameter. This value is stored as a lowercase string.

Constraints:


If supplied, must match the identifier of an existing
DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType
parameter must also be specified.', delete_db_cluster_snapshot_prop: 'db_cluster_snapshot_identifier', describe_db_cluster_snapshots_prop: 'db_cluster_snapshot_identifier'
  • #db_cluster_identifier ⇒ [String]
    'The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can"t be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn"t case-sensitive. Constraints: If supplied, must match the identifier of an existing DBCluster. ^'
    Property Attributes
    • create_db_cluster_snapshot_prop ⇒ 'db_cluster_identifier'
    • read_only ⇒ false
    • source ⇒ "describe_db_cluster_snapshots"
    • describe_db_cluster_snapshots_prop ⇒ 'db_cluster_identifier'
    

34
35
36
37
38
39
40
41
42
43
44
45
46
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster_snapshot.rb', line 34

property :db_cluster_identifier, create_db_cluster_snapshot_prop: 'db_cluster_identifier', type: [String], read_only: false, source: "describe_db_cluster_snapshots", description: 'The ID of the DB cluster to retrieve the list of DB cluster snapshots
for. This parameter can"t be used in conjunction with the
DBClusterSnapshotIdentifier parameter. This parameter isn"t
case-sensitive.

Constraints:


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



^', describe_db_cluster_snapshots_prop: 'db_cluster_identifier'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::RDS::Tag]
    'The tags to be assigned to the DB cluster snapshot.'
    Property Attributes
    • create_db_cluster_snapshot_prop ⇒ 'tags'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster_snapshot"
    

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

property :tags, create_db_cluster_snapshot_prop: 'tags', type: [MintPress::Aws::RDS::Tag], array: false, read_only: false, source: "create_db_cluster_snapshot", description: 'The tags to be assigned to the DB cluster snapshot.', hash: true
  • #snapshot_type ⇒ [String]
    'The type of DB cluster snapshots to be returned. You can specify one of the following values: automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account. manual - Return all DB cluster snapshots that have been taken by my AWS account. shared - Return all manual DB cluster snapshots that have been shared to my AWS account. public - Return all DB cluster snapshots that have been marked as public. If you don"t specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared parameter. You can include public DB cluster 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_cluster_snapshots_prop ⇒ 'snapshot_type'
    • source ⇒ "describe_db_cluster_snapshots"
    

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
73
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster_snapshot.rb', line 48

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


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



If you don"t specify a SnapshotType value, then both automated and
manual DB cluster snapshots are returned. You can include shared DB
cluster snapshots with these results by enabling the IncludeShared
parameter. You can include public DB cluster 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 cluster snapshots to describe. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers. snapshot-type - Accepts types of DB cluster snapshots. engine - Accepts names of database engines.'
    Property Attributes
    • describe_db_cluster_snapshots_prop ⇒ 'filters'
    • source ⇒ "describe_db_cluster_snapshots"
    

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

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

Supported filters:


db-cluster-id - Accepts DB cluster identifiers and DB cluster
Amazon Resource Names (ARNs).
db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.
snapshot-type - Accepts types of DB cluster 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 you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.'
    Property Attributes
    • describe_db_cluster_snapshots_prop ⇒ 'max_records'
    • source ⇒ "describe_db_cluster_snapshots"
    

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

property :max_records, describe_db_cluster_snapshots_prop: 'max_records', type: [Integer], source: "describe_db_cluster_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 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 cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.'
    Property Attributes
    • describe_db_cluster_snapshots_prop ⇒ 'include_shared'
    • source ⇒ "describe_db_cluster_snapshots"
    

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

property :include_shared, describe_db_cluster_snapshots_prop: 'include_shared', type: [TrueClass,FalseClass], source: "describe_db_cluster_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 cluster
snapshot from another AWS account by the
ModifyDBClusterSnapshotAttribute 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 cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.'
    Property Attributes
    • describe_db_cluster_snapshots_prop ⇒ 'include_public'
    • source ⇒ "describe_db_cluster_snapshots"
    

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

property :include_public, describe_db_cluster_snapshots_prop: 'include_public', type: [TrueClass,FalseClass], source: "describe_db_cluster_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 cluster snapshot as public by using the
ModifyDBClusterSnapshotAttribute API action.'
  • #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 
    

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

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
    

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

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

Returns a new instance of DbClusterSnapshot.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object