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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb

Overview

Note:

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

Instance Attribute Details

#cloud_watch_logs_log_group_arnString

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

Returns:

  • (String)


2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2952

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_arnString

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

Returns:

  • (String)


2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2952

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_selectorsBoolean

Indicates whether the trail has custom event selectors.

Returns:

  • (Boolean)


2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2952

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_regionString

The Region where the trail was created.

Returns:

  • (String)


2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2952

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_eventsBoolean

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

Returns:

  • (Boolean)


2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2952

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_trailBoolean

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

Returns:

  • (Boolean)


2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2952

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_trailBoolean

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

Returns:

  • (Boolean)


2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2952

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_idString

The KMS key ID to use to encrypt the logs.

Returns:

  • (String)


2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2952

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_enabledBoolean

Indicates whether CloudTrail log file validation is enabled.

Returns:

  • (Boolean)


2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2952

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

#nameString

The name of the trail.

Returns:

  • (String)


2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2952

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_nameString

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

Returns:

  • (String)


2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2952

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_prefixString

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

Returns:

  • (String)


2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2952

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_arnString

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

Returns:

  • (String)


2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2952

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_nameString

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

Returns:

  • (String)


2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2952

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_arnString

The ARN of the trail.

Returns:

  • (String)


2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2952

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