com.netflix.genie.web.configs.aws

Class AwsS3Config

java.lang.Object

com.netflix.genie.web.configs.aws.AwsS3Config

@Profile(value="s3")
 @Configuration
public class AwsS3Config
extends java.lang.Object

Beans and configuration specifically for S3 connection on AWS.

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
AwsS3Config()

Method Summary

Modifier and Type	Method and Description
com.amazonaws.auth.ClasspathPropertiesFileCredentialsProvider	awsCredentialsFromFile(java.lang.String credentialsFilePath) Create the credentials needed for the application to be able to connect to Aws.
com.amazonaws.auth.STSAssumeRoleSessionCredentialsProvider	awsCredentialsProvider(java.lang.String roleArn) Assume role credentials provider which will be used to fetch session credentials.
com.amazonaws.services.s3.AmazonS3	genieS3Client(int noOfS3Retries, com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider) A bean providing a client to work with S3.
S3FileTransferImpl	s3FileTransferImpl(com.amazonaws.services.s3.AmazonS3 s3Client, com.netflix.spectator.api.Registry registry, S3FileTransferProperties s3FileTransferProperties) Returns a bean which has an s3 implementation of the File Transfer interface.

Methods inherited from class java.lang.Object

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

Constructor Detail

AwsS3Config

public AwsS3Config()

Method Detail

awsCredentialsFromFile

@Bean
 @ConditionalOnProperty(value="genie.aws.credentials.file")
public com.amazonaws.auth.ClasspathPropertiesFileCredentialsProvider awsCredentialsFromFile(@Value(value="${genie.aws.credentials.file}")
                                                                                                                                                              java.lang.String credentialsFilePath)

Create the credentials needed for the application to be able to connect to Aws. Only triggered if the property cloud.aws.credentials.provided is set to true in the config.

Parameters:

credentialsFilePath - The path of the file containing aws credentials

Returns:

AWS credentials object to use to connect to AWS

awsCredentialsProvider

@Bean
 @ConditionalOnProperty(value="genie.aws.credentials.role")
public com.amazonaws.auth.STSAssumeRoleSessionCredentialsProvider awsCredentialsProvider(@Value(value="${genie.aws.credentials.role}")
                                                                                                                                                           java.lang.String roleArn)

Assume role credentials provider which will be used to fetch session credentials.

Parameters:

roleArn - Arn of the IAM role

Returns:

Credentials provider to ask the credentials from

genieS3Client

@Bean
 @ConditionalOnBean(value=com.amazonaws.auth.AWSCredentialsProvider.class)
public com.amazonaws.services.s3.AmazonS3 genieS3Client(@Value(value="${genie.retry.s3.noOfRetries:5}")
                                                                                                                                         int noOfS3Retries,
                                                                                                                                         com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider)

A bean providing a client to work with S3.

Parameters:

noOfS3Retries - No. of S3 request retries

awsCredentialsProvider - A credentials provider used to instantiate the client.

Returns:

An amazon s3 client object

s3FileTransferImpl

@Bean(name={"file.system.s3","file.system.s3n","file.system.s3a"})
 @Order(value=1)
 @ConditionalOnBean(value=com.amazonaws.services.s3.AmazonS3.class)
public S3FileTransferImpl s3FileTransferImpl(com.amazonaws.services.s3.AmazonS3 s3Client,
                                                                                                                                                                                                     com.netflix.spectator.api.Registry registry,
                                                                                                                                                                                                     S3FileTransferProperties s3FileTransferProperties)
                                                                                                                                                                                              throws GenieException

Returns a bean which has an s3 implementation of the File Transfer interface.

Parameters:

s3Client - S3 client to initialize the service

registry - The metrics registry to use

s3FileTransferProperties - Configuration properties

Returns:

An s3 implementation of the FileTransfer interface

Throws:

GenieException - if there is any problem