Class CreateTrailResponse

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

Returns the objects or data listed below if successful. Otherwise, returns an error.

  • Method Details

    • name

      public final String name()

      Specifies the name of the trail.

      Returns:
      Specifies the name of the trail.

    • s3BucketName

      public final String s3BucketName()

      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.

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

      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.

    • 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 format of a topic ARN is:

      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 format of a topic ARN is:

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

    • 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 exists in one Region or in all Regions.

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

    • trailARN

      public final String trailARN()

      Specifies the ARN of the trail that was created. The format of a trail ARN is:

      arn:aws:cloudtrail:us-east-2: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-2:123456789012:trail/MyTrail

    • logFileValidationEnabled

      public final Boolean logFileValidationEnabled()

      Specifies whether log file integrity validation is enabled.

      Returns:
      Specifies whether log file integrity validation is enabled.

    • cloudWatchLogsLogGroupArn

      public final String cloudWatchLogsLogGroupArn()

      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.

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

    • isOrganizationTrail

      public final Boolean isOrganizationTrail()

      Specifies whether the trail is an organization trail.

      Returns:
      Specifies whether the trail is an organization trail.

    • toBuilder

      public CreateTrailResponse.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<CreateTrailResponse.Builder,CreateTrailResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static CreateTrailResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.