Config
@cosmos-building-blocks/common › Globals › Config
Use SSM params to store global config that maybe be refereed to in a decoupled manner.
example Vpc AZ Number or Ca Certificates or Proxy Settings
Hierarchy
Construct
↳ Config
Implements
- IConstruct
- IConstruct
Index
Constructors
Properties
Methods
Constructors
constructor
+ new Config(scope: Construct, id: string, namespace: string, parent?: Config): Config
Overrides void
Defined in packages/@cosmos-building-blocks/common/src/config.ts:14
Parameters:
| Name | Type |
|---|---|
scope | Construct |
id | string |
namespace | string |
parent? | Config |
Returns: Config
Properties
Readonly namespace
• namespace: string
Defined in packages/@cosmos-building-blocks/common/src/config.ts:13
Optional Readonly parent
• parent? : Config
Defined in packages/@cosmos-building-blocks/common/src/config.ts:12
Methods
get
▸ get(id: string, raw: boolean): string | undefined
Defined in packages/@cosmos-building-blocks/common/src/config.ts:63
Parameters:
| Name | Type | Default |
|---|---|---|
id | string | - |
raw | boolean | false |
Returns: string | undefined
getState
▸ getState(id: string, raw: boolean): IParam | undefined
Defined in packages/@cosmos-building-blocks/common/src/config.ts:30
Parameters:
| Name | Type | Default |
|---|---|---|
id | string | - |
raw | boolean | false |
Returns: IParam | undefined
key
▸ key(id: string): string
Defined in packages/@cosmos-building-blocks/common/src/config.ts:24
Parameters:
| Name | Type |
|---|---|
id | string |
Returns: string
lookup
▸ lookup(id: string): string
Defined in packages/@cosmos-building-blocks/common/src/config.ts:82
Parameters:
| Name | Type |
|---|---|
id | string |
Returns: string
onPrepare
▸ onPrepare(): void
Overrides void
Defined in packages/@cosmos-building-blocks/common/src/config.ts:88
Returns: void
set
▸ set(id: string, value: string): void
Defined in packages/@cosmos-building-blocks/common/src/config.ts:73
Parameters:
| Name | Type |
|---|---|
id | string |
value | string |
Returns: void