com.amazonaws.auth.policy.Resource 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;

/**
 * Represents a resource involved in an AWS access control policy statement.
 * Resources are the service specific AWS entities owned by your account. Amazon
 * SQS queues, Amazon S3 buckets and objects, and Amazon SNS topics are all
 * examples of AWS resources.
 * 
 * The standard way of specifying an AWS resource is with an Amazon Resource
 * Name (ARN).
 * 

 * The resource is C in the statement
 * "A has permission to do B to C where D applies."
 */
public class Resource {
    private final String resource;

    /**
     * Constructs a new AWS access control policy resource. Resources are
     * typically specified as Amazon Resource Names (ARNs).
     * 

     * You specify the resource using the following Amazon Resource Name (ARN)
     * format:
     * arn:aws:<vendor>:<region>:<namespace>:<relative-id>
     * 

     * 

     * vendor identifies the AWS product (e.g., sns)
     * region is the AWS Region the resource resides in (e.g., us-east-1),
     * if any
     * 
namespace is the AWS account ID with no hyphens (e.g., 123456789012)
     * 
relative-id is the service specific portion that identifies the
     * specific resource
     * 
     * 
     * For example, an Amazon SQS queue might be addressed with the following
     * ARN: arn:aws:sqs:us-east-1:987654321000:MyQueue
     * 
     * Some resources may not use every field in an ARN. For example, resources
     * in Amazon S3 are global, so they omit the region field:
     * arn:aws:s3:::bucket/*
     *
     * @param resource
     *            The Amazon Resource Name (ARN) uniquely identifying the
     *            desired AWS resource.
     */
    public Resource(String resource) {
        this.resource = resource;
    }

    /**
     * Returns the resource ID, typically an Amazon Resource Name (ARN),
     * identifying this resource.
     *
     * @return The resource ID, typically an Amazon Resource Name (ARN),
     *         identifying this resource.
     */
    public String getId() {
        return resource;
    }
}