Package software.amazon.awssdk.client.builder

Interface ClientBuilder<B extends ClientBuilder<B,C>,C>

Type Parameters:

B - The type of builder that should be returned by the fluent builder methods in this interface.

C - The type of client generated by this builder.

All Superinterfaces:

SdkBuilder<B,C>

All Known Subinterfaces:

ACMAsyncClientBuilder, ACMBaseClientBuilder<B,C>, ACMClientBuilder, APIGatewayAsyncClientBuilder, APIGatewayBaseClientBuilder<B,C>, APIGatewayClientBuilder, ApiGatewayProtocolBaseClientBuilder<B,C>, ApiGatewayProtocolClientBuilder, ApplicationAutoScalingAsyncClientBuilder, ApplicationAutoScalingBaseClientBuilder<B,C>, ApplicationAutoScalingClientBuilder, ApplicationDiscoveryAsyncClientBuilder, ApplicationDiscoveryBaseClientBuilder<B,C>, ApplicationDiscoveryClientBuilder, AppStreamAsyncClientBuilder, AppStreamBaseClientBuilder<B,C>, AppStreamClientBuilder, AsyncClientBuilder<B,C>, AthenaAsyncClientBuilder, AthenaBaseClientBuilder<B,C>, AthenaClientBuilder, AutoScalingAsyncClientBuilder, AutoScalingBaseClientBuilder<B,C>, AutoScalingClientBuilder, BatchAsyncClientBuilder, BatchBaseClientBuilder<B,C>, BatchClientBuilder, BudgetsAsyncClientBuilder, BudgetsBaseClientBuilder<B,C>, BudgetsClientBuilder, CloudDirectoryAsyncClientBuilder, CloudDirectoryBaseClientBuilder<B,C>, CloudDirectoryClientBuilder, CloudFormationAsyncClientBuilder, CloudFormationBaseClientBuilder<B,C>, CloudFormationClientBuilder, CloudFrontAsyncClientBuilder, CloudFrontBaseClientBuilder<B,C>, CloudFrontClientBuilder, CloudHSMAsyncClientBuilder, CloudHSMBaseClientBuilder<B,C>, CloudHSMClientBuilder, CloudSearchAsyncClientBuilder, CloudSearchBaseClientBuilder<B,C>, CloudSearchClientBuilder, CloudSearchDomainAsyncClientBuilder, CloudSearchDomainBaseClientBuilder<B,C>, CloudSearchDomainClientBuilder, CloudTrailAsyncClientBuilder, CloudTrailBaseClientBuilder<B,C>, CloudTrailClientBuilder, CloudWatchAsyncClientBuilder, CloudWatchBaseClientBuilder<B,C>, CloudWatchClientBuilder, CloudWatchEventsAsyncClientBuilder, CloudWatchEventsBaseClientBuilder<B,C>, CloudWatchEventsClientBuilder, CloudWatchLogsAsyncClientBuilder, CloudWatchLogsBaseClientBuilder<B,C>, CloudWatchLogsClientBuilder, CodeBuildAsyncClientBuilder, CodeBuildBaseClientBuilder<B,C>, CodeBuildClientBuilder, CodeCommitAsyncClientBuilder, CodeCommitBaseClientBuilder<B,C>, CodeCommitClientBuilder, CodeDeployAsyncClientBuilder, CodeDeployBaseClientBuilder<B,C>, CodeDeployClientBuilder, CodePipelineAsyncClientBuilder, CodePipelineBaseClientBuilder<B,C>, CodePipelineClientBuilder, CodeStarAsyncClientBuilder, CodeStarBaseClientBuilder<B,C>, CodeStarClientBuilder, CognitoIdentityAsyncClientBuilder, CognitoIdentityBaseClientBuilder<B,C>, CognitoIdentityClientBuilder, CognitoIdentityProviderAsyncClientBuilder, CognitoIdentityProviderBaseClientBuilder<B,C>, CognitoIdentityProviderClientBuilder, CognitoSyncAsyncClientBuilder, CognitoSyncBaseClientBuilder<B,C>, CognitoSyncClientBuilder, ConfigAsyncClientBuilder, ConfigBaseClientBuilder<B,C>, ConfigClientBuilder, CostandUsageReportAsyncClientBuilder, CostandUsageReportBaseClientBuilder<B,C>, CostandUsageReportClientBuilder, DatabaseMigrationAsyncClientBuilder, DatabaseMigrationBaseClientBuilder<B,C>, DatabaseMigrationClientBuilder, DataPipelineAsyncClientBuilder, DataPipelineBaseClientBuilder<B,C>, DataPipelineClientBuilder, DAXAsyncClientBuilder, DAXBaseClientBuilder<B,C>, DAXClientBuilder, DeviceFarmAsyncClientBuilder, DeviceFarmBaseClientBuilder<B,C>, DeviceFarmClientBuilder, DirectConnectAsyncClientBuilder, DirectConnectBaseClientBuilder<B,C>, DirectConnectClientBuilder, DirectoryAsyncClientBuilder, DirectoryBaseClientBuilder<B,C>, DirectoryClientBuilder, DynamoDBAsyncClientBuilder, DynamoDBBaseClientBuilder<B,C>, DynamoDBClientBuilder, DynamoDBStreamsAsyncClientBuilder, DynamoDBStreamsBaseClientBuilder<B,C>, DynamoDBStreamsClientBuilder, EC2AsyncClientBuilder, EC2BaseClientBuilder<B,C>, EC2ClientBuilder, ECRAsyncClientBuilder, ECRBaseClientBuilder<B,C>, ECRClientBuilder, ECSAsyncClientBuilder, ECSBaseClientBuilder<B,C>, ECSClientBuilder, EFSAsyncClientBuilder, EFSBaseClientBuilder<B,C>, EFSClientBuilder, ElastiCacheAsyncClientBuilder, ElastiCacheBaseClientBuilder<B,C>, ElastiCacheClientBuilder, ElasticBeanstalkAsyncClientBuilder, ElasticBeanstalkBaseClientBuilder<B,C>, ElasticBeanstalkClientBuilder, ElasticLoadBalancingAsyncClientBuilder, ElasticLoadBalancingBaseClientBuilder<B,C>, ElasticLoadBalancingClientBuilder, ElasticLoadBalancingv2AsyncClientBuilder, ElasticLoadBalancingv2BaseClientBuilder<B,C>, ElasticLoadBalancingv2ClientBuilder, ElasticsearchAsyncClientBuilder, ElasticsearchBaseClientBuilder<B,C>, ElasticsearchClientBuilder, ElasticTranscoderAsyncClientBuilder, ElasticTranscoderBaseClientBuilder<B,C>, ElasticTranscoderClientBuilder, EMRAsyncClientBuilder, EMRBaseClientBuilder<B,C>, EMRClientBuilder, FirehoseAsyncClientBuilder, FirehoseBaseClientBuilder<B,C>, FirehoseClientBuilder, GameLiftAsyncClientBuilder, GameLiftBaseClientBuilder<B,C>, GameLiftClientBuilder, GlacierAsyncClientBuilder, GlacierBaseClientBuilder<B,C>, GlacierClientBuilder, GreengrassAsyncClientBuilder, GreengrassBaseClientBuilder<B,C>, GreengrassClientBuilder, HealthAsyncClientBuilder, HealthBaseClientBuilder<B,C>, HealthClientBuilder, IAMAsyncClientBuilder, IAMBaseClientBuilder<B,C>, IAMClientBuilder, ImportExportAsyncClientBuilder, ImportExportBaseClientBuilder<B,C>, ImportExportClientBuilder, InspectorAsyncClientBuilder, InspectorBaseClientBuilder<B,C>, InspectorClientBuilder, IoTAsyncClientBuilder, IoTBaseClientBuilder<B,C>, IoTClientBuilder, IoTDataPlaneAsyncClientBuilder, IoTDataPlaneBaseClientBuilder<B,C>, IoTDataPlaneClientBuilder, KinesisAnalyticsAsyncClientBuilder, KinesisAnalyticsBaseClientBuilder<B,C>, KinesisAnalyticsClientBuilder, KinesisAsyncClientBuilder, KinesisBaseClientBuilder<B,C>, KinesisClientBuilder, KMSAsyncClientBuilder, KMSBaseClientBuilder<B,C>, KMSClientBuilder, LambdaAsyncClientBuilder, LambdaBaseClientBuilder<B,C>, LambdaClientBuilder, LexModelBuildingAsyncClientBuilder, LexModelBuildingBaseClientBuilder<B,C>, LexModelBuildingClientBuilder, LightsailAsyncClientBuilder, LightsailBaseClientBuilder<B,C>, LightsailClientBuilder, MachineLearningAsyncClientBuilder, MachineLearningBaseClientBuilder<B,C>, MachineLearningClientBuilder, MarketplaceCommerceAnalyticsAsyncClientBuilder, MarketplaceCommerceAnalyticsBaseClientBuilder<B,C>, MarketplaceCommerceAnalyticsClientBuilder, MarketplaceEntitlementAsyncClientBuilder, MarketplaceEntitlementBaseClientBuilder<B,C>, MarketplaceEntitlementClientBuilder, MarketplaceMeteringAsyncClientBuilder, MarketplaceMeteringBaseClientBuilder<B,C>, MarketplaceMeteringClientBuilder, MTurkAsyncClientBuilder, MTurkBaseClientBuilder<B,C>, MTurkClientBuilder, OpsWorksAsyncClientBuilder, OpsWorksBaseClientBuilder<B,C>, OpsWorksClientBuilder, OpsWorksCMAsyncClientBuilder, OpsWorksCMBaseClientBuilder<B,C>, OpsWorksCMClientBuilder, OrganizationsAsyncClientBuilder, OrganizationsBaseClientBuilder<B,C>, OrganizationsClientBuilder, PinpointAsyncClientBuilder, PinpointBaseClientBuilder<B,C>, PinpointClientBuilder, PollyAsyncClientBuilder, PollyBaseClientBuilder<B,C>, PollyClientBuilder, RDSAsyncClientBuilder, RDSBaseClientBuilder<B,C>, RDSClientBuilder, RedshiftAsyncClientBuilder, RedshiftBaseClientBuilder<B,C>, RedshiftClientBuilder, RekognitionAsyncClientBuilder, RekognitionBaseClientBuilder<B,C>, RekognitionClientBuilder, ResourceGroupsTaggingAPIAsyncClientBuilder, ResourceGroupsTaggingAPIBaseClientBuilder<B,C>, ResourceGroupsTaggingAPIClientBuilder, Route53AsyncClientBuilder, Route53BaseClientBuilder<B,C>, Route53ClientBuilder, Route53DomainsAsyncClientBuilder, Route53DomainsBaseClientBuilder<B,C>, Route53DomainsClientBuilder, S3AsyncClientBuilder, S3BaseClientBuilder<B,C>, S3ClientBuilder, ServiceCatalogAsyncClientBuilder, ServiceCatalogBaseClientBuilder<B,C>, ServiceCatalogClientBuilder, SESAsyncClientBuilder, SESBaseClientBuilder<B,C>, SESClientBuilder, SFNAsyncClientBuilder, SFNBaseClientBuilder<B,C>, SFNClientBuilder, ShieldAsyncClientBuilder, ShieldBaseClientBuilder<B,C>, ShieldClientBuilder, SimpleDBAsyncClientBuilder, SimpleDBBaseClientBuilder<B,C>, SimpleDBClientBuilder, SMSAsyncClientBuilder, SMSBaseClientBuilder<B,C>, SMSClientBuilder, SnowballAsyncClientBuilder, SnowballBaseClientBuilder<B,C>, SnowballClientBuilder, SNSAsyncClientBuilder, SNSBaseClientBuilder<B,C>, SNSClientBuilder, SQSAsyncClientBuilder, SQSBaseClientBuilder<B,C>, SQSClientBuilder, SSMAsyncClientBuilder, SSMBaseClientBuilder<B,C>, SSMClientBuilder, StorageGatewayAsyncClientBuilder, StorageGatewayBaseClientBuilder<B,C>, StorageGatewayClientBuilder, STSAsyncClientBuilder, STSBaseClientBuilder<B,C>, STSClientBuilder, SupportAsyncClientBuilder, SupportBaseClientBuilder<B,C>, SupportClientBuilder, SWFAsyncClientBuilder, SWFBaseClientBuilder<B,C>, SWFClientBuilder, SyncClientBuilder<B,C>, WAFAsyncClientBuilder, WAFBaseClientBuilder<B,C>, WAFClientBuilder, WAFRegionalAsyncClientBuilder, WAFRegionalBaseClientBuilder<B,C>, WAFRegionalClientBuilder, WorkDocsAsyncClientBuilder, WorkDocsBaseClientBuilder<B,C>, WorkDocsClientBuilder, WorkSpacesAsyncClientBuilder, WorkSpacesBaseClientBuilder<B,C>, WorkSpacesClientBuilder, XRayAsyncClientBuilder, XRayBaseClientBuilder<B,C>, XRayClientBuilder

