@pulumi/fastly
Version:
A Pulumi package for creating and managing fastly cloud resources.. Based on terraform-provider-fastly: version v4
106 lines (105 loc) • 4.83 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a container that lets you store data in key-value pairs that are accessible to Compute services during request processing.
*
* In order for a Config Store (`fastly.Configstore`) to be accessible to a [Compute](https://developer.fastly.com/learning/compute/) service you'll first need to define a Compute service (`fastly.ServiceCompute`) in your configuration, and then create a link to the Config Store from within the service using the `resourceLink` block (shown in the below examples).
*
* ## Example Usage
*
* Basic usage:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fastly from "@pulumi/fastly";
*
* // IMPORTANT: Deleting a Config Store requires first deleting its resource_link.
* // This requires a two-step `pulumi up` as we can't guarantee deletion order.
* // e.g. resource_link deletion within fastly_service_compute might not finish first.
* const exampleConfigstore = new fastly.Configstore("example", {name: "my_config_store"});
* const example = fastly.getPackageHash({
* filename: "package.tar.gz",
* });
* const exampleServiceCompute = new fastly.ServiceCompute("example", {
* name: "my_compute_service",
* domains: [{
* name: "demo.example.com",
* }],
* "package": {
* filename: "package.tar.gz",
* sourceCodeHash: example.then(example => example.hash),
* },
* resourceLinks: [{
* name: "my_resource_link",
* resourceId: exampleConfigstore.id,
* }],
* forceDestroy: true,
* });
* ```
*
* ## Import
*
* Fastly Config Stores can be imported using their Store ID, e.g.
*
* ```sh
* $ pulumi import fastly:index/configstore:Configstore example xxxxxxxxxxxxxxxxxxxx
* ```
*/
export declare class Configstore extends pulumi.CustomResource {
/**
* Get an existing Configstore 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?: ConfigstoreState, opts?: pulumi.CustomResourceOptions): Configstore;
/**
* Returns true if the given object is an instance of Configstore. 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 Configstore;
/**
* Allow the Config Store to be deleted, even if it contains entries. Defaults to false.
*/
readonly forceDestroy: pulumi.Output<boolean | undefined>;
/**
* A unique name to identify the Config Store. It is important to note that changing this attribute will delete and recreate the Config Store, and discard the current entries. You MUST first delete the associated resourceLink block from your service before modifying this field.
*/
readonly name: pulumi.Output<string>;
/**
* Create a Configstore 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?: ConfigstoreArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Configstore resources.
*/
export interface ConfigstoreState {
/**
* Allow the Config Store to be deleted, even if it contains entries. Defaults to false.
*/
forceDestroy?: pulumi.Input<boolean>;
/**
* A unique name to identify the Config Store. It is important to note that changing this attribute will delete and recreate the Config Store, and discard the current entries. You MUST first delete the associated resourceLink block from your service before modifying this field.
*/
name?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Configstore resource.
*/
export interface ConfigstoreArgs {
/**
* Allow the Config Store to be deleted, even if it contains entries. Defaults to false.
*/
forceDestroy?: pulumi.Input<boolean>;
/**
* A unique name to identify the Config Store. It is important to note that changing this attribute will delete and recreate the Config Store, and discard the current entries. You MUST first delete the associated resourceLink block from your service before modifying this field.
*/
name?: pulumi.Input<string>;
}