Class S3Bucket

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

Provides information about the S3 bucket that a finding applies to. If a quota prevented Amazon Macie from retrieving and processing all the bucket's information prior to generating the finding, the following values are UNKNOWN or null: allowsUnencryptedObjectUploads, defaultServerSideEncryption, publicAccess, and tags.

See Also:

  • Method Details

    • allowsUnencryptedObjectUploads

      public final AllowsUnencryptedObjectUploads allowsUnencryptedObjectUploads()

      Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are added to the bucket. Possible values are:

      • FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include a valid server-side encryption header.

      • TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include a valid server-side encryption header.

      • UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.

      Valid server-side encryption headers are: x-amz-server-side-encryption with a value of AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm with a value of AES256.

      If the service returns an enum value that is not available in the current SDK version, allowsUnencryptedObjectUploads will return AllowsUnencryptedObjectUploads.UNKNOWN_TO_SDK_VERSION . The raw value returned by the service is available from allowsUnencryptedObjectUploadsAsString().

      Returns:
      Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are added to the bucket. Possible values are:

      • FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include a valid server-side encryption header.

      • TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include a valid server-side encryption header.

      • UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.

      Valid server-side encryption headers are: x-amz-server-side-encryption with a value of AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm with a value of AES256.

      See Also:

    • allowsUnencryptedObjectUploadsAsString

      public final String allowsUnencryptedObjectUploadsAsString()

      Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are added to the bucket. Possible values are:

      • FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include a valid server-side encryption header.

      • TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include a valid server-side encryption header.

      • UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.

      Valid server-side encryption headers are: x-amz-server-side-encryption with a value of AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm with a value of AES256.

      If the service returns an enum value that is not available in the current SDK version, allowsUnencryptedObjectUploads will return AllowsUnencryptedObjectUploads.UNKNOWN_TO_SDK_VERSION . The raw value returned by the service is available from allowsUnencryptedObjectUploadsAsString().

      Returns:
      Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are added to the bucket. Possible values are:

      • FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include a valid server-side encryption header.

      • TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include a valid server-side encryption header.

      • UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.

      Valid server-side encryption headers are: x-amz-server-side-encryption with a value of AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm with a value of AES256.

      See Also:

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the bucket.

      Returns:
      The Amazon Resource Name (ARN) of the bucket.

    • createdAt

      public final Instant createdAt()

      The date and time, in UTC and extended ISO 8601 format, when the bucket was created. This value can also indicate when changes such as edits to the bucket's policy were most recently made to the bucket, relative to when the finding was created or last updated.

      Returns:
      The date and time, in UTC and extended ISO 8601 format, when the bucket was created. This value can also indicate when changes such as edits to the bucket's policy were most recently made to the bucket, relative to when the finding was created or last updated.

    • defaultServerSideEncryption

      public final ServerSideEncryption defaultServerSideEncryption()

      The default server-side encryption settings for the bucket.

      Returns:
      The default server-side encryption settings for the bucket.

    • name

      public final String name()

      The name of the bucket.

      Returns:
      The name of the bucket.

    • owner

      public final S3BucketOwner owner()

      The display name and canonical user ID for the Amazon Web Services account that owns the bucket.

      Returns:
      The display name and canonical user ID for the Amazon Web Services account that owns the bucket.

    • publicAccess

      public final BucketPublicAccess publicAccess()

      The permissions settings that determine whether the bucket is publicly accessible.

      Returns:
      The permissions settings that determine whether the bucket is publicly accessible.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<KeyValuePair> tags()

      The tags that are associated with the bucket.

      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 hasTags() method.

      Returns:
      The tags that are associated with the bucket.

    • toBuilder

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

    • builder

      public static S3Bucket.Builder builder()

    • serializableBuilderClass

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