• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 static software.amazon.awssdk.http.auth.aws.internal.signer.util.OptionalDependencyLoaderUtil.getDefaultAwsCrtV4aHttpSigner;
19 
20 import software.amazon.awssdk.annotations.SdkPublicApi;
21 import software.amazon.awssdk.http.auth.spi.signer.HttpSigner;
22 import software.amazon.awssdk.http.auth.spi.signer.SignerProperty;
23 import software.amazon.awssdk.identity.spi.AwsCredentialsIdentity;
24 
25 /**
26  * An {@link HttpSigner} that will sign a request using an AWS credentials {@link AwsCredentialsIdentity}).
27  * <p>
28  * The process for signing requests to send to AWS services is documented
29  * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">here</a>.
30  */
31 @SdkPublicApi
32 public interface AwsV4aHttpSigner extends AwsV4FamilyHttpSigner<AwsCredentialsIdentity> {
33     /**
34      * The AWS region-set to be used for computing the signature. This property is required.
35      */
36     SignerProperty<RegionSet> REGION_SET = SignerProperty.create(AwsV4aHttpSigner.class, "RegionSet");
37 
38     /**
39      * Get a default implementation of a {@link AwsV4aHttpSigner}
40      */
create()41     static AwsV4aHttpSigner create() {
42         return getDefaultAwsCrtV4aHttpSigner();
43     }
44 
45 }
46