Skip to content

GCP.BeyondCorp reference

Source: packages/gcp/src/BeyondCorp/SecurityGateway.ts

A BeyondCorp Security Gateway that fronts Chrome Enterprise Premium applications.

The API has no labels field, so Alchemy stamps ownership into displayName for list / nuke. Changing securityGatewayId or location replaces the gateway. Display name and hubs update in place.

SecurityGateway: Creating a SecurityGateway

Section titled “SecurityGateway: Creating a SecurityGateway”

Generated name with a us-central1 hub

const gateway = yield* GCP.BeyondCorp.SecurityGateway("Pep", {});

Explicit id and display name

const gateway = yield* GCP.BeyondCorp.SecurityGateway("Pep", {
securityGatewayId: "app-pep",
displayName: "prod gateway",
hubs: {
"us-central1": { internetGateway: {} },
},
});

SecurityGateway: Looking up an existing security gateway

Section titled “SecurityGateway: Looking up an existing security gateway”

SecurityGateway.lookup references a security gateway Alchemy doesn’t manage (created in the console or by another stack). It is read during plan/deploy, never created, updated or deleted, and binds like a declared security gateway.

const securityGateway = GCP.BeyondCorp.SecurityGateway.lookup({
securityGatewayId: "my-security-gateway",
});

Source: packages/gcp/src/BeyondCorp/SecurityGatewaysApplication.ts

A BeyondCorp Security Gateway application that matches host and port combinations and forwards traffic to upstreams.

The API has no labels field, so Alchemy stamps ownership into displayName for list / nuke. Changing the parent gateway, application id, or location replaces the application. Display name, endpoint matchers, schema, and upstreams update in place.

SecurityGatewaysApplication: Creating a SecurityGatewaysApplication

Section titled “SecurityGatewaysApplication: Creating a SecurityGatewaysApplication”

Match HTTPS for a hostname

const app = yield* GCP.BeyondCorp.SecurityGatewaysApplication("Web", {
securityGateway: gateway.name,
endpointMatchers: [{ hostname: "app.example.com", ports: [443] }],
});

External upstreams

const app = yield* GCP.BeyondCorp.SecurityGatewaysApplication("Web", {
securityGateway: gateway.name,
applicationId: "app-web",
displayName: "prod web",
endpointMatchers: [{ hostname: "app.example.com", ports: [80, 443] }],
upstreams: [
{
external: {
endpoints: [{ hostname: "origin.example.com", port: 443 }],
},
},
],
});

SecurityGatewaysApplication: Looking up an existing security gateways application

Section titled “SecurityGatewaysApplication: Looking up an existing security gateways application”

SecurityGatewaysApplication.lookup references a security gateways application Alchemy doesn’t manage (created in the console or by another stack). It is read during plan/deploy, never created, updated or deleted, and binds like a declared security gateways application.

const securityGatewaysApplication = GCP.BeyondCorp.SecurityGatewaysApplication.lookup({
applicationId: "my-application",
securityGateway: "my-security-gateway",
});