S3BucketConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.accessanalyzer.model.S3BucketConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class S3BucketConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Proposed access control configuration for an Amazon S3 bucket. You can propose a configuration for a new Amazon S3 bucket or an existing Amazon S3 bucket that you own by specifying the Amazon S3 bucket policy, bucket ACLs, bucket BPA settings, Amazon S3 access points, and multi-region access points attached to the bucket. If the configuration is for an existing Amazon S3 bucket and you do not specify the Amazon S3 bucket policy, the access preview uses the existing policy attached to the bucket. If the access preview is for a new resource and you do not specify the Amazon S3 bucket policy, the access preview assumes a bucket without a policy. To propose deletion of an existing bucket policy, you can specify an empty string. For more information about bucket policy limits, see Bucket Policy Examples.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

S3BucketConfiguration()

Constructors
Constructor and Description
`S3BucketConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`S3BucketConfiguration`	`addAccessPointsEntry(String key, S3AccessPointConfiguration value)` Add a single AccessPoints entry
`S3BucketConfiguration`	`clearAccessPointsEntries()` Removes all the entries added into AccessPoints.
`S3BucketConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,S3AccessPointConfiguration>`	`getAccessPoints()` The configuration of Amazon S3 access points or multi-region access points for the bucket.
`List<S3BucketAclGrantConfiguration>`	`getBucketAclGrants()` The proposed list of ACL grants for the Amazon S3 bucket.
`String`	`getBucketPolicy()` The proposed bucket policy for the Amazon S3 bucket.
`S3PublicAccessBlockConfiguration`	`getBucketPublicAccessBlock()` The proposed block public access configuration for the Amazon S3 bucket.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAccessPoints(Map<String,S3AccessPointConfiguration> accessPoints)` The configuration of Amazon S3 access points or multi-region access points for the bucket.
`void`	`setBucketAclGrants(Collection<S3BucketAclGrantConfiguration> bucketAclGrants)` The proposed list of ACL grants for the Amazon S3 bucket.
`void`	`setBucketPolicy(String bucketPolicy)` The proposed bucket policy for the Amazon S3 bucket.
`void`	`setBucketPublicAccessBlock(S3PublicAccessBlockConfiguration bucketPublicAccessBlock)` The proposed block public access configuration for the Amazon S3 bucket.
`String`	`toString()` Returns a string representation of this object.
`S3BucketConfiguration`	`withAccessPoints(Map<String,S3AccessPointConfiguration> accessPoints)` The configuration of Amazon S3 access points or multi-region access points for the bucket.
`S3BucketConfiguration`	`withBucketAclGrants(Collection<S3BucketAclGrantConfiguration> bucketAclGrants)` The proposed list of ACL grants for the Amazon S3 bucket.
`S3BucketConfiguration`	`withBucketAclGrants(S3BucketAclGrantConfiguration... bucketAclGrants)` The proposed list of ACL grants for the Amazon S3 bucket.
`S3BucketConfiguration`	`withBucketPolicy(String bucketPolicy)` The proposed bucket policy for the Amazon S3 bucket.
`S3BucketConfiguration`	`withBucketPublicAccessBlock(S3PublicAccessBlockConfiguration bucketPublicAccessBlock)` The proposed block public access configuration for the Amazon S3 bucket.

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

- Constructor Detail
  - S3BucketConfiguration
```
public S3BucketConfiguration()
```
- Method Detail
  - setBucketPolicy
```
public void setBucketPolicy(String bucketPolicy)
```
    The proposed bucket policy for the Amazon S3 bucket.
    
    Parameters:
    
    bucketPolicy - The proposed bucket policy for the Amazon S3 bucket.
  - getBucketPolicy
```
public String getBucketPolicy()
```
    The proposed bucket policy for the Amazon S3 bucket.
    
    Returns:
    
    The proposed bucket policy for the Amazon S3 bucket.
  - withBucketPolicy
```
public S3BucketConfiguration withBucketPolicy(String bucketPolicy)
```
    The proposed bucket policy for the Amazon S3 bucket.
    
    Parameters:
    
    bucketPolicy - The proposed bucket policy for the Amazon S3 bucket.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getBucketAclGrants
```
public List<S3BucketAclGrantConfiguration> getBucketAclGrants()
```
    The proposed list of ACL grants for the Amazon S3 bucket. You can propose up to 100 ACL grants per bucket. If the proposed grant configuration is for an existing bucket, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the bucket.
    
    Returns:
    
    The proposed list of ACL grants for the Amazon S3 bucket. You can propose up to 100 ACL grants per bucket. If the proposed grant configuration is for an existing bucket, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the bucket.
  - setBucketAclGrants
