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

Inherits:

Struct

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

Defined in:

(unknown)

Overview

The settings for a trail.

Returned by:

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

• #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 AWS API calls from AWS 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) —

  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.

Returns:

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

Returns:

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

Returns:

• (Boolean) —

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

#home_region ⇒ String

The region in which the trail was created.

Returns:

• (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. Otherwise, False.

Returns:

• (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 exists only in one region or exists in all regions.

Returns:

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

Returns:

• (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. 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) —

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

#log_file_validation_enabled ⇒ Boolean

Specifies whether log file validation is enabled.

Returns:

• (Boolean) —

  Specifies whether log file validation is enabled.

#name ⇒ String

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

Returns:

• (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. See Amazon S3 Bucket Naming Requirements.

Returns:

• (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. For more information, see Finding Your CloudTrail Log Files.The maximum length is 200 characters.

Returns:

• (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. The format of a topic ARN is:

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

Returns:

• (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. Use SnsTopicARN.

Returns:

• (String) —

  This field is no longer in use.

#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) —

  Specifies the ARN of the trail.