Document return values for ec2_vpc_net.py (#21294)

* Document return values for ec2_vpc_net.py

* Prepend "vpc" to return values
This commit is contained in:
Lorin Hochstein 2017-09-11 13:10:36 -07:00 committed by Sloane Hertel
parent 36a732be7a
commit 362a2e523a

View file

@ -100,6 +100,49 @@ EXAMPLES = '''
'''
RETURN = '''
vpc.id:
description: VPC resource id
returned: success
type: string
sample: vpc-b883b2c4
vpc.cidr_block:
description: The CIDR of the VPC
returned: success
type: string
sample: "10.0.0.0/16"
vpc.state:
description: state of the VPC
returned: success
type: string
sample: available
vpc.tags:
description: tags attached to the VPC, includes name
returned: success
type: dict
sample: {"Name": "My VPC", "env": "staging"}
vpc.classic_link_enabled:
description: indicates whether ClassicLink is enabled
returned: success
type: boolean
sample: false
vpc.dhcp_options_id:
description: the id of the DHCP options assocaited with this VPC
returned: success
type: string
sample: dopt-67236184
vpc.instance_tenancy:
description: indicates whther VPC uses default or dedicated tenancy
returned: success
type: string
sample: default
vpc.is_default:
description: indicates whether this is the default VPC
returned: success
type: boolean
sample: false
'''
try:
import boto
import boto.ec2