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

Specifies the settings for each trail.

See Also:
  • Constructor Details

    • CreateTrailRequest

      public CreateTrailRequest()
  • Method Details

    • setName

      public void setName(String name)

      Specifies the name of the trail. The name must meet the following requirements:

      • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

      • Start with a letter or number, and end with a letter or number

      • Be between 3 and 128 characters

      • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.

      • Not be in IP address format (for example, 192.168.5.4)

      Parameters:
      name - Specifies the name of the trail. The name must meet the following requirements:

      • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

      • Start with a letter or number, and end with a letter or number

      • Be between 3 and 128 characters

      • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.

      • Not be in IP address format (for example, 192.168.5.4)

    • getName

      public String getName()

      Specifies the name of the trail. The name must meet the following requirements:

      • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

      • Start with a letter or number, and end with a letter or number

      • Be between 3 and 128 characters

      • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.

      • Not be in IP address format (for example, 192.168.5.4)

      Returns:
      Specifies the name of the trail. The name must meet the following requirements:

      • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

      • Start with a letter or number, and end with a letter or number

      • Be between 3 and 128 characters

      • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.

      • Not be in IP address format (for example, 192.168.5.4)

    • withName

      public CreateTrailRequest withName(String name)

      Specifies the name of the trail. The name must meet the following requirements:

      • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

      • Start with a letter or number, and end with a letter or number

      • Be between 3 and 128 characters

      • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.

      • Not be in IP address format (for example, 192.168.5.4)

      Parameters:
      name - Specifies the name of the trail. The name must meet the following requirements:

      • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

      • Start with a letter or number, and end with a letter or number

      • Be between 3 and 128 characters

      • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.

      • Not be in IP address format (for example, 192.168.5.4)

      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. See Amazon S3 Bucket Naming Requirements.

      Parameters:
      s3BucketName - Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
    • getS3BucketName

      public String getS3BucketName()

      Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

      Returns:
      Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
    • withS3BucketName

      public CreateTrailRequest withS3BucketName(String s3BucketName)

      Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

      Parameters:
      s3BucketName - Specifies the name of the Amazon S3 bucket designated for publishing log 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 CreateTrailRequest 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)

      Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

      Parameters:
      snsTopicName - Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
    • getSnsTopicName

      public String getSnsTopicName()

      Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

      Returns:
      Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
    • withSnsTopicName

      public CreateTrailRequest withSnsTopicName(String snsTopicName)

      Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

      Parameters:
      snsTopicName - Specifies the name of the Amazon SNS topic defined for notification of log file delivery. 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)

      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 CreateTrailRequest 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 is created in the current region or in all regions. The default is false.

      Parameters:
      isMultiRegionTrail - Specifies whether the trail is created in the current region or in all regions. The default is false.
    • getIsMultiRegionTrail

      public Boolean getIsMultiRegionTrail()

      Specifies whether the trail is created in the current region or in all regions. The default is false.

      Returns:
      Specifies whether the trail is created in the current region or in all regions. The default is false.
    • withIsMultiRegionTrail

      public CreateTrailRequest withIsMultiRegionTrail(Boolean isMultiRegionTrail)

      Specifies whether the trail is created in the current region or in all regions. The default is false.

      Parameters:
      isMultiRegionTrail - Specifies whether the trail is created in the current region or in all regions. The default is false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isMultiRegionTrail

      public Boolean isMultiRegionTrail()

      Specifies whether the trail is created in the current region or in all regions. The default is false.

      Returns:
      Specifies whether the trail is created in the current region or in all regions. The default is false.
    • setEnableLogFileValidation

      public void setEnableLogFileValidation(Boolean enableLogFileValidation)

      Specifies whether log file integrity validation is enabled. The default is false.

      When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

      Parameters:
      enableLogFileValidation - Specifies whether log file integrity validation is enabled. The default is false.

      When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

    • getEnableLogFileValidation

      public Boolean getEnableLogFileValidation()

      Specifies whether log file integrity validation is enabled. The default is false.

      When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

      Returns:
      Specifies whether log file integrity validation is enabled. The default is false.

      When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

    • withEnableLogFileValidation

      public CreateTrailRequest withEnableLogFileValidation(Boolean enableLogFileValidation)

      Specifies whether log file integrity validation is enabled. The default is false.

      When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

      Parameters:
      enableLogFileValidation - Specifies whether log file integrity validation is enabled. The default is false.

      When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

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

      public Boolean isEnableLogFileValidation()

      Specifies whether log file integrity validation is enabled. The default is false.

      When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

      Returns:
      Specifies whether log file integrity validation is enabled. The default is false.

      When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

    • 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.
    • 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.
    • 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.

      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:
      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 CreateTrailRequest 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 to use to encrypt the logs delivered by CloudTrail. The value can be a an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

      Examples:

      • alias/MyAliasName

      • arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

      • arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234- 123456789012

      • 12345678-1234-1234-1234-123456789012

      Parameters:
      kmsKeyId - Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be a an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

      Examples:

      • alias/MyAliasName

      • arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

      • arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234- 123456789012

      • 12345678-1234-1234-1234-123456789012

    • getKmsKeyId

      public String getKmsKeyId()

      Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be a an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

      Examples:

      • alias/MyAliasName

      • arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

      • arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234- 123456789012

      • 12345678-1234-1234-1234-123456789012

      Returns:
      Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be a an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

      Examples:

      • alias/MyAliasName

      • arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

      • arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234- 123456789012

      • 12345678-1234-1234-1234-123456789012

    • withKmsKeyId

      public CreateTrailRequest withKmsKeyId(String kmsKeyId)

      Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be a an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

      Examples:

      • alias/MyAliasName

      • arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

      • arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234- 123456789012

      • 12345678-1234-1234-1234-123456789012

      Parameters:
      kmsKeyId - Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be a an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

      Examples:

      • alias/MyAliasName

      • arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

      • arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234- 123456789012

      • 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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public CreateTrailRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: