@aws-cdk/aws-ssm
Advanced tools
@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.
This module is part of the AWS Cloud Development Kit project.
0.22.0 (2019-01-10)
This is a major release with multiple breaking changes in the core layers. Please consult the breaking changes section below for details.
We are focusing these days on finalizing the common patterns and APIs of the CDK framework and the AWS Construct Library, which is why you are seeing all these breaking changes. Expect a few more releases with changes of that nature as we stabilize these APIs, so you might want to hold off with upgrading. We will communicate when this foundational work is complete.
export() and import() to share constructs between stacks, you can stop doing that, instead of FooImportProps accept an IFoo directly on the consuming stack, and use that object as usual.ArnUtils.fromComponents() and ArnUtils.parse() have been moved onto Stack.AWS::AccountId etc) are now also accessible via Stack, as stack.accountId etc.Fn class (e.g. Fn.join(...) instead of new FnJoin(...).toString())resolve() has been moved to this.node.resolve().CloudFormationJSON.stringify() has been moved to this.node.stringifyJson(). validate() now should be protected.cloudformation.XxxResource classes have been removed. Use the CfnXxx classes instead.CfnXxx resource attributes that represented a list of strings are now typed as string[]s (via #1144). Attributes that represent strings, are still typed as string (#712) and all other attribute types are represented as cdk.Token.route53.TXTRecord class was renamed to route53.TxtRecord.zone when created (not assuming zone is the parent construct).lambda.FunctionRef to lambda.Function.XxxRef abstract classes are now IXxx interfacesXxxRefProps are now XxxImportPropsXxxRef.import(...) are now Xxx.import(...) accept XxxImportProps and return IXxxexport(): XxxImportProps is now defined in IXxx and implemented by imported resourcesFAQs
The CDK Construct Library for AWS::SSM
The npm package @aws-cdk/aws-ssm receives a total of 83,109 weekly downloads. As such, @aws-cdk/aws-ssm popularity was classified as popular.
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.
Security News
Elastic’s return to open source with the AGPL license has been met with skepticism, as many developers see it as a strategic move rather than a genuine effort to restore user trust and freedoms.
Security News
A new "revival hijack" supply chain attack targets deleted Python packages, with an estimated 22K packages at risk. Socket can detect and block hijacked packages that have added malicious code.
Product
We're introducing a new Analytics feature in the Socket dashboard so you can view changes in your organization's and repositories' alerts over time.