cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docfixes: spelling, width (#34301)

Browse source 
Remove examples from main section and make sure it is all in the examples. Should helpw ith the HTML breakage (it is too wide for most monitors).

tyop fixes too.
This commit is contained in:
Ted Timmons 2017-12-29 18:44:21 -08:00 committed by ansibot
parent a05ed65295
commit 32929f916a
1 changed files with 13 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -36,7 +36,7 @@ options:
name: name:
description: description:
- Name for the CloudTrail. - Name for the CloudTrail.
- Names are unique per-region unless the CloudTrail is a mulit-region trail, in which case it is unique per-account. - Names are unique per-region unless the CloudTrail is a multi-region trail, in which case it is unique per-account.
required: true required: true
enable_logging: enable_logging:
description: description:
@ -76,27 +76,20 @@ options:
version_added: "2.4" version_added: "2.4"
cloudwatch_logs_role_arn: cloudwatch_logs_role_arn:
description: description:
- Specifies a full ARN for an IAM role that assigns the proper permissions for CloudTrail to create and write to the log group listed below. - Specifies a full ARN for an IAM role that assigns the proper permissions for CloudTrail to create and write to the log group.
- See U(https://docs.aws.amazon.com/awscloudtrail/latest/userguide/send-cloudtrail-events-to-cloudwatch-logs.html) - See U(https://docs.aws.amazon.com/awscloudtrail/latest/userguide/send-cloudtrail-events-to-cloudwatch-logs.html)
- "Example arn:aws:iam::123456789012:role/CloudTrail_CloudWatchLogs_Role"
- Required when C(cloudwatch_logs_log_group_arn) - Required when C(cloudwatch_logs_log_group_arn)
version_added: "2.4" version_added: "2.4"
cloudwatch_logs_log_group_arn: cloudwatch_logs_log_group_arn:
description: description:
- A full ARN specifying a valid CloudWatch log group to which CloudTrail logs will be delivered. The log group should already exist. - A full ARN specifying a valid CloudWatch log group to which CloudTrail logs will be delivered. The log group should already exist.
- See U(https://docs.aws.amazon.com/awscloudtrail/latest/userguide/send-cloudtrail-events-to-cloudwatch-logs.html) - See U(https://docs.aws.amazon.com/awscloudtrail/latest/userguide/send-cloudtrail-events-to-cloudwatch-logs.html)
- "Example arn:aws:logs:us-east-1:123456789012:log-group:CloudTrail/DefaultLogGroup:*"
- Required when C(cloudwatch_logs_role_arn) - Required when C(cloudwatch_logs_role_arn)
version_added: "2.4" version_added: "2.4"
kms_key_id: kms_key_id:
description: description:
- Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. This also has the effect of enabling log file encryption. - Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. This also has the effect of enabling log file encryption.
- The value can be an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier. - The value can be an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.
- Examples
- alias/MyAliasName
- "arn:aws:kms:us-east-1:123456789012:alias/MyAliasName"
- "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012"
- 12345678-1234-1234-1234-123456789012
- See U(https://docs.aws.amazon.com/awscloudtrail/latest/userguide/encrypting-cloudtrail-log-files-with-aws-kms.html) - See U(https://docs.aws.amazon.com/awscloudtrail/latest/userguide/encrypting-cloudtrail-log-files-with-aws-kms.html)
version_added: "2.4" version_added: "2.4"
tags: tags:
@ -128,10 +121,21 @@ EXAMPLES = '''
region: us-east-1 region: us-east-1
is_multi_region_trail: true is_multi_region_trail: true
enable_log_file_validation: true enable_log_file_validation: true
cloudwatch_logs_role_arn: "arn:aws:iam::123456789012:role/CloudTrail_CloudWatchLogs_Role"
cloudwatch_logs_log_group_arn: "arn:aws:logs:us-east-1:123456789012:log-group:CloudTrail/DefaultLogGroup:*"
kms_key_id: "alias/MyAliasName"
tags: tags:
environment: dev environment: dev
Name: default Name: default
- name: show another valid kms_key_id
cloudtrail:
state: present
name: default
s3_bucket_name: mylogbucket
kms_key_id: "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012"
# simply "12345678-1234-1234-1234-123456789012" would be valid too.
- name: pause logging the trail we just created - name: pause logging the trail we just created
cloudtrail: cloudtrail:
state: present state: present