@pulumi/consul
Version:
A Pulumi package for creating and managing consul resources.
121 lines • 4.87 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.NamespaceRoleAttachment = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* > **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
* ```
*/
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, id, state, opts) {
return new NamespaceRoleAttachment(name, state, { ...opts, id: id });
}
/**
* 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) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === NamespaceRoleAttachment.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["namespace"] = state?.namespace;
resourceInputs["role"] = state?.role;
}
else {
const args = argsOrState;
if (args?.namespace === undefined && !opts.urn) {
throw new Error("Missing required property 'namespace'");
}
if (args?.role === undefined && !opts.urn) {
throw new Error("Missing required property 'role'");
}
resourceInputs["namespace"] = args?.namespace;
resourceInputs["role"] = args?.role;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(NamespaceRoleAttachment.__pulumiType, name, resourceInputs, opts);
}
}
exports.NamespaceRoleAttachment = NamespaceRoleAttachment;
/** @internal */
NamespaceRoleAttachment.__pulumiType = 'consul:index/namespaceRoleAttachment:NamespaceRoleAttachment';
//# sourceMappingURL=namespaceRoleAttachment.js.map