@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
164 lines • 6.81 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.HostingChannel = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("../utilities"));
/**
* A `Channel` represents a stream of releases for a site. All sites have a default
* `live` channel that serves content to the Firebase-provided subdomains and any
* connected custom domains.
*
* > **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider.
* See Provider Versions for more details on beta resources.
*
* To get more information about Channel, see:
*
* * [API documentation](https://firebase.google.com/docs/reference/hosting/rest/v1beta1/sites.channels)
* * How-to Guides
* * [Official Documentation](https://firebase.google.com/docs/hosting)
*
* ## Example Usage
*
* ### Firebasehosting Channel Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.firebase.HostingSite("default", {
* project: "my-project-name",
* siteId: "site-with-channel",
* });
* const defaultHostingChannel = new gcp.firebase.HostingChannel("default", {
* siteId: _default.siteId,
* channelId: "channel-basic",
* });
* ```
* ### Firebasehosting Channel Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.firebase.HostingSite("default", {
* project: "my-project-name",
* siteId: "site-with-channel",
* });
* const full = new gcp.firebase.HostingChannel("full", {
* siteId: _default.siteId,
* channelId: "channel-full",
* ttl: "86400s",
* retainedReleaseCount: 20,
* labels: {
* "some-key": "some-value",
* },
* });
* ```
*
* ## Import
*
* Channel can be imported using any of these accepted formats:
*
* * `sites/{{site_id}}/channels/{{channel_id}}`
* * `{{site_id}}/{{channel_id}}`
*
* When using the `pulumi import` command, Channel can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:firebase/hostingChannel:HostingChannel default sites/{{site_id}}/channels/{{channel_id}}
* $ pulumi import gcp:firebase/hostingChannel:HostingChannel default {{site_id}}/{{channel_id}}
* ```
*/
class HostingChannel extends pulumi.CustomResource {
/**
* Get an existing HostingChannel 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, id, state, opts) {
return new HostingChannel(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'gcp:firebase/hostingChannel:HostingChannel';
/**
* Returns true if the given object is an instance of HostingChannel. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === HostingChannel.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["channelId"] = state?.channelId;
resourceInputs["deletionPolicy"] = state?.deletionPolicy;
resourceInputs["effectiveLabels"] = state?.effectiveLabels;
resourceInputs["expireTime"] = state?.expireTime;
resourceInputs["labels"] = state?.labels;
resourceInputs["name"] = state?.name;
resourceInputs["pulumiLabels"] = state?.pulumiLabels;
resourceInputs["retainedReleaseCount"] = state?.retainedReleaseCount;
resourceInputs["siteId"] = state?.siteId;
resourceInputs["ttl"] = state?.ttl;
}
else {
const args = argsOrState;
if (args?.channelId === undefined && !opts.urn) {
throw new Error("Missing required property 'channelId'");
}
if (args?.siteId === undefined && !opts.urn) {
throw new Error("Missing required property 'siteId'");
}
resourceInputs["channelId"] = args?.channelId;
resourceInputs["deletionPolicy"] = args?.deletionPolicy;
resourceInputs["expireTime"] = args?.expireTime;
resourceInputs["labels"] = args?.labels;
resourceInputs["retainedReleaseCount"] = args?.retainedReleaseCount;
resourceInputs["siteId"] = args?.siteId;
resourceInputs["ttl"] = args?.ttl;
resourceInputs["effectiveLabels"] = undefined /*out*/;
resourceInputs["name"] = undefined /*out*/;
resourceInputs["pulumiLabels"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const secretOpts = { additionalSecretOutputs: ["effectiveLabels", "pulumiLabels"] };
opts = pulumi.mergeOptions(opts, secretOpts);
super(HostingChannel.__pulumiType, name, resourceInputs, opts);
}
}
exports.HostingChannel = HostingChannel;
//# sourceMappingURL=hostingChannel.js.map