BackendBucketSignedUrlKey class

A key for signing Cloud CDN signed URLs for BackendBuckets.

To get more information about BackendBucketSignedUrlKey, see:

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

Example Usage

Backend Bucket 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 bucket = new gcp.storage.Bucket("bucket", {
    name: "test-storage-bucket",
    location: "EU",
});
const testBackend = new gcp.compute.BackendBucket("test_backend", {
    name: "test-signed-backend-bucket",
    description: "Contains beautiful images",
    bucketName: bucket.name,
    enableCdn: true,
});
const backendKey = new gcp.compute.BackendBucketSignedUrlKey("backend_key", {
    name: "test-key",
    keyValue: urlSignature.b64Url,
    backendBucket: testBackend.name,
});

import pulumi
import pulumi_gcp as gcp
import pulumi_random as random

url_signature = random.Id("url_signature", byte_length=16)
bucket = gcp.storage.Bucket("bucket",
    name="test-storage-bucket",
    location="EU")
test_backend = gcp.compute.BackendBucket("test_backend",
    name="test-signed-backend-bucket",
    description="Contains beautiful images",
    bucket_name=bucket.name,
    enable_cdn=True)
backend_key = gcp.compute.BackendBucketSignedUrlKey("backend_key",
    name="test-key",
    key_value=url_signature["b64Url"],
    backend_bucket=test_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 bucket = new Gcp.Storage.Bucket("bucket", new()
    {
        Name = "test-storage-bucket",
        Location = "EU",
    });

    var testBackend = new Gcp.Compute.BackendBucket("test_backend", new()
    {
        Name = "test-signed-backend-bucket",
        Description = "Contains beautiful images",
        BucketName = bucket.Name,
        EnableCdn = true,
    });

    var backendKey = new Gcp.Compute.BackendBucketSignedUrlKey("backend_key", new()
    {
        Name = "test-key",
        KeyValue = urlSignature.B64Url,
        BackendBucket = testBackend.Name,
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/storage"
	"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
		}
		bucket, err := storage.NewBucket(ctx, "bucket", &storage.BucketArgs{
			Name:     pulumi.String("test-storage-bucket"),
			Location: pulumi.String("EU"),
		})
		if err != nil {
			return err
		}
		testBackend, err := compute.NewBackendBucket(ctx, "test_backend", &compute.BackendBucketArgs{
			Name:        pulumi.String("test-signed-backend-bucket"),
			Description: pulumi.String("Contains beautiful images"),
			BucketName:  bucket.Name,
			EnableCdn:   pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewBackendBucketSignedUrlKey(ctx, "backend_key", &compute.BackendBucketSignedUrlKeyArgs{
			Name:          pulumi.String("test-key"),
			KeyValue:      urlSignature.B64Url,
			BackendBucket: testBackend.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_backendbucketsignedurlkey" "backend_key" {
  name           = "test-key"
  key_value      = random_id.url_signature.b64Url
  backend_bucket = gcp_compute_backendbucket.test_backend.name
}
resource "gcp_compute_backendbucket" "test_backend" {
  name        = "test-signed-backend-bucket"
  description = "Contains beautiful images"
  bucket_name = gcp_storage_bucket.bucket.name
  enable_cdn  = true
}
resource "gcp_storage_bucket" "bucket" {
  name     = "test-storage-bucket"
  location = "EU"
}

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.storage.Bucket;
import com.pulumi.gcp.storage.BucketArgs;
import com.pulumi.gcp.compute.BackendBucket;
import com.pulumi.gcp.compute.BackendBucketArgs;
import com.pulumi.gcp.compute.BackendBucketSignedUrlKey;
import com.pulumi.gcp.compute.BackendBucketSignedUrlKeyArgs;
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 bucket = new Bucket("bucket", BucketArgs.builder()
            .name("test-storage-bucket")
            .location("EU")
            .build());

        var testBackend = new BackendBucket("testBackend", BackendBucketArgs.builder()
            .name("test-signed-backend-bucket")
            .description("Contains beautiful images")
            .bucketName(bucket.name())
            .enableCdn(true)
            .build());

        var backendKey = new BackendBucketSignedUrlKey("backendKey", BackendBucketSignedUrlKeyArgs.builder()
            .name("test-key")
            .keyValue(urlSignature.get("b64Url"))
            .backendBucket(testBackend.name())
            .build());

    }
}

resources:
  urlSignature:
    type: random:Id
    name: url_signature
    properties:
      byteLength: 16
  backendKey:
    type: gcp:compute:BackendBucketSignedUrlKey
    name: backend_key
    properties:
      name: test-key
      keyValue: ${urlSignature.b64Url}
      backendBucket: ${testBackend.name}
  testBackend:
    type: gcp:compute:BackendBucket
    name: test_backend
    properties:
      name: test-signed-backend-bucket
      description: Contains beautiful images
      bucketName: ${bucket.name}
      enableCdn: true
  bucket:
    type: gcp:storage:Bucket
    properties:
      name: test-storage-bucket
      location: EU

Import

This resource does not support import.

Constructors

BackendBucketSignedUrlKey(String name, {BackendBucketSignedUrlKeyArgs? args, CustomResourceOptions? options})

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

BackendBucketSignedUrlKey.reference(String urn)

Creates a typed reference to an existing BackendBucketSignedUrlKey resource.

Properties

backendBucket ↔ Output<String>

The backend bucket 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, {BackendBucketSignedUrlKeyState? state, CustomResourceOptions? options}) → BackendBucketSignedUrlKey

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