All Known Implementing Classes:

DefaultClientBuilder

public interface ClientBuilder<B extends ClientBuilder<B,C>,C>
extends SdkBuilder<B,C>

This includes required and optional override configuration required by every client builder. An instance can be acquired by calling the static "builder" method on the type of client you wish to create.

Implementations of this interface are mutable and not thread-safe.

Method Summary

Modifier and Type	Method	Description
B	credentialsProvider(AwsCredentialsProvider credentialsProvider)	Configure the credentials that should be used to authenticate with AWS.
B	endpointOverride(URI endpointOverride)	Configure the endpoint with which the SDK should communicate.
B	overrideConfiguration(ClientOverrideConfiguration overrideConfiguration)	Specify overrides to the default SDK configuration that should be used for clients created by this builder.
B	region(Region region)	Configure the region with which the SDK should communicate.

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

overrideConfiguration

B overrideConfiguration(ClientOverrideConfiguration overrideConfiguration)

Specify overrides to the default SDK configuration that should be used for clients created by this builder.

credentialsProvider

B credentialsProvider(AwsCredentialsProvider credentialsProvider)

Configure the credentials that should be used to authenticate with AWS.

The default provider will attempt to identify the credentials automatically using the following checks:

1. Java System Properties - aws.accessKeyId and aws.secretKey
2. Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
3. Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
4. Credentials delivered through the Amazon EC2 container service if AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set and security manager has permission to access the variable.
5. Instance profile credentials delivered through the Amazon EC2 metadata service

If the credentials are not found in any of the locations above, an exception will be thrown at SdkBuilder.build() time.

endpointOverride

B endpointOverride(URI endpointOverride)

Configure the endpoint with which the SDK should communicate. This will take precedent over the endpoint derived from the region(Region). Even when this is used, the region(Region) must still be specified for the purposes of message signing.

region

B region(Region region)

Configure the region with which the SDK should communicate.

If this is not specified, the SDK will attempt to identify the endpoint automatically using the following logic:

1. Check the 'aws.region' system property for the region.
2. Check the 'AWS_REGION' environment variable for the region.
3. Check the {user.home}/.aws/credentials and {user.home}/.aws/config files for the region.
4. If running in EC2, check the EC2 metadata service for the region.