Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
@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 is a developer preview (public beta) module. Releases might lack important features and might have future breaking changes.
This API is still under active development and subject to non-backward compatible changes or removal in any future version. Use of the API is not recommended in production environments. Experimental APIs are not subject to the Semantic Versioning model.
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 ssm = require('@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.StringListParameter
s 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).
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.
0.36.0 (2019-06-24)
clusterName
from Services (#2980) (a6e4f6a)onXxx()
methods (#2921) (ea10f0d), closes #2913@aws-cdk/cdk
module was renamed to @aws-cdk/core
, python: aws_cdk.core
, java: the artifact cdk
in groupId software.amazon.awscdk
was renamed to core
@aws-cdk/cdk.Duration
instead of number
, and were renamed to exclude any unit indication.app.run()
has been removed (use app.synth()
).CfnResource.options
property was renamed to CfnResource.cfnOptions
to avoid conflicts with properties introduced by derived classes.CfnXxx.cfnResourceTypeName
is now CFN_RESOURCE_TYPE_NAME
in generated CFN resources.ContextProvider
is no longer designed to be extended. Use ContextProvider.getValue
and ContextProvider.getKey
as utilities.Context.getSsmParameter
has been removed. Use ssm.StringParameter.valueFromLookup
Context.getAvailabilityZones
has been removed. Use stack.availabilityZones
Context.getDefaultAccount
and getDefaultRegion
have been removed an no longer available. Use the environment variables CDK_DEFAULT_ACCOUNT
and CDK_DEFAULT_REGION
instead.StackProps.autoRun
was renamed to StackProps.autoSynth
.CfnElement.refAsString
renamed to ref
of string
type. The IResolvable
version have been removed.IStringValue
renamed to IStringProducer
Include
renamed to CfnInclude
Cfn
prefix was added to the following types: CfnCreationPolicy
, CfnResourceAutoScalingCreationPolicy
, CfnResourceAutoScalingCreationPolicy
, CfnDeletionPolicy
, CfnUpdatePolicy
, CfnAutoScalingRollingUpdate
, CfnAutoScalingReplacingUpdate
, CfnAutoScalingScheduledAction
, CfnCodeDeployLambdaAliasUpdate
, CfnTag
CfnRuleAssertion
, CfnDynamicReferenceProps
deepMerge
is no longer exported.CfnOutputProps.export
was renamed to exportName
.CfnOutput
all properties are now privateStringListCfnOutput
has been removedFn
were made static
, and the Fn
constructor was made private.VpcNetworkProvider
has been removed. Use Vpc.fromLookup
.ec2.MachineImage
will now resolve AMIs from SSM during deployment.ecs.EcsOptimizedAmi
will now resolve AMis from SSM during deployment.hardwareType
was STANDARD
. Now it always defaults to Amazon Linux v2.service.clusterName
has been replaced with .cluster
.requiredTransform
is now REQUIRED_TRANSFORM
in generated code.AwsCustomResource
class was moved to a new module called @aws-cdk/custom-resourcecapabilities
property is now an array to support multiple capabilities.Pipeline.crossRegionScaffoldStacks
has been renamed to crossRegionSupport
, and its type changed from CrossRegionScaffoldStack
to CrossRegionSupport
.CodeCommitAction.pollForSourceChanges
to trigger
and make it an enum.trigger
, and make it an enum.CloudFormationAction
and CloudFormationDeployAction
.HostedZoneProvider
has been removed. Use HostedZone.fromLookup
.FAQs
The CDK Construct Library for AWS::SSM
The npm package @aws-cdk/aws-ssm receives a total of 125,153 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
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.