Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document route53 return values #31962

Merged
merged 1 commit into from
Oct 27, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
77 changes: 77 additions & 0 deletions lib/ansible/modules/cloud/amazon/route53.py
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,83 @@
extends_documentation_fragment: aws
'''

RETURN = '''
nameservers:
description: nameservers associated with the zone
returned: when state is 'get'
type: list
sample:
- ns-1036.awsdns-00.org.
- ns-516.awsdns-00.net.
- ns-1504.awsdns-00.co.uk.
- ns-1.awsdns-00.com.
set:
description: info specific to the resource record
returned: when state is 'get'
type: complex
contains:
alias:
description: whether this is an alias
returned: always
type: bool
sample: false
failover:
description:
returned: always
type: NoneType
sample: null
health_check:
description: health_check associated with this record
returned: always
type: NoneType
sample: null
identifier:
description:
returned: always
type: NoneType
sample: null
record:
description: domain name for the record set
returned: always
type: string
sample: new.foo.com.
region:
description:
returned: always
type:
sample:
ttl:
description: resource record cache TTL
returned: always
type: string
sample: '3600'
type:
description: record set type
returned: always
type: string
sample: A
value:
description: value
returned: always
type: string
sample: 52.43.18.27
values:
description: values
returned: always
type: list
sample:
- 52.43.18.27
weight:
description: weight of the record
returned: always
type: string
sample: '3'
zone:
description: zone this record set belongs to
returned: always
type: string
sample: foo.bar.com.
'''

EXAMPLES = '''
# Add new.foo.com as an A record with 3 IPs and wait until the changes have been replicated
Expand Down