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

Class: Aws::CloudTrail::Types::UpdateTrailRequest

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

Overview

Note:

When making an API call, you may pass UpdateTrailRequest data as a hash:

{
  name: "String", # required
  s3_bucket_name: "String",
  s3_key_prefix: "String",
  sns_topic_name: "String",
  include_global_service_events: false,
  is_multi_region_trail: false,
  enable_log_file_validation: false,
  cloud_watch_logs_log_group_arn: "String",
  cloud_watch_logs_role_arn: "String",
  kms_key_id: "String",
}

Specifies settings to update for the trail.

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. Not required unless you specify CloudWatchLogsRoleArn.

Returns:

  • (String)


1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1480

class UpdateTrailRequest < 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)
  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.

Returns:

  • (String)


1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1480

class UpdateTrailRequest < 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)
  include Aws::Structure
end

#enable_log_file_validationBoolean

Specifies whether log file 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 will 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)


1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1480

class UpdateTrailRequest < 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)
  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)


1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1480

class UpdateTrailRequest < 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)
  include Aws::Structure
end

#is_multi_region_trailBoolean

Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted.

Returns:

  • (Boolean)


1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1480

class UpdateTrailRequest < 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)
  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.

Examples:

  • alias/MyAliasName

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

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

  • 12345678-1234-1234-1234-123456789012

Returns:

  • (String)


1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1480

class UpdateTrailRequest < 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)
  include Aws::Structure
end

#nameString

Specifies the name of the trail or trail ARN. If Name is a trail name, the string 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 invalid.

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

If Name is a trail ARN, it must be in the format:

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

Returns:

  • (String)


1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1480

class UpdateTrailRequest < 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)
  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)


1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1480

class UpdateTrailRequest < 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)
  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)


1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1480

class UpdateTrailRequest < 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)
  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)


1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1480

class UpdateTrailRequest < 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)
  include Aws::Structure
end