Package com.cloudbees.jenkins.plugins.awscredentials

Class AmazonWebServicesCredentialsBinding

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.credentialsbinding.MultiBinding<C>>

org.jenkinsci.plugins.credentialsbinding.MultiBinding<AmazonWebServicesCredentials>

com.cloudbees.jenkins.plugins.awscredentials.AmazonWebServicesCredentialsBinding

All Implemented Interfaces:

ExtensionPoint, Describable<org.jenkinsci.plugins.credentialsbinding.MultiBinding<AmazonWebServicesCredentials>>

public class AmazonWebServicesCredentialsBinding
extends org.jenkinsci.plugins.credentialsbinding.MultiBinding<AmazonWebServicesCredentials>

Author:

Nicolas De Loof

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AmazonWebServicesCredentialsBinding.DescriptorImpl

Nested classes/interfaces inherited from class org.jenkinsci.plugins.credentialsbinding.MultiBinding

org.jenkinsci.plugins.credentialsbinding.MultiBinding.MultiEnvironment, org.jenkinsci.plugins.credentialsbinding.MultiBinding.NullUnbinder, org.jenkinsci.plugins.credentialsbinding.MultiBinding.Unbinder

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_ACCESS_KEY_ID_VARIABLE_NAME

Constructor Summary

Constructors

Constructor	Description
AmazonWebServicesCredentialsBinding(String accessKeyVariable, String secretKeyVariable, String credentialsId)

Method Summary

Modifier and Type	Method	Description
org.jenkinsci.plugins.credentialsbinding.MultiBinding.MultiEnvironment	bind(Run<?,?> build, FilePath workspace, Launcher launcher, TaskListener listener)
String	getAccessKeyVariable()
String	getRoleArn()
int	getRoleSessionDurationSeconds()
String	getRoleSessionName()
String	getSecretKeyVariable()
void	setRoleArn(String roleArn)
void	setRoleSessionDurationSeconds(int roleSessionDurationSeconds)
void	setRoleSessionName(String roleSessionName)
protected Class<AmazonWebServicesCredentials>	type()
Set<String>	variables()

Methods inherited from class org.jenkinsci.plugins.credentialsbinding.MultiBinding

getCredentials, getCredentialsId, getDescriptor, variables

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ACCESS_KEY_ID_VARIABLE_NAME

public static final String DEFAULT_ACCESS_KEY_ID_VARIABLE_NAME

See Also:

Constant Field Values

Constructor Detail

AmazonWebServicesCredentialsBinding

@DataBoundConstructor
public AmazonWebServicesCredentialsBinding(@Nullable
                                           String accessKeyVariable,
                                           @Nullable
                                           String secretKeyVariable,
                                           String credentialsId)

Parameters:

accessKeyVariable - if null, "AWS_ACCESS_KEY_ID" will be used.

secretKeyVariable - if null, "AWS_SECRET_ACCESS_KEY" will be used.

credentialsId - identifier which should be referenced when accessing the credentials from a job/pipeline.

Method Detail

getAccessKeyVariable

@NonNull
public String getAccessKeyVariable()

getSecretKeyVariable

@NonNull
public String getSecretKeyVariable()

getRoleArn

@Nullable
public String getRoleArn()

getRoleSessionName

@Nullable
public String getRoleSessionName()

getRoleSessionDurationSeconds

public int getRoleSessionDurationSeconds()

setRoleArn

@DataBoundSetter
public void setRoleArn(String roleArn)

setRoleSessionName

@DataBoundSetter
public void setRoleSessionName(String roleSessionName)

setRoleSessionDurationSeconds

@DataBoundSetter
public void setRoleSessionDurationSeconds(int roleSessionDurationSeconds)

type

protected Class<AmazonWebServicesCredentials> type()

Specified by:

type in class org.jenkinsci.plugins.credentialsbinding.MultiBinding<AmazonWebServicesCredentials>

bind

public org.jenkinsci.plugins.credentialsbinding.MultiBinding.MultiEnvironment bind(@NonNull
                                                                                   Run<?,?> build,
                                                                                   FilePath workspace,
                                                                                   Launcher launcher,
                                                                                   TaskListener listener)
                                                                            throws IOException,
                                                                                   InterruptedException

Specified by:

bind in class org.jenkinsci.plugins.credentialsbinding.MultiBinding<AmazonWebServicesCredentials>

Throws:

IOException

InterruptedException

variables

public Set<String> variables()

Overrides:

variables in class org.jenkinsci.plugins.credentialsbinding.MultiBinding<AmazonWebServicesCredentials>