S3Bucket (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.macie2.model.S3Bucket

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class S3Bucket
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides information about the S3 bucket that a finding applies to.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

S3Bucket()

Constructors
Constructor and Description
`S3Bucket()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`S3Bucket`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAllowsUnencryptedObjectUploads()` Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket.
`String`	`getArn()` The Amazon Resource Name (ARN) of the bucket.
`Date`	`getCreatedAt()` The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
`ServerSideEncryption`	`getDefaultServerSideEncryption()` The type of server-side encryption that's used by default to encrypt objects in the bucket.
`String`	`getName()` The name of the bucket.
`S3BucketOwner`	`getOwner()` The display name and canonical user ID for the Amazon Web Services account that owns the bucket.
`BucketPublicAccess`	`getPublicAccess()` The permissions settings that determine whether the bucket is publicly accessible.
`List<KeyValuePair>`	`getTags()` The tags that are associated with the bucket.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAllowsUnencryptedObjectUploads(String allowsUnencryptedObjectUploads)` Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the bucket.
`void`	`setCreatedAt(Date createdAt)` The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
`void`	`setDefaultServerSideEncryption(ServerSideEncryption defaultServerSideEncryption)` The type of server-side encryption that's used by default to encrypt objects in the bucket.
`void`	`setName(String name)` The name of the bucket.
`void`	`setOwner(S3BucketOwner owner)` The display name and canonical user ID for the Amazon Web Services account that owns the bucket.
`void`	`setPublicAccess(BucketPublicAccess publicAccess)` The permissions settings that determine whether the bucket is publicly accessible.
`void`	`setTags(Collection<KeyValuePair> tags)` The tags that are associated with the bucket.
`String`	`toString()` Returns a string representation of this object.
`S3Bucket`	`withAllowsUnencryptedObjectUploads(AllowsUnencryptedObjectUploads allowsUnencryptedObjectUploads)` Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket.
`S3Bucket`	`withAllowsUnencryptedObjectUploads(String allowsUnencryptedObjectUploads)` Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket.
`S3Bucket`	`withArn(String arn)` The Amazon Resource Name (ARN) of the bucket.
`S3Bucket`	`withCreatedAt(Date createdAt)` The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
`S3Bucket`	`withDefaultServerSideEncryption(ServerSideEncryption defaultServerSideEncryption)` The type of server-side encryption that's used by default to encrypt objects in the bucket.
`S3Bucket`	`withName(String name)` The name of the bucket.
`S3Bucket`	`withOwner(S3BucketOwner owner)` The display name and canonical user ID for the Amazon Web Services account that owns the bucket.
`S3Bucket`	`withPublicAccess(BucketPublicAccess publicAccess)` The permissions settings that determine whether the bucket is publicly accessible.
`S3Bucket`	`withTags(Collection<KeyValuePair> tags)` The tags that are associated with the bucket.
`S3Bucket`	`withTags(KeyValuePair... tags)` The tags that are associated with the bucket.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - S3Bucket
```
public S3Bucket()
```
- Method Detail
  - setAllowsUnencryptedObjectUploads
```
public void setAllowsUnencryptedObjectUploads(String allowsUnencryptedObjectUploads)
```
    Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket. Possible values are:
    - FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include the x-amz-server-side-encryption header and the value for that header must be AES256 or aws:kms.
    - 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 the x-amz-server-side-encryption header and it doesn't require the value for that header to be AES256 or aws:kms.
    - UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of objects.
    Parameters:
    allowsUnencryptedObjectUploads - Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket. Possible values are:
    
    FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include the x-amz-server-side-encryption header and the value for that header must be AES256 or aws:kms.
    
    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 the x-amz-server-side-encryption header and it doesn't require the value for that header to be AES256 or aws:kms.
    
    UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of objects.
    See Also:
    
    AllowsUnencryptedObjectUploads
  - getAllowsUnencryptedObjectUploads
```
public String getAllowsUnencryptedObjectUploads()
```
    Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket. Possible values are:
    - FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include the x-amz-server-side-encryption header and the value for that header must be AES256 or aws:kms.
    - 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 the x-amz-server-side-encryption header and it doesn't require the value for that header to be AES256 or aws:kms.
    - UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of objects.
    Returns:
    Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket. Possible values are:
    
    FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include the x-amz-server-side-encryption header and the value for that header must be AES256 or aws:kms.
    
    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 the x-amz-server-side-encryption header and it doesn't require the value for that header to be AES256 or aws:kms.
    
    UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of objects.
    See Also:
    
    AllowsUnencryptedObjectUploads
  - withAllowsUnencryptedObjectUploads
```
public S3Bucket withAllowsUnencryptedObjectUploads(String allowsUnencryptedObjectUploads)
```
    Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket. Possible values are:
    - FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include the x-amz-server-side-encryption header and the value for that header must be AES256 or aws:kms.
    - 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 the x-amz-server-side-encryption header and it doesn't require the value for that header to be AES256 or aws:kms.
    - UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of objects.
    Parameters:
    allowsUnencryptedObjectUploads - Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket. Possible values are:
    
    FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include the x-amz-server-side-encryption header and the value for that header must be AES256 or aws:kms.
    
    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 the x-amz-server-side-encryption header and it doesn't require the value for that header to be AES256 or aws:kms.
    
    UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of objects.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AllowsUnencryptedObjectUploads
  - withAllowsUnencryptedObjectUploads
```
public S3Bucket withAllowsUnencryptedObjectUploads(AllowsUnencryptedObjectUploads allowsUnencryptedObjectUploads)
```
    Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket. Possible values are:
    - FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include the x-amz-server-side-encryption header and the value for that header must be AES256 or aws:kms.
    - 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 the x-amz-server-side-encryption header and it doesn't require the value for that header to be AES256 or aws:kms.
    - UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of objects.
    Parameters:
    allowsUnencryptedObjectUploads - Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket. Possible values are:
    
    FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include the x-amz-server-side-encryption header and the value for that header must be AES256 or aws:kms.
    
    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 the x-amz-server-side-encryption header and it doesn't require the value for that header to be AES256 or aws:kms.
    
    UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of objects.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AllowsUnencryptedObjectUploads
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the bucket.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the bucket.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the bucket.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the bucket.
  - withArn
```
public S3Bucket withArn(String arn)
```
    The Amazon Resource Name (ARN) of the bucket.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the bucket.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
    
    Parameters:
    
    createdAt - The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
    
    Returns:
    
    The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
  - withCreatedAt
```
public S3Bucket withCreatedAt(Date createdAt)
```
    The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
    
    Parameters:
    
    createdAt - The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultServerSideEncryption
```
public void setDefaultServerSideEncryption(ServerSideEncryption defaultServerSideEncryption)
```
    The type of server-side encryption that's used by default to encrypt objects in the bucket.
    
    Parameters:
    
    defaultServerSideEncryption - The type of server-side encryption that's used by default to encrypt objects in the bucket.
  - getDefaultServerSideEncryption
```
public ServerSideEncryption getDefaultServerSideEncryption()
```
    The type of server-side encryption that's used by default to encrypt objects in the bucket.
    
    Returns:
    
    The type of server-side encryption that's used by default to encrypt objects in the bucket.
  - withDefaultServerSideEncryption
```
public S3Bucket withDefaultServerSideEncryption(ServerSideEncryption defaultServerSideEncryption)
```
    The type of server-side encryption that's used by default to encrypt objects in the bucket.
    
    Parameters:
    
    defaultServerSideEncryption - The type of server-side encryption that's used by default to encrypt objects in the bucket.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the bucket.
    
    Parameters:
    
    name - The name of the bucket.
  - getName
```
public String getName()
```
    The name of the bucket.
    
    Returns:
    
    The name of the bucket.
  - withName
```
public S3Bucket withName(String name)
```
    The name of the bucket.
    
    Parameters:
    
    name - The name of the bucket.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOwner
```
public void setOwner(S3BucketOwner owner)
```
    The display name and canonical user ID for the Amazon Web Services account that owns the bucket.
    
    Parameters:
    
    owner - The display name and canonical user ID for the Amazon Web Services account that owns the bucket.
  - getOwner
```
public S3BucketOwner getOwner()
```
    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.
  - withOwner
```
public S3Bucket withOwner(S3BucketOwner owner)
```
    The display name and canonical user ID for the Amazon Web Services account that owns the bucket.
    
    Parameters:
    
    owner - The display name and canonical user ID for the Amazon Web Services account that owns the bucket.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPublicAccess
```
public void setPublicAccess(BucketPublicAccess publicAccess)
```
    The permissions settings that determine whether the bucket is publicly accessible.
    
    Parameters:
    
    publicAccess - The permissions settings that determine whether the bucket is publicly accessible.
  - getPublicAccess
```
public BucketPublicAccess getPublicAccess()
```
    The permissions settings that determine whether the bucket is publicly accessible.
    
    Returns:
    
    The permissions settings that determine whether the bucket is publicly accessible.
  - withPublicAccess
```
public S3Bucket withPublicAccess(BucketPublicAccess publicAccess)
```
    The permissions settings that determine whether the bucket is publicly accessible.
    
    Parameters:
    
    publicAccess - The permissions settings that determine whether the bucket is publicly accessible.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<KeyValuePair> getTags()
```
    The tags that are associated with the bucket.
    
    Returns:
    
    The tags that are associated with the bucket.
  - setTags
```
public void setTags(Collection<KeyValuePair> tags)
```
    The tags that are associated with the bucket.
    
    Parameters:
    
    tags - The tags that are associated with the bucket.
  - withTags
```
public S3Bucket withTags(KeyValuePair... tags)
```
    The tags that are associated with the bucket.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - The tags that are associated with the bucket.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public S3Bucket withTags(Collection<KeyValuePair> tags)
```
    The tags that are associated with the bucket.
    
    Parameters:
    
    tags - The tags that are associated with the bucket.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public S3Bucket clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class S3Bucket

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

S3Bucket

Method Detail

setAllowsUnencryptedObjectUploads

getAllowsUnencryptedObjectUploads

withAllowsUnencryptedObjectUploads

withAllowsUnencryptedObjectUploads

setArn

getArn

withArn

setCreatedAt

getCreatedAt

withCreatedAt

setDefaultServerSideEncryption

getDefaultServerSideEncryption

withDefaultServerSideEncryption

setName

getName

withName

setOwner

getOwner

withOwner

setPublicAccess

getPublicAccess

withPublicAccess

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone

marshall