Description:
awscdkssmsdkparameter 0.0.9
aws-cdk-ssm-sdk-parameter
Thats an AWS CDK Construct for get and set the value of an SSM parameter. It is designed to be loose coupled and be not managed through AWS CDK / Cloudformation so that the SSM parameter can exist across different stacks and be updated without causing a drift. The looseness is reached through using CFN Custom Resources.
The implementation simply leverages AwsCustomResource as an SDK wrapper for:
https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/get-parameter.html https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_GetParameter.html
https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/put-parameter.html https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html
https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/delete-parameter.html https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_DeleteParameter.html
Features
If the parameter doesn't exist, it will be created. Otherwise it pulls the current value of the parameter.
optional delete when destroying the stack
Use Case
Initialize a parameter to some value upon creation, but allow it to diverge during future CDK deployments.
SSM StringParameter APP_VERSION of an image is used across ECS deployments. New ECS deployments use that latest version value in it. APP_VERSION isn't managed / editable with CDK but if APP_VERSION wouldn't exist you can specify kind of default.
Example
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
stack = cdk.Stack(app, "ssm-demo-stack", env=env)
# Create a loose coupled SSM Parameter from type String
SSMParameter(stack, "SSMParameter",
parameter_name="fooString",
default_value="fooValue"
)
# Create a loose coupled SSM Parameter from type StringList
SSMParameter(stack, "SSMParameterStringList",
parameter_name="fooStringList",
default_value="fooValue1,fooValue2,fooValue3",
type=SSMParameterType.StringList
)
# Delete the SSM Parameter if the stack gets deleted
SSMParameter(stack, "SSMParameterWithDelete",
parameter_name="fooWithDelete",
default_value="fooValue",
delete=True
)
Local Testing
For local testing simply run
yarn deploy --profile X
For destroying use
yarn destroy --profile X
Limitation
SSM SecureString Parameter are not supported
default description are not supported
License
For personal and professional use. You cannot resell or redistribute these repositories in their original state.
Customer Reviews
There are no reviews.
