@pulumi/consul/namespaceRoleAttachment.d.ts

A Pulumi package for creating and managing consul resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * > **NOTE:** This feature requires Consul Enterprise.
 *
 * The `consul.NamespaceRoleAttachment` resource links a Consul Namespace and an ACL
 * role. The link is implemented through an update to the Consul Namespace.
 *
 * > **NOTE:** This resource is only useful to attach roles to a namespace
 * that has been created outside the current Terraform configuration, like the
 * `default` namespace. If the namespace you need to attach a role to has
 * been created in the current Terraform configuration and will only be used in it,
 * you should use the `roleDefaults` attribute of [`consul.Namespace`](https://www.terraform.io/docs/providers/consul/r/namespace.html).
 *
 * ## Example Usage
 *
 * ### Attach a role to the default namespace
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as consul from "@pulumi/consul";
 *
 * const agent = new consul.AclRole("agent", {name: "agent"});
 * const attachment = new consul.NamespaceRoleAttachment("attachment", {
 *     namespace: "default",
 *     role: agent.name,
 * });
 * ```
 *
 * ### Attach a role to a namespace created in another Terraform configuration
 *
 * ### In `first_configuration/main.tf`
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as consul from "@pulumi/consul";
 *
 * const qa = new consul.Namespace("qa", {name: "qa"});
 * ```
 *
 * ### In `second_configuration/main.tf`
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as consul from "@pulumi/consul";
 *
 * const agent = new consul.AclRole("agent", {name: "agent"});
 * const attachment = new consul.NamespaceRoleAttachment("attachment", {
 *     namespace: "qa",
 *     role: agent.name,
 * });
 * ```
 * **NOTE**: consulAclNamespace would attempt to enforce an empty set of default
 * roles, because its `roleDefaults` attribute is empty. For this reason it
 * is necessary to add the lifecycle clause to prevent Terraform from attempting to
 * empty the set of policies associated to the namespace.
 *
 * ## Import
 *
 * `consul.NamespaceRoleAttachment` can be imported. This is especially useful
 * to manage the policies attached to the `default` namespace:
 *
 * ```sh
 * $ pulumi import consul:index/namespaceRoleAttachment:NamespaceRoleAttachment default default:role_name
 * ```
 */
export declare class NamespaceRoleAttachment extends pulumi.CustomResource {
    /**
     * Get an existing NamespaceRoleAttachment 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?: NamespaceRoleAttachmentState, opts?: pulumi.CustomResourceOptions): NamespaceRoleAttachment;
    /**
     * Returns true if the given object is an instance of NamespaceRoleAttachment.  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 NamespaceRoleAttachment;
    /**
     * The namespace to attach the role to.
     */
    readonly namespace: pulumi.Output<string>;
    /**
     * The name of the role attached to the namespace.
     */
    readonly role: pulumi.Output<string>;
    /**
     * Create a NamespaceRoleAttachment 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: NamespaceRoleAttachmentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering NamespaceRoleAttachment resources.
 */
export interface NamespaceRoleAttachmentState {
    /**
     * The namespace to attach the role to.
     */
    namespace?: pulumi.Input<string>;
    /**
     * The name of the role attached to the namespace.
     */
    role?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a NamespaceRoleAttachment resource.
 */
export interface NamespaceRoleAttachmentArgs {
    /**
     * The namespace to attach the role to.
     */
    namespace: pulumi.Input<string>;
    /**
     * The name of the role attached to the namespace.
     */
    role: pulumi.Input<string>;
}