Package software.amazon.awssdk.services.cloudtrail.model

Class CreateTrailRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cloudtrail.model.CloudTrailRequest
software.amazon.awssdk.services.cloudtrail.model.CreateTrailRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateTrailRequest.Builder,CreateTrailRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateTrailRequest extends CloudTrailRequest implements ToCopyableBuilder<CreateTrailRequest.Builder,CreateTrailRequest>

Specifies the settings for each trail.

  • Method Details

    • name

      public final 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 not valid.

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

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

    • s3BucketName

      public final String s3BucketName()

      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.

    • 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

      public final String snsTopicName()

      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.

    • includeGlobalServiceEvents

      public final Boolean includeGlobalServiceEvents()

      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.

    • isMultiRegionTrail

      public final Boolean isMultiRegionTrail()

      Specifies whether the trail is created in the current Region or in all Regions. The default is false, which creates a trail only in the Region where you are signed in. As a best practice, consider creating trails that log events in all Regions.

      Returns:
      Specifies whether the trail is created in the current Region or in all Regions. The default is false, which creates a trail only in the Region where you are signed in. As a best practice, consider creating trails that log events in all Regions.

    • enableLogFileValidation

      public final 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 does 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 does 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.

    • cloudWatchLogsLogGroupArn

      public final 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. You must use a log group that exists in your account.

      Not required unless you specify CloudWatchLogsRoleArn.

      Only the management account can configure a CloudWatch Logs log group for an organization trail.

      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. You must use a log group that exists in your account.

      Not required unless you specify CloudWatchLogsRoleArn.

      Only the management account can configure a CloudWatch Logs log group for an organization trail.

    • cloudWatchLogsRoleArn

      public final String cloudWatchLogsRoleArn()

      Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. You must use a role that exists in your account.

      Returns:
      Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. You must use a role that exists in your account.

    • kmsKeyId

      public final String kmsKeyId()

      Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be 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.

      CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

      Examples:

      • alias/MyAliasName

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

      • arn:aws:kms:us-east-2: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 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.

      CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

      Examples:

      • alias/MyAliasName

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

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

      • 12345678-1234-1234-1234-123456789012

    • isOrganizationTrail

      public final Boolean isOrganizationTrail()

      Specifies whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false, and cannot be true unless the call is made on behalf of an Amazon Web Services account that is the management account or delegated administrator account for an organization in Organizations.

      Returns:
      Specifies whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false, and cannot be true unless the call is made on behalf of an Amazon Web Services account that is the management account or delegated administrator account for an organization in Organizations.

    • hasTagsList

      public final boolean hasTagsList()
      For responses, this returns true if the service returned a value for the TagsList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tagsList

      public final List<Tag> tagsList()
      Returns the value of the TagsList property for this object.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagsList() method.

      Returns:
      The value of the TagsList property for this object.

    • toBuilder

      public CreateTrailRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateTrailRequest.Builder,CreateTrailRequest>
      Specified by:
      toBuilder in class CloudTrailRequest
      Returns:
      a builder for type T

    • builder

      public static CreateTrailRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateTrailRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.