1 /* 2 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"). 5 * You may not use this file except in compliance with the License. 6 * A copy of the License is located at 7 * 8 * http://aws.amazon.com/apache2.0 9 * 10 * or in the "license" file accompanying this file. This file is distributed 11 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either 12 * express or implied. See the License for the specific language governing 13 * permissions and limitations under the License. 14 */ 15 16 package software.amazon.awssdk.http.auth.aws.signer; 17 18 import software.amazon.awssdk.annotations.SdkPublicApi; 19 import software.amazon.awssdk.http.auth.aws.internal.signer.DefaultAwsV4HttpSigner; 20 import software.amazon.awssdk.http.auth.spi.signer.HttpSigner; 21 import software.amazon.awssdk.http.auth.spi.signer.SignerProperty; 22 import software.amazon.awssdk.identity.spi.AwsCredentialsIdentity; 23 24 /** 25 * An {@link HttpSigner} that will sign a request using an AWS credentials {@link AwsCredentialsIdentity}). 26 * <p> 27 * The process for signing requests to send to AWS services is documented 28 * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">here</a>. 29 */ 30 @SdkPublicApi 31 public interface AwsV4HttpSigner extends AwsV4FamilyHttpSigner<AwsCredentialsIdentity> { 32 /** 33 * The AWS region name to be used for computing the signature. This property is required. 34 */ 35 SignerProperty<String> REGION_NAME = 36 SignerProperty.create(AwsV4HttpSigner.class, "RegionName"); 37 38 /** 39 * Get a default implementation of a {@link AwsV4HttpSigner} 40 */ create()41 static AwsV4HttpSigner create() { 42 return new DefaultAwsV4HttpSigner(); 43 } 44 } 45