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

Inherits:

Base

Object
Ansible::Ruby::Models::Base
Base
Ansible::Ruby::Modules::Rds

show all

Defined in:: lib/ansible/ruby/modules/generated/core/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

#apply_immediately ⇒ Boolean^?

Used only when command=modify.
#aws_access_key ⇒ Object^?

AWS access key.
#aws_secret_key ⇒ Object^?

AWS secret key.
#backup_retention ⇒ Object^?

Number of days backups are retained.
#backup_window ⇒ Object^?

Backup window in format of hh24:mi-hh24:mi.
#character_set_name ⇒ Object^?

Associate the DB instance with a specified character set.
#command ⇒ :create, ...

Specifies the action to take.
#db_engine ⇒ :MySQL, ...

The type of database.
#db_name ⇒ Object^?

Name of a database to create within the instance.
#engine_version ⇒ Object^?

Version number of the database engine to use.
#force_failover ⇒ :yes, ...

Used only when command=reboot.
#instance_name ⇒ String^?

Database instance identifier.
#instance_type ⇒ String^?

The instance type of the database.
#iops ⇒ Object^?

Specifies the number of IOPS for the instance.
#license_model ⇒ :"license-included", ...

The license model for this DB instance.
#maint_window ⇒ Object^?

Maintenance window in format of ddd:hh24:mi-ddd:hh24:mi.
#multi_zone ⇒ :yes, ...

Specifies if this is a Multi-availability-zone deployment.
#new_instance_name ⇒ String^?

Name to rename an instance to.
#option_group ⇒ Object^?

The name of the option group to use.
#parameter_group ⇒ Object^?

Name of the DB parameter group to associate with this instance.
#password ⇒ String^?

Password for the master database username.
#port ⇒ Integer^?

Port number that the DB instance uses for connections.
#publicly_accessible ⇒ Boolean^?

Explicitly set whether the resource should be publicly accessible or not.
#region ⇒ String

The AWS region to use.
#security_groups ⇒ Object^?

Comma separated list of one or more security groups.
#size ⇒ Integer^?

Size in gigabytes of the initial storage for the DB instance.
#snapshot ⇒ String^?

Name of snapshot to take.
#source_instance ⇒ String^?

Name of the database to replicate.
#subnet ⇒ String^?

VPC subnet group.
#tags ⇒ Hash^?

Tags dict to apply to a resource.
#upgrade ⇒ Boolean^?

Indicates that minor version upgrades should be applied automatically.
#username ⇒ String^?

Master database username.
#vpc_security_groups ⇒ String^?

Comma separated list of one or more vpc security group ids.
#wait ⇒ :yes, ...

When command=create, replicate, modify or restore then wait for the database to enter the ‘available’ state.
#wait_timeout ⇒ Integer^?

How long before wait gives up, in seconds.
#zone ⇒ String^?

Availability zone in which to launch the instance.

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#apply_immediately ⇒ `Boolean`^?

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:

(Boolean, 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.

120	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 120 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.

109	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 109 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.

106	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 106 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.

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.

91	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 91 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.

88	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 88 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.

132	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 132 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

11	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 11 attribute :command

#db_engine ⇒ `:MySQL`, ...

Returns The type of database. Used only when command=create.

Returns:

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

The type of database. Used only when command=create.

23	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 23 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.

47	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 47 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.

50	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 50 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.

124	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 124 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

15	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 15 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.

31	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 31 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.

64	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 64 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.

56	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 56 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.

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.

85	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 85 attribute :maint_window

#multi_zone ⇒ `:yes`, ...

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:

(:yes, :no, 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.

60	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 60 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.

128	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 128 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.

82	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 82 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.

53	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 53 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.

39	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 39 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 auotmaticaly 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 auotmaticaly defaults to what is expected for each c(db_engine).

74	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 74 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

135	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 135 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.

43	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 43 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.

67	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 67 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.

27	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 27 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.

102	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 102 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.

19	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 19 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.

98	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 98 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

139	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 139 attribute :tags

#upgrade ⇒ `Boolean`^?

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

Returns:

(Boolean, nil) —

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

78	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 78 attribute :upgrade

#username ⇒ `String`^?

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

Returns:

(String, nil) —

Master database username. Used only when command=create.

35	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 35 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.

70	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 70 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.

112	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 112 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

116	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 116 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.

94	# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/rds.rb', line 94 attribute :zone

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

Overview

Instance Method Summary collapse

Methods inherited from Base

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

Constructor Details

Instance Method Details

#apply_immediately ⇒ Boolean?

#aws_access_key ⇒ Object?

#aws_secret_key ⇒ Object?

#backup_retention ⇒ Object?

#backup_window ⇒ Object?

#character_set_name ⇒ Object?

#command ⇒ :create, ...

#db_engine ⇒ :MySQL, ...

#db_name ⇒ Object?

#engine_version ⇒ Object?

#force_failover ⇒ :yes, ...

#instance_name ⇒ String?

#instance_type ⇒ String?

#iops ⇒ Object?

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

#maint_window ⇒ Object?

#multi_zone ⇒ :yes, ...

#new_instance_name ⇒ String?

#option_group ⇒ Object?

#parameter_group ⇒ Object?

#password ⇒ String?

#port ⇒ Integer?

#publicly_accessible ⇒ Boolean?

#region ⇒ String

#security_groups ⇒ Object?

#size ⇒ Integer?

#snapshot ⇒ String?

#source_instance ⇒ String?

#subnet ⇒ String?

#tags ⇒ Hash?

#upgrade ⇒ Boolean?

#username ⇒ String?

#vpc_security_groups ⇒ String?

#wait ⇒ :yes, ...

#wait_timeout ⇒ Integer?

#zone ⇒ String?

#apply_immediately ⇒ `Boolean`^?

#aws_access_key ⇒ `Object`^?

#aws_secret_key ⇒ `Object`^?

#backup_retention ⇒ `Object`^?

#backup_window ⇒ `Object`^?

#character_set_name ⇒ `Object`^?

#command ⇒ `:create`, ...

#db_engine ⇒ `:MySQL`, ...

#db_name ⇒ `Object`^?

#engine_version ⇒ `Object`^?

#force_failover ⇒ `:yes`, ...

#instance_name ⇒ `String`^?

#instance_type ⇒ `String`^?

#iops ⇒ `Object`^?

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

#maint_window ⇒ `Object`^?

#multi_zone ⇒ `:yes`, ...

#new_instance_name ⇒ `String`^?

#option_group ⇒ `Object`^?

#parameter_group ⇒ `Object`^?

#password ⇒ `String`^?

#port ⇒ `Integer`^?

#publicly_accessible ⇒ `Boolean`^?

#region ⇒ `String`

#security_groups ⇒ `Object`^?

#size ⇒ `Integer`^?

#snapshot ⇒ `String`^?

#source_instance ⇒ `String`^?

#subnet ⇒ `String`^?

#tags ⇒ `Hash`^?

#upgrade ⇒ `Boolean`^?

#username ⇒ `String`^?

#vpc_security_groups ⇒ `String`^?

#wait ⇒ `:yes`, ...

#wait_timeout ⇒ `Integer`^?

#zone ⇒ `String`^?