AwsClientBuilder (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.client.builder

Class AwsClientBuilder<Subclass extends AwsClientBuilder,TypeToBuild>

java.lang.Object
- com.amazonaws.client.builder.AwsClientBuilder<Subclass,TypeToBuild>

Type Parameters:

Subclass - Concrete builder type, used for better fluent methods.

TypeToBuild - Type that this builder builds.

Direct Known Subclasses:

AwsAsyncClientBuilder, AwsSyncClientBuilder
```
@NotThreadSafe
public abstract class AwsClientBuilder<Subclass extends AwsClientBuilder,TypeToBuild>
extends Object 
```
Base class for all service specific client builders.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AwsClientBuilder.EndpointConfiguration` A container for configuration required to submit requests to a service (service endpoint and signing region)

Method Summary

All Methods
Modifier and Type	Method and Description
`abstract TypeToBuild`	`build ()` Builds a client with the configure properties.
`ClientConfiguration`	`getClientConfiguration ()` Gets the ClientConfiguration currently configured in the builder
`CsmConfigurationProvider`	`getClientSideMonitoringConfigurationProvider ()`
`AWSCredentialsProvider`	`getCredentials ()` Gets the AWSCredentialsProvider currently configured in the builder.
`AwsClientBuilder.EndpointConfiguration`	`getEndpoint ()` Gets the service endpointConfiguration in use by the builder
`RequestMetricCollector`	`getMetricsCollector ()` Gets the `RequestMetricCollector` in use by the builder.
`MonitoringListener`	`getMonitoringListener ()` Gets the `MonitoringListener` in use by the builder.
`String`	`getRegion ()` Gets the region in use by the builder.
`List<RequestHandler2>`	`getRequestHandlers ()` Gets the list of request handlers in use by the builder.
`void`	`setClientConfiguration (ClientConfiguration config)` Sets the ClientConfiguration to be used by the client.
`void`	`setClientSideMonitoringConfigurationProvider (CsmConfigurationProvider csmConfig)`
`void`	`setCredentials (AWSCredentialsProvider credentialsProvider)` Sets the AWSCredentialsProvider used by the client.
`void`	`setEndpointConfiguration (AwsClientBuilder.EndpointConfiguration endpointConfiguration)` Sets the endpoint configuration (service endpoint & signing region) to be used for requests.
`void`	`setMetricsCollector (RequestMetricCollector metrics)` Sets a custom RequestMetricCollector to use for the client.
`void`	`setMonitoringListener (MonitoringListener monitoringListener)` Sets a custom MonitoringListener to use for the client.
`void`	`setRegion (String region)` Sets the region to be used by the client.
`void`	`setRequestHandlers (RequestHandler2... handlers)` Sets the request handlers to use in the client.
`Subclass`	`withClientConfiguration (ClientConfiguration config)` Sets the ClientConfiguration to be used by the client.
`Subclass`	`withClientSideMonitoringConfigurationProvider (CsmConfigurationProvider csmConfig)`
`Subclass`	`withCredentials (AWSCredentialsProvider credentialsProvider)` Sets the AWSCredentialsProvider used by the client.
`Subclass`	`withEndpointConfiguration (AwsClientBuilder.EndpointConfiguration endpointConfiguration)` Sets the endpoint configuration (service endpoint & signing region) to be used for requests.
`Subclass`	`withMetricsCollector (RequestMetricCollector metrics)` Sets a custom RequestMetricCollector to use for the client.
`Subclass`	`withMonitoringListener (MonitoringListener monitoringListener)` Sets a custom MonitoringListener to use for the client.
`Subclass`	`withRegion (Regions region)` Sets the region to be used by the client.
`Subclass`	`withRegion (String region)` Sets the region to be used by the client.
`Subclass`	`withRequestHandlers (RequestHandler2... handlers)` Sets the request handlers to use in the client.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getCredentials
```
public final AWSCredentialsProvider getCredentials()
```
    Gets the AWSCredentialsProvider currently configured in the builder.
  - setCredentials
```
public final void setCredentials(AWSCredentialsProvider credentialsProvider)
```
    Sets the AWSCredentialsProvider used by the client. If not specified the default is DefaultAWSCredentialsProviderChain.
    
    Parameters:
    
    credentialsProvider - New AWSCredentialsProvider to use.
  - withCredentials
```
public final Subclass withCredentials(AWSCredentialsProvider credentialsProvider)
```
    Sets the AWSCredentialsProvider used by the client. If not specified the default is DefaultAWSCredentialsProviderChain.
    
    Parameters:
    
    credentialsProvider - New AWSCredentialsProvider to use.
    
    Returns:
    
    This object for method chaining.
  - getClientConfiguration
```
public final ClientConfiguration getClientConfiguration()
```
    Gets the ClientConfiguration currently configured in the builder
  - setClientConfiguration
```
public final void setClientConfiguration(ClientConfiguration config)
```
    Sets the ClientConfiguration to be used by the client. If not specified the default is typically PredefinedClientConfigurations.defaultConfig() but may differ per service.
    
    Parameters:
    
    config - Custom configuration to use
  - withClientConfiguration
```
public final Subclass withClientConfiguration(ClientConfiguration config)
```
    Sets the ClientConfiguration to be used by the client. If not specified the default is typically PredefinedClientConfigurations.defaultConfig() but may differ per service.
    
    Parameters:
    
    config - Custom configuration to use
    
    Returns:
    
    This object for method chaining.
  - getMetricsCollector
```
public final RequestMetricCollector getMetricsCollector()
```
    Gets the RequestMetricCollector in use by the builder.
  - setMetricsCollector
```
public final void setMetricsCollector(RequestMetricCollector metrics)
```
    Sets a custom RequestMetricCollector to use for the client.
    
    Parameters:
    
    metrics - Custom RequestMetricCollector to use.
  - withMetricsCollector
```
public final Subclass withMetricsCollector(RequestMetricCollector metrics)
```
    Sets a custom RequestMetricCollector to use for the client.
    
    Parameters:
    
    metrics - Custom RequestMetricCollector to use.
    
    Returns:
    
    This object for method chaining.
  - getRegion
```
public final String getRegion()
```
    Gets the region in use by the builder.
  - setRegion
```
public final void setRegion(String region)
```
    Sets the region to be used by the client. This will be used to determine both the service endpoint (eg: https://sns.us-west-1.amazonaws.com) and signing region (eg: us-west-1) for requests. If neither region or endpoint configuration setEndpointConfiguration(EndpointConfiguration) are explicitly provided in the builder the DEFAULT_REGION_PROVIDER is consulted.
    
    Parameters:
    
    region - Region to use
  - withRegion
```
public final Subclass withRegion(Regions region)
```
    Sets the region to be used by the client. This will be used to determine both the service endpoint (eg: https://sns.us-west-1.amazonaws.com) and signing region (eg: us-west-1) for requests. If neither region or endpoint configuration setEndpointConfiguration(EndpointConfiguration) are explicitly provided in the builder the DEFAULT_REGION_PROVIDER is consulted.
    For regions not explicitly in the Regions enum use the withRegion(String) overload.
    
    Parameters:
    
    region - Region to use
    
    Returns:
    
    This object for method chaining.
  - withRegion
```
public final Subclass withRegion(String region)
```
    Sets the region to be used by the client. This will be used to determine both the service endpoint (eg: https://sns.us-west-1.amazonaws.com) and signing region (eg: us-west-1) for requests. If neither region or endpoint configuration setEndpointConfiguration(EndpointConfiguration) are explicitly provided in the builder the DEFAULT_REGION_PROVIDER is consulted.
    
    Parameters:
    
    region - Region to use
    
    Returns:
    
    This object for method chaining.
  - getEndpoint
```
public final AwsClientBuilder.EndpointConfiguration getEndpoint()
```
    Gets the service endpointConfiguration in use by the builder
  - setEndpointConfiguration
```
public final void setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration endpointConfiguration)
```
    Sets the endpoint configuration (service endpoint & signing region) to be used for requests. If neither region setRegion(String) or endpoint configuration are explicitly provided in the builder the DEFAULT_REGION_PROVIDER is consulted.
    Only use this if using a non-standard service endpoint - the recommended approach for configuring a client is to use setRegion(String)
    
    Parameters:
    
    endpointConfiguration - The endpointConfiguration to use
  - withEndpointConfiguration
```
public final Subclass withEndpointConfiguration(AwsClientBuilder.EndpointConfiguration endpointConfiguration)
```
    Sets the endpoint configuration (service endpoint & signing region) to be used for requests. If neither region withRegion(String) or endpoint configuration are explicitly provided in the builder the DEFAULT_REGION_PROVIDER is consulted.
    Only use this if using a non-standard service endpoint - the recommended approach for configuring a client is to use withRegion(String)
    
    Parameters:
    
    endpointConfiguration - The endpointConfiguration to use
    
    Returns:
    
    This object for method chaining.
  - getRequestHandlers
```
public final List<RequestHandler2> getRequestHandlers()
```
    Gets the list of request handlers in use by the builder.
  - setRequestHandlers
```
public final void setRequestHandlers(RequestHandler2... handlers)
```
    Sets the request handlers to use in the client.
    
    Parameters:
    
    handlers - Request handlers to use for client.
  - withRequestHandlers
```
public final Subclass withRequestHandlers(RequestHandler2... handlers)
```
    Sets the request handlers to use in the client.
    
    Parameters:
    
    handlers - Request handlers to use for client.
    
    Returns:
    
    This object for method chaining.
  - getMonitoringListener
```
public final MonitoringListener getMonitoringListener()
```
    Gets the MonitoringListener in use by the builder.
  - setMonitoringListener
```
public final void setMonitoringListener(MonitoringListener monitoringListener)
```
    Sets a custom MonitoringListener to use for the client.
    
    Parameters:
    
    monitoringListener - Custom Monitoring Listener to use.
  - withMonitoringListener
```
public final Subclass withMonitoringListener(MonitoringListener monitoringListener)
```
    Sets a custom MonitoringListener to use for the client.
    
    Parameters:
    
    monitoringListener - Custom MonitoringListener to use.
    
    Returns:
    
    This object for method chaining.
  - getClientSideMonitoringConfigurationProvider
```
public CsmConfigurationProvider getClientSideMonitoringConfigurationProvider()
```
  - setClientSideMonitoringConfigurationProvider
```
public void setClientSideMonitoringConfigurationProvider(CsmConfigurationProvider csmConfig)
```
  - withClientSideMonitoringConfigurationProvider
```
public Subclass withClientSideMonitoringConfigurationProvider(CsmConfigurationProvider csmConfig)
```
  - build
```
public abstract TypeToBuild build()
```
    Builds a client with the configure properties.
    
    Returns:
    
    Client instance to make API calls with.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class AwsClientBuilder<Subclass extends AwsClientBuilder,TypeToBuild>

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getCredentials

setCredentials

withCredentials

getClientConfiguration

setClientConfiguration

withClientConfiguration

getMetricsCollector

setMetricsCollector

withMetricsCollector

getRegion

setRegion

withRegion

withRegion

getEndpoint

setEndpointConfiguration

withEndpointConfiguration

getRequestHandlers

setRequestHandlers

withRequestHandlers

getMonitoringListener

setMonitoringListener

withMonitoringListener

getClientSideMonitoringConfigurationProvider

setClientSideMonitoringConfigurationProvider

withClientSideMonitoringConfigurationProvider

build