Package software.amazon.awssdk.core.signer

Interface Signer

  • All Known Implementing Classes:
    NoOpSigner
    Functional Interface:
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    @SdkPublicApi
@FunctionalInterface
@Deprecated
public interface Signer
    Deprecated.
    Replaced by software.amazon.awssdk.http.auth.spi.signer.HttpSigner in 'http-auth-spi'.

    Migration Guide:

    • For custom signing logic: Implement HttpSigner and configure via AuthScheme. See example 1 below.
    • For overriding signing properties only: Use custom AuthSchemeProvider instead. See example 2 below.

    Example 1 - Custom signer implementation:

    {@snippet : S3AsyncClient s3 = S3AsyncClient.builder() .region(Region.US_WEST_2) .credentialsProvider(CREDENTIALS) .putAuthScheme(new CustomSigV4AuthScheme()) .build(); public class CustomSigV4AuthScheme implements AwsV4AuthScheme {

    Interface for the signer used for signing the requests. All SDK signer implementations will implement this interface.

    • Method Detail

      • sign

        SdkHttpFullRequest sign​(SdkHttpFullRequest request,
                        ExecutionAttributes executionAttributes)
        Deprecated.
        Method that takes in an request and returns a signed version of the request.
        Parameters:
        request - The request to sign
        executionAttributes - Contains the attributes required for signing the request
        Returns:
        A signed version of the input request

      • credentialType

        default CredentialType credentialType()
        Deprecated.
        Method that retrieves CredentialType i.e. the type of Credentials used by the Signer while authorizing a request.
        Returns:
        null by default else return CredentialType as defined by the signer implementation.