Class ExternalProxy
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ExternalProxy.Builder,ExternalProxy>
Configuration for a customer-managed external proxy server. Includes server location, optional domain-based routing patterns, and authentication credentials.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic ExternalProxy.Builderbuilder()final ProxyCredentialsOptional authentication credentials for the proxy server.Optional array of domain patterns that should route through this specific proxy.final booleanfinal booleanequalsBySdkFields(Object obj) final <T> Optional<T>getValueForField(String fieldName, Class<T> clazz) final booleanFor responses, this returns true if the service returned a value for the DomainPatterns property.final inthashCode()final Integerport()The port number of the proxy server.static Class<? extends ExternalProxy.Builder>final Stringserver()The hostname of the proxy server.final StringtoString()Returns a string representation of this object.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
server
The hostname of the proxy server. Must be a valid DNS hostname (maximum 253 characters).
- Returns:
- The hostname of the proxy server. Must be a valid DNS hostname (maximum 253 characters).
-
port
The port number of the proxy server. Valid range: 1-65535.
- Returns:
- The port number of the proxy server. Valid range: 1-65535.
-
hasDomainPatterns
public final boolean hasDomainPatterns()For responses, this returns true if the service returned a value for the DomainPatterns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
domainPatterns
Optional array of domain patterns that should route through this specific proxy. Supports
.example.comfor subdomain matching (matches any subdomain of example.com) orexample.comfor exact domain matching. If omitted, this proxy acts as a catch-all for domains not matched by other proxies. Maximum 100 patterns per proxy, each up to 253 characters.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDomainPatterns()method.- Returns:
- Optional array of domain patterns that should route through this specific proxy. Supports
.example.comfor subdomain matching (matches any subdomain of example.com) orexample.comfor exact domain matching. If omitted, this proxy acts as a catch-all for domains not matched by other proxies. Maximum 100 patterns per proxy, each up to 253 characters.
-
credentials
Optional authentication credentials for the proxy server. If omitted, the proxy is accessed without authentication (useful for IP-allowlisted proxies).
- Returns:
- Optional authentication credentials for the proxy server. If omitted, the proxy is accessed without authentication (useful for IP-allowlisted proxies).
-
toBuilder
- Specified by:
toBuilderin interfaceToCopyableBuilder<ExternalProxy.Builder,ExternalProxy>
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-