@pulumi/consul/networkArea.d.ts

A Pulumi package for creating and managing consul resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * > **NOTE:** This feature requires [Consul Enterprise](https://www.consul.io/docs/enterprise/index.html).
 *
 * The `consul.NetworkArea` resource manages a relationship between servers in two
 * different Consul datacenters.
 *
 * Unlike Consul's WAN feature, network areas use just the server RPC port for
 * communication, and relationships can be made between independent pairs of
 * datacenters, so not all servers need to be fully connected. This allows for
 * complex topologies among Consul datacenters like hub/spoke and more general trees.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as consul from "@pulumi/consul";
 *
 * const dc2 = new consul.NetworkArea("dc2", {
 *     peerDatacenter: "dc2",
 *     retryJoins: ["1.2.3.4"],
 *     useTls: true,
 * });
 * ```
 */
export declare class NetworkArea extends pulumi.CustomResource {
    /**
     * Get an existing NetworkArea 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?: NetworkAreaState, opts?: pulumi.CustomResourceOptions): NetworkArea;
    /**
     * Returns true if the given object is an instance of NetworkArea.  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 NetworkArea;
    /**
     * The datacenter to use. This overrides the
     * agent's default datacenter and the datacenter in the provider setup.
     */
    readonly datacenter: pulumi.Output<string>;
    /**
     * The name of the Consul datacenter that will be
     * joined to form the area.
     */
    readonly peerDatacenter: pulumi.Output<string>;
    /**
     * Specifies a list of Consul servers to attempt to
     * join. Servers can be given as `IP`, `IP:port`, `hostname`, or `hostname:port`.
     */
    readonly retryJoins: pulumi.Output<string[] | undefined>;
    /**
     * The ACL token to use. This overrides the
     * token that the agent provides by default.
     *
     * @deprecated The token argument has been deprecated and will be removed in a future release.
Please use the token argument in the provider configuration
     */
    readonly token: pulumi.Output<string | undefined>;
    /**
     * Specifies whether gossip over this area should be
     * encrypted with TLS if possible. Defaults to `false`.
     */
    readonly useTls: pulumi.Output<boolean | undefined>;
    /**
     * Create a NetworkArea 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: NetworkAreaArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering NetworkArea resources.
 */
export interface NetworkAreaState {
    /**
     * The datacenter to use. This overrides the
     * agent's default datacenter and the datacenter in the provider setup.
     */
    datacenter?: pulumi.Input<string>;
    /**
     * The name of the Consul datacenter that will be
     * joined to form the area.
     */
    peerDatacenter?: pulumi.Input<string>;
    /**
     * Specifies a list of Consul servers to attempt to
     * join. Servers can be given as `IP`, `IP:port`, `hostname`, or `hostname:port`.
     */
    retryJoins?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The ACL token to use. This overrides the
     * token that the agent provides by default.
     *
     * @deprecated The token argument has been deprecated and will be removed in a future release.
Please use the token argument in the provider configuration
     */
    token?: pulumi.Input<string>;
    /**
     * Specifies whether gossip over this area should be
     * encrypted with TLS if possible. Defaults to `false`.
     */
    useTls?: pulumi.Input<boolean>;
}
/**
 * The set of arguments for constructing a NetworkArea resource.
 */
export interface NetworkAreaArgs {
    /**
     * The datacenter to use. This overrides the
     * agent's default datacenter and the datacenter in the provider setup.
     */
    datacenter?: pulumi.Input<string>;
    /**
     * The name of the Consul datacenter that will be
     * joined to form the area.
     */
    peerDatacenter: pulumi.Input<string>;
    /**
     * Specifies a list of Consul servers to attempt to
     * join. Servers can be given as `IP`, `IP:port`, `hostname`, or `hostname:port`.
     */
    retryJoins?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The ACL token to use. This overrides the
     * token that the agent provides by default.
     *
     * @deprecated The token argument has been deprecated and will be removed in a future release.
Please use the token argument in the provider configuration
     */
    token?: pulumi.Input<string>;
    /**
     * Specifies whether gossip over this area should be
     * encrypted with TLS if possible. Defaults to `false`.
     */
    useTls?: pulumi.Input<boolean>;
}