org.embulk.util.aws.credentials

Interface AwsCredentialsTask

public interface AwsCredentialsTask

An interface for Embulk's task-defining interface.

Method Summary

Modifier and Type	Method and Description
Optional<String>	getAccessKeyId() Gets the AWS IAM access key ID configured.
String	getAuthMethod() Gets the authentication method configured.
Optional<String>	getProfileFile() Gets the path to an AWS IAM profile file configured.
Optional<String>	getProfileName() Gets the name in an AWS IAM profile file configured.
Optional<String>	getSecretAccessKey() Gets the AWS IAM secret access key configured.
Optional<String>	getSessionToken() Gets the AWS IAM session token configured.
void	setAccessKeyId(Optional<String> value) Sets an AWS IAM access key ID to configure.
void	setAuthMethod(String method) Sets an authentication method to configure.
void	setProfileFile(Optional<String> value) Sets a path to an AWS IAM profile file to configure.
void	setProfileName(Optional<String> value) Sets a name in an AWS IAM profile file to configure.
void	setSecretAccessKey(Optional<String> value) Sets an AWS IAM secret access key to configure.
void	setSessionToken(Optional<String> value) Sets an AWS IAM session token to configure.

Method Detail

getAuthMethod

@Config(value="auth_method")
 @ConfigDefault(value="\"basic\"")
String getAuthMethod()

Gets the authentication method configured.

Returns:

The authentication method configured.

getAccessKeyId

@Config(value="access_key_id")
 @ConfigDefault(value="null")
Optional<String> getAccessKeyId()

Gets the AWS IAM access key ID configured.

It is available only when the authentication method is set to: "basic" or "session".

Returns:

The AWS IAM access key ID configured. (For example, AKIAIOSFODNN7EXAMPLE)

See Also:

Managing Access Keys for IAM Users

getSecretAccessKey

@Config(value="secret_access_key")
 @ConfigDefault(value="null")
Optional<String> getSecretAccessKey()

Gets the AWS IAM secret access key configured.

It is available only when the authentication method is set to: "basic" or "session".

Returns:

The AWS IAM secret access key configured. (For example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY)

See Also:

Managing Access Keys for IAM Users

getSessionToken

@Config(value="session_token")
 @ConfigDefault(value="null")
Optional<String> getSessionToken()

Gets the AWS IAM session token configured.

It is available only when the authentication method is set to: "session".

Returns:

The AWS IAM session token configured.

See Also:

Using Temporary Credentials With AWS Resources

getProfileFile

@Config(value="profile_file")
 @ConfigDefault(value="null")
Optional<String> getProfileFile()

Gets the path to an AWS IAM profile file configured.

It is available only when the authentication method is set to: "profile".

Returns:

The path to an AWS IAM profile file configured

See Also:

Named profiles

getProfileName

@Config(value="profile_name")
 @ConfigDefault(value="null")
Optional<String> getProfileName()

Gets the name in an AWS IAM profile file configured.

It is available only when the authentication method is set to: "profile".

Returns:

The name in an AWS IAM profile file configured

See Also:

Named profiles

setAuthMethod

void setAuthMethod(String method)

Sets an authentication method to configure.

Parameters:

method - One of authentication methods from "basic", "env", "instance", "profile", "properties", "anonymous", "session", and "default".

setAccessKeyId

void setAccessKeyId(Optional<String> value)

Sets an AWS IAM access key ID to configure.

It is available only when the authentication method is set to: "basic" or "session".

Parameters:

value - An AWS IAM access key ID to configure. (For example, AKIAIOSFODNN7EXAMPLE)

See Also:

Managing Access Keys for IAM Users

setSecretAccessKey

void setSecretAccessKey(Optional<String> value)

Sets an AWS IAM secret access key to configure.

It is available only when the authentication method is set to: "basic" or "session".

Parameters:

value - The AWS IAM secret access key to configure. (For example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY)

See Also:

Managing Access Keys for IAM Users

setSessionToken

void setSessionToken(Optional<String> value)

Sets an AWS IAM session token to configure.

It is available only when the authentication method is set to: "session".

Parameters:

value - The AWS IAM session token to configure

See Also:

Using Temporary Credentials With AWS Resources

setProfileFile

void setProfileFile(Optional<String> value)

Sets a path to an AWS IAM profile file to configure.

It is available only when the authentication method is set to: "profile".

Parameters:

value - The path to an AWS IAM profile file to configure

See Also:

Named profiles

setProfileName

void setProfileName(Optional<String> value)

Sets a name in an AWS IAM profile file to configure.

It is available only when the authentication method is set to: "profile".

Parameters:

value - The name in an AWS IAM profile file to configure

See Also:

Named profiles