Class: Aws::SecurityHub::Types::AwsCloudTrailTrailDetails
- Inherits:
-
Struct
- Object
- Struct
- Aws::SecurityHub::Types::AwsCloudTrailTrailDetails
- Defined in:
- gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb
Overview
When making an API call, you may pass AwsCloudTrailTrailDetails data as a 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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#cloud_watch_logs_log_group_arn ⇒ 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.
-
#has_custom_event_selectors ⇒ Boolean
Indicates whether the trail has custom event selectors.
-
#home_region ⇒ 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.
-
#is_multi_region_trail ⇒ 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.
-
#kms_key_id ⇒ 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.
-
#name ⇒ String
The name of the trail.
-
#s3_bucket_name ⇒ String
The name of the S3 bucket where the log files are published.
-
#s3_key_prefix ⇒ String
The S3 key prefix.
-
#sns_topic_arn ⇒ 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.
-
#trail_arn ⇒ String
The ARN of the trail.
Instance Attribute Details
#cloud_watch_logs_log_group_arn ⇒ String
The ARN of the log group that CloudTrail logs are delivered to.
2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2495 class AwsCloudTrailTrailDetails < Struct.new( :cloud_watch_logs_log_group_arn, :cloud_watch_logs_role_arn, :has_custom_event_selectors, :home_region, :include_global_service_events, :is_multi_region_trail, :is_organization_trail, :kms_key_id, :log_file_validation_enabled, :name, :s3_bucket_name, :s3_key_prefix, :sns_topic_arn, :sns_topic_name, :trail_arn) SENSITIVE = [] include Aws::Structure end |
#cloud_watch_logs_role_arn ⇒ String
The ARN of the role that the CloudWatch Logs endpoint assumes when it writes to the log group.
2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2495 class AwsCloudTrailTrailDetails < Struct.new( :cloud_watch_logs_log_group_arn, :cloud_watch_logs_role_arn, :has_custom_event_selectors, :home_region, :include_global_service_events, :is_multi_region_trail, :is_organization_trail, :kms_key_id, :log_file_validation_enabled, :name, :s3_bucket_name, :s3_key_prefix, :sns_topic_arn, :sns_topic_name, :trail_arn) SENSITIVE = [] include Aws::Structure end |
#has_custom_event_selectors ⇒ Boolean
Indicates whether the trail has custom event selectors.
2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2495 class AwsCloudTrailTrailDetails < Struct.new( :cloud_watch_logs_log_group_arn, :cloud_watch_logs_role_arn, :has_custom_event_selectors, :home_region, :include_global_service_events, :is_multi_region_trail, :is_organization_trail, :kms_key_id, :log_file_validation_enabled, :name, :s3_bucket_name, :s3_key_prefix, :sns_topic_arn, :sns_topic_name, :trail_arn) SENSITIVE = [] include Aws::Structure end |
#home_region ⇒ String
The Region where the trail was created.
2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2495 class AwsCloudTrailTrailDetails < Struct.new( :cloud_watch_logs_log_group_arn, :cloud_watch_logs_role_arn, :has_custom_event_selectors, :home_region, :include_global_service_events, :is_multi_region_trail, :is_organization_trail, :kms_key_id, :log_file_validation_enabled, :name, :s3_bucket_name, :s3_key_prefix, :sns_topic_arn, :sns_topic_name, :trail_arn) SENSITIVE = [] include Aws::Structure end |
#include_global_service_events ⇒ Boolean
Indicates whether the trail publishes events from global services such as IAM to the log files.
2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2495 class AwsCloudTrailTrailDetails < Struct.new( :cloud_watch_logs_log_group_arn, :cloud_watch_logs_role_arn, :has_custom_event_selectors, :home_region, :include_global_service_events, :is_multi_region_trail, :is_organization_trail, :kms_key_id, :log_file_validation_enabled, :name, :s3_bucket_name, :s3_key_prefix, :sns_topic_arn, :sns_topic_name, :trail_arn) SENSITIVE = [] include Aws::Structure end |
#is_multi_region_trail ⇒ Boolean
Indicates whether the trail applies only to the current Region or to all Regions.
2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2495 class AwsCloudTrailTrailDetails < Struct.new( :cloud_watch_logs_log_group_arn, :cloud_watch_logs_role_arn, :has_custom_event_selectors, :home_region, :include_global_service_events, :is_multi_region_trail, :is_organization_trail, :kms_key_id, :log_file_validation_enabled, :name, :s3_bucket_name, :s3_key_prefix, :sns_topic_arn, :sns_topic_name, :trail_arn) SENSITIVE = [] include Aws::Structure end |
#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.
2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2495 class AwsCloudTrailTrailDetails < Struct.new( :cloud_watch_logs_log_group_arn, :cloud_watch_logs_role_arn, :has_custom_event_selectors, :home_region, :include_global_service_events, :is_multi_region_trail, :is_organization_trail, :kms_key_id, :log_file_validation_enabled, :name, :s3_bucket_name, :s3_key_prefix, :sns_topic_arn, :sns_topic_name, :trail_arn) SENSITIVE = [] include Aws::Structure end |
#kms_key_id ⇒ String
The AWS KMS key ID to use to encrypt the logs.
2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2495 class AwsCloudTrailTrailDetails < Struct.new( :cloud_watch_logs_log_group_arn, :cloud_watch_logs_role_arn, :has_custom_event_selectors, :home_region, :include_global_service_events, :is_multi_region_trail, :is_organization_trail, :kms_key_id, :log_file_validation_enabled, :name, :s3_bucket_name, :s3_key_prefix, :sns_topic_arn, :sns_topic_name, :trail_arn) SENSITIVE = [] include Aws::Structure end |
#log_file_validation_enabled ⇒ Boolean
Indicates whether CloudTrail log file validation is enabled.
2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2495 class AwsCloudTrailTrailDetails < Struct.new( :cloud_watch_logs_log_group_arn, :cloud_watch_logs_role_arn, :has_custom_event_selectors, :home_region, :include_global_service_events, :is_multi_region_trail, :is_organization_trail, :kms_key_id, :log_file_validation_enabled, :name, :s3_bucket_name, :s3_key_prefix, :sns_topic_arn, :sns_topic_name, :trail_arn) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the trail.
2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2495 class AwsCloudTrailTrailDetails < Struct.new( :cloud_watch_logs_log_group_arn, :cloud_watch_logs_role_arn, :has_custom_event_selectors, :home_region, :include_global_service_events, :is_multi_region_trail, :is_organization_trail, :kms_key_id, :log_file_validation_enabled, :name, :s3_bucket_name, :s3_key_prefix, :sns_topic_arn, :sns_topic_name, :trail_arn) SENSITIVE = [] include Aws::Structure end |
#s3_bucket_name ⇒ String
The name of the S3 bucket where the log files are published.
2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2495 class AwsCloudTrailTrailDetails < Struct.new( :cloud_watch_logs_log_group_arn, :cloud_watch_logs_role_arn, :has_custom_event_selectors, :home_region, :include_global_service_events, :is_multi_region_trail, :is_organization_trail, :kms_key_id, :log_file_validation_enabled, :name, :s3_bucket_name, :s3_key_prefix, :sns_topic_arn, :sns_topic_name, :trail_arn) SENSITIVE = [] include Aws::Structure end |
#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.
2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2495 class AwsCloudTrailTrailDetails < Struct.new( :cloud_watch_logs_log_group_arn, :cloud_watch_logs_role_arn, :has_custom_event_selectors, :home_region, :include_global_service_events, :is_multi_region_trail, :is_organization_trail, :kms_key_id, :log_file_validation_enabled, :name, :s3_bucket_name, :s3_key_prefix, :sns_topic_arn, :sns_topic_name, :trail_arn) SENSITIVE = [] include Aws::Structure end |
#sns_topic_arn ⇒ String
The ARN of the SNS topic that is used for notifications of log file delivery.
2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2495 class AwsCloudTrailTrailDetails < Struct.new( :cloud_watch_logs_log_group_arn, :cloud_watch_logs_role_arn, :has_custom_event_selectors, :home_region, :include_global_service_events, :is_multi_region_trail, :is_organization_trail, :kms_key_id, :log_file_validation_enabled, :name, :s3_bucket_name, :s3_key_prefix, :sns_topic_arn, :sns_topic_name, :trail_arn) SENSITIVE = [] include Aws::Structure end |
#sns_topic_name ⇒ String
The name of the SNS topic that is used for notifications of log file delivery.
2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2495 class AwsCloudTrailTrailDetails < Struct.new( :cloud_watch_logs_log_group_arn, :cloud_watch_logs_role_arn, :has_custom_event_selectors, :home_region, :include_global_service_events, :is_multi_region_trail, :is_organization_trail, :kms_key_id, :log_file_validation_enabled, :name, :s3_bucket_name, :s3_key_prefix, :sns_topic_arn, :sns_topic_name, :trail_arn) SENSITIVE = [] include Aws::Structure end |
#trail_arn ⇒ String
The ARN of the trail.
2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2495 class AwsCloudTrailTrailDetails < Struct.new( :cloud_watch_logs_log_group_arn, :cloud_watch_logs_role_arn, :has_custom_event_selectors, :home_region, :include_global_service_events, :is_multi_region_trail, :is_organization_trail, :kms_key_id, :log_file_validation_enabled, :name, :s3_bucket_name, :s3_key_prefix, :sns_topic_arn, :sns_topic_name, :trail_arn) SENSITIVE = [] include Aws::Structure end |