Class: Aws::CloudTrail::Types::Trail

Inherits:

Struct

• Object
• Struct
• Aws::CloudTrail::Types::Trail

Includes:

Structure

Defined in:

lib/aws-sdk-cloudtrail/types.rb

Overview

The settings for a trail.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cloud_watch_logs_log_group_arn ⇒ String

  Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.

• #cloud_watch_logs_role_arn ⇒ String

  Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

• #has_custom_event_selectors ⇒ Boolean

  Specifies if the trail has custom event selectors.

• #has_insight_selectors ⇒ Boolean

  Specifies whether a trail has insight types specified in an InsightSelector list.

• #home_region ⇒ String

  The Region in which the trail was created.

• #include_global_service_events ⇒ Boolean

  Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM.

• #is_multi_region_trail ⇒ Boolean

  Specifies whether the trail exists only in one Region or exists in all Regions.

• #is_organization_trail ⇒ Boolean

  Specifies whether the trail is an organization trail.

• #kms_key_id ⇒ String

  Specifies the KMS key ID that encrypts the logs and digest files delivered by CloudTrail.

• #log_file_validation_enabled ⇒ Boolean

  Specifies whether log file validation is enabled.

• #name ⇒ String

  Name of the trail set by calling CreateTrail.

• #recursive_logging ⇒ Boolean

  Specifies whether recursive logging is enabled for the trail.

• #s3_bucket_name ⇒ String

  Name of the Amazon S3 bucket into which CloudTrail delivers your trail files.

• #s3_key_prefix ⇒ String

  Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery.

• #sns_topic_arn ⇒ String

  Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.

• #sns_topic_name ⇒ String

  This field is no longer in use.

• #trail_arn ⇒ String

  Specifies the ARN of the trail.

Instance Attribute Details

#cloud_watch_logs_log_group_arn ⇒ String

Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.

# File 'lib/aws-sdk-cloudtrail/types.rb', line 5575

class Trail < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :home_region,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :has_custom_event_selectors,
  :has_insight_selectors,
  :is_organization_trail,
  :recursive_logging)
  SENSITIVE = []
  include Aws::Structure
end

#cloud_watch_logs_role_arn ⇒ String

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

# File 'lib/aws-sdk-cloudtrail/types.rb', line 5575

class Trail < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :home_region,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :has_custom_event_selectors,
  :has_insight_selectors,
  :is_organization_trail,
  :recursive_logging)
  SENSITIVE = []
  include Aws::Structure
end

#has_custom_event_selectors ⇒ Boolean

Specifies if the trail has custom event selectors.

# File 'lib/aws-sdk-cloudtrail/types.rb', line 5575

class Trail < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :home_region,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :has_custom_event_selectors,
  :has_insight_selectors,
  :is_organization_trail,
  :recursive_logging)
  SENSITIVE = []
  include Aws::Structure
end

#has_insight_selectors ⇒ Boolean

Specifies whether a trail has insight types specified in an InsightSelector list.

# File 'lib/aws-sdk-cloudtrail/types.rb', line 5575

class Trail < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :home_region,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :has_custom_event_selectors,
  :has_insight_selectors,
  :is_organization_trail,
  :recursive_logging)
  SENSITIVE = []
  include Aws::Structure
end

#home_region ⇒ String

The Region in which the trail was created.

# File 'lib/aws-sdk-cloudtrail/types.rb', line 5575

class Trail < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :home_region,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :has_custom_event_selectors,
  :has_insight_selectors,
  :is_organization_trail,
  :recursive_logging)
  SENSITIVE = []
  include Aws::Structure
end

#include_global_service_events ⇒ Boolean

Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM. Otherwise, False. Setting this value to true only delivers global service events to the trail if the trail is multi-Region or if the trail's home Region is the partition leader Region (for example, us-east-1).

# File 'lib/aws-sdk-cloudtrail/types.rb', line 5575

class Trail < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :home_region,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :has_custom_event_selectors,
  :has_insight_selectors,
  :is_organization_trail,
  :recursive_logging)
  SENSITIVE = []
  include Aws::Structure
