archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fixes #37209 - Added complex return value, instance (#49989)

Browse Source
pull/50462/head
Peter Kirby 6 years ago committed by Alicia Cozine
parent ff4af614e1
commit 5a8aa7ca1f
1 changed files with 179 additions and 174 deletions
Show Stats Download Patch File Download Diff File

107
lib/ansible/modules/cloud/amazon/rds.py
Unescape Escape View File

@ -259,77 +259,82 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
engine: instance:
description: the rds instance
returned: always
type: complex
contains:
engine:
description: the name of the database engine description: the name of the database engine
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "oracle-se" sample: "oracle-se"
engine_version: engine_version:
description: the version of the database engine description: the version of the database engine
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "11.2.0.4.v6" sample: "11.2.0.4.v6"
license_model: license_model:
description: the license model information description: the license model information
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "bring-your-own-license" sample: "bring-your-own-license"
character_set_name: character_set_name:
description: the name of the character set that this instance is associated with description: the name of the character set that this instance is associated with
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "AL32UTF8" sample: "AL32UTF8"
allocated_storage: allocated_storage:
description: the allocated storage size in gigabytes (GB) description: the allocated storage size in gigabytes (GB)
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "100" sample: "100"
publicly_accessible: publicly_accessible:
description: the accessibility options for the DB instance description: the accessibility options for the DB instance
returned: when RDS instance exists returned: when RDS instance exists
type: bool type: boolean
sample: "true" sample: "true"
latest_restorable_time: latest_restorable_time:
description: the latest time to which a database can be restored with point-in-time restore description: the latest time to which a database can be restored with point-in-time restore
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "1489707802.0" sample: "1489707802.0"
secondary_availability_zone: secondary_availability_zone:
description: the name of the secondary AZ for a DB instance with multi-AZ support description: the name of the secondary AZ for a DB instance with multi-AZ support
returned: when RDS instance exists and is multy-AZ returned: when RDS instance exists and is multy-AZ
type: str type: string
sample: "eu-west-1b" sample: "eu-west-1b"
backup_window: backup_window:
description: the daily time range during which automated backups are created if automated backups are enabled description: the daily time range during which automated backups are created if automated backups are enabled
returned: when RDS instance exists and automated backups are enabled returned: when RDS instance exists and automated backups are enabled
type: str type: string
sample: "03:00-03:30" sample: "03:00-03:30"
auto_minor_version_upgrade: auto_minor_version_upgrade:
description: indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window description: indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window
returned: when RDS instance exists returned: when RDS instance exists
type: bool type: boolean
sample: "true" sample: "true"
read_replica_source_dbinstance_identifier: read_replica_source_dbinstance_identifier:
description: the identifier of the source DB instance if this RDS instance is a read replica description: the identifier of the source DB instance if this RDS instance is a read replica
returned: when read replica RDS instance exists returned: when read replica RDS instance exists
type: str type: string
sample: "null" sample: "null"
db_name: db_name:
description: the name of the database to create when the DB instance is created description: the name of the database to create when the DB instance is created
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "ASERTG" sample: "ASERTG"
endpoint: endpoint:
description: the endpoint uri of the database instance description: the endpoint uri of the database instance
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "my-ansible-database.asdfaosdgih.us-east-1.rds.amazonaws.com" sample: "my-ansible-database.asdfaosdgih.us-east-1.rds.amazonaws.com"
port: port:
description: the listening port of the database instance description: the listening port of the database instance
returned: when RDS instance exists returned: when RDS instance exists
type: int type: int
sample: 3306 sample: 3306
parameter_groups: parameter_groups:
description: the list of DB parameter groups applied to this RDS instance description: the list of DB parameter groups applied to this RDS instance
returned: when RDS instance exists and parameter groups are defined returned: when RDS instance exists and parameter groups are defined
type: complex type: complex
@ -337,14 +342,14 @@ parameter_groups:
parameter_apply_status: parameter_apply_status:
description: the status of parameter updates description: the status of parameter updates
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "in-sync" sample: "in-sync"
parameter_group_name: parameter_group_name:
description: the name of the DP parameter group description: the name of the DP parameter group
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "testawsrpprodb01spfile-1ujg7nrs7sgyz" sample: "testawsrpprodb01spfile-1ujg7nrs7sgyz"
option_groups: option_groups:
description: the list of option group memberships for this RDS instance description: the list of option group memberships for this RDS instance
returned: when RDS instance exists returned: when RDS instance exists
type: complex type: complex
@ -352,14 +357,14 @@ option_groups:
option_group_name: option_group_name:
description: the option group name for this RDS instance description: the option group name for this RDS instance
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "default:oracle-se-11-2" sample: "default:oracle-se-11-2"
status: status:
description: the status of the RDS instance's option group membership description: the status of the RDS instance's option group membership
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "in-sync" sample: "in-sync"
pending_modified_values: pending_modified_values:
description: a dictionary of changes to the RDS instance that are pending description: a dictionary of changes to the RDS instance that are pending
returned: when RDS instance exists returned: when RDS instance exists
type: complex type: complex
@ -367,49 +372,49 @@ pending_modified_values:
db_instance_class: db_instance_class:
description: the new DB instance class for this RDS instance that will be applied or is in progress description: the new DB instance class for this RDS instance that will be applied or is in progress
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "null" sample: "null"
db_instance_identifier: db_instance_identifier:
description: the new DB instance identifier this RDS instance that will be applied or is in progress description: the new DB instance identifier this RDS instance that will be applied or is in progress
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "null" sample: "null"
allocated_storage: allocated_storage:
description: the new allocated storage size for this RDS instance that will be applied or is in progress description: the new allocated storage size for this RDS instance that will be applied or is in progress
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "null" sample: "null"
backup_retention_period: backup_retention_period:
description: the pending number of days for which automated backups are retained description: the pending number of days for which automated backups are retained
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "null" sample: "null"
engine_version: engine_version:
description: indicates the database engine version description: indicates the database engine version
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "null" sample: "null"
iops: iops:
description: the new provisioned IOPS value for this RDS instance that will be applied or is being applied description: the new provisioned IOPS value for this RDS instance that will be applied or is being applied
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "null" sample: "null"
master_user_password: master_user_password:
description: the pending or in-progress change of the master credentials for this RDS instance description: the pending or in-progress change of the master credentials for this RDS instance
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "null" sample: "null"
multi_az: multi_az:
description: indicates that the single-AZ RDS instance is to change to a multi-AZ deployment description: indicates that the single-AZ RDS instance is to change to a multi-AZ deployment
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "null" sample: "null"
port: port:
description: specifies the pending port for this RDS instance description: specifies the pending port for this RDS instance
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "null" sample: "null"
db_subnet_groups: db_subnet_groups:
description: information on the subnet group associated with this RDS instance description: information on the subnet group associated with this RDS instance
returned: when RDS instance exists returned: when RDS instance exists
type: complex type: complex
@ -417,17 +422,17 @@ db_subnet_groups:
description: description:
description: the subnet group associated with the DB instance description: the subnet group associated with the DB instance
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "Subnets for the UAT RDS SQL DB Instance" sample: "Subnets for the UAT RDS SQL DB Instance"
name: name:
description: the name of the DB subnet group description: the name of the DB subnet group
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "samplesubnetgrouprds-j6paiqkxqp4z" sample: "samplesubnetgrouprds-j6paiqkxqp4z"
status: status:
description: the status of the DB subnet group description: the status of the DB subnet group
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "complete" sample: "complete"
subnets: subnets:
description: the description of the DB subnet group description: the description of the DB subnet group
@ -442,22 +447,22 @@ db_subnet_groups:
name: name:
description: avaialbility zone description: avaialbility zone
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "eu-west-1b" sample: "eu-west-1b"
provisioned_iops_capable: provisioned_iops_capable:
description: whether provisioned iops are available in AZ subnet description: whether provisioned iops are available in AZ subnet
returned: when RDS instance exists returned: when RDS instance exists
type: bool type: boolean
sample: "false" sample: "false"
identifier: identifier:
description: the identifier of the subnet description: the identifier of the subnet
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "subnet-3fdba63e" sample: "subnet-3fdba63e"
status: status:
description: the status of the subnet description: the status of the subnet
returned: when RDS instance exists returned: when RDS instance exists
type: str type: string
sample: "active" sample: "active"
''' '''

Write Preview
Loading…
Cancel
Save