@pulumi/gcp/apigee/envReferences.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * An `Environment Reference` in Apigee.
 *
 * To get more information about EnvReferences, see:
 *
 * * [API documentation](https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.environments.references/create)
 * * How-to Guides
 *     * [Creating an environment](https://cloud.google.com/apigee/docs/api-platform/get-started/create-environment)
 *
 * ## Import
 *
 * EnvReferences can be imported using any of these accepted formats:
 *
 * * `{{env_id}}/references/{{name}}`
 *
 * * `{{env_id}}/{{name}}`
 *
 * When using the `pulumi import` command, EnvReferences can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:apigee/envReferences:EnvReferences default {{env_id}}/references/{{name}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:apigee/envReferences:EnvReferences default {{env_id}}/{{name}}
 * ```
 */
export declare class EnvReferences extends pulumi.CustomResource {
    /**
     * Get an existing EnvReferences 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?: EnvReferencesState, opts?: pulumi.CustomResourceOptions): EnvReferences;
    /**
     * Returns true if the given object is an instance of EnvReferences.  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 EnvReferences;
    /**
     * Optional. A human-readable description of this reference.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * The Apigee environment group associated with the Apigee environment,
     * in the format `organizations/{{org_name}}/environments/{{env_name}}`.
     *
     *
     * - - -
     */
    readonly envId: pulumi.Output<string>;
    /**
     * Required. The resource id of this reference. Values must match the regular expression [\w\s-.]+.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resourceType.
     */
    readonly refers: pulumi.Output<string>;
    /**
     * The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
     */
    readonly resourceType: pulumi.Output<string>;
    /**
     * Create a EnvReferences 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: EnvReferencesArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering EnvReferences resources.
 */
export interface EnvReferencesState {
    /**
     * Optional. A human-readable description of this reference.
     */
    description?: pulumi.Input<string>;
    /**
     * The Apigee environment group associated with the Apigee environment,
     * in the format `organizations/{{org_name}}/environments/{{env_name}}`.
     *
     *
     * - - -
     */
    envId?: pulumi.Input<string>;
    /**
     * Required. The resource id of this reference. Values must match the regular expression [\w\s-.]+.
     */
    name?: pulumi.Input<string>;
    /**
     * Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resourceType.
     */
    refers?: pulumi.Input<string>;
    /**
     * The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
     */
    resourceType?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a EnvReferences resource.
 */
export interface EnvReferencesArgs {
    /**
     * Optional. A human-readable description of this reference.
     */
    description?: pulumi.Input<string>;
    /**
     * The Apigee environment group associated with the Apigee environment,
     * in the format `organizations/{{org_name}}/environments/{{env_name}}`.
     *
     *
     * - - -
     */
    envId: pulumi.Input<string>;
    /**
     * Required. The resource id of this reference. Values must match the regular expression [\w\s-.]+.
     */
    name?: pulumi.Input<string>;
    /**
     * Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resourceType.
     */
    refers: pulumi.Input<string>;
    /**
     * The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
     */
    resourceType: pulumi.Input<string>;
}