Trail (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudtrail.model.Trail

All Implemented Interfaces:

Serializable, Cloneable
```
public class Trail
extends Object
implements Serializable, Cloneable
```
The settings for a trail.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

Trail()

Constructors
Constructor and Description
`Trail()`

Method Summary

Methods
Modifier and Type	Method and Description
`Trail`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCloudWatchLogsLogGroupArn()` Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
`String`	`getCloudWatchLogsRoleArn()` Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
`String`	`getHomeRegion()` The region in which the trail was created.
`Boolean`	`getIncludeGlobalServiceEvents()` Set to True to include AWS API calls from AWS global services such as IAM.
`Boolean`	`getIsMultiRegionTrail()` Specifies whether the trail belongs only to one region or exists in all regions.
`String`	`getKmsKeyId()` Specifies the KMS key ID that encrypts the logs delivered by CloudTrail.
`Boolean`	`getLogFileValidationEnabled()` Specifies whether log file validation is enabled.
`String`	`getName()` Name of the trail set by calling CreateTrail.
`String`	`getS3BucketName()` Name of the Amazon S3 bucket into which CloudTrail delivers your trail files.
`String`	`getS3KeyPrefix()` Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery.
`String`	`getSnsTopicName()` Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered.
`String`	`getTrailARN()` The Amazon Resource Name of the trail.
`int`	`hashCode()`
`Boolean`	`isIncludeGlobalServiceEvents()` Set to True to include AWS API calls from AWS global services such as IAM.
`Boolean`	`isLogFileValidationEnabled()` Specifies whether log file validation is enabled.
`Boolean`	`isMultiRegionTrail()` Specifies whether the trail belongs only to one region or exists in all regions.
`void`	`setCloudWatchLogsLogGroupArn(String cloudWatchLogsLogGroupArn)` Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
`void`	`setCloudWatchLogsRoleArn(String cloudWatchLogsRoleArn)` Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
`void`	`setHomeRegion(String homeRegion)` The region in which the trail was created.
`void`	`setIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents)` Set to True to include AWS API calls from AWS global services such as IAM.
`void`	`setIsMultiRegionTrail(Boolean isMultiRegionTrail)` Specifies whether the trail belongs only to one region or exists in all regions.
`void`	`setKmsKeyId(String kmsKeyId)` Specifies the KMS key ID that encrypts the logs delivered by CloudTrail.
`void`	`setLogFileValidationEnabled(Boolean logFileValidationEnabled)` Specifies whether log file validation is enabled.
`void`	`setName(String name)` Name of the trail set by calling CreateTrail.
`void`	`setS3BucketName(String s3BucketName)` Name of the Amazon S3 bucket into which CloudTrail delivers your trail files.
`void`	`setS3KeyPrefix(String s3KeyPrefix)` Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery.
`void`	`setSnsTopicName(String snsTopicName)` Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered.
`void`	`setTrailARN(String trailARN)` The Amazon Resource Name of the trail.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Trail`	`withCloudWatchLogsLogGroupArn(String cloudWatchLogsLogGroupArn)` Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
`Trail`	`withCloudWatchLogsRoleArn(String cloudWatchLogsRoleArn)` Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
`Trail`	`withHomeRegion(String homeRegion)` The region in which the trail was created.
`Trail`	`withIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents)` Set to True to include AWS API calls from AWS global services such as IAM.
`Trail`	`withIsMultiRegionTrail(Boolean isMultiRegionTrail)` Specifies whether the trail belongs only to one region or exists in all regions.
`Trail`	`withKmsKeyId(String kmsKeyId)` Specifies the KMS key ID that encrypts the logs delivered by CloudTrail.
`Trail`	`withLogFileValidationEnabled(Boolean logFileValidationEnabled)` Specifies whether log file validation is enabled.
`Trail`	`withName(String name)` Name of the trail set by calling CreateTrail.
`Trail`	`withS3BucketName(String s3BucketName)` Name of the Amazon S3 bucket into which CloudTrail delivers your trail files.
`Trail`	`withS3KeyPrefix(String s3KeyPrefix)` Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery.
`Trail`	`withSnsTopicName(String snsTopicName)` Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered.
`Trail`	`withTrailARN(String trailARN)` The Amazon Resource Name of the trail.

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

