Package com.cloudbees.jenkins.plugins.awscredentials

Class AWSCredentialsImpl

java.lang.Object

com.cloudbees.plugins.credentials.BaseCredentials

com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

com.cloudbees.jenkins.plugins.awscredentials.BaseAmazonWebServicesCredentials

com.cloudbees.jenkins.plugins.awscredentials.AWSCredentialsImpl

All Implemented Interfaces:

com.amazonaws.auth.AWSCredentialsProvider, AmazonWebServicesCredentials, com.cloudbees.plugins.credentials.common.IdCredentials, com.cloudbees.plugins.credentials.common.StandardCredentials, com.cloudbees.plugins.credentials.Credentials, ExtensionPoint, Describable<com.cloudbees.plugins.credentials.Credentials>, Serializable, software.amazon.awssdk.auth.credentials.AwsCredentialsProvider, software.amazon.awssdk.identity.spi.IdentityProvider<software.amazon.awssdk.identity.spi.AwsCredentialsIdentity>

public class AWSCredentialsImpl
extends BaseAmazonWebServicesCredentials

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AWSCredentialsImpl.DescriptorImpl

Nested classes/interfaces inherited from class com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

com.cloudbees.plugins.credentials.impl.BaseStandardCredentials.BaseStandardCredentialsDescriptor

Nested classes/interfaces inherited from interface com.cloudbees.jenkins.plugins.awscredentials.AmazonWebServicesCredentials

AmazonWebServicesCredentials.NameProvider

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface com.cloudbees.plugins.credentials.common.IdCredentials

com.cloudbees.plugins.credentials.common.IdCredentials.Helpers

Nested classes/interfaces inherited from interface com.cloudbees.plugins.credentials.common.StandardCredentials

com.cloudbees.plugins.credentials.common.StandardCredentials.NameProvider

Field Summary

Fields

Modifier and Type	Field	Description
static final int	STS_CREDENTIALS_DURATION_SECONDS

Constructor Summary

Constructors

Constructor	Description
AWSCredentialsImpl(com.cloudbees.plugins.credentials.CredentialsScope scope, String id, String accessKey, String secretKey, String description)
AWSCredentialsImpl(com.cloudbees.plugins.credentials.CredentialsScope scope, String id, String accessKey, String secretKey, String description, String iamRoleArn, String iamMfaSerialNumber)
AWSCredentialsImpl(com.cloudbees.plugins.credentials.CredentialsScope scope, String id, String accessKey, String secretKey, String description, String iamRoleArn, String iamMfaSerialNumber, String iamExternalId)

Method Summary

Modifier and Type	Method	Description
String	getAccessKey()
com.amazonaws.auth.AWSCredentials	getCredentials()	Deprecated. use resolveCredentials()
com.amazonaws.auth.AWSCredentials	getCredentials(String mfaToken)	Deprecated. use resolveCredentials(String)
String	getDisplayName()
String	getIamExternalId()
String	getIamMfaSerialNumber()
String	getIamRoleArn()
Secret	getSecretKey()
Integer	getStsTokenDuration()
void	refresh()	Deprecated. removed without replacement
boolean	requiresToken()
software.amazon.awssdk.auth.credentials.AwsCredentials	resolveCredentials()
software.amazon.awssdk.auth.credentials.AwsCredentials	resolveCredentials(String mfaToken)
void	setStsTokenDuration(Integer stsTokenDuration)

Methods inherited from class com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

equals, getDescription, getId, hashCode

Methods inherited from class com.cloudbees.plugins.credentials.BaseCredentials

getDescriptor, getScope

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.auth.credentials.AwsCredentialsProvider

identityType, resolveIdentity

Methods inherited from interface com.cloudbees.plugins.credentials.Credentials

forRun, getDescriptor, getScope

Methods inherited from interface com.cloudbees.plugins.credentials.common.IdCredentials

getId

Methods inherited from interface software.amazon.awssdk.identity.spi.IdentityProvider

resolveIdentity, resolveIdentity

Methods inherited from interface com.cloudbees.plugins.credentials.common.StandardCredentials

getDescription

Field Details

STS_CREDENTIALS_DURATION_SECONDS

public static final int STS_CREDENTIALS_DURATION_SECONDS

See Also:

• Constant Field Values

Constructor Details

AWSCredentialsImpl

public AWSCredentialsImpl(@CheckForNull
 com.cloudbees.plugins.credentials.CredentialsScope scope,
 @CheckForNull
 String id,
 @CheckForNull
 String accessKey,
 @CheckForNull
 String secretKey,
 @CheckForNull
 String description)

AWSCredentialsImpl

public AWSCredentialsImpl(@CheckForNull
 com.cloudbees.plugins.credentials.CredentialsScope scope,
 @CheckForNull
 String id,
 @CheckForNull
 String accessKey,
 @CheckForNull
 String secretKey,
 @CheckForNull
 String description,
 @CheckForNull
 String iamRoleArn,
 @CheckForNull
 String iamMfaSerialNumber)

AWSCredentialsImpl

@DataBoundConstructor
public AWSCredentialsImpl(@CheckForNull
 com.cloudbees.plugins.credentials.CredentialsScope scope,
 @CheckForNull
 String id,
 @CheckForNull
 String accessKey,
 @CheckForNull
 String secretKey,
 @CheckForNull
 String description,
 @CheckForNull
 String iamRoleArn,
 @CheckForNull
 String iamMfaSerialNumber,
 String iamExternalId)

Method Details

getAccessKey

public String getAccessKey()

getSecretKey

public Secret getSecretKey()

getIamRoleArn

public String getIamRoleArn()

getIamExternalId

public String getIamExternalId()

getIamMfaSerialNumber

public String getIamMfaSerialNumber()

getStsTokenDuration

@NonNull
public Integer getStsTokenDuration()

setStsTokenDuration

@DataBoundSetter
public void setStsTokenDuration(Integer stsTokenDuration)

requiresToken

public boolean requiresToken()

resolveCredentials

public software.amazon.awssdk.auth.credentials.AwsCredentials resolveCredentials()

resolveCredentials

public software.amazon.awssdk.auth.credentials.AwsCredentials resolveCredentials(String mfaToken)

getCredentials

@Deprecated
public com.amazonaws.auth.AWSCredentials getCredentials()

Deprecated.

use resolveCredentials()

getCredentials

@Deprecated
public com.amazonaws.auth.AWSCredentials getCredentials(String mfaToken)

Deprecated.

use resolveCredentials(String)

refresh

@Deprecated
public void refresh()

Deprecated.

removed without replacement

getDisplayName

public String getDisplayName()