BundleResource

An output that a bundle produces when deployed.

Resources represent the infrastructure outputs a bundle creates. Other bundles can consume these as dependencies. For example, an Aurora Postgres bundle might produce a database resource of type aws-rds-instance that application bundles can connect to.

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

Fields

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

Handle name for this resource output (e.g., database, cluster).

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

When true, this resource is always produced on a successful deployment.

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

The version range this output declares, 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.

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

The resource type this output produces, 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