SecretBackend

Import

Consul secret backends can be imported using the path, e.g.

 $ pulumi import vault:consul/secretBackend:SecretBackend example consul

Create a SecretBackend Resource

new SecretBackend(name: string, args: SecretBackendArgs, opts?: CustomResourceOptions);
@overload
def SecretBackend(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  address: Optional[str] = None,
                  ca_cert: Optional[str] = None,
                  client_cert: Optional[str] = None,
                  client_key: Optional[str] = None,
                  default_lease_ttl_seconds: Optional[int] = None,
                  description: Optional[str] = None,
                  max_lease_ttl_seconds: Optional[int] = None,
                  path: Optional[str] = None,
                  scheme: Optional[str] = None,
                  token: Optional[str] = None)
@overload
def SecretBackend(resource_name: str,
                  args: SecretBackendArgs,
                  opts: Optional[ResourceOptions] = None)
func NewSecretBackend(ctx *Context, name string, args SecretBackendArgs, opts ...ResourceOption) (*SecretBackend, error)
public SecretBackend(string name, SecretBackendArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args SecretBackendArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args SecretBackendArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args SecretBackendArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args SecretBackendArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

SecretBackend Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The SecretBackend resource accepts the following input properties:

Address string
Specifies the address of the Consul instance, provided as “host:port” like “127.0.0.1:8500”.
Token string
The Consul management token this backend should use to issue new tokens.
CaCert string
CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
ClientCert string
Client certificate used for Consul’s TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
ClientKey string
Client key used for Consul’s TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
DefaultLeaseTtlSeconds int
The default TTL for credentials issued by this backend.
Description string
A human-friendly description for this backend.
MaxLeaseTtlSeconds int
The maximum TTL that can be requested for credentials issued by this backend.
Path string
The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.
Scheme string
Specifies the URL scheme to use. Defaults to http.
Address string
Specifies the address of the Consul instance, provided as “host:port” like “127.0.0.1:8500”.
Token string
The Consul management token this backend should use to issue new tokens.
CaCert string
CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
ClientCert string
Client certificate used for Consul’s TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
ClientKey string
Client key used for Consul’s TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
DefaultLeaseTtlSeconds int
The default TTL for credentials issued by this backend.
Description string
A human-friendly description for this backend.
MaxLeaseTtlSeconds int
The maximum TTL that can be requested for credentials issued by this backend.
Path string
The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.
Scheme string
Specifies the URL scheme to use. Defaults to http.
address string
Specifies the address of the Consul instance, provided as “host:port” like “127.0.0.1:8500”.
token string
The Consul management token this backend should use to issue new tokens.
caCert string
CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
clientCert string
Client certificate used for Consul’s TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
clientKey string
Client key used for Consul’s TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
defaultLeaseTtlSeconds number
The default TTL for credentials issued by this backend.
description string
A human-friendly description for this backend.
maxLeaseTtlSeconds number
The maximum TTL that can be requested for credentials issued by this backend.
path string
The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.
scheme string
Specifies the URL scheme to use. Defaults to http.
address str
Specifies the address of the Consul instance, provided as “host:port” like “127.0.0.1:8500”.
token str
The Consul management token this backend should use to issue new tokens.
ca_cert str
CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
client_cert str
Client certificate used for Consul’s TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
client_key str
Client key used for Consul’s TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
default_lease_ttl_seconds int
The default TTL for credentials issued by this backend.
description str
A human-friendly description for this backend.
max_lease_ttl_seconds int
The maximum TTL that can be requested for credentials issued by this backend.
path str
The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.
scheme str
Specifies the URL scheme to use. Defaults to http.

Outputs

All input properties are implicitly available as output properties. Additionally, the SecretBackend resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing SecretBackend Resource

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

public static get(name: string, id: Input<ID>, state?: SecretBackendState, opts?: CustomResourceOptions): SecretBackend
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address: Optional[str] = None,
        ca_cert: Optional[str] = None,
        client_cert: Optional[str] = None,
        client_key: Optional[str] = None,
        default_lease_ttl_seconds: Optional[int] = None,
        description: Optional[str] = None,
        max_lease_ttl_seconds: Optional[int] = None,
        path: Optional[str] = None,
        scheme: Optional[str] = None,
        token: Optional[str] = None) -> SecretBackend
func GetSecretBackend(ctx *Context, name string, id IDInput, state *SecretBackendState, opts ...ResourceOption) (*SecretBackend, error)
public static SecretBackend Get(string name, Input<string> id, SecretBackendState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Address string
Specifies the address of the Consul instance, provided as “host:port” like “127.0.0.1:8500”.
CaCert string
CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
ClientCert string
Client certificate used for Consul’s TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
ClientKey string
Client key used for Consul’s TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
DefaultLeaseTtlSeconds int
The default TTL for credentials issued by this backend.
Description string
A human-friendly description for this backend.
MaxLeaseTtlSeconds int
The maximum TTL that can be requested for credentials issued by this backend.
Path string
The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.
Scheme string
Specifies the URL scheme to use. Defaults to http.
Token string
The Consul management token this backend should use to issue new tokens.
Address string
Specifies the address of the Consul instance, provided as “host:port” like “127.0.0.1:8500”.
CaCert string
CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
ClientCert string
Client certificate used for Consul’s TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
ClientKey string
Client key used for Consul’s TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
DefaultLeaseTtlSeconds int
The default TTL for credentials issued by this backend.
Description string
A human-friendly description for this backend.
MaxLeaseTtlSeconds int
The maximum TTL that can be requested for credentials issued by this backend.
Path string
The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.
Scheme string
Specifies the URL scheme to use. Defaults to http.
Token string
The Consul management token this backend should use to issue new tokens.
address string
Specifies the address of the Consul instance, provided as “host:port” like “127.0.0.1:8500”.
caCert string
CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
clientCert string
Client certificate used for Consul’s TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
clientKey string
Client key used for Consul’s TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
defaultLeaseTtlSeconds number
The default TTL for credentials issued by this backend.
description string
A human-friendly description for this backend.
maxLeaseTtlSeconds number
The maximum TTL that can be requested for credentials issued by this backend.
path string
The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.
scheme string
Specifies the URL scheme to use. Defaults to http.
token string
The Consul management token this backend should use to issue new tokens.
address str
Specifies the address of the Consul instance, provided as “host:port” like “127.0.0.1:8500”.
ca_cert str
CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
client_cert str
Client certificate used for Consul’s TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
client_key str
Client key used for Consul’s TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
default_lease_ttl_seconds int
The default TTL for credentials issued by this backend.
description str
A human-friendly description for this backend.
max_lease_ttl_seconds int
The maximum TTL that can be requested for credentials issued by this backend.
path str
The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.
scheme str
Specifies the URL scheme to use. Defaults to http.
token str
The Consul management token this backend should use to issue new tokens.

Package Details

Repository
https://github.com/pulumi/pulumi-vault
License
Apache-2.0
Notes
This Pulumi package is based on the vault Terraform Provider.