org.apache.flink.statefun.sdk.kinesis.auth

Class AwsCredentials

java.lang.Object

org.apache.flink.statefun.sdk.kinesis.auth.AwsCredentials

Direct Known Subclasses:

AwsCredentials.BasicAwsCredentials, AwsCredentials.DefaultAwsCredentials, AwsCredentials.ProfileAwsCredentials

public abstract class AwsCredentials
extends java.lang.Object

AWS credentials to use for connecting to AWS Kinesis.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AwsCredentials.BasicAwsCredentials
static class	AwsCredentials.DefaultAwsCredentials
static class	AwsCredentials.ProfileAwsCredentials

Method Summary

Modifier and Type	Method and Description
AwsCredentials.BasicAwsCredentials	asBasic() Returns this as a AwsCredentials.BasicAwsCredentials.
AwsCredentials.ProfileAwsCredentials	asProfile() Returns this as a AwsCredentials.ProfileAwsCredentials.
static AwsCredentials	basic(java.lang.String accessKeyId, java.lang.String secretAccessKey) Specifies the AWS credentials directly with provided access key ID and secret access key strings.
static AwsCredentials	fromDefaultProviderChain() Consults AWS's default provider chain to determine the AWS credentials.
boolean	isBasic() Checks whether the credentials is specified using directly provided access key ID and secret access key strings.
boolean	isDefault() Checks whether the credentials is configured to be obtained from AWS's default provider chain.
boolean	isProfile() Checks whether the credentials is configured using AWS configuration profiles.
static AwsCredentials	profile(java.lang.String profileName) Specifies the AWS credentials using an AWS configuration profile.
static AwsCredentials	profile(java.lang.String profileName, java.lang.String profilePath) Specifies the AWS credentials using an AWS configuration profile, along with the profile's configuration path.

Methods inherited from class java.lang.Object

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

Method Detail

fromDefaultProviderChain

public static AwsCredentials fromDefaultProviderChain()

Consults AWS's default provider chain to determine the AWS credentials.

basic

public static AwsCredentials basic(java.lang.String accessKeyId,
                                   java.lang.String secretAccessKey)

Specifies the AWS credentials directly with provided access key ID and secret access key strings.

profile

public static AwsCredentials profile(java.lang.String profileName)

Specifies the AWS credentials using an AWS configuration profile.

profile

public static AwsCredentials profile(java.lang.String profileName,
                                     java.lang.String profilePath)

Specifies the AWS credentials using an AWS configuration profile, along with the profile's configuration path.

isDefault

public boolean isDefault()

Checks whether the credentials is configured to be obtained from AWS's default provider chain.

isBasic

public boolean isBasic()

Checks whether the credentials is specified using directly provided access key ID and secret access key strings.

isProfile

public boolean isProfile()

Checks whether the credentials is configured using AWS configuration profiles.

asBasic

public AwsCredentials.BasicAwsCredentials asBasic()

Returns this as a AwsCredentials.BasicAwsCredentials.

asProfile

public AwsCredentials.ProfileAwsCredentials asProfile()

Returns this as a AwsCredentials.ProfileAwsCredentials.