1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. compute
  5. BackendBucketSignedUrlKey
Google Cloud v8.25.1 published on Wednesday, Apr 9, 2025 by Pulumi

gcp.compute.BackendBucketSignedUrlKey

Explore with Pulumi AI

A key for signing Cloud CDN signed URLs for BackendBuckets.

To get more information about BackendBucketSignedUrlKey, see:

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.RandomId("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,
});
Copy
import pulumi
import pulumi_gcp as gcp
import pulumi_random as random

url_signature = random.RandomId("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.b64_url,
    backend_bucket=test_backend.name)
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v8/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.NewRandomId(ctx, "url_signature", &random.RandomIdArgs{
			ByteLength: pulumi.Int(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
	})
}
Copy
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.RandomId("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,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.random.RandomId;
import com.pulumi.random.RandomIdArgs;
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.List;
import java.util.ArrayList;
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 RandomId("urlSignature", RandomIdArgs.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.b64Url())
            .backendBucket(testBackend.name())
            .build());

    }
}
Copy
resources:
  urlSignature:
    type: random:RandomId
    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
Copy

Create BackendBucketSignedUrlKey Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new BackendBucketSignedUrlKey(name: string, args: BackendBucketSignedUrlKeyArgs, opts?: CustomResourceOptions);
@overload
def BackendBucketSignedUrlKey(resource_name: str,
                              args: BackendBucketSignedUrlKeyArgs,
                              opts: Optional[ResourceOptions] = None)

@overload
def BackendBucketSignedUrlKey(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              backend_bucket: Optional[str] = None,
                              key_value: Optional[str] = None,
                              name: Optional[str] = None,
                              project: Optional[str] = None)
func NewBackendBucketSignedUrlKey(ctx *Context, name string, args BackendBucketSignedUrlKeyArgs, opts ...ResourceOption) (*BackendBucketSignedUrlKey, error)
public BackendBucketSignedUrlKey(string name, BackendBucketSignedUrlKeyArgs args, CustomResourceOptions? opts = null)
public BackendBucketSignedUrlKey(String name, BackendBucketSignedUrlKeyArgs args)
public BackendBucketSignedUrlKey(String name, BackendBucketSignedUrlKeyArgs args, CustomResourceOptions options)
type: gcp:compute:BackendBucketSignedUrlKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BackendBucketSignedUrlKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. BackendBucketSignedUrlKeyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. BackendBucketSignedUrlKeyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BackendBucketSignedUrlKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BackendBucketSignedUrlKeyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var backendBucketSignedUrlKeyResource = new Gcp.Compute.BackendBucketSignedUrlKey("backendBucketSignedUrlKeyResource", new()
{
    BackendBucket = "string",
    KeyValue = "string",
    Name = "string",
    Project = "string",
});
Copy
example, err := compute.NewBackendBucketSignedUrlKey(ctx, "backendBucketSignedUrlKeyResource", &compute.BackendBucketSignedUrlKeyArgs{
	BackendBucket: pulumi.String("string"),
	KeyValue:      pulumi.String("string"),
	Name:          pulumi.String("string"),
	Project:       pulumi.String("string"),
})
Copy
var backendBucketSignedUrlKeyResource = new BackendBucketSignedUrlKey("backendBucketSignedUrlKeyResource", BackendBucketSignedUrlKeyArgs.builder()
    .backendBucket("string")
    .keyValue("string")
    .name("string")
    .project("string")
    .build());
Copy
backend_bucket_signed_url_key_resource = gcp.compute.BackendBucketSignedUrlKey("backendBucketSignedUrlKeyResource",
    backend_bucket="string",
    key_value="string",
    name="string",
    project="string")
Copy
const backendBucketSignedUrlKeyResource = new gcp.compute.BackendBucketSignedUrlKey("backendBucketSignedUrlKeyResource", {
    backendBucket: "string",
    keyValue: "string",
    name: "string",
    project: "string",
});
Copy
type: gcp:compute:BackendBucketSignedUrlKey
properties:
    backendBucket: string
    keyValue: string
    name: string
    project: string
Copy

