Trail (AWS Java SDK :: Services :: AWS CloudTrail 2.19.24 API)

java.lang.Object
- software.amazon.awssdk.services.cloudtrail.model.Trail

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Trail.Builder,Trail>

@Generated(value="software.amazon.awssdk:codegen")
public final class Trail
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Trail.Builder,Trail>

The settings for a trail.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Trail.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Trail.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static Trail.Builder`	`builder()`
`String`	`cloudWatchLogsLogGroupArn()` Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
`String`	`cloudWatchLogsRoleArn()` Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`Boolean`	`hasCustomEventSelectors()` Specifies if the trail has custom event selectors.
`int`	`hashCode()`
`Boolean`	`hasInsightSelectors()` Specifies whether a trail has insight types specified in an `InsightSelector` list.
`String`	`homeRegion()` The region in which the trail was created.
`Boolean`	`includeGlobalServiceEvents()` Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM.
`Boolean`	`isMultiRegionTrail()` Specifies whether the trail exists only in one region or exists in all regions.
`Boolean`	`isOrganizationTrail()` Specifies whether the trail is an organization trail.
`String`	`kmsKeyId()` Specifies the KMS key ID that encrypts the logs delivered by CloudTrail.
`Boolean`	`logFileValidationEnabled()` Specifies whether log file validation is enabled.
`String`	`name()` Name of the trail set by calling CreateTrail.
`String`	`s3BucketName()` Name of the Amazon S3 bucket into which CloudTrail delivers your trail files.
`String`	`s3KeyPrefix()` Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Trail.Builder>`	`serializableBuilderClass()`
`String`	`snsTopicARN()` Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.
`String`	`snsTopicName()` Deprecated.
`Trail.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`trailARN()` Specifies the ARN of the trail.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public final String 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
```
public final String 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
```
public final 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.
    
    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
public final String snsTopicName()
```
    Deprecated.
    
    This field is no longer in use. Use SnsTopicARN.
    
    Returns:
    
    This field is no longer in use. Use SnsTopicARN.
  - snsTopicARN
```
public final String 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
```
public final Boolean 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
```
public final Boolean 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
```
public final String homeRegion()
```
    The region in which the trail was created.
    
    Returns:
    
    The region in which the trail was created.
  - trailARN
```
public final String 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
```
public final Boolean logFileValidationEnabled()
```
    Specifies whether log file validation is enabled.
    
    Returns:
    
    Specifies whether log file validation is enabled.
  - cloudWatchLogsLogGroupArn
```
public final String 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
```
public final String 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
```
public final String 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
```
public final Boolean hasCustomEventSelectors()
```
    Specifies if the trail has custom event selectors.
    
    Returns:
    
    Specifies if the trail has custom event selectors.
  - hasInsightSelectors
```
public final Boolean 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
```
public final Boolean isOrganizationTrail()
```
    Specifies whether the trail is an organization trail.
    
    Returns:
    
    Specifies whether the trail is an organization trail.
  - toBuilder
```
public Trail.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Trail.Builder,Trail>
  - builder
```
public static Trail.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Trail.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Trail

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

s3BucketName

s3KeyPrefix

snsTopicName

snsTopicARN

includeGlobalServiceEvents

isMultiRegionTrail

homeRegion

trailARN

logFileValidationEnabled

cloudWatchLogsLogGroupArn

cloudWatchLogsRoleArn

kmsKeyId

hasCustomEventSelectors

hasInsightSelectors

isOrganizationTrail

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields