BackendServiceSignedUrlKey class

A key for signing Cloud CDN signed URLs for Backend Services.

To get more information about BackendServiceSignedUrlKey, see:

• API documentation
• How-to Guides
• Using Signed URLs

Example Usage

Backend Service Signed Url Key

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
import * as random from "@pulumi/random";

const urlSignature = new random.index.Id("url_signature", {byteLength: 16});
const webserver = new gcp.compute.InstanceTemplate("webserver", {
    name: "standard-webserver",
    machineType: "e2-medium",
    networkInterfaces: [{
        network: "default",
    }],
    disks: [{
        sourceImage: "debian-cloud/debian-11",
        autoDelete: true,
        boot: true,
    }],
});
const webservers = new gcp.compute.InstanceGroupManager("webservers", {
    name: "my-webservers",
    versions: [{
        instanceTemplate: webserver.id,
        name: "primary",
    }],
    baseInstanceName: "webserver",
    zone: "us-central1-f",
    targetSize: 1,
});
const _default = new gcp.compute.HttpHealthCheck("default", {
    name: "test",
    requestPath: "/",
    checkIntervalSec: 1,
    timeoutSec: 1,
});
const exampleBackend = new gcp.compute.BackendService("example_backend", {
    name: "my-backend-service",
    description: "Our company website",
    portName: "http",
    protocol: "HTTP",
    timeoutSec: 10,
    enableCdn: true,
    backends: [{
        group: webservers.instanceGroup,
    }],
    healthChecks: _default.id,
});
const backendKey = new gcp.compute.BackendServiceSignedUrlKey("backend_key", {
    name: "test-key",
    keyValue: urlSignature.b64Url,
    backendService: exampleBackend.name,
});

import pulumi
import pulumi_gcp as gcp
import pulumi_random as random

url_signature = random.Id("url_signature", byte_length=16)
webserver = gcp.compute.InstanceTemplate("webserver",
    name="standard-webserver",
    machine_type="e2-medium",
    network_interfaces=[{
        "network": "default",
    }],
    disks=[{
        "source_image": "debian-cloud/debian-11",
        "auto_delete": True,
        "boot": True,
    }])
webservers = gcp.compute.InstanceGroupManager("webservers",
    name="my-webservers",
    versions=[{
        "instance_template": webserver.id,
        "name": "primary",
    }],
    base_instance_name="webserver",
    zone="us-central1-f",
    target_size=1)
default = gcp.compute.HttpHealthCheck("default",
    name="test",
    request_path="/",
    check_interval_sec=1,
    timeout_sec=1)
example_backend = gcp.compute.BackendService("example_backend",
    name="my-backend-service",
    description="Our company website",
    port_name="http",
    protocol="HTTP",
    timeout_sec=10,
    enable_cdn=True,
    backends=[{
        "group": webservers.instance_group,
    }],
    health_checks=default.id)
backend_key = gcp.compute.BackendServiceSignedUrlKey("backend_key",
    name="test-key",
    key_value=url_signature["b64Url"],
    backend_service=example_backend.name)

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
using Random = Pulumi.Random;