BackendBucketSignedUrlKey Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The BackendBucketSignedUrlKey resource accepts the following input properties:

BackendBucket
This property is required.
Changes to this property will trigger replacement.
string
The backend bucket this signed URL key belongs.


KeyValue
This property is required.
Changes to this property will trigger replacement.
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.
Name Changes to this property will trigger replacement. string
Name of the signed URL key.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
BackendBucket
This property is required.
Changes to this property will trigger replacement.
string
The backend bucket this signed URL key belongs.


KeyValue
This property is required.
Changes to this property will trigger replacement.
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.
Name Changes to this property will trigger replacement. string
Name of the signed URL key.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
backendBucket
This property is required.
Changes to this property will trigger replacement.
String
The backend bucket this signed URL key belongs.


keyValue
This property is required.
Changes to this property will trigger replacement.
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.
name Changes to this property will trigger replacement. String
Name of the signed URL key.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
backendBucket
This property is required.
Changes to this property will trigger replacement.
string
The backend bucket this signed URL key belongs.


keyValue
This property is required.
Changes to this property will trigger replacement.
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.
name Changes to this property will trigger replacement. string
Name of the signed URL key.
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
backend_bucket
This property is required.
Changes to this property will trigger replacement.
str
The backend bucket this signed URL key belongs.


key_value
This property is required.
Changes to this property will trigger replacement.
str
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.
name Changes to this property will trigger replacement. str
Name of the signed URL key.
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
backendBucket
This property is required.
Changes to this property will trigger replacement.
String
The backend bucket this signed URL key belongs.


keyValue
This property is required.
Changes to this property will trigger replacement.
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.
name Changes to this property will trigger replacement. String
Name of the signed URL key.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Outputs

All input properties are implicitly available as output properties. Additionally, the BackendBucketSignedUrlKey resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing BackendBucketSignedUrlKey Resource

Get an existing BackendBucketSignedUrlKey resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: BackendBucketSignedUrlKeyState, opts?: CustomResourceOptions): BackendBucketSignedUrlKey
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backend_bucket: Optional[str] = None,
        key_value: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None) -> BackendBucketSignedUrlKey
func GetBackendBucketSignedUrlKey(ctx *Context, name string, id IDInput, state *BackendBucketSignedUrlKeyState, opts ...ResourceOption) (*BackendBucketSignedUrlKey, error)
public static BackendBucketSignedUrlKey Get(string name, Input<string> id, BackendBucketSignedUrlKeyState? state, CustomResourceOptions? opts = null)
public static BackendBucketSignedUrlKey get(String name, Output<String> id, BackendBucketSignedUrlKeyState state, CustomResourceOptions options)
resources:  _:    type: gcp:compute:BackendBucketSignedUrlKey    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
BackendBucket Changes to this property will trigger replacement. string
The backend bucket this signed URL key belongs.


KeyValue Changes to this property will trigger replacement. 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.
Name Changes to this property will trigger replacement. string
Name of the signed URL key.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
BackendBucket Changes to this property will trigger replacement. string
The backend bucket this signed URL key belongs.


KeyValue Changes to this property will trigger replacement. 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.
Name Changes to this property will trigger replacement. string
Name of the signed URL key.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
backendBucket Changes to this property will trigger replacement. String
The backend bucket this signed URL key belongs.


keyValue Changes to this property will trigger replacement. 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.
name Changes to this property will trigger replacement. String
Name of the signed URL key.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
backendBucket Changes to this property will trigger replacement. string
The backend bucket this signed URL key belongs.


keyValue Changes to this property will trigger replacement. 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.
name Changes to this property will trigger replacement. string
Name of the signed URL key.
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
backend_bucket Changes to this property will trigger replacement. str
The backend bucket this signed URL key belongs.


key_value Changes to this property will trigger replacement. str
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.
name Changes to this property will trigger replacement. str
Name of the signed URL key.
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
backendBucket Changes to this property will trigger replacement. String
The backend bucket this signed URL key belongs.


keyValue Changes to this property will trigger replacement. 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.
name Changes to this property will trigger replacement. String
Name of the signed URL key.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Import

This resource does not support import.

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.