You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

The settings for a trail.

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_logs_log_group_arnString

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_arnString

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_selectorsBoolean

Specifies if the trail has custom event selectors.

Returns:

  • (Boolean)

    Specifies if the trail has custom event selectors.

#home_regionString

The region in which the trail was created.

Returns:

  • (String)

    The region in which the trail was created.

#include_global_service_eventsBoolean

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_trailBoolean

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

Returns:

  • (Boolean)

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

#kms_key_idString

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-1:123456789012:key/12345678-1234-1234-1234-123456789012

Returns:

  • (String)

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

#log_file_validation_enabledBoolean

Specifies whether log file validation is enabled.

Returns:

  • (Boolean)

    Specifies whether log file validation is enabled.

#nameString

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_nameString

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_prefixString

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_arnString

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-1: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_nameString

This field is deprecated. Use SnsTopicARN.

Returns:

  • (String)

    This field is deprecated.

#trail_arnString

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

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

Returns:

  • (String)

    Specifies the ARN of the trail.