Class AwsClientEndpointProvider.Builder
- java.lang.Object
-
- software.amazon.awssdk.awscore.endpoint.AwsClientEndpointProvider.Builder
-
- Enclosing class:
- AwsClientEndpointProvider
public static final class AwsClientEndpointProvider.Builder extends Object
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AwsClientEndpointProviderbuild()AwsClientEndpointProvider.BuilderclientEndpointOverride(URI clientEndpointOverride)Set the endpoint that was overridden by the customer usingSdkClientBuilder.endpointOverride(URI).AwsClientEndpointProvider.BuilderdefaultProtocol(String protocol)Set the protocol to be used for endpoints returned byServiceMetadata.of(String).AwsClientEndpointProvider.BuilderdualstackEnabled(Boolean dualstackEnabled)Whether dualstack endpoints should be used when resolving withServiceMetadata.of(String).AwsClientEndpointProvider.BuilderfipsEnabled(Boolean fipsEnabled)Whether FIPS endpoints should be used when resolving withServiceMetadata.of(String).AwsClientEndpointProvider.BuilderprofileFile(Supplier<ProfileFile> profileFile)Set the profile file supplier that will supply the customer's profile file.AwsClientEndpointProvider.BuilderprofileName(String profileName)Set the profile name for the profile that should be used .<T> AwsClientEndpointProvider.BuilderputAdvancedOption(ServiceMetadataAdvancedOption<T> option, T value)Specify advanced options that should be passed on to theServiceMetadata.AwsClientEndpointProvider.Builderregion(Region region)The region to use when resolving withServiceMetadata.of(String).AwsClientEndpointProvider.BuilderserviceEndpointOverrideEnvironmentVariable(String serviceEndpointOverrideEnvironmentVariable)Set the service-specific environment variable that should be used to load the endpoint override for this service.AwsClientEndpointProvider.BuilderserviceEndpointOverrideSystemProperty(String serviceEndpointOverrideSystemProperty)Set the service-specific system property that should be used to load the endpoint override for this service.AwsClientEndpointProvider.BuilderserviceEndpointPrefix(String serviceEndpointPrefix)Set the service endpoint prefix, as it is expected byServiceMetadata.of(String).AwsClientEndpointProvider.BuilderserviceProfileProperty(String serviceProfileProperty)Set the service-specific profile property that should be used to load the endpoint override for this service.
-
-
-
Method Detail
-
clientEndpointOverride
public AwsClientEndpointProvider.Builder clientEndpointOverride(URI clientEndpointOverride)
Set the endpoint that was overridden by the customer usingSdkClientBuilder.endpointOverride(URI).If specified, this provider will behave the same as
ClientEndpointProvider.forEndpointOverride(URI). Other configured values will not be used.
-
serviceEndpointOverrideEnvironmentVariable
public AwsClientEndpointProvider.Builder serviceEndpointOverrideEnvironmentVariable(String serviceEndpointOverrideEnvironmentVariable)
Set the service-specific environment variable that should be used to load the endpoint override for this service.If this value is set,
serviceEndpointOverrideSystemPropertyandserviceProfilePropertymust also be set.If this value is not set, loading the service endpoint from the environment is skipped.
-
serviceEndpointOverrideSystemProperty
public AwsClientEndpointProvider.Builder serviceEndpointOverrideSystemProperty(String serviceEndpointOverrideSystemProperty)
Set the service-specific system property that should be used to load the endpoint override for this service.If this value is set,
serviceEndpointOverrideEnvironmentVariableandserviceProfilePropertymust also be set.If this value is not set, loading the service endpoint from the environment is skipped.
-
serviceProfileProperty
public AwsClientEndpointProvider.Builder serviceProfileProperty(String serviceProfileProperty)
Set the service-specific profile property that should be used to load the endpoint override for this service.If this value is set,
serviceEndpointOverrideEnvironmentVariableandserviceEndpointOverrideSystemPropertymust also be set.If this value is not set, loading the service endpoint from the environment is skipped.
-
profileFile
public AwsClientEndpointProvider.Builder profileFile(Supplier<ProfileFile> profileFile)
Set the profile file supplier that will supply the customer's profile file. This profile file is used both for checking for the endpoint override and when resolving the endpoint fromServiceMetadata.If this value is not set, the
ProfileFile.defaultProfileFile()is used.
-
profileName
public AwsClientEndpointProvider.Builder profileName(String profileName)
Set the profile name for the profile that should be used . This profile is used both for checking for the endpoint override and when resolving the endpoint fromServiceMetadata.If this value is not set,
ProfileFileSystemSetting.AWS_PROFILEis used.
-
serviceEndpointPrefix
public AwsClientEndpointProvider.Builder serviceEndpointPrefix(String serviceEndpointPrefix)
Set the service endpoint prefix, as it is expected byServiceMetadata.of(String).This value will only be used if the endpoint is loaded from service metadata.
If this value is set,
defaultProtocol(java.lang.String)andregionmust also be set. If this value is not set, loading the service endpoint from service metadata is skipped.
-
defaultProtocol
public AwsClientEndpointProvider.Builder defaultProtocol(String protocol)
Set the protocol to be used for endpoints returned byServiceMetadata.of(String).This value will only be used if the endpoint is loaded from service metadata.
If this value is set,
serviceEndpointPrefixandregionmust also be set. If this value is not set, loading the service endpoint from service metadata is skipped.
-
region
public AwsClientEndpointProvider.Builder region(Region region)
The region to use when resolving withServiceMetadata.of(String).This value will only be used if the region is loaded from service metadata.
If this value is set,
serviceEndpointPrefixanddefaultProtocol(java.lang.String)must also be set. If this value is not set, loading the service endpoint from service metadata is skipped.
-
dualstackEnabled
public AwsClientEndpointProvider.Builder dualstackEnabled(Boolean dualstackEnabled)
Whether dualstack endpoints should be used when resolving withServiceMetadata.of(String).This value will only be used if the endpoint is loaded from service metadata.
If this value is not set, the
DualstackEnabledProviderwill be used.
-
fipsEnabled
public AwsClientEndpointProvider.Builder fipsEnabled(Boolean fipsEnabled)
Whether FIPS endpoints should be used when resolving withServiceMetadata.of(String).This value will only be used if the endpoint is loaded from service metadata.
If this value is not set, the
FipsEnabledProviderwill be used.
-
putAdvancedOption
public <T> AwsClientEndpointProvider.Builder putAdvancedOption(ServiceMetadataAdvancedOption<T> option, T value)
Specify advanced options that should be passed on to theServiceMetadata.This value will only be used if the endpoint is loaded from service metadata.
-
build
public AwsClientEndpointProvider build()
-
-