Skip to content

Latest commit

 

History

History
75 lines (51 loc) · 2.65 KB

README.ja.md

File metadata and controls

75 lines (51 loc) · 2.65 KB

English / 日本語

Ghost String Parameter for CDK

AWS Systems ManagerのParameter Storeに格納されたパラメータに対するアクセスコントロールを提供します。

このライブラリはAWS Cloud Development Kit (CDK)バージョン2と組み合わせる想定です。

インストール

npm install https://github.com/codemonger-io/cdk-ghost-string-parameter.git#v0.1.1

サンプル

このライブラリが提供する唯一のクラスがGhostStringParameterです。 以下は使用例です。

import { GhostStringParameter } from 'cdk-ghost-string-parameter';
import { aws_iam as iam } from 'aws-cdk-lib';
import { Construct } from 'constructs';

class SampleConstruct extends Construct {
    readonly parameter: GhostStringParameter;

    constructor(scope: Construct, id: string) {
        super(scope, id);

        this.parameter = new GhostStringParameter(this, {
            parameterName: '/parameters/SAMPLE_PARAMETER'
        });
    }

    grantReadParameter(grantee: iam.IGrantable): iam.Grant {
        return this.parameter.grantRead(grantee);
    }
}

APIドキュメント

APIドキュメントはapi-docs/markdownにあります(英語版のみ)。

動機

CDKでAWS Systems ManagerのParameter Storeに格納されているパラメータを表すのにaws-cdk-lib.aws_ssm.StringParameter (StringParameter)が使えます。 StringParameterを使うと、grantReadなどのAPIを通じてパラメータに対するアクセスコントロールが行えます。 ところが、StringParameterを使うには、

  • CDKスタックでパラメータをプロビジョンするか、
  • 既存のパラメータにバインドするかしなければなりません。

CDKスタックをデプロイした後にパラメータを作成したい場合は、残念ながらStringParameterを使うことはできません。 デプロイ時に存在しないパラメータに対してプロビジョンせずにアクセスコントロールを行いたいときに、このライブラリが役に立つかもしれません。

開発

依存関係の解決

npm ci

ビルド

npm run build

APIドキュメントの生成

npm run build:doc