@cdk-cosmos/core
Index
Modules
- "aws-ecs/lib/cluster"
- "core/lib/construct-compat"
- "cosmos/cosmos-core-import"
- "cosmos/cosmos-core-stack"
- "cosmos/cosmos-extension-stack"
- "galaxy/galaxy-core-stack"
- "solar-system/solar-system-core-import"
- "solar-system/solar-system-core-stack"
- "solar-system/solar-system-extension-stack"
Classes
- BaseConstruct
- BaseFeatureConstruct
- BaseFeatureStack
- BaseNestedStack
- BaseStack
- CertFeatureCoreImport
- CertFeatureCoreStack
- CiCdFeatureCoreStack
- CiCdFeatureExtensionStack
- CoreVpc
- CosmosCoreImport
- CosmosCoreStack
- CosmosExtensionStack
- CrossAccountZoneDelegationRecord
- Domain
- EcsFeatureCoreImport
- EcsFeatureCoreStack
- GalaxyCoreImport
- GalaxyCoreStack
- GalaxyExtensionStack
- GithubEnterpriseFeatureCoreImport
- GithubEnterpriseFeatureCoreStack
- LinkFeatureStack
- RedisFeatureImport
- RedisFeatureStack
- RemoteAlb
- RemoteApplicationListener
- RemoteBucket
- RemoteBuildProject
- RemoteCluster
- RemoteCodeRepo
- RemoteFunction
- RemoteGithubEnterpriseConnection
- RemoteRedis
- RemoteVpc
- RemoteVpcImportProps
- RemoteZone
- Selector
- Selectors
- SharedVpcFeatureCoreStack
- SolarSystemCoreImport
- SolarSystemCoreStack
- SolarSystemExtensionStack
- Subdomain
Interfaces
- BaseConstructProps
- BaseFeatureConstructProps
- BaseFeatureStackProps
- BaseNestedStackProps
- BaseStackProps
- CertFeatureCoreImportProps
- CertFeatureCoreStackProps
- CiCdFeatureCoreStackProps
- CiCdFeatureExtensionStackProps
- ClusterProps
- CoreVpcProps
- CosmosCoreImportProps
- CosmosCoreStackProps
- CosmosExtensionStackProps
- CrossAccountZoneDelegationRecordProps
- DomainProps
- EcsFeatureCoreImportProps
- EcsSolarSystemCoreStackProps
- GalaxyCoreImportProps
- GalaxyCoreStackProps
- GalaxyExtensionStackProps
- GithubEnterpriseFeatureCoreImportProps
- GithubEnterpriseFeatureCoreStackProps
- ICertFeatureCore
- ICiCdFeatureCore
- ICiCdFeatureExtension
- ICoreVpc
- ICosmosCore
- ICosmosExtension
- IEcsFeatureCore
- IGalaxyCore
- IGalaxyExtension
- IGithubEnterpriseFeatureCore
- IKeyValue
- ILinkFeature
- IRedisFeature
- IScope
- ISharedVpcFeature
- ISolarSystemCore
- ISolarSystemExtension
- LinkFeatureStackProps
- RedisFeatureImportProps
- RedisFeatureStackProps
- SharedVpcFeatureCoreStackProps
- SolarSystemCoreImportProps
- SolarSystemCoreStackProps
- SolarSystemExtensionStackProps
- SubdomainProps
Variables
- CDK_PIPELINE_PATTERN
- CONTEXT_AWS_ENV
- CONTEXT_COSMOS_NAMING
- CONTEXT_COSMOS_NETWORK_BUILDER
- CONTEXT_COSMOS_PARTITION
- CONTEXT_COSMOS_VERSION
- COSMOS_CORE_SYMBOL
- COSMOS_EXTENSION_SYMBOL
- GALAXY_CORE_SYMBOL
- GALAXY_EXTENSION_SYMBOL
- SOLAR_SYSTEM_CORE_SYMBOL
- SOLAR_SYSTEM_EXTENSION_SYMBOL
Functions
- configureListener
- defaultUserData
- expandCfnArray
- expandSubnetIds
- findLazyExportName
- generateNodeId
- generateScopeId
- generateSingletonId
- getContext
- getPattern
- getScopes
- isNotHidden
- isUnique
- nodeId
- removeNonAlphanumeric
- tryAddInterfaceEndpoint
Object literals
Variables
Const CDK_PIPELINE_PATTERN
• CDK_PIPELINE_PATTERN: "{Partition}{Cosmos}{Resource}" = "{Partition}{Cosmos}{Resource}"
Defined in packages/@cdk-cosmos/core/src/features/cicd-feature/cicd-feature-core-stack.ts:9
Const CONTEXT_AWS_ENV
• CONTEXT_AWS_ENV: "AWS_ENV" = "AWS_ENV"
Defined in packages/@cdk-cosmos/core/src/helpers/constants.ts:1
Const CONTEXT_COSMOS_NAMING
• CONTEXT_COSMOS_NAMING: "COSMOS_NAMING" = "COSMOS_NAMING"
Defined in packages/@cdk-cosmos/core/src/helpers/constants.ts:5
Const CONTEXT_COSMOS_NETWORK_BUILDER
• CONTEXT_COSMOS_NETWORK_BUILDER: "COSMOS_NETWORK_BUILDER" = "COSMOS_NETWORK_BUILDER"
Defined in packages/@cdk-cosmos/core/src/helpers/constants.ts:4
Const CONTEXT_COSMOS_PARTITION
• CONTEXT_COSMOS_PARTITION: "COSMOS_PARTITION" = "COSMOS_PARTITION"
Defined in packages/@cdk-cosmos/core/src/helpers/constants.ts:2
Const CONTEXT_COSMOS_VERSION
• CONTEXT_COSMOS_VERSION: "COSMOS_VERSION" = "COSMOS_VERSION"
Defined in packages/@cdk-cosmos/core/src/helpers/constants.ts:3
Const COSMOS_CORE_SYMBOL
• COSMOS_CORE_SYMBOL: unique symbol = Symbol.for('@cdk-cosmos/core.CosmosCore')
Defined in packages/@cdk-cosmos/core/src/cosmos/cosmos-core-stack.ts:10
Const COSMOS_EXTENSION_SYMBOL
• COSMOS_EXTENSION_SYMBOL: unique symbol = Symbol.for('@cdk-cosmos/core.CosmosExtensionStack')
Defined in packages/@cdk-cosmos/core/src/cosmos/cosmos-extension-stack.ts:7
Const GALAXY_CORE_SYMBOL
• GALAXY_CORE_SYMBOL: unique symbol = Symbol.for('@cdk-cosmos/core.GalaxyCore')
Defined in packages/@cdk-cosmos/core/src/galaxy/galaxy-core-stack.ts:10
Const GALAXY_EXTENSION_SYMBOL
• GALAXY_EXTENSION_SYMBOL: unique symbol = Symbol.for('@cdk-cosmos/core.GalaxyExtensionStack')
Defined in packages/@cdk-cosmos/core/src/galaxy/galaxy-extension-stack.ts:7
Const SOLAR_SYSTEM_CORE_SYMBOL
• SOLAR_SYSTEM_CORE_SYMBOL: unique symbol = Symbol.for('@cdk-cosmos/core.SolarSystemCore')
Defined in packages/@cdk-cosmos/core/src/solar-system/solar-system-core-stack.ts:20
Const SOLAR_SYSTEM_EXTENSION_SYMBOL
• SOLAR_SYSTEM_EXTENSION_SYMBOL: unique symbol = Symbol.for('@cdk-cosmos/core.SolarSystemExtensionStack')
Defined in packages/@cdk-cosmos/core/src/solar-system/solar-system-extension-stack.ts:7
Functions
Const configureListener
▸ configureListener(listener: ApplicationListener, listenerInboundCidr?: string | null): void
Defined in packages/@cdk-cosmos/core/src/features/ecs-feature/ecs-feature-core-stack.ts:238
Parameters:
| Name | Type |
|---|---|
listener | ApplicationListener |
listenerInboundCidr? | string | null |
Returns: void
Const defaultUserData
▸ defaultUserData(): UserData
Defined in packages/@cdk-cosmos/core/src/features/ecs-feature/ecs-feature-core-stack.ts:273
Returns: UserData
Const expandCfnArray
▸ expandCfnArray(val: string[], n: number): string[]
Defined in packages/@cdk-cosmos/core/src/components/remote.ts:425
Parameters:
| Name | Type |
|---|---|
val | string[] |
n | number |
Returns: string[]
Const expandSubnetIds
▸ expandSubnetIds(names: string[] | undefined, value: string, aZs: number): string[]
Defined in packages/@cdk-cosmos/core/src/components/remote.ts:417
Parameters:
| Name | Type |
|---|---|
names | string[] | undefined |
value | string |
aZs | number |
Returns: string[]
Const findLazyExportName
▸ findLazyExportName(scope: IConstruct, id: string): string
Defined in packages/@cdk-cosmos/core/src/components/cross-account.ts:46
Parameters:
| Name | Type |
|---|---|
scope | IConstruct |
id | string |
Returns: string
generateNodeId
▸ generateNodeId(props: object): string
Defined in packages/@cdk-cosmos/core/src/helpers/generate-scope-id.ts:23
Parameters:
▪ props: object
| Name | Type |
|---|---|
delimiter? | undefined | string |
id? | undefined | string |
partition? | undefined | string |
pattern? | undefined | string |
scope | IConstruct |
type? | undefined | string |
version? | undefined | string |
Returns: string
Const generateScopeId
▸ generateScopeId(props: object): string
Defined in packages/@cdk-cosmos/core/src/helpers/generate-scope-id.ts:44
Parameters:
▪ props: object
| Name | Type |
|---|---|
defaultPattern? | undefined | string |
delimiter? | undefined | string |
partition? | undefined | string |
pattern? | undefined | string |
scope | IConstruct |
scopes? | IScope[] |
version? | undefined | string |
Returns: string
generateSingletonId
▸ generateSingletonId(props: object): string
Defined in packages/@cdk-cosmos/core/src/helpers/generate-scope-id.ts:11
Parameters:
▪ props: object
| Name | Type |
|---|---|
delimiter? | undefined | string |
id? | undefined | string |
partition? | undefined | string |
scope | IConstruct |
type? | undefined | string |
version? | undefined | string |
Returns: string
Const getContext
▸ getContext(scopes: IScope[]): IKeyValue[]
Defined in packages/@cdk-cosmos/core/src/helpers/generate-scope-id.ts:72
Parameters:
| Name | Type |
|---|---|
scopes | IScope[] |
Returns: IKeyValue[]
Const getPattern
▸ getPattern(scopes: IScope[]): string | undefined
Defined in packages/@cdk-cosmos/core/src/helpers/generate-scope-id.ts:82
Parameters:
| Name | Type |
|---|---|
scopes | IScope[] |
Returns: string | undefined
Const getScopes
▸ getScopes(scope: IConstruct): IScope[]
Defined in packages/@cdk-cosmos/core/src/helpers/generate-scope-id.ts:69
Parameters:
| Name | Type |
|---|---|
scope | IConstruct |
Returns: IScope[]
Const isNotHidden
▸ isNotHidden(item: IKeyValue): boolean
Defined in packages/@cdk-cosmos/core/src/helpers/generate-id.ts:83
Parameters:
| Name | Type |
|---|---|
item | IKeyValue |
Returns: boolean
Const isUnique
▸ isUnique(result: IKeyValue[], item: IKeyValue): IKeyValue[]
Defined in packages/@cdk-cosmos/core/src/helpers/generate-id.ts:88
Parameters:
| Name | Type |
|---|---|
result | IKeyValue[] |
item | IKeyValue |
Returns: IKeyValue[]
nodeId
▸ nodeId(props: object): string
Defined in packages/@cdk-cosmos/core/src/helpers/generate-id.ts:6
Parameters:
▪ props: object
| Name | Type |
|---|---|
context | IKeyValue[] |
delimiter | string |
pattern | string |
Returns: string
Const removeNonAlphanumeric
▸ removeNonAlphanumeric(s: string): string
Defined in packages/@cdk-cosmos/core/src/components/base.ts:177
Parameters:
| Name | Type |
|---|---|
s | string |
Returns: string
Const tryAddInterfaceEndpoint
▸ tryAddInterfaceEndpoint(vpc: IVpc, id: string, options: InterfaceVpcEndpointOptions): InterfaceVpcEndpoint | undefined
Defined in packages/@cdk-cosmos/core/src/components/core-vpc.ts:119
Parameters:
| Name | Type |
|---|---|
vpc | IVpc |
id | string |
options | InterfaceVpcEndpointOptions |
Returns: InterfaceVpcEndpoint | undefined
Object literals
Const PATTERN
▪ PATTERN: object
Defined in packages/@cdk-cosmos/core/src/helpers/constants.ts:7
COSMOS
• COSMOS: string = "{Partition}{Cosmos}{Galaxy}?{SolarSystem}?{Resource}*{Version}?"
Defined in packages/@cdk-cosmos/core/src/helpers/constants.ts:9
RESOURCE
• RESOURCE: string = "{Resource}+{Version}?"
Defined in packages/@cdk-cosmos/core/src/helpers/constants.ts:11
SINGLETON_COSMOS
• SINGLETON_COSMOS: string = "${Partition}{Galaxy}?{SolarSystem}?{Resource}+"
Defined in packages/@cdk-cosmos/core/src/helpers/constants.ts:10
STACK
• STACK: string = "{Partition}{Cosmos}{Galaxy}?{SolarSystem}?{Version}?{Type}"
Defined in packages/@cdk-cosmos/core/src/helpers/constants.ts:8
Const linkGetter
▪ linkGetter: object
Defined in packages/@cdk-cosmos/core/src/features/link-feature/link-feature-stack.ts:46
get
▸ get(this: any): LinkFeatureStack
Defined in packages/@cdk-cosmos/core/src/features/link-feature/link-feature-stack.ts:47
Parameters:
| Name | Type |
|---|---|
this | any |
Returns: LinkFeatureStack