API.md

README

@cloudcomponents/cdk-secret-key

@cloudcomponents/cdk-secret-key

Table of contents

Enumerations

• KeyType

Classes

• SecretKey
• SecretKeyStore

Secret Key

@cloudcomponents/cdk-secret-key / SecretKey

Class: SecretKey

Table of contents

Constructors

• constructor

Properties

• secretKeyType

Methods

• grantRead
• serialize
• fromPlainText
• fromSSMParameter
• fromSecretsManager

Constructors

constructor

• new SecretKey(secretKeyType)

Parameters

Name	Type
secretKeyType	KeyType

Properties

secretKeyType

• Readonly secretKeyType: KeyType

Methods

grantRead

▸ Optional Abstract grantRead(grantee): Grant

Parameters

Name	Type
grantee	IGrantable

Returns

Grant

---

serialize

▸ Abstract serialize(): string

Returns

string

---

fromPlainText

▸ Static fromPlainText(value): SecretKey

Parameters

Name	Type
value	string

Returns

SecretKey

---

fromSSMParameter

▸ Static fromSSMParameter(secretKeyParameter): SecretKey

Parameters

Name	Type
secretKeyParameter	IParameter

Returns

SecretKey

---

fromSecretsManager

▸ Static fromSecretsManager(secretKeySecret, fieldName?): SecretKey

Parameters

Name	Type
secretKeySecret	ISecret
fieldName?	string

Returns

SecretKey

Secret Key Store

@cloudcomponents/cdk-secret-key / SecretKeyStore

Class: SecretKeyStore

Table of contents

Constructors

• constructor

Properties

• secretKeyType

Methods

• grantWrite
• serialize
• fromSSMParameter
• fromSecretsManager

Constructors

constructor

• new SecretKeyStore(secretKeyType)

Parameters

Name	Type
secretKeyType	KeyType

Properties

secretKeyType

• Readonly secretKeyType: KeyType

Methods

grantWrite

▸ Abstract grantWrite(grantee): Grant

Parameters

Name	Type
grantee	IGrantable

Returns

Grant

---

serialize

▸ Abstract serialize(): string

Returns

string

---

fromSSMParameter

▸ Static fromSSMParameter(secretKeyParameter): SecretKeyStore

Parameters

Name	Type
secretKeyParameter	IParameter

Returns

SecretKeyStore

---

fromSecretsManager

▸ Static fromSecretsManager(secretKeySecret): SecretKeyStore

Parameters

Name	Type
secretKeySecret	ISecret

Returns

SecretKeyStore

Key Type

@cloudcomponents/cdk-secret-key / KeyType

Enumeration: KeyType

Table of contents

Enumeration members

• PLAIN_TEXT
• SECRETS_MANAGER
• SSM_PARAMETER

Enumeration members

PLAIN_TEXT

• PLAIN_TEXT = "PLAIN_TEXT"

---

SECRETS_MANAGER

• SECRETS_MANAGER = "SECRETS_MANAGER"

---

SSM_PARAMETER

• SSM_PARAMETER = "SSM_PARAMETER"