Class CreateTrailResult
- java.lang.Object
-
- com.amazonaws.services.cloudtrail.model.CreateTrailResult
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class CreateTrailResult extends Object implements Serializable, Cloneable
Returns the objects or data listed below if successful. Otherwise, returns an error.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description CreateTrailResult()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description CreateTrailResult
clone()
boolean
equals(Object obj)
String
getCloudWatchLogsLogGroupArn()
Specifies the Amazon Resource Name (ARN) of 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.Boolean
getIncludeGlobalServiceEvents()
Specifies whether the trail is publishing events from global services such as IAM to the log files.Boolean
getIsMultiRegionTrail()
Specifies whether the trail exists in one region or in all regions.String
getKmsKeyId()
Specifies the KMS key ID that encrypts the logs delivered by CloudTrail.Boolean
getLogFileValidationEnabled()
Specifies whether log file integrity validation is enabled.String
getName()
Specifies the name of the trail.String
getS3BucketName()
Specifies the name of the Amazon S3 bucket designated for publishing log 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
getSnsTopicARN()
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.String
getSnsTopicName()
Deprecated.String
getTrailARN()
Specifies the ARN of the trail that was created.int
hashCode()
Boolean
isIncludeGlobalServiceEvents()
Specifies whether the trail is publishing events from global services such as IAM to the log files.Boolean
isLogFileValidationEnabled()
Specifies whether log file integrity validation is enabled.Boolean
isMultiRegionTrail()
Specifies whether the trail exists in one region or in all regions.void
setCloudWatchLogsLogGroupArn(String cloudWatchLogsLogGroupArn)
Specifies the Amazon Resource Name (ARN) of 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
setIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents)
Specifies whether the trail is publishing events from global services such as IAM to the log files.void
setIsMultiRegionTrail(Boolean isMultiRegionTrail)
Specifies whether the trail exists in one region or 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 integrity validation is enabled.void
setName(String name)
Specifies the name of the trail.void
setS3BucketName(String s3BucketName)
Specifies the name of the Amazon S3 bucket designated for publishing log 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
setSnsTopicARN(String snsTopicARN)
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.void
setSnsTopicName(String snsTopicName)
Deprecated.void
setTrailARN(String trailARN)
Specifies the ARN of the trail that was created.String
toString()
Returns a string representation of this object; useful for testing and debugging.CreateTrailResult
withCloudWatchLogsLogGroupArn(String cloudWatchLogsLogGroupArn)
Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.CreateTrailResult
withCloudWatchLogsRoleArn(String cloudWatchLogsRoleArn)
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.CreateTrailResult
withIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents)
Specifies whether the trail is publishing events from global services such as IAM to the log files.CreateTrailResult
withIsMultiRegionTrail(Boolean isMultiRegionTrail)
Specifies whether the trail exists in one region or in all regions.CreateTrailResult
withKmsKeyId(String kmsKeyId)
Specifies the KMS key ID that encrypts the logs delivered by CloudTrail.CreateTrailResult
withLogFileValidationEnabled(Boolean logFileValidationEnabled)
Specifies whether log file integrity validation is enabled.CreateTrailResult
withName(String name)
Specifies the name of the trail.CreateTrailResult
withS3BucketName(String s3BucketName)
Specifies the name of the Amazon S3 bucket designated for publishing log files.CreateTrailResult
withS3KeyPrefix(String s3KeyPrefix)
Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery.CreateTrailResult
withSnsTopicARN(String snsTopicARN)
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.CreateTrailResult
withSnsTopicName(String snsTopicName)
Deprecated.CreateTrailResult
withTrailARN(String trailARN)
Specifies the ARN of the trail that was created.
-
-
-
Method Detail
-
setName
public void setName(String name)
Specifies the name of the trail.
- Parameters:
name
- Specifies the name of the trail.
-
getName
public String getName()
Specifies the name of the trail.
- Returns:
- Specifies the name of the trail.
-
withName
public CreateTrailResult withName(String name)
Specifies the name of the trail.
- Parameters:
name
- Specifies the name of the trail.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setS3BucketName
public void setS3BucketName(String s3BucketName)
Specifies the name of the Amazon S3 bucket designated for publishing log files.
- Parameters:
s3BucketName
- Specifies the name of the Amazon S3 bucket designated for publishing log files.
-
getS3BucketName
public String getS3BucketName()
Specifies the name of the Amazon S3 bucket designated for publishing log files.
- Returns:
- Specifies the name of the Amazon S3 bucket designated for publishing log files.
-
withS3BucketName
public CreateTrailResult withS3BucketName(String s3BucketName)
Specifies the name of the Amazon S3 bucket designated for publishing log files.
- Parameters:
s3BucketName
- Specifies the name of the Amazon S3 bucket designated for publishing log files.- 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.
- 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.
-
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.
- 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.
-
withS3KeyPrefix
public CreateTrailResult 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.
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSnsTopicName
@Deprecated public void setSnsTopicName(String snsTopicName)
Deprecated.Specifies the name of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.
- Parameters:
snsTopicName
- Specifies the name of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.
-
getSnsTopicName
@Deprecated public String getSnsTopicName()
Deprecated.Specifies the name of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.
- Returns:
- Specifies the name of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.
-
withSnsTopicName
@Deprecated public CreateTrailResult withSnsTopicName(String snsTopicName)
Deprecated.Specifies the name of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.
- Parameters:
snsTopicName
- Specifies the name of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSnsTopicARN
public void setSnsTopicARN(String snsTopicARN)
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:
arn:aws:sns:us-east-1:123456789012:MyTopic
- Parameters:
snsTopicARN
- Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:arn:aws:sns:us-east-1:123456789012:MyTopic
-
getSnsTopicARN
public String getSnsTopicARN()
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:
arn:aws:sns:us-east-1:123456789012:MyTopic
- Returns:
- Specifies the ARN of the Amazon SNS topic that CloudTrail uses to
send notifications when log files are delivered. The format of a
topic ARN is:
arn:aws:sns:us-east-1:123456789012:MyTopic
-
withSnsTopicARN
public CreateTrailResult withSnsTopicARN(String snsTopicARN)
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:
arn:aws:sns:us-east-1:123456789012:MyTopic
- Parameters:
snsTopicARN
- Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:arn:aws:sns:us-east-1:123456789012:MyTopic
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIncludeGlobalServiceEvents
public void setIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents)
Specifies whether the trail is publishing events from global services such as IAM to the log files.
- Parameters:
includeGlobalServiceEvents
- Specifies whether the trail is publishing events from global services such as IAM to the log files.
-
getIncludeGlobalServiceEvents
public Boolean getIncludeGlobalServiceEvents()
Specifies whether the trail is publishing events from global services such as IAM to the log files.
- Returns:
- Specifies whether the trail is publishing events from global services such as IAM to the log files.
-
withIncludeGlobalServiceEvents
public CreateTrailResult withIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents)
Specifies whether the trail is publishing events from global services such as IAM to the log files.
- Parameters:
includeGlobalServiceEvents
- Specifies whether the trail is publishing events from global services such as IAM to the log files.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isIncludeGlobalServiceEvents
public Boolean isIncludeGlobalServiceEvents()
Specifies whether the trail is publishing events from global services such as IAM to the log files.
- Returns:
- Specifies whether the trail is publishing events from global services such as IAM to the log files.
-
setIsMultiRegionTrail
public void setIsMultiRegionTrail(Boolean isMultiRegionTrail)
Specifies whether the trail exists in one region or in all regions.
- Parameters:
isMultiRegionTrail
- Specifies whether the trail exists in one region or in all regions.
-
getIsMultiRegionTrail
public Boolean getIsMultiRegionTrail()
Specifies whether the trail exists in one region or in all regions.
- Returns:
- Specifies whether the trail exists in one region or in all regions.
-
withIsMultiRegionTrail
public CreateTrailResult withIsMultiRegionTrail(Boolean isMultiRegionTrail)
Specifies whether the trail exists in one region or in all regions.
- Parameters:
isMultiRegionTrail
- Specifies whether the trail exists in one region or 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 exists in one region or in all regions.
- Returns:
- Specifies whether the trail exists in one region or in all regions.
-
setTrailARN
public void setTrailARN(String trailARN)
Specifies the ARN of the trail that was created. The format of a trail ARN is:
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
- Parameters:
trailARN
- Specifies the ARN of the trail that was created. The format of a trail ARN is:arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
-
getTrailARN
public String getTrailARN()
Specifies the ARN of the trail that was created. The format of a trail ARN is:
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
- Returns:
- Specifies the ARN of the trail that was created. The format of a
trail ARN is:
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
-
withTrailARN
public CreateTrailResult withTrailARN(String trailARN)
Specifies the ARN of the trail that was created. The format of a trail ARN is:
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
- Parameters:
trailARN
- Specifies the ARN of the trail that was created. The format of a trail ARN 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 integrity validation is enabled.
- Parameters:
logFileValidationEnabled
- Specifies whether log file integrity validation is enabled.
-
getLogFileValidationEnabled
public Boolean getLogFileValidationEnabled()
Specifies whether log file integrity validation is enabled.
- Returns:
- Specifies whether log file integrity validation is enabled.
-
withLogFileValidationEnabled
public CreateTrailResult withLogFileValidationEnabled(Boolean logFileValidationEnabled)
Specifies whether log file integrity validation is enabled.
- Parameters:
logFileValidationEnabled
- Specifies whether log file integrity 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 integrity validation is enabled.
- Returns:
- Specifies whether log file integrity validation is enabled.
-
setCloudWatchLogsLogGroupArn
public void setCloudWatchLogsLogGroupArn(String cloudWatchLogsLogGroupArn)
Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.
- Parameters:
cloudWatchLogsLogGroupArn
- Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.
-
getCloudWatchLogsLogGroupArn
public String getCloudWatchLogsLogGroupArn()
Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.
- Returns:
- Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.
-
withCloudWatchLogsLogGroupArn
public CreateTrailResult withCloudWatchLogsLogGroupArn(String cloudWatchLogsLogGroupArn)
Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.
- Parameters:
cloudWatchLogsLogGroupArn
- Specifies the Amazon Resource Name (ARN) of 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 CreateTrailResult 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 CreateTrailResult 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public CreateTrailResult clone()
-
-