com.amazonaws.auth.profile.internal.Profile 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
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.
/*
* Copyright 2014-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.profile.internal;
import java.util.LinkedHashMap;
import java.util.Map;
import com.amazonaws.annotation.Immutable;
import com.amazonaws.auth.AccountIdAware;
import com.amazonaws.auth.AWSCredentials;
import com.amazonaws.auth.AWSCredentialsProvider;
import com.amazonaws.auth.AWSSessionCredentials;
import com.amazonaws.auth.profile.internal.securitytoken.RoleInfo;
import com.amazonaws.internal.StaticCredentialsProvider;
/**
* Contains the information stored in an AWS profile, such as AWS security
* credentials.
*/
@Immutable
@Deprecated
public class Profile {
/** The name of this profile */
private final String profileName;
/** Profile properties */
private final Map properties;
/** Holds the AWS Credentials for the profile. */
private final AWSCredentialsProvider awsCredentials;
public Profile(String profileName, AWSCredentials awsCredentials) {
Map properties = new LinkedHashMap();
properties.put(ProfileKeyConstants.AWS_ACCESS_KEY_ID, awsCredentials.getAWSAccessKeyId());
properties.put(ProfileKeyConstants.AWS_SECRET_ACCESS_KEY, awsCredentials.getAWSSecretKey());
if (awsCredentials instanceof AWSSessionCredentials) {
AWSSessionCredentials sessionCred = (AWSSessionCredentials)awsCredentials;
properties.put(ProfileKeyConstants.AWS_SESSION_TOKEN, sessionCred.getSessionToken());
}
if (awsCredentials instanceof AccountIdAware) {
AccountIdAware accountIdAwareCred = (AccountIdAware)awsCredentials;
properties.put(ProfileKeyConstants.AWS_ACCOUNT_ID, accountIdAwareCred.getAccountId());
}
this.profileName = profileName;
this.properties = properties;
this.awsCredentials = new StaticCredentialsProvider(awsCredentials);
}
public Profile(String profileName, String sourceProfile, AWSCredentialsProvider awsCredentials, RoleInfo roleInfo) {
Map properties = new LinkedHashMap();
properties.put(ProfileKeyConstants.SOURCE_PROFILE, sourceProfile);
properties.put(ProfileKeyConstants.ROLE_ARN, roleInfo.getRoleArn());
if (roleInfo.getRoleSessionName() != null) {
properties.put(ProfileKeyConstants.ROLE_SESSION_NAME, roleInfo.getRoleSessionName());
}
if (roleInfo.getExternalId() != null) {
properties.put(ProfileKeyConstants.EXTERNAL_ID, roleInfo.getExternalId());
}
this.profileName = profileName;
this.properties = properties;
this.awsCredentials = awsCredentials;
}
public Profile(String profileName, Map properties,
AWSCredentialsProvider awsCredentials) {
this.profileName = profileName;
this.properties = properties;
this.awsCredentials = awsCredentials;
}
public String getProfileName() {
return profileName;
}
public AWSCredentials getCredentials() {
return awsCredentials.getCredentials();
}
/**
* Returns a map of profile properties included in this Profile instance.
* The returned properties corresponds to how this profile is described in
* the credential profiles file, i.e., profiles with basic credentials
* consist of two properties {"aws_access_key_id", "aws_secret_access_key"}
* and profiles with session credentials have three properties, with an
* additional "aws_session_token" property.
*/
public Map getProperties() {
return new LinkedHashMap(properties);
}
/**
* Returns the value of a specific property that is included in this Profile instance.
* @see Profile#getProperties()
*/
public String getPropertyValue(String propertyName) {
return getProperties().get(propertyName);
}
}