public abstract class AWSConnection extends AdaptrisConnectionImp implements AWSCredentialsProviderBuilder.BuilderConfig
log
Constructor and Description |
---|
AWSConnection() |
Modifier and Type | Method and Description |
---|---|
KeyValuePairSet |
clientConfiguration() |
AWSCredentialsProviderBuilder |
credentialsProvider() |
EndpointBuilder |
endpointBuilder()
Returns something that can configure a normal AWS builder with a custom endpoint or a region...
|
KeyValuePairSet |
getClientConfiguration()
Any specific client configuration.
|
AWSCredentialsProviderBuilder |
getCredentials()
How to provide Credentials for AWS.
|
CustomEndpoint |
getCustomEndpoint()
The custom endpoint for this connection.
|
java.lang.String |
getRegion()
Set the region for the client.
|
RetryPolicyFactory |
getRetryPolicy()
The Retry policy.
|
RetryPolicyFactory |
retryPolicy() |
void |
setClientConfiguration(KeyValuePairSet clientConfiguration)
Any specific client configuration.
|
void |
setCredentials(AWSCredentialsProviderBuilder credentials)
How to provide Credentials for AWS.
|
void |
setCustomEndpoint(CustomEndpoint customEndpoint)
The custom endpoint for this connection.
|
void |
setRegion(java.lang.String region)
Set the region for the client.
|
void |
setRetryPolicy(RetryPolicyFactory retryPolicy)
The Retry policy.
|
<T extends AWSConnection> |
withClientConfiguration(KeyValuePairSet cfg) |
<T extends AWSConnection> |
withCredentialsProviderBuilder(AWSCredentialsProviderBuilder builder) |
<T extends AWSConnection> |
withCustomEndpoint(CustomEndpoint endpoint) |
<T extends AWSConnection> |
withRegion(java.lang.String s) |
<T extends AWSConnection> |
withRetryPolicy(RetryPolicyFactory f) |
addExceptionListener, addMessageConsumer, addMessageProducer, changeState, cloneForTesting, close, closeConnection, connectionErrorHandler, getConnectionErrorHandler, getUniqueId, getWorkersFirstOnShutdown, init, initConnection, prepare, prepareConnection, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, retrieveConnection, retrieveExceptionListeners, retrieveMessageConsumers, retrieveMessageProducers, setConnectionErrorHandler, setUniqueId, setWorkersFirstOnShutdown, start, startConnection, stop, stopConnection, workersFirstOnShutdown
public AWSCredentialsProviderBuilder credentialsProvider()
public KeyValuePairSet clientConfiguration()
clientConfiguration
in interface AWSCredentialsProviderBuilder.BuilderConfig
public RetryPolicyFactory retryPolicy()
retryPolicy
in interface AWSCredentialsProviderBuilder.BuilderConfig
public <T extends AWSConnection> T withCustomEndpoint(CustomEndpoint endpoint)
public <T extends AWSConnection> T withCredentialsProviderBuilder(AWSCredentialsProviderBuilder builder)
public <T extends AWSConnection> T withClientConfiguration(KeyValuePairSet cfg)
public <T extends AWSConnection> T withRetryPolicy(RetryPolicyFactory f)
public <T extends AWSConnection> T withRegion(java.lang.String s)
public EndpointBuilder endpointBuilder()
endpointBuilder
in interface AWSCredentialsProviderBuilder.BuilderConfig
public java.lang.String getRegion()
If the region is not specified, then DefaultAwsRegionProviderChain
is used to determine
the region. You can always specify a region using the standard system property aws.region
or via environment variables.
public void setRegion(java.lang.String region)
If the region is not specified, then DefaultAwsRegionProviderChain
is used to determine
the region. You can always specify a region using the standard system property aws.region
or via environment variables.
public AWSCredentialsProviderBuilder getCredentials()
If not specified, then a static credentials provider with a default provider chain will be used.
public void setCredentials(AWSCredentialsProviderBuilder credentials)
If not specified, then a static credentials provider with a default provider chain will be used.
public KeyValuePairSet getClientConfiguration()
public void setClientConfiguration(KeyValuePairSet clientConfiguration)
public RetryPolicyFactory getRetryPolicy()
public void setRetryPolicy(RetryPolicyFactory retryPolicy)
public CustomEndpoint getCustomEndpoint()
Generally speaking, you don't need to configure this; use setRegion(String)
instead.
This is only required if you are planning to use a non-standard service endpoint such as
localstack to provide AWS services.
Explicitly configuring this means that your setRegion(String)
will have no effect (i.e.
AwsClientBuilder#setRegion(String)
will never be invoked.
public void setCustomEndpoint(CustomEndpoint customEndpoint)
Generally speaking, you don't need to configure this; use setRegion(String)
instead.
This is only required if you are planning to use a non-standard service endpoint such as
localstack to provide AWS services.
Explicitly configuring this means that your setRegion(String)
will have no effect (i.e.
AwsClientBuilder#setRegion(String)
will never be invoked.