cdk-ghost-string-parameter.ghoststringparameter.md

Home > @codemonger-io/cdk-ghost-string-parameter > GhostStringParameter

GhostStringParameter class

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

String parameter stored in Parameter Store on AWS Systems Manager.

Signature:

export declare class GhostStringParameter 

Remarks

The main goal of this class is to provide access control over a parameter in Parameter Store on AWS Systems Manager.

To grant access to parameters stored in Parameter Store on AWS Systems Manager, the simplest way is to use CDK's StringParameter. However, to instantiate a StringParameter, you have to provision it in the CDK stack or bind it to an already existing one; you cannot bind a StringParameter to a parameter supposed to exist afterwards.

You can bind this class to a parameter that does not exist in Parameter Store on AWS Systems Manager without provisioning it.

Note that this class is not a Construct.

Constructors

Constructor	Modifiers	Description
(constructor)(scope, props)		(BETA) Constructs a new instance of the GhostStringParameter class

Properties

Property	Modifiers	Type	Description
parameterName	readonly	string	(BETA) Name of this parameter.
scope	readonly	Construct	(BETA) Scope of this parameter.

Methods

Method	Modifiers	Description
grantRead(grantee)		(BETA) Allows a given principal to read this parameter.