Class: Aws::CloudTrail::Types::CreateTrailRequest

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

Overview

Specifies the settings for each trail.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_logs_log_group_arnString

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. You must use a log group that exists in your account.

Not required unless you specify CloudWatchLogsRoleArn.

Returns:

  • (String)


1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1449

class CreateTrailRequest < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :include_global_service_events,
  :is_multi_region_trail,
  :enable_log_file_validation,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail,
  :tags_list)
  SENSITIVE = []
  include Aws::Structure
end

#cloud_watch_logs_role_arnString

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. You must use a role that exists in your account.

Returns:

  • (String)


1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1449

class CreateTrailRequest < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :include_global_service_events,
  :is_multi_region_trail,
  :enable_log_file_validation,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail,
  :tags_list)
  SENSITIVE = []
  include Aws::Structure
end

#enable_log_file_validationBoolean

Specifies whether log file integrity validation is enabled. The default is false.

When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail does not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

Returns:

  • (Boolean)


1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1449

class CreateTrailRequest < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :include_global_service_events,
  :is_multi_region_trail,
  :enable_log_file_validation,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail,
  :tags_list)
  SENSITIVE = []
  include Aws::Structure
end

#include_global_service_eventsBoolean

Specifies whether the trail is publishing events from global services such as IAM to the log files.

Returns:

  • (Boolean)


1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1449

class CreateTrailRequest < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :include_global_service_events,
  :is_multi_region_trail,
  :enable_log_file_validation,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail,
  :tags_list)
  SENSITIVE = []
  include Aws::Structure
end

#is_multi_region_trailBoolean

Specifies whether the trail is created in the current Region or in all Regions. The default is false, which creates a trail only in the Region where you are signed in. As a best practice, consider creating trails that log events in all Regions.

Returns:

  • (Boolean)


1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1449

class CreateTrailRequest < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :include_global_service_events,
  :is_multi_region_trail,
  :enable_log_file_validation,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail,
  :tags_list)
  SENSITIVE = []
  include Aws::Structure
end

#is_organization_trailBoolean

Specifies whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false, and cannot be true unless the call is made on behalf of an Amazon Web Services account that is the management account or delegated administrator account for an organization in Organizations.

Returns:

  • (Boolean)


1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1449

class CreateTrailRequest < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :include_global_service_events,
  :is_multi_region_trail,
  :enable_log_file_validation,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail,
  :tags_list)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by alias/, a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

Examples:

  • alias/MyAliasName

  • arn:aws:kms:us-east-2:123456789012:alias/MyAliasName

  • arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

  • 12345678-1234-1234-1234-123456789012

Returns:

  • (String)


1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1449

class CreateTrailRequest < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :include_global_service_events,
  :is_multi_region_trail,
  :enable_log_file_validation,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail,
  :tags_list)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

Specifies the name of the trail. The name must meet the following requirements:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

  • Start with a letter or number, and end with a letter or number

  • Be between 3 and 128 characters

  • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are not valid.

  • Not be in IP address format (for example, 192.168.5.4)

Returns:

  • (String)


1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1449

class CreateTrailRequest < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :include_global_service_events,
  :is_multi_region_trail,
  :enable_log_file_validation,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail,
  :tags_list)
  SENSITIVE = []
  include Aws::Structure
end

#s3_bucket_nameString

Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

Returns:

  • (String)


1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1449

class CreateTrailRequest < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :include_global_service_events,
  :is_multi_region_trail,
  :enable_log_file_validation,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail,
  :tags_list)
  SENSITIVE = []
  include Aws::Structure
end

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


1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1449

class CreateTrailRequest < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :include_global_service_events,
  :is_multi_region_trail,
  :enable_log_file_validation,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail,
  :tags_list)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic_nameString

Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

Returns:

  • (String)


1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1449

class CreateTrailRequest < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :include_global_service_events,
  :is_multi_region_trail,
  :enable_log_file_validation,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail,
  :tags_list)
  SENSITIVE = []
  include Aws::Structure
end

#tags_listArray<Types::Tag>

A list of tags.

Returns:



1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1449

class CreateTrailRequest < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :include_global_service_events,
  :is_multi_region_trail,
  :enable_log_file_validation,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail,
  :tags_list)
  SENSITIVE = []
  include Aws::Structure
end