Skip to main content

EnvironmentDefaultResource

A resource referenced by an environment default.

This represents the actual cloud resource (e.g., a VPC or DNS zone) that has been designated as the default for its resource type within an environment.

type EnvironmentDefaultResource {
  id: ID!
  name: String!
  resourceType: ResourceType
  origin: ResourceOrigin!
  instance: Instance
  instanceAccessGroups(
    sort: GroupsSort
    cursor: Cursor
  ): GroupsPage
}

Fields​

EnvironmentDefaultResource.id ● ID! non-null scalar {#id}​

The resource's unique identifier.

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

Human-readable name of the resource.

EnvironmentDefaultResource.resourceType ● ResourceType object {#resource-type}​

The resource type (e.g., massdriver/aws-vpc) that this resource conforms to.

EnvironmentDefaultResource.origin ● ResourceOrigin! non-null enum {#origin}​

How this resource was created. Determines whether it can be modified through the API.

EnvironmentDefaultResource.instance ● Instance object {#instance}​

The instance whose deployment produced this resource.

Null for imported resources. For provisioned resources, this is the instance that owns the resource's lifecycle — updating or decommissioning the instance will update or remove the resource.

Also null when you cannot view the project that contains the instance. You can see a resource from another project through a grant, a resource:view policy, or a dependency of an instance you can view; the instance that produced it stays hidden.

EnvironmentDefaultResource.instanceAccessGroups ● GroupsPage object {#instance-access-groups}​

The groups whose members can view instance.

Null for imported resources. You can read this field even when you cannot view the project that contains the instance. When instance is null for you, ask a member of one of these groups for access.

EnvironmentDefaultResource.instanceAccessGroups.sort ● GroupsSort input {#environment-default-resource-instance-access-groups-sort}​

Sort field and direction. Defaults to name ascending.

EnvironmentDefaultResource.instanceAccessGroups.cursor ● Cursor input {#environment-default-resource-instance-access-groups-cursor}​

Pagination cursor returned from a previous response to fetch the next page.

Member Of​

EnvironmentDefault object