Interface Trail.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Trail.Builder,
,Trail> SdkBuilder<Trail.Builder,
,Trail> SdkPojo
- Enclosing class:
Trail
-
Method Summary
Modifier and TypeMethodDescriptioncloudWatchLogsLogGroupArn
(String cloudWatchLogsLogGroupArn) Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.cloudWatchLogsRoleArn
(String cloudWatchLogsRoleArn) Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.hasCustomEventSelectors
(Boolean hasCustomEventSelectors) Specifies if the trail has custom event selectors.hasInsightSelectors
(Boolean hasInsightSelectors) Specifies whether a trail has insight types specified in anInsightSelector
list.homeRegion
(String homeRegion) The Region in which the trail was created.includeGlobalServiceEvents
(Boolean includeGlobalServiceEvents) Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM.isMultiRegionTrail
(Boolean isMultiRegionTrail) Specifies whether the trail exists only in one Region or exists in all Regions.isOrganizationTrail
(Boolean isOrganizationTrail) Specifies whether the trail is an organization trail.Specifies the KMS key ID that encrypts the logs delivered by CloudTrail.logFileValidationEnabled
(Boolean logFileValidationEnabled) Specifies whether log file validation is enabled.Name of the trail set by calling CreateTrail.s3BucketName
(String s3BucketName) Name of the Amazon S3 bucket into which CloudTrail delivers your trail files.s3KeyPrefix
(String s3KeyPrefix) Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery.snsTopicARN
(String snsTopicARN) Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.snsTopicName
(String snsTopicName) Deprecated.Specifies the ARN of the trail.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
name
Name of the trail set by calling CreateTrail. The maximum length is 128 characters.
- Parameters:
name
- Name of the trail set by calling CreateTrail. The maximum length is 128 characters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
s3BucketName
Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.
- Parameters:
s3BucketName
- Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snsTopicName
Deprecated.This field is no longer in use. Use
SnsTopicARN
.- Parameters:
snsTopicName
- This field is no longer in use. UseSnsTopicARN
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snsTopicARN
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The following is the format of a topic ARN.
arn:aws:sns:us-east-2:123456789012:MyTopic
- Parameters:
snsTopicARN
- Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The following is the format of a topic ARN.arn:aws:sns:us-east-2:123456789012:MyTopic
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
includeGlobalServiceEvents
Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM. Otherwise, False.
- Parameters:
includeGlobalServiceEvents
- Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM. Otherwise, False.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isMultiRegionTrail
Specifies whether the trail exists only in one Region or exists in all Regions.
- Parameters:
isMultiRegionTrail
- Specifies whether the trail exists only in one Region or exists in all Regions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
homeRegion
The Region in which the trail was created.
- Parameters:
homeRegion
- The Region in which the trail was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
trailARN
Specifies the ARN of the trail. The following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
- Parameters:
trailARN
- Specifies the ARN of the trail. The following is the format of a trail ARN.arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logFileValidationEnabled
Specifies whether log file validation is enabled.
- Parameters:
logFileValidationEnabled
- Specifies whether log file validation is enabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cloudWatchLogsLogGroupArn
Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
- Parameters:
cloudWatchLogsLogGroupArn
- Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cloudWatchLogsRoleArn
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
- Parameters:
cloudWatchLogsRoleArn
- Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKeyId
Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
- Parameters:
kmsKeyId
- Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hasCustomEventSelectors
Specifies if the trail has custom event selectors.
- Parameters:
hasCustomEventSelectors
- Specifies if the trail has custom event selectors.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hasInsightSelectors
Specifies whether a trail has insight types specified in an
InsightSelector
list.- Parameters:
hasInsightSelectors
- Specifies whether a trail has insight types specified in anInsightSelector
list.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isOrganizationTrail
Specifies whether the trail is an organization trail.
- Parameters:
isOrganizationTrail
- Specifies whether the trail is an organization trail.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-