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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceS3Bucket.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description PublicAccessConfigurationaccountPublicAccess()Contains information about the public access policies that apply to the Amazon S3 bucket at the account level.PublicAccessConfigurationbucketPublicAccess()Contains information about public access policies that apply to the Amazon S3 bucket.static S3Bucket.Builderbuilder()InstantcreatedAt()The timestamp at which the Amazon S3 bucket was created.StringeffectivePermission()Describes the effective permissions on this S3 bucket, after factoring all the attached policies.StringencryptionKeyArn()The Amazon Resource Name (ARN) of the encryption key that is used to encrypt the Amazon S3 bucket and its objects.StringencryptionType()The type of encryption used for the Amazon S3 buckets and its objects.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasS3ObjectUids()For responses, this returns true if the service returned a value for the S3ObjectUids property.StringownerId()The owner ID of the associated S3Amazon S3bucket.PublicAccessStatuspublicReadAccess()Indicates whether or not the public read access is allowed for an Amazon S3 bucket.StringpublicReadAccessAsString()Indicates whether or not the public read access is allowed for an Amazon S3 bucket.PublicAccessStatuspublicWriteAccess()Indicates whether or not the public write access is allowed for an Amazon S3 bucket.StringpublicWriteAccessAsString()Indicates whether or not the public write access is allowed for an Amazon S3 bucket.List<String>s3ObjectUids()Represents a list of Amazon S3 object identifiers.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends S3Bucket.Builder>serializableBuilderClass()S3Bucket.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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,
publicReadAccesswill returnPublicAccessStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompublicReadAccessAsString().- Returns:
- Indicates whether or not the public read access is allowed for an Amazon S3 bucket.
- See Also:
PublicAccessStatus
-
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,
publicReadAccesswill returnPublicAccessStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompublicReadAccessAsString().- Returns:
- Indicates whether or not the public read access is allowed for an Amazon S3 bucket.
- See Also:
PublicAccessStatus
-
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,
publicWriteAccesswill returnPublicAccessStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompublicWriteAccessAsString().- Returns:
- Indicates whether or not the public write access is allowed for an Amazon S3 bucket.
- See Also:
PublicAccessStatus
-
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,
publicWriteAccesswill returnPublicAccessStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompublicWriteAccessAsString().- Returns:
- Indicates whether or not the public write access is allowed for an Amazon S3 bucket.
- See Also:
PublicAccessStatus
-
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 theisEmpty()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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<S3Bucket.Builder,S3Bucket>
-
builder
public static S3Bucket.Builder builder()
-
serializableBuilderClass
public static Class<? extends S3Bucket.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-