Class: Ansible::Ruby::Modules::Rds

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

Overview

Creates, deletes, or modifies rds instances. When creating an instance it can be either a new instance or a read-only replica of an existing instance. This module has a dependency on python-boto >= 2.5. The ‘promote’ command requires boto >= 2.18.0. Certain features such as tags rely on boto.rds2 (boto >= 2.26.0)

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

#apply_immediately ⇒ :yes, ...

Returns Used only when command=modify. If enabled, the modifications will be applied as soon as possible rather than waiting for the next preferred maintenance window.

Returns:

  • (:yes, :no, nil) —

    Used only when command=modify. If enabled, the modifications will be applied as soon as possible rather than waiting for the next preferred maintenance window.



121
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 121

attribute :apply_immediately

#aws_access_key ⇒ Object?

Returns AWS access key. If not set then the value of the AWS_ACCESS_KEY environment variable is used.

Returns:

  • (Object, nil) —

    AWS access key. If not set then the value of the AWS_ACCESS_KEY environment variable is used.



110
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 110

attribute :aws_access_key

#aws_secret_key ⇒ Object?

Returns AWS secret key. If not set then the value of the AWS_SECRET_KEY environment variable is used.

Returns:

  • (Object, nil) —

    AWS secret key. If not set then the value of the AWS_SECRET_KEY environment variable is used.



107
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 107

attribute :aws_secret_key

#backup_retention ⇒ Object?

Returns Number of days backups are retained. Set to 0 to disable backups. Default is 1 day. Valid range: 0-35. Used only when command=create or command=modify.rn.

Returns:

  • (Object, nil) —

    Number of days backups are retained. Set to 0 to disable backups. Default is 1 day. Valid range: 0-35. Used only when command=create or command=modify.rn



92
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 92

attribute :backup_retention

#backup_window ⇒ Object?

Returns Backup window in format of hh24:mi-hh24:mi. If not specified then a random backup window is assigned. Used only when command=create or command=modify.

Returns:

  • (Object, nil) —

    Backup window in format of hh24:mi-hh24:mi. If not specified then a random backup window is assigned. Used only when command=create or command=modify.



89
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 89

attribute :backup_window

#character_set_name ⇒ Object?

Returns Associate the DB instance with a specified character set. Used with command=create.

Returns:

  • (Object, nil) —

    Associate the DB instance with a specified character set. Used with command=create.



133
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 133

attribute :character_set_name

#command ⇒ :create, ...

Returns Specifies the action to take. The ‘reboot’ option is available starting at version 2.0.

Returns:

  • (:create, :replicate, :delete, :facts, :modify, :promote, :snapshot, :reboot, :restore) —

    Specifies the action to take. The ‘reboot’ option is available starting at version 2.0



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 12

attribute :command

#db_engine ⇒ :mariadb, ...

Returns The type of database. Used only when command=create.,mariadb was added in version 2.2.

Returns:

  • (:mariadb, :MySQL, :"oracle-se1", :"oracle-se2", :"oracle-se", :"oracle-ee", :"sqlserver-ee", :"sqlserver-se", :"sqlserver-ex", :"sqlserver-web", :postgres, :aurora, nil) —

    The type of database. Used only when command=create.,mariadb was added in version 2.2



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

attribute :db_engine

#db_name ⇒ Object?

Returns Name of a database to create within the instance. If not specified then no database is created. Used only when command=create.

Returns:

  • (Object, nil) —

    Name of a database to create within the instance. If not specified then no database is created. Used only when command=create.



48
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 48

attribute :db_name

#engine_version ⇒ Object?

Returns Version number of the database engine to use. Used only when command=create. If not specified then the current Amazon RDS default engine version is used.

Returns:

  • (Object, nil) —

    Version number of the database engine to use. Used only when command=create. If not specified then the current Amazon RDS default engine version is used



51
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 51

attribute :engine_version

#force_failover ⇒ :yes, ...

Returns Used only when command=reboot. If enabled, the reboot is done using a MultiAZ failover.

Returns:

  • (:yes, :no, nil) —

    Used only when command=reboot. If enabled, the reboot is done using a MultiAZ failover.



125
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 125

attribute :force_failover

