com.netflix.genie.web.configs.aws

Class GenieAwsS3AutoConfiguration

java.lang.Object

com.netflix.genie.web.configs.aws.GenieAwsS3AutoConfiguration

@Configuration
 @ConditionalOnBean(value=com.amazonaws.auth.AWSCredentialsProvider.class)
 @AutoConfigureAfter(value=org.springframework.cloud.aws.autoconfigure.context.ContextCredentialsAutoConfiguration.class)
 @EnableConfigurationProperties(value={AwsCredentialsProperties.class,AwsCredentialsProperties.SpringCloudAwsRegionProperties.class,RetryProperties.class,S3FileTransferProperties.class})
public class GenieAwsS3AutoConfiguration
extends java.lang.Object

Beans and configuration specifically for S3 connection on AWS.

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
GenieAwsS3AutoConfiguration()

Method Summary

Modifier and Type	Method and Description
com.amazonaws.services.s3.AmazonS3	amazonS3(com.amazonaws.auth.AWSCredentialsProvider credentialsProvider, com.amazonaws.ClientConfiguration clientConfiguration, AwsCredentialsProperties.SpringCloudAwsRegionProperties springCloudAwsRegionProperties, AwsCredentialsProperties awsCredentialsProperties) Amazon S3 client configured using either the default credentials provider or an STSAssumeRoleSessionCredentialsProvider if a role is desired to be assumed.
com.amazonaws.ClientConfiguration	genieAwsClientConfiguration(RetryProperties retryProperties) Default AWS client configuration that sets the number of retries provided by the user.
S3FileTransferImpl	s3FileTransferImpl(com.amazonaws.services.s3.AmazonS3 amazonS3, io.micrometer.core.instrument.MeterRegistry 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

GenieAwsS3AutoConfiguration

public GenieAwsS3AutoConfiguration()

Method Detail

genieAwsClientConfiguration

@Bean
 @ConditionalOnMissingBean(name="genieAwsClientConfiguration",
                          value=com.amazonaws.ClientConfiguration.class)
public com.amazonaws.ClientConfiguration genieAwsClientConfiguration(RetryProperties retryProperties)

Default AWS client configuration that sets the number of retries provided by the user.

Parameters:

retryProperties - The properties related to retry configuration in Genie

Returns:

The client configuration to use for all built AWS clients

amazonS3

@Bean
public com.amazonaws.services.s3.AmazonS3 amazonS3(com.amazonaws.auth.AWSCredentialsProvider credentialsProvider,
                                                         com.amazonaws.ClientConfiguration clientConfiguration,
                                                         AwsCredentialsProperties.SpringCloudAwsRegionProperties springCloudAwsRegionProperties,
                                                         AwsCredentialsProperties awsCredentialsProperties)

Amazon S3 client configured using either the default credentials provider or an STSAssumeRoleSessionCredentialsProvider if a role is desired to be assumed.

Parameters:

credentialsProvider - The default credentials provider to use

clientConfiguration - The client configuration to use

springCloudAwsRegionProperties - Properties for the region coming from Spring Cloud AWS

awsCredentialsProperties - The properties under the Genie namespace related to AWS context

Returns:

An amazon s3 client object

s3FileTransferImpl

@Bean(name={"file.system.s3","file.system.s3n","file.system.s3a"})
 @Order(value=1)
public S3FileTransferImpl s3FileTransferImpl(com.amazonaws.services.s3.AmazonS3 amazonS3,
                                                                                                                                 io.micrometer.core.instrument.MeterRegistry registry,
                                                                                                                                 S3FileTransferProperties s3FileTransferProperties)

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

Parameters:

amazonS3 - S3 client to use

registry - The metrics registry to use

s3FileTransferProperties - Configuration properties

Returns:

An s3 implementation of the FileTransfer interface