org.apache.flink.connector.aws.util

Class AWSGeneralUtil

java.lang.Object

org.apache.flink.connector.aws.util.AWSGeneralUtil

Direct Known Subclasses:

AWSAsyncSinkUtil

@Internal
public class AWSGeneralUtil
extends Object

Some general utilities specific to Amazon Web Service.

Constructor Summary

Constructors

Constructor and Description
AWSGeneralUtil()

Method Summary

Modifier and Type	Method and Description
static void	closeResources(software.amazon.awssdk.utils.SdkAutoCloseable... resources)
static software.amazon.awssdk.http.async.SdkAsyncHttpClient	createAsyncHttpClient(software.amazon.awssdk.utils.AttributeMap config, software.amazon.awssdk.http.nio.netty.NettyNioAsyncHttpClient.Builder httpClientBuilder)
static software.amazon.awssdk.http.async.SdkAsyncHttpClient	createAsyncHttpClient(software.amazon.awssdk.http.nio.netty.NettyNioAsyncHttpClient.Builder httpClientBuilder)
static software.amazon.awssdk.http.async.SdkAsyncHttpClient	createAsyncHttpClient(Properties configProperties)
static software.amazon.awssdk.http.async.SdkAsyncHttpClient	createAsyncHttpClient(Properties configProperties, software.amazon.awssdk.http.nio.netty.NettyNioAsyncHttpClient.Builder httpClientBuilder)
static AWSConfigConstants.CredentialProvider	getCredentialProviderType(Properties configProps, String configPrefix) Determines and returns the credential provider type from the given properties.
static software.amazon.awssdk.auth.credentials.AwsCredentialsProvider	getCredentialsProvider(Map<String,?> configProps) Return a AwsCredentialsProvider instance corresponding to the configuration properties.
static software.amazon.awssdk.auth.credentials.AwsCredentialsProvider	getCredentialsProvider(Properties configProps) Return a AwsCredentialsProvider instance corresponding to the configuration properties.
static software.amazon.awssdk.auth.credentials.AwsCredentialsProvider	getCredentialsProvider(Properties configProps, String configPrefix)
static software.amazon.awssdk.auth.credentials.AwsCredentialsProvider	getProfileCredentialProvider(Properties configProps, String configPrefix)
static software.amazon.awssdk.regions.Region	getRegion(Properties configProps) Creates a Region object from the given Properties.
static boolean	isValidRegion(software.amazon.awssdk.regions.Region region) Checks whether or not a region is valid.
static void	validateAwsConfiguration(Properties config) Validates configuration properties related to Amazon AWS service.
static void	validateAwsCredentials(Properties config)

Methods inherited from class java.lang.Object

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

Constructor Detail

AWSGeneralUtil

public AWSGeneralUtil()

Method Detail

getCredentialProviderType

public static AWSConfigConstants.CredentialProvider getCredentialProviderType(Properties configProps,
                                                                              String configPrefix)

Determines and returns the credential provider type from the given properties.

Returns:

the credential provider type

getCredentialsProvider

public static software.amazon.awssdk.auth.credentials.AwsCredentialsProvider getCredentialsProvider(Map<String,?> configProps)

Return a AwsCredentialsProvider instance corresponding to the configuration properties.

Parameters:

configProps - the configuration property map

Returns:

The corresponding AWS Credentials Provider instance

getCredentialsProvider

public static software.amazon.awssdk.auth.credentials.AwsCredentialsProvider getCredentialsProvider(Properties configProps)

Return a AwsCredentialsProvider instance corresponding to the configuration properties.

Parameters:

configProps - the configuration properties

Returns:

The corresponding AWS Credentials Provider instance

getCredentialsProvider

public static software.amazon.awssdk.auth.credentials.AwsCredentialsProvider getCredentialsProvider(Properties configProps,
                                                                                                    String configPrefix)

getProfileCredentialProvider

public static software.amazon.awssdk.auth.credentials.AwsCredentialsProvider getProfileCredentialProvider(Properties configProps,
                                                                                                          String configPrefix)

createAsyncHttpClient

public static software.amazon.awssdk.http.async.SdkAsyncHttpClient createAsyncHttpClient(Properties configProperties)

createAsyncHttpClient

public static software.amazon.awssdk.http.async.SdkAsyncHttpClient createAsyncHttpClient(Properties configProperties,
                                                                                         software.amazon.awssdk.http.nio.netty.NettyNioAsyncHttpClient.Builder httpClientBuilder)

createAsyncHttpClient

public static software.amazon.awssdk.http.async.SdkAsyncHttpClient createAsyncHttpClient(software.amazon.awssdk.http.nio.netty.NettyNioAsyncHttpClient.Builder httpClientBuilder)

createAsyncHttpClient

public static software.amazon.awssdk.http.async.SdkAsyncHttpClient createAsyncHttpClient(software.amazon.awssdk.utils.AttributeMap config,
                                                                                         software.amazon.awssdk.http.nio.netty.NettyNioAsyncHttpClient.Builder httpClientBuilder)

getRegion

public static software.amazon.awssdk.regions.Region getRegion(Properties configProps)

Creates a Region object from the given Properties.

Parameters:

configProps - the properties containing the region

Returns:

the region specified by the properties

isValidRegion

public static boolean isValidRegion(software.amazon.awssdk.regions.Region region)

Checks whether or not a region is valid.

Parameters:

region - The AWS region to check

Returns:

true if the supplied region is valid, false otherwise

validateAwsConfiguration

public static void validateAwsConfiguration(Properties config)

Validates configuration properties related to Amazon AWS service.

Parameters:

config - the properties to setup credentials and region

closeResources

public static void closeResources(software.amazon.awssdk.utils.SdkAutoCloseable... resources)

validateAwsCredentials

public static void validateAwsCredentials(Properties config)