#instance_name ⇒ String?

Returns Database instance identifier. Required except when using command=facts or command=delete on just a snapshot.

Returns:

  • (String, nil) —

    Database instance identifier. Required except when using command=facts or command=delete on just a snapshot



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 16

attribute :instance_name

#instance_type ⇒ String?

Returns The instance type of the database. Must be specified when command=create. Optional when command=replicate, command=modify or command=restore. If not specified then the replica inherits the same instance type as the source instance.

Returns:

  • (String, nil) —

    The instance type of the database. Must be specified when command=create. Optional when command=replicate, command=modify or command=restore. If not specified then the replica inherits the same instance type as the source instance.



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 32

attribute :instance_type

#iops ⇒ Object?

Returns Specifies the number of IOPS for the instance. Used only when command=create or command=modify. Must be an integer greater than 1000.

Returns:

  • (Object, nil) —

    Specifies the number of IOPS for the instance. Used only when command=create or command=modify. Must be an integer greater than 1000.



65
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 65

attribute :iops

#license_model ⇒ :"license-included", ...

Returns The license model for this DB instance. Used only when command=create or command=restore.

Returns:

  • (:"license-included", :"bring-your-own-license", :"general-public-license", :"postgresql-license", nil) —

    The license model for this DB instance. Used only when command=create or command=restore.



57
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 57

attribute :license_model

#maint_window ⇒ Object?

Returns Maintenance window in format of ddd:hh24:mi-ddd:hh24:mi. (Example: Mon:22:00-Mon:23:15) If not specified then a random maintenance window is assigned. Used only when command=create or command=modify.rn.

Returns:

  • (Object, nil) —

    Maintenance window in format of ddd:hh24:mi-ddd:hh24:mi. (Example: Mon:22:00-Mon:23:15) If not specified then a random maintenance window is assigned. Used only when command=create or command=modify.rn



86
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 86

attribute :maint_window

#multi_zone ⇒ Symbol?

Returns Specifies if this is a Multi-availability-zone deployment. Can not be used in conjunction with zone parameter. Used only when command=create or command=modify.

Returns:

  • (Symbol, nil) —

    Specifies if this is a Multi-availability-zone deployment. Can not be used in conjunction with zone parameter. Used only when command=create or command=modify.



61
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 61

attribute :multi_zone

#new_instance_name ⇒ String?

Returns Name to rename an instance to. Used only when command=modify.

Returns:

  • (String, nil) —

    Name to rename an instance to. Used only when command=modify.



129
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 129

attribute :new_instance_name

#option_group ⇒ Object?

Returns The name of the option group to use. If not specified then the default option group is used. Used only when command=create.

Returns:

  • (Object, nil) —

    The name of the option group to use. If not specified then the default option group is used. Used only when command=create.



83
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 83

attribute :option_group

#parameter_group ⇒ Object?

Returns Name of the DB parameter group to associate with this instance. If omitted then the RDS default DBParameterGroup will be used. Used only when command=create or command=modify.

Returns:

  • (Object, nil) —

    Name of the DB parameter group to associate with this instance. If omitted then the RDS default DBParameterGroup will be used. Used only when command=create or command=modify.



54
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 54

attribute :parameter_group

#password ⇒ String?

Returns Password for the master database username. Used only when command=create or command=modify.

Returns:

  • (String, nil) —

    Password for the master database username. Used only when command=create or command=modify.



40
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 40

attribute :password

#port ⇒ Integer?

Returns Port number that the DB instance uses for connections. Used only when command=create or command=replicate.,Prior to 2.0 it always defaults to null and the API would use 3306, it had to be set to other DB default values when not using MySql. Starting at 2.0 it automatically defaults to what is expected for each C(db_engine).

Returns:

  • (Integer, nil) —

    Port number that the DB instance uses for connections. Used only when command=create or command=replicate.,Prior to 2.0 it always defaults to null and the API would use 3306, it had to be set to other DB default values when not using MySql. Starting at 2.0 it automatically defaults to what is expected for each C(db_engine).



75
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 75

attribute :port

#publicly_accessible ⇒ Boolean?

Returns explicitly set whether the resource should be publicly accessible or not. Used with command=create, command=replicate. Requires boto >= 2.26.0.

