Skip to main content

Blueprint

A project's infrastructure blueprint -- the design-time architecture.

The blueprint is the canonical description of how your infrastructure fits together. It contains components (the bundles you want to deploy) and links (the wiring between them).

Every project has exactly one blueprint. When you deploy to an environment, the blueprint is realized as an environment blueprint containing live instances and connections.

type Blueprint {
components(
filter: ComponentsFilter
sort: ComponentsSort
cursor: Cursor
): ComponentsPage
links(
filter: LinksFilter
sort: LinksSort
cursor: Cursor
): LinksPage
}

Fields

Blueprint.components ● ComponentsPage object {#components}

Paginated list of components in this blueprint.

Returns all bundle slots that make up the project's architecture. Defaults to alphabetical order by name.

Blueprint.components.filter ● ComponentsFilter input {#blueprint-components-filter}

Narrow results by component ID or bundle name.

Blueprint.components.sort ● ComponentsSort input {#blueprint-components-sort}

Sort field and direction. Defaults to name ascending.

Blueprint.components.cursor ● Cursor input {#blueprint-components-cursor}

Pagination cursor returned by a previous page.

Paginated list of links between components in this blueprint.

Each link declares a dependency from one component's output to another's input. Defaults to chronological order by creation time.

Narrow results by source or destination component.

Sort field and direction. Defaults to created_at ascending.

Pagination cursor returned by a previous page.

Member Of

Project object