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.
AWS SAM
samDeploy
: AWS SAM deploy application
settings
Nested Object
credentialsId : String
region : String
s3Bucket : String
The name of the S3 bucket where this command uploads the artifacts that are referenced in your template.
S3 bucket will be created automatically if it does not exist.
stackName : String
The name of the AWS SAM stack you're deploying to. If you specify an existing stack, the command updates the stack. If you specify a new stack, the command creates it.
templateFile : String
The path, relative to the workspace directory, where your AWS SAM template is located.
Examples:
template.yaml
app/template.json
kmsKeyId : String
(optional)
The ID of an AWS KMS key that the command uses to encrypt artifacts that are at rest in the S3 bucket. If not specified, SSE-AES256 is used.
outputTemplateFile : String
(optional)
The path to the file (relative to the workspace directory) where the build step writes the output AWS SAM template.
template-#jobId.yaml
by default.
parameters
(optional)
A list of key-value pairs that specify input parameters for the change set.
Array / List of Nested Object
key : String
value : String
roleArn : String
(optional)
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS SAM assumes when executing the change set.
s3Prefix : String
(optional)
A prefix name that the command adds to the artifacts' name when it uploads them to the S3 bucket. The prefix name is a path name (folder name) for the S3 bucket.
tags
(optional)
A list of tags to associate with the stack that is created or updated. AWS SAM also propagates these tags to resources in the stack.
Array / List of Nested Object
key : String
value : String
Was this page helpful?
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.