com.amazonaws.auth.DefaultAWSCredentialsProviderChain Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-core Show documentation

The AWS SDK for Java - Core module holds the classes that are used by the individual service clients to interact with Amazon Web Services. Users need to depend on aws-java-sdk artifact for accessing individual client classes.

There is a newer version: 1.12.778

Show newest version

/*
 * Copyright 2012-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */
package com.amazonaws.auth;

import com.amazonaws.auth.profile.ProfileCredentialsProvider;

/**
 * AWS credentials provider chain that looks for credentials in this order:
 * 
 *   Environment Variables -
 *      AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
 *      (RECOMMENDED since they are recognized by all the AWS SDKs and CLI except for .NET),
 *      or AWS_ACCESS_KEY and AWS_SECRET_KEY (only recognized by Java SDK)
 *   
 *   Java System Properties - aws.accessKeyId and aws.secretKey
 *   Web Identity Token credentials from the environment or container
 *   Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
 *   Credentials delivered through the Amazon EC2 container service if AWS_CONTAINER_CREDENTIALS_RELATIVE_URI" environment variable is set
 *   and security manager has permission to access the variable,
 *   Instance profile credentials delivered through the Amazon EC2 metadata service
 * 
 *
 * 
 * Migrating to the AWS SDK for Java v2
 * 

 * The v2 equivalent of this class is
 * DefaultCredentialsProvider
 *
 * 
 * See Migration Guide
 * for more information.
 *
 * @see EnvironmentVariableCredentialsProvider
 * @see SystemPropertiesCredentialsProvider
 * @see WebIdentityTokenCredentialsProvider
 * @see ProfileCredentialsProvider
 * @see EC2ContainerCredentialsProviderWrapper
 *
 */
public class DefaultAWSCredentialsProviderChain extends AWSCredentialsProviderChain {

    private static final DefaultAWSCredentialsProviderChain INSTANCE
        = new DefaultAWSCredentialsProviderChain();

    public DefaultAWSCredentialsProviderChain() {
        super(new EnvironmentVariableCredentialsProvider(),
              new SystemPropertiesCredentialsProvider(),
              WebIdentityTokenCredentialsProvider.create(),
              new ProfileCredentialsProvider(),
              new EC2ContainerCredentialsProviderWrapper());
    }

    public static DefaultAWSCredentialsProviderChain getInstance() {
        return INSTANCE;
    }
}