return await Deployment.RunAsync(() =>
{
    var urlSignature = new Random.Id("url_signature", new()
    {
        ByteLength = 16,
    });

    var webserver = new Gcp.Compute.InstanceTemplate("webserver", new()
    {
        Name = "standard-webserver",
        MachineType = "e2-medium",
        NetworkInterfaces = new[]
        {
            new Gcp.Compute.Inputs.InstanceTemplateNetworkInterfaceArgs
            {
                Network = "default",
            },
        },
        Disks = new[]
        {
            new Gcp.Compute.Inputs.InstanceTemplateDiskArgs
            {
                SourceImage = "debian-cloud/debian-11",
                AutoDelete = true,
                Boot = true,
            },
        },
    });

    var webservers = new Gcp.Compute.InstanceGroupManager("webservers", new()
    {
        Name = "my-webservers",
        Versions = new[]
        {
            new Gcp.Compute.Inputs.InstanceGroupManagerVersionArgs
            {
                InstanceTemplate = webserver.Id,
                Name = "primary",
            },
        },
        BaseInstanceName = "webserver",
        Zone = "us-central1-f",
        TargetSize = 1,
    });

    var @default = new Gcp.Compute.HttpHealthCheck("default", new()
    {
        Name = "test",
        RequestPath = "/",
        CheckIntervalSec = 1,
        TimeoutSec = 1,
    });

    var exampleBackend = new Gcp.Compute.BackendService("example_backend", new()
    {
        Name = "my-backend-service",
        Description = "Our company website",
        PortName = "http",
        Protocol = "HTTP",
        TimeoutSec = 10,
        EnableCdn = true,
        Backends = new[]
        {
            new Gcp.Compute.Inputs.BackendServiceBackendArgs
            {
                Group = webservers.InstanceGroup,
            },
        },
        HealthChecks = @default.Id,
    });

    var backendKey = new Gcp.Compute.BackendServiceSignedUrlKey("backend_key", new()
    {
        Name = "test-key",
        KeyValue = urlSignature.B64Url,
        BackendService = exampleBackend.Name,
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
	"github.com/pulumi/pulumi-random/sdk/v4/go/random"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		urlSignature, err := random.NewId(ctx, "url_signature", &random.IdArgs{
			ByteLength: 16,
		})
		if err != nil {
			return err
		}
		webserver, err := compute.NewInstanceTemplate(ctx, "webserver", &compute.InstanceTemplateArgs{
			Name:        pulumi.String("standard-webserver"),
			MachineType: pulumi.String("e2-medium"),
			NetworkInterfaces: compute.InstanceTemplateNetworkInterfaceArray{
				&compute.InstanceTemplateNetworkInterfaceArgs{
					Network: pulumi.String("default"),
				},
			},
			Disks: compute.InstanceTemplateDiskArray{
				&compute.InstanceTemplateDiskArgs{
					SourceImage: pulumi.String("debian-cloud/debian-11"),
					AutoDelete:  pulumi.Bool(true),
					Boot:        pulumi.Bool(true),
				},
			},
		})
		if err != nil {
			return err
		}
		webservers, err := compute.NewInstanceGroupManager(ctx, "webservers", &compute.InstanceGroupManagerArgs{
			Name: pulumi.String("my-webservers"),
			Versions: compute.InstanceGroupManagerVersionArray{
				&compute.InstanceGroupManagerVersionArgs{
					InstanceTemplate: webserver.ID().ToIDOutput().ToStringOutput(),
					Name:             pulumi.String("primary"),
				},
			},
			BaseInstanceName: pulumi.String("webserver"),
			Zone:             pulumi.String("us-central1-f"),
			TargetSize:       pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		_default, err := compute.NewHttpHealthCheck(ctx, "default", &compute.HttpHealthCheckArgs{
			Name:             pulumi.String("test"),
			RequestPath:      pulumi.String("/"),
			CheckIntervalSec: pulumi.Int(1),
			TimeoutSec:       pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		exampleBackend, err := compute.NewBackendService(ctx, "example_backend", &compute.BackendServiceArgs{
			Name:        pulumi.String("my-backend-service"),
			Description: pulumi.String("Our company website"),
			PortName:    pulumi.String("http"),
			Protocol:    pulumi.String("HTTP"),
			TimeoutSec:  pulumi.Int(10),
			EnableCdn:   pulumi.Bool(true),
			Backends: compute.BackendServiceBackendArray{
				&compute.BackendServiceBackendArgs{
					Group: webservers.InstanceGroup,
				},
			},
			HealthChecks: _default.ID().ToIDOutput().ToStringOutput(),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewBackendServiceSignedUrlKey(ctx, "backend_key", &compute.BackendServiceSignedUrlKeyArgs{
			Name:           pulumi.String("test-key"),
			KeyValue:       urlSignature.B64Url,
			BackendService: exampleBackend.Name,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
    random = {
      source = "pulumi/random"
    }
  }
}

resource "random_id" "url_signature" {
  byte_length = 16
}
resource "gcp_compute_backendservicesignedurlkey" "backend_key" {
  name            = "test-key"
  key_value       = random_id.url_signature.b64Url
  backend_service = gcp_compute_backendservice.example_backend.name
}
resource "gcp_compute_backendservice" "example_backend" {
  name        = "my-backend-service"
  description = "Our company website"
  port_name   = "http"
  protocol    = "HTTP"
  timeout_sec = 10
  enable_cdn  = true
  backends {
    group = gcp_compute_instancegroupmanager.webservers.instance_group
  }
  health_checks = gcp_compute_httphealthcheck.default.id
}
resource "gcp_compute_instancegroupmanager" "webservers" {
  name = "my-webservers"
  versions {
    instance_template = gcp_compute_instancetemplate.webserver.id
    name              = "primary"
  }
  base_instance_name = "webserver"
  zone               = "us-central1-f"
  target_size        = 1
}
resource "gcp_compute_instancetemplate" "webserver" {
  name         = "standard-webserver"
  machine_type = "e2-medium"
  network_interfaces {
    network = "default"
  }
  disks {
    source_image = "debian-cloud/debian-11"
    auto_delete  = true
    boot         = true
  }
}
resource "gcp_compute_httphealthcheck" "default" {
  name               = "test"
  request_path       = "/"
  check_interval_sec = 1
  timeout_sec        = 1
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.random.Id;
import com.pulumi.random.IdArgs;
import com.pulumi.gcp.compute.InstanceTemplate;
import com.pulumi.gcp.compute.InstanceTemplateArgs;
import com.pulumi.gcp.compute.inputs.InstanceTemplateNetworkInterfaceArgs;
import com.pulumi.gcp.compute.inputs.InstanceTemplateDiskArgs;
import com.pulumi.gcp.compute.InstanceGroupManager;
import com.pulumi.gcp.compute.InstanceGroupManagerArgs;
import com.pulumi.gcp.compute.inputs.InstanceGroupManagerVersionArgs;
import com.pulumi.gcp.compute.HttpHealthCheck;
import com.pulumi.gcp.compute.HttpHealthCheckArgs;
import com.pulumi.gcp.compute.BackendService;
import com.pulumi.gcp.compute.BackendServiceArgs;
import com.pulumi.gcp.compute.inputs.BackendServiceBackendArgs;
import com.pulumi.gcp.compute.BackendServiceSignedUrlKey;
import com.pulumi.gcp.compute.BackendServiceSignedUrlKeyArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var urlSignature = new Id("urlSignature", IdArgs.builder()
            .byteLength(16)
            .build());

        var webserver = new InstanceTemplate("webserver", InstanceTemplateArgs.builder()
            .name("standard-webserver")
            .machineType("e2-medium")
            .networkInterfaces(InstanceTemplateNetworkInterfaceArgs.builder()
                .network("default")
                .build())
            .disks(InstanceTemplateDiskArgs.builder()
                .sourceImage("debian-cloud/debian-11")
                .autoDelete(true)
                .boot(true)
                .build())
            .build());

        var webservers = new InstanceGroupManager("webservers", InstanceGroupManagerArgs.builder()
            .name("my-webservers")
            .versions(InstanceGroupManagerVersionArgs.builder()
                .instanceTemplate(webserver.id())
                .name("primary")
                .build())
            .baseInstanceName("webserver")
            .zone("us-central1-f")
            .targetSize(1)
            .build());

        var default_ = new HttpHealthCheck("default", HttpHealthCheckArgs.builder()
            .name("test")
            .requestPath("/")
            .checkIntervalSec(1)
            .timeoutSec(1)
            .build());

        var exampleBackend = new BackendService("exampleBackend", BackendServiceArgs.builder()
            .name("my-backend-service")
            .description("Our company website")
            .portName("http")
            .protocol("HTTP")
            .timeoutSec(10)
            .enableCdn(true)
            .backends(BackendServiceBackendArgs.builder()
                .group(webservers.instanceGroup())
                .build())
            .healthChecks(default_.id())
            .build());

        var backendKey = new BackendServiceSignedUrlKey("backendKey", BackendServiceSignedUrlKeyArgs.builder()
            .name("test-key")
            .keyValue(urlSignature.get("b64Url"))
            .backendService(exampleBackend.name())
            .build());

    }
}

resources:
  urlSignature:
    type: random:Id
    name: url_signature
    properties:
      byteLength: 16
  backendKey:
    type: gcp:compute:BackendServiceSignedUrlKey
    name: backend_key
    properties:
      name: test-key
      keyValue: ${urlSignature.b64Url}
      backendService: ${exampleBackend.name}
  exampleBackend:
    type: gcp:compute:BackendService
    name: example_backend
    properties:
      name: my-backend-service
      description: Our company website
      portName: http
      protocol: HTTP
      timeoutSec: 10
      enableCdn: true
      backends:
        - group: ${webservers.instanceGroup}
      healthChecks: ${default.id}
  webservers:
    type: gcp:compute:InstanceGroupManager
    properties:
      name: my-webservers
      versions:
        - instanceTemplate: ${webserver.id}
          name: primary
      baseInstanceName: webserver
      zone: us-central1-f
      targetSize: 1
  webserver:
    type: gcp:compute:InstanceTemplate
    properties:
      name: standard-webserver
      machineType: e2-medium
      networkInterfaces:
        - network: default
      disks:
        - sourceImage: debian-cloud/debian-11
          autoDelete: true
          boot: true
  default:
    type: gcp:compute:HttpHealthCheck
    properties:
      name: test
      requestPath: /
      checkIntervalSec: 1
      timeoutSec: 1

Import

This resource does not support import.

Constructors

BackendServiceSignedUrlKey(String name, {BackendServiceSignedUrlKeyArgs? args, CustomResourceOptions? options})

Creates a new BackendServiceSignedUrlKey. name The Pulumi resource name. args Arguments used to configure this BackendServiceSignedUrlKey. The set of arguments for BackendServiceSignedUrlKey. options Resource options controlling this resource's behavior.

BackendServiceSignedUrlKey.reference(String urn)

Creates a typed reference to an existing BackendServiceSignedUrlKey resource.

Properties

backendService ↔ Output<String>

The backend service this signed URL key belongs.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

keyValue ↔ Output<String>

128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string. Note: This property is sensitive and will not be displayed in the plan.

late, final

name ↔ Output<String>

Name of the signed URL key.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {BackendServiceSignedUrlKeyState? state, CustomResourceOptions? options}) → BackendServiceSignedUrlKey

Gets an existing BackendServiceSignedUrlKey resource's state with the given name and id.