The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.
For a list of other such plugins, see the Pipeline Steps Reference page.
awaitDeploymentCompletion
: Wait for AWS CodeDeploy deployment completionawsIdentity
: Print and return the AWS identitycfInvalidate
: Invalidate given paths in CloudFront distributioncfnCreateChangeSet
: Create CloudFormation change setcfnDelete
: Delete CloudFormation stackcfnDeleteStackSet
: Delete CloudFormation Stack SetcfnDescribe
: Describe outputs of CloudFormation stackcfnExecuteChangeSet
: Execute CloudFormation change setcfnExports
: Describe CloudFormation global exportscfnUpdate
: Create or Update CloudFormation stackcfnUpdateStackSet
: Create or Update CloudFormation Stack SetcfnValidate
: Validate CloudFormation templatecreateDeployment
: Deploys an application revision through the specified deployment group (AWS CodeDeploy).deployAPI
: Deploy the given API Gateway APIebCreateApplication
: Creates a new Elastic Beanstalk applicationebCreateApplicationVersion
: Creates a new version for an elastic beanstalk applicationebCreateConfigurationTemplate
: Creates a new configuration template for an elastic beanstalk applicationebCreateEnvironment
: Creates a new Elastic Beanstalk environmentebSwapEnvironmentCNAMEs
: Swaps the CNAMEs of two elastic beanstalk environments.ebWaitOnEnvironmentHealth
: Waits until the specified environment application becomes availableebWaitOnEnvironmentStatus
: Waits until the specified environment becomes availableec2ShareAmi
: Share an AMI with other accountsecrDeleteImage
: Delete ecr imagesecrListImages
: List ECR ImagesecrLogin
: Create and return the ECR login stringecrSetRepositoryPolicy
: Set ECR Repository PolicyelbDeregisterInstance
: Deregisters the specified instances from the specified load balancer.elbIsInstanceDeregistered
: Registers the specified instances from the specified load balancer.elbIsInstanceRegistered
: Registers the specified instances from the specified load balancer.elbRegisterInstance
: Registers the specified instances from the specified load balancer.invokeLambda
: Invoke a given Lambda functionlambdaVersionCleanup
: Cleanup old lambda versionslistAWSAccounts
: List all AWS accounts of the organizations3Copy
: Copy file between S3 bucketss3Delete
: Delete file from S3s3DoesObjectExist
: Check if object exists in S3s3Download
: Copy file from S3s3FindFiles
: Find files in S3s3PresignURL
: Presign file in S3s3Upload
: Copy file to S3setAccountAlias
: Set the AWS account aliassnsPublish
: Publish notification to SNSupdateIdP
: Update thirdparty Identity ProviderupdateTrustPolicy
: Update trust policy of IAM roleswithAWS
: set AWS settings for nested blockcfInvalidate
: Invalidate given paths in CloudFront distributiondistribution
String
paths
String
waitForCompletion
(optional)
boolean
cfnCreateChangeSet
: Create CloudFormation change setchangeSet
String
stack
String
create
(optional)
boolean
file
(optional)
String
keepParams
(optional)
String
notificationARNs
(optional)
String
onFailure
(optional)
String
params
(optional)
Object
paramsFile
(optional)
String
pollInterval
(optional)
long
roleArn
(optional)
String
rollbackTimeoutInMinutes
(optional)
int
rollbackTriggers
(optional)
String
tags
(optional)
String
tagsFile
(optional)
String
template
(optional)
String
timeoutInMinutes
(optional)
long
timeoutInSeconds
(optional)
long
url
(optional)
String
cfnDelete
: Delete CloudFormation stackDelete Cloudformation Templates
stack
String
clientRequestToken
(optional)
String
pollInterval
(optional)
long
retainResources
(optional)
String
roleArn
(optional)
String
timeoutInMinutes
(optional)
long
cfnDeleteStackSet
: Delete CloudFormation Stack SetstackSet
String
pollInterval
(optional)
long
cfnExecuteChangeSet
: Execute CloudFormation change setchangeSet
String
stack
String
pollInterval
(optional)
long
timeoutInMinutes
(optional)
long
timeoutInSeconds
(optional)
long
cfnUpdate
: Create or Update CloudFormation stackstack
String
create
(optional)
boolean
enableTerminationProtection
(optional)
boolean
file
(optional)
String
keepParams
(optional)
String
notificationARNs
(optional)
String
onFailure
(optional)
String
params
(optional)
Object
paramsFile
(optional)
String
pollInterval
(optional)
long
roleArn
(optional)
String
rollbackTimeoutInMinutes
(optional)
int
rollbackTriggers
(optional)
String
tags
(optional)
String
tagsFile
(optional)
String
template
(optional)
String
timeoutInMinutes
(optional)
long
timeoutInSeconds
(optional)
long
url
(optional)
String
cfnUpdateStackSet
: Create or Update CloudFormation Stack SetstackSet
String
administratorRoleArn
(optional)
String
batchingOptions
(optional)
regions
boolean
create
(optional)
boolean
executionRoleName
(optional)
String
file
(optional)
String
keepParams
(optional)
String
notificationARNs
(optional)
String
onFailure
(optional)
String
operationPreferences
(optional)
failureToleranceCount
(optional)
int
failureTolerancePercentage
(optional)
int
maxConcurrentCount
(optional)
int
maxConcurrentPercentage
(optional)
int
regionOrder
(optional)
String
params
(optional)
Object
paramsFile
(optional)
String
pollInterval
(optional)
long
rollbackTimeoutInMinutes
(optional)
int
rollbackTriggers
(optional)
String
tags
(optional)
String
tagsFile
(optional)
String
template
(optional)
String
timeoutInMinutes
(optional)
long
timeoutInSeconds
(optional)
long
url
(optional)
String
cfnValidate
: Validate CloudFormation templatefile
(optional)
String
url
(optional)
String
createDeployment
: Deploys an application revision through the specified deployment group (AWS CodeDeploy).applicationName
(optional)
String
deploymentConfigName
(optional)
String
deploymentGroupName
(optional)
String
description
(optional)
String
fileExistsBehavior
(optional)
String
gitHubCommitId
(optional)
String
gitHubRepository
(optional)
String
ignoreApplicationStopFailures
(optional)
boolean
s3Bucket
(optional)
String
s3BundleType
(optional)
String
s3Key
(optional)
String
waitForCompletion
(optional)
boolean
deployAPI
: Deploy the given API Gateway APIapi
String
stage
String
description
(optional)
String
variables
(optional)
String
ebCreateApplication
: Creates a new Elastic Beanstalk applicationapplicationName
String
description
(optional)
String
ebCreateApplicationVersion
: Creates a new version for an elastic beanstalk applicationapplicationName
String
versionLabel
String
s3Bucket
String
s3Key
String
description
(optional)
String
ebCreateConfigurationTemplate
: Creates a new configuration template for an elastic beanstalk applicationapplicationName
String
templateName
String
description
(optional)
String
environmentId
(optional)
String
solutionStackName
(optional)
String
sourceConfigurationApplication
(optional)
String
sourceConfigurationTemplate
(optional)
String
ebCreateEnvironment
: Creates a new Elastic Beanstalk environmentapplicationName
String
environmentName
String
description
(optional)
String
solutionStackName
(optional)
String
templateName
(optional)
String
updateOnExisting
(optional)
boolean
versionLabel
(optional)
String
ebSwapEnvironmentCNAMEs
: Swaps the CNAMEs of two elastic beanstalk environments.destinationEnvironmentId
(optional)
String
destinationEnvironmentName
(optional)
String
sourceEnvironmentId
(optional)
String
sourceEnvironmentName
(optional)
String
ebWaitOnEnvironmentHealth
: Waits until the specified environment application becomes availableapplicationName
String
environmentName
String
health
(optional)
String
stabilityThreshold
(optional)
int
ebWaitOnEnvironmentStatus
: Waits until the specified environment becomes availableapplicationName
String
environmentName
String
status
(optional)
String
ec2ShareAmi
: Share an AMI with other accountsaccountIds
(optional)
String
amiId
(optional)
String
ecrDeleteImage
: Delete ecr imagesimageIds
(optional)
imageDigest
(optional)
String
imageTag
(optional)
String
registryId
(optional)
String
repositoryName
(optional)
String
ecrListImages
: List ECR Imagesfilter
(optional)
tagStatus
(optional)
String
registryId
(optional)
String
repositoryName
(optional)
String
ecrLogin
: Create and return the ECR login stringemail
(optional)
boolean
registryIds
(optional)
String
ecrSetRepositoryPolicy
: Set ECR Repository PolicypolicyText
(optional)
String
registryId
(optional)
String
repositoryName
(optional)
String
elbDeregisterInstance
: Deregisters the specified instances from the specified load balancer.targetGroupARN
(optional)
String
instanceID
(optional)
String
port
(optional)
int
elbIsInstanceDeregistered
: Registers the specified instances from the specified load balancer.targetGroupARN
(optional)
String
instanceID
(optional)
String
port
(optional)
int
elbIsInstanceRegistered
: Registers the specified instances from the specified load balancer.targetGroupARN
(optional)
String
instanceID
(optional)
String
port
(optional)
int
elbRegisterInstance
: Registers the specified instances from the specified load balancer.targetGroupARN
(optional)
String
instanceID
(optional)
String
port
(optional)
int
invokeLambda
: Invoke a given Lambda functionfunctionName
String
payload
(optional)
Object
payloadAsString
(optional)
String
returnValueAsString
(optional)
boolean
lambdaVersionCleanup
: Cleanup old lambda versionsdaysAgo
int
functionName
(optional)
String
stackName
(optional)
String
s3Copy
: Copy file between S3 bucketsCopy file between S3 buckets.
fromBucket
String
fromPath
String
toBucket
String
toPath
String
pathStyleAccessEnabled
(optional)
boolean
payloadSigningEnabled
(optional)
boolean
acl
(optional)
Canned ACL to add to the new file.
Private
, PublicRead
, PublicReadWrite
, AuthenticatedRead
, LogDeliveryWrite
, BucketOwnerRead
, BucketOwnerFullControl
, AwsExecRead
cacheControl
(optional)
String
contentDisposition
(optional)
String
contentType
(optional)
String
kmsId
(optional)
String
metadatas
(optional)
String
sseAlgorithm
(optional)
String
s3Delete
: Delete file from S3Delete a file/folder from S3. If the path ends in a "/", then the path will be interpreted to be a folder, and all of its contents will be removed.
bucket
String
path
This is the path inside the bucket to delete. If this ends in a "/", then the path will be interpreted to be a folder, and all of its contents will be removed.
Do not begin with a leading "/".
String
pathStyleAccessEnabled
(optional)
boolean
payloadSigningEnabled
(optional)
boolean
s3DoesObjectExist
: Check if object exists in S3Check if object exists in S3 bucket.
bucket
String
path
String
pathStyleAccessEnabled
(optional)
boolean
payloadSigningEnabled
(optional)
boolean
s3Download
: Copy file from S3Download a file/folder from S3 to the local workspace. Set optional parameter force to true to overwrite any existing files in workspace. If the path ends with a /, then the complete virtual directory will be downloaded.
file
String
bucket
String
pathStyleAccessEnabled
(optional)
boolean
payloadSigningEnabled
(optional)
boolean
force
(optional)
boolean
path
(optional)
String
s3FindFiles
: Find files in S3Return a list of all of the files/folders in the bucket. If path is given, then it will be used as the root of the search. Results are returned relative to path; if path is not given, then the results will contain the full S3 path.
The following all ultimately return one item referring to "path/to/my/file.ext"; however, by limiting the scope via path, the results are different.
List every file in the bucket:
The return format is identical to that of the findFiles step. This will return an array of FileWrapper instances with the following properties:
bucket
String
pathStyleAccessEnabled
(optional)
boolean
payloadSigningEnabled
(optional)
boolean
glob
(optional)
This is the glob to use to match files/folders. You may use a full file name/path (for example "path/to/file.ext"), but you may also use a glob (for example, "path/t*/file.*").
If left blank, this will perform the equivalent function of "*".
To list absolutely everything, use "**".
String
onlyFiles
(optional)
boolean
path
(optional)
String
s3PresignURL
: Presign file in S3bucket
String
key
String
httpMethod
String
durationInSeconds
int
pathStyleAccessEnabled
(optional)
boolean
payloadSigningEnabled
(optional)
boolean
s3Upload
: Copy file to S3Upload a file/folder from the workspace to an S3 bucket. If the file parameter denotes a directory, then the complete directory (including all subfolders) will be uploaded. If text is provided, upload the text as the provided filename in the remote S3 bucket.
bucket
String
pathStyleAccessEnabled
(optional)
boolean
payloadSigningEnabled
(optional)
boolean
acl
(optional)
Canned ACL to add to the upload request.
Private
, PublicRead
, PublicReadWrite
, AuthenticatedRead
, LogDeliveryWrite
, BucketOwnerRead
, BucketOwnerFullControl
, AwsExecRead
cacheControl
(optional)
String
contentDisposition
(optional)
String
contentEncoding
(optional)
String
contentType
(optional)
String
excludePathPattern
(optional)
String
file
(optional)
String
includePathPattern
(optional)
String
kmsId
(optional)
String
metadatas
(optional)
String
path
(optional)
String
redirectLocation
(optional)
String
sseAlgorithm
(optional)
String
tags
(optional)
String
text
(optional)
String
verbose
(optional)
boolean
workingDir
(optional)
String
setAccountAlias
: Set the AWS account alias The setAccountAlias
step set the given name as AWS account alias.
name
String
snsPublish
: Publish notification to SNStopicArn
String
subject
String
message
String
messageAttributes
(optional)
java.util.Map<java.lang.String, java.lang.String>
withAWS
: set AWS settings for nested block The withAWS
step provides authorization for the nested steps. You can provide region and profile information or let Jenkins assume a role in another or the same AWS account. You can mix all parameters in one withAWS
block.
credentials
(optional)
String
duration
(optional)
int
endpointUrl
(optional)
String
externalId
(optional)
String
federatedUserId
(optional)
String
iamMfaToken
(optional)
String
policy
(optional)
String
principalArn
(optional)
String
profile
(optional)
String
region
(optional)
String
role
(optional)
String
roleAccount
(optional)
String
roleSessionName
(optional)
String
samlAssertion
(optional)
String
useNode
(optional)
boolean
Please submit your feedback about this page through this quick form.
Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?
See existing feedback here.