@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
134 lines (133 loc) • 4.95 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A key for signing Cloud CDN signed URLs for BackendBuckets.
*
* To get more information about BackendBucketSignedUrlKey, see:
*
* * [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/backendBuckets)
* * How-to Guides
* * [Using Signed URLs](https://cloud.google.com/cdn/docs/using-signed-urls/)
*
* ## Example Usage
*
* ### Backend Bucket 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 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
*
* This resource does not support import.
*/
export declare class BackendBucketSignedUrlKey extends pulumi.CustomResource {
/**
* Get an existing BackendBucketSignedUrlKey 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?: BackendBucketSignedUrlKeyState, opts?: pulumi.CustomResourceOptions): BackendBucketSignedUrlKey;
/**
* Returns true if the given object is an instance of BackendBucketSignedUrlKey. 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 BackendBucketSignedUrlKey;
/**
* The backend bucket this signed URL key belongs.
*/
readonly backendBucket: 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 BackendBucketSignedUrlKey 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: BackendBucketSignedUrlKeyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering BackendBucketSignedUrlKey resources.
*/
export interface BackendBucketSignedUrlKeyState {
/**
* The backend bucket this signed URL key belongs.
*/
backendBucket?: 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 BackendBucketSignedUrlKey resource.
*/
export interface BackendBucketSignedUrlKeyArgs {
/**
* The backend bucket this signed URL key belongs.
*/
backendBucket: 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>;
}