org.mule.module.s3

Class S3RoleConfig

java.lang.Object

org.mule.modules.aws.commons.CommonConfig<com.amazonaws.services.s3.AmazonS3Client>

org.mule.module.s3.S3CommonConfig

org.mule.module.s3.S3RoleConfig

@ConnectionManagement(friendlyName="Role Configuration",
                      configElementName="role-config")
public class S3RoleConfig
extends S3CommonConfig

Field Summary

Fields inherited from class org.mule.modules.aws.commons.CommonConfig

clientBuilder

Constructor Summary

Constructors

Constructor and Description
S3RoleConfig()

Method Summary

Modifier and Type	Method and Description
void	connect(String accessKey, String secretKey, String roleARN, boolean tryDefaultAWSCredentialsProviderChain) Login to Amazon S3
void	testConnect(String accessKey, String secretKey, String roleARN, boolean tryDefaultAWSCredentialsProviderChain) Test Connectivity to Amazon S3.

Methods inherited from class org.mule.module.s3.S3CommonConfig

connectionId, disconnect, getDefaultRegion, getMaxConnections, getStorageUrl, isConnected, setClientBuilder, setMaxConnections, setStorageUrl

Methods inherited from class org.mule.modules.aws.commons.CommonConfig

getAsyncClient, getClientBuilder, getConfigRegion, getConnectionTimeout, getProtocol, getProxyDomain, getProxyHost, getProxyPassword, getProxyPort, getProxyUsername, getProxyWorkstation, getSocketTimeout, getSyncClient, setConnectionTimeout, setProtocol, setProxyDomain, setProxyHost, setProxyPassword, setProxyPort, setProxyUsername, setProxyWorkstation, setSocketTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

S3RoleConfig

public S3RoleConfig()

Method Detail

connect

@Connect
public void connect(@ConnectionKey
                             String accessKey,
                             String secretKey,
                             String roleARN,
                             @Optional
                             boolean tryDefaultAWSCredentialsProviderChain)
                      throws org.mule.api.ConnectionException

Login to Amazon S3

Parameters:

accessKey - The access key provided by Amazon, needed for non anonymous operations

secretKey - The secrete key provided by Amazon, needed for non anonymous operations

roleARN - The Role ARN allows you to cross account access without using security credentials.

tryDefaultAWSCredentialsProviderChain - Set it to true to try first to obtain credentials from AWS environment. See: http://docs.aws.amazon.com/java-sdk/latest/developer-guide/credentials.html#using-the-default-credential-provider-chain

Throws:

org.mule.api.ConnectionException - Throws a Connection Exception.

testConnect

@TestConnectivity
public void testConnect(@ConnectionKey
                                          String accessKey,
                                          String secretKey,
                                          String roleARN,
                                          @Optional
                                          boolean tryDefaultAWSCredentialsProviderChain)
                                   throws org.mule.api.ConnectionException

Test Connectivity to Amazon S3. Access to operations on Amazon S3 is controlled through policies for that user. It may not always be possible to validate the credentials before the exact operation for which the user has access is done. This can vary for instance on the bucket name and other parameters. Hence the test connection may fail in case the credentials have a restricted policy such as access to a specific folder within a specific bucket.

Parameters:

accessKey - The access key provided by Amazon, needed for non anonymous operations

secretKey - The secret key provided by Amazon, needed for non anonymous operations

roleARN - The Role ARN allows you to cross account access without using security credentials. //TODO check if the following parameter description is correct.

tryDefaultAWSCredentialsProviderChain - Try Default AWS Credentials Provider Chain (Boolean).

Throws:

org.mule.api.ConnectionException - Throws a Connection Exception.