Returns:

  • (Boolean, nil) —

    explicitly set whether the resource should be publicly accessible or not. Used with command=create, command=replicate. Requires boto >= 2.26.0



136
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 136

attribute :publicly_accessible

#region ⇒ String

Returns The AWS region to use. If not specified then the value of the EC2_REGION environment variable, if any, is used.

Returns:

  • (String) —

    The AWS region to use. If not specified then the value of the EC2_REGION environment variable, if any, is used.



44
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 44

attribute :region

#security_groups ⇒ Object?

Returns Comma separated list of one or more security groups. Used only when command=create or command=modify.

Returns:

  • (Object, nil) —

    Comma separated list of one or more security groups. Used only when command=create or command=modify.



68
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 68

attribute :security_groups

#size ⇒ Integer?

Returns Size in gigabytes of the initial storage for the DB instance. Used only when command=create or command=modify.

Returns:

  • (Integer, nil) —

    Size in gigabytes of the initial storage for the DB instance. Used only when command=create or command=modify.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 28

attribute :size

#snapshot ⇒ String?

Returns Name of snapshot to take. When command=delete, if no snapshot name is provided then no snapshot is taken. If used with command=delete with no instance_name, the snapshot is deleted. Used with command=facts, command=delete or command=snapshot.

Returns:

  • (String, nil) —

    Name of snapshot to take. When command=delete, if no snapshot name is provided then no snapshot is taken. If used with command=delete with no instance_name, the snapshot is deleted. Used with command=facts, command=delete or command=snapshot.



103
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 103

attribute :snapshot

#source_instance ⇒ String?

Returns Name of the database to replicate. Used only when command=replicate.

Returns:

  • (String, nil) —

    Name of the database to replicate. Used only when command=replicate.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 20

attribute :source_instance

#subnet ⇒ String?

Returns VPC subnet group. If specified then a VPC instance is created. Used only when command=create.

Returns:

  • (String, nil) —

    VPC subnet group. If specified then a VPC instance is created. Used only when command=create.



99
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 99

attribute :subnet

#tags ⇒ Hash?

Returns tags dict to apply to a resource. Used with command=create, command=replicate, command=restore. Requires boto >= 2.26.0.

Returns:

  • (Hash, nil) —

    tags dict to apply to a resource. Used with command=create, command=replicate, command=restore. Requires boto >= 2.26.0



140
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 140

attribute :tags

#upgrade ⇒ :yes, ...

Returns Indicates that minor version upgrades should be applied automatically. Used only when command=create or command=replicate.

Returns:

  • (:yes, :no, nil) —

    Indicates that minor version upgrades should be applied automatically. Used only when command=create or command=replicate.



79
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 79

attribute :upgrade

#username ⇒ String?

Returns Master database username. Used only when command=create.

Returns:

  • (String, nil) —

    Master database username. Used only when command=create.



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 36

attribute :username

#vpc_security_groups ⇒ String?

Returns Comma separated list of one or more vpc security group ids. Also requires ‘subnet` to be specified. Used only when command=create or command=modify.

Returns:

  • (String, nil) —

    Comma separated list of one or more vpc security group ids. Also requires ‘subnet` to be specified. Used only when command=create or command=modify.



71
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 71

attribute :vpc_security_groups

#wait ⇒ :yes, ...

Returns When command=create, replicate, modify or restore then wait for the database to enter the ‘available’ state. When command=delete wait for the database to be terminated.

Returns:

  • (:yes, :no, nil) —

    When command=create, replicate, modify or restore then wait for the database to enter the ‘available’ state. When command=delete wait for the database to be terminated.



113
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 113

attribute :wait

#wait_timeout ⇒ Integer?

Returns how long before wait gives up, in seconds.

Returns:

  • (Integer, nil) —

    how long before wait gives up, in seconds



117
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 117

attribute :wait_timeout

#zone ⇒ String?

Returns availability zone in which to launch the instance. Used only when command=create, command=replicate or command=restore.

Returns:

  • (String, nil) —

    availability zone in which to launch the instance. Used only when command=create, command=replicate or command=restore.



95
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds.rb', line 95

attribute :zone