Class: Ansible::Ruby::Modules::Cloudtrail

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/cloud/amazon/cloudtrail.rb

Overview

Creates or deletes CloudTrail configuration. Ensures logging is also enabled.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#aws_access_key ⇒ Object?

Returns AWS access key. If not set then the value of the AWS_ACCESS_KEY environment variable is used.

Returns:

  • (Object, nil) —

    AWS access key. If not set then the value of the AWS_ACCESS_KEY environment variable is used.



33
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/amazon/cloudtrail.rb', line 33

attribute :aws_access_key

#aws_secret_key ⇒ Object?

Returns AWS secret key. If not set then the value of the AWS_SECRET_KEY environment variable is used.

Returns:

  • (Object, nil) —

    AWS secret key. If not set then the value of the AWS_SECRET_KEY environment variable is used.



30
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/amazon/cloudtrail.rb', line 30

attribute :aws_secret_key

#include_global_events ⇒ Boolean?

Returns record API calls from global services such as IAM and STS?.

Returns:

  • (Boolean, nil) —

    record API calls from global services such as IAM and STS?



26
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/amazon/cloudtrail.rb', line 26

attribute :include_global_events

#name ⇒ String?

Returns name for given CloudTrail configuration.,This is a primary key and is used to identify the configuration.

Returns:

  • (String, nil) —

    name for given CloudTrail configuration.,This is a primary key and is used to identify the configuration.



15
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/amazon/cloudtrail.rb', line 15

attribute :name

#region ⇒ String?

Returns The AWS region to use. If not specified then the value of the EC2_REGION environment variable, if any, is used.

Returns:

  • (String, nil) —

    The AWS region to use. If not specified then the value of the EC2_REGION environment variable, if any, is used.



36
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/amazon/cloudtrail.rb', line 36

attribute :region

#s3_bucket_prefix ⇒ Object?

Returns bucket to place CloudTrail in.,this bucket should exist and have the proper policy. See U(docs.aws.amazon.com/awscloudtrail/latest/userguide/aggregating_logs_regions_bucket_policy.html),required when state=enabled.

Returns:



19
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/amazon/cloudtrail.rb', line 19

attribute :s3_bucket_prefix

#s3_key_prefix ⇒ String?

Returns prefix to keys in bucket. A trailing slash is not necessary and will be removed.

Returns:

  • (String, nil) —

    prefix to keys in bucket. A trailing slash is not necessary and will be removed.



22
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/amazon/cloudtrail.rb', line 22

attribute :s3_key_prefix

#state ⇒ :enabled, :disabled

Returns add or remove CloudTrail configuration.

Returns:

  • (:enabled, :disabled) —

    add or remove CloudTrail configuration.



11
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/amazon/cloudtrail.rb', line 11

attribute :state