Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

You can use the AWS Systems Manager Parameter task to put, get or delete secrets and configuration data as an AWS Systems Manager (SSM) Parameter Store parameter.

Image Removed

Panel
borderColor#bbb
bgColor#eeeeee

Image Added

Configuration

To configure an AWS Systems Manager Parameter task:

1. Navigate to the Tasks configuration tab for the job (this will be the default job if creating a new plan).

2. Click the name of an existing AWS Systems Manager Parameter task, or click Add Task and then AWS Systems Manager

Parameter 

Parameter to create a new task.

3. Complete the following settings:

a. Common to all tasks

Include Page
_CommonTaskParametersTable
_CommonTaskParametersTable

b. Actions supported by this task:

Put Parameter

Name

Specify the parameter name.

Description

Specify a parameter description.

Type

Select the parameter type.

Key ID

Specify the KMS Key ID that you want to use to encrypt a parameter (only for SecureString data type, leave empty to use the default key associated with your AWS account).

Allowed Pattern

Specify a regular expression used to validate the parameter value.

Overwrite

Check to allow overwrite (update) of an existing parameter.

Advanced

Tier

Select the tier to use for the parameter.


Get Parameter


Tip
title

Integration with AWS Secrets Manager

Besides natively supporting encrypted Secure String Parameters, the AWS Systems Manager Parameter Store is also integrated with the dedicated AWS Secrets Manager and allows Referencing AWS Secrets Manager Secrets from Parameter Store Parameters.


Name

see Put Parameter above

With Decryption

Check to return decrypted values for secure string parameters.

Delete Parameter


Name

see Put Parameter above

Label Parameter Version


Name

see Put Parameter above

Labels

Specify one or more labels to attach to the specified parameter version.

(Optional) Version

Specify the version of the parameter you want to label (leave empty to label latest version).


Variables

Include Page
_VariablesNote
_VariablesNote

Put Parameter

Code Block
languagetext
linenumbers
true
Creating common variables for 1 resources affected by task:
... bamboo.custom.aws.systemsmanager.parameter.resources: /taws-it280/4/ubot
Creating resource variables for parameter '/taws-it280/4/ubot':
... bamboo.custom.aws.systemsmanager.parameter.resources./taws-it280/4/ubot.Name: /taws-it280/4/ubot
... bamboo.custom.aws.systemsmanager.parameter.resources./taws-it280/4/ubot.Tier: Standard
... bamboo.custom.aws.systemsmanager.parameter.resources./taws-it280/4/ubot.Version: 1
Creating common variables for first resource affected by task:
Creating resource variables for parameter '/taws-it280/4/ubot':
... bamboo.custom.aws.systemsmanager.parameter.first.Name: /taws-it280/4/ubot
... bamboo.custom.aws.systemsmanager.parameter.first.Tier: Standard
... bamboo.custom.aws.systemsmanager.parameter.first.Version: 1

Get Parameter

Code Block
languagetext
linenumberstrue
Creating common variables for 1 resources affected by task:
... bamboo.custom.aws.systemsmanager.parameter.resources: /taws-it280/4/ubot
Creating resource variables for parameter '/taws-it280/4/ubot':
... bamboo.custom.aws.systemsmanager.parameter.resources./taws-it280/4/ubot.ARN: arn:aws:ssm:us-east-1:288727192237:parameter/taws-it280/4/ubot
... bamboo.custom.aws.systemsmanager.parameter.resources./taws-it280/4/ubot.Name: /taws-it280/4/ubot
... bamboo.custom.aws.systemsmanager.parameter.resources./taws-it280/4/ubot.Selector: null
... bamboo.custom.aws.systemsmanager.parameter.resources./taws-it280/4/ubot.SourceResult: null
... bamboo.custom.aws.systemsmanager.parameter.resources./taws-it280/4/ubot.Type: String
... bamboo.custom.aws.systemsmanager.parameter.resources./taws-it280/4/ubot.Value: taws-it280-4-ubot-2
... bamboo.custom.aws.systemsmanager.parameter.resources./taws-it280/4/ubot.Version: 2
... bamboo.custom.aws.systemsmanager.parameter.resources./taws-it280/4/ubot.LastModifiedDate: 20180912T125434Z
Creating common variables for first resource affected by task:
Creating resource variables for parameter '/taws-it280/4/ubot':
... bamboo.custom.aws.systemsmanager.parameter.first.ARN: arn:aws:ssm:us-east-1:288727192237:parameter/taws-it280/4/ubot
... bamboo.custom.aws.systemsmanager.parameter.first.Name: /taws-it280/4/ubot
... bamboo.custom.aws.systemsmanager.parameter.first.Selector: null
... bamboo.custom.aws.systemsmanager.parameter.first.SourceResult: null
... bamboo.custom.aws.systemsmanager.parameter.first.Type: String
... bamboo.custom.aws.systemsmanager.parameter.first.Value: taws-it280-4-ubot-2
... bamboo.custom.aws.systemsmanager.parameter.first.Version: 2
... bamboo.custom.aws.systemsmanager.parameter.first.LastModifiedDate: 20180912T125434Z

Delete Parameter

N/A

Label Parameter Version

N/A

How-to Articles

Filter by label (Content by label)
max8
showSpacefalse
sorttitle
excerptTypesimple
cqllabel in ( "aws-cli" , "aws-systems-manager" ) and label in ( "kb-how-to-article" , "kb-troubleshooting-article" )

Frequently Asked Questions (FAQ)

Include Page
UAA:_FAQHeaderQuestionsForConfluence
UAA:_FAQHeaderQuestionsForConfluence
Questionslist macro
asktrue
limit8
topicaws-systems-manager