Class Trail
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Trail.Builder,
Trail>
The settings for a trail.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Trail.Builder
builder()
final String
Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.final String
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final Boolean
Specifies if the trail has custom event selectors.final int
hashCode()
final Boolean
Specifies whether a trail has insight types specified in anInsightSelector
list.final String
The Region in which the trail was created.final Boolean
Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM.final Boolean
Specifies whether the trail exists only in one Region or exists in all Regions.final Boolean
Specifies whether the trail is an organization trail.final String
kmsKeyId()
Specifies the KMS key ID that encrypts the logs delivered by CloudTrail.final Boolean
Specifies whether log file validation is enabled.final String
name()
Name of the trail set by calling CreateTrail.final String
Name of the Amazon S3 bucket into which CloudTrail delivers your trail files.final String
Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery.static Class
<? extends Trail.Builder> final String
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.final String
Deprecated.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
trailARN()
Specifies the ARN of the trail.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
Name of the trail set by calling CreateTrail. The maximum length is 128 characters.
- Returns:
- Name of the trail set by calling CreateTrail. The maximum length is 128 characters.
-
s3BucketName
Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.
- Returns:
- Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.
-
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:
- 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.
-
snsTopicName
Deprecated.This field is no longer in use. Use
SnsTopicARN
.- Returns:
- This field is no longer in use. Use
SnsTopicARN
.
-
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:
- 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
-
includeGlobalServiceEvents
Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM. Otherwise, False.
- Returns:
- Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM. Otherwise, False.
-
isMultiRegionTrail
Specifies whether the trail exists only in one Region or exists in all Regions.
- Returns:
- Specifies whether the trail exists only in one Region or exists in all Regions.
-
homeRegion
The Region in which the trail was created.
- Returns:
- The Region in which the trail was created.
-
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:
- Specifies the ARN of the trail. The following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
-
logFileValidationEnabled
Specifies whether log file validation is enabled.
- Returns:
- Specifies whether log file validation is enabled.
-
cloudWatchLogsLogGroupArn
Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
- Returns:
- Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
-
cloudWatchLogsRoleArn
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
- Returns:
- Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
-
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:
- 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
-
hasCustomEventSelectors
Specifies if the trail has custom event selectors.
- Returns:
- Specifies if the trail has custom event selectors.
-
hasInsightSelectors
Specifies whether a trail has insight types specified in an
InsightSelector
list.- Returns:
- Specifies whether a trail has insight types specified in an
InsightSelector
list.
-
isOrganizationTrail
Specifies whether the trail is an organization trail.
- Returns:
- Specifies whether the trail is an organization trail.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Trail.Builder,
Trail> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-