Class S3ExportDestination

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

The Amazon S3 destination for an export, including the bucket, the Amazon Web Services KMS key used for encryption, and an optional object key prefix.

See Also:

  • Method Details

    • bucketArn

      public final String bucketArn()

      The Amazon Resource Name (ARN) of the Amazon S3 bucket that Security Hub writes the export to. You must own the bucket, and its bucket policy must grant the Security Hub service principal ( exportv2.securityhub.amazonaws.com) permission to write objects. For the required bucket policy, see the Examples section of StartExportJobV2.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon S3 bucket that Security Hub writes the export to. You must own the bucket, and its bucket policy must grant the Security Hub service principal ( exportv2.securityhub.amazonaws.com) permission to write objects. For the required bucket policy, see the Examples section of StartExportJobV2.

    • kmsKeyArn

      public final String kmsKeyArn()

      The ARN of the Amazon Web Services KMS key that Security Hub uses to encrypt the export objects with server-side encryption. The key policy must allow the Security Hub service principal ( exportv2.securityhub.amazonaws.com) to use the key through Amazon S3. For the required key policy, see the Examples section of StartExportJobV2.

      The key must meet all of the following requirements:

      • It must be a symmetric key with a key usage of ENCRYPT_DECRYPT.

      • It must be a single-Region key. Multi-Region keys, whose key IDs begin with mrk-, are rejected.

      • You must specify the full key ARN. Key IDs and aliases are rejected.

      • The key must be in the same Amazon Web Services account as the export job.

      • The key must be in the same Amazon Web Services Region as the export job.

      • The key must be in the aws, aws-cn, or aws-us-gov partition.

      Returns:
      The ARN of the Amazon Web Services KMS key that Security Hub uses to encrypt the export objects with server-side encryption. The key policy must allow the Security Hub service principal ( exportv2.securityhub.amazonaws.com) to use the key through Amazon S3. For the required key policy, see the Examples section of StartExportJobV2.

      The key must meet all of the following requirements:

      • It must be a symmetric key with a key usage of ENCRYPT_DECRYPT.

      • It must be a single-Region key. Multi-Region keys, whose key IDs begin with mrk-, are rejected.

      • You must specify the full key ARN. Key IDs and aliases are rejected.

      • The key must be in the same Amazon Web Services account as the export job.

      • The key must be in the same Amazon Web Services Region as the export job.

      • The key must be in the aws, aws-cn, or aws-us-gov partition.

    • objectPrefix

      public final String objectPrefix()

      An optional key prefix that Security Hub prepends to the Amazon S3 object keys of the export output. Use a prefix to organize exports within the bucket. The value can be up to 512 characters.

      Returns:
      An optional key prefix that Security Hub prepends to the Amazon S3 object keys of the export output. Use a prefix to organize exports within the bucket. The value can be up to 512 characters.

    • toBuilder

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

    • builder

      public static S3ExportDestination.Builder builder()

    • serializableBuilderClass

      public static Class<? extends S3ExportDestination.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.