@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
182 lines (181 loc) • 7.1 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates key value entries in a key value map scoped to an environment.
*
* To get more information about EnvironmentKeyvaluemapsEntries, see:
*
* * [API documentation](https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.keyvaluemaps.entries/create)
* * How-to Guides
* * [Using key value maps](https://cloud.google.com/apigee/docs/api-platform/cache/key-value-maps)
*
* ## Example Usage
*
* ### Apigee Environment Keyvaluemaps Entries Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const current = gcp.organizations.getClientConfig({});
* const apigeeNetwork = new gcp.compute.Network("apigee_network", {name: "apigee-network"});
* const apigeeRange = new gcp.compute.GlobalAddress("apigee_range", {
* name: "apigee-range",
* purpose: "VPC_PEERING",
* addressType: "INTERNAL",
* prefixLength: 16,
* network: apigeeNetwork.id,
* });
* const apigeeVpcConnection = new gcp.servicenetworking.Connection("apigee_vpc_connection", {
* network: apigeeNetwork.id,
* service: "servicenetworking.googleapis.com",
* reservedPeeringRanges: [apigeeRange.name],
* });
* const apigeeOrg = new gcp.apigee.Organization("apigee_org", {
* analyticsRegion: "us-central1",
* projectId: current.then(current => current.project),
* authorizedNetwork: apigeeNetwork.id,
* }, {
* dependsOn: [apigeeVpcConnection],
* });
* const apigeeEnvironment = new gcp.apigee.Environment("apigee_environment", {
* orgId: apigeeOrg.id,
* name: "tf-test-env",
* description: "Apigee Environment",
* displayName: "Apigee Environment",
* });
* const apigeeInstance = new gcp.apigee.Instance("apigee_instance", {
* name: "tf-test-instance",
* location: "us-central1",
* orgId: apigeeOrg.id,
* });
* const apigeeInstanceAttachment = new gcp.apigee.InstanceAttachment("apigee_instance_attachment", {
* instanceId: apigeeInstance.id,
* environment: apigeeEnvironment.name,
* });
* const apigeeEnvironmentKeyvaluemaps = new gcp.apigee.EnvironmentKeyvaluemaps("apigee_environment_keyvaluemaps", {
* envId: createApigeeEnvironment.id,
* name: "tf-test-env-kvms",
* }, {
* dependsOn: [
* apigeeOrg,
* apigeeEnvironment,
* apigeeInstance,
* apigeeInstanceAttachment,
* ],
* });
* const apigeeEnvironmentKeyvaluemapsEntries = new gcp.apigee.EnvironmentKeyvaluemapsEntries("apigee_environment_keyvaluemaps_entries", {
* envKeyvaluemapId: apigeeEnvironmentKeyvaluemaps.id,
* name: "testName",
* value: "testValue",
* }, {
* dependsOn: [
* apigeeOrg,
* apigeeEnvironment,
* apigeeInstance,
* apigeeInstanceAttachment,
* apigeeEnvironmentKeyvaluemaps,
* ],
* });
* ```
*
* ## Import
*
* EnvironmentKeyvaluemapsEntries can be imported using any of these accepted formats:
*
* * `{{env_keyvaluemap_id}}/entries/{{name}}`
*
* * `{{env_keyvaluemap_id}}/{{name}}`
*
* When using the `pulumi import` command, EnvironmentKeyvaluemapsEntries can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:apigee/environmentKeyvaluemapsEntries:EnvironmentKeyvaluemapsEntries default {{env_keyvaluemap_id}}/entries/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:apigee/environmentKeyvaluemapsEntries:EnvironmentKeyvaluemapsEntries default {{env_keyvaluemap_id}}/{{name}}
* ```
*/
export declare class EnvironmentKeyvaluemapsEntries extends pulumi.CustomResource {
/**
* Get an existing EnvironmentKeyvaluemapsEntries 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?: EnvironmentKeyvaluemapsEntriesState, opts?: pulumi.CustomResourceOptions): EnvironmentKeyvaluemapsEntries;
/**
* Returns true if the given object is an instance of EnvironmentKeyvaluemapsEntries. 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 EnvironmentKeyvaluemapsEntries;
/**
* The Apigee environment keyvalumaps Id associated with the Apigee environment,
* in the format `organizations/{{org_name}}/environments/{{env_name}}/keyvaluemaps/{{keyvaluemap_name}}`.
*
*
* - - -
*/
readonly envKeyvaluemapId: pulumi.Output<string>;
/**
* Required. Resource URI that can be used to identify the scope of the key value map entries.
*/
readonly name: pulumi.Output<string>;
/**
* Required. Data or payload that is being retrieved and associated with the unique key.
*/
readonly value: pulumi.Output<string>;
/**
* Create a EnvironmentKeyvaluemapsEntries 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: EnvironmentKeyvaluemapsEntriesArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering EnvironmentKeyvaluemapsEntries resources.
*/
export interface EnvironmentKeyvaluemapsEntriesState {
/**
* The Apigee environment keyvalumaps Id associated with the Apigee environment,
* in the format `organizations/{{org_name}}/environments/{{env_name}}/keyvaluemaps/{{keyvaluemap_name}}`.
*
*
* - - -
*/
envKeyvaluemapId?: pulumi.Input<string>;
/**
* Required. Resource URI that can be used to identify the scope of the key value map entries.
*/
name?: pulumi.Input<string>;
/**
* Required. Data or payload that is being retrieved and associated with the unique key.
*/
value?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a EnvironmentKeyvaluemapsEntries resource.
*/
export interface EnvironmentKeyvaluemapsEntriesArgs {
/**
* The Apigee environment keyvalumaps Id associated with the Apigee environment,
* in the format `organizations/{{org_name}}/environments/{{env_name}}/keyvaluemaps/{{keyvaluemap_name}}`.
*
*
* - - -
*/
envKeyvaluemapId: pulumi.Input<string>;
/**
* Required. Resource URI that can be used to identify the scope of the key value map entries.
*/
name?: pulumi.Input<string>;
/**
* Required. Data or payload that is being retrieved and associated with the unique key.
*/
value: pulumi.Input<string>;
}