Class AwsClientEndpointProvider

java.lang.Object

software.amazon.awssdk.awscore.endpoint.AwsClientEndpointProvider

All Implemented Interfaces:

ClientEndpointProvider

@SdkProtectedApi
public final class AwsClientEndpointProvider
extends Object
implements ClientEndpointProvider

An implementation of ClientEndpointProvider that loads the default client endpoint from:

1. The client-level endpoint override
2. The service-specific endpoint override system property (e.g. 'aws.endpointUrlS3')
3. The service-agnostic endpoint override system property (i.e. 'aws.endpointUrl')
4. The service-specific endpoint override environment variable (e.g. 'AWS_ENDPOINT_URL_S3')
5. The service-agnostic endpoint override environment variable (i.e. 'AWS_ENDPOINT_URL')
6. The service-specific endpoint override from services section (e.g. '[services dev] s3.endpoint_url')
7. The service-specific endpoint override profile property (e.g. 's3.endpoint_url')
8. The service-agnostic endpoint override profile property (i.e. 'endpoint_url')
9. The ServiceMetadata for the service

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AwsClientEndpointProvider.Builder

Method Summary

Modifier and Type	Method	Description
static AwsClientEndpointProvider.Builder	builder()
URI	clientEndpoint()	Retrieve the endpoint to be used by the client.
boolean	isEndpointOverridden()	Return true if the endpoint was overridden by the customer, or false if it was loaded from the ServiceMetadata.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.core.ClientEndpointProvider

sanitizedEndpointString

Method Details

builder

public static AwsClientEndpointProvider.Builder builder()

clientEndpoint

public URI clientEndpoint()

Retrieve the endpoint to be used by the client.

Specified by:

clientEndpoint in interface ClientEndpointProvider

Throws:

SdkClientException - If the endpoint could not be loaded or was invalid

isEndpointOverridden

public boolean isEndpointOverridden()

Return true if the endpoint was overridden by the customer, or false if it was loaded from the ServiceMetadata.

Specified by:

isEndpointOverridden in interface ClientEndpointProvider

Throws:

SdkClientException - If the endpoint could not be loaded or was invalid