```
public void setBucketAclGrants(Collection<S3BucketAclGrantConfiguration> bucketAclGrants)
```
    The proposed list of ACL grants for the Amazon S3 bucket. You can propose up to 100 ACL grants per bucket. If the proposed grant configuration is for an existing bucket, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the bucket.
    
    Parameters:
    
    bucketAclGrants - The proposed list of ACL grants for the Amazon S3 bucket. You can propose up to 100 ACL grants per bucket. If the proposed grant configuration is for an existing bucket, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the bucket.
  - withBucketAclGrants
```
public S3BucketConfiguration withBucketAclGrants(S3BucketAclGrantConfiguration... bucketAclGrants)
```
    The proposed list of ACL grants for the Amazon S3 bucket. You can propose up to 100 ACL grants per bucket. If the proposed grant configuration is for an existing bucket, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the bucket.
    
    NOTE: This method appends the values to the existing list (if any). Use setBucketAclGrants(java.util.Collection) or withBucketAclGrants(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    bucketAclGrants - The proposed list of ACL grants for the Amazon S3 bucket. You can propose up to 100 ACL grants per bucket. If the proposed grant configuration is for an existing bucket, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the bucket.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withBucketAclGrants
```
public S3BucketConfiguration withBucketAclGrants(Collection<S3BucketAclGrantConfiguration> bucketAclGrants)
```
    The proposed list of ACL grants for the Amazon S3 bucket. You can propose up to 100 ACL grants per bucket. If the proposed grant configuration is for an existing bucket, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the bucket.
    
    Parameters:
    
    bucketAclGrants - The proposed list of ACL grants for the Amazon S3 bucket. You can propose up to 100 ACL grants per bucket. If the proposed grant configuration is for an existing bucket, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the bucket.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBucketPublicAccessBlock
```
public void setBucketPublicAccessBlock(S3PublicAccessBlockConfiguration bucketPublicAccessBlock)
```
    The proposed block public access configuration for the Amazon S3 bucket.
    
    Parameters:
    
    bucketPublicAccessBlock - The proposed block public access configuration for the Amazon S3 bucket.
  - getBucketPublicAccessBlock
```
public S3PublicAccessBlockConfiguration getBucketPublicAccessBlock()
```
    The proposed block public access configuration for the Amazon S3 bucket.
    
    Returns:
    
    The proposed block public access configuration for the Amazon S3 bucket.
  - withBucketPublicAccessBlock
```
public S3BucketConfiguration withBucketPublicAccessBlock(S3PublicAccessBlockConfiguration bucketPublicAccessBlock)
```
    The proposed block public access configuration for the Amazon S3 bucket.
    
    Parameters:
    
    bucketPublicAccessBlock - The proposed block public access configuration for the Amazon S3 bucket.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAccessPoints
```
public Map<String,S3AccessPointConfiguration> getAccessPoints()
```
    The configuration of Amazon S3 access points or multi-region access points for the bucket. You can propose up to 10 new access points per bucket.
    
    Returns:
    
    The configuration of Amazon S3 access points or multi-region access points for the bucket. You can propose up to 10 new access points per bucket.
  - setAccessPoints
```
public void setAccessPoints(Map<String,S3AccessPointConfiguration> accessPoints)
```
    The configuration of Amazon S3 access points or multi-region access points for the bucket. You can propose up to 10 new access points per bucket.
    
    Parameters:
    
    accessPoints - The configuration of Amazon S3 access points or multi-region access points for the bucket. You can propose up to 10 new access points per bucket.
  - withAccessPoints
```
public S3BucketConfiguration withAccessPoints(Map<String,S3AccessPointConfiguration> accessPoints)
```
    The configuration of Amazon S3 access points or multi-region access points for the bucket. You can propose up to 10 new access points per bucket.
    
    Parameters:
    
    accessPoints - The configuration of Amazon S3 access points or multi-region access points for the bucket. You can propose up to 10 new access points per bucket.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAccessPointsEntry
```
public S3BucketConfiguration addAccessPointsEntry(String key,
                                                  S3AccessPointConfiguration value)
```
    Add a single AccessPoints entry
    
    See Also:
    
    withAccessPoints(java.util.Map<java.lang.String, com.amazonaws.services.accessanalyzer.model.S3AccessPointConfiguration>)
  - clearAccessPointsEntries
```
public S3BucketConfiguration clearAccessPointsEntries()
```
    Removes all the entries added into AccessPoints.
    
    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 S3BucketConfiguration 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.

AWS SDK for Java 1.x API Reference - 1.12.779

Class S3BucketConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

S3BucketConfiguration

Method Detail

setBucketPolicy

getBucketPolicy

withBucketPolicy

getBucketAclGrants

setBucketAclGrants

withBucketAclGrants

withBucketAclGrants

setBucketPublicAccessBlock

getBucketPublicAccessBlock

withBucketPublicAccessBlock

getAccessPoints

setAccessPoints

withAccessPoints

addAccessPointsEntry

clearAccessPointsEntries

toString

equals

hashCode

clone

marshall