@cosmos-building-blocks/common

@cosmos-building-blocks/common › Globals

Index

Modules

• "custom-resource-provider"

Classes

• CdkBootstrap
• Config
• CrossAccountExports
• Param
• SecureBucket
• SsmState

Interfaces

• Attributes
• CdkBootstrapProps
• CrossAccountExportsProps
• IParam
• IState
• Props
• SsmStateProps

Variables

• RESOURCE_TYPE
• app
• getOrCreateProvider
• stacks

Functions

• createCrossAccountExportProvider
• getCredential
• getExports
• getPackageVersion
• handler
• isCrossAccount
• isCrossStack

Variables

Const RESOURCE_TYPE

• RESOURCE_TYPE: "Custom::CrossAccountExports" = "Custom::CrossAccountExports"

Defined in packages/@cosmos-building-blocks/common/src/cross-account-exports.ts:12

---

Const app

• app: App‹› = new App()

Defined in packages/@cosmos-building-blocks/common/src/cdk-toolkit/bootstrap-app.ts:6

---

Const getOrCreateProvider

• getOrCreateProvider: getOrCreateProvider = CustomResourceProvider.getOrCreateProvider

Defined in packages/@cosmos-building-blocks/common/src/custom-resource-provider.ts:14

---

Const stacks

• stacks: string = process.env.STACKS || 'Cosmos Galaxy *CiCdSolarSystem'

Defined in packages/@cosmos-building-blocks/common/src/cdk-toolkit/bootstrap-app.ts:4

Functions

Const createCrossAccountExportProvider

▸ createCrossAccountExportProvider(scope: Construct, role?: IRole): string

Defined in packages/@cosmos-building-blocks/common/src/cross-account-exports.ts:70

Parameters:

Name	Type
scope	Construct
role?	IRole

Returns: string

---

Const getCredential

▸ getCredential(props: AssumeRoleRequest): Promise‹ChainableTemporaryCredentials›

Defined in packages/@cosmos-building-blocks/common/src/cross-account-export-handler/index.ts:45

Parameters:

Name	Type
props	AssumeRoleRequest

Returns: Promise‹ChainableTemporaryCredentials›

---

Const getExports

▸ getExports(cloudformation: CloudFormation, next?: undefined | string): Promise‹CloudFormation.Exports›

Defined in packages/@cosmos-building-blocks/common/src/cross-account-export-handler/index.ts:56

Parameters:

Name	Type
cloudformation	CloudFormation
next?	undefined | string

Returns: Promise‹CloudFormation.Exports›

---

Const getPackageVersion

▸ getPackageVersion(dirname: string): string

Defined in packages/@cosmos-building-blocks/common/src/utils.ts:17

Parameters:

Name	Type
dirname	string

Returns: string

---

Const handler

▸ handler(event: CloudFormationCustomResourceEvent): Promise‹Partial‹CloudFormationCustomResourceResponse› | undefined›

Defined in packages/@cosmos-building-blocks/common/src/cross-account-export-handler/index.ts:15

Parameters:

Name	Type
event	CloudFormationCustomResourceEvent

Returns: Promise‹Partial‹CloudFormationCustomResourceResponse› | undefined›

---

Const isCrossAccount

▸ isCrossAccount(x: IConstruct, y: IConstruct, includeRegion?: undefined | false | true): boolean

Defined in packages/@cosmos-building-blocks/common/src/utils.ts:5

Parameters:

Name	Type
x	IConstruct
y	IConstruct
includeRegion?	undefined | false | true

Returns: boolean

---

Const isCrossStack

▸ isCrossStack(x: IConstruct, y: IConstruct): boolean

Defined in packages/@cosmos-building-blocks/common/src/utils.ts:13

Parameters:

Name	Type
x	IConstruct
y	IConstruct

Returns: boolean