end

#is_multi_region_trail ⇒ Boolean

Specifies whether the trail exists only in one Region or exists in all Regions.

# File 'lib/aws-sdk-cloudtrail/types.rb', line 5575

class Trail < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :home_region,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :has_custom_event_selectors,
  :has_insight_selectors,
  :is_organization_trail,
  :recursive_logging)
  SENSITIVE = []
  include Aws::Structure
end

#is_organization_trail ⇒ Boolean

Specifies whether the trail is an organization trail.

# File 'lib/aws-sdk-cloudtrail/types.rb', line 5575

class Trail < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :home_region,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :has_custom_event_selectors,
  :has_insight_selectors,
  :is_organization_trail,
  :recursive_logging)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

Specifies the KMS key ID that encrypts the logs and digest files delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.

arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

# File 'lib/aws-sdk-cloudtrail/types.rb', line 5575

class Trail < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :home_region,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :has_custom_event_selectors,
  :has_insight_selectors,
  :is_organization_trail,
  :recursive_logging)
  SENSITIVE = []
  include Aws::Structure
end

#log_file_validation_enabled ⇒ Boolean

Specifies whether log file validation is enabled.

# File 'lib/aws-sdk-cloudtrail/types.rb', line 5575

class Trail < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :home_region,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :has_custom_event_selectors,
  :has_insight_selectors,
  :is_organization_trail,
  :recursive_logging)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Name of the trail set by calling CreateTrail. The maximum length is 128 characters.

# File 'lib/aws-sdk-cloudtrail/types.rb', line 5575

class Trail < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :home_region,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :has_custom_event_selectors,
  :has_insight_selectors,
  :is_organization_trail,
  :recursive_logging)
  SENSITIVE = []
  include Aws::Structure
end

#recursive_logging ⇒ Boolean

Specifies whether recursive logging is enabled for the trail. If you set RecursiveLogging to false, CloudTrail suppresses events generated by CloudTrail when it delivers log files to your trail's destinations, including Amazon S3 and CloudWatch Logs. The default value is true.

# File 'lib/aws-sdk-cloudtrail/types.rb', line 5575

class Trail < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :home_region,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :has_custom_event_selectors,
  :has_insight_selectors,
  :is_organization_trail,
  :recursive_logging)
  SENSITIVE = []
  include Aws::Structure
end

#s3_bucket_name ⇒ String

Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket naming rules.

# File 'lib/aws-sdk-cloudtrail/types.rb', line 5575

class Trail < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :home_region,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :has_custom_event_selectors,
  :has_insight_selectors,
  :is_organization_trail,
  :recursive_logging)
  SENSITIVE = []
  include Aws::Structure
end

#s3_key_prefix ⇒ String

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.

# File 'lib/aws-sdk-cloudtrail/types.rb', line 5575

class Trail < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :home_region,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :has_custom_event_selectors,
  :has_insight_selectors,
  :is_organization_trail,
  :recursive_logging)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic_arn ⇒ String

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The following is the format of a topic ARN.

arn:aws:sns:us-east-2:123456789012:MyTopic

# File 'lib/aws-sdk-cloudtrail/types.rb', line 5575

class Trail < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :home_region,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :has_custom_event_selectors,
  :has_insight_selectors,
  :is_organization_trail,
  :recursive_logging)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic_name ⇒ String

This field is no longer in use. Use SnsTopicARN.

# File 'lib/aws-sdk-cloudtrail/types.rb', line 5575

class Trail < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :home_region,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :has_custom_event_selectors,
  :has_insight_selectors,
  :is_organization_trail,
  :recursive_logging)
  SENSITIVE = []
  include Aws::Structure
end

#trail_arn ⇒ String

Specifies the ARN of the trail. The following is the format of a trail ARN.

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

# File 'lib/aws-sdk-cloudtrail/types.rb', line 5575

class Trail < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :home_region,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :has_custom_event_selectors,
  :has_insight_selectors,
  :is_organization_trail,
  :recursive_logging)
  SENSITIVE = []
  include Aws::Structure
end