Class S3Bucket

java.lang.Object
software.amazon.awssdk.services.guardduty.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>

Contains information about the Amazon S3 bucket policies and encryption.

See Also:

  • Method Details

    • ownerId

      public final String ownerId()

      The owner ID of the associated S3Amazon S3bucket.

      Returns:
      The owner ID of the associated S3Amazon S3bucket.

    • createdAt

      public final Instant createdAt()

      The timestamp at which the Amazon S3 bucket was created.

      Returns:
      The timestamp at which the Amazon S3 bucket was created.

    • encryptionType

      public final String encryptionType()

      The type of encryption used for the Amazon S3 buckets and its objects. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide.

      Returns:
      The type of encryption used for the Amazon S3 buckets and its objects. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide.

    • encryptionKeyArn

      public final String encryptionKeyArn()

      The Amazon Resource Name (ARN) of the encryption key that is used to encrypt the Amazon S3 bucket and its objects.

      Returns:
      The Amazon Resource Name (ARN) of the encryption key that is used to encrypt the Amazon S3 bucket and its objects.

    • effectivePermission

      public final String effectivePermission()

      Describes the effective permissions on this S3 bucket, after factoring all the attached policies.

      Returns:
      Describes the effective permissions on this S3 bucket, after factoring all the attached policies.

    • publicReadAccess

      public final PublicAccessStatus publicReadAccess()

      Indicates whether or not the public read access is allowed for an Amazon S3 bucket.

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

      Returns:
      Indicates whether or not the public read access is allowed for an Amazon S3 bucket.
      See Also:

    • publicReadAccessAsString

      public final String publicReadAccessAsString()

      Indicates whether or not the public read access is allowed for an Amazon S3 bucket.

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

      Returns:
      Indicates whether or not the public read access is allowed for an Amazon S3 bucket.
      See Also:

    • publicWriteAccess

      public final PublicAccessStatus publicWriteAccess()

      Indicates whether or not the public write access is allowed for an Amazon S3 bucket.

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

      Returns:
      Indicates whether or not the public write access is allowed for an Amazon S3 bucket.
      See Also:

    • publicWriteAccessAsString

      public final String publicWriteAccessAsString()

      Indicates whether or not the public write access is allowed for an Amazon S3 bucket.

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

      Returns:
      Indicates whether or not the public write access is allowed for an Amazon S3 bucket.
      See Also:

    • accountPublicAccess

      public final PublicAccessConfiguration accountPublicAccess()

      Contains information about the public access policies that apply to the Amazon S3 bucket at the account level.

      Returns:
      Contains information about the public access policies that apply to the Amazon S3 bucket at the account level.

    • bucketPublicAccess

      public final PublicAccessConfiguration bucketPublicAccess()

      Contains information about public access policies that apply to the Amazon S3 bucket.

      Returns:
      Contains information about public access policies that apply to the Amazon S3 bucket.

    • hasS3ObjectUids

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

    • s3ObjectUids

      public final List<String> s3ObjectUids()

      Represents a list of Amazon S3 object identifiers.

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

      Returns:
      Represents a list of Amazon S3 object identifiers.

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