@aws-cdk/aws-ssm
Advanced tools
Package description
@aws-cdk/aws-ssm is an AWS Cloud Development Kit (CDK) library that allows you to interact with AWS Systems Manager (SSM) services. It provides constructs for defining and managing SSM parameters, documents, and associations within your CDK applications.
Create SSM Parameter
This feature allows you to create a new SSM parameter. The code sample demonstrates how to create a string parameter named 'myParameter' with the value 'myValue'.
const ssm = require('@aws-cdk/aws-ssm');
const cdk = require('@aws-cdk/core');
const app = new cdk.App();
const stack = new cdk.Stack(app, 'MyStack');
new ssm.StringParameter(stack, 'MyParameter', {
parameterName: 'myParameter',
stringValue: 'myValue',
});
app.synth();Retrieve SSM Parameter
This feature allows you to retrieve an existing SSM parameter. The code sample demonstrates how to retrieve a string parameter named 'myParameter' and log its value.
const ssm = require('@aws-cdk/aws-ssm');
const cdk = require('@aws-cdk/core');
const app = new cdk.App();
const stack = new cdk.Stack(app, 'MyStack');
const parameter = ssm.StringParameter.fromStringParameterName(stack, 'MyParameter', 'myParameter');
console.log(parameter.stringValue);Create SSM Document
This feature allows you to create a new SSM document. The code sample demonstrates how to create a document with a shell script that echoes 'Hello World'.
const ssm = require('@aws-cdk/aws-ssm');
const cdk = require('@aws-cdk/core');
const app = new cdk.App();
const stack = new cdk.Stack(app, 'MyStack');
new ssm.CfnDocument(stack, 'MyDocument', {
content: JSON.stringify({
schemaVersion: '2.2',
description: 'My SSM Document',
mainSteps: [
{
action: 'aws:runShellScript',
name: 'exampleStep',
inputs: {
runCommand: ['echo Hello World']
}
}
]
}),
documentType: 'Command'
});
app.synth();The aws-sdk package is the official AWS SDK for JavaScript, which provides a comprehensive set of tools for interacting with AWS services, including SSM. Unlike @aws-cdk/aws-ssm, which is focused on infrastructure as code, aws-sdk is more general-purpose and can be used for a wide range of AWS service interactions.
The serverless-ssm-fetch package is a Serverless Framework plugin that allows you to fetch SSM parameters and use them in your serverless applications. It is more specialized than @aws-cdk/aws-ssm and is designed specifically for use with the Serverless Framework.
The ssm-parameter-store package is a lightweight library for interacting with AWS SSM Parameter Store. It provides a simple API for getting and setting parameters, but lacks the broader infrastructure management capabilities of @aws-cdk/aws-ssm.
Changelog
1.72.0 (2020-11-06)
enableHttpEndpoint renamed to enableDataApioutputLocation in the experimental Athena StartQueryExecution has been changed to s3.Location from stringEnvironment from attributes (#10932) (d395b5e), closes #10931--no-previous-parameters incorrectly skips updates (#11288) (1bfc649)Readme
This module is part of the AWS Cloud Development Kit project.
Install the module:
$ npm i @aws-cdk/aws-ssm
Import it into your code:
import * as ssm from '@aws-cdk/aws-ssm';
You can reference existing SSM Parameter Store values that you want to use in
your CDK app by using ssm.ParameterStoreString:
You can create either ssm.StringParameter or ssm.StringListParameters in
a CDK app. These are public (not secret) values. Parameters of type
SecretString cannot be created directly from a CDK application; if you want
to provision secrets automatically, use Secrets Manager Secrets (see the
@aws-cdk/aws-secretsmanager package).
new ssm.StringParameter(stack, 'Parameter', {
allowedPattern: '.*',
description: 'The value Foo',
parameterName: 'FooParameter',
stringValue: 'Foo',
tier: ssm.ParameterTier.ADVANCED,
});
When specifying an allowedPattern, the values provided as string literals
are validated against the pattern and an exception is raised if a value
provided does not comply.
FAQs
The CDK Construct Library for AWS::SSM
We found that @aws-cdk/aws-ssm demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.