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.

class pulumi_vault.consul.SecretBackend(resource_name, opts=None, address=None, default_lease_ttl_seconds=None, description=None, max_lease_ttl_seconds=None, path=None, scheme=None, token=None, __props__=None, __name__=None, __opts__=None)¶

Create a SecretBackend resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] address: Specifies the address of the Consul instance, provided as “host:port” like “127.0.0.1:8500”. :param pulumi.Input[float] default_lease_ttl_seconds: The default TTL for credentials issued by this backend. :param pulumi.Input[str] description: A human-friendly description for this backend. :param pulumi.Input[float] max_lease_ttl_seconds: The maximum TTL that can be requested

for credentials issued by this backend.

Parameters

path (pulumi.Input[str]) – The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.
scheme (pulumi.Input[str]) – Specifies the URL scheme to use. Defaults to http.
token (pulumi.Input[str]) – The Consul management token this backend should use to issue new tokens.

address: pulumi.Output[str] = None¶: Specifies the address of the Consul instance, provided as “host:port” like “127.0.0.1:8500”.

default_lease_ttl_seconds: pulumi.Output[float] = None¶: The default TTL for credentials issued by this backend.

description: pulumi.Output[str] = None¶: A human-friendly description for this backend.

max_lease_ttl_seconds: pulumi.Output[float] = None¶: The maximum TTL that can be requested for credentials issued by this backend.

path: pulumi.Output[str] = None¶: The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.

scheme: pulumi.Output[str] = None¶: Specifies the URL scheme to use. Defaults to http.

token: pulumi.Output[str] = None¶: The Consul management token this backend should use to issue new tokens.

static get(resource_name, id, opts=None, address=None, default_lease_ttl_seconds=None, description=None, max_lease_ttl_seconds=None, path=None, scheme=None, token=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
address (pulumi.Input[str]) – Specifies the address of the Consul instance, provided as “host:port” like “127.0.0.1:8500”.
default_lease_ttl_seconds (pulumi.Input[float]) – The default TTL for credentials issued by this backend.
description (pulumi.Input[str]) – A human-friendly description for this backend.
max_lease_ttl_seconds (pulumi.Input[float]) – The maximum TTL that can be requested for credentials issued by this backend.
path (pulumi.Input[str]) – The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.
scheme (pulumi.Input[str]) – Specifies the URL scheme to use. Defaults to http.
token (pulumi.Input[str]) – The Consul management token this backend should use to issue new tokens.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_vault.consul.SecretBackendRole(resource_name, opts=None, backend=None, local=None, max_ttl=None, name=None, path=None, policies=None, token_type=None, ttl=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_vault as vault

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

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
backend (pulumi.Input[str]) – The unique name of an existing Consul secrets backend mount. Must not begin or end with a /. One of path or backend is required.
local (pulumi.Input[bool]) – Indicates that the token should not be replicated globally and instead be local to the current datacenter.
max_ttl (pulumi.Input[float]) – Maximum TTL for leases associated with this role, in seconds.
name (pulumi.Input[str]) – The name of the Consul secrets engine role to create.
path (pulumi.Input[str]) – The unique name of an existing Consul secrets backend mount. Must not begin or end with a /. Deprecated
policies (pulumi.Input[list]) – The list of Consul ACL policies to associate with these roles.
token_type (pulumi.Input[str]) – Specifies the type of token to create when using this role. Valid values are “client” or “management”.
ttl (pulumi.Input[float]) – Specifies the TTL for this role.

backend: pulumi.Output[str] = None¶: The unique name of an existing Consul secrets backend mount. Must not begin or end with a /. One of path or backend is required.

local: pulumi.Output[bool] = None¶: Indicates that the token should not be replicated globally and instead be local to the current datacenter.

max_ttl: pulumi.Output[float] = None¶: Maximum TTL for leases associated with this role, in seconds.

name: pulumi.Output[str] = None¶: The name of the Consul secrets engine role to create.

path: pulumi.Output[str] = None¶: The unique name of an existing Consul secrets backend mount. Must not begin or end with a /. Deprecated

policies: pulumi.Output[list] = None¶: The list of Consul ACL policies to associate with these roles.

token_type: pulumi.Output[str] = None¶: Specifies the type of token to create when using this role. Valid values are “client” or “management”.

ttl: pulumi.Output[float] = None¶: Specifies the TTL for this role.

static get(resource_name, id, opts=None, backend=None, local=None, max_ttl=None, name=None, path=None, policies=None, token_type=None, ttl=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
backend (pulumi.Input[str]) – The unique name of an existing Consul secrets backend mount. Must not begin or end with a /. One of path or backend is required.
local (pulumi.Input[bool]) – Indicates that the token should not be replicated globally and instead be local to the current datacenter.
max_ttl (pulumi.Input[float]) – Maximum TTL for leases associated with this role, in seconds.
name (pulumi.Input[str]) – The name of the Consul secrets engine role to create.
path (pulumi.Input[str]) – The unique name of an existing Consul secrets backend mount. Must not begin or end with a /. Deprecated
policies (pulumi.Input[list]) – The list of Consul ACL policies to associate with these roles.
token_type (pulumi.Input[str]) – Specifies the type of token to create when using this role. Valid values are “client” or “management”.
ttl (pulumi.Input[float]) – Specifies the TTL for this role.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

consul¶

On This Page