From 6a92d48b0f053617c42dd4c28e042b971b4259e0 Mon Sep 17 00:00:00 2001 From: Maykel Moya Date: Fri, 21 Mar 2014 08:35:25 +0100 Subject: [PATCH] ec2_group: Document group_desc rule param --- library/cloud/ec2_group | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/library/cloud/ec2_group b/library/cloud/ec2_group index e25185c5f1c..bf40e7b83b7 100644 --- a/library/cloud/ec2_group +++ b/library/cloud/ec2_group @@ -85,6 +85,11 @@ options: version_added: "1.6" requirements: [ "boto" ] + +notes: + - If a rule declares a group_name and that group doesn't exist, it will be + automatically created. In that case, group_desc should be provided as well. + The module will refuse to create a depended-on group without a description. ''' EXAMPLES = ''' @@ -121,7 +126,9 @@ EXAMPLES = ''' - proto: tcp from_port: 80 to_port: 80 - group_name: example + group_name: example-other + # description to use if example-other needs to be created + group_desc: other example EC2 group ''' try: