public interface AwsCredentialsTask
interface
for Embulk's task-defining interface.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.
|
@Config(value="auth_method") @ConfigDefault(value="\"basic\"") String getAuthMethod()
@Config(value="access_key_id") @ConfigDefault(value="null") Optional<String> getAccessKeyId()
It is available only when the authentication method is set to: "basic"
or "session"
.
AKIAIOSFODNN7EXAMPLE
)@Config(value="secret_access_key") @ConfigDefault(value="null") Optional<String> getSecretAccessKey()
It is available only when the authentication method is set to: "basic"
or "session"
.
wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
)@Config(value="session_token") @ConfigDefault(value="null") Optional<String> getSessionToken()
It is available only when the authentication method is set to: "session"
.
@Config(value="profile_file") @ConfigDefault(value="null") Optional<String> getProfileFile()
It is available only when the authentication method is set to: "profile"
.
@Config(value="profile_name") @ConfigDefault(value="null") Optional<String> getProfileName()
It is available only when the authentication method is set to: "profile"
.
void setAuthMethod(String method)
method
- One of authentication methods from "basic"
, "env"
, "instance"
,
"profile"
, "properties"
, "anonymous"
, "session"
, and "default"
.void setAccessKeyId(Optional<String> value)
It is available only when the authentication method is set to: "basic"
or "session"
.
value
- An AWS IAM access key ID to configure. (For example, AKIAIOSFODNN7EXAMPLE
)void setSecretAccessKey(Optional<String> value)
It is available only when the authentication method is set to: "basic"
or "session"
.
value
- The AWS IAM secret access key to configure. (For example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
)void setSessionToken(Optional<String> value)
It is available only when the authentication method is set to: "session"
.
value
- The AWS IAM session token to configurevoid setProfileFile(Optional<String> value)
It is available only when the authentication method is set to: "profile"
.
value
- The path to an AWS IAM profile file to configurevoid setProfileName(Optional<String> value)
It is available only when the authentication method is set to: "profile"
.
value
- The name in an AWS IAM profile file to configure