Skip to main content

BundleDependency

An input that a bundle requires from another bundle's output.

Each dependency declares a named slot that must (or may) be satisfied by connecting it to a resource of the matching type. For example, a database bundle might declare an aws_authentication dependency of type aws-iam-role.

Dependencies are satisfied at deploy time by linking an instance that produces the required resource type, or by an environment-level default if the resource type's connection orientation is ENVIRONMENT_DEFAULT.

type BundleDependency {
name: String!
required: Boolean!
versionConstraint: String!
resourceType: ResourceType
}

Fields

BundleDependency.name ● String! non-null scalar {#name}

Handle name for this dependency slot (e.g., aws_authentication, vpc).

BundleDependency.required ● Boolean! non-null scalar {#required}

When true, this dependency must be connected before the bundle can be deployed.

BundleDependency.versionConstraint ● String! non-null scalar {#version-constraint}

The version range this slot accepts, as declared in the bundle — an exact version (1.2.3), a tilde range (~1, ~1.2), or a channel (latest, latest+dev). Bundles published before versioned dependencies report the current version of the type they point at.

BundleDependency.resourceType ● ResourceType object {#resource-type}

The resource type this dependency accepts, resolved to the newest version its versionConstraint accepts. null if no published version of the type satisfies the range, or the field is not pinned to a resource type at all.

Member Of

Bundle object