com.amazonaws.auth.policy.resources.S3ObjectResource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk Show documentation

The Amazon Web Services SDK for Java provides Java APIs for building software on AWS' cost-effective, scalable, and reliable infrastructure products. The AWS Java SDK allows developers to code against APIs for all of Amazon's infrastructure web services (Amazon S3, Amazon EC2, Amazon SQS, Amazon Relational Database Service, Amazon AutoScaling, etc).

The newest version!

/*
 * Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */
package com.amazonaws.auth.policy.resources;

import com.amazonaws.auth.policy.Resource;
import com.amazonaws.auth.policy.actions.S3Actions;

/**
 * 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:
 * 

 *  {@link S3Actions#GetObject}
 * 
 {@link S3Actions#GetObjectVersion}
 * 
 {@link S3Actions#PutObject}
 * 
 {@link S3Actions#GetObjectAcl}
 * 
 {@link S3Actions#GetObjectVersionAcl}
 * 
 {@link S3Actions#SetObjectAcl}
 * 
 {@link S3Actions#SetObjectVersionAcl}
 * 
 {@link S3Actions#DeleteObject}
 * 
 {@link S3Actions#DeleteObjectVersion}
 * 
 */
public class S3ObjectResource extends Resource {

    /**
     * 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'.
     *
     * @param bucketName
     *            The name of the bucket containing the object or objects
     *            represented by this resource.
     * @param keyPattern
     *            The key or key pattern, which can optionally contain the '*'
     *            wildcard to include multiple objects in the resource.
     */
    public S3ObjectResource(String bucketName, String keyPattern) {
        super("arn:aws:s3:::" + bucketName + "/" + keyPattern);
    }
}