com.amazonaws.services.cloudtrail.model

Class CreateTrailRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudtrail.model.CreateTrailRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CreateTrailRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the CreateTrail operation.

From the command line, use create-subscription .

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.

See Also:

AWSCloudTrail.createTrail(CreateTrailRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateTrailRequest()

Method Summary

Methods

Modifier and Type	Method and Description
CreateTrailRequest	clone()
boolean	equals(Object obj)
String	getCloudWatchLogsLogGroupArn() Specifies a log group name using 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.
Boolean	getIncludeGlobalServiceEvents() Specifies whether the trail is publishing events from global services such as IAM to the log files.
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 precedes the name of the bucket you have designated for log file delivery.
String	getSnsTopicName() Specifies the name of the Amazon SNS topic defined for notification of log file delivery.
int	hashCode()
Boolean	isIncludeGlobalServiceEvents() Specifies whether the trail is publishing events from global services such as IAM to the log files.
void	setCloudWatchLogsLogGroupArn(String cloudWatchLogsLogGroupArn) Specifies a log group name using 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	setIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents) Specifies whether the trail is publishing events from global services such as IAM to the log files.
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 precedes the name of the bucket you have designated for log file delivery.
void	setSnsTopicName(String snsTopicName) Specifies the name of the Amazon SNS topic defined for notification of log file delivery.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateTrailRequest	withCloudWatchLogsLogGroupArn(String cloudWatchLogsLogGroupArn) Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
CreateTrailRequest	withCloudWatchLogsRoleArn(String cloudWatchLogsRoleArn) Specifies the role for the CloudWatch Logs endpoint to assume to write to a user???s log group.
CreateTrailRequest	withIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents) Specifies whether the trail is publishing events from global services such as IAM to the log files.
CreateTrailRequest	withName(String name) Specifies the name of the trail.
CreateTrailRequest	withS3BucketName(String s3BucketName) Specifies the name of the Amazon S3 bucket designated for publishing log files.
CreateTrailRequest	withS3KeyPrefix(String s3KeyPrefix) Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.
CreateTrailRequest	withSnsTopicName(String snsTopicName) Specifies the name of the Amazon SNS topic defined for notification of log file delivery.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateTrailRequest

public CreateTrailRequest()

Method Detail

getName

public String getName()

Specifies the name of the trail.

Returns:

Specifies the name of the trail.

setName

public void setName(String name)

Specifies the name of the trail.

Parameters:

name - Specifies the name of the trail.

withName

public CreateTrailRequest withName(String name)

Specifies the name of the trail.

Returns a reference to this object so that method calls can be chained together.

Parameters:

name - Specifies the name of the trail.

Returns:

A reference to this updated object so that method calls can be chained together.

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.

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.

withS3BucketName

public CreateTrailRequest withS3BucketName(String s3BucketName)

Specifies the name of the Amazon S3 bucket designated for publishing log files.

Returns a reference to this object so that method calls can be chained together.

Parameters:

s3BucketName - Specifies the name of the Amazon S3 bucket designated for publishing log files.

Returns:

A reference to this updated object so that method calls can be chained together.

getS3KeyPrefix

public String getS3KeyPrefix()

Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.

Returns:

Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.

setS3KeyPrefix

public void setS3KeyPrefix(String s3KeyPrefix)

Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.

Parameters:

s3KeyPrefix - Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.

withS3KeyPrefix

public CreateTrailRequest withS3KeyPrefix(String s3KeyPrefix)

Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.

Returns a reference to this object so that method calls can be chained together.

Parameters:

s3KeyPrefix - Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.

Returns:

A reference to this updated object so that method calls can be chained together.

getSnsTopicName

public String getSnsTopicName()

Specifies the name of the Amazon SNS topic defined for notification of log file delivery.

Returns:

Specifies the name of the Amazon SNS topic defined for notification of log file delivery.

setSnsTopicName

public void setSnsTopicName(String snsTopicName)

Specifies the name of the Amazon SNS topic defined for notification of log file delivery.

Parameters:

snsTopicName - Specifies the name of the Amazon SNS topic defined for notification of log file delivery.

withSnsTopicName

public CreateTrailRequest withSnsTopicName(String snsTopicName)

Specifies the name of the Amazon SNS topic defined for notification of log file delivery.

Returns a reference to this object so that method calls can be chained together.

Parameters:

snsTopicName - Specifies the name of the Amazon SNS topic defined for notification of log file delivery.

Returns:

A reference to this updated 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.

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.

withIncludeGlobalServiceEvents

public CreateTrailRequest withIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents)

Specifies whether the trail is publishing events from global services such as IAM to the log files.

Returns a reference to this object so that method calls can be chained together.

Parameters:

includeGlobalServiceEvents - Specifies whether the trail is publishing events from global services such as IAM to the log files.

Returns:

A reference to this updated object so that method calls can be chained together.

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.

getCloudWatchLogsLogGroupArn

public String getCloudWatchLogsLogGroupArn()

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.

Returns:

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.

setCloudWatchLogsLogGroupArn

public void setCloudWatchLogsLogGroupArn(String cloudWatchLogsLogGroupArn)

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.

Parameters:

cloudWatchLogsLogGroupArn - Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.

withCloudWatchLogsLogGroupArn

public CreateTrailRequest withCloudWatchLogsLogGroupArn(String cloudWatchLogsLogGroupArn)

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.

Returns a reference to this object so that method calls can be chained together.

Parameters:

cloudWatchLogsLogGroupArn - Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.

Returns:

A reference to this updated object so that method calls can be chained together.

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.

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.

withCloudWatchLogsRoleArn

public CreateTrailRequest withCloudWatchLogsRoleArn(String cloudWatchLogsRoleArn)

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user???s log group.

Returns a reference to this object so that method calls can be chained together.

Parameters:

cloudWatchLogsRoleArn - Specifies the role for the CloudWatch Logs endpoint to assume to write to a user???s log group.

Returns:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public CreateTrailRequest clone()

Overrides:

clone in class AmazonWebServiceRequest