@pulumi/gcp/compute/interconnectGroup.d.ts

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

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * An interconnect group resource allows customers to create, analyze, and
 * expand their redundant connections.
 *
 * To get more information about InterconnectGroup, see:
 *
 * * [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/interconnects)
 * * How-to Guides
 *     * [Create a Dedicated Interconnect](https://cloud.google.com/network-connectivity/docs/interconnect/concepts/dedicated-overview)
 *
 * ## Example Usage
 *
 * ### Interconnect Group Basic
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const example_interconnect_group = new gcp.compute.InterconnectGroup("example-interconnect-group", {
 *     name: "example-interconnect-group",
 *     intent: {
 *         topologyCapability: "NO_SLA",
 *     },
 * });
 * ```
 *
 * ## Import
 *
 * InterconnectGroup can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/global/interconnectGroups/{{name}}`
 *
 * * `{{project}}/{{name}}`
 *
 * * `{{name}}`
 *
 * When using the `pulumi import` command, InterconnectGroup can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:compute/interconnectGroup:InterconnectGroup default projects/{{project}}/global/interconnectGroups/{{name}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:compute/interconnectGroup:InterconnectGroup default {{project}}/{{name}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:compute/interconnectGroup:InterconnectGroup default {{name}}
 * ```
 */
export declare class InterconnectGroup extends pulumi.CustomResource {
    /**
     * Get an existing InterconnectGroup 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?: InterconnectGroupState, opts?: pulumi.CustomResourceOptions): InterconnectGroup;
    /**
     * Returns true if the given object is an instance of InterconnectGroup.  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 InterconnectGroup;
    /**
     * The status of the group as configured. This has the same
     * structure as the operational field reported by the OperationalStatus
     * method, but does not take into account the operational status of each
     * resource.
     * Structure is documented below.
     */
    readonly configureds: pulumi.Output<outputs.compute.InterconnectGroupConfigured[]>;
    /**
     * Creation timestamp in RFC3339 text format.
     */
    readonly creationTimestamp: pulumi.Output<string>;
    /**
     * An optional description of this resource. Provide this property when you create the resource.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * The user's intent for this group. This is the only required field besides
     * the name that must be specified on group creation.
     * Structure is documented below.
     */
    readonly intent: pulumi.Output<outputs.compute.InterconnectGroupIntent>;
    /**
     * Interconnects in the InterconnectGroup. Keys are arbitrary user-specified
     * strings. Users are encouraged, but not required, to use their preferred
     * format for resource links as keys.
     * Note that there are add-members and remove-members methods in gcloud.
     * The size of this map is limited by an "Interconnects per group" quota.
     * Structure is documented below.
     */
    readonly interconnects: pulumi.Output<outputs.compute.InterconnectGroupInterconnect[] | undefined>;
    /**
     * Name of the resource. Provided by the client when the resource is created. The name must be
     * 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters
     * long and match the regular expression `a-z?` which means the first
     * character must be a lowercase letter, and all following characters must be a dash,
     * lowercase letter, or digit, except the last character, which cannot be a dash.
     */
    readonly name: pulumi.Output<string>;
    /**
     * An analysis of the physical layout of Interconnects in this
     * group. Every Interconnect in the group is shown once in this structure.
     * Structure is documented below.
     */
    readonly physicalStructures: pulumi.Output<outputs.compute.InterconnectGroupPhysicalStructure[]>;
    /**
     * 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 InterconnectGroup 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: InterconnectGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering InterconnectGroup resources.
 */
export interface InterconnectGroupState {
    /**
     * The status of the group as configured. This has the same
     * structure as the operational field reported by the OperationalStatus
     * method, but does not take into account the operational status of each
     * resource.
     * Structure is documented below.
     */
    configureds?: pulumi.Input<pulumi.Input<inputs.compute.InterconnectGroupConfigured>[]>;
    /**
     * Creation timestamp in RFC3339 text format.
     */
    creationTimestamp?: pulumi.Input<string>;
    /**
     * An optional description of this resource. Provide this property when you create the resource.
     */
    description?: pulumi.Input<string>;
    /**
     * The user's intent for this group. This is the only required field besides
     * the name that must be specified on group creation.
     * Structure is documented below.
     */
    intent?: pulumi.Input<inputs.compute.InterconnectGroupIntent>;
    /**
     * Interconnects in the InterconnectGroup. Keys are arbitrary user-specified
     * strings. Users are encouraged, but not required, to use their preferred
     * format for resource links as keys.
     * Note that there are add-members and remove-members methods in gcloud.
     * The size of this map is limited by an "Interconnects per group" quota.
     * Structure is documented below.
     */
    interconnects?: pulumi.Input<pulumi.Input<inputs.compute.InterconnectGroupInterconnect>[]>;
    /**
     * Name of the resource. Provided by the client when the resource is created. The name must be
     * 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters
     * long and match the regular expression `a-z?` which means the first
     * character must be a lowercase letter, and all following characters must be a dash,
     * lowercase letter, or digit, except the last character, which cannot be a dash.
     */
    name?: pulumi.Input<string>;
    /**
     * An analysis of the physical layout of Interconnects in this
     * group. Every Interconnect in the group is shown once in this structure.
     * Structure is documented below.
     */
    physicalStructures?: pulumi.Input<pulumi.Input<inputs.compute.InterconnectGroupPhysicalStructure>[]>;
    /**
     * 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 InterconnectGroup resource.
 */
export interface InterconnectGroupArgs {
    /**
     * An optional description of this resource. Provide this property when you create the resource.
     */
    description?: pulumi.Input<string>;
    /**
     * The user's intent for this group. This is the only required field besides
     * the name that must be specified on group creation.
     * Structure is documented below.
     */
    intent: pulumi.Input<inputs.compute.InterconnectGroupIntent>;
    /**
     * Interconnects in the InterconnectGroup. Keys are arbitrary user-specified
     * strings. Users are encouraged, but not required, to use their preferred
     * format for resource links as keys.
     * Note that there are add-members and remove-members methods in gcloud.
     * The size of this map is limited by an "Interconnects per group" quota.
     * Structure is documented below.
     */
    interconnects?: pulumi.Input<pulumi.Input<inputs.compute.InterconnectGroupInterconnect>[]>;
    /**
     * Name of the resource. Provided by the client when the resource is created. The name must be
     * 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters
     * long and match the regular expression `a-z?` which means the first
     * character must be a lowercase letter, and all following characters must be a dash,
     * lowercase letter, or digit, except the last character, which cannot be a dash.
     */
    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>;
}