AwsCredentialsTask (embulk-util-aws-credentials v0.4.2)

```
public interface AwsCredentialsTask
```
An interface for Embulk's task-defining interface.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Optional<String>`	`getAccessKeyId()` Gets the AWS IAM access key ID configured.
`Optional<String>`	`getAccountId()` Gets the AWS Account ID configured.
`String`	`getArnPartition()` Gets the ARN Partition configured.
`String`	`getAuthMethod()` Gets the authentication method configured.
`int`	`getDurationInSeconds()` Gets the Duration in seconds configured.
`Optional<String>`	`getExternalId()` Gets the External ID 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>`	`getRoleName()` Gets the AWS Role Name configured.
`Optional<String>`	`getSecretAccessKey()` Gets the AWS IAM secret access key configured.
`String`	`getSessionName()` Gets the Role session name 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`	`setAccountId(Optional<String> value)` Sets an AWS Account ID to configure.
`void`	`setArnPartition(String value)` Sets an ARN Partition to configure.
`void`	`setAuthMethod(String method)` Sets an authentication method to configure.
`void`	`setDurationInSeconds(int value)` Sets a Duration in seconds to configure.
`void`	`setExternalId(Optional<String> value)` Sets an External ID 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`	`setRoleName(Optional<String> value)` Sets an AWS Role Name to configure.
`void`	`setSecretAccessKey(Optional<String> value)` Sets an AWS IAM secret access key to configure.
`void`	`setSessionName(String value)` Sets a Role session name 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
  - getAccountId
```
@Config(value="account_id")
 @ConfigDefault(value="null")
Optional<String> getAccountId()
```
    Gets the AWS Account ID configured.
    It is available only when the authentication method is set to: "assume_role".
    
    Returns:
    
    The AWS Account ID configured
    
    See Also:
    
    Account ID
  - getRoleName
```
@Config(value="role_name")
 @ConfigDefault(value="null")
Optional<String> getRoleName()
```
    Gets the AWS Role Name configured.
    It is available only when the authentication method is set to: "assume_role".
    
    Returns:
    
    The AWS Role Name configured
    
    See Also:
    
    Role
  - getExternalId
```
@Config(value="external_id")
 @ConfigDefault(value="null")
Optional<String> getExternalId()
```
    Gets the External ID configured.
    It is available only when the authentication method is set to: "assume_role".
    
    Returns:
    
    The External ID configured
    
    See Also:
    
    External ID
  - getDurationInSeconds
```
@Config(value="duration_in_seconds")
 @ConfigDefault(value="3600")
int getDurationInSeconds()
```
    Gets the Duration in seconds configured.
    It is available only when the authentication method is set to: "assume_role".
    
    Returns:
    
    The Duration in seconds configured
    
    See Also:
    
    Duration
  - getArnPartition
```
@Config(value="arn_partition")
 @ConfigDefault(value="\"aws\"")
String getArnPartition()
```
    Gets the ARN Partition configured.
    It is available only when the authentication method is set to: "assume_role".
    
    Returns:
    
    The ARN Partition configured
    
    See Also:
    
    Partition
  - getSessionName
```
@Config(value="session_name")
 @ConfigDefault(value="\"embulk\"")
String getSessionName()
```
    Gets the Role session name configured.
    It is available only when the authentication method is set to: "assume_role".
    
    Returns:
    
    The Roel session name configured
    
    See Also:
    
    RoleSessionName
  - 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", "assume_role", 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
  - setAccountId
```
void setAccountId(Optional<String> value)
```
    Sets an AWS Account ID to configure.
    It is available only when the authentication method is set to: "assume_role".
    
    Parameters:
    
    value - An AWS Account ID to configure. (For example, 0123456789)
    
    See Also:
    
    Account ID
  - setRoleName
```
void setRoleName(Optional<String> value)
```
    Sets an AWS Role Name to configure.
    It is available only when the authentication method is set to: "assume_role".
    
    Parameters:
    
    value - An AWS Role Name to configure. (For example, exampleRole)
    
    See Also:
    
    Role
  - setExternalId
```
void setExternalId(Optional<String> value)
```
    Sets an External ID to configure.
    It is available only when the authentication method is set to: "assume_role".
    
    Parameters:
    
    value - An External ID to configure. (For example, 9a59e793-355f-4729-abbc-ab612ee419e5)
    
    See Also:
    
    External ID
  - setDurationInSeconds
```
void setDurationInSeconds(int value)
```
    Sets a Duration in seconds to configure.
    It is available only when the authentication method is set to: "assume_role".
    
    Parameters:
    
    value - A Duration in seconds to configure. (For example, 900)
    
    See Also:
    
    Duration
  - setArnPartition
```
void setArnPartition(String value)
```
    Sets an ARN Partition to configure.
    It is available only when the authentication method is set to: "assume_role".
    
    Parameters:
    
    value - An ARN Partition to configure. (For example, aws)
    
    See Also:
    
    Partition
  - setSessionName
```
void setSessionName(String value)
```
    Sets a Role session name to configure.
    It is available only when the authentication method is set to: "assume_role".
    
    Parameters:
    
    value - A Role session name to configure. (For example, treasure-data)
    
    See Also:
    
    RoleSessionName

Interface AwsCredentialsTask

Method Summary

Method Detail

getAuthMethod

getAccessKeyId

getSecretAccessKey

getSessionToken

getProfileFile

getProfileName

getAccountId

getRoleName

getExternalId

getDurationInSeconds

getArnPartition

getSessionName

setAuthMethod

setAccessKeyId

setSecretAccessKey

setSessionToken

setProfileFile

setProfileName

setAccountId

setRoleName

setExternalId

setDurationInSeconds

setArnPartition

setSessionName