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

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.

• #home_region ⇒ String

  The region in which the trail was created.

• #include_global_service_events ⇒ Boolean

  Set to True to include AWS API calls from AWS global services such as IAM.

• #is_multi_region_trail ⇒ Boolean

  Specifies whether the trail belongs only to one region or exists in all regions.

• #kms_key_id ⇒ String

  Specifies the KMS key ID that encrypts the logs 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.

• #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 deprecated.

• #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.

Returns:

• (String)

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

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)
  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.

Returns:

• (String)

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

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)
  include Aws::Structure
end

#has_custom_event_selectors ⇒ Boolean

Specifies if the trail has custom event selectors.

Returns:

• (Boolean)

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

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)
  include Aws::Structure
end

#home_region ⇒ String

The region in which the trail was created.

Returns:

• (String)

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

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)
  include Aws::Structure
end

#include_global_service_events ⇒ Boolean

Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.

Returns:

• (Boolean)

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

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)
  include Aws::Structure
end

#is_multi_region_trail ⇒ Boolean

Specifies whether the trail belongs only to one region or exists in all regions.

Returns:

• (Boolean)

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

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)
  include Aws::Structure
end

#kms_key_id ⇒ String

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

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

Returns:

• (String)

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

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)
  include Aws::Structure
end

#log_file_validation_enabled ⇒ Boolean

Specifies whether log file validation is enabled.

Returns:

• (Boolean)

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

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)
  include Aws::Structure
end

#name ⇒ String

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

Returns:

• (String)

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

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)
  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 Requirements].

[1]: docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html

Returns:

• (String)

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

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)
  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.

[1]: docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html

Returns:

• (String)

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

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)
  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 format of a topic ARN is:

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

Returns:

• (String)

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

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)
  include Aws::Structure
end

#sns_topic_name ⇒ String

This field is deprecated. Use SnsTopicARN.

Returns:

• (String)

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

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)
  include Aws::Structure
end

#trail_arn ⇒ String

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

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

Returns:

• (String)

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

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)
  include Aws::Structure
end