@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
164 lines (163 loc) • 5.82 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A key for signing Cloud CDN signed URLs for Backend Services.
*
* To get more information about BackendServiceSignedUrlKey, see:
*
* * [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices)
* * How-to Guides
* * [Using Signed URLs](https://cloud.google.com/cdn/docs/using-signed-urls/)
*
* ## Example Usage
*
* ### Backend Service Signed Url Key
*
* ```typescript
* 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 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
*
* This resource does not support import.
*/
export declare class BackendServiceSignedUrlKey extends pulumi.CustomResource {
/**
* Get an existing BackendServiceSignedUrlKey resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: BackendServiceSignedUrlKeyState, opts?: pulumi.CustomResourceOptions): BackendServiceSignedUrlKey;
/**
* Returns true if the given object is an instance of BackendServiceSignedUrlKey. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is BackendServiceSignedUrlKey;
/**
* The backend service this signed URL key belongs.
*/
readonly backendService: pulumi.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.
*/
readonly keyValue: pulumi.Output<string>;
/**
* Name of the signed URL key.
*/
readonly name: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* Create a BackendServiceSignedUrlKey resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: BackendServiceSignedUrlKeyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering BackendServiceSignedUrlKey resources.
*/
export interface BackendServiceSignedUrlKeyState {
/**
* The backend service this signed URL key belongs.
*/
backendService?: pulumi.Input<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.
*/
keyValue?: pulumi.Input<string>;
/**
* Name of the signed URL key.
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a BackendServiceSignedUrlKey resource.
*/
export interface BackendServiceSignedUrlKeyArgs {
/**
* The backend service this signed URL key belongs.
*/
backendService: pulumi.Input<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.
*/
keyValue: pulumi.Input<string>;
/**
* Name of the signed URL key.
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
}