hudson.plugins.awsparameterstore

Class AwsParameterStoreBuildWrapper

java.lang.Object

hudson.model.AbstractDescribableImpl<hudson.tasks.BuildWrapper>

hudson.tasks.BuildWrapper

jenkins.tasks.SimpleBuildWrapper

hudson.plugins.awsparameterstore.AwsParameterStoreBuildWrapper

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.BuildWrapper>

public class AwsParameterStoreBuildWrapper
extends jenkins.tasks.SimpleBuildWrapper

A Jenkins BuildWrapper for AWS Parameter Store.

Author:

Rik Turnbull

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AwsParameterStoreBuildWrapper.DescriptorImpl A Jenkins BuildWrapperDescriptor for the AwsParameterStoreBuildWrapper.

Nested classes/interfaces inherited from class jenkins.tasks.SimpleBuildWrapper

jenkins.tasks.SimpleBuildWrapper.Context, jenkins.tasks.SimpleBuildWrapper.Disposer

Nested classes/interfaces inherited from class hudson.tasks.BuildWrapper

hudson.tasks.BuildWrapper.Environment

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
AwsParameterStoreBuildWrapper() Creates a new AwsParameterStoreBuildWrapper.
AwsParameterStoreBuildWrapper(String credentialsId, String regionName, String path, Boolean recursive, String naming, String namePrefixes) Deprecated.

Method Summary

Modifier and Type	Method and Description
String	getCredentialsId() Gets AWS credentials identifier.
String	getNamePrefixes() Gets namePrefixes (comma separated)
String	getNaming() Gets naming: basename, absolute, relative.
String	getPath() Gets path.
Boolean	getRecursive() Gets recursive flag.
String	getRegionName() Gets AWS region name.
void	setCredentialsId(String credentialsId) Sets the AWS credentials identifier.
void	setNamePrefixes(String namePrefixes) Sets the name prefixes filter.
void	setNaming(String naming) Sets the naming type: basename, absolute, relative.
void	setPath(String path) Sets the AWS Parameter Store hierarchy.
void	setRecursive(Boolean recursive) Sets the recursive flag.
void	setRegionName(String regionName) Sets the AWS region name.
void	setUp(jenkins.tasks.SimpleBuildWrapper.Context context, hudson.model.Run<?,?> run, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener, hudson.EnvVars initialEnvironment)

Methods inherited from class jenkins.tasks.SimpleBuildWrapper

createLoggerDecorator, decorateLauncher, decorateLogger, getProjectActions, makeBuildVariables, makeSensitiveBuildVariables, preCheckout, runPreCheckout, setUp

Methods inherited from class hudson.tasks.BuildWrapper

all, getProjectAction, setUp

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

AwsParameterStoreBuildWrapper

@DataBoundConstructor
public AwsParameterStoreBuildWrapper()

Creates a new AwsParameterStoreBuildWrapper.

AwsParameterStoreBuildWrapper

@Deprecated
public AwsParameterStoreBuildWrapper(String credentialsId,
                                                 String regionName,
                                                 String path,
                                                 Boolean recursive,
                                                 String naming,
                                                 String namePrefixes)

Deprecated.

Creates a new AwsParameterStoreBuildWrapper.

Parameters:

credentialsId - aws credentials id

regionName - aws region name

path - hierarchy for the parameter

recursive - fetch all parameters within a hierarchy

naming - environment variable naming: basename, absolute, relative

namePrefixes - filter parameters by Name with beginsWith filter

Method Detail

getCredentialsId

public String getCredentialsId()

Gets AWS credentials identifier.

Returns:

AWS credentials identifier

setCredentialsId

@DataBoundSetter
public void setCredentialsId(String credentialsId)

Sets the AWS credentials identifier.

Parameters:

credentialsId - aws credentials id

getRegionName

public String getRegionName()

Gets AWS region name.

Returns:

aws region name

setRegionName

@DataBoundSetter
public void setRegionName(String regionName)

Sets the AWS region name.

Parameters:

regionName - aws region name

getPath

public String getPath()

Gets path.

Returns:

path

setPath

@DataBoundSetter
public void setPath(String path)

Sets the AWS Parameter Store hierarchy.

Parameters:

path - aws parameter store hierarchy

getRecursive

public Boolean getRecursive()

Gets recursive flag.

Returns:

recursive

setRecursive

@DataBoundSetter
public void setRecursive(Boolean recursive)

Sets the recursive flag.

Parameters:

recursive - recursive flag

getNaming

public String getNaming()

Gets naming: basename, absolute, relative.

Returns:

naming.

setNaming

@DataBoundSetter
public void setNaming(String naming)

Sets the naming type: basename, absolute, relative.

Parameters:

naming - the naming type

getNamePrefixes

public String getNamePrefixes()

Gets namePrefixes (comma separated)

Returns:

namePrefixes.

setNamePrefixes

@DataBoundSetter
public void setNamePrefixes(String namePrefixes)

Sets the name prefixes filter.

Parameters:

namePrefixes - name prefixes filter

setUp

public void setUp(jenkins.tasks.SimpleBuildWrapper.Context context,
                  hudson.model.Run<?,?> run,
                  hudson.FilePath workspace,
                  hudson.Launcher launcher,
                  hudson.model.TaskListener listener,
                  hudson.EnvVars initialEnvironment)
           throws IOException,
                  InterruptedException

Specified by:

setUp in class jenkins.tasks.SimpleBuildWrapper

Throws:

IOException

InterruptedException