com.ibm.cloud.objectstorage.auth.policy.resources

Class S3ObjectResource

java.lang.Object

com.ibm.cloud.objectstorage.auth.policy.Resource

com.ibm.cloud.objectstorage.auth.policy.resources.S3ObjectResource

public class S3ObjectResource
extends Resource

Represents one or more Amazon S3 objects involved in an AWS access control policy. S3 object resources can be fully specified (i.e. the full key) or you can use the '*' wildcard to match multiple objects.

For example, an object resource created for bucket 'mybucket' and key pattern 'foo*' will match any object stored in 'mybucket' with a key that starts with 'foo':

    new S3ObjectResource("mybucket", "foo*");
 

To match all objects in a bucket:

    new S3ObjectResource("mybucket", "*");
 

Amazon S3 object resources can be used in the following operations:

• S3Actions.GetObject
• S3Actions.GetObjectVersion
• S3Actions.PutObject
• S3Actions.GetObjectAcl
• S3Actions.GetObjectVersionAcl
• S3Actions.SetObjectAcl
• S3Actions.SetObjectVersionAcl
• S3Actions.DeleteObject
• S3Actions.DeleteObjectVersion

Constructor Summary

Constructors

Constructor and Description
S3ObjectResource(String bucketName, String keyPattern) Constructs a new object resource that represents the specified objects.
S3ObjectResource(String partitionName, String bucketName, String keyPattern) Constructs a new object resource that represents the specified objects.

Method Summary

Methods inherited from class com.ibm.cloud.objectstorage.auth.policy.Resource

getId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

S3ObjectResource

public S3ObjectResource(String bucketName,
                        String keyPattern)

Constructs a new object resource that represents the specified objects. This constructor defaults to aws partition. Use S3ObjectResource(String, String, String) to specify other partitions if needed. The keyPattern argument may contain the '*' wildcard to match multiple objects. For example, an object resource created for bucket 'mybucket' and key pattern 'foo*' will match any object stored in 'mybucket' with a key that starts with 'foo'.

Parameters:

bucketName - The name of the bucket containing the object or objects represented by this resource.

keyPattern - The key or key pattern, which can optionally contain the '*' wildcard to include multiple objects in the resource.

See Also:

S3ObjectResource(String, String, String)

S3ObjectResource

public S3ObjectResource(String partitionName,
                        String bucketName,
                        String keyPattern)

Constructs a new object resource that represents the specified objects. The keyPattern argument may contain the '*' wildcard to match multiple objects. For example, an object resource created for bucket 'mybucket' and key pattern 'foo*' will match any object stored in 'mybucket' with a key that starts with 'foo'.

Parameters:

partitionName - The name of the partition in which the specified bucket is located.

bucketName - The name of the bucket containing the object or objects represented by this resource.

keyPattern - The key or key pattern, which can optionally contain the '*' wildcard to include multiple objects in the resource.