software.amazon.awssdk.awscore.client.builder

Interface AwsClientBuilder<BuilderT extends AwsClientBuilder<BuilderT,ClientT>,ClientT>

Type Parameters:

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

ClientT - The type of client generated by this builder.

All Superinterfaces:

SdkBuilder<BuilderT,ClientT>, SdkClientBuilder<BuilderT,ClientT>

All Known Subinterfaces:

AcmAsyncClientBuilder, AcmBaseClientBuilder<B,C>, AcmClientBuilder, AlexaForBusinessAsyncClientBuilder, AlexaForBusinessBaseClientBuilder<B,C>, AlexaForBusinessClientBuilder, ApiGatewayAsyncClientBuilder, ApiGatewayBaseClientBuilder<B,C>, ApiGatewayClientBuilder, ApplicationAutoScalingAsyncClientBuilder, ApplicationAutoScalingBaseClientBuilder<B,C>, ApplicationAutoScalingClientBuilder, ApplicationDiscoveryAsyncClientBuilder, ApplicationDiscoveryBaseClientBuilder<B,C>, ApplicationDiscoveryClientBuilder, AppStreamAsyncClientBuilder, AppStreamBaseClientBuilder<B,C>, AppStreamClientBuilder, AppSyncAsyncClientBuilder, AppSyncBaseClientBuilder<B,C>, AppSyncClientBuilder, AthenaAsyncClientBuilder, AthenaBaseClientBuilder<B,C>, AthenaClientBuilder, AutoScalingAsyncClientBuilder, AutoScalingBaseClientBuilder<B,C>, AutoScalingClientBuilder, BatchAsyncClientBuilder, BatchBaseClientBuilder<B,C>, BatchClientBuilder, BudgetsAsyncClientBuilder, BudgetsBaseClientBuilder<B,C>, BudgetsClientBuilder, Cloud9AsyncClientBuilder, Cloud9BaseClientBuilder<B,C>, Cloud9ClientBuilder, CloudDirectoryAsyncClientBuilder, CloudDirectoryBaseClientBuilder<B,C>, CloudDirectoryClientBuilder, CloudFormationAsyncClientBuilder, CloudFormationBaseClientBuilder<B,C>, CloudFormationClientBuilder, CloudFrontAsyncClientBuilder, CloudFrontBaseClientBuilder<B,C>, CloudFrontClientBuilder, CloudHsmAsyncClientBuilder, CloudHsmBaseClientBuilder<B,C>, CloudHsmClientBuilder, CloudHsmV2AsyncClientBuilder, CloudHsmV2BaseClientBuilder<B,C>, CloudHsmV2ClientBuilder, 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, ComprehendAsyncClientBuilder, ComprehendBaseClientBuilder<B,C>, ComprehendClientBuilder, ConfigAsyncClientBuilder, ConfigBaseClientBuilder<B,C>, ConfigClientBuilder, CostAndUsageReportAsyncClientBuilder, CostAndUsageReportBaseClientBuilder<B,C>, CostAndUsageReportClientBuilder, CostExplorerAsyncClientBuilder, CostExplorerBaseClientBuilder<B,C>, CostExplorerClientBuilder, 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, GlueAsyncClientBuilder, GlueBaseClientBuilder<B,C>, GlueClientBuilder, GreengrassAsyncClientBuilder, GreengrassBaseClientBuilder<B,C>, GreengrassClientBuilder, GuardDutyAsyncClientBuilder, GuardDutyBaseClientBuilder<B,C>, GuardDutyClientBuilder, 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, KinesisVideoAsyncClientBuilder, KinesisVideoBaseClientBuilder<B,C>, KinesisVideoClientBuilder, 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, MediaConvertAsyncClientBuilder, MediaConvertBaseClientBuilder<B,C>, MediaConvertClientBuilder, MediaLiveAsyncClientBuilder, MediaLiveBaseClientBuilder<B,C>, MediaLiveClientBuilder, MediaPackageAsyncClientBuilder, MediaPackageBaseClientBuilder<B,C>, MediaPackageClientBuilder, MediaStoreAsyncClientBuilder, MediaStoreBaseClientBuilder<B,C>, MediaStoreClientBuilder, MigrationHubAsyncClientBuilder, MigrationHubBaseClientBuilder<B,C>, MigrationHubClientBuilder, MobileAsyncClientBuilder, MobileBaseClientBuilder<B,C>, MobileClientBuilder, MqAsyncClientBuilder, MqBaseClientBuilder<B,C>, MqClientBuilder, 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, PricingAsyncClientBuilder, PricingBaseClientBuilder<B,C>, PricingClientBuilder, RdsAsyncClientBuilder, RdsBaseClientBuilder<B,C>, RdsClientBuilder, RedshiftAsyncClientBuilder, RedshiftBaseClientBuilder<B,C>, RedshiftClientBuilder, RekognitionAsyncClientBuilder, RekognitionBaseClientBuilder<B,C>, RekognitionClientBuilder, ResourceGroupsAsyncClientBuilder, ResourceGroupsBaseClientBuilder<B,C>, ResourceGroupsClientBuilder, ResourceGroupsTaggingApiAsyncClientBuilder, ResourceGroupsTaggingApiBaseClientBuilder<B,C>, ResourceGroupsTaggingApiClientBuilder, Route53AsyncClientBuilder, Route53BaseClientBuilder<B,C>, Route53ClientBuilder, Route53DomainsAsyncClientBuilder, Route53DomainsBaseClientBuilder<B,C>, Route53DomainsClientBuilder, S3AsyncClientBuilder, S3BaseClientBuilder<B,C>, S3ClientBuilder, SageMakerAsyncClientBuilder, SageMakerBaseClientBuilder<B,C>, SageMakerClientBuilder, SecretsManagerAsyncClientBuilder, SecretsManagerBaseClientBuilder<B,C>, SecretsManagerClientBuilder, ServerlessApplicationRepositoryAsyncClientBuilder, ServerlessApplicationRepositoryBaseClientBuilder<B,C>, ServerlessApplicationRepositoryClientBuilder, ServiceCatalogAsyncClientBuilder, ServiceCatalogBaseClientBuilder<B,C>, ServiceCatalogClientBuilder, ServiceDiscoveryAsyncClientBuilder, ServiceDiscoveryBaseClientBuilder<B,C>, ServiceDiscoveryClientBuilder, 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, TranslateAsyncClientBuilder, TranslateBaseClientBuilder<B,C>, TranslateClientBuilder, WafAsyncClientBuilder, WafBaseClientBuilder<B,C>, WafClientBuilder, WafRegionalAsyncClientBuilder, WafRegionalBaseClientBuilder<B,C>, WafRegionalClientBuilder, WorkDocsAsyncClientBuilder, WorkDocsBaseClientBuilder<B,C>, WorkDocsClientBuilder, WorkMailAsyncClientBuilder, WorkMailBaseClientBuilder<B,C>, WorkMailClientBuilder, WorkSpacesAsyncClientBuilder, WorkSpacesBaseClientBuilder<B,C>, WorkSpacesClientBuilder, XRayAsyncClientBuilder, XRayBaseClientBuilder<B,C>, XRayClientBuilder

All Known Implementing Classes:

AwsDefaultClientBuilder

public interface AwsClientBuilder<BuilderT extends AwsClientBuilder<BuilderT,ClientT>,ClientT>
extends SdkClientBuilder<BuilderT,ClientT>

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 and Description
BuilderT	credentialsProvider(AwsCredentialsProvider credentialsProvider) Configure the credentials that should be used to authenticate with AWS.
BuilderT	region(Region region) Configure the region with which the SDK should communicate.

Methods inherited from interface software.amazon.awssdk.core.client.builder.SdkClientBuilder

endpointOverride, overrideConfiguration, overrideConfiguration

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

applyMutation, build

Method Detail

credentialsProvider

BuilderT 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.

region

BuilderT 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.