ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-25 03:41:25 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Convert to reduced list of known types (#50010)

Browse source
This commit is contained in:
Dag Wieers 2018-12-18 22:25:30 +01:00 • committed by Jordan Borean
parent fcd1486b51
commit 05c6ff79f9
908 changed files with 4822 additions and 4821 deletions
Download patch file Download diff file Expand all files Collapse all files

66
lib/ansible/modules/cloud/alicloud/ali_instance.py
View file

@ -268,7 +268,7 @@ instances:
availability_zone: availability_zone:
description: The availability zone of the instance is in. description: The availability zone of the instance is in.
returned: always returned: always
type: string type: str
sample: cn-beijing-a sample: cn-beijing-a
block_device_mappings: block_device_mappings:
description: Any block device mapping entries for the instance. description: Any block device mapping entries for the instance.
@ -278,12 +278,12 @@ instances:
device_name: device_name:
description: The device name exposed to the instance (for example, /dev/xvda). description: The device name exposed to the instance (for example, /dev/xvda).
returned: always returned: always
type: string type: str
sample: /dev/xvda sample: /dev/xvda
attach_time: attach_time:
description: The time stamp when the attachment initiated. description: The time stamp when the attachment initiated.
returned: always returned: always
type: string type: str
sample: "2018-06-25T04:08:26Z" sample: "2018-06-25T04:08:26Z"
delete_on_termination: delete_on_termination:
description: Indicates whether the volume is deleted on instance termination. description: Indicates whether the volume is deleted on instance termination.
@ -293,12 +293,12 @@ instances:
status: status:
description: The attachment state. description: The attachment state.
returned: always returned: always
type: string type: str
sample: in_use sample: in_use
volume_id: volume_id:
description: The ID of the cloud disk. description: The ID of the cloud disk.
returned: always returned: always
type: string type: str
sample: d-2zei53pjsi117y6gf9t6 sample: d-2zei53pjsi117y6gf9t6
cpu: cpu:
description: The CPU core count of the instance. description: The CPU core count of the instance.
@ -308,12 +308,12 @@ instances:
creation_time: creation_time:
description: The time the instance was created. description: The time the instance was created.
returned: always returned: always
type: string type: str
sample: "2018-06-25T04:08Z" sample: "2018-06-25T04:08Z"
description: description:
description: The instance description. description: The instance description.
returned: always returned: always
type: string type: str
sample: "my ansible instance" sample: "my ansible instance"
eip: eip:
description: The attribution of EIP associated with the instance. description: The attribution of EIP associated with the instance.
@ -323,22 +323,22 @@ instances:
allocation_id: allocation_id:
description: The ID of the EIP. description: The ID of the EIP.
returned: always returned: always
type: string type: str
sample: eip-12345 sample: eip-12345
internet_charge_type: internet_charge_type:
description: The internet charge type of the EIP. description: The internet charge type of the EIP.
returned: always returned: always
type: string type: str
sample: "paybybandwidth" sample: "paybybandwidth"
ip_address: ip_address:
description: EIP address. description: EIP address.
returned: always returned: always
type: string type: str
sample: 42.10.2.2 sample: 42.10.2.2
expired_time: expired_time:
description: The time the instance will expire. description: The time the instance will expire.
returned: always returned: always
type: string type: str
sample: "2099-12-31T15:59Z" sample: "2099-12-31T15:59Z"
gpu: gpu:
description: The attribution of instance GPU. description: The attribution of instance GPU.
@ -353,52 +353,52 @@ instances:
spec: spec:
description: The specification of the GPU. description: The specification of the GPU.
returned: always returned: always
type: string type: str
sample: "" sample: ""
host_name: host_name:
description: The host name of the instance. description: The host name of the instance.
returned: always returned: always
type: string type: str
sample: iZ2zewaoZ sample: iZ2zewaoZ
id: id:
description: Alias of instance_id. description: Alias of instance_id.
returned: always returned: always
type: string type: str
sample: i-abc12345 sample: i-abc12345
instance_id: instance_id:
description: ECS instance resource ID. description: ECS instance resource ID.
returned: always returned: always
type: string type: str
sample: i-abc12345 sample: i-abc12345
image_id: image_id:
description: The ID of the image used to launch the instance. description: The ID of the image used to launch the instance.
returned: always returned: always
type: string type: str
sample: m-0011223344 sample: m-0011223344
inner_ip_address: inner_ip_address:
description: The inner IPv4 address of the classic instance. description: The inner IPv4 address of the classic instance.
returned: always returned: always
type: string type: str
sample: 10.0.0.2 sample: 10.0.0.2
instance_charge_type: instance_charge_type:
description: The instance charge type. description: The instance charge type.
returned: always returned: always
type: string type: str
sample: PostPaid sample: PostPaid
instance_name: instance_name:
description: The name of the instance. description: The name of the instance.
returned: always returned: always
type: string type: str
sample: my-ecs sample: my-ecs
instance_type: instance_type:
description: The instance type of the running instance. description: The instance type of the running instance.
returned: always returned: always
type: string type: str
sample: ecs.sn1ne.xlarge sample: ecs.sn1ne.xlarge
internet_charge_type: internet_charge_type:
description: The billing method of the network bandwidth. description: The billing method of the network bandwidth.
returned: always returned: always
type: string type: str
sample: PayByBandwidth sample: PayByBandwidth
internet_max_bandwidth_in: internet_max_bandwidth_in:
description: Maximum incoming bandwidth from the internet network. description: Maximum incoming bandwidth from the internet network.
@ -428,42 +428,42 @@ instances:
mac_address: mac_address:
description: The MAC address. description: The MAC address.
returned: always returned: always
type: string type: str
sample: "00:11:22:33:44:55" sample: "00:11:22:33:44:55"
network_interface_id: network_interface_id:
description: The ID of the network interface. description: The ID of the network interface.
returned: always returned: always
type: string type: str
sample: eni-01234567 sample: eni-01234567
primary_ip_address: primary_ip_address:
description: The primary IPv4 address of the network interface within the vswitch. description: The primary IPv4 address of the network interface within the vswitch.
returned: always returned: always
type: string type: str
sample: 10.0.0.1 sample: 10.0.0.1
osname: osname:
description: The operation system name of the instance owned. description: The operation system name of the instance owned.
returned: always returned: always
type: string type: str
sample: CentOS sample: CentOS
ostype: ostype:
description: The operation system type of the instance owned. description: The operation system type of the instance owned.
returned: always returned: always
type: string type: str
sample: linux sample: linux
private_ip_address: private_ip_address:
description: The IPv4 address of the network interface within the subnet. description: The IPv4 address of the network interface within the subnet.
returned: always returned: always
type: string type: str
sample: 10.0.0.1 sample: 10.0.0.1
public_ip_address: public_ip_address:
description: The public IPv4 address assigned to the instance description: The public IPv4 address assigned to the instance
returned: always returned: always
type: string type: str
sample: 43.0.0.1 sample: 43.0.0.1
resource_group_id: resource_group_id:
description: The id of the resource group to which the instance belongs. description: The id of the resource group to which the instance belongs.
returned: always returned: always
type: string type: str
sample: my-ecs-group sample: my-ecs-group
security_groups: security_groups:
description: One or more security groups for the instance. description: One or more security groups for the instance.
@ -473,17 +473,17 @@ instances:
- group_id: - group_id:
description: The ID of the security group. description: The ID of the security group.
returned: always returned: always
type: string type: str
sample: sg-0123456 sample: sg-0123456
- group_name: - group_name:
description: The name of the security group. description: The name of the security group.
returned: always returned: always
type: string type: str
sample: my-security-group sample: my-security-group
status: status:
description: The current status of the instance. description: The current status of the instance.
returned: always returned: always
type: string type: str
sample: running sample: running
tags: tags:
description: Any tags assigned to the instance. description: Any tags assigned to the instance.
@ -493,7 +493,7 @@ instances:
vswitch_id: vswitch_id:
description: The ID of the vswitch in which the instance is running. description: The ID of the vswitch in which the instance is running.
returned: always returned: always
type: string type: str
sample: vsw-dew00abcdef sample: vsw-dew00abcdef
vpc_id: vpc_id:
description: The ID of the VPC the instance is in. description: The ID of the VPC the instance is in.

66
lib/ansible/modules/cloud/alicloud/ali_instance_facts.py
View file

@ -97,7 +97,7 @@ instances:
availability_zone: availability_zone:
description: The availability zone of the instance is in. description: The availability zone of the instance is in.
returned: always returned: always
type: string type: str
sample: cn-beijing-a sample: cn-beijing-a
block_device_mappings: block_device_mappings:
description: Any block device mapping entries for the instance. description: Any block device mapping entries for the instance.
@ -107,12 +107,12 @@ instances:
device_name: device_name:
description: The device name exposed to the instance (for example, /dev/xvda). description: The device name exposed to the instance (for example, /dev/xvda).
returned: always returned: always
type: string type: str
sample: /dev/xvda sample: /dev/xvda
attach_time: attach_time:
description: The time stamp when the attachment initiated. description: The time stamp when the attachment initiated.
returned: always returned: always
type: string type: str
sample: "2018-06-25T04:08:26Z" sample: "2018-06-25T04:08:26Z"
delete_on_termination: delete_on_termination:
description: Indicates whether the volume is deleted on instance termination. description: Indicates whether the volume is deleted on instance termination.
@ -122,12 +122,12 @@ instances:
status: status:
description: The attachment state. description: The attachment state.
returned: always returned: always
type: string type: str
sample: in_use sample: in_use
volume_id: volume_id:
description: The ID of the cloud disk. description: The ID of the cloud disk.
returned: always returned: always
type: string type: str
sample: d-2zei53pjsi117y6gf9t6 sample: d-2zei53pjsi117y6gf9t6
cpu: cpu:
description: The CPU core count of the instance. description: The CPU core count of the instance.
@ -137,12 +137,12 @@ instances:
creation_time: creation_time:
description: The time the instance was created. description: The time the instance was created.
returned: always returned: always
type: string type: str
sample: "2018-06-25T04:08Z" sample: "2018-06-25T04:08Z"
description: description:
description: The instance description. description: The instance description.
returned: always returned: always
type: string type: str
sample: "my ansible instance" sample: "my ansible instance"
eip: eip:
description: The attribution of EIP associated with the instance. description: The attribution of EIP associated with the instance.
@ -152,22 +152,22 @@ instances:
allocation_id: allocation_id:
description: The ID of the EIP. description: The ID of the EIP.
returned: always returned: always
type: string type: str
sample: eip-12345 sample: eip-12345
internet_charge_type: internet_charge_type:
description: The internet charge type of the EIP. description: The internet charge type of the EIP.
returned: always returned: always
type: string type: str
sample: "paybybandwidth" sample: "paybybandwidth"
ip_address: ip_address:
description: EIP address. description: EIP address.
returned: always returned: always
type: string type: str
sample: 42.10.2.2 sample: 42.10.2.2
expired_time: expired_time:
description: The time the instance will expire. description: The time the instance will expire.
returned: always returned: always
type: string type: str
sample: "2099-12-31T15:59Z" sample: "2099-12-31T15:59Z"
gpu: gpu:
description: The attribution of instance GPU. description: The attribution of instance GPU.
@ -182,52 +182,52 @@ instances:
spec: spec:
description: The specification of the GPU. description: The specification of the GPU.
returned: always returned: always
type: string type: str
sample: "" sample: ""
host_name: host_name:
description: The host name of the instance. description: The host name of the instance.
returned: always returned: always
type: string type: str
sample: iZ2zewaoZ sample: iZ2zewaoZ
id: id:
description: Alias of instance_id. description: Alias of instance_id.
returned: always returned: always
type: string type: str
sample: i-abc12345 sample: i-abc12345
instance_id: instance_id:
description: ECS instance resource ID. description: ECS instance resource ID.
returned: always returned: always
type: string type: str
sample: i-abc12345 sample: i-abc12345
image_id: image_id:
description: The ID of the image used to launch the instance. description: The ID of the image used to launch the instance.
returned: always returned: always
type: string type: str
sample: m-0011223344 sample: m-0011223344
inner_ip_address: inner_ip_address:
description: The inner IPv4 address of the classic instance. description: The inner IPv4 address of the classic instance.
returned: always returned: always
type: string type: str
sample: 10.0.0.2 sample: 10.0.0.2
instance_charge_type: instance_charge_type:
description: The instance charge type. description: The instance charge type.
returned: always returned: always
type: string type: str
sample: PostPaid sample: PostPaid
instance_name: instance_name:
description: The name of the instance. description: The name of the instance.
returned: always returned: always
type: string type: str
sample: my-ecs sample: my-ecs
instance_type: instance_type:
description: The instance type of the running instance. description: The instance type of the running instance.
returned: always returned: always
type: string type: str
sample: ecs.sn1ne.xlarge sample: ecs.sn1ne.xlarge
internet_charge_type: internet_charge_type:
description: The billing method of the network bandwidth. description: The billing method of the network bandwidth.
returned: always returned: always
type: string type: str
sample: PayByBandwidth sample: PayByBandwidth
internet_max_bandwidth_in: internet_max_bandwidth_in:
description: Maximum incoming bandwidth from the internet network. description: Maximum incoming bandwidth from the internet network.
@ -257,42 +257,42 @@ instances:
mac_address: mac_address:
description: The MAC address. description: The MAC address.
returned: always returned: always
type: string type: str
sample: "00:11:22:33:44:55" sample: "00:11:22:33:44:55"
network_interface_id: network_interface_id:
description: The ID of the network interface. description: The ID of the network interface.
returned: always returned: always
type: string type: str
sample: eni-01234567 sample: eni-01234567
primary_ip_address: primary_ip_address:
description: The primary IPv4 address of the network interface within the vswitch. description: The primary IPv4 address of the network interface within the vswitch.
returned: always returned: always
type: string type: str
sample: 10.0.0.1 sample: 10.0.0.1
osname: osname:
description: The operation system name of the instance owned. description: The operation system name of the instance owned.
returned: always returned: always
type: string type: str
sample: CentOS sample: CentOS
ostype: ostype:
description: The operation system type of the instance owned. description: The operation system type of the instance owned.
returned: always returned: always
type: string type: str
sample: linux sample: linux
private_ip_address: private_ip_address:
description: The IPv4 address of the network interface within the subnet. description: The IPv4 address of the network interface within the subnet.
returned: always returned: always
type: string type: str
sample: 10.0.0.1 sample: 10.0.0.1
public_ip_address: public_ip_address:
description: The public IPv4 address assigned to the instance description: The public IPv4 address assigned to the instance
returned: always returned: always
type: string type: str
sample: 43.0.0.1 sample: 43.0.0.1
resource_group_id: resource_group_id:
description: The id of the resource group to which the instance belongs. description: The id of the resource group to which the instance belongs.
returned: always returned: always
type: string type: str
sample: my-ecs-group sample: my-ecs-group
security_groups: security_groups:
description: One or more security groups for the instance. description: One or more security groups for the instance.
@ -302,17 +302,17 @@ instances:
- group_id: - group_id:
description: The ID of the security group. description: The ID of the security group.
returned: always returned: always
type: string type: str
sample: sg-0123456 sample: sg-0123456
- group_name: - group_name:
description: The name of the security group. description: The name of the security group.
returned: always returned: always
type: string type: str
sample: my-security-group sample: my-security-group
status: status:
description: The current status of the instance. description: The current status of the instance.
returned: always returned: always
type: string type: str
sample: running sample: running
tags: tags:
description: Any tags assigned to the instance. description: Any tags assigned to the instance.
@ -322,7 +322,7 @@ instances:
vswitch_id: vswitch_id:
description: The ID of the vswitch in which the instance is running. description: The ID of the vswitch in which the instance is running.
returned: always returned: always
type: string type: str
sample: vsw-dew00abcdef sample: vsw-dew00abcdef
vpc_id: vpc_id:
description: The ID of the VPC the instance is in. description: The ID of the VPC the instance is in.

26
lib/ansible/modules/cloud/amazon/_ec2_ami_find.py
View file

@ -168,12 +168,12 @@ RETURN = '''
ami_id: ami_id:
description: id of found amazon image description: id of found amazon image
returned: when AMI found returned: when AMI found
type: string type: str
sample: "ami-e9095e8c" sample: "ami-e9095e8c"
architecture: architecture:
description: architecture of image description: architecture of image
returned: when AMI found returned: when AMI found
type: string type: str
sample: "x86_64" sample: "x86_64"
block_device_mapping: block_device_mapping:
description: block device mapping associated with image description: block device mapping associated with image
@ -190,17 +190,17 @@ block_device_mapping:
creationDate: creationDate:
description: creation date of image description: creation date of image
returned: when AMI found returned: when AMI found
type: string type: str
sample: "2015-10-15T22:43:44.000Z" sample: "2015-10-15T22:43:44.000Z"
description: description:
description: description of image description: description of image
returned: when AMI found returned: when AMI found
type: string type: str
sample: "test-server01" sample: "test-server01"
hypervisor: hypervisor:
description: type of hypervisor description: type of hypervisor
returned: when AMI found returned: when AMI found
type: string type: str
sample: "xen" sample: "xen"
is_public: is_public:
description: whether image is public description: whether image is public
@ -210,37 +210,37 @@ is_public:
location: location:
description: location of image description: location of image
returned: when AMI found returned: when AMI found
type: string type: str
sample: "435210894375/test-server01-20151015-234343" sample: "435210894375/test-server01-20151015-234343"
name: name:
description: ami name of image description: ami name of image
returned: when AMI found returned: when AMI found
type: string type: str
sample: "test-server01-20151015-234343" sample: "test-server01-20151015-234343"
owner_id: owner_id:
description: owner of image description: owner of image
returned: when AMI found returned: when AMI found
type: string type: str
sample: "435210894375" sample: "435210894375"
platform: platform:
description: platform of image description: platform of image
returned: when AMI found returned: when AMI found
type: string type: str
sample: null sample: null
root_device_name: root_device_name:
description: root device name of image description: root device name of image
returned: when AMI found returned: when AMI found
type: string type: str
sample: "/dev/xvda" sample: "/dev/xvda"
root_device_type: root_device_type:
description: root device type of image description: root device type of image
returned: when AMI found returned: when AMI found
type: string type: str
sample: "ebs" sample: "ebs"
state: state:
description: state of image description: state of image
returned: when AMI found returned: when AMI found
type: string type: str
sample: "available" sample: "available"
tags: tags:
description: tags assigned to image description: tags assigned to image
@ -254,7 +254,7 @@ tags:
virtualization_type: virtualization_type:
description: image virtualization type description: image virtualization type
returned: when AMI found returned: when AMI found
type: string type: str
sample: "hvm" sample: "hvm"
''' '''

50
lib/ansible/modules/cloud/amazon/aws_acm_facts.py
View file

@ -56,27 +56,27 @@ certificates:
description: The ACM Certificate body description: The ACM Certificate body
returned: when certificate creation is complete returned: when certificate creation is complete
sample: '-----BEGIN CERTIFICATE-----\\nMII.....-----END CERTIFICATE-----\\n' sample: '-----BEGIN CERTIFICATE-----\\nMII.....-----END CERTIFICATE-----\\n'
type: string type: str
certificate_arn: certificate_arn:
description: Certificate ARN description: Certificate ARN
returned: always returned: always
sample: arn:aws:acm:ap-southeast-2:123456789012:certificate/abcd1234-abcd-1234-abcd-123456789abc sample: arn:aws:acm:ap-southeast-2:123456789012:certificate/abcd1234-abcd-1234-abcd-123456789abc
type: string type: str
certificate_chain: certificate_chain:
description: Full certificate chain for the certificate description: Full certificate chain for the certificate
returned: when certificate creation is complete returned: when certificate creation is complete
sample: '-----BEGIN CERTIFICATE-----\\nMII...\\n-----END CERTIFICATE-----\\n-----BEGIN CERTIFICATE-----\\n...' sample: '-----BEGIN CERTIFICATE-----\\nMII...\\n-----END CERTIFICATE-----\\n-----BEGIN CERTIFICATE-----\\n...'
type: string type: str
created_at: created_at:
description: Date certificate was created description: Date certificate was created
returned: always returned: always
sample: '2017-08-15T10:31:19+10:00' sample: '2017-08-15T10:31:19+10:00'
type: string type: str
domain_name: domain_name:
description: Domain name for the certificate description: Domain name for the certificate
returned: always returned: always
sample: '*.example.com' sample: '*.example.com'
type: string type: str
domain_validation_options: domain_validation_options:
description: Options used by ACM to validate the certificate description: Options used by ACM to validate the certificate
returned: when certificate type is AMAZON_ISSUED returned: when certificate type is AMAZON_ISSUED
@ -86,12 +86,12 @@ certificates:
description: Fully qualified domain name of the certificate description: Fully qualified domain name of the certificate
returned: always returned: always
sample: example.com sample: example.com
type: string type: str
validation_domain: validation_domain:
description: The domain name ACM used to send validation emails description: The domain name ACM used to send validation emails
returned: always returned: always
sample: example.com sample: example.com
type: string type: str
validation_emails: validation_emails:
description: A list of email addresses that ACM used to send domain validation emails description: A list of email addresses that ACM used to send domain validation emails
returned: always returned: always
@ -103,11 +103,11 @@ certificates:
description: Validation status of the domain description: Validation status of the domain
returned: always returned: always
sample: SUCCESS sample: SUCCESS
type: string type: str
failure_reason: failure_reason:
description: Reason certificate request failed description: Reason certificate request failed
returned: only when certificate issuing failed returned: only when certificate issuing failed
type: string type: str
sample: NO_AVAILABLE_CONTACTS sample: NO_AVAILABLE_CONTACTS
in_use_by: in_use_by:
description: A list of ARNs for the AWS resources that are using the certificate. description: A list of ARNs for the AWS resources that are using the certificate.
@ -118,27 +118,27 @@ certificates:
description: Date certificate was issued description: Date certificate was issued
returned: always returned: always
sample: '2017-01-01T00:00:00+10:00' sample: '2017-01-01T00:00:00+10:00'
type: string type: str
issuer: issuer:
description: Issuer of the certificate description: Issuer of the certificate
returned: always returned: always
sample: Amazon sample: Amazon
type: string type: str
key_algorithm: key_algorithm:
description: Algorithm used to generate the certificate description: Algorithm used to generate the certificate
returned: always returned: always
sample: RSA-2048 sample: RSA-2048
type: string type: str
not_after: not_after:
description: Date after which the certificate is not valid description: Date after which the certificate is not valid
returned: always returned: always
sample: '2019-01-01T00:00:00+10:00' sample: '2019-01-01T00:00:00+10:00'
type: string type: str
not_before: not_before:
description: Date before which the certificate is not valid description: Date before which the certificate is not valid
returned: always returned: always
sample: '2017-01-01T00:00:00+10:00' sample: '2017-01-01T00:00:00+10:00'
type: string type: str
renewal_summary: renewal_summary:
description: Information about managed renewal process description: Information about managed renewal process
returned: when certificate is issued by Amazon and a renewal has been started returned: when certificate is issued by Amazon and a renewal has been started
@ -153,12 +153,12 @@ certificates:
description: Fully qualified domain name of the certificate description: Fully qualified domain name of the certificate
returned: always returned: always
sample: example.com sample: example.com
type: string type: str
validation_domain: validation_domain:
description: The domain name ACM used to send validation emails description: The domain name ACM used to send validation emails
returned: always returned: always
sample: example.com sample: example.com
type: string type: str
validation_emails: validation_emails:
description: A list of email addresses that ACM used to send domain validation emails description: A list of email addresses that ACM used to send domain validation emails
returned: always returned: always
@ -170,42 +170,42 @@ certificates:
description: Validation status of the domain description: Validation status of the domain
returned: always returned: always
sample: SUCCESS sample: SUCCESS
type: string type: str
renewal_status: renewal_status:
description: Status of the domain renewal description: Status of the domain renewal
returned: always returned: always
sample: PENDING_AUTO_RENEWAL sample: PENDING_AUTO_RENEWAL
type: string type: str
revocation_reason: revocation_reason:
description: Reason for certificate revocation description: Reason for certificate revocation
returned: when the certificate has been revoked returned: when the certificate has been revoked
sample: SUPERCEDED sample: SUPERCEDED
type: string type: str
revoked_at: revoked_at:
description: Date certificate was revoked description: Date certificate was revoked
returned: when the certificate has been revoked returned: when the certificate has been revoked
sample: '2017-09-01T10:00:00+10:00' sample: '2017-09-01T10:00:00+10:00'
type: string type: str
serial: serial:
description: The serial number of the certificate description: The serial number of the certificate
returned: always returned: always
sample: 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f sample: 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f
type: string type: str
signature_algorithm: signature_algorithm:
description: Algorithm used to sign the certificate description: Algorithm used to sign the certificate
returned: always returned: always
sample: SHA256WITHRSA sample: SHA256WITHRSA
type: string type: str
status: status:
description: Status of the certificate in ACM description: Status of the certificate in ACM
returned: always returned: always
sample: ISSUED sample: ISSUED
type: string type: str
subject: subject:
description: The name of the entity that is associated with the public key contained in the certificate description: The name of the entity that is associated with the public key contained in the certificate
returned: always returned: always
sample: CN=*.example.com sample: CN=*.example.com
type: string type: str
subject_alternative_names: subject_alternative_names:
description: Subject Alternative Names for the certificate description: Subject Alternative Names for the certificate
returned: always returned: always
@ -223,7 +223,7 @@ certificates:
description: The source of the certificate description: The source of the certificate
returned: always returned: always
sample: AMAZON_ISSUED sample: AMAZON_ISSUED
type: string type: str
''' '''
import traceback import traceback

28
lib/ansible/modules/cloud/amazon/aws_application_scaling_policy.py
View file

@ -139,38 +139,38 @@ alarms:
alarm_arn: alarm_arn:
description: The Amazon Resource Name (ARN) of the alarm description: The Amazon Resource Name (ARN) of the alarm
returned: when state present returned: when state present
type: string type: str
alarm_name: alarm_name:
description: The name of the alarm description: The name of the alarm
returned: when state present returned: when state present
type: string type: str
service_namespace: service_namespace:
description: The namespace of the AWS service. description: The namespace of the AWS service.
returned: when state present returned: when state present
type: string type: str
sample: ecs sample: ecs
resource_id: resource_id:
description: The identifier of the resource associated with the scalable target. description: The identifier of the resource associated with the scalable target.
returned: when state present returned: when state present
type: string type: str
sample: service/cluster-name/service-name sample: service/cluster-name/service-name
scalable_dimension: scalable_dimension:
description: The scalable dimension associated with the scalable target. description: The scalable dimension associated with the scalable target.
returned: when state present returned: when state present
type: string type: str
sample: ecs:service:DesiredCount sample: ecs:service:DesiredCount
policy_arn: policy_arn:
description: The Amazon Resource Name (ARN) of the scaling policy.. description: The Amazon Resource Name (ARN) of the scaling policy..
returned: when state present returned: when state present
type: string type: str
policy_name: policy_name:
description: The name of the scaling policy. description: The name of the scaling policy.
returned: when state present returned: when state present
type: string type: str
policy_type: policy_type:
description: The policy type. description: The policy type.
returned: when state present returned: when state present
type: string type: str
min_capacity: min_capacity:
description: The minimum value to scale to in response to a scale in event. Required if I(state) is C(present). description: The minimum value to scale to in response to a scale in event. Required if I(state) is C(present).
returned: when state present returned: when state present
@ -184,7 +184,7 @@ max_capacity:
role_arn: role_arn:
description: The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf. Required if I(state) is C(present). description: The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf. Required if I(state) is C(present).
returned: when state present returned: when state present
type: string type: str
sample: arn:aws:iam::123456789123:role/roleName sample: arn:aws:iam::123456789123:role/roleName
step_scaling_policy_configuration: step_scaling_policy_configuration:
description: The step scaling policy. description: The step scaling policy.
@ -194,7 +194,7 @@ step_scaling_policy_configuration:
adjustment_type: adjustment_type:
description: The adjustment type description: The adjustment type
returned: when state present and the policy type is StepScaling returned: when state present and the policy type is StepScaling
type: string type: str
sample: "ChangeInCapacity, PercentChangeInCapacity, ExactCapacity" sample: "ChangeInCapacity, PercentChangeInCapacity, ExactCapacity"
cooldown: cooldown:
description: The amount of time, in seconds, after a scaling activity completes description: The amount of time, in seconds, after a scaling activity completes
@ -205,7 +205,7 @@ step_scaling_policy_configuration:
metric_aggregation_type: metric_aggregation_type:
description: The aggregation type for the CloudWatch metrics description: The aggregation type for the CloudWatch metrics
returned: when state present and the policy type is StepScaling returned: when state present and the policy type is StepScaling
type: string type: str
sample: "Average, Minimum, Maximum" sample: "Average, Minimum, Maximum"
step_adjustments: step_adjustments:
description: A set of adjustments that enable you to scale based on the size of the alarm breach description: A set of adjustments that enable you to scale based on the size of the alarm breach
@ -224,12 +224,12 @@ target_tracking_scaling_policy_configuration:
predefined_metric_type: predefined_metric_type:
description: The metric type description: The metric type
returned: when state present and the policy type is TargetTrackingScaling returned: when state present and the policy type is TargetTrackingScaling
type: string type: str
sample: "ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization" sample: "ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization"
resource_label: resource_label:
description: Identifies the resource associated with the metric type description: Identifies the resource associated with the metric type
returned: when metric type is ALBRequestCountPerTarget returned: when metric type is ALBRequestCountPerTarget
type: string type: str
scale_in_cooldown: scale_in_cooldown:
description: The amount of time, in seconds, after a scale in activity completes before another scale in activity can start description: The amount of time, in seconds, after a scale in activity completes before another scale in activity can start
returned: when state present and the policy type is TargetTrackingScaling returned: when state present and the policy type is TargetTrackingScaling
@ -248,7 +248,7 @@ target_tracking_scaling_policy_configuration:
creation_time: creation_time:
description: The Unix timestamp for when the scalable target was created. description: The Unix timestamp for when the scalable target was created.
returned: when state present returned: when state present
type: string type: str
sample: '2017-09-28T08:22:51.881000-03:00' sample: '2017-09-28T08:22:51.881000-03:00'
''' # NOQA ''' # NOQA

8
lib/ansible/modules/cloud/amazon/aws_caller_facts.py
View file

@ -39,24 +39,24 @@ RETURN = '''
account: account:
description: The account id the access credentials are associated with. description: The account id the access credentials are associated with.
returned: success returned: success
type: string type: str
sample: "123456789012" sample: "123456789012"
account_alias: account_alias:
description: The account alias the access credentials are associated with. description: The account alias the access credentials are associated with.
returned: when caller has the iam:ListAccountAliases permission returned: when caller has the iam:ListAccountAliases permission
type: string type: str
sample: "acme-production" sample: "acme-production"
arn: arn:
description: The arn identifying the user the credentials are associated with. description: The arn identifying the user the credentials are associated with.
returned: success returned: success
type: string type: str
sample: arn:aws:sts::123456789012:federated-user/my-federated-user-name sample: arn:aws:sts::123456789012:federated-user/my-federated-user-name
user_id: user_id:
description: | description: |
The user id the access credentials are associated with. Note that this may not correspond to The user id the access credentials are associated with. Note that this may not correspond to
anything you can look up in the case of roles or federated identities. anything you can look up in the case of roles or federated identities.
returned: success returned: success
type: string type: str
sample: 123456789012:my-federated-user-name sample: 123456789012:my-federated-user-name
''' '''

22
lib/ansible/modules/cloud/amazon/aws_codecommit.py
View file

@ -51,22 +51,22 @@ repository_metadata:
account_id: account_id:
description: "The ID of the AWS account associated with the repository." description: "The ID of the AWS account associated with the repository."
returned: when state is present returned: when state is present
type: string type: str
sample: "268342293637" sample: "268342293637"
arn: arn:
description: "The Amazon Resource Name (ARN) of the repository." description: "The Amazon Resource Name (ARN) of the repository."
returned: when state is present returned: when state is present
type: string type: str
sample: "arn:aws:codecommit:ap-northeast-1:268342293637:username" sample: "arn:aws:codecommit:ap-northeast-1:268342293637:username"
clone_url_http: clone_url_http:
description: "The URL to use for cloning the repository over HTTPS." description: "The URL to use for cloning the repository over HTTPS."
returned: when state is present returned: when state is present
type: string type: str
sample: "https://git-codecommit.ap-northeast-1.amazonaws.com/v1/repos/reponame" sample: "https://git-codecommit.ap-northeast-1.amazonaws.com/v1/repos/reponame"
clone_url_ssh: clone_url_ssh:
description: "The URL to use for cloning the repository over SSH." description: "The URL to use for cloning the repository over SSH."
returned: when state is present returned: when state is present
type: string type: str
sample: "ssh://git-codecommit.ap-northeast-1.amazonaws.com/v1/repos/reponame" sample: "ssh://git-codecommit.ap-northeast-1.amazonaws.com/v1/repos/reponame"
creation_date: creation_date:
description: "The date and time the repository was created, in timestamp format." description: "The date and time the repository was created, in timestamp format."
@ -76,22 +76,22 @@ repository_metadata:
last_modified_date: last_modified_date:
description: "The date and time the repository was last modified, in timestamp format." description: "The date and time the repository was last modified, in timestamp format."
returned: when state is present returned: when state is present
type: string type: str
sample: "2018-10-16T13:21:41.261000+09:00" sample: "2018-10-16T13:21:41.261000+09:00"
repository_description: repository_description:
description: "A comment or description about the repository." description: "A comment or description about the repository."
returned: when state is present returned: when state is present
type: string type: str
sample: "test from ptux" sample: "test from ptux"
repository_id: repository_id:
description: "The ID of the repository that was created or deleted" description: "The ID of the repository that was created or deleted"
returned: always returned: always
type: string type: str
sample: "e62a5c54-i879-497b-b62f-9f99e4ebfk8e" sample: "e62a5c54-i879-497b-b62f-9f99e4ebfk8e"
repository_name: repository_name:
description: "The repository's name." description: "The repository's name."
returned: when state is present returned: when state is present
type: string type: str
sample: "reponame" sample: "reponame"
response_metadata: response_metadata:
@ -106,17 +106,17 @@ response_metadata:
http_status_code: http_status_code:
description: "http status code of http response" description: "http status code of http response"
returned: always returned: always
type: string type: str
sample: "200" sample: "200"
request_id: request_id:
description: "http request id" description: "http request id"
returned: always returned: always
type: string type: str
sample: "fb49cfca-d0fa-11e8-85cb-b3cc4b5045ef" sample: "fb49cfca-d0fa-11e8-85cb-b3cc4b5045ef"
retry_attempts: retry_attempts:
description: "numbers of retry attempts" description: "numbers of retry attempts"
returned: always returned: always
type: string type: str
sample: "0" sample: "0"
''' '''

18
lib/ansible/modules/cloud/amazon/aws_direct_connect_connection.py
View file

@ -101,47 +101,47 @@ connection:
aws_device: aws_device:
description: The endpoint which the physical connection terminates on. description: The endpoint which the physical connection terminates on.
returned: when the requested state is no longer 'requested' returned: when the requested state is no longer 'requested'
type: string type: str
sample: EqDC2-12pmo7hemtz1z sample: EqDC2-12pmo7hemtz1z
bandwidth: bandwidth:
description: The bandwidth of the connection. description: The bandwidth of the connection.
returned: always returned: always
type: string type: str
sample: 1Gbps sample: 1Gbps
connection_id: connection_id:
description: The ID of the connection. description: The ID of the connection.
returned: always returned: always
type: string type: str
sample: dxcon-ffy9ywed sample: dxcon-ffy9ywed
connection_name: connection_name:
description: The name of the connection. description: The name of the connection.
returned: always returned: always
type: string type: str
sample: ansible-test-connection sample: ansible-test-connection
connection_state: connection_state:
description: The state of the connection. description: The state of the connection.
returned: always returned: always
type: string type: str
sample: pending sample: pending
loa_issue_time: loa_issue_time:
description: The issue time of the connection's Letter of Authorization - Connecting Facility Assignment. description: The issue time of the connection's Letter of Authorization - Connecting Facility Assignment.
returned: when the LOA-CFA has been issued (the connection state will no longer be 'requested') returned: when the LOA-CFA has been issued (the connection state will no longer be 'requested')
type: string type: str
sample: '2018-03-20T17:36:26-04:00' sample: '2018-03-20T17:36:26-04:00'
location: location:
description: The location of the connection. description: The location of the connection.
returned: always returned: always
type: string type: str
sample: EqDC2 sample: EqDC2
owner_account: owner_account:
description: The account that owns the direct connect connection. description: The account that owns the direct connect connection.
returned: always returned: always
type: string type: str
sample: '123456789012' sample: '123456789012'
region: region:
description: The region in which the connection exists. description: The region in which the connection exists.
returned: always returned: always
type: string type: str
sample: us-east-1 sample: us-east-1
""" """

40
lib/ansible/modules/cloud/amazon/aws_direct_connect_virtual_interface.py
View file

@ -72,12 +72,12 @@ RETURN = '''
address_family: address_family:
description: The address family for the BGP peer. description: The address family for the BGP peer.
returned: always returned: always
type: string type: str
sample: ipv4 sample: ipv4
amazon_address: amazon_address:
description: IP address assigned to the Amazon interface. description: IP address assigned to the Amazon interface.
returned: always returned: always
type: string type: str
sample: 169.254.255.1/30 sample: 169.254.255.1/30
asn: asn:
description: The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. description: The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
@ -87,7 +87,7 @@ asn:
auth_key: auth_key:
description: The authentication key for BGP configuration. description: The authentication key for BGP configuration.
returned: always returned: always
type: string type: str
sample: 0xZ59Y1JZ2oDOSh6YriIlyRE sample: 0xZ59Y1JZ2oDOSh6YriIlyRE
bgp_peers: bgp_peers:
description: A list of the BGP peers configured on this virtual interface. description: A list of the BGP peers configured on this virtual interface.
@ -97,12 +97,12 @@ bgp_peers:
address_family: address_family:
description: The address family for the BGP peer. description: The address family for the BGP peer.
returned: always returned: always
type: string type: str
sample: ipv4 sample: ipv4
amazon_address: amazon_address:
description: IP address assigned to the Amazon interface. description: IP address assigned to the Amazon interface.
returned: always returned: always
type: string type: str
sample: 169.254.255.1/30 sample: 169.254.255.1/30
asn: asn:
description: The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. description: The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
@ -112,22 +112,22 @@ bgp_peers:
auth_key: auth_key:
description: The authentication key for BGP configuration. description: The authentication key for BGP configuration.
returned: always returned: always
type: string type: str
sample: 0xZ59Y1JZ2oDOSh6YriIlyRE sample: 0xZ59Y1JZ2oDOSh6YriIlyRE
bgp_peer_state: bgp_peer_state:
description: The state of the BGP peer (verifying, pending, available) description: The state of the BGP peer (verifying, pending, available)
returned: always returned: always
type: string type: str
sample: available sample: available
bgp_status: bgp_status:
description: The up/down state of the BGP peer. description: The up/down state of the BGP peer.
returned: always returned: always
type: string type: str
sample: up sample: up
customer_address: customer_address:
description: IP address assigned to the customer interface. description: IP address assigned to the customer interface.
returned: always returned: always
type: string type: str
sample: 169.254.255.2/30 sample: 169.254.255.2/30
changed: changed:
description: Indicated if the virtual interface has been created/modified/deleted description: Indicated if the virtual interface has been created/modified/deleted
@ -139,26 +139,26 @@ connection_id:
- The ID of the connection. This field is also used as the ID type for operations that - The ID of the connection. This field is also used as the ID type for operations that
use multiple connection types (LAG, interconnect, and/or connection). use multiple connection types (LAG, interconnect, and/or connection).
returned: always returned: always
type: string type: str
sample: dxcon-fgb175av sample: dxcon-fgb175av
customer_address: customer_address:
description: IP address assigned to the customer interface. description: IP address assigned to the customer interface.
returned: always returned: always
type: string type: str
sample: 169.254.255.2/30 sample: 169.254.255.2/30
customer_router_config: customer_router_config:
description: Information for generating the customer router configuration. description: Information for generating the customer router configuration.
returned: always returned: always
type: string type: str
location: location:
description: Where the connection is located. description: Where the connection is located.
returned: always returned: always
type: string type: str
sample: EqDC2 sample: EqDC2
owner_account: owner_account:
description: The AWS account that will own the new virtual interface. description: The AWS account that will own the new virtual interface.
returned: always returned: always
type: string type: str
sample: '123456789012' sample: '123456789012'
route_filter_prefixes: route_filter_prefixes:
description: A list of routes to be advertised to the AWS network in this region (public virtual interface). description: A list of routes to be advertised to the AWS network in this region (public virtual interface).
@ -168,32 +168,32 @@ route_filter_prefixes:
cidr: cidr:
description: A routes to be advertised to the AWS network in this region. description: A routes to be advertised to the AWS network in this region.
returned: always returned: always
type: string type: str
sample: 54.227.92.216/30 sample: 54.227.92.216/30
virtual_gateway_id: virtual_gateway_id:
description: The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces. description: The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.
returned: when I(public=False) returned: when I(public=False)
type: string type: str
sample: vgw-f3ce259a sample: vgw-f3ce259a
virtual_interface_id: virtual_interface_id:
description: The ID of the virtual interface. description: The ID of the virtual interface.
returned: always returned: always
type: string type: str
sample: dxvif-fh0w7cex sample: dxvif-fh0w7cex
virtual_interface_name: virtual_interface_name:
description: The name of the virtual interface assigned by the customer. description: The name of the virtual interface assigned by the customer.
returned: always returned: always
type: string type: str
sample: test_virtual_interface sample: test_virtual_interface
virtual_interface_state: virtual_interface_state:
description: State of the virtual interface (confirming, verifying, pending, available, down, rejected). description: State of the virtual interface (confirming, verifying, pending, available, down, rejected).
returned: always returned: always
type: string type: str
sample: available sample: available
virtual_interface_type: virtual_interface_type:
description: The type of virtual interface (private, public). description: The type of virtual interface (private, public).
returned: always returned: always
type: string type: str
sample: private sample: private
vlan: vlan:
description: The VLAN ID. description: The VLAN ID.

18
lib/ansible/modules/cloud/amazon/aws_eks_cluster.py
View file

@ -80,7 +80,7 @@ RETURN = '''
arn: arn:
description: ARN of the EKS cluster description: ARN of the EKS cluster
returned: when state is present returned: when state is present
type: string type: str
sample: arn:aws:eks:us-west-2:111111111111:cluster/my-eks-cluster sample: arn:aws:eks:us-west-2:111111111111:cluster/my-eks-cluster
certificate_authority: certificate_authority:
description: Dictionary containing Certificate Authority Data for cluster description: Dictionary containing Certificate Authority Data for cluster
@ -90,21 +90,21 @@ certificate_authority:
data: data:
description: Base-64 encoded Certificate Authority Data for cluster description: Base-64 encoded Certificate Authority Data for cluster
returned: when the cluster has been created and is active returned: when the cluster has been created and is active
type: string type: str
endpoint: endpoint:
description: Kubernetes API server endpoint description: Kubernetes API server endpoint
returned: when the cluster has been created and is active returned: when the cluster has been created and is active
type: string type: str
sample: https://API_SERVER_ENDPOINT.yl4.us-west-2.eks.amazonaws.com sample: https://API_SERVER_ENDPOINT.yl4.us-west-2.eks.amazonaws.com
created_at: created_at:
description: Cluster creation date and time description: Cluster creation date and time
returned: when state is present returned: when state is present
type: string type: str
sample: '2018-06-06T11:56:56.242000+00:00' sample: '2018-06-06T11:56:56.242000+00:00'
name: name:
description: EKS cluster name description: EKS cluster name
returned: when state is present returned: when state is present
type: string type: str
sample: my-eks-cluster sample: my-eks-cluster
resources_vpc_config: resources_vpc_config:
description: VPC configuration of the cluster description: VPC configuration of the cluster
@ -129,24 +129,24 @@ resources_vpc_config:
vpc_id: vpc_id:
description: VPC id description: VPC id
returned: always returned: always
type: string type: str
sample: vpc-a1b2c3d4 sample: vpc-a1b2c3d4
role_arn: role_arn:
description: ARN of the IAM role used by the cluster description: ARN of the IAM role used by the cluster
returned: when state is present returned: when state is present
type: string type: str
sample: arn:aws:iam::111111111111:role/aws_eks_cluster_role sample: arn:aws:iam::111111111111:role/aws_eks_cluster_role
status: status:
description: status of the EKS cluster description: status of the EKS cluster
returned: when state is present returned: when state is present
type: string type: str
sample: sample:
- CREATING - CREATING
- ACTIVE - ACTIVE
version: version:
description: Kubernetes version of the cluster description: Kubernetes version of the cluster
returned: when state is present returned: when state is present
type: string type: str
sample: '1.10' sample: '1.10'
''' '''

2
lib/ansible/modules/cloud/amazon/aws_elasticbeanstalk_app.py
View file

@ -77,7 +77,7 @@ app:
output: output:
description: message indicating what change will occur description: message indicating what change will occur
returned: in check mode returned: in check mode
type: string type: str
sample: App is up-to-date sample: App is up-to-date
''' '''

10
lib/ansible/modules/cloud/amazon/aws_glue_connection.py
View file

@ -90,22 +90,22 @@ connection_properties:
connection_type: connection_type:
description: The type of the connection. description: The type of the connection.
returned: when state is present returned: when state is present
type: string type: str
sample: JDBC sample: JDBC
creation_time: creation_time:
description: The time this connection definition was created. description: The time this connection definition was created.
returned: when state is present returned: when state is present
type: string type: str
sample: "2018-04-21T05:19:58.326000+00:00" sample: "2018-04-21T05:19:58.326000+00:00"
description: description:
description: Description of the job being defined. description: Description of the job being defined.
returned: when state is present returned: when state is present
type: string type: str
sample: My first Glue job sample: My first Glue job
last_updated_time: last_updated_time:
description: The last time this connection definition was updated. description: The last time this connection definition was updated.
returned: when state is present returned: when state is present
type: string type: str
sample: "2018-04-21T05:19:58.326000+00:00" sample: "2018-04-21T05:19:58.326000+00:00"
match_criteria: match_criteria:
description: A list of criteria that can be used in selecting this connection. description: A list of criteria that can be used in selecting this connection.
@ -115,7 +115,7 @@ match_criteria:
name: name:
description: The name of the connection definition. description: The name of the connection definition.
returned: when state is present returned: when state is present
type: string type: str
sample: my-glue-connection sample: my-glue-connection
physical_connection_requirements: physical_connection_requirements:
description: A dict of physical connection requirements, such as VPC and SecurityGroup, description: A dict of physical connection requirements, such as VPC and SecurityGroup,

16
lib/ansible/modules/cloud/amazon/aws_glue_job.py
View file

@ -109,12 +109,12 @@ command:
name: name:
description: The name of the job command. description: The name of the job command.
returned: when state is present returned: when state is present
type: string type: str
sample: glueetl sample: glueetl
script_location: script_location:
description: Specifies the S3 path to a script that executes a job. description: Specifies the S3 path to a script that executes a job.
returned: when state is present returned: when state is present
type: string type: str
sample: mybucket/myscript.py sample: mybucket/myscript.py
connections: connections:
description: The connections used for this job. description: The connections used for this job.
@ -124,7 +124,7 @@ connections:
created_on: created_on:
description: The time and date that this job definition was created. description: The time and date that this job definition was created.
returned: when state is present returned: when state is present
type: string type: str
sample: "2018-04-21T05:19:58.326000+00:00" sample: "2018-04-21T05:19:58.326000+00:00"
default_arguments: default_arguments:
description: The default arguments for this job, specified as name-value pairs. description: The default arguments for this job, specified as name-value pairs.
@ -134,12 +134,12 @@ default_arguments:
description: description:
description: Description of the job being defined. description: Description of the job being defined.
returned: when state is present returned: when state is present
type: string type: str
sample: My first Glue job sample: My first Glue job
job_name: job_name:
description: The name of the AWS Glue job. description: The name of the AWS Glue job.
returned: always returned: always
type: string type: str
sample: my-glue-job sample: my-glue-job
execution_property: execution_property:
description: An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job. description: An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
@ -156,7 +156,7 @@ execution_property:
last_modified_on: last_modified_on:
description: The last point in time when this job definition was modified. description: The last point in time when this job definition was modified.
returned: when state is present returned: when state is present
type: string type: str
sample: "2018-04-21T05:19:58.326000+00:00" sample: "2018-04-21T05:19:58.326000+00:00"
max_retries: max_retries:
description: The maximum number of times to retry this job after a JobRun fails. description: The maximum number of times to retry this job after a JobRun fails.
@ -166,12 +166,12 @@ max_retries:
name: name:
description: The name assigned to this job definition. description: The name assigned to this job definition.
returned: when state is present returned: when state is present
type: string type: str
sample: my-glue-job sample: my-glue-job
role: role:
description: The name or ARN of the IAM role associated with this job. description: The name or ARN of the IAM role associated with this job.
returned: when state is present returned: when state is present
type: string type: str
sample: my-iam-role sample: my-iam-role
timeout: timeout:
description: The job timeout in minutes. description: The job timeout in minutes.

10
lib/ansible/modules/cloud/amazon/aws_inspector_target.py
View file

@ -64,23 +64,23 @@ RETURN = '''
arn: arn:
description: The ARN that specifies the Amazon Inspector assessment target. description: The ARN that specifies the Amazon Inspector assessment target.
returned: success returned: success
type: string type: str
sample: "arn:aws:inspector:eu-west-1:123456789012:target/0-O4LnL7n1" sample: "arn:aws:inspector:eu-west-1:123456789012:target/0-O4LnL7n1"
created_at: created_at:
description: The time at which the assessment target was created. description: The time at which the assessment target was created.
returned: success returned: success
type: string type: str
sample: "2018-01-29T13:48:51.958000+00:00" sample: "2018-01-29T13:48:51.958000+00:00"
name: name:
description: The name of the Amazon Inspector assessment target. description: The name of the Amazon Inspector assessment target.
returned: success returned: success
type: string type: str
sample: "my_target" sample: "my_target"
resource_group_arn: resource_group_arn:
description: The ARN that specifies the resource group that is associated description: The ARN that specifies the resource group that is associated
with the assessment target. with the assessment target.
returned: success returned: success
type: string type: str
sample: "arn:aws:inspector:eu-west-1:123456789012:resourcegroup/0-qY4gDel8" sample: "arn:aws:inspector:eu-west-1:123456789012:resourcegroup/0-qY4gDel8"
tags: tags:
description: The tags of the resource group that is associated with the description: The tags of the resource group that is associated with the
@ -91,7 +91,7 @@ tags:
updated_at: updated_at:
description: The time at which the assessment target was last updated. description: The time at which the assessment target was last updated.
returned: success returned: success
type: string type: str
sample: "2018-01-29T13:48:51.958000+00:00" sample: "2018-01-29T13:48:51.958000+00:00"
''' '''

2
lib/ansible/modules/cloud/amazon/aws_kms.py
View file

@ -91,7 +91,7 @@ changes_needed:
sample: { "role": "add", "role grant": "add" } sample: { "role": "add", "role grant": "add" }
had_invalid_entries: had_invalid_entries:
description: there are invalid (non-ARN) entries in the KMS entry. These don't count as a change, but will be removed if any changes are being made. description: there are invalid (non-ARN) entries in the KMS entry. These don't count as a change, but will be removed if any changes are being made.
type: boolean type: bool
returned: always returned: always
''' '''

6
lib/ansible/modules/cloud/amazon/aws_s3.py
View file

@ -270,12 +270,12 @@ RETURN = '''
msg: msg:
description: msg indicating the status of the operation description: msg indicating the status of the operation
returned: always returned: always
type: string type: str
sample: PUT operation complete sample: PUT operation complete
url: url:
description: url of the object description: url of the object
returned: (for put and geturl operations) returned: (for put and geturl operations)
type: string type: str
sample: https://my-bucket.s3.amazonaws.com/my-key.txt?AWSAccessKeyId=<access-key>&Expires=1506888865&Signature=<signature> sample: https://my-bucket.s3.amazonaws.com/my-key.txt?AWSAccessKeyId=<access-key>&Expires=1506888865&Signature=<signature>
expiry: expiry:
description: number of seconds the presigned url is valid for description: number of seconds the presigned url is valid for
@ -285,7 +285,7 @@ expiry:
contents: contents:
description: contents of the object as string description: contents of the object as string
returned: (for getstr operation) returned: (for getstr operation)
type: string type: str
sample: "Hello, world!" sample: "Hello, world!"
s3_keys: s3_keys:
description: list of object keys description: list of object keys

4
lib/ansible/modules/cloud/amazon/aws_s3_cors.py
View file

@ -62,12 +62,12 @@ RETURN = '''
changed: changed:
description: check to see if a change was made to the rules description: check to see if a change was made to the rules
returned: always returned: always
type: boolean type: bool
sample: true sample: true
name: name:
description: name of bucket description: name of bucket
returned: always returned: always
type: string type: str
sample: 'bucket-name' sample: 'bucket-name'
rules: rules:
description: list of current rules description: list of current rules

14
lib/ansible/modules/cloud/amazon/aws_ses_identity.py
View file

@ -148,12 +148,12 @@ RETURN = '''
identity: identity:
description: The identity being modified. description: The identity being modified.
returned: success returned: success
type: string type: str
sample: example@example.com sample: example@example.com
identity_arn: identity_arn:
description: The arn of the identity being modified. description: The arn of the identity being modified.
returned: success returned: success
type: string type: str
sample: arn:aws:ses:us-east-1:12345678:identity/example@example.com sample: arn:aws:ses:us-east-1:12345678:identity/example@example.com
verification_attributes: verification_attributes:
description: The verification information for the identity. description: The verification information for the identity.
@ -166,11 +166,11 @@ verification_attributes:
contains: contains:
verification_status: verification_status:
description: The verification status of the identity. description: The verification status of the identity.
type: string type: str
sample: "Pending" sample: "Pending"
verification_token: verification_token:
description: The verification token for a domain identity. description: The verification token for a domain identity.
type: string type: str
notification_attributes: notification_attributes:
description: The notification setup for the identity. description: The notification setup for the identity.
returned: success returned: success
@ -189,17 +189,17 @@ notification_attributes:
description: description:
- The ARN of the topic bounce notifications are delivered to. - The ARN of the topic bounce notifications are delivered to.
- Omitted if bounce notifications are not delivered to a topic. - Omitted if bounce notifications are not delivered to a topic.
type: string type: str
complaint_topic: complaint_topic:
description: description:
- The ARN of the topic complaint notifications are delivered to. - The ARN of the topic complaint notifications are delivered to.
- Omitted if complaint notifications are not delivered to a topic. - Omitted if complaint notifications are not delivered to a topic.
type: string type: str
delivery_topic: delivery_topic:
description: description:
- The ARN of the topic delivery notifications are delivered to. - The ARN of the topic delivery notifications are delivered to.
- Omitted if delivery notifications are not delivered to a topic. - Omitted if delivery notifications are not delivered to a topic.
type: string type: str
forwarding_enabled: forwarding_enabled:
description: Whether or not feedback forwarding is enabled. description: Whether or not feedback forwarding is enabled.
type: bool type: bool

36
lib/ansible/modules/cloud/amazon/aws_sgw_facts.py
View file

@ -57,27 +57,27 @@ gateways:
gateway_arn: gateway_arn:
description: "Storage Gateway ARN" description: "Storage Gateway ARN"
returned: always returned: always
type: string type: str
sample: "arn:aws:storagegateway:eu-west-1:367709993819:gateway/sgw-9999F888" sample: "arn:aws:storagegateway:eu-west-1:367709993819:gateway/sgw-9999F888"
gateway_id: gateway_id:
description: "Storage Gateway ID" description: "Storage Gateway ID"
returned: always returned: always
type: string type: str
sample: "sgw-9999F888" sample: "sgw-9999F888"
gateway_name: gateway_name:
description: "Storage Gateway friendly name" description: "Storage Gateway friendly name"
returned: always returned: always
type: string type: str
sample: "my-sgw-01" sample: "my-sgw-01"
gateway_operational_state: gateway_operational_state:
description: "Storage Gateway operational state" description: "Storage Gateway operational state"
returned: always returned: always
type: string type: str
sample: "ACTIVE" sample: "ACTIVE"
gateway_type: gateway_type:
description: "Storage Gateway type" description: "Storage Gateway type"
returned: always returned: always
type: string type: str
sample: "FILE_S3" sample: "FILE_S3"
file_shares: file_shares:
description: "Storage gateway file shares" description: "Storage gateway file shares"
@ -87,17 +87,17 @@ gateways:
file_share_arn: file_share_arn:
description: "File share ARN" description: "File share ARN"
returned: always returned: always
type: string type: str
sample: "arn:aws:storagegateway:eu-west-1:399805793479:share/share-AF999C88" sample: "arn:aws:storagegateway:eu-west-1:399805793479:share/share-AF999C88"
file_share_id: file_share_id:
description: "File share ID" description: "File share ID"
returned: always returned: always
type: string type: str
sample: "share-AF999C88" sample: "share-AF999C88"
file_share_status: file_share_status:
description: "File share status" description: "File share status"
returned: always returned: always
type: string type: str
sample: "AVAILABLE" sample: "AVAILABLE"
tapes: tapes:
description: "Storage Gateway tapes" description: "Storage Gateway tapes"
@ -107,22 +107,22 @@ gateways:
tape_arn: tape_arn:
description: "Tape ARN" description: "Tape ARN"
returned: always returned: always
type: string type: str
sample: "arn:aws:storagegateway:eu-west-1:399805793479:tape/tape-AF999C88" sample: "arn:aws:storagegateway:eu-west-1:399805793479:tape/tape-AF999C88"
tape_barcode: tape_barcode:
description: "Tape ARN" description: "Tape ARN"
returned: always returned: always
type: string type: str
sample: "tape-AF999C88" sample: "tape-AF999C88"
tape_size_in_bytes: tape_size_in_bytes:
description: "Tape ARN" description: "Tape ARN"
returned: always returned: always
type: integer type: int
sample: 555887569 sample: 555887569
tape_status: tape_status:
description: "Tape ARN" description: "Tape ARN"
returned: always returned: always
type: string type: str
sample: "AVAILABLE" sample: "AVAILABLE"
local_disks: local_disks:
description: "Storage gateway local disks" description: "Storage gateway local disks"
@ -132,32 +132,32 @@ gateways:
disk_allocation_type: disk_allocation_type:
description: "Disk allocation type" description: "Disk allocation type"
returned: always returned: always
type: string type: str
sample: "CACHE STORAGE" sample: "CACHE STORAGE"
disk_id: disk_id:
description: "Disk ID on the system" description: "Disk ID on the system"
returned: always returned: always
type: string type: str
sample: "pci-0000:00:1f.0" sample: "pci-0000:00:1f.0"
disk_node: disk_node:
description: "Disk parent block device" description: "Disk parent block device"
returned: always returned: always
type: string type: str
sample: "/dev/sdb" sample: "/dev/sdb"
disk_path: disk_path:
description: "Disk path used for the cache" description: "Disk path used for the cache"
returned: always returned: always
type: string type: str
sample: "/dev/nvme1n1" sample: "/dev/nvme1n1"
disk_size_in_bytes: disk_size_in_bytes:
description: "Disk size in bytes" description: "Disk size in bytes"
returned: always returned: always
type: integer type: int
sample: 107374182400 sample: 107374182400
disk_status: disk_status:
description: "Disk status" description: "Disk status"
returned: always returned: always
type: string type: str
sample: "present" sample: "present"
''' '''

4
lib/ansible/modules/cloud/amazon/aws_ssm_parameter_store.py
View file

@ -113,11 +113,11 @@ RETURN = '''
put_parameter: put_parameter:
description: Add one or more parameters to the system. description: Add one or more parameters to the system.
returned: success returned: success
type: dictionary type: dict
delete_parameter: delete_parameter:
description: Delete a parameter from the system. description: Delete a parameter from the system.
returned: success returned: success
type: dictionary type: dict
''' '''
from ansible.module_utils.aws.core import AnsibleAWSModule from ansible.module_utils.aws.core import AnsibleAWSModule

56
lib/ansible/modules/cloud/amazon/aws_waf_condition.py
View file

@ -143,12 +143,12 @@ condition:
condition_id: condition_id:
description: type-agnostic ID for the condition description: type-agnostic ID for the condition
returned: when state is present returned: when state is present
type: string type: str
sample: dd74b1ff-8c06-4a4f-897a-6b23605de413 sample: dd74b1ff-8c06-4a4f-897a-6b23605de413
byte_match_set_id: byte_match_set_id:
description: ID for byte match set description: ID for byte match set
returned: always returned: always
type: string type: str
sample: c4882c96-837b-44a2-a762-4ea87dbf812b sample: c4882c96-837b-44a2-a762-4ea87dbf812b
byte_match_tuples: byte_match_tuples:
description: list of byte match tuples description: list of byte match tuples
@ -162,23 +162,23 @@ condition:
contains: contains:
data: data:
description: Which specific header (if type is header) description: Which specific header (if type is header)
type: string type: str
sample: content-type sample: content-type
type: type:
description: Type of field description: Type of field
type: string type: str
sample: HEADER sample: HEADER
positional_constraint: positional_constraint:
description: Position in the field to match description: Position in the field to match
type: string type: str
sample: STARTS_WITH sample: STARTS_WITH
target_string: target_string:
description: String to look for description: String to look for
type: string type: str
sample: Hello sample: Hello
text_transformation: text_transformation:
description: Transformation to apply to the field before matching description: Transformation to apply to the field before matching
type: string type: str
sample: NONE sample: NONE
geo_match_constraints: geo_match_constraints:
description: List of geographical constraints description: List of geographical constraints
@ -187,16 +187,16 @@ condition:
contains: contains:
type: type:
description: Type of geo constraint description: Type of geo constraint
type: string type: str
sample: Country sample: Country
value: value:
description: Value of geo constraint (typically a country code) description: Value of geo constraint (typically a country code)
type: string type: str
sample: AT sample: AT
geo_match_set_id: geo_match_set_id:
description: ID of the geo match set description: ID of the geo match set
returned: when type is geo and state is present returned: when type is geo and state is present
type: string type: str
sample: dd74b1ff-8c06-4a4f-897a-6b23605de413 sample: dd74b1ff-8c06-4a4f-897a-6b23605de413
ip_set_descriptors: ip_set_descriptors:
description: list of IP address filters description: list of IP address filters
@ -206,27 +206,27 @@ condition:
type: type:
description: Type of IP address (IPV4 or IPV6) description: Type of IP address (IPV4 or IPV6)
returned: always returned: always
type: string type: str
sample: IPV4 sample: IPV4
value: value:
description: IP address description: IP address
returned: always returned: always
type: string type: str
sample: 10.0.0.0/8 sample: 10.0.0.0/8
ip_set_id: ip_set_id:
description: ID of condition description: ID of condition
returned: when type is ip and state is present returned: when type is ip and state is present
type: string type: str
sample: 78ad334a-3535-4036-85e6-8e11e745217b sample: 78ad334a-3535-4036-85e6-8e11e745217b
name: name:
description: Name of condition description: Name of condition
returned: when state is present returned: when state is present
type: string type: str
sample: my_waf_condition sample: my_waf_condition
regex_match_set_id: regex_match_set_id:
description: ID of the regex match set description: ID of the regex match set
returned: when type is regex and state is present returned: when type is regex and state is present
type: string type: str
sample: 5ea3f6a8-3cd3-488b-b637-17b79ce7089c sample: 5ea3f6a8-3cd3-488b-b637-17b79ce7089c
regex_match_tuples: regex_match_tuples:
description: List of regex matches description: List of regex matches
@ -240,20 +240,20 @@ condition:
type: type:
description: The field name description: The field name
returned: when type is regex and state is present returned: when type is regex and state is present
type: string type: str
sample: QUERY_STRING sample: QUERY_STRING
regex_pattern_set_id: regex_pattern_set_id:
description: ID of the regex pattern description: ID of the regex pattern
type: string type: str
sample: 6fdf7f2d-9091-445c-aef2-98f3c051ac9e sample: 6fdf7f2d-9091-445c-aef2-98f3c051ac9e
text_transformation: text_transformation:
description: transformation applied to the text before matching description: transformation applied to the text before matching
type: string type: str
sample: NONE sample: NONE
size_constraint_set_id: size_constraint_set_id:
description: ID of the size constraint set description: ID of the size constraint set
returned: when type is size and state is present returned: when type is size and state is present
type: string type: str
sample: de84b4b3-578b-447e-a9a0-0db35c995656 sample: de84b4b3-578b-447e-a9a0-0db35c995656
size_constraints: size_constraints:
description: List of size constraints to apply description: List of size constraints to apply
@ -262,7 +262,7 @@ condition:
contains: contains:
comparison_operator: comparison_operator:
description: Comparison operator to apply description: Comparison operator to apply
type: string type: str
sample: GT sample: GT
field_to_match: field_to_match:
description: Field on which the size constraint is applied description: Field on which the size constraint is applied
@ -270,7 +270,7 @@ condition:
contains: contains:
type: type:
description: Field name description: Field name
type: string type: str
sample: QUERY_STRING sample: QUERY_STRING
size: size:
description: size to compare against the field description: size to compare against the field
@ -278,12 +278,12 @@ condition:
sample: 300 sample: 300
text_transformation: text_transformation:
description: transformation applied to the text before matching description: transformation applied to the text before matching
type: string type: str
sample: NONE sample: NONE
sql_injection_match_set_id: sql_injection_match_set_id:
description: ID of the SQL injection match set description: ID of the SQL injection match set
returned: when type is sql and state is present returned: when type is sql and state is present
type: string type: str
sample: de84b4b3-578b-447e-a9a0-0db35c995656 sample: de84b4b3-578b-447e-a9a0-0db35c995656
sql_injection_match_tuples: sql_injection_match_tuples:
description: List of SQL injection match sets description: List of SQL injection match sets
@ -296,16 +296,16 @@ condition:
contains: contains:
type: type:
description: Field name description: Field name
type: string type: str
sample: QUERY_STRING sample: QUERY_STRING
text_transformation: text_transformation:
description: transformation applied to the text before matching description: transformation applied to the text before matching
type: string type: str
sample: URL_DECODE sample: URL_DECODE
xss_match_set_id: xss_match_set_id:
description: ID of the XSS match set description: ID of the XSS match set
returned: when type is xss and state is present returned: when type is xss and state is present
type: string type: str
sample: de84b4b3-578b-447e-a9a0-0db35c995656 sample: de84b4b3-578b-447e-a9a0-0db35c995656
xss_match_tuples: xss_match_tuples:
description: List of XSS match sets description: List of XSS match sets
@ -318,11 +318,11 @@ condition:
contains: contains:
type: type:
description: Field name description: Field name
type: string type: str
sample: QUERY_STRING sample: QUERY_STRING
text_transformation: text_transformation:
description: transformation applied to the text before matching description: transformation applied to the text before matching
type: string type: str
sample: URL_DECODE sample: URL_DECODE
''' '''

10
lib/ansible/modules/cloud/amazon/aws_waf_facts.py
View file

@ -44,7 +44,7 @@ wafs:
name: name:
description: A friendly name or description of the WebACL description: A friendly name or description of the WebACL
returned: always returned: always
type: string type: str
sample: test_waf sample: test_waf
default_action: default_action:
description: The action to perform if none of the Rules contained in the WebACL match. description: The action to perform if none of the Rules contained in the WebACL match.
@ -54,7 +54,7 @@ wafs:
metric_name: metric_name:
description: A friendly name or description for the metrics for this WebACL description: A friendly name or description for the metrics for this WebACL
returned: always returned: always
type: string type: str
sample: test_waf_metric sample: test_waf_metric
rules: rules:
description: An array that contains the action for each Rule in a WebACL , the priority of the Rule description: An array that contains the action for each Rule in a WebACL , the priority of the Rule
@ -64,17 +64,17 @@ wafs:
action: action:
description: The action to perform if the Rule matches description: The action to perform if the Rule matches
returned: always returned: always
type: string type: str
sample: BLOCK sample: BLOCK
metric_name: metric_name:
description: A friendly name or description for the metrics for this Rule description: A friendly name or description for the metrics for this Rule
returned: always returned: always
type: string type: str
sample: ipblockrule sample: ipblockrule
name: name:
description: A friendly name or description of the Rule description: A friendly name or description of the Rule
returned: always returned: always
type: string type: str
sample: ip_block_rule sample: ip_block_rule
predicates: predicates:
description: The Predicates list contains a Predicate for each description: The Predicates list contains a Predicate for each

10
lib/ansible/modules/cloud/amazon/aws_waf_rule.py
View file

@ -83,12 +83,12 @@ rule:
metric_name: metric_name:
description: Metric name for the rule description: Metric name for the rule
returned: always returned: always
type: string type: str
sample: ansibletest1234rule sample: ansibletest1234rule
name: name:
description: Friendly name for the rule description: Friendly name for the rule
returned: always returned: always
type: string type: str
sample: ansible-test-1234_rule sample: ansible-test-1234_rule
predicates: predicates:
description: List of conditions used in the rule description: List of conditions used in the rule
@ -98,7 +98,7 @@ rule:
data_id: data_id:
description: ID of the condition description: ID of the condition
returned: always returned: always
type: string type: str
sample: 8251acdb-526c-42a8-92bc-d3d13e584166 sample: 8251acdb-526c-42a8-92bc-d3d13e584166
negated: negated:
description: Whether the sense of the condition is negated description: Whether the sense of the condition is negated
@ -108,12 +108,12 @@ rule:
type: type:
description: type of the condition description: type of the condition
returned: always returned: always
type: string type: str
sample: ByteMatch sample: ByteMatch
rule_id: rule_id:
description: ID of the WAF rule description: ID of the WAF rule
returned: always returned: always
type: string type: str
sample: 15de0cbc-9204-4e1f-90e6-69b2f415c261 sample: 15de0cbc-9204-4e1f-90e6-69b2f415c261
''' '''

10
lib/ansible/modules/cloud/amazon/aws_waf_web_acl.py
View file

@ -90,12 +90,12 @@ web_acl:
metric_name: metric_name:
description: Metric name used as an identifier description: Metric name used as an identifier
returned: always returned: always
type: string type: str
sample: mywebacl sample: mywebacl
name: name:
description: Friendly name of the Web ACL description: Friendly name of the Web ACL
returned: always returned: always
type: string type: str
sample: my web acl sample: my web acl
rules: rules:
description: List of rules description: List of rules
@ -116,17 +116,17 @@ web_acl:
rule_id: rule_id:
description: Rule ID description: Rule ID
returned: always returned: always
type: string type: str
sample: a6fc7ab5-287b-479f-8004-7fd0399daf75 sample: a6fc7ab5-287b-479f-8004-7fd0399daf75
type: type:
description: Type of rule (either REGULAR or RATE_BASED) description: Type of rule (either REGULAR or RATE_BASED)
returned: always returned: always
type: string type: str
sample: REGULAR sample: REGULAR
web_acl_id: web_acl_id:
description: Unique identifier of Web ACL description: Unique identifier of Web ACL
returned: always returned: always
type: string type: str
sample: 10fff965-4b6b-46e2-9d78-24f6d2e2d21c sample: 10fff965-4b6b-46e2-9d78-24f6d2e2d21c
''' '''

66
lib/ansible/modules/cloud/amazon/cloudfront_distribution.py
View file

@ -440,7 +440,7 @@ aliases:
arn: arn:
description: Amazon Resource Name of the distribution description: Amazon Resource Name of the distribution
returned: always returned: always
type: string type: str
sample: arn:aws:cloudfront::123456789012:distribution/E1234ABCDEFGHI sample: arn:aws:cloudfront::123456789012:distribution/E1234ABCDEFGHI
cache_behaviors: cache_behaviors:
description: Cloudfront cache behaviors description: Cloudfront cache behaviors
@ -509,7 +509,7 @@ cache_behaviors:
forward: forward:
description: Which cookies to forward to the origin for this cache behavior description: Which cookies to forward to the origin for this cache behavior
returned: always returned: always
type: string type: str
sample: none sample: none
whitelisted_names: whitelisted_names:
description: The names of the cookies to forward to the origin for this cache behavior description: The names of the cookies to forward to the origin for this cache behavior
@ -592,7 +592,7 @@ cache_behaviors:
path_pattern: path_pattern:
description: Path pattern that determines this cache behavior description: Path pattern that determines this cache behavior
returned: always returned: always
type: string type: str
sample: /path/to/files/* sample: /path/to/files/*
smooth_streaming: smooth_streaming:
description: Whether smooth streaming is enabled description: Whether smooth streaming is enabled
@ -602,7 +602,7 @@ cache_behaviors:
target_origin_id: target_origin_id:
description: Id of origin reference by this cache behavior description: Id of origin reference by this cache behavior
returned: always returned: always
type: string type: str
sample: origin_abcd sample: origin_abcd
trusted_signers: trusted_signers:
description: Trusted signers description: Trusted signers
@ -622,7 +622,7 @@ cache_behaviors:
viewer_protocol_policy: viewer_protocol_policy:
description: Policy of how to handle http/https description: Policy of how to handle http/https
returned: always returned: always
type: string type: str
sample: redirect-to-https sample: redirect-to-https
quantity: quantity:
description: Count of cache behaviors description: Count of cache behaviors
@ -633,12 +633,12 @@ cache_behaviors:
caller_reference: caller_reference:
description: Idempotency reference given when creating cloudfront distribution description: Idempotency reference given when creating cloudfront distribution
returned: always returned: always
type: string type: str
sample: '1484796016700' sample: '1484796016700'
comment: comment:
description: Any comments you want to include about the distribution description: Any comments you want to include about the distribution
returned: always returned: always
type: string type: str
sample: 'my first cloudfront distribution' sample: 'my first cloudfront distribution'
custom_error_responses: custom_error_responses:
description: Custom error responses to use for error handling description: Custom error responses to use for error handling
@ -663,12 +663,12 @@ custom_error_responses:
response_code: response_code:
description: Response code to return to the requester description: Response code to return to the requester
returned: always returned: always
type: string type: str
sample: '500' sample: '500'
response_page_path: response_page_path:
description: Path that contains the error page to display description: Path that contains the error page to display
returned: always returned: always
type: string type: str
sample: /errors/5xx.html sample: /errors/5xx.html
quantity: quantity:
description: Count of custom error response items description: Count of custom error response items
@ -737,7 +737,7 @@ default_cache_behavior:
forward: forward:
description: Which cookies to forward to the origin for this cache behavior description: Which cookies to forward to the origin for this cache behavior
returned: always returned: always
type: string type: str
sample: none sample: none
whitelisted_names: whitelisted_names:
description: The names of the cookies to forward to the origin for this cache behavior description: The names of the cookies to forward to the origin for this cache behavior
@ -820,7 +820,7 @@ default_cache_behavior:
path_pattern: path_pattern:
description: Path pattern that determines this cache behavior description: Path pattern that determines this cache behavior
returned: always returned: always
type: string type: str
sample: /path/to/files/* sample: /path/to/files/*
smooth_streaming: smooth_streaming:
description: Whether smooth streaming is enabled description: Whether smooth streaming is enabled
@ -830,7 +830,7 @@ default_cache_behavior:
target_origin_id: target_origin_id:
description: Id of origin reference by this cache behavior description: Id of origin reference by this cache behavior
returned: always returned: always
type: string type: str
sample: origin_abcd sample: origin_abcd
trusted_signers: trusted_signers:
description: Trusted signers description: Trusted signers
@ -850,13 +850,13 @@ default_cache_behavior:
viewer_protocol_policy: viewer_protocol_policy:
description: Policy of how to handle http/https description: Policy of how to handle http/https
returned: always returned: always
type: string type: str
sample: redirect-to-https sample: redirect-to-https
default_root_object: default_root_object:
description: The object that you want CloudFront to request from your origin (for example, index.html) description: The object that you want CloudFront to request from your origin (for example, index.html)
when a viewer requests the root URL for your distribution when a viewer requests the root URL for your distribution
returned: always returned: always
type: string type: str
sample: '' sample: ''
diff: diff:
description: Difference between previous configuration and new configuration description: Difference between previous configuration and new configuration
@ -866,7 +866,7 @@ diff:
domain_name: domain_name:
description: Domain name of cloudfront distribution description: Domain name of cloudfront distribution
returned: always returned: always
type: string type: str
sample: d1vz8pzgurxosf.cloudfront.net sample: d1vz8pzgurxosf.cloudfront.net
enabled: enabled:
description: Whether the cloudfront distribution is enabled or not description: Whether the cloudfront distribution is enabled or not
@ -876,12 +876,12 @@ enabled:
http_version: http_version:
description: Version of HTTP supported by the distribution description: Version of HTTP supported by the distribution
returned: always returned: always
type: string type: str
sample: http2 sample: http2
id: id:
description: Cloudfront distribution ID description: Cloudfront distribution ID
returned: always returned: always
type: string type: str
sample: E123456ABCDEFG sample: E123456ABCDEFG
in_progress_invalidation_batches: in_progress_invalidation_batches:
description: The number of invalidation batches currently in progress description: The number of invalidation batches currently in progress
@ -896,7 +896,7 @@ is_ipv6_enabled:
last_modified_time: last_modified_time:
description: Date and time distribution was last modified description: Date and time distribution was last modified
returned: always returned: always
type: string type: str
sample: '2017-10-13T01:51:12.656000+00:00' sample: '2017-10-13T01:51:12.656000+00:00'
logging: logging:
description: Logging information description: Logging information
@ -906,7 +906,7 @@ logging:
bucket: bucket:
description: S3 bucket logging destination description: S3 bucket logging destination
returned: always returned: always
type: string type: str
sample: logs-example-com.s3.amazonaws.com sample: logs-example-com.s3.amazonaws.com
enabled: enabled:
description: Whether logging is enabled description: Whether logging is enabled
@ -921,7 +921,7 @@ logging:
prefix: prefix:
description: Prefix added to logging object names description: Prefix added to logging object names
returned: always returned: always
type: string type: str
sample: cloudfront/test sample: cloudfront/test
origins: origins:
description: Origins in the cloudfront distribution description: Origins in the cloudfront distribution
@ -966,7 +966,7 @@ origins:
origin_protocol_policy: origin_protocol_policy:
description: Policy of which protocols are supported description: Policy of which protocols are supported
returned: always returned: always
type: string type: str
sample: https-only sample: https-only
origin_read_timeout: origin_read_timeout:
description: Timeout for reads to the origin description: Timeout for reads to the origin
@ -994,17 +994,17 @@ origins:
domain_name: domain_name:
description: Domain name of the origin description: Domain name of the origin
returned: always returned: always
type: string type: str
sample: test-origin.example.com sample: test-origin.example.com
id: id:
description: ID of the origin description: ID of the origin
returned: always returned: always
type: string type: str
sample: test-origin.example.com sample: test-origin.example.com
origin_path: origin_path:
description: Subdirectory to prefix the request from the S3 or HTTP origin description: Subdirectory to prefix the request from the S3 or HTTP origin
returned: always returned: always
type: string type: str
sample: '' sample: ''
quantity: quantity:
description: Count of origins description: Count of origins
@ -1014,7 +1014,7 @@ origins:
price_class: price_class:
description: Price class of cloudfront distribution description: Price class of cloudfront distribution
returned: always returned: always
type: string type: str
sample: PriceClass_All sample: PriceClass_All
restrictions: restrictions:
description: Restrictions in use by Cloudfront description: Restrictions in use by Cloudfront
@ -1039,12 +1039,12 @@ restrictions:
restriction_type: restriction_type:
description: Type of restriction description: Type of restriction
returned: always returned: always
type: string type: str
sample: blacklist sample: blacklist
status: status:
description: Status of the cloudfront distribution description: Status of the cloudfront distribution
returned: always returned: always
type: string type: str
sample: InProgress sample: InProgress
tags: tags:
description: Distribution tags description: Distribution tags
@ -1060,32 +1060,32 @@ viewer_certificate:
acm_certificate_arn: acm_certificate_arn:
description: ARN of ACM certificate description: ARN of ACM certificate
returned: when certificate comes from ACM returned: when certificate comes from ACM
type: string type: str
sample: arn:aws:acm:us-east-1:123456789012:certificate/abcd1234-1234-1234-abcd-123456abcdef sample: arn:aws:acm:us-east-1:123456789012:certificate/abcd1234-1234-1234-abcd-123456abcdef
certificate: certificate:
description: Reference to certificate description: Reference to certificate
returned: always returned: always
type: string type: str
sample: arn:aws:acm:us-east-1:123456789012:certificate/abcd1234-1234-1234-abcd-123456abcdef sample: arn:aws:acm:us-east-1:123456789012:certificate/abcd1234-1234-1234-abcd-123456abcdef
certificate_source: certificate_source:
description: Where certificate comes from description: Where certificate comes from
returned: always returned: always
type: string type: str
sample: acm sample: acm
minimum_protocol_version: minimum_protocol_version:
description: Minimum SSL/TLS protocol supported by this distribution description: Minimum SSL/TLS protocol supported by this distribution
returned: always returned: always
type: string type: str
sample: TLSv1 sample: TLSv1
ssl_support_method: ssl_support_method:
description: Support for pre-SNI browsers or not description: Support for pre-SNI browsers or not
returned: always returned: always
type: string type: str
sample: sni-only sample: sni-only
web_acl_id: web_acl_id:
description: ID of Web Access Control List (from WAF service) description: ID of Web Access Control List (from WAF service)
returned: always returned: always
type: string type: str
sample: abcd1234-1234-abcd-abcd-abcd12345678 sample: abcd1234-1234-abcd-abcd-abcd12345678
''' '''

10
lib/ansible/modules/cloud/amazon/cloudfront_invalidation.py
View file

@ -82,12 +82,12 @@ invalidation:
create_time: create_time:
description: The date and time the invalidation request was first made. description: The date and time the invalidation request was first made.
returned: always returned: always
type: string type: str
sample: '2018-02-01T15:50:41.159000+00:00' sample: '2018-02-01T15:50:41.159000+00:00'
id: id:
description: The identifier for the invalidation request. description: The identifier for the invalidation request.
returned: always returned: always
type: string type: str
sample: I2G9MOWJZFV612 sample: I2G9MOWJZFV612
invalidation_batch: invalidation_batch:
description: The current invalidation information for the batch request. description: The current invalidation information for the batch request.
@ -97,7 +97,7 @@ invalidation:
caller_reference: caller_reference:
description: The value used to uniquely identify an invalidation request. description: The value used to uniquely identify an invalidation request.
returned: always returned: always
type: string type: str
sample: testing 123 sample: testing 123
paths: paths:
description: A dict that contains information about the objects that you want to invalidate. description: A dict that contains information about the objects that you want to invalidate.
@ -120,12 +120,12 @@ invalidation:
status: status:
description: The status of the invalidation request. description: The status of the invalidation request.
returned: always returned: always
type: string type: str
sample: Completed sample: Completed
location: location:
description: The fully qualified URI of the distribution and invalidation batch request. description: The fully qualified URI of the distribution and invalidation batch request.
returned: always returned: always
type: string type: str
sample: https://cloudfront.amazonaws.com/2017-03-25/distribution/E1ZID6KZJECZY7/invalidation/I2G9MOWJZFV622 sample: https://cloudfront.amazonaws.com/2017-03-25/distribution/E1ZID6KZJECZY7/invalidation/I2G9MOWJZFV622
''' '''

12
lib/ansible/modules/cloud/amazon/cloudfront_origin_access_identity.py
View file

@ -91,27 +91,27 @@ cloud_front_origin_access_identity:
caller_reference: caller_reference:
description: a caller reference for the oai description: a caller reference for the oai
returned: always returned: always
type: string type: str
comment: comment:
description: a comment describing the oai description: a comment describing the oai
returned: always returned: always
type: string type: str
id: id:
description: a unique identifier of the oai description: a unique identifier of the oai
returned: always returned: always
type: string type: str
s3_canonical_user_id: s3_canonical_user_id:
description: the cannonical user id of the user who created the oai description: the cannonical user id of the user who created the oai
returned: always returned: always
type: string type: str
e_tag: e_tag:
description: The current version of the origin access identity created. description: The current version of the origin access identity created.
returned: always returned: always
type: string type: str
location: location:
description: The fully qualified URI of the new origin access identity just created. description: The fully qualified URI of the new origin access identity just created.
returned: when initially created returned: when initially created
type: string type: str
''' '''

20
lib/ansible/modules/cloud/amazon/cloudtrail.py
View file

@ -173,12 +173,12 @@ trail:
trail_arn: trail_arn:
description: Full ARN of the CloudTrail resource description: Full ARN of the CloudTrail resource
returned: success returned: success
type: string type: str
sample: arn:aws:cloudtrail:us-east-1:123456789012:trail/default sample: arn:aws:cloudtrail:us-east-1:123456789012:trail/default
name: name:
description: Name of the CloudTrail resource description: Name of the CloudTrail resource
returned: success returned: success
type: string type: str
sample: default sample: default
is_logging: is_logging:
description: Whether logging is turned on or paused for the Trail description: Whether logging is turned on or paused for the Trail
@ -188,12 +188,12 @@ trail:
s3_bucket_name: s3_bucket_name:
description: S3 bucket name where log files are delivered description: S3 bucket name where log files are delivered
returned: success returned: success
type: string type: str
sample: myBucket sample: myBucket
s3_key_prefix: s3_key_prefix:
description: Key prefix in bucket where log files are delivered (if any) description: Key prefix in bucket where log files are delivered (if any)
returned: success when present returned: success when present
type: string type: str
sample: myKeyPrefix sample: myKeyPrefix
log_file_validation_enabled: log_file_validation_enabled:
description: Whether log file validation is enabled on the trail description: Whether log file validation is enabled on the trail
@ -218,32 +218,32 @@ trail:
home_region: home_region:
description: The home region where the trail was originally created and must be edited. description: The home region where the trail was originally created and must be edited.
returned: success returned: success
type: string type: str
sample: us-east-1 sample: us-east-1
sns_topic_name: sns_topic_name:
description: The SNS topic name where log delivery notifications are sent. description: The SNS topic name where log delivery notifications are sent.
returned: success when present returned: success when present
type: string type: str
sample: myTopic sample: myTopic
sns_topic_arn: sns_topic_arn:
description: Full ARN of the SNS topic where log delivery notifications are sent. description: Full ARN of the SNS topic where log delivery notifications are sent.
returned: success when present returned: success when present
type: string type: str
sample: arn:aws:sns:us-east-1:123456789012:topic/myTopic sample: arn:aws:sns:us-east-1:123456789012:topic/myTopic
cloud_watch_logs_log_group_arn: cloud_watch_logs_log_group_arn:
description: Full ARN of the CloudWatch Logs log group where events are delivered. description: Full ARN of the CloudWatch Logs log group where events are delivered.
returned: success when present returned: success when present
type: string type: str
sample: arn:aws:logs:us-east-1:123456789012:log-group:CloudTrail/DefaultLogGroup:* sample: arn:aws:logs:us-east-1:123456789012:log-group:CloudTrail/DefaultLogGroup:*
cloud_watch_logs_role_arn: cloud_watch_logs_role_arn:
description: Full ARN of the IAM role that CloudTrail assumes to deliver events. description: Full ARN of the IAM role that CloudTrail assumes to deliver events.
returned: success when present returned: success when present
type: string type: str
sample: arn:aws:iam::123456789012:role/CloudTrail_CloudWatchLogs_Role sample: arn:aws:iam::123456789012:role/CloudTrail_CloudWatchLogs_Role
kms_key_id: kms_key_id:
description: Full ARN of the KMS Key used to encrypt log files. description: Full ARN of the KMS Key used to encrypt log files.
returned: success when present returned: success when present
type: string type: str
sample: arn:aws:kms::123456789012:key/12345678-1234-1234-1234-123456789012 sample: arn:aws:kms::123456789012:key/12345678-1234-1234-1234-123456789012
tags: tags:
description: hash/dictionary of tags applied to this resource description: hash/dictionary of tags applied to this resource

14
lib/ansible/modules/cloud/amazon/cloudwatchlogs_log_group.py
View file

@ -90,31 +90,31 @@ log_groups:
log_group_name: log_group_name:
description: The name of the log group. description: The name of the log group.
returned: always returned: always
type: string type: str
creation_time: creation_time:
description: The creation time of the log group. description: The creation time of the log group.
returned: always returned: always
type: integer type: int
retention_in_days: retention_in_days:
description: The number of days to retain the log events in the specified log group. description: The number of days to retain the log events in the specified log group.
returned: always returned: always
type: integer type: int
metric_filter_count: metric_filter_count:
description: The number of metric filters. description: The number of metric filters.
returned: always returned: always
type: integer type: int
arn: arn:
description: The Amazon Resource Name (ARN) of the log group. description: The Amazon Resource Name (ARN) of the log group.
returned: always returned: always
type: string type: str
stored_bytes: stored_bytes:
description: The number of bytes stored. description: The number of bytes stored.
returned: always returned: always
type: string type: str
kms_key_id: kms_key_id:
description: The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. description: The Amazon Resource Name (ARN) of the CMK to use when encrypting log data.
returned: always returned: always
type: string type: str
''' '''
import traceback import traceback

14
lib/ansible/modules/cloud/amazon/cloudwatchlogs_log_group_facts.py
View file

@ -43,31 +43,31 @@ log_groups:
log_group_name: log_group_name:
description: The name of the log group. description: The name of the log group.
returned: always returned: always
type: string type: str
creation_time: creation_time:
description: The creation time of the log group. description: The creation time of the log group.
returned: always returned: always
type: integer type: int
retention_in_days: retention_in_days:
description: The number of days to retain the log events in the specified log group. description: The number of days to retain the log events in the specified log group.
returned: always returned: always
type: integer type: int
metric_filter_count: metric_filter_count:
description: The number of metric filters. description: The number of metric filters.
returned: always returned: always
type: integer type: int
arn: arn:
description: The Amazon Resource Name (ARN) of the log group. description: The Amazon Resource Name (ARN) of the log group.
returned: always returned: always
type: string type: str
stored_bytes: stored_bytes:
description: The number of bytes stored. description: The number of bytes stored.
returned: always returned: always
type: string type: str
kms_key_id: kms_key_id:
description: The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. description: The Amazon Resource Name (ARN) of the CMK to use when encrypting log data.
returned: always returned: always
type: string type: str
''' '''
import traceback import traceback

2
lib/ansible/modules/cloud/amazon/dynamodb_table.py
View file

@ -128,7 +128,7 @@ RETURN = '''
table_status: table_status:
description: The current status of the table. description: The current status of the table.
returned: success returned: success
type: string type: str
sample: ACTIVE sample: ACTIVE
''' '''

26
lib/ansible/modules/cloud/amazon/ec2_ami.py
View file

@ -215,7 +215,7 @@ RETURN = '''
architecture: architecture:
description: architecture of image description: architecture of image
returned: when AMI is created or already exists returned: when AMI is created or already exists
type: string type: str
sample: "x86_64" sample: "x86_64"
block_device_mapping: block_device_mapping:
description: block device mapping associated with image description: block device mapping associated with image
@ -233,22 +233,22 @@ block_device_mapping:
creationDate: creationDate:
description: creation date of image description: creation date of image
returned: when AMI is created or already exists returned: when AMI is created or already exists
type: string type: str
sample: "2015-10-15T22:43:44.000Z" sample: "2015-10-15T22:43:44.000Z"
description: description:
description: description of image description: description of image
returned: when AMI is created or already exists returned: when AMI is created or already exists
type: string type: str
sample: "nat-server" sample: "nat-server"
hypervisor: hypervisor:
description: type of hypervisor description: type of hypervisor
returned: when AMI is created or already exists returned: when AMI is created or already exists
type: string type: str
sample: "xen" sample: "xen"
image_id: image_id:
description: id of the image description: id of the image
returned: when AMI is created or already exists returned: when AMI is created or already exists
type: string type: str
sample: "ami-1234abcd" sample: "ami-1234abcd"
is_public: is_public:
description: whether image is public description: whether image is public
@ -264,37 +264,37 @@ launch_permission:
location: location:
description: location of image description: location of image
returned: when AMI is created or already exists returned: when AMI is created or already exists
type: string type: str
sample: "315210894379/nat-server" sample: "315210894379/nat-server"
name: name:
description: ami name of image description: ami name of image
returned: when AMI is created or already exists returned: when AMI is created or already exists
type: string type: str
sample: "nat-server" sample: "nat-server"
ownerId: ownerId:
description: owner of image description: owner of image
returned: when AMI is created or already exists returned: when AMI is created or already exists
type: string type: str
sample: "435210894375" sample: "435210894375"
platform: platform:
description: platform of image description: platform of image
returned: when AMI is created or already exists returned: when AMI is created or already exists
type: string type: str
sample: null sample: null
root_device_name: root_device_name:
description: root device name of image description: root device name of image
returned: when AMI is created or already exists returned: when AMI is created or already exists
type: string type: str
sample: "/dev/sda1" sample: "/dev/sda1"
root_device_type: root_device_type:
description: root device type of image description: root device type of image
returned: when AMI is created or already exists returned: when AMI is created or already exists
type: string type: str
sample: "ebs" sample: "ebs"
state: state:
description: state of image description: state of image
returned: when AMI is created or already exists returned: when AMI is created or already exists
type: string type: str
sample: "available" sample: "available"
tags: tags:
description: a dictionary of tags assigned to image description: a dictionary of tags assigned to image
@ -307,7 +307,7 @@ tags:
virtualization_type: virtualization_type:
description: image virtualization type description: image virtualization type
returned: when AMI is created or already exists returned: when AMI is created or already exists
type: string type: str
sample: "hvm" sample: "hvm"
snapshots_deleted: snapshots_deleted:
description: a list of snapshot ids deleted after deregistering image description: a list of snapshot ids deleted after deregistering image

2
lib/ansible/modules/cloud/amazon/ec2_ami_copy.py
View file

@ -137,7 +137,7 @@ RETURN = '''
image_id: image_id:
description: AMI ID of the copied AMI description: AMI ID of the copied AMI
returned: always returned: always
type: string type: str
sample: ami-e689729e sample: ami-e689729e
''' '''

30
lib/ansible/modules/cloud/amazon/ec2_ami_facts.py
View file

@ -79,7 +79,7 @@ images:
architecture: architecture:
description: The architecture of the image description: The architecture of the image
returned: always returned: always
type: string type: str
sample: x86_64 sample: x86_64
block_device_mappings: block_device_mappings:
description: Any block device mapping entries description: Any block device mapping entries
@ -89,7 +89,7 @@ images:
device_name: device_name:
description: The device name exposed to the instance description: The device name exposed to the instance
returned: always returned: always
type: string type: str
sample: /dev/sda1 sample: /dev/sda1
ebs: ebs:
description: EBS volumes description: EBS volumes
@ -98,12 +98,12 @@ images:
creation_date: creation_date:
description: The date and time the image was created description: The date and time the image was created
returned: always returned: always
type: string type: str
sample: '2017-10-16T19:22:13.000Z' sample: '2017-10-16T19:22:13.000Z'
description: description:
description: The description of the AMI description: The description of the AMI
returned: always returned: always
type: string type: str
sample: '' sample: ''
ena_support: ena_support:
description: whether enhanced networking with ENA is enabled description: whether enhanced networking with ENA is enabled
@ -113,22 +113,22 @@ images:
hypervisor: hypervisor:
description: The hypervisor type of the image description: The hypervisor type of the image
returned: always returned: always
type: string type: str
sample: xen sample: xen
image_id: image_id:
description: The ID of the AMI description: The ID of the AMI
returned: always returned: always
type: string type: str
sample: ami-5b466623 sample: ami-5b466623
image_location: image_location:
description: The location of the AMI description: The location of the AMI
returned: always returned: always
type: string type: str
sample: 408466080000/Webapp sample: 408466080000/Webapp
image_type: image_type:
description: The type of image description: The type of image
returned: always returned: always
type: string type: str
sample: machine sample: machine
launch_permissions: launch_permissions:
description: launch permissions of the ami description: launch permissions of the ami
@ -138,12 +138,12 @@ images:
name: name:
description: The name of the AMI that was provided during image creation description: The name of the AMI that was provided during image creation
returned: always returned: always
type: string type: str
sample: Webapp sample: Webapp
owner_id: owner_id:
description: The AWS account ID of the image owner description: The AWS account ID of the image owner
returned: always returned: always
type: string type: str
sample: '408466080000' sample: '408466080000'
public: public:
description: whether the image has public launch permissions description: whether the image has public launch permissions
@ -153,22 +153,22 @@ images:
root_device_name: root_device_name:
description: The device name of the root device description: The device name of the root device
returned: always returned: always
type: string type: str
sample: /dev/sda1 sample: /dev/sda1
root_device_type: root_device_type:
description: The type of root device used by the AMI description: The type of root device used by the AMI
returned: always returned: always
type: string type: str
sample: ebs sample: ebs
sriov_net_support: sriov_net_support:
description: whether enhanced networking is enabled description: whether enhanced networking is enabled
returned: always returned: always
type: string type: str
sample: simple sample: simple
state: state:
description: The current state of the AMI description: The current state of the AMI
returned: always returned: always
type: string type: str
sample: available sample: available
tags: tags:
description: Any tags assigned to the image description: Any tags assigned to the image
@ -177,7 +177,7 @@ images:
virtualization_type: virtualization_type:
description: The type of virtualization of the AMI description: The type of virtualization of the AMI
returned: always returned: always
type: string type: str
sample: hvm sample: hvm
''' '''

6
lib/ansible/modules/cloud/amazon/ec2_asg_facts.py
View file

@ -81,7 +81,7 @@ RETURN = '''
auto_scaling_group_arn: auto_scaling_group_arn:
description: The Amazon Resource Name of the ASG description: The Amazon Resource Name of the ASG
returned: success returned: success
type: string type: str
sample: "arn:aws:autoscaling:us-west-2:1234567890:autoScalingGroup:10787c52-0bcb-427d-82ba-c8e4b008ed2e:autoScalingGroupName/public-webapp-production-1" sample: "arn:aws:autoscaling:us-west-2:1234567890:autoScalingGroup:10787c52-0bcb-427d-82ba-c8e4b008ed2e:autoScalingGroupName/public-webapp-production-1"
auto_scaling_group_name: auto_scaling_group_name:
description: Name of autoscaling group description: Name of autoscaling group
@ -96,7 +96,7 @@ availability_zones:
created_time: created_time:
description: The date and time this ASG was created, in ISO 8601 format. description: The date and time this ASG was created, in ISO 8601 format.
returned: success returned: success
type: string type: str
sample: "2015-11-25T00:05:36.309Z" sample: "2015-11-25T00:05:36.309Z"
default_cooldown: default_cooldown:
description: The default cooldown time in seconds. description: The default cooldown time in seconds.
@ -162,7 +162,7 @@ min_size:
new_instances_protected_from_scale_in: new_instances_protected_from_scale_in:
description: Whether or not new instances a protected from automatic scaling in. description: Whether or not new instances a protected from automatic scaling in.
returned: success returned: success
type: boolean type: bool
sample: "false" sample: "false"
placement_group: placement_group:
description: Placement group into which instances are launched, if any. description: Placement group into which instances are launched, if any.

12
lib/ansible/modules/cloud/amazon/ec2_customer_gateway.py
View file

@ -90,32 +90,32 @@ gateway.customer_gateways:
description: The Border Gateway Autonomous System Number. description: The Border Gateway Autonomous System Number.
returned: when exists and gateway is available. returned: when exists and gateway is available.
sample: 65123 sample: 65123
type: string type: str
customer_gateway_id: customer_gateway_id:
description: gateway id assigned by amazon. description: gateway id assigned by amazon.
returned: when exists and gateway is available. returned: when exists and gateway is available.
sample: cgw-cb6386a2 sample: cgw-cb6386a2
type: string type: str
ip_address: ip_address:
description: ip address of your gateway device. description: ip address of your gateway device.
returned: when exists and gateway is available. returned: when exists and gateway is available.
sample: 1.2.3.4 sample: 1.2.3.4
type: string type: str
state: state:
description: state of gateway. description: state of gateway.
returned: when gateway exists and is available. returned: when gateway exists and is available.
state: available state: available
type: string type: str
tags: tags:
description: any tags on the gateway. description: any tags on the gateway.
returned: when gateway exists and is available, and when tags exist. returned: when gateway exists and is available, and when tags exist.
state: available state: available
type: string type: str
type: type:
description: encryption type. description: encryption type.
returned: when gateway exists and is available. returned: when gateway exists and is available.
sample: ipsec.1 sample: ipsec.1
type: string type: str
''' '''
try: try:

4
lib/ansible/modules/cloud/amazon/ec2_eip.py
View file

@ -155,12 +155,12 @@ RETURN = '''
allocation_id: allocation_id:
description: allocation_id of the elastic ip description: allocation_id of the elastic ip
returned: on success returned: on success
type: string type: str
sample: eipalloc-51aa3a6c sample: eipalloc-51aa3a6c
public_ip: public_ip:
description: an elastic ip address description: an elastic ip address
returned: on success returned: on success
type: string type: str
sample: 52.88.159.209 sample: 52.88.159.209
''' '''

18
lib/ansible/modules/cloud/amazon/ec2_eni.py
View file

@ -205,7 +205,7 @@ interface:
contains: contains:
description: description:
description: interface description description: interface description
type: string type: str
sample: Firewall network interface sample: Firewall network interface
groups: groups:
description: list of security groups description: list of security groups
@ -213,19 +213,19 @@ interface:
sample: [ { "sg-f8a8a9da": "default" } ] sample: [ { "sg-f8a8a9da": "default" } ]
id: id:
description: network interface id description: network interface id
type: string type: str
sample: "eni-1d889198" sample: "eni-1d889198"
mac_address: mac_address:
description: interface's physical address description: interface's physical address
type: string type: str
sample: "00:00:5E:00:53:23" sample: "00:00:5E:00:53:23"
owner_id: owner_id:
description: aws account id description: aws account id
type: string type: str
sample: 812381371 sample: 812381371
private_ip_address: private_ip_address:
description: primary ip address of this interface description: primary ip address of this interface
type: string type: str
sample: 10.20.30.40 sample: 10.20.30.40
private_ip_addresses: private_ip_addresses:
description: list of all private ip addresses associated to this interface description: list of all private ip addresses associated to this interface
@ -233,19 +233,19 @@ interface:
sample: [ { "primary_address": true, "private_ip_address": "10.20.30.40" } ] sample: [ { "primary_address": true, "private_ip_address": "10.20.30.40" } ]
source_dest_check: source_dest_check:
description: value of source/dest check flag description: value of source/dest check flag
type: boolean type: bool
sample: True sample: True
status: status:
description: network interface status description: network interface status
type: string type: str
sample: "pending" sample: "pending"
subnet_id: subnet_id:
description: which vpc subnet the interface is bound description: which vpc subnet the interface is bound
type: string type: str
sample: subnet-b0a0393c sample: subnet-b0a0393c
vpc_id: vpc_id:
description: which vpc this network interface is bound description: which vpc this network interface is bound
type: string type: str
sample: vpc-9a9a9da sample: vpc-9a9a9da
''' '''

26
lib/ansible/modules/cloud/amazon/ec2_eni_facts.py
View file

@ -83,12 +83,12 @@ network_interfaces:
availability_zone: availability_zone:
description: Availability zone of ENI description: Availability zone of ENI
returned: always returned: always
type: string type: str
sample: "us-east-1b" sample: "us-east-1b"
description: description:
description: Description text for ENI description: Description text for ENI
returned: always returned: always
type: string type: str
sample: "My favourite network interface" sample: "My favourite network interface"
groups: groups:
description: List of attached security groups description: List of attached security groups
@ -103,12 +103,12 @@ network_interfaces:
id: id:
description: The id of the ENI (alias for network_interface_id) description: The id of the ENI (alias for network_interface_id)
returned: always returned: always
type: string type: str
sample: "eni-392fsdf" sample: "eni-392fsdf"
interface_type: interface_type:
description: Type of the network interface description: Type of the network interface
returned: always returned: always
type: string type: str
sample: "interface" sample: "interface"
ipv6_addresses: ipv6_addresses:
description: List of IPv6 addresses for this interface description: List of IPv6 addresses for this interface
@ -118,27 +118,27 @@ network_interfaces:
mac_address: mac_address:
description: MAC address of the network interface description: MAC address of the network interface
returned: always returned: always
type: string type: str
sample: "0a:f8:10:2f:ab:a1" sample: "0a:f8:10:2f:ab:a1"
network_interface_id: network_interface_id:
description: The id of the ENI description: The id of the ENI
returned: always returned: always
type: string type: str
sample: "eni-392fsdf" sample: "eni-392fsdf"
owner_id: owner_id:
description: AWS account id of the owner of the ENI description: AWS account id of the owner of the ENI
returned: always returned: always
type: string type: str
sample: "4415120123456" sample: "4415120123456"
private_dns_name: private_dns_name:
description: Private DNS name for the ENI description: Private DNS name for the ENI
returned: always returned: always
type: string type: str
sample: "ip-172-16-1-180.ec2.internal" sample: "ip-172-16-1-180.ec2.internal"
private_ip_address: private_ip_address:
description: Private IP address for the ENI description: Private IP address for the ENI
returned: always returned: always
type: string type: str
sample: "172.16.1.180" sample: "172.16.1.180"
private_ip_addresses: private_ip_addresses:
description: List of private IP addresses attached to the ENI description: List of private IP addresses attached to the ENI
@ -148,7 +148,7 @@ network_interfaces:
requester_id: requester_id:
description: The ID of the entity that launched the ENI description: The ID of the entity that launched the ENI
returned: always returned: always
type: string type: str
sample: "AIDAIONYVJQNIAZFT3ABC" sample: "AIDAIONYVJQNIAZFT3ABC"
requester_managed: requester_managed:
description: Indicates whether the network interface is being managed by an AWS service. description: Indicates whether the network interface is being managed by an AWS service.
@ -163,12 +163,12 @@ network_interfaces:
status: status:
description: Indicates if the network interface is attached to an instance or not description: Indicates if the network interface is attached to an instance or not
returned: always returned: always
type: string type: str
sample: "in-use" sample: "in-use"
subnet_id: subnet_id:
description: Subnet ID the ENI is in description: Subnet ID the ENI is in
returned: always returned: always
type: string type: str
sample: "subnet-7bbf01234" sample: "subnet-7bbf01234"
tag_set: tag_set:
description: Dictionary of tags added to the ENI description: Dictionary of tags added to the ENI
@ -178,7 +178,7 @@ network_interfaces:
vpc_id: vpc_id:
description: ID of the VPC the network interface it part of description: ID of the VPC the network interface it part of
returned: always returned: always
type: string type: str
sample: "vpc-b3f1f123" sample: "vpc-b3f1f123"
''' '''

8
lib/ansible/modules/cloud/amazon/ec2_group.py
View file

@ -237,17 +237,17 @@ RETURN = '''
group_name: group_name:
description: Security group name description: Security group name
sample: My Security Group sample: My Security Group
type: string type: str
returned: on create/update returned: on create/update
group_id: group_id:
description: Security group id description: Security group id
sample: sg-abcd1234 sample: sg-abcd1234
type: string type: str
returned: on create/update returned: on create/update
description: description:
description: Description of security group description: Description of security group
sample: My Security Group sample: My Security Group
type: string type: str
returned: on create/update returned: on create/update
tags: tags:
description: Tags associated with the security group description: Tags associated with the security group
@ -259,7 +259,7 @@ tags:
vpc_id: vpc_id:
description: ID of VPC to which the security group belongs description: ID of VPC to which the security group belongs
sample: vpc-abcd1234 sample: vpc-abcd1234
type: string type: str
returned: on create/update returned: on create/update
ip_permissions: ip_permissions:
description: Inbound rules associated with the security group. description: Inbound rules associated with the security group.

106
lib/ansible/modules/cloud/amazon/ec2_instance.py
View file

@ -312,7 +312,7 @@ instances:
architecture: architecture:
description: The architecture of the image description: The architecture of the image
returned: always returned: always
type: string type: str
sample: x86_64 sample: x86_64
block_device_mappings: block_device_mappings:
description: Any block device mapping entries for the instance. description: Any block device mapping entries for the instance.
@ -322,7 +322,7 @@ instances:
device_name: device_name:
description: The device name exposed to the instance (for example, /dev/sdh or xvdh). description: The device name exposed to the instance (for example, /dev/sdh or xvdh).
returned: always returned: always
type: string type: str
sample: /dev/sdh sample: /dev/sdh
ebs: ebs:
description: Parameters used to automatically set up EBS volumes when the instance is launched. description: Parameters used to automatically set up EBS volumes when the instance is launched.
@ -332,7 +332,7 @@ instances:
attach_time: attach_time:
description: The time stamp when the attachment initiated. description: The time stamp when the attachment initiated.
returned: always returned: always
type: string type: str
sample: "2017-03-23T22:51:24+00:00" sample: "2017-03-23T22:51:24+00:00"
delete_on_termination: delete_on_termination:
description: Indicates whether the volume is deleted on instance termination. description: Indicates whether the volume is deleted on instance termination.
@ -342,17 +342,17 @@ instances:
status: status:
description: The attachment state. description: The attachment state.
returned: always returned: always
type: string type: str
sample: attached sample: attached
volume_id: volume_id:
description: The ID of the EBS volume description: The ID of the EBS volume
returned: always returned: always
type: string type: str
sample: vol-12345678 sample: vol-12345678
client_token: client_token:
description: The idempotency token you provided when you launched the instance, if applicable. description: The idempotency token you provided when you launched the instance, if applicable.
returned: always returned: always
type: string type: str
sample: mytoken sample: mytoken
ebs_optimized: ebs_optimized:
description: Indicates whether the instance is optimized for EBS I/O. description: Indicates whether the instance is optimized for EBS I/O.
@ -362,7 +362,7 @@ instances:
hypervisor: hypervisor:
description: The hypervisor type of the instance. description: The hypervisor type of the instance.
returned: always returned: always
type: string type: str
sample: xen sample: xen
iam_instance_profile: iam_instance_profile:
description: The IAM instance profile associated with the instance, if applicable. description: The IAM instance profile associated with the instance, if applicable.
@ -372,37 +372,37 @@ instances:
arn: arn:
description: The Amazon Resource Name (ARN) of the instance profile. description: The Amazon Resource Name (ARN) of the instance profile.
returned: always returned: always
type: string type: str
sample: "arn:aws:iam::000012345678:instance-profile/myprofile" sample: "arn:aws:iam::000012345678:instance-profile/myprofile"
id: id:
description: The ID of the instance profile description: The ID of the instance profile
returned: always returned: always
type: string type: str
sample: JFJ397FDG400FG9FD1N sample: JFJ397FDG400FG9FD1N
image_id: image_id:
description: The ID of the AMI used to launch the instance. description: The ID of the AMI used to launch the instance.
returned: always returned: always
type: string type: str
sample: ami-0011223344 sample: ami-0011223344
instance_id: instance_id:
description: The ID of the instance. description: The ID of the instance.
returned: always returned: always
type: string type: str
sample: i-012345678 sample: i-012345678
instance_type: instance_type:
description: The instance type size of the running instance. description: The instance type size of the running instance.
returned: always returned: always
type: string type: str
sample: t2.micro sample: t2.micro
key_name: key_name:
description: The name of the key pair, if this instance was launched with an associated key pair. description: The name of the key pair, if this instance was launched with an associated key pair.
returned: always returned: always
type: string type: str
sample: my-key sample: my-key
launch_time: launch_time:
description: The time the instance was launched. description: The time the instance was launched.
returned: always returned: always
type: string type: str
sample: "2017-03-23T22:51:24+00:00" sample: "2017-03-23T22:51:24+00:00"
monitoring: monitoring:
description: The monitoring for the instance. description: The monitoring for the instance.
@ -412,7 +412,7 @@ instances:
state: state:
description: Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. description: Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
returned: always returned: always
type: string type: str
sample: disabled sample: disabled
network_interfaces: network_interfaces:
description: One or more network interfaces for the instance. description: One or more network interfaces for the instance.
@ -427,17 +427,17 @@ instances:
ip_owner_id: ip_owner_id:
description: The ID of the owner of the Elastic IP address. description: The ID of the owner of the Elastic IP address.
returned: always returned: always
type: string type: str
sample: amazon sample: amazon
public_dns_name: public_dns_name:
description: The public DNS name. description: The public DNS name.
returned: always returned: always
type: string type: str
sample: "" sample: ""
public_ip: public_ip:
description: The public IP address or Elastic IP address bound to the network interface. description: The public IP address or Elastic IP address bound to the network interface.
returned: always returned: always
type: string type: str
sample: 1.2.3.4 sample: 1.2.3.4
attachment: attachment:
description: The network interface attachment. description: The network interface attachment.
@ -447,12 +447,12 @@ instances:
attach_time: attach_time:
description: The time stamp when the attachment initiated. description: The time stamp when the attachment initiated.
returned: always returned: always
type: string type: str
sample: "2017-03-23T22:51:24+00:00" sample: "2017-03-23T22:51:24+00:00"
attachment_id: attachment_id:
description: The ID of the network interface attachment. description: The ID of the network interface attachment.
returned: always returned: always
type: string type: str
sample: eni-attach-3aff3f sample: eni-attach-3aff3f
delete_on_termination: delete_on_termination:
description: Indicates whether the network interface is deleted when the instance is terminated. description: Indicates whether the network interface is deleted when the instance is terminated.
@ -467,12 +467,12 @@ instances:
status: status:
description: The attachment state. description: The attachment state.
returned: always returned: always
type: string type: str
sample: attached sample: attached
description: description:
description: The description. description: The description.
returned: always returned: always
type: string type: str
sample: My interface sample: My interface
groups: groups:
description: One or more security groups. description: One or more security groups.
@ -482,12 +482,12 @@ instances:
- group_id: - group_id:
description: The ID of the security group. description: The ID of the security group.
returned: always returned: always
type: string type: str
sample: sg-abcdef12 sample: sg-abcdef12
group_name: group_name:
description: The name of the security group. description: The name of the security group.
returned: always returned: always
type: string type: str
sample: mygroup sample: mygroup
ipv6_addresses: ipv6_addresses:
description: One or more IPv6 addresses associated with the network interface. description: One or more IPv6 addresses associated with the network interface.
@ -497,27 +497,27 @@ instances:
- ipv6_address: - ipv6_address:
description: The IPv6 address. description: The IPv6 address.
returned: always returned: always
type: string type: str
sample: "2001:0db8:85a3:0000:0000:8a2e:0370:7334" sample: "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
mac_address: mac_address:
description: The MAC address. description: The MAC address.
returned: always returned: always
type: string type: str
sample: "00:11:22:33:44:55" sample: "00:11:22:33:44:55"
network_interface_id: network_interface_id:
description: The ID of the network interface. description: The ID of the network interface.
returned: always returned: always
type: string type: str
sample: eni-01234567 sample: eni-01234567
owner_id: owner_id:
description: The AWS account ID of the owner of the network interface. description: The AWS account ID of the owner of the network interface.
returned: always returned: always
type: string type: str
sample: 01234567890 sample: 01234567890
private_ip_address: private_ip_address:
description: The IPv4 address of the network interface within the subnet. description: The IPv4 address of the network interface within the subnet.
returned: always returned: always
type: string type: str
sample: 10.0.0.1 sample: 10.0.0.1
private_ip_addresses: private_ip_addresses:
description: The private IPv4 addresses associated with the network interface. description: The private IPv4 addresses associated with the network interface.
@ -532,17 +532,17 @@ instances:
ip_owner_id: ip_owner_id:
description: The ID of the owner of the Elastic IP address. description: The ID of the owner of the Elastic IP address.
returned: always returned: always
type: string type: str
sample: amazon sample: amazon
public_dns_name: public_dns_name:
description: The public DNS name. description: The public DNS name.
returned: always returned: always
type: string type: str
sample: "" sample: ""
public_ip: public_ip:
description: The public IP address or Elastic IP address bound to the network interface. description: The public IP address or Elastic IP address bound to the network interface.
returned: always returned: always
type: string type: str
sample: 1.2.3.4 sample: 1.2.3.4
primary: primary:
description: Indicates whether this IPv4 address is the primary private IP address of the network interface. description: Indicates whether this IPv4 address is the primary private IP address of the network interface.
@ -552,7 +552,7 @@ instances:
private_ip_address: private_ip_address:
description: The private IPv4 address of the network interface. description: The private IPv4 address of the network interface.
returned: always returned: always
type: string type: str
sample: 10.0.0.1 sample: 10.0.0.1
source_dest_check: source_dest_check:
description: Indicates whether source/destination checking is enabled. description: Indicates whether source/destination checking is enabled.
@ -562,17 +562,17 @@ instances:
status: status:
description: The status of the network interface. description: The status of the network interface.
returned: always returned: always
type: string type: str
sample: in-use sample: in-use
subnet_id: subnet_id:
description: The ID of the subnet for the network interface. description: The ID of the subnet for the network interface.
returned: always returned: always
type: string type: str
sample: subnet-0123456 sample: subnet-0123456
vpc_id: vpc_id:
description: The ID of the VPC for the network interface. description: The ID of the VPC for the network interface.
returned: always returned: always
type: string type: str
sample: vpc-0123456 sample: vpc-0123456
placement: placement:
description: The location where the instance launched, if applicable. description: The location where the instance launched, if applicable.
@ -582,27 +582,27 @@ instances:
availability_zone: availability_zone:
description: The Availability Zone of the instance. description: The Availability Zone of the instance.
returned: always returned: always
type: string type: str
sample: ap-southeast-2a sample: ap-southeast-2a
group_name: group_name:
description: The name of the placement group the instance is in (for cluster compute instances). description: The name of the placement group the instance is in (for cluster compute instances).
returned: always returned: always
type: string type: str
sample: "" sample: ""
tenancy: tenancy:
description: The tenancy of the instance (if the instance is running in a VPC). description: The tenancy of the instance (if the instance is running in a VPC).
returned: always returned: always
type: string type: str
sample: default sample: default
private_dns_name: private_dns_name:
description: The private DNS name. description: The private DNS name.
returned: always returned: always
type: string type: str
sample: ip-10-0-0-1.ap-southeast-2.compute.internal sample: ip-10-0-0-1.ap-southeast-2.compute.internal
private_ip_address: private_ip_address:
description: The IPv4 address of the network interface within the subnet. description: The IPv4 address of the network interface within the subnet.
returned: always returned: always
type: string type: str
sample: 10.0.0.1 sample: 10.0.0.1
product_codes: product_codes:
description: One or more product codes. description: One or more product codes.
@ -612,32 +612,32 @@ instances:
- product_code_id: - product_code_id:
description: The product code. description: The product code.
returned: always returned: always
type: string type: str
sample: aw0evgkw8ef3n2498gndfgasdfsd5cce sample: aw0evgkw8ef3n2498gndfgasdfsd5cce
product_code_type: product_code_type:
description: The type of product code. description: The type of product code.
returned: always returned: always
type: string type: str
sample: marketplace sample: marketplace
public_dns_name: public_dns_name:
description: The public DNS name assigned to the instance. description: The public DNS name assigned to the instance.
returned: always returned: always
type: string type: str
sample: sample:
public_ip_address: public_ip_address:
description: The public IPv4 address assigned to the instance description: The public IPv4 address assigned to the instance
returned: always returned: always
type: string type: str
sample: 52.0.0.1 sample: 52.0.0.1
root_device_name: root_device_name:
description: The device name of the root device description: The device name of the root device
returned: always returned: always
type: string type: str
sample: /dev/sda1 sample: /dev/sda1
root_device_type: root_device_type:
description: The type of root device used by the AMI. description: The type of root device used by the AMI.
returned: always returned: always
type: string type: str
sample: ebs sample: ebs
security_groups: security_groups:
description: One or more security groups for the instance. description: One or more security groups for the instance.
@ -647,12 +647,12 @@ instances:
- group_id: - group_id:
description: The ID of the security group. description: The ID of the security group.
returned: always returned: always
type: string type: str
sample: sg-0123456 sample: sg-0123456
- group_name: - group_name:
description: The name of the security group. description: The name of the security group.
returned: always returned: always
type: string type: str
sample: my-security-group sample: my-security-group
network.source_dest_check: network.source_dest_check:
description: Indicates whether source/destination checking is enabled. description: Indicates whether source/destination checking is enabled.
@ -672,17 +672,17 @@ instances:
name: name:
description: The name of the state. description: The name of the state.
returned: always returned: always
type: string type: str
sample: running sample: running
state_transition_reason: state_transition_reason:
description: The reason for the most recent state transition. description: The reason for the most recent state transition.
returned: always returned: always
type: string type: str
sample: sample:
subnet_id: subnet_id:
description: The ID of the subnet in which the instance is running. description: The ID of the subnet in which the instance is running.
returned: always returned: always
type: string type: str
sample: subnet-00abcdef sample: subnet-00abcdef
tags: tags:
description: Any tags assigned to the instance. description: Any tags assigned to the instance.
@ -692,7 +692,7 @@ instances:
virtualization_type: virtualization_type:
description: The type of virtualization of the AMI. description: The type of virtualization of the AMI.
returned: always returned: always
type: string type: str
sample: hvm sample: hvm
vpc_id: vpc_id:
description: The ID of the VPC the instance is in. description: The ID of the VPC the instance is in.

106
lib/ansible/modules/cloud/amazon/ec2_instance_facts.py
View file

@ -82,7 +82,7 @@ instances:
architecture: architecture:
description: The architecture of the image description: The architecture of the image
returned: always returned: always
type: string type: str
sample: x86_64 sample: x86_64
block_device_mappings: block_device_mappings:
description: Any block device mapping entries for the instance. description: Any block device mapping entries for the instance.
@ -92,7 +92,7 @@ instances:
device_name: device_name:
description: The device name exposed to the instance (for example, /dev/sdh or xvdh). description: The device name exposed to the instance (for example, /dev/sdh or xvdh).
returned: always returned: always
type: string type: str
sample: /dev/sdh sample: /dev/sdh
ebs: ebs:
description: Parameters used to automatically set up EBS volumes when the instance is launched. description: Parameters used to automatically set up EBS volumes when the instance is launched.
@ -102,7 +102,7 @@ instances:
attach_time: attach_time:
description: The time stamp when the attachment initiated. description: The time stamp when the attachment initiated.
returned: always returned: always
type: string type: str
sample: "2017-03-23T22:51:24+00:00" sample: "2017-03-23T22:51:24+00:00"
delete_on_termination: delete_on_termination:
description: Indicates whether the volume is deleted on instance termination. description: Indicates whether the volume is deleted on instance termination.
@ -112,12 +112,12 @@ instances:
status: status:
description: The attachment state. description: The attachment state.
returned: always returned: always
type: string type: str
sample: attached sample: attached
volume_id: volume_id:
description: The ID of the EBS volume description: The ID of the EBS volume
returned: always returned: always
type: string type: str
sample: vol-12345678 sample: vol-12345678
cpu_options: cpu_options:
description: The CPU options set for the instance. description: The CPU options set for the instance.
@ -137,7 +137,7 @@ instances:
client_token: client_token:
description: The idempotency token you provided when you launched the instance, if applicable. description: The idempotency token you provided when you launched the instance, if applicable.
returned: always returned: always
type: string type: str
sample: mytoken sample: mytoken
ebs_optimized: ebs_optimized:
description: Indicates whether the instance is optimized for EBS I/O. description: Indicates whether the instance is optimized for EBS I/O.
@ -147,7 +147,7 @@ instances:
hypervisor: hypervisor:
description: The hypervisor type of the instance. description: The hypervisor type of the instance.
returned: always returned: always
type: string type: str
sample: xen sample: xen
iam_instance_profile: iam_instance_profile:
description: The IAM instance profile associated with the instance, if applicable. description: The IAM instance profile associated with the instance, if applicable.
@ -157,37 +157,37 @@ instances:
arn: arn:
description: The Amazon Resource Name (ARN) of the instance profile. description: The Amazon Resource Name (ARN) of the instance profile.
returned: always returned: always
type: string type: str
sample: "arn:aws:iam::000012345678:instance-profile/myprofile" sample: "arn:aws:iam::000012345678:instance-profile/myprofile"
id: id:
description: The ID of the instance profile description: The ID of the instance profile
returned: always returned: always
type: string type: str
sample: JFJ397FDG400FG9FD1N sample: JFJ397FDG400FG9FD1N
image_id: image_id:
description: The ID of the AMI used to launch the instance. description: The ID of the AMI used to launch the instance.
returned: always returned: always
type: string type: str
sample: ami-0011223344 sample: ami-0011223344
instance_id: instance_id:
description: The ID of the instance. description: The ID of the instance.
returned: always returned: always
type: string type: str
sample: i-012345678 sample: i-012345678
instance_type: instance_type:
description: The instance type size of the running instance. description: The instance type size of the running instance.
returned: always returned: always
type: string type: str
sample: t2.micro sample: t2.micro
key_name: key_name:
description: The name of the key pair, if this instance was launched with an associated key pair. description: The name of the key pair, if this instance was launched with an associated key pair.
returned: always returned: always
type: string type: str
sample: my-key sample: my-key
launch_time: launch_time:
description: The time the instance was launched. description: The time the instance was launched.
returned: always returned: always
type: string type: str
sample: "2017-03-23T22:51:24+00:00" sample: "2017-03-23T22:51:24+00:00"
monitoring: monitoring:
description: The monitoring for the instance. description: The monitoring for the instance.
@ -197,7 +197,7 @@ instances:
state: state:
description: Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. description: Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
returned: always returned: always
type: string type: str
sample: disabled sample: disabled
network_interfaces: network_interfaces:
description: One or more network interfaces for the instance. description: One or more network interfaces for the instance.
@ -212,17 +212,17 @@ instances:
ip_owner_id: ip_owner_id:
description: The ID of the owner of the Elastic IP address. description: The ID of the owner of the Elastic IP address.
returned: always returned: always
type: string type: str
sample: amazon sample: amazon
public_dns_name: public_dns_name:
description: The public DNS name. description: The public DNS name.
returned: always returned: always
type: string type: str
sample: "" sample: ""
public_ip: public_ip:
description: The public IP address or Elastic IP address bound to the network interface. description: The public IP address or Elastic IP address bound to the network interface.
returned: always returned: always
type: string type: str
sample: 1.2.3.4 sample: 1.2.3.4
attachment: attachment:
description: The network interface attachment. description: The network interface attachment.
@ -232,12 +232,12 @@ instances:
attach_time: attach_time:
description: The time stamp when the attachment initiated. description: The time stamp when the attachment initiated.
returned: always returned: always
type: string type: str
sample: "2017-03-23T22:51:24+00:00" sample: "2017-03-23T22:51:24+00:00"
attachment_id: attachment_id:
description: The ID of the network interface attachment. description: The ID of the network interface attachment.
returned: always returned: always
type: string type: str
sample: eni-attach-3aff3f sample: eni-attach-3aff3f
delete_on_termination: delete_on_termination:
description: Indicates whether the network interface is deleted when the instance is terminated. description: Indicates whether the network interface is deleted when the instance is terminated.
@ -252,12 +252,12 @@ instances:
status: status:
description: The attachment state. description: The attachment state.
returned: always returned: always
type: string type: str
sample: attached sample: attached
description: description:
description: The description. description: The description.
returned: always returned: always
type: string type: str
sample: My interface sample: My interface
groups: groups:
description: One or more security groups. description: One or more security groups.
@ -267,12 +267,12 @@ instances:
- group_id: - group_id:
description: The ID of the security group. description: The ID of the security group.
returned: always returned: always
type: string type: str
sample: sg-abcdef12 sample: sg-abcdef12
group_name: group_name:
description: The name of the security group. description: The name of the security group.
returned: always returned: always
type: string type: str
sample: mygroup sample: mygroup
ipv6_addresses: ipv6_addresses:
description: One or more IPv6 addresses associated with the network interface. description: One or more IPv6 addresses associated with the network interface.
@ -282,27 +282,27 @@ instances:
- ipv6_address: - ipv6_address:
description: The IPv6 address. description: The IPv6 address.
returned: always returned: always
type: string type: str
sample: "2001:0db8:85a3:0000:0000:8a2e:0370:7334" sample: "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
mac_address: mac_address:
description: The MAC address. description: The MAC address.
returned: always returned: always
type: string type: str
sample: "00:11:22:33:44:55" sample: "00:11:22:33:44:55"
network_interface_id: network_interface_id:
description: The ID of the network interface. description: The ID of the network interface.
returned: always returned: always
type: string type: str
sample: eni-01234567 sample: eni-01234567
owner_id: owner_id:
description: The AWS account ID of the owner of the network interface. description: The AWS account ID of the owner of the network interface.
returned: always returned: always
type: string type: str
sample: 01234567890 sample: 01234567890
private_ip_address: private_ip_address:
description: The IPv4 address of the network interface within the subnet. description: The IPv4 address of the network interface within the subnet.
returned: always returned: always
type: string type: str
sample: 10.0.0.1 sample: 10.0.0.1
private_ip_addresses: private_ip_addresses:
description: The private IPv4 addresses associated with the network interface. description: The private IPv4 addresses associated with the network interface.
@ -317,17 +317,17 @@ instances:
ip_owner_id: ip_owner_id:
description: The ID of the owner of the Elastic IP address. description: The ID of the owner of the Elastic IP address.
returned: always returned: always
type: string type: str
sample: amazon sample: amazon
public_dns_name: public_dns_name:
description: The public DNS name. description: The public DNS name.
returned: always returned: always
type: string type: str
sample: "" sample: ""
public_ip: public_ip:
description: The public IP address or Elastic IP address bound to the network interface. description: The public IP address or Elastic IP address bound to the network interface.
returned: always returned: always
type: string type: str
sample: 1.2.3.4 sample: 1.2.3.4
primary: primary:
description: Indicates whether this IPv4 address is the primary private IP address of the network interface. description: Indicates whether this IPv4 address is the primary private IP address of the network interface.
@ -337,7 +337,7 @@ instances:
private_ip_address: private_ip_address:
description: The private IPv4 address of the network interface. description: The private IPv4 address of the network interface.
returned: always returned: always
type: string type: str
sample: 10.0.0.1 sample: 10.0.0.1
source_dest_check: source_dest_check:
description: Indicates whether source/destination checking is enabled. description: Indicates whether source/destination checking is enabled.
@ -347,17 +347,17 @@ instances:
status: status:
description: The status of the network interface. description: The status of the network interface.
returned: always returned: always
type: string type: str
sample: in-use sample: in-use
subnet_id: subnet_id:
description: The ID of the subnet for the network interface. description: The ID of the subnet for the network interface.
returned: always returned: always
type: string type: str
sample: subnet-0123456 sample: subnet-0123456
vpc_id: vpc_id:
description: The ID of the VPC for the network interface. description: The ID of the VPC for the network interface.
returned: always returned: always
type: string type: str
sample: vpc-0123456 sample: vpc-0123456
placement: placement:
description: The location where the instance launched, if applicable. description: The location where the instance launched, if applicable.
@ -367,27 +367,27 @@ instances:
availability_zone: availability_zone:
description: The Availability Zone of the instance. description: The Availability Zone of the instance.
returned: always returned: always
type: string type: str
sample: ap-southeast-2a sample: ap-southeast-2a
group_name: group_name:
description: The name of the placement group the instance is in (for cluster compute instances). description: The name of the placement group the instance is in (for cluster compute instances).
returned: always returned: always
type: string type: str
sample: "" sample: ""
tenancy: tenancy:
description: The tenancy of the instance (if the instance is running in a VPC). description: The tenancy of the instance (if the instance is running in a VPC).
returned: always returned: always
type: string type: str
sample: default sample: default
private_dns_name: private_dns_name:
description: The private DNS name. description: The private DNS name.
returned: always returned: always
type: string type: str
sample: ip-10-0-0-1.ap-southeast-2.compute.internal sample: ip-10-0-0-1.ap-southeast-2.compute.internal
private_ip_address: private_ip_address:
description: The IPv4 address of the network interface within the subnet. description: The IPv4 address of the network interface within the subnet.
returned: always returned: always
type: string type: str
sample: 10.0.0.1 sample: 10.0.0.1
product_codes: product_codes:
description: One or more product codes. description: One or more product codes.
@ -397,32 +397,32 @@ instances:
- product_code_id: - product_code_id:
description: The product code. description: The product code.
returned: always returned: always
type: string type: str
sample: aw0evgkw8ef3n2498gndfgasdfsd5cce sample: aw0evgkw8ef3n2498gndfgasdfsd5cce
product_code_type: product_code_type:
description: The type of product code. description: The type of product code.
returned: always returned: always
type: string type: str
sample: marketplace sample: marketplace
public_dns_name: public_dns_name:
description: The public DNS name assigned to the instance. description: The public DNS name assigned to the instance.
returned: always returned: always
type: string type: str
sample: sample:
public_ip_address: public_ip_address:
description: The public IPv4 address assigned to the instance description: The public IPv4 address assigned to the instance
returned: always returned: always
type: string type: str
sample: 52.0.0.1 sample: 52.0.0.1
root_device_name: root_device_name:
description: The device name of the root device description: The device name of the root device
returned: always returned: always
type: string type: str
sample: /dev/sda1 sample: /dev/sda1
root_device_type: root_device_type:
description: The type of root device used by the AMI. description: The type of root device used by the AMI.
returned: always returned: always
type: string type: str
sample: ebs sample: ebs
security_groups: security_groups:
description: One or more security groups for the instance. description: One or more security groups for the instance.
@ -432,12 +432,12 @@ instances:
- group_id: - group_id:
description: The ID of the security group. description: The ID of the security group.
returned: always returned: always
type: string type: str
sample: sg-0123456 sample: sg-0123456
- group_name: - group_name:
description: The name of the security group. description: The name of the security group.
returned: always returned: always
type: string type: str
sample: my-security-group sample: my-security-group
source_dest_check: source_dest_check:
description: Indicates whether source/destination checking is enabled. description: Indicates whether source/destination checking is enabled.
@ -457,17 +457,17 @@ instances:
name: name:
description: The name of the state. description: The name of the state.
returned: always returned: always
type: string type: str
sample: running sample: running
state_transition_reason: state_transition_reason:
description: The reason for the most recent state transition. description: The reason for the most recent state transition.
returned: always returned: always
type: string type: str
sample: sample:
subnet_id: subnet_id:
description: The ID of the subnet in which the instance is running. description: The ID of the subnet in which the instance is running.
returned: always returned: always
type: string type: str
sample: subnet-00abcdef sample: subnet-00abcdef
tags: tags:
description: Any tags assigned to the instance. description: Any tags assigned to the instance.
@ -477,7 +477,7 @@ instances:
virtualization_type: virtualization_type:
description: The type of virtualization of the AMI. description: The type of virtualization of the AMI.
returned: always returned: always
type: string type: str
sample: hvm sample: hvm
vpc_id: vpc_id:
description: The ID of the VPC the instance is in. description: The ID of the VPC the instance is in.

8
lib/ansible/modules/cloud/amazon/ec2_key.py
View file

@ -104,7 +104,7 @@ changed:
msg: msg:
description: short message describing the action taken description: short message describing the action taken
returned: always returned: always
type: string type: str
sample: key pair created sample: key pair created
key: key:
description: details of the keypair (this is set to null when state is absent) description: details of the keypair (this is set to null when state is absent)
@ -114,17 +114,17 @@ key:
fingerprint: fingerprint:
description: fingerprint of the key description: fingerprint of the key
returned: when state is present returned: when state is present
type: string type: str
sample: 'b0:22:49:61:d9:44:9d:0c:7e:ac:8a:32:93:21:6c:e8:fb:59:62:43' sample: 'b0:22:49:61:d9:44:9d:0c:7e:ac:8a:32:93:21:6c:e8:fb:59:62:43'
name: name:
description: name of the keypair description: name of the keypair
returned: when state is present returned: when state is present
type: string type: str
sample: my_keypair sample: my_keypair
private_key: private_key:
description: private key of a newly created keypair description: private key of a newly created keypair
returned: when a new keypair is created by AWS (key_material is not provided) returned: when a new keypair is created by AWS (key_material is not provided)
type: string type: str
sample: '-----BEGIN RSA PRIVATE KEY----- sample: '-----BEGIN RSA PRIVATE KEY-----
MIIEowIBAAKC... MIIEowIBAAKC...
-----END RSA PRIVATE KEY-----' -----END RSA PRIVATE KEY-----'

38
lib/ansible/modules/cloud/amazon/ec2_lc.py
View file

@ -188,7 +188,7 @@ RETURN = '''
arn: arn:
description: The Amazon Resource Name of the launch configuration. description: The Amazon Resource Name of the launch configuration.
returned: when I(state=present) returned: when I(state=present)
type: string type: str
sample: arn:aws:autoscaling:us-east-1:148830907657:launchConfiguration:888d9b58-d93a-40c4-90cf-759197a2621a:launchConfigurationName/launch_config_name sample: arn:aws:autoscaling:us-east-1:148830907657:launchConfiguration:888d9b58-d93a-40c4-90cf-759197a2621a:launchConfigurationName/launch_config_name
changed: changed:
description: Whether the state of the launch configuration has changed. description: Whether the state of the launch configuration has changed.
@ -198,22 +198,22 @@ changed:
created_time: created_time:
description: The creation date and time for the launch configuration. description: The creation date and time for the launch configuration.
returned: when I(state=present) returned: when I(state=present)
type: string type: str
sample: '2017-11-03 23:46:44.841000' sample: '2017-11-03 23:46:44.841000'
image_id: image_id:
description: The ID of the Amazon Machine Image used by the launch configuration. description: The ID of the Amazon Machine Image used by the launch configuration.
returned: when I(state=present) returned: when I(state=present)
type: string type: str
sample: ami-9be6f38c sample: ami-9be6f38c
instance_type: instance_type:
description: The instance type for the instances. description: The instance type for the instances.
returned: when I(state=present) returned: when I(state=present)
type: string type: str
sample: t1.micro sample: t1.micro
name: name:
description: The name of the launch configuration. description: The name of the launch configuration.
returned: when I(state=present) returned: when I(state=present)
type: string type: str
sample: launch_config_name sample: launch_config_name
result: result:
description: The specification details for the launch configuration. description: The specification details for the launch configuration.
@ -223,7 +223,7 @@ result:
PlacementTenancy: PlacementTenancy:
description: The tenancy of the instances, either default or dedicated. description: The tenancy of the instances, either default or dedicated.
returned: when I(state=present) returned: when I(state=present)
type: string type: str
sample: default sample: default
associate_public_ip_address: associate_public_ip_address:
description: (EC2-VPC) Indicates whether to assign a public IP address to each instance. description: (EC2-VPC) Indicates whether to assign a public IP address to each instance.
@ -238,7 +238,7 @@ result:
device_name: device_name:
description: The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh). description: The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh).
returned: when I(state=present) returned: when I(state=present)
type: string type: str
sample: /dev/sda1 sample: /dev/sda1
ebs: ebs:
description: The information about the Amazon EBS volume. description: The information about the Amazon EBS volume.
@ -253,7 +253,7 @@ result:
volume_size: volume_size:
description: The volume size, in GiB. description: The volume size, in GiB.
returned: when I(state=present) returned: when I(state=present)
type: string type: str
sample: '100' sample: '100'
virtual_name: virtual_name:
description: The name of the virtual device (for example, ephemeral0). description: The name of the virtual device (for example, ephemeral0).
@ -273,7 +273,7 @@ result:
created_time: created_time:
description: The creation date and time for the launch configuration. description: The creation date and time for the launch configuration.
returned: when I(state=present) returned: when I(state=present)
type: string type: str
sample: '2017-11-03 23:46:44.841000' sample: '2017-11-03 23:46:44.841000'
delete_on_termination: delete_on_termination:
description: Indicates whether the volume is deleted on instance termination. description: Indicates whether the volume is deleted on instance termination.
@ -288,7 +288,7 @@ result:
image_id: image_id:
description: The ID of the Amazon Machine Image used by the launch configuration. description: The ID of the Amazon Machine Image used by the launch configuration.
returned: when I(state=present) returned: when I(state=present)
type: string type: str
sample: ami-9be6f38c sample: ami-9be6f38c
instance_monitoring: instance_monitoring:
description: Indicates whether instances in this group are launched with detailed (true) or basic (false) monitoring. description: Indicates whether instances in this group are launched with detailed (true) or basic (false) monitoring.
@ -298,12 +298,12 @@ result:
instance_profile_name: instance_profile_name:
description: The name or Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. description: The name or Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.
returned: when I(state=present) returned: when I(state=present)
type: string type: str
sample: null sample: null
instance_type: instance_type:
description: The instance type for the instances. description: The instance type for the instances.
returned: when I(state=present) returned: when I(state=present)
type: string type: str
sample: t1.micro sample: t1.micro
iops: iops:
description: The number of I/O operations per second (IOPS) to provision for the volume. description: The number of I/O operations per second (IOPS) to provision for the volume.
@ -313,32 +313,32 @@ result:
kernel_id: kernel_id:
description: The ID of the kernel associated with the AMI. description: The ID of the kernel associated with the AMI.
returned: when I(state=present) returned: when I(state=present)
type: string type: str
sample: '' sample: ''
key_name: key_name:
description: The name of the key pair. description: The name of the key pair.
returned: when I(state=present) returned: when I(state=present)
type: string type: str
sample: testkey sample: testkey
launch_configuration_arn: launch_configuration_arn:
description: The Amazon Resource Name (ARN) of the launch configuration. description: The Amazon Resource Name (ARN) of the launch configuration.
returned: when I(state=present) returned: when I(state=present)
type: string type: str
sample: arn:aws:autoscaling:us-east-1:148830907657:launchConfiguration:888d9b58-d93a-40c4-90cf-759197a2621a:launchConfigurationName/launch_config_name sample: arn:aws:autoscaling:us-east-1:148830907657:launchConfiguration:888d9b58-d93a-40c4-90cf-759197a2621a:launchConfigurationName/launch_config_name
member: member:
description: "" description: ""
returned: when I(state=present) returned: when I(state=present)
type: string type: str
sample: "\n " sample: "\n "
name: name:
description: The name of the launch configuration. description: The name of the launch configuration.
returned: when I(state=present) returned: when I(state=present)
type: string type: str
sample: launch_config_name sample: launch_config_name
ramdisk_id: ramdisk_id:
description: The ID of the RAM disk associated with the AMI. description: The ID of the RAM disk associated with the AMI.
returned: when I(state=present) returned: when I(state=present)
type: string type: str
sample: '' sample: ''
security_groups: security_groups:
description: The security groups to associate with the instances. description: The security groups to associate with the instances.
@ -359,7 +359,7 @@ result:
user_data: user_data:
description: The user data available to the instances. description: The user data available to the instances.
returned: when I(state=present) returned: when I(state=present)
type: string type: str
sample: '' sample: ''
volume_type: volume_type:
description: The volume type (one of standard, io1, gp2). description: The volume type (one of standard, io1, gp2).

20
lib/ansible/modules/cloud/amazon/ec2_lc_facts.py
View file

@ -79,12 +79,12 @@ block_device_mapping:
}]" }]"
classic_link_vpc_security_groups: classic_link_vpc_security_groups:
description: IDs of one or more security groups for the VPC specified in classic_link_vpc_id description: IDs of one or more security groups for the VPC specified in classic_link_vpc_id
type: string type: str
returned: always returned: always
sample: sample:
created_time: created_time:
description: The creation date and time for the launch configuration description: The creation date and time for the launch configuration
type: string type: str
returned: always returned: always
sample: "2016-05-27T13:47:44.216000+00:00" sample: "2016-05-27T13:47:44.216000+00:00"
ebs_optimized: ebs_optimized:
@ -94,7 +94,7 @@ ebs_optimized:
sample: true, sample: true,
image_id: image_id:
description: ID of the Amazon Machine Image (AMI) description: ID of the Amazon Machine Image (AMI)
type: string type: str
returned: always returned: always
sample: "ami-12345678" sample: "ami-12345678"
instance_monitoring: instance_monitoring:
@ -106,32 +106,32 @@ instance_monitoring:
}" }"
instance_type: instance_type:
description: Instance type description: Instance type
type: string type: str
returned: always returned: always
sample: "t2.micro" sample: "t2.micro"
kernel_id: kernel_id:
description: ID of the kernel associated with the AMI description: ID of the kernel associated with the AMI
type: string type: str
returned: always returned: always
sample: sample:
key_name: key_name:
description: Name of the key pair description: Name of the key pair
type: string type: str
returned: always returned: always
sample: "user_app" sample: "user_app"
launch_configuration_arn: launch_configuration_arn:
description: Amazon Resource Name (ARN) of the launch configuration description: Amazon Resource Name (ARN) of the launch configuration
type: string type: str
returned: always returned: always
sample: "arn:aws:autoscaling:us-east-1:666612345678:launchConfiguration:ba785e3a-dd42-6f02-4585-ea1a2b458b3d:launchConfigurationName/lc-app" sample: "arn:aws:autoscaling:us-east-1:666612345678:launchConfiguration:ba785e3a-dd42-6f02-4585-ea1a2b458b3d:launchConfigurationName/lc-app"
launch_configuration_name: launch_configuration_name:
description: Name of the launch configuration description: Name of the launch configuration
type: string type: str
returned: always returned: always
sample: "lc-app" sample: "lc-app"
ramdisk_id: ramdisk_id:
description: ID of the RAM disk associated with the AMI description: ID of the RAM disk associated with the AMI
type: string type: str
returned: always returned: always
sample: sample:
security_groups: security_groups:
@ -143,7 +143,7 @@ security_groups:
]" ]"
user_data: user_data:
description: User data available description: User data available
type: string type: str
returned: always returned: always
sample: sample:
''' '''

24
lib/ansible/modules/cloud/amazon/ec2_lc_find.py
View file

@ -66,42 +66,42 @@ RETURN = '''
image_id: image_id:
description: AMI id description: AMI id
returned: when Launch Configuration was found returned: when Launch Configuration was found
type: string type: str
sample: "ami-0d75df7e" sample: "ami-0d75df7e"
user_data: user_data:
description: User data used to start instance description: User data used to start instance
returned: when Launch Configuration was found returned: when Launch Configuration was found
type: string type: str
sample: "ZXhwb3J0IENMT1VE" sample: "ZXhwb3J0IENMT1VE"
name: name:
description: Name of the Launch Configuration description: Name of the Launch Configuration
returned: when Launch Configuration was found returned: when Launch Configuration was found
type: string type: str
sample: "myapp-v123" sample: "myapp-v123"
arn: arn:
description: Name of the AMI description: Name of the AMI
returned: when Launch Configuration was found returned: when Launch Configuration was found
type: string type: str
sample: "arn:aws:autoscaling:eu-west-1:12345:launchConfiguration:d82f050e-e315:launchConfigurationName/yourproject" sample: "arn:aws:autoscaling:eu-west-1:12345:launchConfiguration:d82f050e-e315:launchConfigurationName/yourproject"
instance_type: instance_type:
description: Type of ec2 instance description: Type of ec2 instance
returned: when Launch Configuration was found returned: when Launch Configuration was found
type: string type: str
sample: "t2.small" sample: "t2.small"
created_time: created_time:
description: When it was created description: When it was created
returned: when Launch Configuration was found returned: when Launch Configuration was found
type: string type: str
sample: "2016-06-29T14:59:22.222000+00:00" sample: "2016-06-29T14:59:22.222000+00:00"
ebs_optimized: ebs_optimized:
description: Launch Configuration EBS optimized property description: Launch Configuration EBS optimized property
returned: when Launch Configuration was found returned: when Launch Configuration was found
type: boolean type: bool
sample: False sample: False
instance_monitoring: instance_monitoring:
description: Launch Configuration instance monitoring property description: Launch Configuration instance monitoring property
returned: when Launch Configuration was found returned: when Launch Configuration was found
type: string type: str
sample: {"Enabled": false} sample: {"Enabled": false}
classic_link_vpc_security_groups: classic_link_vpc_security_groups:
description: Launch Configuration classic link vpc security groups property description: Launch Configuration classic link vpc security groups property
@ -116,7 +116,7 @@ block_device_mappings:
keyname: keyname:
description: Launch Configuration ssh key description: Launch Configuration ssh key
returned: when Launch Configuration was found returned: when Launch Configuration was found
type: string type: str
sample: mykey sample: mykey
security_groups: security_groups:
description: Launch Configuration security groups description: Launch Configuration security groups
@ -126,17 +126,17 @@ security_groups:
kernel_id: kernel_id:
description: Launch Configuration kernel to use description: Launch Configuration kernel to use
returned: when Launch Configuration was found returned: when Launch Configuration was found
type: string type: str
sample: '' sample: ''
ram_disk_id: ram_disk_id:
description: Launch Configuration ram disk property description: Launch Configuration ram disk property
returned: when Launch Configuration was found returned: when Launch Configuration was found
type: string type: str
sample: '' sample: ''
associate_public_address: associate_public_address:
description: Assign public address or not description: Assign public address or not
returned: when Launch Configuration was found returned: when Launch Configuration was found
type: boolean type: bool
sample: True sample: True
... ...
''' '''

162
lib/ansible/modules/cloud/amazon/ec2_metadata_facts.py
View file

@ -45,60 +45,60 @@ ansible_facts:
contains: contains:
ansible_ec2_ami_id: ansible_ec2_ami_id:
description: The AMI ID used to launch the instance. description: The AMI ID used to launch the instance.
type: string type: str
sample: "ami-XXXXXXXX" sample: "ami-XXXXXXXX"
ansible_ec2_ami_launch_index: ansible_ec2_ami_launch_index:
description: description:
- If you started more than one instance at the same time, this value indicates the order in which the instance was launched. - If you started more than one instance at the same time, this value indicates the order in which the instance was launched.
The value of the first instance launched is 0. The value of the first instance launched is 0.
type: string type: str
sample: "0" sample: "0"
ansible_ec2_ami_manifest_path: ansible_ec2_ami_manifest_path:
description: description:
- The path to the AMI manifest file in Amazon S3. - The path to the AMI manifest file in Amazon S3.
If you used an Amazon EBS-backed AMI to launch the instance, the returned result is unknown. If you used an Amazon EBS-backed AMI to launch the instance, the returned result is unknown.
type: string type: str
sample: "(unknown)" sample: "(unknown)"
ansible_ec2_ancestor_ami_ids: ansible_ec2_ancestor_ami_ids:
description: description:
- The AMI IDs of any instances that were rebundled to create this AMI. - The AMI IDs of any instances that were rebundled to create this AMI.
This value will only exist if the AMI manifest file contained an ancestor-amis key. This value will only exist if the AMI manifest file contained an ancestor-amis key.
type: string type: str
sample: "(unknown)" sample: "(unknown)"
ansible_ec2_block_device_mapping_ami: ansible_ec2_block_device_mapping_ami:
description: The virtual device that contains the root/boot file system. description: The virtual device that contains the root/boot file system.
type: string type: str
sample: "/dev/sda1" sample: "/dev/sda1"
ansible_ec2_block_device_mapping_ebsN: ansible_ec2_block_device_mapping_ebsN:
description: description:
- The virtual devices associated with Amazon EBS volumes, if any are present. - The virtual devices associated with Amazon EBS volumes, if any are present.
Amazon EBS volumes are only available in metadata if they were present at launch time or when the instance was last started. Amazon EBS volumes are only available in metadata if they were present at launch time or when the instance was last started.
The N indicates the index of the Amazon EBS volume (such as ebs1 or ebs2). The N indicates the index of the Amazon EBS volume (such as ebs1 or ebs2).
type: string type: str
sample: "/dev/xvdb" sample: "/dev/xvdb"
ansible_ec2_block_device_mapping_ephemeralN: ansible_ec2_block_device_mapping_ephemeralN:
description: The virtual devices associated with ephemeral devices, if any are present. The N indicates the index of the ephemeral volume. description: The virtual devices associated with ephemeral devices, if any are present. The N indicates the index of the ephemeral volume.
type: string type: str
sample: "/dev/xvdc" sample: "/dev/xvdc"
ansible_ec2_block_device_mapping_root: ansible_ec2_block_device_mapping_root:
description: description:
- The virtual devices or partitions associated with the root devices, or partitions on the virtual device, - The virtual devices or partitions associated with the root devices, or partitions on the virtual device,
where the root (/ or C) file system is associated with the given instance. where the root (/ or C) file system is associated with the given instance.
type: string type: str
sample: "/dev/sda1" sample: "/dev/sda1"
ansible_ec2_block_device_mapping_swap: ansible_ec2_block_device_mapping_swap:
description: The virtual devices associated with swap. Not always present. description: The virtual devices associated with swap. Not always present.
type: string type: str
sample: "/dev/sda2" sample: "/dev/sda2"
ansible_ec2_fws_instance_monitoring: ansible_ec2_fws_instance_monitoring:
description: "Value showing whether the customer has enabled detailed one-minute monitoring in CloudWatch." description: "Value showing whether the customer has enabled detailed one-minute monitoring in CloudWatch."
type: string type: str
sample: "enabled" sample: "enabled"
ansible_ec2_hostname: ansible_ec2_hostname:
description: description:
- The private IPv4 DNS hostname of the instance. - The private IPv4 DNS hostname of the instance.
In cases where multiple network interfaces are present, this refers to the eth0 device (the device for which the device number is 0). In cases where multiple network interfaces are present, this refers to the eth0 device (the device for which the device number is 0).
type: string type: str
sample: "ip-10-0-0-1.ec2.internal" sample: "ip-10-0-0-1.ec2.internal"
ansible_ec2_iam_info: ansible_ec2_iam_info:
description: description:
@ -108,310 +108,310 @@ ansible_facts:
sample: "" sample: ""
ansible_ec2_iam_info_instanceprofilearn: ansible_ec2_iam_info_instanceprofilearn:
description: The IAM instance profile ARN. description: The IAM instance profile ARN.
type: string type: str
sample: "arn:aws:iam::<account id>:instance-profile/<role name>" sample: "arn:aws:iam::<account id>:instance-profile/<role name>"
ansible_ec2_iam_info_instanceprofileid: ansible_ec2_iam_info_instanceprofileid:
description: IAM instance profile ID. description: IAM instance profile ID.
type: string type: str
sample: "" sample: ""
ansible_ec2_iam_info_lastupdated: ansible_ec2_iam_info_lastupdated:
description: IAM info last updated time. description: IAM info last updated time.
type: string type: str
sample: "2017-05-12T02:42:27Z" sample: "2017-05-12T02:42:27Z"
ansible_ec2_iam_instance_profile_role: ansible_ec2_iam_instance_profile_role:
description: IAM instance role. description: IAM instance role.
type: string type: str
sample: "role_name" sample: "role_name"
ansible_ec2_iam_security_credentials_<role name>: ansible_ec2_iam_security_credentials_<role name>:
description: description:
- If there is an IAM role associated with the instance, role-name is the name of the role, - If there is an IAM role associated with the instance, role-name is the name of the role,
and role-name contains the temporary security credentials associated with the role. Otherwise, not present. and role-name contains the temporary security credentials associated with the role. Otherwise, not present.
type: string type: str
sample: "" sample: ""
ansible_ec2_iam_security_credentials_<role name>_accesskeyid: ansible_ec2_iam_security_credentials_<role name>_accesskeyid:
description: IAM role access key ID. description: IAM role access key ID.
type: string type: str
sample: "" sample: ""
ansible_ec2_iam_security_credentials_<role name>_code: ansible_ec2_iam_security_credentials_<role name>_code:
description: IAM code. description: IAM code.
type: string type: str
sample: "Success" sample: "Success"
ansible_ec2_iam_security_credentials_<role name>_expiration: ansible_ec2_iam_security_credentials_<role name>_expiration:
description: IAM role credentials expiration time. description: IAM role credentials expiration time.
type: string type: str
sample: "2017-05-12T09:11:41Z" sample: "2017-05-12T09:11:41Z"
ansible_ec2_iam_security_credentials_<role name>_lastupdated: ansible_ec2_iam_security_credentials_<role name>_lastupdated:
description: IAM role last updated time. description: IAM role last updated time.
type: string type: str
sample: "2017-05-12T02:40:44Z" sample: "2017-05-12T02:40:44Z"
ansible_ec2_iam_security_credentials_<role name>_secretaccesskey: ansible_ec2_iam_security_credentials_<role name>_secretaccesskey:
description: IAM role secret access key. description: IAM role secret access key.
type: string type: str
sample: "" sample: ""
ansible_ec2_iam_security_credentials_<role name>_token: ansible_ec2_iam_security_credentials_<role name>_token:
description: IAM role token. description: IAM role token.
type: string type: str
sample: "" sample: ""
ansible_ec2_iam_security_credentials_<role name>_type: ansible_ec2_iam_security_credentials_<role name>_type:
description: IAM role type. description: IAM role type.
type: string type: str
sample: "AWS-HMAC" sample: "AWS-HMAC"
ansible_ec2_instance_action: ansible_ec2_instance_action:
description: Notifies the instance that it should reboot in preparation for bundling. description: Notifies the instance that it should reboot in preparation for bundling.
type: string type: str
sample: "none" sample: "none"
ansible_ec2_instance_id: ansible_ec2_instance_id:
description: The ID of this instance. description: The ID of this instance.
type: string type: str
sample: "i-XXXXXXXXXXXXXXXXX" sample: "i-XXXXXXXXXXXXXXXXX"
ansible_ec2_instance_identity_document: ansible_ec2_instance_identity_document:
description: JSON containing instance attributes, such as instance-id, private IP address, etc. description: JSON containing instance attributes, such as instance-id, private IP address, etc.
type: string type: str
sample: "" sample: ""
ansible_ec2_instance_identity_document_accountid: ansible_ec2_instance_identity_document_accountid:
description: "" description: ""
type: string type: str
sample: "012345678901" sample: "012345678901"
ansible_ec2_instance_identity_document_architecture: ansible_ec2_instance_identity_document_architecture:
description: Instance system architecture. description: Instance system architecture.
type: string type: str
sample: "x86_64" sample: "x86_64"
ansible_ec2_instance_identity_document_availabilityzone: ansible_ec2_instance_identity_document_availabilityzone:
description: The Availability Zone in which the instance launched. description: The Availability Zone in which the instance launched.
type: string type: str
sample: "us-east-1a" sample: "us-east-1a"
ansible_ec2_instance_identity_document_billingproducts: ansible_ec2_instance_identity_document_billingproducts:
description: Billing products for this instance. description: Billing products for this instance.
type: string type: str
sample: "" sample: ""
ansible_ec2_instance_identity_document_devpayproductcodes: ansible_ec2_instance_identity_document_devpayproductcodes:
description: Product codes for the launched AMI. description: Product codes for the launched AMI.
type: string type: str
sample: "" sample: ""
ansible_ec2_instance_identity_document_imageid: ansible_ec2_instance_identity_document_imageid:
description: The AMI ID used to launch the instance. description: The AMI ID used to launch the instance.
type: string type: str
sample: "ami-01234567" sample: "ami-01234567"
ansible_ec2_instance_identity_document_instanceid: ansible_ec2_instance_identity_document_instanceid:
description: The ID of this instance. description: The ID of this instance.
type: string type: str
sample: "i-0123456789abcdef0" sample: "i-0123456789abcdef0"
ansible_ec2_instance_identity_document_instancetype: ansible_ec2_instance_identity_document_instancetype:
description: The type of instance. description: The type of instance.
type: string type: str
sample: "m4.large" sample: "m4.large"
ansible_ec2_instance_identity_document_kernelid: ansible_ec2_instance_identity_document_kernelid:
description: The ID of the kernel launched with this instance, if applicable. description: The ID of the kernel launched with this instance, if applicable.
type: string type: str
sample: "" sample: ""
ansible_ec2_instance_identity_document_pendingtime: ansible_ec2_instance_identity_document_pendingtime:
description: The instance pending time. description: The instance pending time.
type: string type: str
sample: "2017-05-11T20:51:20Z" sample: "2017-05-11T20:51:20Z"
ansible_ec2_instance_identity_document_privateip: ansible_ec2_instance_identity_document_privateip:
description: description:
- The private IPv4 address of the instance. - The private IPv4 address of the instance.
In cases where multiple network interfaces are present, this refers to the eth0 device (the device for which the device number is 0). In cases where multiple network interfaces are present, this refers to the eth0 device (the device for which the device number is 0).
type: string type: str
sample: "10.0.0.1" sample: "10.0.0.1"
ansible_ec2_instance_identity_document_ramdiskid: ansible_ec2_instance_identity_document_ramdiskid:
description: The ID of the RAM disk specified at launch time, if applicable. description: The ID of the RAM disk specified at launch time, if applicable.
type: string type: str
sample: "" sample: ""
ansible_ec2_instance_identity_document_region: ansible_ec2_instance_identity_document_region:
description: The Region in which the instance launched. description: The Region in which the instance launched.
type: string type: str
sample: "us-east-1" sample: "us-east-1"
ansible_ec2_instance_identity_document_version: ansible_ec2_instance_identity_document_version:
description: Identity document version. description: Identity document version.
type: string type: str
sample: "2010-08-31" sample: "2010-08-31"
ansible_ec2_instance_identity_pkcs7: ansible_ec2_instance_identity_pkcs7:
description: Used to verify the document's authenticity and content against the signature. description: Used to verify the document's authenticity and content against the signature.
type: string type: str
sample: "" sample: ""
ansible_ec2_instance_identity_rsa2048: ansible_ec2_instance_identity_rsa2048:
description: Used to verify the document's authenticity and content against the signature. description: Used to verify the document's authenticity and content against the signature.
type: string type: str
sample: "" sample: ""
ansible_ec2_instance_identity_signature: ansible_ec2_instance_identity_signature:
description: Data that can be used by other parties to verify its origin and authenticity. description: Data that can be used by other parties to verify its origin and authenticity.
type: string type: str
sample: "" sample: ""
ansible_ec2_instance_type: ansible_ec2_instance_type:
description: The type of instance. description: The type of instance.
type: string type: str
sample: "m4.large" sample: "m4.large"
ansible_ec2_local_hostname: ansible_ec2_local_hostname:
description: description:
- The private IPv4 DNS hostname of the instance. - The private IPv4 DNS hostname of the instance.
In cases where multiple network interfaces are present, this refers to the eth0 device (the device for which the device number is 0). In cases where multiple network interfaces are present, this refers to the eth0 device (the device for which the device number is 0).
type: string type: str
sample: "ip-10-0-0-1.ec2.internal" sample: "ip-10-0-0-1.ec2.internal"
ansible_ec2_local_ipv4: ansible_ec2_local_ipv4:
description: description:
- The private IPv4 address of the instance. - The private IPv4 address of the instance.
In cases where multiple network interfaces are present, this refers to the eth0 device (the device for which the device number is 0). In cases where multiple network interfaces are present, this refers to the eth0 device (the device for which the device number is 0).
type: string type: str
sample: "10.0.0.1" sample: "10.0.0.1"
ansible_ec2_mac: ansible_ec2_mac:
description: description:
- The instance's media access control (MAC) address. - The instance's media access control (MAC) address.
In cases where multiple network interfaces are present, this refers to the eth0 device (the device for which the device number is 0). In cases where multiple network interfaces are present, this refers to the eth0 device (the device for which the device number is 0).
type: string type: str
sample: "00:11:22:33:44:55" sample: "00:11:22:33:44:55"
ansible_ec2_metrics_vhostmd: ansible_ec2_metrics_vhostmd:
description: Metrics. description: Metrics.
type: string type: str
sample: "" sample: ""
ansible_ec2_network_interfaces_macs_<mac address>_device_number: ansible_ec2_network_interfaces_macs_<mac address>_device_number:
description: description:
- The unique device number associated with that interface. The device number corresponds to the device name; - The unique device number associated with that interface. The device number corresponds to the device name;
for example, a device-number of 2 is for the eth2 device. for example, a device-number of 2 is for the eth2 device.
This category corresponds to the DeviceIndex and device-index fields that are used by the Amazon EC2 API and the EC2 commands for the AWS CLI. This category corresponds to the DeviceIndex and device-index fields that are used by the Amazon EC2 API and the EC2 commands for the AWS CLI.
type: string type: str
sample: "0" sample: "0"
ansible_ec2_network_interfaces_macs_<mac address>_interface_id: ansible_ec2_network_interfaces_macs_<mac address>_interface_id:
description: The elastic network interface ID. description: The elastic network interface ID.
type: string type: str
sample: "eni-12345678" sample: "eni-12345678"
ansible_ec2_network_interfaces_macs_<mac address>_ipv4_associations_<ip address>: ansible_ec2_network_interfaces_macs_<mac address>_ipv4_associations_<ip address>:
description: The private IPv4 addresses that are associated with each public-ip address and assigned to that interface. description: The private IPv4 addresses that are associated with each public-ip address and assigned to that interface.
type: string type: str
sample: "" sample: ""
ansible_ec2_network_interfaces_macs_<mac address>_ipv6s: ansible_ec2_network_interfaces_macs_<mac address>_ipv6s:
description: The IPv6 addresses associated with the interface. Returned only for instances launched into a VPC. description: The IPv6 addresses associated with the interface. Returned only for instances launched into a VPC.
type: string type: str
sample: "" sample: ""
ansible_ec2_network_interfaces_macs_<mac address>_local_hostname: ansible_ec2_network_interfaces_macs_<mac address>_local_hostname:
description: The interface's local hostname. description: The interface's local hostname.
type: string type: str
sample: "" sample: ""
ansible_ec2_network_interfaces_macs_<mac address>_local_ipv4s: ansible_ec2_network_interfaces_macs_<mac address>_local_ipv4s:
description: The private IPv4 addresses associated with the interface. description: The private IPv4 addresses associated with the interface.
type: string type: str
sample: "" sample: ""
ansible_ec2_network_interfaces_macs_<mac address>_mac: ansible_ec2_network_interfaces_macs_<mac address>_mac:
description: The instance's MAC address. description: The instance's MAC address.
type: string type: str
sample: "00:11:22:33:44:55" sample: "00:11:22:33:44:55"
ansible_ec2_network_interfaces_macs_<mac address>_owner_id: ansible_ec2_network_interfaces_macs_<mac address>_owner_id:
description: description:
- The ID of the owner of the network interface. - The ID of the owner of the network interface.
In multiple-interface environments, an interface can be attached by a third party, such as Elastic Load Balancing. In multiple-interface environments, an interface can be attached by a third party, such as Elastic Load Balancing.
Traffic on an interface is always billed to the interface owner. Traffic on an interface is always billed to the interface owner.
type: string type: str
sample: "01234567890" sample: "01234567890"
ansible_ec2_network_interfaces_macs_<mac address>_public_hostname: ansible_ec2_network_interfaces_macs_<mac address>_public_hostname:
description: description:
- The interface's public DNS (IPv4). If the instance is in a VPC, - The interface's public DNS (IPv4). If the instance is in a VPC,
this category is only returned if the enableDnsHostnames attribute is set to true. this category is only returned if the enableDnsHostnames attribute is set to true.
type: string type: str
sample: "ec2-1-2-3-4.compute-1.amazonaws.com" sample: "ec2-1-2-3-4.compute-1.amazonaws.com"
ansible_ec2_network_interfaces_macs_<mac address>_public_ipv4s: ansible_ec2_network_interfaces_macs_<mac address>_public_ipv4s:
description: The Elastic IP addresses associated with the interface. There may be multiple IPv4 addresses on an instance. description: The Elastic IP addresses associated with the interface. There may be multiple IPv4 addresses on an instance.
type: string type: str
sample: "1.2.3.4" sample: "1.2.3.4"
ansible_ec2_network_interfaces_macs_<mac address>_security_group_ids: ansible_ec2_network_interfaces_macs_<mac address>_security_group_ids:
description: The IDs of the security groups to which the network interface belongs. Returned only for instances launched into a VPC. description: The IDs of the security groups to which the network interface belongs. Returned only for instances launched into a VPC.
type: string type: str
sample: "sg-01234567,sg-01234568" sample: "sg-01234567,sg-01234568"
ansible_ec2_network_interfaces_macs_<mac address>_security_groups: ansible_ec2_network_interfaces_macs_<mac address>_security_groups:
description: Security groups to which the network interface belongs. Returned only for instances launched into a VPC. description: Security groups to which the network interface belongs. Returned only for instances launched into a VPC.
type: string type: str
sample: "secgroup1,secgroup2" sample: "secgroup1,secgroup2"
ansible_ec2_network_interfaces_macs_<mac address>_subnet_id: ansible_ec2_network_interfaces_macs_<mac address>_subnet_id:
description: The ID of the subnet in which the interface resides. Returned only for instances launched into a VPC. description: The ID of the subnet in which the interface resides. Returned only for instances launched into a VPC.
type: string type: str
sample: "subnet-01234567" sample: "subnet-01234567"
ansible_ec2_network_interfaces_macs_<mac address>_subnet_ipv4_cidr_block: ansible_ec2_network_interfaces_macs_<mac address>_subnet_ipv4_cidr_block:
description: The IPv4 CIDR block of the subnet in which the interface resides. Returned only for instances launched into a VPC. description: The IPv4 CIDR block of the subnet in which the interface resides. Returned only for instances launched into a VPC.
type: string type: str
sample: "10.0.1.0/24" sample: "10.0.1.0/24"
ansible_ec2_network_interfaces_macs_<mac address>_subnet_ipv6_cidr_blocks: ansible_ec2_network_interfaces_macs_<mac address>_subnet_ipv6_cidr_blocks:
description: The IPv6 CIDR block of the subnet in which the interface resides. Returned only for instances launched into a VPC. description: The IPv6 CIDR block of the subnet in which the interface resides. Returned only for instances launched into a VPC.
type: string type: str
sample: "" sample: ""
ansible_ec2_network_interfaces_macs_<mac address>_vpc_id: ansible_ec2_network_interfaces_macs_<mac address>_vpc_id:
description: The ID of the VPC in which the interface resides. Returned only for instances launched into a VPC. description: The ID of the VPC in which the interface resides. Returned only for instances launched into a VPC.
type: string type: str
sample: "vpc-0123456" sample: "vpc-0123456"
ansible_ec2_network_interfaces_macs_<mac address>_vpc_ipv4_cidr_block: ansible_ec2_network_interfaces_macs_<mac address>_vpc_ipv4_cidr_block:
description: The IPv4 CIDR block of the VPC in which the interface resides. Returned only for instances launched into a VPC. description: The IPv4 CIDR block of the VPC in which the interface resides. Returned only for instances launched into a VPC.
type: string type: str
sample: "10.0.0.0/16" sample: "10.0.0.0/16"
ansible_ec2_network_interfaces_macs_<mac address>_vpc_ipv4_cidr_blocks: ansible_ec2_network_interfaces_macs_<mac address>_vpc_ipv4_cidr_blocks:
description: The IPv4 CIDR block of the VPC in which the interface resides. Returned only for instances launched into a VPC. description: The IPv4 CIDR block of the VPC in which the interface resides. Returned only for instances launched into a VPC.
type: string type: str
sample: "10.0.0.0/16" sample: "10.0.0.0/16"
ansible_ec2_network_interfaces_macs_<mac address>_vpc_ipv6_cidr_blocks: ansible_ec2_network_interfaces_macs_<mac address>_vpc_ipv6_cidr_blocks:
description: The IPv6 CIDR block of the VPC in which the interface resides. Returned only for instances launched into a VPC. description: The IPv6 CIDR block of the VPC in which the interface resides. Returned only for instances launched into a VPC.
type: string type: str
sample: "" sample: ""
ansible_ec2_placement_availability_zone: ansible_ec2_placement_availability_zone:
description: The Availability Zone in which the instance launched. description: The Availability Zone in which the instance launched.
type: string type: str
sample: "us-east-1a" sample: "us-east-1a"
ansible_ec2_placement_region: ansible_ec2_placement_region:
description: The Region in which the instance launched. description: The Region in which the instance launched.
type: string type: str
sample: "us-east-1" sample: "us-east-1"
ansible_ec2_product_codes: ansible_ec2_product_codes:
description: Product codes associated with the instance, if any. description: Product codes associated with the instance, if any.
type: string type: str
sample: "aw0evgkw8e5c1q413zgy5pjce" sample: "aw0evgkw8e5c1q413zgy5pjce"
ansible_ec2_profile: ansible_ec2_profile:
description: EC2 instance hardware profile. description: EC2 instance hardware profile.
type: string type: str
sample: "default-hvm" sample: "default-hvm"
ansible_ec2_public_hostname: ansible_ec2_public_hostname:
description: description:
- The instance's public DNS. If the instance is in a VPC, this category is only returned if the enableDnsHostnames attribute is set to true. - The instance's public DNS. If the instance is in a VPC, this category is only returned if the enableDnsHostnames attribute is set to true.
type: string type: str
sample: "ec2-1-2-3-4.compute-1.amazonaws.com" sample: "ec2-1-2-3-4.compute-1.amazonaws.com"
ansible_ec2_public_ipv4: ansible_ec2_public_ipv4:
description: The public IPv4 address. If an Elastic IP address is associated with the instance, the value returned is the Elastic IP address. description: The public IPv4 address. If an Elastic IP address is associated with the instance, the value returned is the Elastic IP address.
type: string type: str
sample: "1.2.3.4" sample: "1.2.3.4"
ansible_ec2_public_key: ansible_ec2_public_key:
description: Public key. Only available if supplied at instance launch time. description: Public key. Only available if supplied at instance launch time.
type: string type: str
sample: "" sample: ""
ansible_ec2_ramdisk_id: ansible_ec2_ramdisk_id:
description: The ID of the RAM disk specified at launch time, if applicable. description: The ID of the RAM disk specified at launch time, if applicable.
type: string type: str
sample: "" sample: ""
ansible_ec2_reservation_id: ansible_ec2_reservation_id:
description: The ID of the reservation. description: The ID of the reservation.
type: string type: str
sample: "r-0123456789abcdef0" sample: "r-0123456789abcdef0"
ansible_ec2_security_groups: ansible_ec2_security_groups:
description: description:
- The names of the security groups applied to the instance. After launch, you can only change the security groups of instances running in a VPC. - The names of the security groups applied to the instance. After launch, you can only change the security groups of instances running in a VPC.
Such changes are reflected here and in network/interfaces/macs/mac/security-groups. Such changes are reflected here and in network/interfaces/macs/mac/security-groups.
type: string type: str
sample: "securitygroup1,securitygroup2" sample: "securitygroup1,securitygroup2"
ansible_ec2_services_domain: ansible_ec2_services_domain:
description: The domain for AWS resources for the region; for example, amazonaws.com for us-east-1. description: The domain for AWS resources for the region; for example, amazonaws.com for us-east-1.
type: string type: str
sample: "amazonaws.com" sample: "amazonaws.com"
ansible_ec2_services_partition: ansible_ec2_services_partition:
description: description:
- The partition that the resource is in. For standard AWS regions, the partition is aws. - The partition that the resource is in. For standard AWS regions, the partition is aws.
If you have resources in other partitions, the partition is aws-partitionname. If you have resources in other partitions, the partition is aws-partitionname.
For example, the partition for resources in the China (Beijing) region is aws-cn. For example, the partition for resources in the China (Beijing) region is aws-cn.
type: string type: str
sample: "aws" sample: "aws"
ansible_ec2_spot_termination_time: ansible_ec2_spot_termination_time:
description: description:
- The approximate time, in UTC, that the operating system for your Spot instance will receive the shutdown signal. - The approximate time, in UTC, that the operating system for your Spot instance will receive the shutdown signal.
This item is present and contains a time value only if the Spot instance has been marked for termination by Amazon EC2. This item is present and contains a time value only if the Spot instance has been marked for termination by Amazon EC2.
The termination-time item is not set to a time if you terminated the Spot instance yourself. The termination-time item is not set to a time if you terminated the Spot instance yourself.
type: string type: str
sample: "2015-01-05T18:02:00Z" sample: "2015-01-05T18:02:00Z"
ansible_ec2_user_data: ansible_ec2_user_data:
description: The instance user data. description: The instance user data.
type: string type: str
sample: "#!/bin/bash" sample: "#!/bin/bash"
''' '''

6
lib/ansible/modules/cloud/amazon/ec2_placement_group.py
View file

@ -73,15 +73,15 @@ placement_group:
contains: contains:
name: name:
description: PG name description: PG name
type: string type: str
sample: my-cluster sample: my-cluster
state: state:
description: PG state description: PG state
type: string type: str
sample: "available" sample: "available"
strategy: strategy:
description: PG strategy description: PG strategy
type: string type: str
sample: "cluster" sample: "cluster"
''' '''

6
lib/ansible/modules/cloud/amazon/ec2_placement_group_facts.py
View file

@ -55,15 +55,15 @@ placement_groups:
contains: contains:
name: name:
description: PG name description: PG name
type: string type: str
sample: my-cluster sample: my-cluster
state: state:
description: PG state description: PG state
type: string type: str
sample: "available" sample: "available"
strategy: strategy:
description: PG strategy description: PG strategy
type: string type: str
sample: "cluster" sample: "cluster"
''' '''

2
lib/ansible/modules/cloud/amazon/ec2_snapshot_copy.py
View file

@ -102,7 +102,7 @@ RETURN = '''
snapshot_id: snapshot_id:
description: snapshot id of the newly created snapshot description: snapshot id of the newly created snapshot
returned: when snapshot copy is successful returned: when snapshot copy is successful
type: string type: str
sample: "snap-e9095e8c" sample: "snap-e9095e8c"
''' '''

24
lib/ansible/modules/cloud/amazon/ec2_snapshot_facts.py
View file

@ -95,44 +95,44 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
snapshot_id: snapshot_id:
description: The ID of the snapshot. Each snapshot receives a unique identifier when it is created. description: The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
type: string type: str
returned: always returned: always
sample: snap-01234567 sample: snap-01234567
volume_id: volume_id:
description: The ID of the volume that was used to create the snapshot. description: The ID of the volume that was used to create the snapshot.
type: string type: str
returned: always returned: always
sample: vol-01234567 sample: vol-01234567
state: state:
description: The snapshot state (completed, pending or error). description: The snapshot state (completed, pending or error).
type: string type: str
returned: always returned: always
sample: completed sample: completed
state_message: state_message:
description: Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper description: Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper
AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the
error occurred. error occurred.
type: string type: str
returned: always returned: always
sample: sample:
start_time: start_time:
description: The time stamp when the snapshot was initiated. description: The time stamp when the snapshot was initiated.
type: string type: str
returned: always returned: always
sample: "2015-02-12T02:14:02+00:00" sample: "2015-02-12T02:14:02+00:00"
progress: progress:
description: The progress of the snapshot, as a percentage. description: The progress of the snapshot, as a percentage.
type: string type: str
returned: always returned: always
sample: "100%" sample: "100%"
owner_id: owner_id:
description: The AWS account ID of the EBS snapshot owner. description: The AWS account ID of the EBS snapshot owner.
type: string type: str
returned: always returned: always
sample: "099720109477" sample: "099720109477"
description: description:
description: The description for the snapshot. description: The description for the snapshot.
type: string type: str
returned: always returned: always
sample: "My important backup" sample: "My important backup"
volume_size: volume_size:
@ -142,7 +142,7 @@ volume_size:
sample: 8 sample: 8
owner_alias: owner_alias:
description: The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot. description: The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.
type: string type: str
returned: always returned: always
sample: "033440102211" sample: "033440102211"
tags: tags:
@ -152,19 +152,19 @@ tags:
sample: "{ 'my_tag_key': 'my_tag_value' }" sample: "{ 'my_tag_key': 'my_tag_value' }"
encrypted: encrypted:
description: Indicates whether the snapshot is encrypted. description: Indicates whether the snapshot is encrypted.
type: boolean type: bool
returned: always returned: always
sample: "True" sample: "True"
kms_key_id: kms_key_id:
description: The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to \ description: The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to \
protect the volume encryption key for the parent volume. protect the volume encryption key for the parent volume.
type: string type: str
returned: always returned: always
sample: "74c9742a-a1b2-45cb-b3fe-abcdef123456" sample: "74c9742a-a1b2-45cb-b3fe-abcdef123456"
data_encryption_key_id: data_encryption_key_id:
description: The data encryption key identifier for the snapshot. This value is a unique identifier that \ description: The data encryption key identifier for the snapshot. This value is a unique identifier that \
corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy.
type: string type: str
returned: always returned: always
sample: "arn:aws:kms:ap-southeast-2:012345678900:key/74c9742a-a1b2-45cb-b3fe-abcdef123456" sample: "arn:aws:kms:ap-southeast-2:012345678900:key/74c9742a-a1b2-45cb-b3fe-abcdef123456"

8
lib/ansible/modules/cloud/amazon/ec2_vol.py
View file

@ -183,22 +183,22 @@ RETURN = '''
device: device:
description: device name of attached volume description: device name of attached volume
returned: when success returned: when success
type: string type: str
sample: "/def/sdf" sample: "/def/sdf"
volume_id: volume_id:
description: the id of volume description: the id of volume
returned: when success returned: when success
type: string type: str
sample: "vol-35b333d9" sample: "vol-35b333d9"
volume_type: volume_type:
description: the volume type description: the volume type
returned: when success returned: when success
type: string type: str
sample: "standard" sample: "standard"
volume: volume:
description: a dictionary containing detailed attributes of the volume description: a dictionary containing detailed attributes of the volume
returned: when success returned: when success
type: string type: str
sample: { sample: {
"attachment_set": { "attachment_set": {
"attach_time": "2015-10-23T00:22:29.000Z", "attach_time": "2015-10-23T00:22:29.000Z",

2
lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option.py
View file

@ -114,7 +114,7 @@ new_options:
domain-name: "my.example.com" domain-name: "my.example.com"
dhcp_options_id: dhcp_options_id:
description: The aws resource id of the primary DCHP options set created, found or removed description: The aws resource id of the primary DCHP options set created, found or removed
type: string type: str
returned: when available returned: when available
changed: changed:
description: Whether the dhcp options were changed description: Whether the dhcp options were changed

4
lib/ansible/modules/cloud/amazon/ec2_vpc_egress_igw.py
View file

@ -46,12 +46,12 @@ RETURN = '''
gateway_id: gateway_id:
description: The ID of the Egress Only Internet Gateway or Null. description: The ID of the Egress Only Internet Gateway or Null.
returned: always returned: always
type: string type: str
sample: eigw-0e00cf111ba5bc11e sample: eigw-0e00cf111ba5bc11e
vpc_id: vpc_id:
description: The ID of the VPC to attach or detach gateway from. description: The ID of the VPC to attach or detach gateway from.
returned: always returned: always
type: string type: str
sample: vpc-012345678 sample: vpc-012345678
''' '''

2
lib/ansible/modules/cloud/amazon/ec2_vpc_nacl.py
View file

@ -139,7 +139,7 @@ RETURN = '''
task: task:
description: The result of the create, or delete action. description: The result of the create, or delete action.
returned: success returned: success
type: dictionary type: dict
''' '''
try: try:

6
lib/ansible/modules/cloud/amazon/ec2_vpc_nacl_facts.py
View file

@ -68,15 +68,15 @@ nacls:
nacl_id: nacl_id:
description: The ID of the Network Access Control List. description: The ID of the Network Access Control List.
returned: always returned: always
type: string type: str
vpc_id: vpc_id:
description: The ID of the VPC that the NACL is attached to. description: The ID of the VPC that the NACL is attached to.
returned: always returned: always
type: string type: str
is_default: is_default:
description: True if the NACL is the default for its VPC. description: True if the NACL is the default for its VPC.
returned: always returned: always
type: boolean type: bool
tags: tags:
description: A dict of tags associated with the NACL. description: A dict of tags associated with the NACL.
returned: always returned: always

12
lib/ansible/modules/cloud/amazon/ec2_vpc_nat_gateway.py
View file

@ -156,32 +156,32 @@ RETURN = '''
create_time: create_time:
description: The ISO 8601 date time format in UTC. description: The ISO 8601 date time format in UTC.
returned: In all cases. returned: In all cases.
type: string type: str
sample: "2016-03-05T05:19:20.282000+00:00'" sample: "2016-03-05T05:19:20.282000+00:00'"
nat_gateway_id: nat_gateway_id:
description: id of the VPC NAT Gateway description: id of the VPC NAT Gateway
returned: In all cases. returned: In all cases.
type: string type: str
sample: "nat-0d1e3a878585988f8" sample: "nat-0d1e3a878585988f8"
subnet_id: subnet_id:
description: id of the Subnet description: id of the Subnet
returned: In all cases. returned: In all cases.
type: string type: str
sample: "subnet-12345" sample: "subnet-12345"
state: state:
description: The current state of the NAT Gateway. description: The current state of the NAT Gateway.
returned: In all cases. returned: In all cases.
type: string type: str
sample: "available" sample: "available"
vpc_id: vpc_id:
description: id of the VPC. description: id of the VPC.
returned: In all cases. returned: In all cases.
type: string type: str
sample: "vpc-12345" sample: "vpc-12345"
nat_gateway_addresses: nat_gateway_addresses:
description: List of dictionairies containing the public_ip, network_interface_id, private_ip, and allocation_id. description: List of dictionairies containing the public_ip, network_interface_id, private_ip, and allocation_id.
returned: In all cases. returned: In all cases.
type: string type: str
sample: [ sample: [
{ {
'public_ip': '52.52.52.52', 'public_ip': '52.52.52.52',

12
lib/ansible/modules/cloud/amazon/ec2_vpc_net.py
View file

@ -102,7 +102,7 @@ vpc:
cidr_block: cidr_block:
description: The CIDR of the VPC description: The CIDR of the VPC
returned: always returned: always
type: string type: str
sample: 10.0.0.0/16 sample: 10.0.0.0/16
cidr_block_association_set: cidr_block_association_set:
description: IPv4 CIDR blocks associated with the VPC description: IPv4 CIDR blocks associated with the VPC
@ -126,17 +126,17 @@ vpc:
dhcp_options_id: dhcp_options_id:
description: the id of the DHCP options assocaited with this VPC description: the id of the DHCP options assocaited with this VPC
returned: always returned: always
type: string type: str
sample: dopt-0fb8bd6b sample: dopt-0fb8bd6b
id: id:
description: VPC resource id description: VPC resource id
returned: always returned: always
type: string type: str
sample: vpc-c2e00da5 sample: vpc-c2e00da5
instance_tenancy: instance_tenancy:
description: indicates whether VPC uses default or dedicated tenancy description: indicates whether VPC uses default or dedicated tenancy
returned: always returned: always
type: string type: str
sample: default sample: default
is_default: is_default:
description: indicates whether this is the default VPC description: indicates whether this is the default VPC
@ -146,7 +146,7 @@ vpc:
state: state:
description: state of the VPC description: state of the VPC
returned: always returned: always
type: string type: str
sample: available sample: available
tags: tags:
description: tags attached to the VPC, includes name description: tags attached to the VPC, includes name
@ -156,7 +156,7 @@ vpc:
Name: Name:
description: name tag for the VPC description: name tag for the VPC
returned: always returned: always
type: string type: str
sample: pk_vpc4 sample: pk_vpc4
''' '''

26
lib/ansible/modules/cloud/amazon/ec2_vpc_net_facts.py
View file

@ -69,15 +69,15 @@ vpcs:
id: id:
description: The ID of the VPC (for backwards compatibility). description: The ID of the VPC (for backwards compatibility).
returned: always returned: always
type: string type: str
vpc_id: vpc_id:
description: The ID of the VPC . description: The ID of the VPC .
returned: always returned: always
type: string type: str
state: state:
description: The state of the VPC. description: The state of the VPC.
returned: always returned: always
type: string type: str
tags: tags:
description: A dict of tags associated with the VPC. description: A dict of tags associated with the VPC.
returned: always returned: always
@ -85,31 +85,31 @@ vpcs:
instance_tenancy: instance_tenancy:
description: The instance tenancy setting for the VPC. description: The instance tenancy setting for the VPC.
returned: always returned: always
type: string type: str
is_default: is_default:
description: True if this is the default VPC for account. description: True if this is the default VPC for account.
returned: always returned: always
type: boolean type: bool
cidr_block: cidr_block:
description: The IPv4 CIDR block assigned to the VPC. description: The IPv4 CIDR block assigned to the VPC.
returned: always returned: always
type: string type: str
classic_link_dns_supported: classic_link_dns_supported:
description: True/False depending on attribute setting for classic link DNS support. description: True/False depending on attribute setting for classic link DNS support.
returned: always returned: always
type: boolean type: bool
classic_link_enabled: classic_link_enabled:
description: True/False depending on if classic link support is enabled. description: True/False depending on if classic link support is enabled.
returned: always returned: always
type: boolean type: bool
enable_dns_hostnames: enable_dns_hostnames:
description: True/False depending on attribute setting for DNS hostnames support. description: True/False depending on attribute setting for DNS hostnames support.
returned: always returned: always
type: boolean type: bool
enable_dns_support: enable_dns_support:
description: True/False depending on attribute setting for DNS support. description: True/False depending on attribute setting for DNS support.
returned: always returned: always
type: boolean type: bool
ipv6_cidr_block_association_set: ipv6_cidr_block_association_set:
description: An array of IPv6 cidr block association set information. description: An array of IPv6 cidr block association set information.
returned: always returned: always
@ -118,11 +118,11 @@ vpcs:
association_id: association_id:
description: The association ID description: The association ID
returned: always returned: always
type: string type: str
ipv6_cidr_block: ipv6_cidr_block:
description: The IPv6 CIDR block that is associated with the VPC. description: The IPv6 CIDR block that is associated with the VPC.
returned: always returned: always
type: string type: str
ipv6_cidr_block_state: ipv6_cidr_block_state:
description: A hash/dict that contains a single item. The state of the cidr block association. description: A hash/dict that contains a single item. The state of the cidr block association.
returned: always returned: always
@ -131,7 +131,7 @@ vpcs:
state: state:
description: The CIDR block association state. description: The CIDR block association state.
returned: always returned: always
type: string type: str
''' '''
import traceback import traceback

2
lib/ansible/modules/cloud/amazon/ec2_vpc_peer.py
View file

@ -211,7 +211,7 @@ RETURN = '''
task: task:
description: The result of the create, accept, reject or delete action. description: The result of the create, accept, reject or delete action.
returned: success returned: success
type: dictionary type: dict
''' '''
try: try:

26
lib/ansible/modules/cloud/amazon/ec2_vpc_route_table.py
View file

@ -143,22 +143,22 @@ route_table:
route_table_association_id: route_table_association_id:
description: ID of association between route table and subnet description: ID of association between route table and subnet
returned: always returned: always
type: string type: str
sample: rtbassoc-ab47cfc3 sample: rtbassoc-ab47cfc3
route_table_id: route_table_id:
description: ID of the route table description: ID of the route table
returned: always returned: always
type: string type: str
sample: rtb-bf779ed7 sample: rtb-bf779ed7
subnet_id: subnet_id:
description: ID of the subnet description: ID of the subnet
returned: always returned: always
type: string type: str
sample: subnet-82055af9 sample: subnet-82055af9
id: id:
description: ID of the route table (same as route_table_id for backwards compatibility) description: ID of the route table (same as route_table_id for backwards compatibility)
returned: always returned: always
type: string type: str
sample: rtb-bf779ed7 sample: rtb-bf779ed7
propagating_vgws: propagating_vgws:
description: List of Virtual Private Gateways propagating routes description: List of Virtual Private Gateways propagating routes
@ -168,7 +168,7 @@ route_table:
route_table_id: route_table_id:
description: ID of the route table description: ID of the route table
returned: always returned: always
type: string type: str
sample: rtb-bf779ed7 sample: rtb-bf779ed7
routes: routes:
description: List of routes in the route table description: List of routes in the route table
@ -178,37 +178,37 @@ route_table:
destination_cidr_block: destination_cidr_block:
description: CIDR block of destination description: CIDR block of destination
returned: always returned: always
type: string type: str
sample: 10.228.228.0/22 sample: 10.228.228.0/22
gateway_id: gateway_id:
description: ID of the gateway description: ID of the gateway
returned: when gateway is local or internet gateway returned: when gateway is local or internet gateway
type: string type: str
sample: local sample: local
instance_id: instance_id:
description: ID of a NAT instance description: ID of a NAT instance
returned: when the route is via an EC2 instance returned: when the route is via an EC2 instance
type: string type: str
sample: i-abcd123456789 sample: i-abcd123456789
instance_owner_id: instance_owner_id:
description: AWS account owning the NAT instance description: AWS account owning the NAT instance
returned: when the route is via an EC2 instance returned: when the route is via an EC2 instance
type: string type: str
sample: 123456789012 sample: 123456789012
nat_gateway_id: nat_gateway_id:
description: ID of the NAT gateway description: ID of the NAT gateway
returned: when the route is via a NAT gateway returned: when the route is via a NAT gateway
type: string type: str
sample: local sample: local
origin: origin:
description: mechanism through which the route is in the table description: mechanism through which the route is in the table
returned: always returned: always
type: string type: str
sample: CreateRouteTable sample: CreateRouteTable
state: state:
description: state of the route description: state of the route
returned: always returned: always
type: string type: str
sample: active sample: active
tags: tags:
description: Tags applied to the route table description: Tags applied to the route table
@ -220,7 +220,7 @@ route_table:
vpc_id: vpc_id:
description: ID for the VPC in which the route lives description: ID for the VPC in which the route lives
returned: always returned: always
type: string type: str
sample: vpc-6e2d2407 sample: vpc-6e2d2407
''' '''

28
lib/ansible/modules/cloud/amazon/ec2_vpc_subnet.py
View file

@ -123,27 +123,27 @@ subnet:
id: id:
description: Subnet resource id description: Subnet resource id
returned: I(state=present) returned: I(state=present)
type: string type: str
sample: subnet-b883b2c4 sample: subnet-b883b2c4
cidr_block: cidr_block:
description: The IPv4 CIDR of the Subnet description: The IPv4 CIDR of the Subnet
returned: I(state=present) returned: I(state=present)
type: string type: str
sample: "10.0.0.0/16" sample: "10.0.0.0/16"
ipv6_cidr_block: ipv6_cidr_block:
description: The IPv6 CIDR block actively associated with the Subnet description: The IPv6 CIDR block actively associated with the Subnet
returned: I(state=present) returned: I(state=present)
type: string type: str
sample: "2001:db8:0:102::/64" sample: "2001:db8:0:102::/64"
availability_zone: availability_zone:
description: Availability zone of the Subnet description: Availability zone of the Subnet
returned: I(state=present) returned: I(state=present)
type: string type: str
sample: us-east-1a sample: us-east-1a
state: state:
description: state of the Subnet description: state of the Subnet
returned: I(state=present) returned: I(state=present)
type: string type: str
sample: available sample: available
tags: tags:
description: tags attached to the Subnet, includes name description: tags attached to the Subnet, includes name
@ -153,32 +153,32 @@ subnet:
map_public_ip_on_launch: map_public_ip_on_launch:
description: whether public IP is auto-assigned to new instances description: whether public IP is auto-assigned to new instances
returned: I(state=present) returned: I(state=present)
type: boolean type: bool
sample: false sample: false
assign_ipv6_address_on_creation: assign_ipv6_address_on_creation:
description: whether IPv6 address is auto-assigned to new instances description: whether IPv6 address is auto-assigned to new instances
returned: I(state=present) returned: I(state=present)
type: boolean type: bool
sample: false sample: false
vpc_id: vpc_id:
description: the id of the VPC where this Subnet exists description: the id of the VPC where this Subnet exists
returned: I(state=present) returned: I(state=present)
type: string type: str
sample: vpc-67236184 sample: vpc-67236184
available_ip_address_count: available_ip_address_count:
description: number of available IPv4 addresses description: number of available IPv4 addresses
returned: I(state=present) returned: I(state=present)
type: string type: str
sample: 251 sample: 251
default_for_az: default_for_az:
description: indicates whether this is the default Subnet for this Availability Zone description: indicates whether this is the default Subnet for this Availability Zone
returned: I(state=present) returned: I(state=present)
type: boolean type: bool
sample: false sample: false
ipv6_association_id: ipv6_association_id:
description: The IPv6 association ID for the currently associated CIDR description: The IPv6 association ID for the currently associated CIDR
returned: I(state=present) returned: I(state=present)
type: string type: str
sample: subnet-cidr-assoc-b85c74d2 sample: subnet-cidr-assoc-b85c74d2
ipv6_cidr_block_association_set: ipv6_cidr_block_association_set:
description: An array of IPv6 cidr block association set information. description: An array of IPv6 cidr block association set information.
@ -188,11 +188,11 @@ subnet:
association_id: association_id:
description: The association ID description: The association ID
returned: always returned: always
type: string type: str
ipv6_cidr_block: ipv6_cidr_block:
description: The IPv6 CIDR block that is associated with the subnet. description: The IPv6 CIDR block that is associated with the subnet.
returned: always returned: always
type: string type: str
ipv6_cidr_block_state: ipv6_cidr_block_state:
description: A hash/dict that contains a single item. The state of the cidr block association. description: A hash/dict that contains a single item. The state of the cidr block association.
returned: always returned: always
@ -201,7 +201,7 @@ subnet:
state: state:
description: The CIDR block association state. description: The CIDR block association state.
returned: always returned: always
type: string type: str
''' '''

26
lib/ansible/modules/cloud/amazon/ec2_vpc_subnet_facts.py
View file

@ -91,19 +91,19 @@ subnets:
subnet_id: subnet_id:
description: The ID of the Subnet. description: The ID of the Subnet.
returned: always returned: always
type: string type: str
id: id:
description: The ID of the Subnet (for backwards compatibility). description: The ID of the Subnet (for backwards compatibility).
returned: always returned: always
type: string type: str
vpc_id: vpc_id:
description: The ID of the VPC . description: The ID of the VPC .
returned: always returned: always
type: string type: str
state: state:
description: The state of the subnet. description: The state of the subnet.
returned: always returned: always
type: string type: str
tags: tags:
description: A dict of tags associated with the Subnet. description: A dict of tags associated with the Subnet.
returned: always returned: always
@ -111,27 +111,27 @@ subnets:
map_public_ip_on_launch: map_public_ip_on_launch:
description: True/False depending on attribute setting for public IP mapping. description: True/False depending on attribute setting for public IP mapping.
returned: always returned: always
type: boolean type: bool
default_for_az: default_for_az:
description: True if this is the default subnet for AZ. description: True if this is the default subnet for AZ.
returned: always returned: always
type: boolean type: bool
cidr_block: cidr_block:
description: The IPv4 CIDR block assigned to the subnet. description: The IPv4 CIDR block assigned to the subnet.
returned: always returned: always
type: string type: str
available_ip_address_count: available_ip_address_count:
description: Count of available IPs in subnet. description: Count of available IPs in subnet.
returned: always returned: always
type: string type: str
availability_zone: availability_zone:
description: The availability zone where the subnet exists. description: The availability zone where the subnet exists.
returned: always returned: always
type: string type: str
assign_ipv6_address_on_creation: assign_ipv6_address_on_creation:
description: True/False depending on attribute setting for IPv6 address assignment. description: True/False depending on attribute setting for IPv6 address assignment.
returned: always returned: always
type: boolean type: bool
ipv6_cidr_block_association_set: ipv6_cidr_block_association_set:
description: An array of IPv6 cidr block association set information. description: An array of IPv6 cidr block association set information.
returned: always returned: always
@ -140,11 +140,11 @@ subnets:
association_id: association_id:
description: The association ID description: The association ID
returned: always returned: always
type: string type: str
ipv6_cidr_block: ipv6_cidr_block:
description: The IPv6 CIDR block that is associated with the subnet. description: The IPv6 CIDR block that is associated with the subnet.
returned: always returned: always
type: string type: str
ipv6_cidr_block_state: ipv6_cidr_block_state:
description: A hash/dict that contains a single item. The state of the cidr block association. description: A hash/dict that contains a single item. The state of the cidr block association.
returned: always returned: always
@ -153,7 +153,7 @@ subnets:
state: state:
description: The CIDR block association state. description: The CIDR block association state.
returned: always returned: always
type: string type: str
''' '''
import traceback import traceback

2
lib/ansible/modules/cloud/amazon/ec2_vpc_vgw.py
View file

@ -104,7 +104,7 @@ RETURN = '''
result: result:
description: The result of the create, or delete action. description: The result of the create, or delete action.
returned: success returned: success
type: dictionary type: dict
''' '''
import time import time

2
lib/ansible/modules/cloud/amazon/ec2_vpc_vpn.py
View file

@ -230,7 +230,7 @@ routes:
}] }]
state: state:
description: The status of the VPN connection. description: The status of the VPN connection.
type: string type: str
returned: I(state=present) returned: I(state=present)
sample: sample:
state: available state: available

24
lib/ansible/modules/cloud/amazon/ec2_vpc_vpn_facts.py
View file

@ -59,16 +59,16 @@ vpn_connections:
category: category:
description: The category of the VPN connection. description: The category of the VPN connection.
returned: always returned: always
type: string type: str
sample: VPN sample: VPN
customer_gatway_configuration: customer_gatway_configuration:
description: The configuration information for the VPN connection's customer gateway (in the native XML format). description: The configuration information for the VPN connection's customer gateway (in the native XML format).
returned: always returned: always
type: string type: str
customer_gateway_id: customer_gateway_id:
description: The ID of the customer gateway at your end of the VPN connection. description: The ID of the customer gateway at your end of the VPN connection.
returned: always returned: always
type: string type: str
sample: cgw-17a53c37 sample: cgw-17a53c37
options: options:
description: The VPN connection options. description: The VPN connection options.
@ -85,17 +85,17 @@ vpn_connections:
destination_cidr_block: destination_cidr_block:
description: The CIDR block associated with the local subnet of the customer data center. description: The CIDR block associated with the local subnet of the customer data center.
returned: always returned: always
type: string type: str
sample: 10.0.0.0/16 sample: 10.0.0.0/16
state: state:
description: The current state of the static route. description: The current state of the static route.
returned: always returned: always
type: string type: str
sample: available sample: available
state: state:
description: The current state of the VPN connection. description: The current state of the VPN connection.
returned: always returned: always
type: string type: str
sample: available sample: available
tags: tags:
description: Any tags assigned to the VPN connection. description: Any tags assigned to the VPN connection.
@ -107,7 +107,7 @@ vpn_connections:
type: type:
description: The type of VPN connection. description: The type of VPN connection.
returned: always returned: always
type: string type: str
sample: ipsec.1 sample: ipsec.1
vgw_telemetry: vgw_telemetry:
description: Information about the VPN tunnel. description: Information about the VPN tunnel.
@ -127,27 +127,27 @@ vpn_connections:
outside_ip_address: outside_ip_address:
description: The Internet-routable IP address of the virtual private gateway's outside interface. description: The Internet-routable IP address of the virtual private gateway's outside interface.
returned: always returned: always
type: string type: str
sample: 13.127.79.191 sample: 13.127.79.191
status: status:
description: The status of the VPN tunnel. description: The status of the VPN tunnel.
returned: always returned: always
type: string type: str
sample: DOWN sample: DOWN
status_message: status_message:
description: If an error occurs, a description of the error. description: If an error occurs, a description of the error.
returned: always returned: always
type: string type: str
sample: IPSEC IS DOWN sample: IPSEC IS DOWN
vpn_connection_id: vpn_connection_id:
description: The ID of the VPN connection. description: The ID of the VPN connection.
returned: always returned: always
type: string type: str
sample: vpn-f700d5c0 sample: vpn-f700d5c0
vpn_gateway_id: vpn_gateway_id:
description: The ID of the virtual private gateway at the AWS side of the VPN connection. description: The ID of the virtual private gateway at the AWS side of the VPN connection.
returned: always returned: always
type: string type: str
sample: vgw-cbe56bfb sample: vgw-cbe56bfb
''' '''

8
lib/ansible/modules/cloud/amazon/ecs_attribute.py
View file

@ -88,21 +88,21 @@ attributes:
contains: contains:
cluster: cluster:
description: cluster name description: cluster name
type: string type: str
ec2_instance_id: ec2_instance_id:
description: ec2 instance id of ecs container instance description: ec2 instance id of ecs container instance
type: string type: str
attributes: attributes:
description: list of attributes description: list of attributes
type: list of complex type: list of complex
contains: contains:
name: name:
description: name of the attribute description: name of the attribute
type: string type: str
value: value:
description: value of the attribute description: value of the attribute
returned: if present returned: if present
type: string type: str
''' '''
try: try:

6
lib/ansible/modules/cloud/amazon/ecs_cluster.py
View file

@ -75,12 +75,12 @@ activeServicesCount:
type: int type: int
clusterArn: clusterArn:
description: the ARN of the cluster just created description: the ARN of the cluster just created
type: string type: str
returned: 0 if a new cluster returned: 0 if a new cluster
sample: arn:aws:ecs:us-west-2:172139249013:cluster/test-cluster-mfshcdok sample: arn:aws:ecs:us-west-2:172139249013:cluster/test-cluster-mfshcdok
clusterName: clusterName:
description: name of the cluster just created (should match the input argument) description: name of the cluster just created (should match the input argument)
type: string type: str
returned: always returned: always
sample: test-cluster-mfshcdok sample: test-cluster-mfshcdok
pendingTasksCount: pendingTasksCount:
@ -98,7 +98,7 @@ runningTasksCount:
status: status:
description: the status of the new cluster description: the status of the new cluster
returned: always returned: always
type: string type: str
sample: ACTIVE sample: ACTIVE
''' '''
import time import time

6
lib/ansible/modules/cloud/amazon/ecs_ecr.py
View file

@ -99,15 +99,15 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
state: state:
type: string type: str
description: The asserted state of the repository (present, absent) description: The asserted state of the repository (present, absent)
returned: always returned: always
created: created:
type: boolean type: bool
description: If true, the repository was created description: If true, the repository was created
returned: always returned: always
name: name:
type: string type: str
description: The name of the repository description: The name of the repository
returned: "when state == 'absent'" returned: "when state == 'absent'"
repository: repository:

22
lib/ansible/modules/cloud/amazon/ecs_service.py
View file

@ -199,7 +199,7 @@ service:
clusterArn: clusterArn:
description: The Amazon Resource Name (ARN) of the of the cluster that hosts the service. description: The Amazon Resource Name (ARN) of the of the cluster that hosts the service.
returned: always returned: always
type: string type: str
desiredCount: desiredCount:
description: The desired number of instantiations of the task definition to keep running on the service. description: The desired number of instantiations of the task definition to keep running on the service.
returned: always returned: always
@ -212,11 +212,11 @@ service:
loadBalancerName: loadBalancerName:
description: the name description: the name
returned: always returned: always
type: string type: str
containerName: containerName:
description: The name of the container to associate with the load balancer. description: The name of the container to associate with the load balancer.
returned: always returned: always
type: string type: str
containerPort: containerPort:
description: The port on the container to associate with the load balancer. description: The port on the container to associate with the load balancer.
returned: always returned: always
@ -234,19 +234,19 @@ service:
of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example,
arn:aws:ecs:region :012345678910 :service/my-service . arn:aws:ecs:region :012345678910 :service/my-service .
returned: always returned: always
type: string type: str
serviceName: serviceName:
description: A user-generated string used to identify the service description: A user-generated string used to identify the service
returned: always returned: always
type: string type: str
status: status:
description: The valid values are ACTIVE, DRAINING, or INACTIVE. description: The valid values are ACTIVE, DRAINING, or INACTIVE.
returned: always returned: always
type: string type: str
taskDefinition: taskDefinition:
description: The ARN of a task definition to use for tasks in the service. description: The ARN of a task definition to use for tasks in the service.
returned: always returned: always
type: string type: str
deployments: deployments:
description: list of service deployments description: list of service deployments
returned: always returned: always
@ -276,12 +276,12 @@ service:
type: type:
description: The type of constraint. Valid values are distinctInstance and memberOf. description: The type of constraint. Valid values are distinctInstance and memberOf.
returned: always returned: always
type: string type: str
expression: expression:
description: A cluster query language expression to apply to the constraint. Note you cannot specify an expression if the constraint type is description: A cluster query language expression to apply to the constraint. Note you cannot specify an expression if the constraint type is
distinctInstance. distinctInstance.
returned: always returned: always
type: string type: str
placementStrategy: placementStrategy:
description: List of placement strategy objects description: List of placement strategy objects
returned: always returned: always
@ -290,13 +290,13 @@ service:
type: type:
description: The type of placement strategy. Valid values are random, spread and binpack. description: The type of placement strategy. Valid values are random, spread and binpack.
returned: always returned: always
type: string type: str
field: field:
description: The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId description: The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId
(or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance,
such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are CPU and MEMORY. such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are CPU and MEMORY.
returned: always returned: always
type: string type: str
ansible_facts: ansible_facts:
description: Facts about deleted service. description: Facts about deleted service.
returned: when deleting a service returned: when deleting a service

14
lib/ansible/modules/cloud/amazon/ecs_service_facts.py
View file

@ -72,7 +72,7 @@ services:
clusterArn: clusterArn:
description: The Amazon Resource Name (ARN) of the of the cluster that hosts the service. description: The Amazon Resource Name (ARN) of the of the cluster that hosts the service.
returned: always returned: always
type: string type: str
desiredCount: desiredCount:
description: The desired number of instantiations of the task definition to keep running on the service. description: The desired number of instantiations of the task definition to keep running on the service.
returned: always returned: always
@ -85,11 +85,11 @@ services:
loadBalancerName: loadBalancerName:
description: the name description: the name
returned: always returned: always
type: string type: str
containerName: containerName:
description: The name of the container to associate with the load balancer. description: The name of the container to associate with the load balancer.
returned: always returned: always
type: string type: str
containerPort: containerPort:
description: The port on the container to associate with the load balancer. description: The port on the container to associate with the load balancer.
returned: always returned: always
@ -105,19 +105,19 @@ services:
serviceArn: serviceArn:
description: The Amazon Resource Name (ARN) that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region :012345678910 :service/my-service . description: The Amazon Resource Name (ARN) that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region :012345678910 :service/my-service .
returned: always returned: always
type: string type: str
serviceName: serviceName:
description: A user-generated string used to identify the service description: A user-generated string used to identify the service
returned: always returned: always
type: string type: str
status: status:
description: The valid values are ACTIVE, DRAINING, or INACTIVE. description: The valid values are ACTIVE, DRAINING, or INACTIVE.
returned: always returned: always
type: string type: str
taskDefinition: taskDefinition:
description: The ARN of a task definition to use for tasks in the service. description: The ARN of a task definition to use for tasks in the service.
returned: always returned: always
type: string type: str
deployments: deployments:
description: list of service deployments description: list of service deployments
returned: always returned: always

22
lib/ansible/modules/cloud/amazon/ecs_task.py
View file

@ -111,19 +111,19 @@ task:
taskArn: taskArn:
description: The Amazon Resource Name (ARN) that identifies the task. description: The Amazon Resource Name (ARN) that identifies the task.
returned: always returned: always
type: string type: str
clusterArn: clusterArn:
description: The Amazon Resource Name (ARN) of the of the cluster that hosts the task. description: The Amazon Resource Name (ARN) of the of the cluster that hosts the task.
returned: only when details is true returned: only when details is true
type: string type: str
taskDefinitionArn: taskDefinitionArn:
description: The Amazon Resource Name (ARN) of the task definition. description: The Amazon Resource Name (ARN) of the task definition.
returned: only when details is true returned: only when details is true
type: string type: str
containerInstanceArn: containerInstanceArn:
description: The Amazon Resource Name (ARN) of the container running the task. description: The Amazon Resource Name (ARN) of the container running the task.
returned: only when details is true returned: only when details is true
type: string type: str
overrides: overrides:
description: The container overrides set for this task. description: The container overrides set for this task.
returned: only when details is true returned: only when details is true
@ -131,11 +131,11 @@ task:
lastStatus: lastStatus:
description: The last recorded status of the task. description: The last recorded status of the task.
returned: only when details is true returned: only when details is true
type: string type: str
desiredStatus: desiredStatus:
description: The desired status of the task. description: The desired status of the task.
returned: only when details is true returned: only when details is true
type: string type: str
containers: containers:
description: The container details. description: The container details.
returned: only when details is true returned: only when details is true
@ -143,23 +143,23 @@ task:
startedBy: startedBy:
description: The used who started the task. description: The used who started the task.
returned: only when details is true returned: only when details is true
type: string type: str
stoppedReason: stoppedReason:
description: The reason why the task was stopped. description: The reason why the task was stopped.
returned: only when details is true returned: only when details is true
type: string type: str
createdAt: createdAt:
description: The timestamp of when the task was created. description: The timestamp of when the task was created.
returned: only when details is true returned: only when details is true
type: string type: str
startedAt: startedAt:
description: The timestamp of when the task was started. description: The timestamp of when the task was started.
returned: only when details is true returned: only when details is true
type: string type: str
stoppedAt: stoppedAt:
description: The timestamp of when the task was stopped. description: The timestamp of when the task was stopped.
returned: only when details is true returned: only when details is true
type: string type: str
''' '''
from ansible.module_utils.aws.core import AnsibleAWSModule from ansible.module_utils.aws.core import AnsibleAWSModule

72
lib/ansible/modules/cloud/amazon/ecs_taskdefinition_facts.py
View file

@ -51,11 +51,11 @@ container_definitions:
name: name:
description: The name of a container. description: The name of a container.
returned: always returned: always
type: string type: str
image: image:
description: The image used to start a container. description: The image used to start a container.
returned: always returned: always
type: string type: str
cpu: cpu:
description: The number of cpu units reserved for the container. description: The number of cpu units reserved for the container.
returned: always returned: always
@ -67,7 +67,7 @@ container_definitions:
links: links:
description: Links to other containers. description: Links to other containers.
returned: when present returned: when present
type: string type: str
portMappings: portMappings:
description: The list of port mappings for the container. description: The list of port mappings for the container.
returned: always returned: always
@ -84,7 +84,7 @@ container_definitions:
protocol: protocol:
description: The protocol used for the port mapping. description: The protocol used for the port mapping.
returned: when present returned: when present
type: string type: str
essential: essential:
description: Whether this is an essential container or not. description: Whether this is an essential container or not.
returned: always returned: always
@ -92,11 +92,11 @@ container_definitions:
entryPoint: entryPoint:
description: The entry point that is passed to the container. description: The entry point that is passed to the container.
returned: when present returned: when present
type: string type: str
command: command:
description: The command that is passed to the container. description: The command that is passed to the container.
returned: when present returned: when present
type: string type: str
environment: environment:
description: The environment variables to pass to a container. description: The environment variables to pass to a container.
returned: always returned: always
@ -105,11 +105,11 @@ container_definitions:
name: name:
description: The name of the environment variable. description: The name of the environment variable.
returned: when present returned: when present
type: string type: str
value: value:
description: The value of the environment variable. description: The value of the environment variable.
returned: when present returned: when present
type: string type: str
mountPoints: mountPoints:
description: The mount points for data volumes in your container. description: The mount points for data volumes in your container.
returned: always returned: always
@ -118,11 +118,11 @@ container_definitions:
sourceVolume: sourceVolume:
description: The name of the volume to mount. description: The name of the volume to mount.
returned: when present returned: when present
type: string type: str
containerPath: containerPath:
description: The path on the container to mount the host volume at. description: The path on the container to mount the host volume at.
returned: when present returned: when present
type: string type: str
readOnly: readOnly:
description: If this value is true , the container has read-only access to the volume. description: If this value is true , the container has read-only access to the volume.
If this value is false , then the container can write to the volume. If this value is false , then the container can write to the volume.
@ -136,7 +136,7 @@ container_definitions:
sourceContainer: sourceContainer:
description: The name of another container within the same task definition to mount volumes from. description: The name of another container within the same task definition to mount volumes from.
returned: when present returned: when present
type: string type: str
readOnly: readOnly:
description: If this value is true , the container has read-only access to the volume. description: If this value is true , the container has read-only access to the volume.
If this value is false , then the container can write to the volume. If this value is false , then the container can write to the volume.
@ -145,15 +145,15 @@ container_definitions:
hostname: hostname:
description: The hostname to use for your container. description: The hostname to use for your container.
returned: when present returned: when present
type: string type: str
user: user:
description: The user name to use inside the container. description: The user name to use inside the container.
returned: when present returned: when present
type: string type: str
workingDirectory: workingDirectory:
description: The working directory in which to run commands inside the container. description: The working directory in which to run commands inside the container.
returned: when present returned: when present
type: string type: str
disableNetworking: disableNetworking:
description: When this parameter is true, networking is disabled within the container. description: When this parameter is true, networking is disabled within the container.
returned: when present returned: when present
@ -170,11 +170,11 @@ container_definitions:
dnsServers: dnsServers:
description: A list of DNS servers that are presented to the container. description: A list of DNS servers that are presented to the container.
returned: when present returned: when present
type: string type: str
dnsSearchDomains: dnsSearchDomains:
description: A list of DNS search domains that are presented to the container. description: A list of DNS search domains that are presented to the container.
returned: when present returned: when present
type: string type: str
extraHosts: extraHosts:
description: A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. description: A list of hostnames and IP address mappings to append to the /etc/hosts file on the container.
returned: when present returned: when present
@ -183,19 +183,19 @@ container_definitions:
hostname: hostname:
description: The hostname to use in the /etc/hosts entry. description: The hostname to use in the /etc/hosts entry.
returned: when present returned: when present
type: string type: str
ipAddress: ipAddress:
description: The IP address to use in the /etc/hosts entry. description: The IP address to use in the /etc/hosts entry.
returned: when present returned: when present
type: string type: str
dockerSecurityOptions: dockerSecurityOptions:
description: A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. description: A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.
returned: when present returned: when present
type: string type: str
dockerLabels: dockerLabels:
description: A key/value map of labels to add to the container. description: A key/value map of labels to add to the container.
returned: when present returned: when present
type: string type: str
ulimits: ulimits:
description: A list of ulimits to set in the container. description: A list of ulimits to set in the container.
returned: when present returned: when present
@ -204,7 +204,7 @@ container_definitions:
name: name:
description: The type of the ulimit . description: The type of the ulimit .
returned: when present returned: when present
type: string type: str
softLimit: softLimit:
description: The soft limit for the ulimit type. description: The soft limit for the ulimit type.
returned: when present returned: when present
@ -216,28 +216,28 @@ container_definitions:
logConfiguration: logConfiguration:
description: The log configuration specification for the container. description: The log configuration specification for the container.
returned: when present returned: when present
type: string type: str
options: options:
description: The configuration options to send to the log driver. description: The configuration options to send to the log driver.
returned: when present returned: when present
type: string type: str
family: family:
description: The family of your task definition, used as the definition name description: The family of your task definition, used as the definition name
returned: always returned: always
type: string type: str
task_definition_arn: task_definition_arn:
description: ARN of the task definition description: ARN of the task definition
returned: always returned: always
type: string type: str
task_role_arn: task_role_arn:
description: The ARN of the IAM role that containers in this task can assume description: The ARN of the IAM role that containers in this task can assume
returned: when role is set returned: when role is set
type: string type: str
network_mode: network_mode:
description: Network mode for the containers description: Network mode for the containers
returned: always returned: always
type: string type: str
revision: revision:
description: Revision number that was queried description: Revision number that was queried
returned: always returned: always
@ -250,7 +250,7 @@ volumes:
name: name:
description: The name of the volume. description: The name of the volume.
returned: when present returned: when present
type: string type: str
host: host:
description: The contents of the host parameter determine whether your data volume description: The contents of the host parameter determine whether your data volume
persists on the host container instance and where it is stored. persists on the host container instance and where it is stored.
@ -259,11 +259,11 @@ volumes:
source_path: source_path:
description: The path on the host container instance that is presented to the container. description: The path on the host container instance that is presented to the container.
returned: when present returned: when present
type: string type: str
status: status:
description: The status of the task definition description: The status of the task definition
returned: always returned: always
type: string type: str
requires_attributes: requires_attributes:
description: The container instance attributes required by your task description: The container instance attributes required by your task
returned: when present returned: when present
@ -272,19 +272,19 @@ requires_attributes:
name: name:
description: The name of the attribute. description: The name of the attribute.
returned: when present returned: when present
type: string type: str
value: value:
description: The value of the attribute. description: The value of the attribute.
returned: when present returned: when present
type: string type: str
targetType: targetType:
description: The type of the target with which to attach the attribute. description: The type of the target with which to attach the attribute.
returned: when present returned: when present
type: string type: str
targetId: targetId:
description: The ID of the target. description: The ID of the target.
returned: when present returned: when present
type: string type: str
placement_constraints: placement_constraints:
description: A list of placement constraint objects to use for tasks description: A list of placement constraint objects to use for tasks
returned: always returned: always
@ -293,11 +293,11 @@ placement_constraints:
type: type:
description: The type of constraint. description: The type of constraint.
returned: when present returned: when present
type: string type: str
expression: expression:
description: A cluster query language expression to apply to the constraint. description: A cluster query language expression to apply to the constraint.
returned: when present returned: when present
type: string type: str
''' '''
from ansible.module_utils.aws.core import AnsibleAWSModule from ansible.module_utils.aws.core import AnsibleAWSModule

18
lib/ansible/modules/cloud/amazon/efs.py
View file

@ -130,32 +130,32 @@ RETURN = '''
creation_time: creation_time:
description: timestamp of creation date description: timestamp of creation date
returned: always returned: always
type: string type: str
sample: "2015-11-16 07:30:57-05:00" sample: "2015-11-16 07:30:57-05:00"
creation_token: creation_token:
description: EFS creation token description: EFS creation token
returned: always returned: always
type: string type: str
sample: "console-88609e04-9a0e-4a2e-912c-feaa99509961" sample: "console-88609e04-9a0e-4a2e-912c-feaa99509961"
file_system_id: file_system_id:
description: ID of the file system description: ID of the file system
returned: always returned: always
type: string type: str
sample: "fs-xxxxxxxx" sample: "fs-xxxxxxxx"
life_cycle_state: life_cycle_state:
description: state of the EFS file system description: state of the EFS file system
returned: always returned: always
type: string type: str
sample: "creating, available, deleting, deleted" sample: "creating, available, deleting, deleted"
mount_point: mount_point:
description: url of file system with leading dot from the time when AWS EFS required to add a region suffix to the address description: url of file system with leading dot from the time when AWS EFS required to add a region suffix to the address
returned: always returned: always
type: string type: str
sample: ".fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/" sample: ".fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/"
filesystem_address: filesystem_address:
description: url of file system valid for use with mount description: url of file system valid for use with mount
returned: always returned: always
type: string type: str
sample: "fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/" sample: "fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/"
mount_targets: mount_targets:
description: list of mount targets description: list of mount targets
@ -180,7 +180,7 @@ mount_targets:
name: name:
description: name of the file system description: name of the file system
returned: always returned: always
type: string type: str
sample: "my-efs" sample: "my-efs"
number_of_mount_targets: number_of_mount_targets:
description: the number of targets mounted description: the number of targets mounted
@ -190,7 +190,7 @@ number_of_mount_targets:
owner_id: owner_id:
description: AWS account ID of EFS owner description: AWS account ID of EFS owner
returned: always returned: always
type: string type: str
sample: "XXXXXXXXXXXX" sample: "XXXXXXXXXXXX"
size_in_bytes: size_in_bytes:
description: size of the file system in bytes as of a timestamp description: size of the file system in bytes as of a timestamp
@ -204,7 +204,7 @@ size_in_bytes:
performance_mode: performance_mode:
description: performance mode of the file system description: performance mode of the file system
returned: always returned: always
type: string type: str
sample: "generalPurpose" sample: "generalPurpose"
tags: tags:
description: tags on the efs instance description: tags on the efs instance

46
lib/ansible/modules/cloud/amazon/elasticache_facts.py
View file

@ -47,22 +47,22 @@ elasticache_clusters:
cache_cluster_create_time: cache_cluster_create_time:
description: Date and time cluster was created description: Date and time cluster was created
returned: always returned: always
type: string type: str
sample: '2017-09-15T05:43:46.038000+00:00' sample: '2017-09-15T05:43:46.038000+00:00'
cache_cluster_id: cache_cluster_id:
description: ID of the cache cluster description: ID of the cache cluster
returned: always returned: always
type: string type: str
sample: abcd-1234-001 sample: abcd-1234-001
cache_cluster_status: cache_cluster_status:
description: Status of Elasticache cluster description: Status of Elasticache cluster
returned: always returned: always
type: string type: str
sample: available sample: available
cache_node_type: cache_node_type:
description: Instance type of Elasticache nodes description: Instance type of Elasticache nodes
returned: always returned: always
type: string type: str
sample: cache.t2.micro sample: cache.t2.micro
cache_nodes: cache_nodes:
description: List of Elasticache nodes in the cluster description: List of Elasticache nodes in the cluster
@ -72,22 +72,22 @@ elasticache_clusters:
cache_node_create_time: cache_node_create_time:
description: Date and time node was created description: Date and time node was created
returned: always returned: always
type: string type: str
sample: '2017-09-15T05:43:46.038000+00:00' sample: '2017-09-15T05:43:46.038000+00:00'
cache_node_id: cache_node_id:
description: ID of the cache node description: ID of the cache node
returned: always returned: always
type: string type: str
sample: '0001' sample: '0001'
cache_node_status: cache_node_status:
description: Status of the cache node description: Status of the cache node
returned: always returned: always
type: string type: str
sample: available sample: available
customer_availability_zone: customer_availability_zone:
description: Availability Zone in which the cache node was created description: Availability Zone in which the cache node was created
returned: always returned: always
type: string type: str
sample: ap-southeast-2b sample: ap-southeast-2b
endpoint: endpoint:
description: Connection details for the cache node description: Connection details for the cache node
@ -97,7 +97,7 @@ elasticache_clusters:
address: address:
description: URL of the cache node endpoint description: URL of the cache node endpoint
returned: always returned: always
type: string type: str
sample: abcd-1234-001.bgiz2p.0001.apse2.cache.amazonaws.com sample: abcd-1234-001.bgiz2p.0001.apse2.cache.amazonaws.com
port: port:
description: Port of the cache node endpoint description: Port of the cache node endpoint
@ -107,7 +107,7 @@ elasticache_clusters:
parameter_grou_status: parameter_grou_status:
description: Status of the Cache Parameter Group description: Status of the Cache Parameter Group
returned: always returned: always
type: string type: str
sample: in-sync sample: in-sync
cache_parameter_group: cache_parameter_group:
description: Contents of the Cache Parameter GGroup description: Contents of the Cache Parameter GGroup
@ -122,12 +122,12 @@ elasticache_clusters:
cache_parameter_group_name: cache_parameter_group_name:
description: Name of the cache parameter group description: Name of the cache parameter group
returned: always returned: always
type: string type: str
sample: default.redis3.2 sample: default.redis3.2
parameter_apply_status: parameter_apply_status:
description: Status of parameter updates description: Status of parameter updates
returned: always returned: always
type: string type: str
sample: in-sync sample: in-sync
cache_security_groups: cache_security_groups:
description: Security Groups used by the cache description: Security Groups used by the cache
@ -138,22 +138,22 @@ elasticache_clusters:
cache_subnet_group_name: cache_subnet_group_name:
description: Elasticache Subnet Group used by the cache description: Elasticache Subnet Group used by the cache
returned: always returned: always
type: string type: str
sample: abcd-subnet-group sample: abcd-subnet-group
client_download_landing_page: client_download_landing_page:
description: URL of client download web page description: URL of client download web page
returned: always returned: always
type: string type: str
sample: 'https://console.aws.amazon.com/elasticache/home#client-download:' sample: 'https://console.aws.amazon.com/elasticache/home#client-download:'
engine: engine:
description: Engine used by elasticache description: Engine used by elasticache
returned: always returned: always
type: string type: str
sample: redis sample: redis
engine_version: engine_version:
description: Version of elasticache engine description: Version of elasticache engine
returned: always returned: always
type: string type: str
sample: 3.2.4 sample: 3.2.4
notification_configuration: notification_configuration:
description: Configuration of notifications description: Configuration of notifications
@ -163,12 +163,12 @@ elasticache_clusters:
topic_arn: topic_arn:
description: ARN of notification destination topic description: ARN of notification destination topic
returned: if notifications are enabled returned: if notifications are enabled
type: string type: str
sample: arn:aws:sns:*:123456789012:my_topic sample: arn:aws:sns:*:123456789012:my_topic
topic_name: topic_name:
description: Name of notification destination topic description: Name of notification destination topic
returned: if notifications are enabled returned: if notifications are enabled
type: string type: str
sample: MyTopic sample: MyTopic
num_cache_nodes: num_cache_nodes:
description: Number of Cache Nodes description: Number of Cache Nodes
@ -183,17 +183,17 @@ elasticache_clusters:
preferred_availability_zone: preferred_availability_zone:
description: Preferred Availability Zone description: Preferred Availability Zone
returned: always returned: always
type: string type: str
sample: ap-southeast-2b sample: ap-southeast-2b
preferred_maintenance_window: preferred_maintenance_window:
description: Time slot for preferred maintenance window description: Time slot for preferred maintenance window
returned: always returned: always
type: string type: str
sample: sat:12:00-sat:13:00 sample: sat:12:00-sat:13:00
replication_group_id: replication_group_id:
description: Replication Group Id description: Replication Group Id
returned: always returned: always
type: string type: str
sample: replication-001 sample: replication-001
security_groups: security_groups:
description: List of Security Groups associated with Elasticache description: List of Security Groups associated with Elasticache
@ -203,12 +203,12 @@ elasticache_clusters:
security_group_id: security_group_id:
description: Security Group ID description: Security Group ID
returned: always returned: always
type: string type: str
sample: sg-abcd1234 sample: sg-abcd1234
status: status:
description: Status of Security Group description: Status of Security Group
returned: always returned: always
type: string type: str
sample: active sample: active
tags: tags:
description: Tags applied to the elasticache cluster description: Tags applied to the elasticache cluster

46
lib/ansible/modules/cloud/amazon/elb_application_lb.py
View file

@ -221,17 +221,17 @@ RETURN = '''
access_logs_s3_bucket: access_logs_s3_bucket:
description: The name of the S3 bucket for the access logs. description: The name of the S3 bucket for the access logs.
returned: when state is present returned: when state is present
type: string type: str
sample: mys3bucket sample: mys3bucket
access_logs_s3_enabled: access_logs_s3_enabled:
description: Indicates whether access logs stored in Amazon S3 are enabled. description: Indicates whether access logs stored in Amazon S3 are enabled.
returned: when state is present returned: when state is present
type: string type: str
sample: true sample: true
access_logs_s3_prefix: access_logs_s3_prefix:
description: The prefix for the location in the S3 bucket. description: The prefix for the location in the S3 bucket.
returned: when state is present returned: when state is present
type: string type: str
sample: /my/logs sample: /my/logs
availability_zones: availability_zones:
description: The Availability Zones for the load balancer. description: The Availability Zones for the load balancer.
@ -241,32 +241,32 @@ availability_zones:
canonical_hosted_zone_id: canonical_hosted_zone_id:
description: The ID of the Amazon Route 53 hosted zone associated with the load balancer. description: The ID of the Amazon Route 53 hosted zone associated with the load balancer.
returned: when state is present returned: when state is present
type: string type: str
sample: ABCDEF12345678 sample: ABCDEF12345678
created_time: created_time:
description: The date and time the load balancer was created. description: The date and time the load balancer was created.
returned: when state is present returned: when state is present
type: string type: str
sample: "2015-02-12T02:14:02+00:00" sample: "2015-02-12T02:14:02+00:00"
deletion_protection_enabled: deletion_protection_enabled:
description: Indicates whether deletion protection is enabled. description: Indicates whether deletion protection is enabled.
returned: when state is present returned: when state is present
type: string type: str
sample: true sample: true
dns_name: dns_name:
description: The public DNS name of the load balancer. description: The public DNS name of the load balancer.
returned: when state is present returned: when state is present
type: string type: str
sample: internal-my-elb-123456789.ap-southeast-2.elb.amazonaws.com sample: internal-my-elb-123456789.ap-southeast-2.elb.amazonaws.com
idle_timeout_timeout_seconds: idle_timeout_timeout_seconds:
description: The idle timeout value, in seconds. description: The idle timeout value, in seconds.
returned: when state is present returned: when state is present
type: string type: str
sample: 60 sample: 60
ip_address_type: ip_address_type:
description: The type of IP addresses used by the subnets for the load balancer. description: The type of IP addresses used by the subnets for the load balancer.
returned: when state is present returned: when state is present
type: string type: str
sample: ipv4 sample: ipv4
listeners: listeners:
description: Information about the listeners. description: Information about the listeners.
@ -276,12 +276,12 @@ listeners:
listener_arn: listener_arn:
description: The Amazon Resource Name (ARN) of the listener. description: The Amazon Resource Name (ARN) of the listener.
returned: when state is present returned: when state is present
type: string type: str
sample: "" sample: ""
load_balancer_arn: load_balancer_arn:
description: The Amazon Resource Name (ARN) of the load balancer. description: The Amazon Resource Name (ARN) of the load balancer.
returned: when state is present returned: when state is present
type: string type: str
sample: "" sample: ""
port: port:
description: The port on which the load balancer is listening. description: The port on which the load balancer is listening.
@ -291,7 +291,7 @@ listeners:
protocol: protocol:
description: The protocol for connections from clients to the load balancer. description: The protocol for connections from clients to the load balancer.
returned: when state is present returned: when state is present
type: string type: str
sample: HTTPS sample: HTTPS
certificates: certificates:
description: The SSL server certificate. description: The SSL server certificate.
@ -301,47 +301,47 @@ listeners:
certificate_arn: certificate_arn:
description: The Amazon Resource Name (ARN) of the certificate. description: The Amazon Resource Name (ARN) of the certificate.
returned: when state is present returned: when state is present
type: string type: str
sample: "" sample: ""
ssl_policy: ssl_policy:
description: The security policy that defines which ciphers and protocols are supported. description: The security policy that defines which ciphers and protocols are supported.
returned: when state is present returned: when state is present
type: string type: str
sample: "" sample: ""
default_actions: default_actions:
description: The default actions for the listener. description: The default actions for the listener.
returned: when state is present returned: when state is present
type: string type: str
contains: contains:
type: type:
description: The type of action. description: The type of action.
returned: when state is present returned: when state is present
type: string type: str
sample: "" sample: ""
target_group_arn: target_group_arn:
description: The Amazon Resource Name (ARN) of the target group. description: The Amazon Resource Name (ARN) of the target group.
returned: when state is present returned: when state is present
type: string type: str
sample: "" sample: ""
load_balancer_arn: load_balancer_arn:
description: The Amazon Resource Name (ARN) of the load balancer. description: The Amazon Resource Name (ARN) of the load balancer.
returned: when state is present returned: when state is present
type: string type: str
sample: arn:aws:elasticloadbalancing:ap-southeast-2:0123456789:loadbalancer/app/my-elb/001122334455 sample: arn:aws:elasticloadbalancing:ap-southeast-2:0123456789:loadbalancer/app/my-elb/001122334455
load_balancer_name: load_balancer_name:
description: The name of the load balancer. description: The name of the load balancer.
returned: when state is present returned: when state is present
type: string type: str
sample: my-elb sample: my-elb
routing_http2_enabled: routing_http2_enabled:
description: Indicates whether HTTP/2 is enabled. description: Indicates whether HTTP/2 is enabled.
returned: when state is present returned: when state is present
type: string type: str
sample: true sample: true
scheme: scheme:
description: Internet-facing or internal load balancer. description: Internet-facing or internal load balancer.
returned: when state is present returned: when state is present
type: string type: str
sample: internal sample: internal
security_groups: security_groups:
description: The IDs of the security groups for the load balancer. description: The IDs of the security groups for the load balancer.
@ -363,12 +363,12 @@ tags:
type: type:
description: The type of load balancer. description: The type of load balancer.
returned: when state is present returned: when state is present
type: string type: str
sample: application sample: application
vpc_id: vpc_id:
description: The ID of the VPC for the load balancer. description: The ID of the VPC for the load balancer.
returned: when state is present returned: when state is present
type: string type: str
sample: vpc-0011223344 sample: vpc-0011223344
''' '''

28
lib/ansible/modules/cloud/amazon/elb_application_lb_facts.py
View file

@ -68,17 +68,17 @@ load_balancers:
access_logs_s3_bucket: access_logs_s3_bucket:
description: The name of the S3 bucket for the access logs. description: The name of the S3 bucket for the access logs.
returned: when status is present returned: when status is present
type: string type: str
sample: mys3bucket sample: mys3bucket
access_logs_s3_enabled: access_logs_s3_enabled:
description: Indicates whether access logs stored in Amazon S3 are enabled. description: Indicates whether access logs stored in Amazon S3 are enabled.
returned: when status is present returned: when status is present
type: string type: str
sample: true sample: true
access_logs_s3_prefix: access_logs_s3_prefix:
description: The prefix for the location in the S3 bucket. description: The prefix for the location in the S3 bucket.
returned: when status is present returned: when status is present
type: string type: str
sample: /my/logs sample: /my/logs
availability_zones: availability_zones:
description: The Availability Zones for the load balancer. description: The Availability Zones for the load balancer.
@ -88,47 +88,47 @@ load_balancers:
canonical_hosted_zone_id: canonical_hosted_zone_id:
description: The ID of the Amazon Route 53 hosted zone associated with the load balancer. description: The ID of the Amazon Route 53 hosted zone associated with the load balancer.
returned: when status is present returned: when status is present
type: string type: str
sample: ABCDEF12345678 sample: ABCDEF12345678
created_time: created_time:
description: The date and time the load balancer was created. description: The date and time the load balancer was created.
returned: when status is present returned: when status is present
type: string type: str
sample: "2015-02-12T02:14:02+00:00" sample: "2015-02-12T02:14:02+00:00"
deletion_protection_enabled: deletion_protection_enabled:
description: Indicates whether deletion protection is enabled. description: Indicates whether deletion protection is enabled.
returned: when status is present returned: when status is present
type: string type: str
sample: true sample: true
dns_name: dns_name:
description: The public DNS name of the load balancer. description: The public DNS name of the load balancer.
returned: when status is present returned: when status is present
type: string type: str
sample: internal-my-elb-123456789.ap-southeast-2.elb.amazonaws.com sample: internal-my-elb-123456789.ap-southeast-2.elb.amazonaws.com
idle_timeout_timeout_seconds: idle_timeout_timeout_seconds:
description: The idle timeout value, in seconds. description: The idle timeout value, in seconds.
returned: when status is present returned: when status is present
type: string type: str
sample: 60 sample: 60
ip_address_type: ip_address_type:
description: The type of IP addresses used by the subnets for the load balancer. description: The type of IP addresses used by the subnets for the load balancer.
returned: when status is present returned: when status is present
type: string type: str
sample: ipv4 sample: ipv4
load_balancer_arn: load_balancer_arn:
description: The Amazon Resource Name (ARN) of the load balancer. description: The Amazon Resource Name (ARN) of the load balancer.
returned: when status is present returned: when status is present
type: string type: str
sample: arn:aws:elasticloadbalancing:ap-southeast-2:0123456789:loadbalancer/app/my-elb/001122334455 sample: arn:aws:elasticloadbalancing:ap-southeast-2:0123456789:loadbalancer/app/my-elb/001122334455
load_balancer_name: load_balancer_name:
description: The name of the load balancer. description: The name of the load balancer.
returned: when status is present returned: when status is present
type: string type: str
sample: my-elb sample: my-elb
scheme: scheme:
description: Internet-facing or internal load balancer. description: Internet-facing or internal load balancer.
returned: when status is present returned: when status is present
type: string type: str
sample: internal sample: internal
security_groups: security_groups:
description: The IDs of the security groups for the load balancer. description: The IDs of the security groups for the load balancer.
@ -150,12 +150,12 @@ load_balancers:
type: type:
description: The type of load balancer. description: The type of load balancer.
returned: when status is present returned: when status is present
type: string type: str
sample: application sample: application
vpc_id: vpc_id:
description: The ID of the VPC for the load balancer. description: The ID of the VPC for the load balancer.
returned: when status is present returned: when status is present
type: string type: str
sample: vpc-0011223344 sample: vpc-0011223344
''' '''

40
lib/ansible/modules/cloud/amazon/elb_network_lb.py
View file

@ -140,32 +140,32 @@ availability_zones:
canonical_hosted_zone_id: canonical_hosted_zone_id:
description: The ID of the Amazon Route 53 hosted zone associated with the load balancer. description: The ID of the Amazon Route 53 hosted zone associated with the load balancer.
returned: when state is present returned: when state is present
type: string type: str
sample: ABCDEF12345678 sample: ABCDEF12345678
created_time: created_time:
description: The date and time the load balancer was created. description: The date and time the load balancer was created.
returned: when state is present returned: when state is present
type: string type: str
sample: "2015-02-12T02:14:02+00:00" sample: "2015-02-12T02:14:02+00:00"
deletion_protection_enabled: deletion_protection_enabled:
description: Indicates whether deletion protection is enabled. description: Indicates whether deletion protection is enabled.
returned: when state is present returned: when state is present
type: string type: str
sample: true sample: true
dns_name: dns_name:
description: The public DNS name of the load balancer. description: The public DNS name of the load balancer.
returned: when state is present returned: when state is present
type: string type: str
sample: internal-my-elb-123456789.ap-southeast-2.elb.amazonaws.com sample: internal-my-elb-123456789.ap-southeast-2.elb.amazonaws.com
idle_timeout_timeout_seconds: idle_timeout_timeout_seconds:
description: The idle timeout value, in seconds. description: The idle timeout value, in seconds.
returned: when state is present returned: when state is present
type: string type: str
sample: 60 sample: 60
ip_address_type: ip_address_type:
description: The type of IP addresses used by the subnets for the load balancer. description: The type of IP addresses used by the subnets for the load balancer.
returned: when state is present returned: when state is present
type: string type: str
sample: ipv4 sample: ipv4
listeners: listeners:
description: Information about the listeners. description: Information about the listeners.
@ -175,12 +175,12 @@ listeners:
listener_arn: listener_arn:
description: The Amazon Resource Name (ARN) of the listener. description: The Amazon Resource Name (ARN) of the listener.
returned: when state is present returned: when state is present
type: string type: str
sample: "" sample: ""
load_balancer_arn: load_balancer_arn:
description: The Amazon Resource Name (ARN) of the load balancer. description: The Amazon Resource Name (ARN) of the load balancer.
returned: when state is present returned: when state is present
type: string type: str
sample: "" sample: ""
port: port:
description: The port on which the load balancer is listening. description: The port on which the load balancer is listening.
@ -190,7 +190,7 @@ listeners:
protocol: protocol:
description: The protocol for connections from clients to the load balancer. description: The protocol for connections from clients to the load balancer.
returned: when state is present returned: when state is present
type: string type: str
sample: HTTPS sample: HTTPS
certificates: certificates:
description: The SSL server certificate. description: The SSL server certificate.
@ -200,47 +200,47 @@ listeners:
certificate_arn: certificate_arn:
description: The Amazon Resource Name (ARN) of the certificate. description: The Amazon Resource Name (ARN) of the certificate.
returned: when state is present returned: when state is present
type: string type: str
sample: "" sample: ""
ssl_policy: ssl_policy:
description: The security policy that defines which ciphers and protocols are supported. description: The security policy that defines which ciphers and protocols are supported.
returned: when state is present returned: when state is present
type: string type: str
sample: "" sample: ""
default_actions: default_actions:
description: The default actions for the listener. description: The default actions for the listener.
returned: when state is present returned: when state is present
type: string type: str
contains: contains:
type: type:
description: The type of action. description: The type of action.
returned: when state is present returned: when state is present
type: string type: str
sample: "" sample: ""
target_group_arn: target_group_arn:
description: The Amazon Resource Name (ARN) of the target group. description: The Amazon Resource Name (ARN) of the target group.
returned: when state is present returned: when state is present
type: string type: str
sample: "" sample: ""
load_balancer_arn: load_balancer_arn:
description: The Amazon Resource Name (ARN) of the load balancer. description: The Amazon Resource Name (ARN) of the load balancer.
returned: when state is present returned: when state is present
type: string type: str
sample: arn:aws:elasticloadbalancing:ap-southeast-2:0123456789:loadbalancer/app/my-elb/001122334455 sample: arn:aws:elasticloadbalancing:ap-southeast-2:0123456789:loadbalancer/app/my-elb/001122334455
load_balancer_name: load_balancer_name:
description: The name of the load balancer. description: The name of the load balancer.
returned: when state is present returned: when state is present
type: string type: str
sample: my-elb sample: my-elb
load_balancing_cross_zone_enabled: load_balancing_cross_zone_enabled:
description: Indicates whether cross-zone load balancing is enabled. description: Indicates whether cross-zone load balancing is enabled.
returned: when state is present returned: when state is present
type: string type: str
sample: true sample: true
scheme: scheme:
description: Internet-facing or internal load balancer. description: Internet-facing or internal load balancer.
returned: when state is present returned: when state is present
type: string type: str
sample: internal sample: internal
state: state:
description: The state of the load balancer. description: The state of the load balancer.
@ -257,12 +257,12 @@ tags:
type: type:
description: The type of load balancer. description: The type of load balancer.
returned: when state is present returned: when state is present
type: string type: str
sample: network sample: network
vpc_id: vpc_id:
description: The ID of the VPC for the load balancer. description: The ID of the VPC for the load balancer.
returned: when state is present returned: when state is present
type: string type: str
sample: vpc-0011223344 sample: vpc-0011223344
''' '''

4
lib/ansible/modules/cloud/amazon/elb_target_facts.py
View file

@ -141,14 +141,14 @@ instance_target_groups:
contains: contains:
target_group_arn: target_group_arn:
description: The ARN of the target group description: The ARN of the target group
type: string type: str
returned: always returned: always
sample: sample:
- "arn:aws:elasticloadbalancing:eu-west-1:111111111111:targetgroup/target-group/deadbeefdeadbeef" - "arn:aws:elasticloadbalancing:eu-west-1:111111111111:targetgroup/target-group/deadbeefdeadbeef"
target_group_type: target_group_type:
description: Which target type is used for this group description: Which target type is used for this group
returned: always returned: always
type: string type: str
sample: sample:
- ip - ip
- instance - instance

16
lib/ansible/modules/cloud/amazon/elb_target_group.py
View file

@ -227,17 +227,17 @@ health_check_interval_seconds:
health_check_path: health_check_path:
description: The destination for the health check request. description: The destination for the health check request.
returned: when state present returned: when state present
type: string type: str
sample: /index.html sample: /index.html
health_check_port: health_check_port:
description: The port to use to connect with the target. description: The port to use to connect with the target.
returned: when state present returned: when state present
type: string type: str
sample: traffic-port sample: traffic-port
health_check_protocol: health_check_protocol:
description: The protocol to use to connect with the target. description: The protocol to use to connect with the target.
returned: when state present returned: when state present
type: string type: str
sample: HTTP sample: HTTP
health_check_timeout_seconds: health_check_timeout_seconds:
description: The amount of time, in seconds, during which no response means a failed health check. description: The amount of time, in seconds, during which no response means a failed health check.
@ -269,7 +269,7 @@ port:
protocol: protocol:
description: The protocol to use for routing traffic to the targets. description: The protocol to use for routing traffic to the targets.
returned: when state present returned: when state present
type: string type: str
sample: HTTP sample: HTTP
stickiness_enabled: stickiness_enabled:
description: Indicates whether sticky sessions are enabled. description: Indicates whether sticky sessions are enabled.
@ -284,7 +284,7 @@ stickiness_lb_cookie_duration_seconds:
stickiness_type: stickiness_type:
description: The type of sticky sessions. description: The type of sticky sessions.
returned: when state present returned: when state present
type: string type: str
sample: lb_cookie sample: lb_cookie
tags: tags:
description: The tags attached to the target group. description: The tags attached to the target group.
@ -296,12 +296,12 @@ tags:
target_group_arn: target_group_arn:
description: The Amazon Resource Name (ARN) of the target group. description: The Amazon Resource Name (ARN) of the target group.
returned: when state present returned: when state present
type: string type: str
sample: "arn:aws:elasticloadbalancing:ap-southeast-2:01234567890:targetgroup/mytargetgroup/aabbccddee0044332211" sample: "arn:aws:elasticloadbalancing:ap-southeast-2:01234567890:targetgroup/mytargetgroup/aabbccddee0044332211"
target_group_name: target_group_name:
description: The name of the target group. description: The name of the target group.
returned: when state present returned: when state present
type: string type: str
sample: mytargetgroup sample: mytargetgroup
unhealthy_threshold_count: unhealthy_threshold_count:
description: The number of consecutive health check failures required before considering the target unhealthy. description: The number of consecutive health check failures required before considering the target unhealthy.
@ -311,7 +311,7 @@ unhealthy_threshold_count:
vpc_id: vpc_id:
description: The ID of the VPC for the targets. description: The ID of the VPC for the targets.
returned: when state present returned: when state present
type: string type: str
sample: vpc-0123456 sample: vpc-0123456
''' '''

16
lib/ansible/modules/cloud/amazon/elb_target_group_facts.py
View file

@ -75,17 +75,17 @@ target_groups:
health_check_path: health_check_path:
description: The destination for the health check request. description: The destination for the health check request.
returned: always returned: always
type: string type: str
sample: /index.html sample: /index.html
health_check_port: health_check_port:
description: The port to use to connect with the target. description: The port to use to connect with the target.
returned: always returned: always
type: string type: str
sample: traffic-port sample: traffic-port
health_check_protocol: health_check_protocol:
description: The protocol to use to connect with the target. description: The protocol to use to connect with the target.
returned: always returned: always
type: string type: str
sample: HTTP sample: HTTP
health_check_timeout_seconds: health_check_timeout_seconds:
description: The amount of time, in seconds, during which no response means a failed health check. description: The amount of time, in seconds, during which no response means a failed health check.
@ -117,7 +117,7 @@ target_groups:
protocol: protocol:
description: The protocol to use for routing traffic to the targets. description: The protocol to use for routing traffic to the targets.
returned: always returned: always
type: string type: str
sample: HTTP sample: HTTP
stickiness_enabled: stickiness_enabled:
description: Indicates whether sticky sessions are enabled. description: Indicates whether sticky sessions are enabled.
@ -132,7 +132,7 @@ target_groups:
stickiness_type: stickiness_type:
description: The type of sticky sessions. description: The type of sticky sessions.
returned: always returned: always
type: string type: str
sample: lb_cookie sample: lb_cookie
tags: tags:
description: The tags attached to the target group. description: The tags attached to the target group.
@ -144,12 +144,12 @@ target_groups:
target_group_arn: target_group_arn:
description: The Amazon Resource Name (ARN) of the target group. description: The Amazon Resource Name (ARN) of the target group.
returned: always returned: always
type: string type: str
sample: "arn:aws:elasticloadbalancing:ap-southeast-2:01234567890:targetgroup/mytargetgroup/aabbccddee0044332211" sample: "arn:aws:elasticloadbalancing:ap-southeast-2:01234567890:targetgroup/mytargetgroup/aabbccddee0044332211"
target_group_name: target_group_name:
description: The name of the target group. description: The name of the target group.
returned: always returned: always
type: string type: str
sample: mytargetgroup sample: mytargetgroup
unhealthy_threshold_count: unhealthy_threshold_count:
description: The number of consecutive health check failures required before considering the target unhealthy. description: The number of consecutive health check failures required before considering the target unhealthy.
@ -159,7 +159,7 @@ target_groups:
vpc_id: vpc_id:
description: The ID of the VPC for the targets. description: The ID of the VPC for the targets.
returned: always returned: always
type: string type: str
sample: vpc-0123456 sample: vpc-0123456
''' '''

2
lib/ansible/modules/cloud/amazon/execute_lambda.py
View file

@ -121,7 +121,7 @@ output:
sample: "{ 'output': 'something' }" sample: "{ 'output': 'something' }"
logs: logs:
description: The last 4KB of the function logs. Only provided if I(tail_log) is true description: The last 4KB of the function logs. Only provided if I(tail_log) is true
type: string type: str
returned: if I(tail_log) == true returned: if I(tail_log) == true
status: status:
description: C(StatusCode) of API call exit (200 for synchronous invokes, 202 for async) description: C(StatusCode) of API call exit (200 for synchronous invokes, 202 for async)

2
lib/ansible/modules/cloud/amazon/iam.py
View file

@ -137,7 +137,7 @@ task:
RETURN = ''' RETURN = '''
role_result: role_result:
description: the IAM.role dict returned by Boto description: the IAM.role dict returned by Boto
type: string type: str
returned: if iam_type=role and state=present returned: if iam_type=role and state=present
sample: { sample: {
"arn": "arn:aws:iam::A1B2C3D4E5F6:role/my-new-role", "arn": "arn:aws:iam::A1B2C3D4E5F6:role/my-new-role",

20
lib/ansible/modules/cloud/amazon/iam_group.py
View file

@ -118,23 +118,23 @@ group:
contains: contains:
arn: arn:
description: the Amazon Resource Name (ARN) specifying the group description: the Amazon Resource Name (ARN) specifying the group
type: string type: str
sample: "arn:aws:iam::1234567890:group/testgroup1" sample: "arn:aws:iam::1234567890:group/testgroup1"
create_date: create_date:
description: the date and time, in ISO 8601 date-time format, when the group was created description: the date and time, in ISO 8601 date-time format, when the group was created
type: string type: str
sample: "2017-02-08T04:36:28+00:00" sample: "2017-02-08T04:36:28+00:00"
group_id: group_id:
description: the stable and unique string identifying the group description: the stable and unique string identifying the group
type: string type: str
sample: AGPAIDBWE12NSFINE55TM sample: AGPAIDBWE12NSFINE55TM
group_name: group_name:
description: the friendly name that identifies the group description: the friendly name that identifies the group
type: string type: str
sample: testgroup1 sample: testgroup1
path: path:
description: the path to the group description: the path to the group
type: string type: str
sample: / sample: /
users: users:
description: list containing all the group members description: list containing all the group members
@ -143,23 +143,23 @@ users:
contains: contains:
arn: arn:
description: the Amazon Resource Name (ARN) specifying the user description: the Amazon Resource Name (ARN) specifying the user
type: string type: str
sample: "arn:aws:iam::1234567890:user/test_user1" sample: "arn:aws:iam::1234567890:user/test_user1"
create_date: create_date:
description: the date and time, in ISO 8601 date-time format, when the user was created description: the date and time, in ISO 8601 date-time format, when the user was created
type: string type: str
sample: "2017-02-08T04:36:28+00:00" sample: "2017-02-08T04:36:28+00:00"
user_id: user_id:
description: the stable and unique string identifying the user description: the stable and unique string identifying the user
type: string type: str
sample: AIDAIZTPY123YQRS22YU2 sample: AIDAIZTPY123YQRS22YU2
user_name: user_name:
description: the friendly name that identifies the user description: the friendly name that identifies the user
type: string type: str
sample: testgroup1 sample: testgroup1
path: path:
description: the path to the user description: the path to the user
type: string type: str
sample: / sample: /
''' '''

2
lib/ansible/modules/cloud/amazon/iam_managed_policy.py
View file

@ -95,7 +95,7 @@ RETURN = '''
policy: policy:
description: Returns the policy json structure, when state == absent this will return the value of the removed policy. description: Returns the policy json structure, when state == absent this will return the value of the removed policy.
returned: success returned: success
type: string type: str
sample: '{ sample: '{
"arn": "arn:aws:iam::aws:policy/AdministratorAccess " "arn": "arn:aws:iam::aws:policy/AdministratorAccess "
"attachment_count": 0, "attachment_count": 0,

12
lib/ansible/modules/cloud/amazon/iam_role.py
View file

@ -104,32 +104,32 @@ iam_role:
contains: contains:
path: path:
description: the path to the role description: the path to the role
type: string type: str
returned: always returned: always
sample: / sample: /
role_name: role_name:
description: the friendly name that identifies the role description: the friendly name that identifies the role
type: string type: str
returned: always returned: always
sample: myrole sample: myrole
role_id: role_id:
description: the stable and unique string identifying the role description: the stable and unique string identifying the role
type: string type: str
returned: always returned: always
sample: ABCDEFF4EZ4ABCDEFV4ZC sample: ABCDEFF4EZ4ABCDEFV4ZC
arn: arn:
description: the Amazon Resource Name (ARN) specifying the role description: the Amazon Resource Name (ARN) specifying the role
type: string type: str
returned: always returned: always
sample: "arn:aws:iam::1234567890:role/mynewrole" sample: "arn:aws:iam::1234567890:role/mynewrole"
create_date: create_date:
description: the date and time, in ISO 8601 date-time format, when the role was created description: the date and time, in ISO 8601 date-time format, when the role was created
type: string type: str
returned: always returned: always
sample: "2016-08-14T04:36:28+00:00" sample: "2016-08-14T04:36:28+00:00"
assume_role_policy_document: assume_role_policy_document:
description: the policy that grants an entity permission to assume the role description: the policy that grants an entity permission to assume the role
type: string type: str
returned: always returned: always
sample: { sample: {
'statement': [ 'statement': [

26
lib/ansible/modules/cloud/amazon/iam_role_facts.py
View file

@ -60,16 +60,16 @@ iam_roles:
arn: arn:
description: Amazon Resource Name for IAM role description: Amazon Resource Name for IAM role
returned: always returned: always
type: string type: str
sample: arn:aws:iam::123456789012:role/AnsibleTestRole sample: arn:aws:iam::123456789012:role/AnsibleTestRole
assume_role_policy_document: assume_role_policy_document:
description: Policy Document describing what can assume the role description: Policy Document describing what can assume the role
returned: always returned: always
type: string type: str
create_date: create_date:
description: Date IAM role was created description: Date IAM role was created
returned: always returned: always
type: string type: str
sample: '2017-10-23T00:05:08+00:00' sample: '2017-10-23T00:05:08+00:00'
inline_policies: inline_policies:
description: List of names of inline policies description: List of names of inline policies
@ -84,12 +84,12 @@ iam_roles:
policy_arn: policy_arn:
description: Amazon Resource Name for the policy description: Amazon Resource Name for the policy
returned: always returned: always
type: string type: str
sample: arn:aws:iam::123456789012:policy/AnsibleTestEC2Policy sample: arn:aws:iam::123456789012:policy/AnsibleTestEC2Policy
policy_name: policy_name:
description: Name of managed policy description: Name of managed policy
returned: always returned: always
type: string type: str
sample: AnsibleTestEC2Policy sample: AnsibleTestEC2Policy
instance_profiles: instance_profiles:
description: List of attached instance profiles description: List of attached instance profiles
@ -99,27 +99,27 @@ iam_roles:
arn: arn:
description: Amazon Resource Name for the instance profile description: Amazon Resource Name for the instance profile
returned: always returned: always
type: string type: str
sample: arn:aws:iam::123456789012:instance-profile/AnsibleTestEC2Policy sample: arn:aws:iam::123456789012:instance-profile/AnsibleTestEC2Policy
create_date: create_date:
description: Date instance profile was created description: Date instance profile was created
returned: always returned: always
type: string type: str
sample: '2017-10-23T00:05:08+00:00' sample: '2017-10-23T00:05:08+00:00'
instance_profile_id: instance_profile_id:
description: Amazon Identifier for the instance profile description: Amazon Identifier for the instance profile
returned: always returned: always
type: string type: str
sample: AROAII7ABCD123456EFGH sample: AROAII7ABCD123456EFGH
instance_profile_name: instance_profile_name:
description: Name of instance profile description: Name of instance profile
returned: always returned: always
type: string type: str
sample: AnsibleTestEC2Policy sample: AnsibleTestEC2Policy
path: path:
description: Path of instance profile description: Path of instance profile
returned: always returned: always
type: string type: str
sample: / sample: /
roles: roles:
description: List of roles associated with this instance profile description: List of roles associated with this instance profile
@ -129,17 +129,17 @@ iam_roles:
path: path:
description: Path of role description: Path of role
returned: always returned: always
type: string type: str
sample: / sample: /
role_id: role_id:
description: Amazon Identifier for the role description: Amazon Identifier for the role
returned: always returned: always
type: string type: str
sample: AROAII7ABCD123456EFGH sample: AROAII7ABCD123456EFGH
role_name: role_name:
description: Name of the role description: Name of the role
returned: always returned: always
type: string type: str
sample: AnsibleTestRole sample: AnsibleTestRole
''' '''

10
lib/ansible/modules/cloud/amazon/iam_user.py
View file

@ -78,23 +78,23 @@ user:
contains: contains:
arn: arn:
description: the Amazon Resource Name (ARN) specifying the user description: the Amazon Resource Name (ARN) specifying the user
type: string type: str
sample: "arn:aws:iam::1234567890:user/testuser1" sample: "arn:aws:iam::1234567890:user/testuser1"
create_date: create_date:
description: the date and time, in ISO 8601 date-time format, when the user was created description: the date and time, in ISO 8601 date-time format, when the user was created
type: string type: str
sample: "2017-02-08T04:36:28+00:00" sample: "2017-02-08T04:36:28+00:00"
user_id: user_id:
description: the stable and unique string identifying the user description: the stable and unique string identifying the user
type: string type: str
sample: AGPAIDBWE12NSFINE55TM sample: AGPAIDBWE12NSFINE55TM
user_name: user_name:
description: the friendly name that identifies the user description: the friendly name that identifies the user
type: string type: str
sample: testuser1 sample: testuser1
path: path:
description: the path to the user description: the path to the user
type: string type: str
sample: / sample: /
''' '''

6
lib/ansible/modules/cloud/amazon/kinesis_stream.py
View file

@ -147,17 +147,17 @@ RETURN = '''
stream_name: stream_name:
description: The name of the Kinesis Stream. description: The name of the Kinesis Stream.
returned: when state == present. returned: when state == present.
type: string type: str
sample: "test-stream" sample: "test-stream"
stream_arn: stream_arn:
description: The amazon resource identifier description: The amazon resource identifier
returned: when state == present. returned: when state == present.
type: string type: str
sample: "arn:aws:kinesis:east-side:123456789:stream/test-stream" sample: "arn:aws:kinesis:east-side:123456789:stream/test-stream"
stream_status: stream_status:
description: The current state of the Kinesis Stream. description: The current state of the Kinesis Stream.
returned: when state == present. returned: when state == present.
type: string type: str
sample: "ACTIVE" sample: "ACTIVE"
retention_period_hours: retention_period_hours:
description: Number of hours messages will be kept for a Kinesis Stream. description: Number of hours messages will be kept for a Kinesis Stream.

8
lib/ansible/modules/cloud/amazon/lambda_alias.py
View file

@ -120,22 +120,22 @@ RETURN = '''
alias_arn: alias_arn:
description: Full ARN of the function, including the alias description: Full ARN of the function, including the alias
returned: success returned: success
type: string type: str
sample: arn:aws:lambda:us-west-2:123456789012:function:myFunction:dev sample: arn:aws:lambda:us-west-2:123456789012:function:myFunction:dev
description: description:
description: A short description of the alias description: A short description of the alias
returned: success returned: success
type: string type: str
sample: The development stage for my hot new app sample: The development stage for my hot new app
function_version: function_version:
description: The qualifier that the alias refers to description: The qualifier that the alias refers to
returned: success returned: success
type: string type: str
sample: $LATEST sample: $LATEST
name: name:
description: The name of the alias assigned description: The name of the alias assigned
returned: success returned: success
type: string type: str
sample: dev sample: dev
''' '''

2
lib/ansible/modules/cloud/amazon/lambda_policy.py
View file

@ -123,7 +123,7 @@ RETURN = '''
lambda_policy_action: lambda_policy_action:
description: describes what action was taken description: describes what action was taken
returned: success returned: success
type: string type: str
''' '''
import json import json

66
lib/ansible/modules/cloud/amazon/rds.py
View file

@ -262,67 +262,67 @@ RETURN = '''
engine: 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: string type: str
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: string type: str
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: string type: str
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: string type: str
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: string type: str
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: boolean type: bool
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: string type: str
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: string type: str
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: string type: str
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: boolean type: bool
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: string type: str
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: string type: str
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: string type: str
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
@ -337,12 +337,12 @@ 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: string type: str
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: string type: str
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
@ -352,12 +352,12 @@ 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: string type: str
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: string type: str
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
@ -367,47 +367,47 @@ 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: string type: str
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: string type: str
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: string type: str
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: string type: str
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: string type: str
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: string type: str
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: string type: str
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: string type: str
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: string type: str
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
@ -417,17 +417,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: string type: str
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: string type: str
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: string type: str
sample: "complete" sample: "complete"
subnets: subnets:
description: the description of the DB subnet group description: the description of the DB subnet group
@ -442,22 +442,22 @@ db_subnet_groups:
name: name:
description: avaialbility zone description: avaialbility zone
returned: when RDS instance exists returned: when RDS instance exists
type: string type: str
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: boolean type: bool
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: string type: str
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: string type: str
sample: "active" sample: "active"
''' '''

64
lib/ansible/modules/cloud/amazon/rds_instance.py
View file

@ -414,7 +414,7 @@ auto_minor_version_upgrade:
availability_zone: availability_zone:
description: The availability zone for the DB instance. description: The availability zone for the DB instance.
returned: always returned: always
type: string type: str
sample: us-east-1f sample: us-east-1f
backup_retention_period: backup_retention_period:
description: The number of days for which automated backups are retained. description: The number of days for which automated backups are retained.
@ -424,7 +424,7 @@ backup_retention_period:
ca_certificate_identifier: ca_certificate_identifier:
description: The identifier of the CA certificate for the DB instance. description: The identifier of the CA certificate for the DB instance.
returned: always returned: always
type: string type: str
sample: rds-ca-2015 sample: rds-ca-2015
copy_tags_to_snapshot: copy_tags_to_snapshot:
description: Whether tags are copied from the DB instance to snapshots of the DB instance. description: Whether tags are copied from the DB instance to snapshots of the DB instance.
@ -434,17 +434,17 @@ copy_tags_to_snapshot:
db_instance_arn: db_instance_arn:
description: The Amazon Resource Name (ARN) for the DB instance. description: The Amazon Resource Name (ARN) for the DB instance.
returned: always returned: always
type: string type: str
sample: arn:aws:rds:us-east-1:123456789012:db:ansible-test sample: arn:aws:rds:us-east-1:123456789012:db:ansible-test
db_instance_class: db_instance_class:
description: The name of the compute and memory capacity class of the DB instance. description: The name of the compute and memory capacity class of the DB instance.
returned: always returned: always
type: string type: str
sample: db.m4.large sample: db.m4.large
db_instance_identifier: db_instance_identifier:
description: The identifier of the DB instance description: The identifier of the DB instance
returned: always returned: always
type: string type: str
sample: ansible-test sample: ansible-test
db_instance_port: db_instance_port:
description: The port that the DB instance listens on. description: The port that the DB instance listens on.
@ -454,7 +454,7 @@ db_instance_port:
db_instance_status: db_instance_status:
description: The current state of this database. description: The current state of this database.
returned: always returned: always
type: string type: str
sample: stopped sample: stopped
db_parameter_groups: db_parameter_groups:
description: The list of DB parameter groups applied to this DB instance. description: The list of DB parameter groups applied to this DB instance.
@ -464,12 +464,12 @@ db_parameter_groups:
db_parameter_group_name: db_parameter_group_name:
description: The name of the DP parameter group. description: The name of the DP parameter group.
returned: always returned: always
type: string type: str
sample: default.mariadb10.0 sample: default.mariadb10.0
parameter_apply_status: parameter_apply_status:
description: The status of parameter updates. description: The status of parameter updates.
returned: always returned: always
type: string type: str
sample: in-sync sample: in-sync
db_security_groups: db_security_groups:
description: A list of DB security groups associated with this DB instance. description: A list of DB security groups associated with this DB instance.
@ -484,17 +484,17 @@ db_subnet_group:
db_subnet_group_description: db_subnet_group_description:
description: The description of the DB subnet group. description: The description of the DB subnet group.
returned: always returned: always
type: string type: str
sample: default sample: default
db_subnet_group_name: db_subnet_group_name:
description: The name of the DB subnet group. description: The name of the DB subnet group.
returned: always returned: always
type: string type: str
sample: default sample: default
subnet_group_status: subnet_group_status:
description: The status of the DB subnet group. description: The status of the DB subnet group.
returned: always returned: always
type: string type: str
sample: Complete sample: Complete
subnets: subnets:
description: A list of Subnet elements. description: A list of Subnet elements.
@ -509,27 +509,27 @@ db_subnet_group:
name: name:
description: The name of the Availability Zone. description: The name of the Availability Zone.
returned: always returned: always
type: string type: str
sample: us-east-1c sample: us-east-1c
subnet_identifier: subnet_identifier:
description: The ID of the subnet. description: The ID of the subnet.
returned: always returned: always
type: string type: str
sample: subnet-12345678 sample: subnet-12345678
subnet_status: subnet_status:
description: The status of the subnet. description: The status of the subnet.
returned: always returned: always
type: string type: str
sample: Active sample: Active
vpc_id: vpc_id:
description: The VpcId of the DB subnet group. description: The VpcId of the DB subnet group.
returned: always returned: always
type: string type: str
sample: vpc-12345678 sample: vpc-12345678
dbi_resource_id: dbi_resource_id:
description: The AWS Region-unique, immutable identifier for the DB instance. description: The AWS Region-unique, immutable identifier for the DB instance.
returned: always returned: always
type: string type: str
sample: db-UHV3QRNWX4KB6GALCIGRML6QFA sample: db-UHV3QRNWX4KB6GALCIGRML6QFA
domain_memberships: domain_memberships:
description: The Active Directory Domain membership records associated with the DB instance. description: The Active Directory Domain membership records associated with the DB instance.
@ -544,12 +544,12 @@ endpoint:
address: address:
description: The DNS address of the DB instance. description: The DNS address of the DB instance.
returned: always returned: always
type: string type: str
sample: ansible-test.cvlrtwiennww.us-east-1.rds.amazonaws.com sample: ansible-test.cvlrtwiennww.us-east-1.rds.amazonaws.com
hosted_zone_id: hosted_zone_id:
description: The ID that Amazon Route 53 assigns when you create a hosted zone. description: The ID that Amazon Route 53 assigns when you create a hosted zone.
returned: always returned: always
type: string type: str
sample: ZTR2ITUGPA61AM sample: ZTR2ITUGPA61AM
port: port:
description: The port that the database engine is listening on. description: The port that the database engine is listening on.
@ -559,12 +559,12 @@ endpoint:
engine: engine:
description: The database engine version. description: The database engine version.
returned: always returned: always
type: string type: str
sample: mariadb sample: mariadb
engine_version: engine_version:
description: The database engine version. description: The database engine version.
returned: always returned: always
type: string type: str
sample: 10.0.35 sample: 10.0.35
iam_database_authentication_enabled: iam_database_authentication_enabled:
description: Whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. description: Whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
@ -574,27 +574,27 @@ iam_database_authentication_enabled:
instance_create_time: instance_create_time:
description: The date and time the DB instance was created. description: The date and time the DB instance was created.
returned: always returned: always
type: string type: str
sample: '2018-07-04T16:48:35.332000+00:00' sample: '2018-07-04T16:48:35.332000+00:00'
kms_key_id: kms_key_id:
description: The AWS KMS key identifier for the encrypted DB instance when storage_encrypted is true. description: The AWS KMS key identifier for the encrypted DB instance when storage_encrypted is true.
returned: When storage_encrypted is true returned: When storage_encrypted is true
type: string type: str
sample: arn:aws:kms:us-east-1:123456789012:key/70c45553-ad2e-4a85-9f14-cfeb47555c33 sample: arn:aws:kms:us-east-1:123456789012:key/70c45553-ad2e-4a85-9f14-cfeb47555c33
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: always returned: always
type: string type: str
sample: '2018-07-04T16:50:50.642000+00:00' sample: '2018-07-04T16:50:50.642000+00:00'
license_model: license_model:
description: The License model information for this DB instance. description: The License model information for this DB instance.
returned: always returned: always
type: string type: str
sample: general-public-license sample: general-public-license
master_username: master_username:
description: The master username for the DB instance. description: The master username for the DB instance.
returned: always returned: always
type: string type: str
sample: test sample: test
monitoring_interval: monitoring_interval:
description: description:
@ -616,12 +616,12 @@ option_group_memberships:
option_group_name: option_group_name:
description: The name of the option group that the instance belongs to. description: The name of the option group that the instance belongs to.
returned: always returned: always
type: string type: str
sample: default:mariadb-10-0 sample: default:mariadb-10-0
status: status:
description: The status of the DB instance's option group membership. description: The status of the DB instance's option group membership.
returned: always returned: always
type: string type: str
sample: in-sync sample: in-sync
pending_modified_values: pending_modified_values:
description: The changes to the DB instance that are pending. description: The changes to the DB instance that are pending.
@ -636,12 +636,12 @@ performance_insights_enabled:
preferred_backup_window: preferred_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: always returned: always
type: string type: str
sample: 07:01-07:31 sample: 07:01-07:31
preferred_maintenance_window: preferred_maintenance_window:
description: The weekly time range (in UTC) during which system maintenance can occur. description: The weekly time range (in UTC) during which system maintenance can occur.
returned: always returned: always
type: string type: str
sample: sun:09:31-sun:10:01 sample: sun:09:31-sun:10:01
publicly_accessible: publicly_accessible:
description: description:
@ -663,7 +663,7 @@ storage_encrypted:
storage_type: storage_type:
description: The storage type to be associated with the DB instance. description: The storage type to be associated with the DB instance.
returned: always returned: always
type: string type: str
sample: standard sample: standard
tags: tags:
description: A dictionary of tags associated with the DB instance. description: A dictionary of tags associated with the DB instance.
@ -678,12 +678,12 @@ vpc_security_groups:
status: status:
description: The status of the VPC security group. description: The status of the VPC security group.
returned: always returned: always
type: string type: str
sample: active sample: active
vpc_security_group_id: vpc_security_group_id:
description: The name of the VPC security group. description: The name of the VPC security group.
returned: always returned: always
type: string type: str
sample: sg-12345678 sample: sg-12345678
''' '''

66
lib/ansible/modules/cloud/amazon/rds_instance_facts.py
View file

@ -66,7 +66,7 @@ instances:
availability_zone: availability_zone:
description: Availability Zone in which the database resides description: Availability Zone in which the database resides
returned: always returned: always
type: string type: str
sample: us-west-2b sample: us-west-2b
backup_retention_period: backup_retention_period:
description: Days for which backups are retained description: Days for which backups are retained
@ -76,7 +76,7 @@ instances:
ca_certificate_identifier: ca_certificate_identifier:
description: ID for the CA certificate description: ID for the CA certificate
returned: always returned: always
type: string type: str
sample: rds-ca-2015 sample: rds-ca-2015
copy_tags_to_snapshot: copy_tags_to_snapshot:
description: Whether DB tags should be copied to the snapshot description: Whether DB tags should be copied to the snapshot
@ -86,17 +86,17 @@ instances:
db_instance_arn: db_instance_arn:
description: ARN of the database instance description: ARN of the database instance
returned: always returned: always
type: string type: str
sample: arn:aws:rds:us-west-2:111111111111:db:helloworld-rds sample: arn:aws:rds:us-west-2:111111111111:db:helloworld-rds
db_instance_class: db_instance_class:
description: Instance class of the database instance description: Instance class of the database instance
returned: always returned: always
type: string type: str
sample: db.t2.small sample: db.t2.small
db_instance_identifier: db_instance_identifier:
description: Database instance identifier description: Database instance identifier
returned: always returned: always
type: string type: str
sample: helloworld-rds sample: helloworld-rds
db_instance_port: db_instance_port:
description: Port used by the database instance description: Port used by the database instance
@ -106,12 +106,12 @@ instances:
db_instance_status: db_instance_status:
description: Status of the database instance description: Status of the database instance
returned: always returned: always
type: string type: str
sample: available sample: available
db_name: db_name:
description: Name of the database description: Name of the database
returned: always returned: always
type: string type: str
sample: management sample: management
db_parameter_groups: db_parameter_groups:
description: List of database parameter groups description: List of database parameter groups
@ -121,12 +121,12 @@ instances:
db_parameter_group_name: db_parameter_group_name:
description: Name of the database parameter group description: Name of the database parameter group
returned: always returned: always
type: string type: str
sample: psql-pg-helloworld sample: psql-pg-helloworld
parameter_apply_status: parameter_apply_status:
description: Whether the parameter group has been applied description: Whether the parameter group has been applied
returned: always returned: always
type: string type: str
sample: in-sync sample: in-sync
db_security_groups: db_security_groups:
description: List of security groups used by the database instance description: List of security groups used by the database instance
@ -141,17 +141,17 @@ instances:
db_subnet_group_description: db_subnet_group_description:
description: Description of the DB subnet group description: Description of the DB subnet group
returned: always returned: always
type: string type: str
sample: My database subnet group sample: My database subnet group
db_subnet_group_name: db_subnet_group_name:
description: Name of the database subnet group description: Name of the database subnet group
returned: always returned: always
type: string type: str
sample: my-subnet-group sample: my-subnet-group
subnet_group_status: subnet_group_status:
description: Subnet group status description: Subnet group status
returned: always returned: always
type: string type: str
sample: Complete sample: Complete
subnets: subnets:
description: List of subnets in the subnet group description: List of subnets in the subnet group
@ -166,27 +166,27 @@ instances:
name: name:
description: Name of the availability zone description: Name of the availability zone
returned: always returned: always
type: string type: str
sample: us-west-2c sample: us-west-2c
subnet_identifier: subnet_identifier:
description: Subnet ID description: Subnet ID
returned: always returned: always
type: string type: str
sample: subnet-abcd1234 sample: subnet-abcd1234
subnet_status: subnet_status:
description: Subnet status description: Subnet status
returned: always returned: always
type: string type: str
sample: Active sample: Active
vpc_id: vpc_id:
description: VPC id of the subnet group description: VPC id of the subnet group
returned: always returned: always
type: string type: str
sample: vpc-abcd1234 sample: vpc-abcd1234
dbi_resource_id: dbi_resource_id:
description: AWS Region-unique, immutable identifier for the DB instance description: AWS Region-unique, immutable identifier for the DB instance
returned: always returned: always
type: string type: str
sample: db-AAAAAAAAAAAAAAAAAAAAAAAAAA sample: db-AAAAAAAAAAAAAAAAAAAAAAAAAA
domain_memberships: domain_memberships:
description: List of domain memberships description: List of domain memberships
@ -201,12 +201,12 @@ instances:
address: address:
description: Database endpoint address description: Database endpoint address
returned: always returned: always
type: string type: str
sample: helloworld-rds.ctrqpe3so1sf.us-west-2.rds.amazonaws.com sample: helloworld-rds.ctrqpe3so1sf.us-west-2.rds.amazonaws.com
hosted_zone_id: hosted_zone_id:
description: Route53 hosted zone ID description: Route53 hosted zone ID
returned: always returned: always
type: string type: str
sample: Z1PABCD0000000 sample: Z1PABCD0000000
port: port:
description: Database endpoint port description: Database endpoint port
@ -216,12 +216,12 @@ instances:
engine: engine:
description: Database engine description: Database engine
returned: always returned: always
type: string type: str
sample: postgres sample: postgres
engine_version: engine_version:
description: Database engine version description: Database engine version
returned: always returned: always
type: string type: str
sample: 9.5.10 sample: 9.5.10
iam_database_authentication_enabled: iam_database_authentication_enabled:
description: Whether database authentication through IAM is enabled description: Whether database authentication through IAM is enabled
@ -231,27 +231,27 @@ instances:
instance_create_time: instance_create_time:
description: Date and time the instance was created description: Date and time the instance was created
returned: always returned: always
type: string type: str
sample: '2017-10-10T04:00:07.434000+00:00' sample: '2017-10-10T04:00:07.434000+00:00'
kms_key_id: kms_key_id:
description: KMS Key ID description: KMS Key ID
returned: always returned: always
type: string type: str
sample: arn:aws:kms:us-west-2:111111111111:key/abcd1234-0000-abcd-1111-0123456789ab sample: arn:aws:kms:us-west-2:111111111111:key/abcd1234-0000-abcd-1111-0123456789ab
latest_restorable_time: latest_restorable_time:
description: Latest time to which a database can be restored with point-in-time restore description: Latest time to which a database can be restored with point-in-time restore
returned: always returned: always
type: string type: str
sample: '2018-05-17T00:03:56+00:00' sample: '2018-05-17T00:03:56+00:00'
license_model: license_model:
description: License model description: License model
returned: always returned: always
type: string type: str
sample: postgresql-license sample: postgresql-license
master_username: master_username:
description: Database master username description: Database master username
returned: always returned: always
type: string type: str
sample: dbadmin sample: dbadmin
monitoring_interval: monitoring_interval:
description: Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance description: Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance
@ -271,12 +271,12 @@ instances:
option_group_name: option_group_name:
description: Option group name description: Option group name
returned: always returned: always
type: string type: str
sample: default:postgres-9-5 sample: default:postgres-9-5
status: status:
description: Status of option group description: Status of option group
returned: always returned: always
type: string type: str
sample: in-sync sample: in-sync
pending_modified_values: pending_modified_values:
description: Modified values pending application description: Modified values pending application
@ -291,12 +291,12 @@ instances:
preferred_backup_window: preferred_backup_window:
description: Preferred backup window description: Preferred backup window
returned: always returned: always
type: string type: str
sample: 04:00-05:00 sample: 04:00-05:00
preferred_maintenance_window: preferred_maintenance_window:
description: Preferred maintenance window description: Preferred maintenance window
returned: always returned: always
type: string type: str
sample: mon:05:00-mon:05:30 sample: mon:05:00-mon:05:30
publicly_accessible: publicly_accessible:
description: Whether the DB is publicly accessible description: Whether the DB is publicly accessible
@ -316,7 +316,7 @@ instances:
storage_type: storage_type:
description: Storage type of the Database instance description: Storage type of the Database instance
returned: always returned: always
type: string type: str
sample: gp2 sample: gp2
tags: tags:
description: Tags used by the database instance description: Tags used by the database instance
@ -331,12 +331,12 @@ instances:
status: status:
description: Status of the VPC security group description: Status of the VPC security group
returned: always returned: always
type: string type: str
sample: active sample: active
vpc_security_group_id: vpc_security_group_id:
description: VPC Security Group ID description: VPC Security Group ID
returned: always returned: always
type: string type: str
sample: sg-abcd1234 sample: sg-abcd1234
''' '''

8
lib/ansible/modules/cloud/amazon/rds_param_group.py
View file

@ -97,19 +97,19 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
db_parameter_group_name: db_parameter_group_name:
description: Name of DB parameter group description: Name of DB parameter group
type: string type: str
returned: when state is present returned: when state is present
db_parameter_group_family: db_parameter_group_family:
description: DB parameter group family that this DB parameter group is compatible with. description: DB parameter group family that this DB parameter group is compatible with.
type: string type: str
returned: when state is present returned: when state is present
db_parameter_group_arn: db_parameter_group_arn:
description: ARN of the DB parameter group description: ARN of the DB parameter group
type: string type: str
returned: when state is present returned: when state is present
description: description:
description: description of the DB parameter group description: description of the DB parameter group
type: string type: str
returned: when state is present returned: when state is present
errors: errors:
description: list of errors from attempting to modify parameters that are not modifiable description: list of errors from attempting to modify parameters that are not modifiable

58
lib/ansible/modules/cloud/amazon/rds_snapshot_facts.py
View file

@ -78,22 +78,22 @@ snapshots:
availability_zone: availability_zone:
description: The availability zone of the database from which the snapshot was taken description: The availability zone of the database from which the snapshot was taken
returned: always returned: always
type: string type: str
sample: us-west-2b sample: us-west-2b
db_instance_identifier: db_instance_identifier:
description: Database instance identifier description: Database instance identifier
returned: always returned: always
type: string type: str
sample: hello-world-rds sample: hello-world-rds
db_snapshot_arn: db_snapshot_arn:
description: Snapshot ARN description: Snapshot ARN
returned: always returned: always
type: string type: str
sample: arn:aws:rds:us-west-2:111111111111:snapshot:rds:hello-world-rds-us1-2018-05-16-04-03 sample: arn:aws:rds:us-west-2:111111111111:snapshot:rds:hello-world-rds-us1-2018-05-16-04-03
db_snapshot_identifier: db_snapshot_identifier:
description: Snapshot name description: Snapshot name
returned: always returned: always
type: string type: str
sample: rds:hello-world-rds-us1-2018-05-16-04-03 sample: rds:hello-world-rds-us1-2018-05-16-04-03
encrypted: encrypted:
description: Whether the snapshot was encrypted description: Whether the snapshot was encrypted
@ -103,12 +103,12 @@ snapshots:
engine: engine:
description: Database engine description: Database engine
returned: always returned: always
type: string type: str
sample: postgres sample: postgres
engine_version: engine_version:
description: Database engine version description: Database engine version
returned: always returned: always
type: string type: str
sample: 9.5.10 sample: 9.5.10
iam_database_authentication_enabled: iam_database_authentication_enabled:
description: Whether database authentication through IAM is enabled description: Whether database authentication through IAM is enabled
@ -118,27 +118,27 @@ snapshots:
instance_create_time: instance_create_time:
description: Time the Instance was created description: Time the Instance was created
returned: always returned: always
type: string type: str
sample: '2017-10-10T04:00:07.434000+00:00' sample: '2017-10-10T04:00:07.434000+00:00'
kms_key_id: kms_key_id:
description: ID of the KMS Key encrypting the snapshot description: ID of the KMS Key encrypting the snapshot
returned: always returned: always
type: string type: str
sample: arn:aws:kms:us-west-2:111111111111:key/abcd1234-1234-aaaa-0000-1234567890ab sample: arn:aws:kms:us-west-2:111111111111:key/abcd1234-1234-aaaa-0000-1234567890ab
license_model: license_model:
description: License model description: License model
returned: always returned: always
type: string type: str
sample: postgresql-license sample: postgresql-license
master_username: master_username:
description: Database master username description: Database master username
returned: always returned: always
type: string type: str
sample: dbadmin sample: dbadmin
option_group_name: option_group_name:
description: Database option group name description: Database option group name
returned: always returned: always
type: string type: str
sample: default:postgres-9-5 sample: default:postgres-9-5
percent_progress: percent_progress:
description: Perecent progress of snapshot description: Perecent progress of snapshot
@ -148,22 +148,22 @@ snapshots:
snapshot_create_time: snapshot_create_time:
description: Time snapshot was created description: Time snapshot was created
returned: always returned: always
type: string type: str
sample: '2018-05-16T04:03:33.871000+00:00' sample: '2018-05-16T04:03:33.871000+00:00'
snapshot_type: snapshot_type:
description: Type of snapshot description: Type of snapshot
returned: always returned: always
type: string type: str
sample: automated sample: automated
status: status:
description: Status of snapshot description: Status of snapshot
returned: always returned: always
type: string type: str
sample: available sample: available
storage_type: storage_type:
description: Storage type of underlying DB description: Storage type of underlying DB
returned: always returned: always
type: string type: str
sample: gp2 sample: gp2
tags: tags:
description: Snapshot tags description: Snapshot tags
@ -173,7 +173,7 @@ snapshots:
vpc_id: vpc_id:
description: ID of VPC containing the DB description: ID of VPC containing the DB
returned: always returned: always
type: string type: str
sample: vpc-abcd1234 sample: vpc-abcd1234
cluster_snapshots: cluster_snapshots:
description: List of cluster snapshots description: List of cluster snapshots
@ -195,32 +195,32 @@ cluster_snapshots:
cluster_create_time: cluster_create_time:
description: Date and time the cluster was created description: Date and time the cluster was created
returned: always returned: always
type: string type: str
sample: '2018-05-17T00:13:40.223000+00:00' sample: '2018-05-17T00:13:40.223000+00:00'
db_cluster_identifier: db_cluster_identifier:
description: Database cluster identifier description: Database cluster identifier
returned: always returned: always
type: string type: str
sample: test-aurora-cluster sample: test-aurora-cluster
db_cluster_snapshot_arn: db_cluster_snapshot_arn:
description: ARN of the database snapshot description: ARN of the database snapshot
returned: always returned: always
type: string type: str
sample: arn:aws:rds:ca-central-1:111111111111:cluster-snapshot:test-aurora-snapshot sample: arn:aws:rds:ca-central-1:111111111111:cluster-snapshot:test-aurora-snapshot
db_cluster_snapshot_identifier: db_cluster_snapshot_identifier:
description: Snapshot identifier description: Snapshot identifier
returned: always returned: always
type: string type: str
sample: test-aurora-snapshot sample: test-aurora-snapshot
engine: engine:
description: Database engine description: Database engine
returned: always returned: always
type: string type: str
sample: aurora sample: aurora
engine_version: engine_version:
description: Database engine version description: Database engine version
returned: always returned: always
type: string type: str
sample: 5.6.10a sample: 5.6.10a
iam_database_authentication_enabled: iam_database_authentication_enabled:
description: Whether database authentication through IAM is enabled description: Whether database authentication through IAM is enabled
@ -230,17 +230,17 @@ cluster_snapshots:
kms_key_id: kms_key_id:
description: ID of the KMS Key encrypting the snapshot description: ID of the KMS Key encrypting the snapshot
returned: always returned: always
type: string type: str
sample: arn:aws:kms:ca-central-1:111111111111:key/abcd1234-abcd-1111-aaaa-0123456789ab sample: arn:aws:kms:ca-central-1:111111111111:key/abcd1234-abcd-1111-aaaa-0123456789ab
license_model: license_model:
description: License model description: License model
returned: always returned: always
type: string type: str
sample: aurora sample: aurora
master_username: master_username:
description: Database master username description: Database master username
returned: always returned: always
type: string type: str
sample: shertel sample: shertel
percent_progress: percent_progress:
description: Perecent progress of snapshot description: Perecent progress of snapshot
@ -255,17 +255,17 @@ cluster_snapshots:
snapshot_create_time: snapshot_create_time:
description: Date and time when the snapshot was created description: Date and time when the snapshot was created
returned: always returned: always
type: string type: str
sample: '2018-05-17T00:23:23.731000+00:00' sample: '2018-05-17T00:23:23.731000+00:00'
snapshot_type: snapshot_type:
description: Type of snapshot description: Type of snapshot
returned: always returned: always
type: string type: str
sample: manual sample: manual
status: status:
description: Status of snapshot description: Status of snapshot
returned: always returned: always
type: string type: str
sample: creating sample: creating
storage_encrypted: storage_encrypted:
description: Whether the snapshot is encrypted description: Whether the snapshot is encrypted
@ -280,7 +280,7 @@ cluster_snapshots:
vpc_id: vpc_id:
description: VPC of the database description: VPC of the database
returned: always returned: always
type: string type: str
sample: vpc-abcd1234 sample: vpc-abcd1234
''' '''

8
lib/ansible/modules/cloud/amazon/rds_subnet_group.py
View file

@ -66,15 +66,15 @@ subnet_group:
name: name:
description: The name of the DB subnet group description: The name of the DB subnet group
returned: I(state=present) returned: I(state=present)
type: string type: str
description: description:
description: The description of the DB subnet group description: The description of the DB subnet group
returned: I(state=present) returned: I(state=present)
type: string type: str
vpc_id: vpc_id:
description: The VpcId of the DB subnet group description: The VpcId of the DB subnet group
returned: I(state=present) returned: I(state=present)
type: string type: str
subnet_ids: subnet_ids:
description: Contains a list of Subnet IDs description: Contains a list of Subnet IDs
returned: I(state=present) returned: I(state=present)
@ -82,7 +82,7 @@ subnet_group:
status: status:
description: The status of the DB subnet group description: The status of the DB subnet group
returned: I(state=present) returned: I(state=present)
type: string type: str
''' '''
try: try:

16
lib/ansible/modules/cloud/amazon/redshift.py
View file

@ -163,7 +163,7 @@ cluster:
identifier: identifier:
description: Id of the cluster. description: Id of the cluster.
returned: success returned: success
type: string type: str
sample: "new_redshift_cluster" sample: "new_redshift_cluster"
create_time: create_time:
description: Time of the cluster creation as timestamp. description: Time of the cluster creation as timestamp.
@ -173,32 +173,32 @@ cluster:
status: status:
description: Stutus of the cluster. description: Stutus of the cluster.
returned: success returned: success
type: string type: str
sample: "available" sample: "available"
db_name: db_name:
description: Name of the database. description: Name of the database.
returned: success returned: success
type: string type: str
sample: "new_db_name" sample: "new_db_name"
availability_zone: availability_zone:
description: Amazon availability zone where the cluster is located. description: Amazon availability zone where the cluster is located.
returned: success returned: success
type: string type: str
sample: "us-east-1b" sample: "us-east-1b"
maintenance_window: maintenance_window:
description: Time frame when maintenance/upgrade are done. description: Time frame when maintenance/upgrade are done.
returned: success returned: success
type: string type: str
sample: "sun:09:30-sun:10:00" sample: "sun:09:30-sun:10:00"
private_ip_address: private_ip_address:
description: Private IP address of the main node. description: Private IP address of the main node.
returned: success returned: success
type: string type: str
sample: "10.10.10.10" sample: "10.10.10.10"
public_ip_address: public_ip_address:
description: Public IP address of the main node. description: Public IP address of the main node.
returned: success returned: success
type: string type: str
sample: "0.0.0.0" sample: "0.0.0.0"
port: port:
description: Port of the cluster. description: Port of the cluster.
@ -208,7 +208,7 @@ cluster:
url: url:
description: FQDN of the main cluster node. description: FQDN of the main cluster node.
returned: success returned: success
type: string type: str
sample: "new-redshift_cluster.jfkdjfdkj.us-east-1.redshift.amazonaws.com" sample: "new-redshift_cluster.jfkdjfdkj.us-east-1.redshift.amazonaws.com"
''' '''

40
lib/ansible/modules/cloud/amazon/redshift_facts.py
View file

@ -74,37 +74,37 @@ RETURN = '''
cluster_identifier: cluster_identifier:
description: Unique key to identify the cluster. description: Unique key to identify the cluster.
returned: success returned: success
type: string type: str
sample: "redshift-identifier" sample: "redshift-identifier"
node_type: node_type:
description: The node type for nodes in the cluster. description: The node type for nodes in the cluster.
returned: success returned: success
type: string type: str
sample: "ds2.xlarge" sample: "ds2.xlarge"
cluster_status: cluster_status:
description: Current state of the cluster. description: Current state of the cluster.
returned: success returned: success
type: string type: str
sample: "available" sample: "available"
modify_status: modify_status:
description: The status of a modify operation. description: The status of a modify operation.
returned: optional returned: optional
type: string type: str
sample: "" sample: ""
master_username: master_username:
description: The master user name for the cluster. description: The master user name for the cluster.
returned: success returned: success
type: string type: str
sample: "admin" sample: "admin"
db_name: db_name:
description: The name of the initial database that was created when the cluster was created. description: The name of the initial database that was created when the cluster was created.
returned: success returned: success
type: string type: str
sample: "dev" sample: "dev"
endpoint: endpoint:
description: The connection endpoint. description: The connection endpoint.
returned: success returned: success
type: string type: str
sample: { sample: {
"address": "cluster-ds2.ocmugla0rf.us-east-1.redshift.amazonaws.com", "address": "cluster-ds2.ocmugla0rf.us-east-1.redshift.amazonaws.com",
"port": 5439 "port": 5439
@ -112,7 +112,7 @@ endpoint:
cluster_create_time: cluster_create_time:
description: The date and time that the cluster was created. description: The date and time that the cluster was created.
returned: success returned: success
type: string type: str
sample: "2016-05-10T08:33:16.629000+00:00" sample: "2016-05-10T08:33:16.629000+00:00"
automated_snapshot_retention_period: automated_snapshot_retention_period:
description: The number of days that automatic cluster snapshots are retained. description: The number of days that automatic cluster snapshots are retained.
@ -157,22 +157,22 @@ cluster_paramater_groups:
cluster_subnet_group_name: cluster_subnet_group_name:
description: The name of the subnet group that is associated with the cluster. description: The name of the subnet group that is associated with the cluster.
returned: success returned: success
type: string type: str
sample: "redshift-subnet" sample: "redshift-subnet"
vpc_id: vpc_id:
description: The identifier of the VPC the cluster is in, if the cluster is in a VPC. description: The identifier of the VPC the cluster is in, if the cluster is in a VPC.
returned: success returned: success
type: string type: str
sample: "vpc-1234567" sample: "vpc-1234567"
availability_zone: availability_zone:
description: The name of the Availability Zone in which the cluster is located. description: The name of the Availability Zone in which the cluster is located.
returned: success returned: success
type: string type: str
sample: "us-east-1b" sample: "us-east-1b"
preferred_maintenance_window: preferred_maintenance_window:
description: The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur. description: The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
returned: success returned: success
type: string type: str
sample: "tue:07:30-tue:08:00" sample: "tue:07:30-tue:08:00"
pending_modified_values: pending_modified_values:
description: A value that, if present, indicates that changes to the cluster are pending. description: A value that, if present, indicates that changes to the cluster are pending.
@ -182,14 +182,14 @@ pending_modified_values:
cluster_version: cluster_version:
description: The version ID of the Amazon Redshift engine that is running on the cluster. description: The version ID of the Amazon Redshift engine that is running on the cluster.
returned: success returned: success
type: string type: str
sample: "1.0" sample: "1.0"
allow_version_upgrade: allow_version_upgrade:
description: > description: >
A Boolean value that, if true, indicates that major version upgrades will be applied A Boolean value that, if true, indicates that major version upgrades will be applied
automatically to the cluster during the maintenance window. automatically to the cluster during the maintenance window.
returned: success returned: success
type: boolean type: bool
sample: true|false sample: true|false
number_of_nodes: number_of_nodes:
description: The number of compute nodes in the cluster. description: The number of compute nodes in the cluster.
@ -199,12 +199,12 @@ number_of_nodes:
publicly_accessible: publicly_accessible:
description: A Boolean value that, if true , indicates that the cluster can be accessed from a public network. description: A Boolean value that, if true , indicates that the cluster can be accessed from a public network.
returned: success returned: success
type: boolean type: bool
sample: true|false sample: true|false
encrypted: encrypted:
description: Boolean value that, if true , indicates that data in the cluster is encrypted at rest. description: Boolean value that, if true , indicates that data in the cluster is encrypted at rest.
returned: success returned: success
type: boolean type: bool
sample: true|false sample: true|false
restore_status: restore_status:
description: A value that describes the status of a cluster restore action. description: A value that describes the status of a cluster restore action.
@ -226,7 +226,7 @@ cluster_snapshot_copy_status:
cluster_public_keys: cluster_public_keys:
description: The public key for the cluster. description: The public key for the cluster.
returned: success returned: success
type: string type: str
sample: "ssh-rsa anjigfam Amazon-Redshift\n" sample: "ssh-rsa anjigfam Amazon-Redshift\n"
cluster_nodes: cluster_nodes:
description: The nodes in the cluster. description: The nodes in the cluster.
@ -252,7 +252,7 @@ elastic_ip_status:
cluster_revision_number: cluster_revision_number:
description: The specific revision number of the database in the cluster. description: The specific revision number of the database in the cluster.
returned: success returned: success
type: string type: str
sample: "1231" sample: "1231"
tags: tags:
description: The list of tags for the cluster. description: The list of tags for the cluster.
@ -262,12 +262,12 @@ tags:
kms_key_id: kms_key_id:
description: The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster. description: The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.
returned: success returned: success
type: string type: str
sample: "" sample: ""
enhanced_vpc_routing: enhanced_vpc_routing:
description: An option that specifies whether to create the cluster with enhanced VPC routing enabled. description: An option that specifies whether to create the cluster with enhanced VPC routing enabled.
returned: success returned: success
type: boolean type: bool
sample: true|false sample: true|false
iam_roles: iam_roles:
description: List of IAM roles attached to the cluster. description: List of IAM roles attached to the cluster.

4
lib/ansible/modules/cloud/amazon/redshift_subnet_group.py
View file

@ -72,12 +72,12 @@ group:
name: name:
description: name of the Redshift subnet group description: name of the Redshift subnet group
returned: success returned: success
type: string type: str
sample: "redshift_subnet_group_name" sample: "redshift_subnet_group_name"
vpc_id: vpc_id:
description: Id of the VPC where the subnet is located description: Id of the VPC where the subnet is located
returned: success returned: success
type: string type: str
sample: "vpc-aabb1122" sample: "vpc-aabb1122"
''' '''

Some files were not shown because too many files have changed in this diff Show more