Class: Ansible::Ruby::Modules::Rds_snapshot_facts

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/amazon/rds_snapshot_facts.rb

Overview

obtain facts about one or more RDS snapshots. These can be for unclustered snapshots or snapshots of clustered DBs (Aurora) Aurora snapshot facts may be obtained if no identifier parameters are passed or if one of the cluster parameters are passed.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#db_cluster_identifier ⇒ Object?

Returns RDS cluster name for which to find snapshots. Mutually exclusive with I(db_snapshot_identifier), I(db_instance_identifier), I(db_cluster_snapshot_identifier).

Returns:

  • (Object, nil) —

    RDS cluster name for which to find snapshots. Mutually exclusive with I(db_snapshot_identifier), I(db_instance_identifier), I(db_cluster_snapshot_identifier)



21
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_snapshot_facts.rb', line 21

attribute :db_cluster_identifier

#db_cluster_snapshot_identifier ⇒ Object?

Returns Name of an RDS cluster snapshot. Mutually exclusive with I(db_instance_identifier), I(db_snapshot_identifier), I(db_cluster_identifier).

Returns:

  • (Object, nil) —

    Name of an RDS cluster snapshot. Mutually exclusive with I(db_instance_identifier), I(db_snapshot_identifier), I(db_cluster_identifier)



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_snapshot_facts.rb', line 24

attribute :db_cluster_snapshot_identifier

#db_instance_identifier ⇒ String?

Returns RDS instance name for which to find snapshots. Mutually exclusive with I(db_snapshot_identifier), I(db_cluster_identifier), I(db_cluster_snapshot_identifier).

Returns:

  • (String, nil) —

    RDS instance name for which to find snapshots. Mutually exclusive with I(db_snapshot_identifier), I(db_cluster_identifier), I(db_cluster_snapshot_identifier)



17
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_snapshot_facts.rb', line 17

attribute :db_instance_identifier

#db_snapshot_identifier ⇒ String?

Returns Name of an RDS (unclustered) snapshot. Mutually exclusive with I(db_instance_identifier), I(db_cluster_identifier), I(db_cluster_snapshot_identifier).

Returns:

  • (String, nil) —

    Name of an RDS (unclustered) snapshot. Mutually exclusive with I(db_instance_identifier), I(db_cluster_identifier), I(db_cluster_snapshot_identifier)



13
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_snapshot_facts.rb', line 13

attribute :db_snapshot_identifier

#snapshot_type ⇒ :automated, ...

Returns Type of snapshot to find. By default both automated and manual snapshots will be returned.

Returns:

  • (:automated, :manual, :shared, :public, nil) —

    Type of snapshot to find. By default both automated and manual snapshots will be returned.



27
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_snapshot_facts.rb', line 27

attribute :snapshot_type