Class Trail

java.lang.Object
software.amazon.awssdk.services.cloudtrail.model.Trail
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Trail.Builder,Trail>
@Generated("software.amazon.awssdk:codegen") public final class Trail extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Trail.Builder,Trail>

The settings for a trail.

See Also:

  • Method Details

    • name

      public final String name()

      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.

    • s3BucketName

      public final String s3BucketName()

      Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket naming rules.

      Returns:
      Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket naming rules.

    • 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

      @Deprecated public final String snsTopicName()
      Deprecated.

      This field is no longer in use. Use SnsTopicARN.

      Returns:
      This field is no longer in use. Use SnsTopicARN.

    • snsTopicARN

      public final String snsTopicARN()

      Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The following is the format of a topic ARN.

      arn:aws:sns:us-east-2:123456789012:MyTopic

      Returns:
      Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The following is the format of a topic ARN.

      arn:aws:sns:us-east-2:123456789012:MyTopic

    • includeGlobalServiceEvents

      public final Boolean includeGlobalServiceEvents()

      Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM. Otherwise, False.

      Returns:
      Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM. Otherwise, False.

    • isMultiRegionTrail

      public final Boolean isMultiRegionTrail()

      Specifies whether the trail exists only in one Region or exists in all Regions.

      Returns:
      Specifies whether the trail exists only in one Region or exists in all Regions.

    • homeRegion

      public final String homeRegion()

      The Region in which the trail was created.

      Returns:
      The Region in which the trail was created.

    • trailARN

      public final String trailARN()

      Specifies the ARN of the trail. The following is the format of a trail ARN.

      arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

      Returns:
      Specifies the ARN of the trail. The following is the format of a trail ARN.

      arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

    • logFileValidationEnabled

      public final Boolean logFileValidationEnabled()

      Specifies whether log file validation is enabled.

      Returns:
      Specifies whether log file validation is enabled.

    • cloudWatchLogsLogGroupArn

      public final String cloudWatchLogsLogGroupArn()

      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.

    • cloudWatchLogsRoleArn

      public final String cloudWatchLogsRoleArn()

      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.

    • kmsKeyId

      public final 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 following format.

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

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

    • hasCustomEventSelectors

      public final Boolean hasCustomEventSelectors()

      Specifies if the trail has custom event selectors.

      Returns:
      Specifies if the trail has custom event selectors.

    • hasInsightSelectors

      public final Boolean hasInsightSelectors()

      Specifies whether a trail has insight types specified in an InsightSelector list.

      Returns:
      Specifies whether a trail has insight types specified in an InsightSelector list.

    • isOrganizationTrail

      public final Boolean isOrganizationTrail()

      Specifies whether the trail is an organization trail.

      Returns:
      Specifies whether the trail is an organization trail.

    • toBuilder

      public Trail.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<Trail.Builder,Trail>
      Returns:
      a builder for type T

    • builder

      public static Trail.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.