@pulumi/consul
Version:
A Pulumi package for creating and managing consul resources.
163 lines (162 loc) • 5.69 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as consul from "@pulumi/consul";
*
* const read_policy = new consul.AclPolicy("read-policy", {
* name: "read-policy",
* rules: "node \"\" { policy = \"read\" }",
* datacenters: ["dc1"],
* });
* const read = new consul.AclRole("read", {
* name: "foo",
* description: "bar",
* policies: [read_policy.id],
* serviceIdentities: [{
* serviceName: "foo",
* }],
* });
* ```
*
* ## Import
*
* ```sh
* $ pulumi import consul:index/aclRole:AclRole read 816a195f-6cb1-2e8d-92af-3011ae706318
* ```
*/
export declare class AclRole extends pulumi.CustomResource {
/**
* Get an existing AclRole 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?: AclRoleState, opts?: pulumi.CustomResourceOptions): AclRole;
/**
* Returns true if the given object is an instance of AclRole. 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 AclRole;
/**
* A free form human readable description of the role.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The name of the ACL role.
*/
readonly name: pulumi.Output<string>;
/**
* The namespace to create the role within.
*/
readonly namespace: pulumi.Output<string | undefined>;
/**
* The list of node identities that should be applied to the role.
*/
readonly nodeIdentities: pulumi.Output<outputs.AclRoleNodeIdentity[] | undefined>;
/**
* The partition the ACL role is associated with.
*/
readonly partition: pulumi.Output<string | undefined>;
/**
* The list of policies that should be applied to the role. Both the policy ID or its name can be used.
*/
readonly policies: pulumi.Output<string[] | undefined>;
/**
* The list of service identities that should be applied to the role.
*/
readonly serviceIdentities: pulumi.Output<outputs.AclRoleServiceIdentity[] | undefined>;
/**
* The list of templated policies that should be applied to the token.
*/
readonly templatedPolicies: pulumi.Output<outputs.AclRoleTemplatedPolicy[] | undefined>;
/**
* Create a AclRole 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?: AclRoleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AclRole resources.
*/
export interface AclRoleState {
/**
* A free form human readable description of the role.
*/
description?: pulumi.Input<string>;
/**
* The name of the ACL role.
*/
name?: pulumi.Input<string>;
/**
* The namespace to create the role within.
*/
namespace?: pulumi.Input<string>;
/**
* The list of node identities that should be applied to the role.
*/
nodeIdentities?: pulumi.Input<pulumi.Input<inputs.AclRoleNodeIdentity>[]>;
/**
* The partition the ACL role is associated with.
*/
partition?: pulumi.Input<string>;
/**
* The list of policies that should be applied to the role. Both the policy ID or its name can be used.
*/
policies?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The list of service identities that should be applied to the role.
*/
serviceIdentities?: pulumi.Input<pulumi.Input<inputs.AclRoleServiceIdentity>[]>;
/**
* The list of templated policies that should be applied to the token.
*/
templatedPolicies?: pulumi.Input<pulumi.Input<inputs.AclRoleTemplatedPolicy>[]>;
}
/**
* The set of arguments for constructing a AclRole resource.
*/
export interface AclRoleArgs {
/**
* A free form human readable description of the role.
*/
description?: pulumi.Input<string>;
/**
* The name of the ACL role.
*/
name?: pulumi.Input<string>;
/**
* The namespace to create the role within.
*/
namespace?: pulumi.Input<string>;
/**
* The list of node identities that should be applied to the role.
*/
nodeIdentities?: pulumi.Input<pulumi.Input<inputs.AclRoleNodeIdentity>[]>;
/**
* The partition the ACL role is associated with.
*/
partition?: pulumi.Input<string>;
/**
* The list of policies that should be applied to the role. Both the policy ID or its name can be used.
*/
policies?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The list of service identities that should be applied to the role.
*/
serviceIdentities?: pulumi.Input<pulumi.Input<inputs.AclRoleServiceIdentity>[]>;
/**
* The list of templated policies that should be applied to the token.
*/
templatedPolicies?: pulumi.Input<pulumi.Input<inputs.AclRoleTemplatedPolicy>[]>;
}