org.mule.modules.sqs

Class SQSRoleConfig

java.lang.Object

org.mule.modules.aws.CommonConfig<com.amazonaws.services.sqs.AmazonSQSClient>

org.mule.modules.sqs.SQSCommonConfig

org.mule.modules.sqs.SQSRoleConfig

@ReconnectOn(exceptions=SQSConnectorException.class)
 @ConnectionManagement(friendlyName="Role Configuration",
                      configElementName="role-config")
public class SQSRoleConfig
extends SQSCommonConfig

Field Summary

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

clientBuilder

Constructor Summary

Constructors

Constructor and Description
SQSRoleConfig()

Method Summary

Modifier and Type	Method and Description
void	connect(String accessKey, String secretKey, String roleARN, boolean tryDefaultAWSCredentialsProviderChain)
void	testConnect(String accessKey, String secretKey, String roleARN, boolean tryDefaultAWSCredentialsProviderChain)

Methods inherited from class org.mule.modules.sqs.SQSCommonConfig

disconnect, getConfigRegion, getConnectionId, getDefaultQueueName, getDefaultRegion, getRegion, getUrl, getUrl, isConnected, setClientBuilder, setDefaultQueueName, setRegion, setUrl

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

getAsyncClient, getClientBuilder, 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

SQSRoleConfig

public SQSRoleConfig()

Method Detail

connect

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

Parameters:

accessKey - AWS access key

secretKey - AWS secret key

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 - If a connection cannot be made due to invalid credentials or if a network connection is not available.

testConnect

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

Parameters:

accessKey - AWS access key

secretKey - AWS secret key

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 - If a connection cannot be made due to invalid credentials or if a network connection is not available.