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

Class: Aws::SecurityHub::Types::AwsCloudTrailTrailDetails

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

Overview

Note:

When passing AwsCloudTrailTrailDetails as input to an Aws::Client method, you can use a vanilla Hash:

{
  cloud_watch_logs_log_group_arn: "NonEmptyString",
  cloud_watch_logs_role_arn: "NonEmptyString",
  has_custom_event_selectors: false,
  home_region: "NonEmptyString",
  include_global_service_events: false,
  is_multi_region_trail: false,
  is_organization_trail: false,
  kms_key_id: "NonEmptyString",
  log_file_validation_enabled: false,
  name: "NonEmptyString",
  s3_bucket_name: "NonEmptyString",
  s3_key_prefix: "NonEmptyString",
  sns_topic_arn: "NonEmptyString",
  sns_topic_name: "NonEmptyString",
  trail_arn: "NonEmptyString",
}

Provides details about a CloudTrail trail.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_logs_log_group_arn ⇒ String

The ARN of the log group that CloudTrail logs are delivered to.

Returns:

  • (String) —

    The ARN of the log group that CloudTrail logs are delivered to.

#cloud_watch_logs_role_arn ⇒ String

The ARN of the role that the CloudWatch Logs endpoint assumes when it writes to the log group.

Returns:

  • (String) —

    The ARN of the role that the CloudWatch Logs endpoint assumes when it writes to the log group.

#has_custom_event_selectors ⇒ Boolean

Indicates whether the trail has custom event selectors.

Returns:

  • (Boolean) —

    Indicates whether the trail has custom event selectors.

#home_region ⇒ String

The Region where the trail was created.

Returns:

  • (String) —

    The Region where the trail was created.

#include_global_service_events ⇒ Boolean

Indicates whether the trail publishes events from global services such as IAM to the log files.

Returns:

  • (Boolean) —

    Indicates whether the trail publishes events from global services such as IAM to the log files.

#is_multi_region_trail ⇒ Boolean

Indicates whether the trail applies only to the current Region or to all Regions.

Returns:

  • (Boolean) —

    Indicates whether the trail applies only to the current Region or to all Regions.

#is_organization_trail ⇒ Boolean

Whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account.

Returns:

  • (Boolean) —

    Whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account.

#kms_key_id ⇒ String

The AWS KMS key ID to use to encrypt the logs.

Returns:

  • (String) —

    The AWS KMS key ID to use to encrypt the logs.

#log_file_validation_enabled ⇒ Boolean

Indicates whether CloudTrail log file validation is enabled.

Returns:

  • (Boolean) —

    Indicates whether CloudTrail log file validation is enabled.

#name ⇒ String

The name of the trail.

Returns:

  • (String) —

    The name of the trail.

#s3_bucket_name ⇒ String

The name of the S3 bucket where the log files are published.

Returns:

  • (String) —

    The name of the S3 bucket where the log files are published.

#s3_key_prefix ⇒ String

The S3 key prefix. The key prefix is added after the name of the S3 bucket where the log files are published.

Returns:

  • (String) —

    The S3 key prefix.

#sns_topic_arn ⇒ String

The ARN of the SNS topic that is used for notifications of log file delivery.

Returns:

  • (String) —

    The ARN of the SNS topic that is used for notifications of log file delivery.

#sns_topic_name ⇒ String

The name of the SNS topic that is used for notifications of log file delivery.

Returns:

  • (String) —

    The name of the SNS topic that is used for notifications of log file delivery.

#trail_arn ⇒ String

The ARN of the trail.

Returns:

  • (String) —

    The ARN of the trail.