Package io.jenkins.plugins.aws.global_configuration

Class CredentialsAwsGlobalConfiguration

java.lang.Object

hudson.model.Descriptor<GlobalConfiguration>

jenkins.model.GlobalConfiguration

io.jenkins.plugins.aws.global_configuration.AbstractAwsGlobalConfiguration

io.jenkins.plugins.aws.global_configuration.CredentialsAwsGlobalConfiguration

All Implemented Interfaces:

ExtensionPoint, Describable<GlobalConfiguration>, Saveable, OnMaster

@Symbol("awsCredentials")
@Extension
public final class CredentialsAwsGlobalConfiguration
extends AbstractAwsGlobalConfiguration

Store the AWS configuration to save it on a separate file

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Modifier	Constructor	Description
	CredentialsAwsGlobalConfiguration()
protected	CredentialsAwsGlobalConfiguration(boolean test)	Testing only

Method Summary

Modifier and Type	Method	Description
FormValidation	doCheckRegion(String region)
ListBoxModel	doFillCredentialsIdItems()
ListBoxModel	doFillRegionItems()
static CredentialsAwsGlobalConfiguration	get()
com.cloudbees.jenkins.plugins.awscredentials.AmazonWebServicesCredentials	getCredentials()
com.cloudbees.jenkins.plugins.awscredentials.AmazonWebServicesCredentials	getCredentials(String credentialsId)
String	getCredentialsId()
String	getDisplayName()
String	getRegion()
int	getSessionDuration()
com.amazonaws.auth.AWSSessionCredentials	sessionCredentials(com.amazonaws.client.builder.AwsClientBuilder<?,?> builder)	Deprecated.
com.amazonaws.auth.AWSSessionCredentials	sessionCredentials(com.amazonaws.client.builder.AwsClientBuilder<?,?> builder, String region, String credentialsId)	Select the type of AWS credential that has to be created based on the configuration.
void	setCredentialsId(String credentialsId)
void	setRegion(String region)

Methods inherited from class io.jenkins.plugins.aws.global_configuration.AbstractAwsGlobalConfiguration

getCategory, processExceptionMessage

Methods inherited from class jenkins.model.GlobalConfiguration

all, configure, getDescriptor, getGlobalConfigPage

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

CredentialsAwsGlobalConfiguration

public CredentialsAwsGlobalConfiguration()

CredentialsAwsGlobalConfiguration

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
protected CredentialsAwsGlobalConfiguration(boolean test)

Testing only

Method Detail

getRegion

public String getRegion()

setRegion

@DataBoundSetter
public void setRegion(String region)

getCredentialsId

@CheckForNull
public String getCredentialsId()

setCredentialsId

@DataBoundSetter
public void setCredentialsId(@CheckForNull
                             String credentialsId)

getCredentials

@CheckForNull
public com.cloudbees.jenkins.plugins.awscredentials.AmazonWebServicesCredentials getCredentials()

getCredentials

@CheckForNull
public com.cloudbees.jenkins.plugins.awscredentials.AmazonWebServicesCredentials getCredentials(@NonNull
                                                                                                String credentialsId)

sessionCredentials

@Deprecated
public com.amazonaws.auth.AWSSessionCredentials sessionCredentials(@NonNull
                                                                   com.amazonaws.client.builder.AwsClientBuilder<?,?> builder)
                                                            throws IOException

Deprecated.

Use sessionCredentials(AwsClientBuilder, String, String)

Throws:

IOException

sessionCredentials

public com.amazonaws.auth.AWSSessionCredentials sessionCredentials(@NonNull
                                                                   com.amazonaws.client.builder.AwsClientBuilder<?,?> builder,
                                                                   String region,
                                                                   String credentialsId)
                                                            throws IOException

Select the type of AWS credential that has to be created based on the configuration. If no AWS credential is provided, the IAM instance profile or user AWS configuration is used to create the AWS credentials.

Returns:

An AWS session credential.

Throws:

IOException - in case of error.

getSessionDuration

public int getSessionDuration()

getDisplayName

@NonNull
public String getDisplayName()

Overrides:

getDisplayName in class Descriptor<GlobalConfiguration>

get

@NonNull
public static CredentialsAwsGlobalConfiguration get()

doFillRegionItems

public ListBoxModel doFillRegionItems()

doFillCredentialsIdItems

public ListBoxModel doFillCredentialsIdItems()

doCheckRegion

public FormValidation doCheckRegion(@QueryParameter
                                    String region)