Module consul

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-vault repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-vault repo.

Others

SecretBackendArgs
SecretBackendRoleArgs
SecretBackendRoleState
SecretBackendState

Resources

Resource SecretBackend

class SecretBackend extends CustomResource

constructor

new SecretBackend(name: string, args: SecretBackendArgs, opts?: pulumi.CustomResourceOptions)

Create a SecretBackend resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SecretBackendState, opts?: pulumi.CustomResourceOptions): SecretBackend

Get an existing SecretBackend resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SecretBackend

Returns true if the given object is an instance of SecretBackend. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property address

public address: pulumi.Output<string>;

Specifies the address of the Consul instance, provided as “host:port” like “127.0.0.1:8500”.

property defaultLeaseTtlSeconds

public defaultLeaseTtlSeconds: pulumi.Output<number | undefined>;

The default TTL for credentials issued by this backend.

property description

public description: pulumi.Output<string | undefined>;

A human-friendly description for this backend.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property maxLeaseTtlSeconds

public maxLeaseTtlSeconds: pulumi.Output<number | undefined>;

The maximum TTL that can be requested for credentials issued by this backend.

property path

public path: pulumi.Output<string | undefined>;

The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.

property scheme

public scheme: pulumi.Output<string | undefined>;

Specifies the URL scheme to use. Defaults to http.

property token

public token: pulumi.Output<string>;

The Consul management token this backend should use to issue new tokens.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource SecretBackendRole

class SecretBackendRole extends CustomResource

Manages a Consul secrets role for a Consul secrets engine in Vault. Consul secret backends can then issue Consul tokens.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";

const test = new vault.consul.SecretBackend("test", {
    path: "consul",
    description: "Manages the Consul backend",
    address: "127.0.0.1:8500",
    token: "4240861b-ce3d-8530-115a-521ff070dd29",
});
const example = new vault.consul.SecretBackendRole("example", {
    backend: test.path,
    policies: ["example-policy"],
});

constructor

new SecretBackendRole(name: string, args: SecretBackendRoleArgs, opts?: pulumi.CustomResourceOptions)

Create a SecretBackendRole resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SecretBackendRoleState, opts?: pulumi.CustomResourceOptions): SecretBackendRole

Get an existing SecretBackendRole resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SecretBackendRole

Returns true if the given object is an instance of SecretBackendRole. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property backend

public backend: pulumi.Output<string | undefined>;

The unique name of an existing Consul secrets backend mount. Must not begin or end with a /. One of path or backend is required.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property local

public local: pulumi.Output<boolean | undefined>;

Indicates that the token should not be replicated globally and instead be local to the current datacenter.

property maxTtl

public maxTtl: pulumi.Output<number | undefined>;

Maximum TTL for leases associated with this role, in seconds.

property name

public name: pulumi.Output<string>;

The name of the Consul secrets engine role to create.

property path

public path: pulumi.Output<string | undefined>;

The unique name of an existing Consul secrets backend mount. Must not begin or end with a /. Deprecated

property policies

public policies: pulumi.Output<string[]>;

The list of Consul ACL policies to associate with these roles.

property tokenType

public tokenType: pulumi.Output<string | undefined>;

Specifies the type of token to create when using this role. Valid values are “client” or “management”.

property ttl

public ttl: pulumi.Output<number | undefined>;

Specifies the TTL for this role.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface SecretBackendArgs

interface SecretBackendArgs

The set of arguments for constructing a SecretBackend resource.

property address

address: pulumi.Input<string>;

Specifies the address of the Consul instance, provided as “host:port” like “127.0.0.1:8500”.

property defaultLeaseTtlSeconds

defaultLeaseTtlSeconds?: pulumi.Input<number>;

The default TTL for credentials issued by this backend.

property description

description?: pulumi.Input<string>;

A human-friendly description for this backend.

property maxLeaseTtlSeconds

maxLeaseTtlSeconds?: pulumi.Input<number>;

The maximum TTL that can be requested for credentials issued by this backend.

property path

path?: pulumi.Input<string>;

The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.

property scheme

scheme?: pulumi.Input<string>;

Specifies the URL scheme to use. Defaults to http.

property token

token: pulumi.Input<string>;

The Consul management token this backend should use to issue new tokens.

interface SecretBackendRoleArgs

interface SecretBackendRoleArgs

The set of arguments for constructing a SecretBackendRole resource.

property backend

backend?: pulumi.Input<string>;

The unique name of an existing Consul secrets backend mount. Must not begin or end with a /. One of path or backend is required.

property local

local?: pulumi.Input<boolean>;

Indicates that the token should not be replicated globally and instead be local to the current datacenter.

property maxTtl

maxTtl?: pulumi.Input<number>;

Maximum TTL for leases associated with this role, in seconds.

property name

name?: pulumi.Input<string>;

The name of the Consul secrets engine role to create.

property path

DEPRECATED use backend instead

path?: pulumi.Input<string>;

The unique name of an existing Consul secrets backend mount. Must not begin or end with a /. Deprecated

property policies

policies: pulumi.Input<pulumi.Input<string>[]>;

The list of Consul ACL policies to associate with these roles.

property tokenType

tokenType?: pulumi.Input<string>;

Specifies the type of token to create when using this role. Valid values are “client” or “management”.

property ttl

ttl?: pulumi.Input<number>;

Specifies the TTL for this role.

interface SecretBackendRoleState

interface SecretBackendRoleState

Input properties used for looking up and filtering SecretBackendRole resources.

property backend

backend?: pulumi.Input<string>;

The unique name of an existing Consul secrets backend mount. Must not begin or end with a /. One of path or backend is required.

property local

local?: pulumi.Input<boolean>;

Indicates that the token should not be replicated globally and instead be local to the current datacenter.

property maxTtl

maxTtl?: pulumi.Input<number>;

Maximum TTL for leases associated with this role, in seconds.

property name

name?: pulumi.Input<string>;

The name of the Consul secrets engine role to create.

property path

DEPRECATED use backend instead

path?: pulumi.Input<string>;

The unique name of an existing Consul secrets backend mount. Must not begin or end with a /. Deprecated

property policies

policies?: pulumi.Input<pulumi.Input<string>[]>;

The list of Consul ACL policies to associate with these roles.

property tokenType

tokenType?: pulumi.Input<string>;

Specifies the type of token to create when using this role. Valid values are “client” or “management”.

property ttl

ttl?: pulumi.Input<number>;

Specifies the TTL for this role.

interface SecretBackendState

interface SecretBackendState

Input properties used for looking up and filtering SecretBackend resources.

property address

address?: pulumi.Input<string>;

Specifies the address of the Consul instance, provided as “host:port” like “127.0.0.1:8500”.

property defaultLeaseTtlSeconds

defaultLeaseTtlSeconds?: pulumi.Input<number>;

The default TTL for credentials issued by this backend.

property description

description?: pulumi.Input<string>;

A human-friendly description for this backend.

property maxLeaseTtlSeconds

maxLeaseTtlSeconds?: pulumi.Input<number>;

The maximum TTL that can be requested for credentials issued by this backend.

property path

path?: pulumi.Input<string>;

The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.

property scheme

scheme?: pulumi.Input<string>;

Specifies the URL scheme to use. Defaults to http.

property token

token?: pulumi.Input<string>;

The Consul management token this backend should use to issue new tokens.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module consul

Resources

Others

Resources

Example Usage

Others