public static interface UpdateTrailRequest.Builder extends CloudTrailRequest.Builder, CopyableBuilder<UpdateTrailRequest.Builder,UpdateTrailRequest>
Modifier and Type | Method and Description |
---|---|
UpdateTrailRequest.Builder |
cloudWatchLogsLogGroupArn(String cloudWatchLogsLogGroupArn)
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.
|
UpdateTrailRequest.Builder |
cloudWatchLogsRoleArn(String cloudWatchLogsRoleArn)
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
|
UpdateTrailRequest.Builder |
enableLogFileValidation(Boolean enableLogFileValidation)
Specifies whether log file validation is enabled.
|
UpdateTrailRequest.Builder |
includeGlobalServiceEvents(Boolean includeGlobalServiceEvents)
Specifies whether the trail is publishing events from global services such as IAM to the log files.
|
UpdateTrailRequest.Builder |
isMultiRegionTrail(Boolean isMultiRegionTrail)
Specifies whether the trail applies only to the current region or to all regions.
|
UpdateTrailRequest.Builder |
kmsKeyId(String kmsKeyId)
Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail.
|
UpdateTrailRequest.Builder |
name(String name)
Specifies the name of the trail or trail ARN.
|
UpdateTrailRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
UpdateTrailRequest.Builder |
s3BucketName(String s3BucketName)
Specifies the name of the Amazon S3 bucket designated for publishing log files.
|
UpdateTrailRequest.Builder |
s3KeyPrefix(String s3KeyPrefix)
Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file
delivery.
|
UpdateTrailRequest.Builder |
snsTopicName(String snsTopicName)
Specifies the name of the Amazon SNS topic defined for notification of log file delivery.
|
build
requestOverrideConfig, requestOverrideConfig
copy
apply, build
UpdateTrailRequest.Builder name(String name)
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
name
- 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
UpdateTrailRequest.Builder s3BucketName(String s3BucketName)
Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
s3BucketName
- Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.UpdateTrailRequest.Builder s3KeyPrefix(String s3KeyPrefix)
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.
s3KeyPrefix
- 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.UpdateTrailRequest.Builder snsTopicName(String snsTopicName)
Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
snsTopicName
- Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum
length is 256 characters.UpdateTrailRequest.Builder includeGlobalServiceEvents(Boolean includeGlobalServiceEvents)
Specifies whether the trail is publishing events from global services such as IAM to the log files.
includeGlobalServiceEvents
- Specifies whether the trail is publishing events from global services such as IAM to the log files.UpdateTrailRequest.Builder isMultiRegionTrail(Boolean isMultiRegionTrail)
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.
isMultiRegionTrail
- 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.UpdateTrailRequest.Builder enableLogFileValidation(Boolean enableLogFileValidation)
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.
enableLogFileValidation
- 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.
UpdateTrailRequest.Builder cloudWatchLogsLogGroupArn(String cloudWatchLogsLogGroupArn)
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.
cloudWatchLogsLogGroupArn
- 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.UpdateTrailRequest.Builder cloudWatchLogsRoleArn(String cloudWatchLogsRoleArn)
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
cloudWatchLogsRoleArn
- Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.UpdateTrailRequest.Builder kmsKeyId(String kmsKeyId)
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
kmsKeyId
- 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
UpdateTrailRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.Builder
requestOverrideConfig
in interface AwsRequest.Builder
awsRequestOverrideConfig
- The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.