Parameter |
Choices/Defaults |
Comments |
apply_immediately
bool |
|
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.
|
aws_access_key
|
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY environment variable is used.
aliases: ec2_access_key, access_key
|
aws_secret_key
|
|
AWS secret key. If not set then the value of the AWS_SECRET_KEY environment variable is used.
aliases: ec2_secret_key, secret_key
|
backup_retention
|
|
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.
|
backup_window
|
|
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.
|
character_set_name
(added in 1.9) |
|
Associate the DB instance with a specified character set. Used with command=create.
|
command
required |
Choices:
- create
- replicate
- delete
- facts
- modify
- promote
- snapshot
- reboot
- restore
|
Specifies the action to take. The 'reboot' option is available starting at version 2.0
|
db_engine
|
Choices:
- mariadb
- MySQL
- oracle-se1
- oracle-se2
- oracle-se
- oracle-ee
- sqlserver-ee
- sqlserver-se
- sqlserver-ex
- sqlserver-web
- postgres
- aurora
|
The type of database. Used only when command=create.
mariadb was added in version 2.2
|
db_name
|
|
Name of a database to create within the instance. If not specified then no database is created. Used only when command=create.
|
ec2_url
|
|
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
|
engine_version
|
|
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
|
force_failover
bool
(added in 2.0) |
|
Used only when command=reboot. If enabled, the reboot is done using a MultiAZ failover.
|
instance_name
|
|
Database instance identifier. Required except when using command=facts or command=delete on just a snapshot
|
instance_type
|
|
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.
|
iops
|
|
Specifies the number of IOPS for the instance. Used only when command=create or command=modify. Must be an integer greater than 1000.
|
license_model
|
Choices:
- license-included
- bring-your-own-license
- general-public-license
- postgresql-license
|
The license model for this DB instance. Used only when command=create or command=restore.
|
maint_window
|
|
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.
|
multi_zone
bool |
|
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.
|
new_instance_name
(added in 1.5) |
|
Name to rename an instance to. Used only when command=modify.
|
option_group
|
|
The name of the option group to use. If not specified then the default option group is used. Used only when command=create.
|
parameter_group
|
|
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.
|
password
|
|
Password for the master database username. Used only when command=create or command=modify.
|
port
|
Default:
3306 for mysql, 1521 for Oracle, 1433 for SQL Server, 5432 for PostgreSQL.
|
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 db_engine .
|
profile
(added in 1.6) |
|
Uses a boto profile. Only works with boto >= 2.24.0.
|
publicly_accessible
(added in 1.9) |
|
explicitly set whether the resource should be publicly accessible or not. Used with command=create, command=replicate. Requires boto >= 2.26.0
|
region
required |
|
The AWS region to use. If not specified then the value of the EC2_REGION environment variable, if any, is used.
aliases: aws_region, ec2_region
|
security_groups
|
|
Comma separated list of one or more security groups. Used only when command=create or command=modify.
|
security_token
(added in 1.6) |
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
aliases: access_token
|
size
|
|
Size in gigabytes of the initial storage for the DB instance. Used only when command=create or command=modify.
|
snapshot
|
|
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.
|
source_instance
|
|
Name of the database to replicate. Used only when command=replicate.
|
subnet
|
|
VPC subnet group. If specified then a VPC instance is created. Used only when command=create.
|
tags
(added in 1.9) |
|
tags dict to apply to a resource. Used with command=create, command=replicate, command=restore. Requires boto >= 2.26.0
|
upgrade
bool |
|
Indicates that minor version upgrades should be applied automatically. Used only when command=create or command=replicate.
|
username
|
|
Master database username. Used only when command=create.
|
validate_certs
bool
(added in 1.5) |
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|
vpc_security_groups
|
|
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.
|
wait
bool |
|
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.
|
wait_timeout
|
Default:
300
|
how long before wait gives up, in seconds
|
zone
|
|
availability zone in which to launch the instance. Used only when command=create, command=replicate or command=restore.
aliases: aws_zone, ec2_zone
|