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

Inherits:

Struct

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

show all

Includes:: Structure

Defined in:: lib/aws-sdk-cloudtrail/types.rb

Overview

The settings for a trail.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

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

Returns:

(String)

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

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

Returns:

(String)

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

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)
  SENSITIVE = []
  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 4887

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)
  SENSITIVE = []
  include Aws::Structure
end

#has_insight_selectors ⇒ `Boolean`

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

Returns:

(Boolean)

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

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)
  SENSITIVE = []
  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 4887

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

Returns:

(Boolean)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#is_multi_region_trail ⇒ `Boolean`

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

Returns:

(Boolean)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#is_organization_trail ⇒ `Boolean`

Specifies whether the trail is an organization trail.

Returns:

(Boolean)

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

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)
  SENSITIVE = []
  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 following format.

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

Returns:

(String)

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

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)
  SENSITIVE = []
  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 4887

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)
  SENSITIVE = []
  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 4887

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

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html

Returns:

(String)

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

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

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

Returns:

(String)

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

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

Returns:

(String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic_name ⇒ `String`

This field is no longer in use. Use ‘SnsTopicARN`.

Returns:

(String)

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

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

Returns:

(String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_logs_log_group_arn ⇒ String

#cloud_watch_logs_role_arn ⇒ String

#has_custom_event_selectors ⇒ Boolean

#has_insight_selectors ⇒ Boolean

#home_region ⇒ String

#include_global_service_events ⇒ Boolean

#is_multi_region_trail ⇒ Boolean

#is_organization_trail ⇒ Boolean

#kms_key_id ⇒ String

#log_file_validation_enabled ⇒ Boolean

#name ⇒ String

#s3_bucket_name ⇒ String

#s3_key_prefix ⇒ String

#sns_topic_arn ⇒ String

#sns_topic_name ⇒ String

#trail_arn ⇒ String

#cloud_watch_logs_log_group_arn ⇒ `String`

#cloud_watch_logs_role_arn ⇒ `String`

#has_custom_event_selectors ⇒ `Boolean`

#has_insight_selectors ⇒ `Boolean`

#home_region ⇒ `String`

#include_global_service_events ⇒ `Boolean`

#is_multi_region_trail ⇒ `Boolean`

#is_organization_trail ⇒ `Boolean`

#kms_key_id ⇒ `String`

#log_file_validation_enabled ⇒ `Boolean`

#name ⇒ `String`

#s3_bucket_name ⇒ `String`

#s3_key_prefix ⇒ `String`

#sns_topic_arn ⇒ `String`

#sns_topic_name ⇒ `String`

#trail_arn ⇒ `String`