@pulumi/consul
Version:
A Pulumi package for creating and managing consul resources.
136 lines (135 loc) • 3.99 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Starting with Consul 1.4.0, the consul.AclPolicy can be used to managed Consul ACL policies.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as consul from "@pulumi/consul";
*
* const test = new consul.AclPolicy("test", {
* name: "my_policy",
* datacenters: ["dc1"],
* rules: `node_prefix "" {
* policy = "read"
* }
* `,
* });
* ```
*
* ## Import
*
* `consul_acl_policy` can be imported:
*
* ```sh
* $ pulumi import consul:index/aclPolicy:AclPolicy my-policy 1c90ef03-a6dd-6a8c-ac49-042ad3752896
* ```
*/
export declare class AclPolicy extends pulumi.CustomResource {
/**
* Get an existing AclPolicy 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?: AclPolicyState, opts?: pulumi.CustomResourceOptions): AclPolicy;
/**
* Returns true if the given object is an instance of AclPolicy. 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 AclPolicy;
/**
* The datacenters of the policy.
*/
readonly datacenters: pulumi.Output<string[] | undefined>;
/**
* The description of the policy.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The name of the policy.
*/
readonly name: pulumi.Output<string>;
/**
* The namespace to create the policy within.
*/
readonly namespace: pulumi.Output<string | undefined>;
/**
* The partition the ACL policy is associated with.
*/
readonly partition: pulumi.Output<string | undefined>;
/**
* The rules of the policy.
*/
readonly rules: pulumi.Output<string>;
/**
* Create a AclPolicy 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: AclPolicyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AclPolicy resources.
*/
export interface AclPolicyState {
/**
* The datacenters of the policy.
*/
datacenters?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The description of the policy.
*/
description?: pulumi.Input<string>;
/**
* The name of the policy.
*/
name?: pulumi.Input<string>;
/**
* The namespace to create the policy within.
*/
namespace?: pulumi.Input<string>;
/**
* The partition the ACL policy is associated with.
*/
partition?: pulumi.Input<string>;
/**
* The rules of the policy.
*/
rules?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a AclPolicy resource.
*/
export interface AclPolicyArgs {
/**
* The datacenters of the policy.
*/
datacenters?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The description of the policy.
*/
description?: pulumi.Input<string>;
/**
* The name of the policy.
*/
name?: pulumi.Input<string>;
/**
* The namespace to create the policy within.
*/
namespace?: pulumi.Input<string>;
/**
* The partition the ACL policy is associated with.
*/
partition?: pulumi.Input<string>;
/**
* The rules of the policy.
*/
rules: pulumi.Input<string>;
}