- Constructor Detail
  - Trail
```
public Trail()
```
- Method Detail
  - setName
```
public void setName(String 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.
  - getName
```
public String getName()
```
    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.
  - withName
```
public Trail withName(String 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.
  - setS3BucketName
```
public void setS3BucketName(String 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.
  - getS3BucketName
```
public String getS3BucketName()
```
    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.
  - withS3BucketName
```
public Trail withS3BucketName(String 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.
  - setS3KeyPrefix
```
public void setS3KeyPrefix(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.
    
    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.
  - getS3KeyPrefix
```
public String getS3KeyPrefix()
```
    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.
  - withS3KeyPrefix
```
public Trail withS3KeyPrefix(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.
    
    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.
  - setSnsTopicName
```
public void setSnsTopicName(String snsTopicName)
```
    Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered. The maximum length is 256 characters.
    
    Parameters:
    snsTopicName - Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered. The maximum length is 256 characters.
  - getSnsTopicName
```
public String getSnsTopicName()
```
    Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered. The maximum length is 256 characters.
    
    Returns:
    Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered. The maximum length is 256 characters.
  - withSnsTopicName
```
public Trail withSnsTopicName(String snsTopicName)
```
    Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered. The maximum length is 256 characters.
    
    Parameters:
    snsTopicName - Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered. The maximum length is 256 characters.
    
    Returns:
    Returns a reference to this object so that method calls can be chained together.
  - setIncludeGlobalServiceEvents
```
public void setIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents)
```
    Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
    
    Parameters:
    includeGlobalServiceEvents - Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
  - getIncludeGlobalServiceEvents
```
public Boolean getIncludeGlobalServiceEvents()
```
    Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
    
    Returns:
    Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
  - withIncludeGlobalServiceEvents
```
public Trail withIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents)
```
    Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
    
    Parameters:
    includeGlobalServiceEvents - Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
    
    Returns:
    Returns a reference to this object so that method calls can be chained together.
  - isIncludeGlobalServiceEvents
```
public Boolean isIncludeGlobalServiceEvents()
```
    Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
    
    Returns:
    Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
  - setIsMultiRegionTrail
```
public void setIsMultiRegionTrail(Boolean isMultiRegionTrail)
```
    Specifies whether the trail belongs only to one region or exists in all regions.
    
    Parameters:
    isMultiRegionTrail - Specifies whether the trail belongs only to one region or exists in all regions.
  - getIsMultiRegionTrail
```
public Boolean getIsMultiRegionTrail()
```
    Specifies whether the trail belongs only to one region or exists in all regions.
    
    Returns:
    Specifies whether the trail belongs only to one region or exists in all regions.
  - withIsMultiRegionTrail
```
public Trail withIsMultiRegionTrail(Boolean isMultiRegionTrail)
```
    Specifies whether the trail belongs only to one region or exists in all regions.
    
    Parameters:
    isMultiRegionTrail - Specifies whether the trail belongs only to one region or exists in all regions.
    
    Returns:
    Returns a reference to this object so that method calls can be chained together.
  - isMultiRegionTrail
```
public Boolean isMultiRegionTrail()
```
    Specifies whether the trail belongs only to one region or exists in all regions.
    
    Returns:
    Specifies whether the trail belongs only to one region or exists in all regions.
  - setHomeRegion
```
public void setHomeRegion(String homeRegion)
```
    The region in which the trail was created.
    
    Parameters:
    homeRegion - The region in which the trail was created.
  - getHomeRegion
```
public String getHomeRegion()
```
    The region in which the trail was created.
    
    Returns:
    The region in which the trail was created.
  - withHomeRegion
```
public Trail withHomeRegion(String 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.
  - setTrailARN
```
public void setTrailARN(String trailARN)
```
    The Amazon Resource Name of the trail. The TrailARN format is arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail.
    
    Parameters:
    trailARN - The Amazon Resource Name of the trail. The TrailARN format is arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail .
  - getTrailARN
```
public String getTrailARN()
```
    The Amazon Resource Name of the trail. The TrailARN format is arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail.
    
    Returns:
    The Amazon Resource Name of the trail. The TrailARN format is arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail .
  - withTrailARN
```
public Trail withTrailARN(String trailARN)
```
    The Amazon Resource Name of the trail. The TrailARN format is arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail.
    
    Parameters:
    trailARN - The Amazon Resource Name of the trail. The TrailARN format is arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail .
    
    Returns:
    Returns a reference to this object so that method calls can be chained together.
  - setLogFileValidationEnabled
```
public void setLogFileValidationEnabled(Boolean logFileValidationEnabled)
```
    Specifies whether log file validation is enabled.
    
    Parameters:
    logFileValidationEnabled - Specifies whether log file validation is enabled.
  - getLogFileValidationEnabled
```
public Boolean getLogFileValidationEnabled()
```
    Specifies whether log file validation is enabled.
    
    Returns:
    Specifies whether log file validation is enabled.
  - withLogFileValidationEnabled
```
public Trail withLogFileValidationEnabled(Boolean 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.
  - isLogFileValidationEnabled
```
public Boolean isLogFileValidationEnabled()
```
    Specifies whether log file validation is enabled.
    
    Returns:
    Specifies whether log file validation is enabled.
  - setCloudWatchLogsLogGroupArn
```
public void setCloudWatchLogsLogGroupArn(String 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.
  - getCloudWatchLogsLogGroupArn
```
public String getCloudWatchLogsLogGroupArn()
```
    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.
  - withCloudWatchLogsLogGroupArn
```
public Trail withCloudWatchLogsLogGroupArn(String 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.
  - setCloudWatchLogsRoleArn
```
public void setCloudWatchLogsRoleArn(String 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.
  - getCloudWatchLogsRoleArn
```
public String getCloudWatchLogsRoleArn()
```
    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.
  - withCloudWatchLogsRoleArn
```
public Trail withCloudWatchLogsRoleArn(String 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.
  - setKmsKeyId
```
public void setKmsKeyId(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 format:
    arn:aws:kms:us-east-1: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 format:
    arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
  getKmsKeyId public String getKmsKeyId() 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 format: arn:aws:kms:us-east-1: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 format: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 withKmsKeyId public Trail withKmsKeyId(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 format: arn:aws:kms:us-east-1: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 format: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Returns: Returns a reference to this object so that method calls can be chained together. toString public String toString() Returns a string representation of this object; useful for testing and debugging. Overrides: toString in class Object Returns: A string representation of this object. See Also: Object.toString() equals public boolean equals(Object obj) Overrides: equals in class Object hashCode public int hashCode() Overrides: hashCode in class Object clone public Trail clone() Overrides: clone in class Object

Did this page help you?

Class Trail

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Trail

Method Detail

setName

getName

withName

setS3BucketName

getS3BucketName

withS3BucketName

setS3KeyPrefix

getS3KeyPrefix

withS3KeyPrefix

setSnsTopicName

getSnsTopicName

withSnsTopicName

setIncludeGlobalServiceEvents

getIncludeGlobalServiceEvents

withIncludeGlobalServiceEvents

isIncludeGlobalServiceEvents

setIsMultiRegionTrail

getIsMultiRegionTrail

withIsMultiRegionTrail

isMultiRegionTrail

setHomeRegion

getHomeRegion

withHomeRegion

setTrailARN

getTrailARN

withTrailARN

setLogFileValidationEnabled

getLogFileValidationEnabled

withLogFileValidationEnabled

isLogFileValidationEnabled

setCloudWatchLogsLogGroupArn

getCloudWatchLogsLogGroupArn

withCloudWatchLogsLogGroupArn

setCloudWatchLogsRoleArn

getCloudWatchLogsRoleArn

withCloudWatchLogsRoleArn

setKmsKeyId

getKmsKeyId

withKmsKeyId

toString

equals

hashCode

clone