com.amazonaws.codedeploy

Class AWSCodeDeployPublisher

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

com.amazonaws.codedeploy.AWSCodeDeployPublisher

All Implemented Interfaces:

hudson.model.Describable<hudson.tasks.Publisher>, hudson.tasks.BuildStep, jenkins.tasks.SimpleBuildStep

public class AWSCodeDeployPublisher
extends hudson.tasks.Publisher
implements jenkins.tasks.SimpleBuildStep

The AWS CodeDeploy Publisher is a post-build plugin that adds the ability to start a new CodeDeploy deployment with the project's workspace as the application revision. To configure, users must create an IAM role that allows "S3" and "CodeDeploy" actions and must be assumable by the globally configured keys. This allows the plugin to get temporary credentials instead of requiring permanent credentials to be configured for each project.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AWSCodeDeployPublisher.DescriptorImpl Descriptor for AWSCodeDeployPublisher.

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

hudson.tasks.Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

jenkins.tasks.SimpleBuildStep.LastBuildAction, jenkins.tasks.SimpleBuildStep.LastBuildActionFactory

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_POLLING_FREQUENCY_SECONDS
static long	DEFAULT_TIMEOUT_SECONDS
static String	ROLE_SESSION_NAME

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description

AWSCodeDeployPublisher(String s3bucket, String s3prefix, String applicationName, String deploymentGroupName, String deploymentConfig, String region, Boolean deploymentGroupAppspec, Boolean waitForCompletion, Long pollingTimeoutSec, Long pollingFreqSec, String credentials, String versionFileName, String deploymentMethod, String awsAccessKey, String awsSecretKey, String iamRoleArn, String externalId, String includes, String proxyHost, int proxyPort, String excludes, String subdirectory)

Method Summary

Modifier and Type	Method and Description
String	getApplicationName()
String	getApplicationNameFromEnv(Map<String,String> envVars)
String	getAwsAccessKey()
hudson.util.Secret	getAwsSecretKey()
String	getCredentials()
String	getDeploymentConfig()
String	getDeploymentConfigFromEnv(Map<String,String> envVars)
boolean	getDeploymentGroupAppspec()
String	getDeploymentGroupName()
String	getDeploymentGroupNameFromEnv(Map<String,String> envVars)
String	getDeploymentMethod()
AWSCodeDeployPublisher.DescriptorImpl	getDescriptor()
String	getExcludes()
String	getExternalId()
String	getIamRoleArn()
String	getIncludes()
Long	getPollingFreqSec()
Long	getPollingTimeoutSec()
String	getProxyHost()
int	getProxyPort()
String	getRegion()
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
String	getS3bucket()
String	getS3BucketFromEnv(Map<String,String> envVars)
String	getS3prefix()
String	getS3PrefixFromEnv(Map<String,String> envVars)
String	getSubdirectory()
String	getSubdirectoryFromEnv(Map<String,String> envVars)
String	getVersionFileName()
boolean	getWaitForCompletion()
void	perform(hudson.model.Run<?,?> build, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, perform, prebuild

Field Detail

DEFAULT_TIMEOUT_SECONDS

public static final long DEFAULT_TIMEOUT_SECONDS

See Also:

Constant Field Values

DEFAULT_POLLING_FREQUENCY_SECONDS

public static final long DEFAULT_POLLING_FREQUENCY_SECONDS

See Also:

Constant Field Values

ROLE_SESSION_NAME

public static final String ROLE_SESSION_NAME

See Also:

Constant Field Values

Constructor Detail

AWSCodeDeployPublisher

@DataBoundConstructor
public AWSCodeDeployPublisher(String s3bucket,
                                                    String s3prefix,
                                                    String applicationName,
                                                    String deploymentGroupName,
                                                    String deploymentConfig,
                                                    String region,
                                                    Boolean deploymentGroupAppspec,
                                                    Boolean waitForCompletion,
                                                    Long pollingTimeoutSec,
                                                    Long pollingFreqSec,
                                                    String credentials,
                                                    String versionFileName,
                                                    String deploymentMethod,
                                                    String awsAccessKey,
                                                    String awsSecretKey,
                                                    String iamRoleArn,
                                                    String externalId,
                                                    String includes,
                                                    String proxyHost,
                                                    int proxyPort,
                                                    String excludes,
                                                    String subdirectory)

Method Detail

perform

public void perform(@Nonnull
                    hudson.model.Run<?,?> build,
                    @Nonnull
                    hudson.FilePath workspace,
                    @Nonnull
                    hudson.Launcher launcher,
                    @Nonnull
                    hudson.model.TaskListener listener)
             throws IOException,
                    InterruptedException

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Throws:

IOException

InterruptedException

getDescriptor

public AWSCodeDeployPublisher.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Publisher>

Overrides:

getDescriptor in class hudson.tasks.Publisher

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface hudson.tasks.BuildStep

getApplicationName

public String getApplicationName()

getDeploymentGroupName

public String getDeploymentGroupName()

getDeploymentConfig

public String getDeploymentConfig()

getS3bucket

public String getS3bucket()

getS3prefix

public String getS3prefix()

getPollingTimeoutSec

public Long getPollingTimeoutSec()

getIamRoleArn

public String getIamRoleArn()

getAwsAccessKey

public String getAwsAccessKey()

getAwsSecretKey

public hudson.util.Secret getAwsSecretKey()

getPollingFreqSec

public Long getPollingFreqSec()

getExternalId

public String getExternalId()

getDeploymentMethod

public String getDeploymentMethod()

getVersionFileName

public String getVersionFileName()

getWaitForCompletion

public boolean getWaitForCompletion()

getDeploymentGroupAppspec

public boolean getDeploymentGroupAppspec()

getCredentials

public String getCredentials()

getIncludes

public String getIncludes()

getExcludes

public String getExcludes()

getSubdirectory

public String getSubdirectory()

getRegion

public String getRegion()

getProxyHost

public String getProxyHost()

getProxyPort

public int getProxyPort()

getApplicationNameFromEnv

public String getApplicationNameFromEnv(Map<String,String> envVars)

getDeploymentGroupNameFromEnv

public String getDeploymentGroupNameFromEnv(Map<String,String> envVars)

getDeploymentConfigFromEnv

public String getDeploymentConfigFromEnv(Map<String,String> envVars)

getS3BucketFromEnv

public String getS3BucketFromEnv(Map<String,String> envVars)

getS3PrefixFromEnv

public String getS3PrefixFromEnv(Map<String,String> envVars)

getSubdirectoryFromEnv

public String getSubdirectoryFromEnv(Map<String,String> envVars)