org.finra.herd.service.helper

Class AwsPolicyBuilder

java.lang.Object

org.finra.herd.service.helper.AwsPolicyBuilder

public class AwsPolicyBuilder
extends Object

A builder for AWS policy objects.

Constructor Summary

Constructors

Constructor and Description
AwsPolicyBuilder()

Method Summary

Modifier and Type	Method and Description
com.amazonaws.auth.policy.Policy	build() Returns the policy object.
AwsPolicyBuilder	withKms(String kmsKeyId, KmsActions... actions) Adds a permission to allow the specified actions to the given KMS key id.
AwsPolicyBuilder	withS3(String bucketName, String objectKey, com.amazonaws.auth.policy.actions.S3Actions... actions) Adds a permission to allow the specified actions to the given bucket and s3 object key.
AwsPolicyBuilder	withS3Prefix(String bucketName, String prefix, com.amazonaws.auth.policy.actions.S3Actions... actions) Adds a permission to allow the specified actions to the given bucket and s3 key prefix.

Methods inherited from class java.lang.Object

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

Constructor Detail

AwsPolicyBuilder

public AwsPolicyBuilder()

Method Detail

build

public com.amazonaws.auth.policy.Policy build()

Returns the policy object.

Returns:

The policy

withKms

public AwsPolicyBuilder withKms(String kmsKeyId,
                                KmsActions... actions)

Adds a permission to allow the specified actions to the given KMS key id.

Parameters:

kmsKeyId - Full ARN to the kms key

actions - List of actions

Returns:

This builder

withS3

public AwsPolicyBuilder withS3(String bucketName,
                               String objectKey,
                               com.amazonaws.auth.policy.actions.S3Actions... actions)

Adds a permission to allow the specified actions to the given bucket and s3 object key. The permission will allow the given actions only to the specified object key. If object key is null, the permission is applied to the bucket itself.

Parameters:

bucketName - S3 bucket name

objectKey - S3 object key

actions - List of actions to allow

Returns:

This builder

withS3Prefix

public AwsPolicyBuilder withS3Prefix(String bucketName,
                                     String prefix,
                                     com.amazonaws.auth.policy.actions.S3Actions... actions)

Adds a permission to allow the specified actions to the given bucket and s3 key prefix. The permissions will allow the given actions to all objects with the given prefix.

Parameters:

bucketName - S3 Bucket name

prefix - S3 Object key prefix

actions - List of actions to allow

Returns:

This builder