@ -25,151 +25,211 @@ description:
options :
options :
command :
command :
description :
description :
- Specifies the action to take . The ' reboot ' option is available starting at version 2.0
- Specifies the action to take . The ' reboot ' option is available starting at version 2.0 .
required : true
required : true
choices : [ ' create ' , ' replicate ' , ' delete ' , ' facts ' , ' modify ' , ' promote ' , ' snapshot ' , ' reboot ' , ' restore ' ]
choices : [ ' create ' , ' replicate ' , ' delete ' , ' facts ' , ' modify ' , ' promote ' , ' snapshot ' , ' reboot ' , ' restore ' ]
type : str
instance_name :
instance_name :
description :
description :
- Database instance identifier . Required except when using command = facts or command = delete on just a snapshot
- Database instance identifier .
- Required except when using I ( command = facts ) or I ( command = delete ) on just a snapshot .
type : str
source_instance :
source_instance :
description :
description :
- Name of the database to replicate . Used only when command = replicate .
- Name of the database to replicate .
- Used only when I ( command = replicate ) .
type : str
db_engine :
db_engine :
description :
description :
- The type of database . Used only when command = create .
- The type of database .
- mariadb was added in version 2.2
- Used only when I ( command = create ) .
- mariadb was added in version 2.2 .
choices : [ ' mariadb ' , ' MySQL ' , ' oracle-se1 ' , ' oracle-se2 ' , ' oracle-se ' , ' oracle-ee ' ,
choices : [ ' mariadb ' , ' MySQL ' , ' oracle-se1 ' , ' oracle-se2 ' , ' oracle-se ' , ' oracle-ee ' ,
' sqlserver-ee ' , ' sqlserver-se ' , ' sqlserver-ex ' , ' sqlserver-web ' , ' postgres ' , ' aurora ' ]
' sqlserver-ee ' , ' sqlserver-se ' , ' sqlserver-ex ' , ' sqlserver-web ' , ' postgres ' , ' aurora ' ]
type : str
size :
size :
description :
description :
- Size in gigabytes of the initial storage for the DB instance . Used only when command = create or command = modify .
- Size in gigabytes of the initial storage for the DB instance .
- Used only when I ( command = create ) or I ( command = modify ) .
type : str
instance_type :
instance_type :
description :
description :
- The instance type of the database . Must be specified when command = create . Optional when command = replicate , command = modify or command = restore .
- The instance type of the database .
If not specified then the replica inherits the same instance type as the source instance .
- If not specified then the replica inherits the same instance type as the source instance .
- Required when I ( command = create ) .
- Optional when I ( command = replicate ) , I ( command = modify ) or I ( command = restore ) .
aliases : [ ' type ' ]
type : str
username :
username :
description :
description :
- Master database username . Used only when command = create .
- Master database username .
- Used only when I ( command = create ) .
type : str
password :
password :
description :
description :
- Password for the master database username . Used only when command = create or command = modify .
- Password for the master database username .
region :
- Used only when I ( command = create ) or I ( command = modify ) .
description :
type : str
- The AWS region to use . If not specified then the value of the EC2_REGION environment variable , if any , is used .
required : true
aliases : [ ' aws_region ' , ' ec2_region ' ]
db_name :
db_name :
description :
description :
- Name of a database to create within the instance . If not specified then no database is created . Used only when command = create .
- Name of a database to create within the instance .
- If not specified then no database is created .
- Used only when I ( command = create ) .
type : str
engine_version :
engine_version :
description :
description :
- 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
- Version number of the database engine to use .
- If not specified then the current Amazon RDS default engine version is used
- Used only when I ( command = create ) .
type : str
parameter_group :
parameter_group :
description :
description :
- Name of the DB parameter group to associate with this instance . If omitted then the RDS default DBParameterGroup will be used . Used only
- Name of the DB parameter group to associate with this instance .
when command = create or command = modify .
- If omitted then the RDS default DBParameterGroup will be used .
- Used only when I ( command = create ) or I ( command = modify ) .
type : str
license_model :
license_model :
description :
description :
- The license model for this DB instance . Used only when command = create or command = restore .
- The license model for this DB instance .
- Used only when I ( command = create ) or I ( command = restore ) .
choices : [ ' license-included ' , ' bring-your-own-license ' , ' general-public-license ' , ' postgresql-license ' ]
choices : [ ' license-included ' , ' bring-your-own-license ' , ' general-public-license ' , ' postgresql-license ' ]
type : str
multi_zone :
multi_zone :
description :
description :
- Specifies if this is a Multi - availability - zone deployment . Can not be used in conjunction with zone parameter . Used only when command = create or
- Specifies if this is a Multi - availability - zone deployment .
command = modify .
- Can not be used in conjunction with I ( zone ) parameter .
- Used only when I ( command = create ) or I ( command = modify ) .
type : bool
type : bool
iops :
iops :
description :
description :
- Specifies the number of IOPS for the instance . Used only when command = create or command = modify . Must be an integer greater than 1000.
- Specifies the number of IOPS for the instance .
- Used only when I ( command = create ) or I ( command = modify ) .
- Must be an integer greater than 1000.
type : str
security_groups :
security_groups :
description :
description :
- Comma separated list of one or more security groups . Used only when command = create or command = modify .
- Comma separated list of one or more security groups .
- Used only when I ( command = create ) or I ( command = modify ) .
type : str
vpc_security_groups :
vpc_security_groups :
description :
description :
- 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 .
- Comma separated list of one or more vpc security group ids .
- Also requires I ( subnet ) to be specified .
- Used only when I ( command = create ) or I ( command = modify ) .
type : list
elements : str
port :
port :
description :
description :
- Port number that the DB instance uses for connections . Used only when command = create or command = replicate .
- Port number that the DB instance uses for connections .
- 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 .
- Used only when I ( command = create ) or I ( command = replicate ) .
Starting at 2.0 it automatically defaults to what is expected for each C ( db_engine ) .
- ' Defaults to the standard ports for each I(db_engine): C(3306) for MySQL and MariaDB, C(1521) for Oracle
default : 3306 for mysql , 1521 for Oracle , 1433 for SQL Server , 5432 for PostgreSQL .
C ( 1433 ) for SQL Server , C ( 5432 ) for PostgreSQL . '
type : int
upgrade :
upgrade :
description :
description :
- Indicates that minor version upgrades should be applied automatically .
- Indicates that minor version upgrades should be applied automatically .
- Used only when command= create or command= modify or command= restore or command= replicate .
- Used only when I( command= create ) or I( command= modify ) or I( command= restore ) or I( command= replicate ) .
type : bool
type : bool
default : ' no '
default : false
option_group :
option_group :
description :
description :
- The name of the option group to use . If not specified then the default option group is used . Used only when command = create .
- The name of the option group to use .
- If not specified then the default option group is used .
- Used only when I ( command = create ) .
type : str
maint_window :
maint_window :
description :
description :
- >
- ' Maintenance window in format of C(ddd:hh24:mi-ddd:hh24:mi). (Example: C(Mon:22:00-Mon:23:15)) '
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
- Times are specified in UTC .
assigned . Used only when command = create or command = modify .
- If not specified then a random maintenance window is assigned .
- Used only when I ( command = create ) or I ( command = modify ) .
type : str
backup_window :
backup_window :
description :
description :
- 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 .
- ' Backup window in format of C(hh24:mi-hh24:mi). (Example: C(18:00-20:30)) '
- Times are specified in UTC .
- If not specified then a random backup window is assigned .
- Used only when command = create or command = modify .
type : str
backup_retention :
backup_retention :
description :
description :
- >
- Number of days backups are retained .
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
- Set to 0 to disable backups .
command = modify .
- Default is 1 day .
- ' Valid range: 0-35. '
- Used only when I ( command = create ) or I ( command = modify ) .
type : str
zone :
zone :
description :
description :
- availability zone in which to launch the instance . Used only when command = create , command = replicate or command = restore .
- availability zone in which to launch the instance .
- Used only when I ( command = create ) , I ( command = replicate ) or I ( command = restore ) .
- Can not be used in conjunction with I ( multi_zone ) parameter .
aliases : [ ' aws_zone ' , ' ec2_zone ' ]
aliases : [ ' aws_zone ' , ' ec2_zone ' ]
type : str
subnet :
subnet :
description :
description :
- VPC subnet group . If specified then a VPC instance is created . Used only when command = create .
- VPC subnet group .
- If specified then a VPC instance is created .
- Used only when I ( command = create ) .
type : str
snapshot :
snapshot :
description :
description :
- 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
- Name of snapshot to take .
no instance_name , the snapshot is deleted . Used with command = facts , command = delete or command = snapshot .
- When I ( command = delete ) , if no I ( snapshot ) name is provided then no snapshot is taken .
aws_secret_key :
- When I ( command = delete ) , if no I ( instance_name ) is provided the snapshot is deleted .
description :
- Used with I ( command = facts ) , I ( command = delete ) or I ( command = snapshot ) .
- AWS secret key . If not set then the value of the AWS_SECRET_KEY environment variable is used .
type : str
aliases : [ ' ec2_secret_key ' , ' secret_key ' ]
aws_access_key :
description :
- AWS access key . If not set then the value of the AWS_ACCESS_KEY environment variable is used .
aliases : [ ' ec2_access_key ' , ' access_key ' ]
wait :
wait :
description :
description :
- When command= create , replicate , modify or restore then wait for the database to enter the ' available ' state . When command = delete wait for
- When I ( command = create ) , replicate , modify or restore then wait for the database to enter the ' available ' state .
the database to be terminated .
- When I ( command = delete ) , wait for the database to be terminated .
type : bool
type : bool
default : ' no '
default : false
wait_timeout :
wait_timeout :
description :
description :
- how long before wait gives up , in seconds
- How long before wait gives up , in seconds .
- Used when I ( wait = true ) .
default : 300
default : 300
type : int
apply_immediately :
apply_immediately :
description :
description :
- Used only when command = modify . If enabled , the modifications will be applied as soon as possible rather than waiting for the next
- When I ( apply_immediately = trye ) , the modifications will be applied as soon as possible rather than waiting for the
preferred maintenance window .
next preferred maintenance window .
- Used only when I ( command = modify ) .
type : bool
type : bool
default : ' no '
default : false
force_failover :
force_failover :
description :
description :
- Used only when command = reboot . If enabled , the reboot is done using a MultiAZ failover .
- If enabled , the reboot is done using a MultiAZ failover .
- Used only when I ( command = reboot ) .
type : bool
type : bool
default : ' no '
default : false
version_added : " 2.0 "
version_added : " 2.0 "
new_instance_name :
new_instance_name :
description :
description :
- Name to rename an instance to . Used only when command = modify .
- Name to rename an instance to .
- Used only when I ( command = modify ) .
type : str
version_added : " 1.5 "
version_added : " 1.5 "
character_set_name :
character_set_name :
description :
description :
- Associate the DB instance with a specified character set . Used with command = create .
- Associate the DB instance with a specified character set .
- Used with I ( command = create ) .
version_added : " 1.9 "
version_added : " 1.9 "
type : str
publicly_accessible :
publicly_accessible :
description :
description :
- explicitly set whether the resource should be publicly accessible or not . Used with command = create , command = replicate . Requires boto > = 2.26 .0
- Explicitly set whether the resource should be publicly accessible or not .
- Used with I ( command = create ) , I ( command = replicate ) .
- Requires boto > = 2.26 .0
type : str
version_added : " 1.9 "
version_added : " 1.9 "
tags :
tags :
description :
description :
- tags dict to apply to a resource . Used with command = create , command = replicate , command = restore . Requires boto > = 2.26 .0
- tags dict to apply to a resource .
- Used with I ( command = create ) , I ( command = replicate ) , I ( command = restore ) .
- Requires boto > = 2.26 .0
type : dict
version_added : " 1.9 "
version_added : " 1.9 "
requirements :
requirements :
- " python >= 2.6 "
- " python >= 2.6 "