1. Packages
  2. HashiCorp Vault Provider
  3. API Docs
  4. pkiSecret
  5. SecretBackendRootCert
HashiCorp Vault v6.6.0 published on Thursday, Mar 13, 2025 by Pulumi

vault.pkiSecret.SecretBackendRootCert

Explore with Pulumi AI

Example Usage

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

const test = new vault.pkisecret.SecretBackendRootCert("test", {
    backend: pki.path,
    type: "internal",
    commonName: "Root CA",
    ttl: "315360000",
    format: "pem",
    privateKeyFormat: "der",
    keyType: "rsa",
    keyBits: 4096,
    excludeCnFromSans: true,
    ou: "My OU",
    organization: "My organization",
}, {
    dependsOn: [pki],
});
Copy
import pulumi
import pulumi_vault as vault

test = vault.pki_secret.SecretBackendRootCert("test",
    backend=pki["path"],
    type="internal",
    common_name="Root CA",
    ttl="315360000",
    format="pem",
    private_key_format="der",
    key_type="rsa",
    key_bits=4096,
    exclude_cn_from_sans=True,
    ou="My OU",
    organization="My organization",
    opts = pulumi.ResourceOptions(depends_on=[pki]))
Copy
package main

import (
	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault/pkisecret"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := pkisecret.NewSecretBackendRootCert(ctx, "test", &pkisecret.SecretBackendRootCertArgs{
			Backend:           pulumi.Any(pki.Path),
			Type:              pulumi.String("internal"),
			CommonName:        pulumi.String("Root CA"),
			Ttl:               pulumi.String("315360000"),
			Format:            pulumi.String("pem"),
			PrivateKeyFormat:  pulumi.String("der"),
			KeyType:           pulumi.String("rsa"),
			KeyBits:           pulumi.Int(4096),
			ExcludeCnFromSans: pulumi.Bool(true),
			Ou:                pulumi.String("My OU"),
			Organization:      pulumi.String("My organization"),
		}, pulumi.DependsOn([]pulumi.Resource{
			pki,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vault = Pulumi.Vault;

return await Deployment.RunAsync(() => 
{
    var test = new Vault.PkiSecret.SecretBackendRootCert("test", new()
    {
        Backend = pki.Path,
        Type = "internal",
        CommonName = "Root CA",
        Ttl = "315360000",
        Format = "pem",
        PrivateKeyFormat = "der",
        KeyType = "rsa",
        KeyBits = 4096,
        ExcludeCnFromSans = true,
        Ou = "My OU",
        Organization = "My organization",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            pki,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.pkiSecret.SecretBackendRootCert;
import com.pulumi.vault.pkiSecret.SecretBackendRootCertArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new SecretBackendRootCert("test", SecretBackendRootCertArgs.builder()
            .backend(pki.path())
            .type("internal")
            .commonName("Root CA")
            .ttl("315360000")
            .format("pem")
            .privateKeyFormat("der")
            .keyType("rsa")
            .keyBits(4096)
            .excludeCnFromSans(true)
            .ou("My OU")
            .organization("My organization")
            .build(), CustomResourceOptions.builder()
                .dependsOn(pki)
                .build());

    }
}
Copy
resources:
  test:
    type: vault:pkiSecret:SecretBackendRootCert
    properties:
      backend: ${pki.path}
      type: internal
      commonName: Root CA
      ttl: '315360000'
      format: pem
      privateKeyFormat: der
      keyType: rsa
      keyBits: 4096
      excludeCnFromSans: true
      ou: My OU
      organization: My organization
    options:
      dependsOn:
        - ${pki}
Copy

Create SecretBackendRootCert Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SecretBackendRootCert(name: string, args: SecretBackendRootCertArgs, opts?: CustomResourceOptions);
@overload
def SecretBackendRootCert(resource_name: str,
                          args: SecretBackendRootCertArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def SecretBackendRootCert(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          type: Optional[str] = None,
                          backend: Optional[str] = None,
                          common_name: Optional[str] = None,
                          managed_key_name: Optional[str] = None,
                          ip_sans: Optional[Sequence[str]] = None,
                          excluded_dns_domains: Optional[Sequence[str]] = None,
                          excluded_email_addresses: Optional[Sequence[str]] = None,
                          max_path_length: Optional[int] = None,
                          excluded_uri_domains: Optional[Sequence[str]] = None,
                          format: Optional[str] = None,
                          namespace: Optional[str] = None,
                          issuer_name: Optional[str] = None,
                          not_after: Optional[str] = None,
                          key_name: Optional[str] = None,
                          key_ref: Optional[str] = None,
                          key_type: Optional[str] = None,
                          locality: Optional[str] = None,
                          managed_key_id: Optional[str] = None,
                          alt_names: Optional[Sequence[str]] = None,
                          excluded_ip_ranges: Optional[Sequence[str]] = None,
                          exclude_cn_from_sans: Optional[bool] = None,
                          key_bits: Optional[int] = None,
                          organization: Optional[str] = None,
                          other_sans: Optional[Sequence[str]] = None,
                          ou: Optional[str] = None,
                          permitted_dns_domains: Optional[Sequence[str]] = None,
                          permitted_email_addresses: Optional[Sequence[str]] = None,
                          permitted_ip_ranges: Optional[Sequence[str]] = None,
                          permitted_uri_domains: Optional[Sequence[str]] = None,
                          postal_code: Optional[str] = None,
                          private_key_format: Optional[str] = None,
                          province: Optional[str] = None,
                          signature_bits: Optional[int] = None,
                          street_address: Optional[str] = None,
                          ttl: Optional[str] = None,
                          country: Optional[str] = None,
                          uri_sans: Optional[Sequence[str]] = None)
func NewSecretBackendRootCert(ctx *Context, name string, args SecretBackendRootCertArgs, opts ...ResourceOption) (*SecretBackendRootCert, error)
public SecretBackendRootCert(string name, SecretBackendRootCertArgs args, CustomResourceOptions? opts = null)
public SecretBackendRootCert(String name, SecretBackendRootCertArgs args)
public SecretBackendRootCert(String name, SecretBackendRootCertArgs args, CustomResourceOptions options)
type: vault:pkiSecret:SecretBackendRootCert
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SecretBackendRootCertArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SecretBackendRootCertArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SecretBackendRootCertArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SecretBackendRootCertArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SecretBackendRootCertArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var secretBackendRootCertResource = new Vault.PkiSecret.SecretBackendRootCert("secretBackendRootCertResource", new()
{
    Type = "string",
    Backend = "string",
    CommonName = "string",
    ManagedKeyName = "string",
    IpSans = new[]
    {
        "string",
    },
    ExcludedDnsDomains = new[]
    {
        "string",
    },
    ExcludedEmailAddresses = new[]
    {
        "string",
    },
    MaxPathLength = 0,
    ExcludedUriDomains = new[]
    {
        "string",
    },
    Format = "string",
    Namespace = "string",
    IssuerName = "string",
    NotAfter = "string",
    KeyName = "string",
    KeyRef = "string",
    KeyType = "string",
    Locality = "string",
    ManagedKeyId = "string",
    AltNames = new[]
    {
        "string",
    },
    ExcludedIpRanges = new[]
    {
        "string",
    },
    ExcludeCnFromSans = false,
    KeyBits = 0,
    Organization = "string",
    OtherSans = new[]
    {
        "string",
    },
    Ou = "string",
    PermittedDnsDomains = new[]
    {
        "string",
    },
    PermittedEmailAddresses = new[]
    {
        "string",
    },
    PermittedIpRanges = new[]
    {
        "string",
    },
    PermittedUriDomains = new[]
    {
        "string",
    },
    PostalCode = "string",
    PrivateKeyFormat = "string",
    Province = "string",
    SignatureBits = 0,
    StreetAddress = "string",
    Ttl = "string",
    Country = "string",
    UriSans = new[]
    {
        "string",
    },
});
Copy
example, err := pkiSecret.NewSecretBackendRootCert(ctx, "secretBackendRootCertResource", &pkiSecret.SecretBackendRootCertArgs{
	Type:           pulumi.String("string"),
	Backend:        pulumi.String("string"),
	CommonName:     pulumi.String("string"),
	ManagedKeyName: pulumi.String("string"),
	IpSans: pulumi.StringArray{
		pulumi.String("string"),
	},
	ExcludedDnsDomains: pulumi.StringArray{
		pulumi.String("string"),
	},
	ExcludedEmailAddresses: pulumi.StringArray{
		pulumi.String("string"),
	},
	MaxPathLength: pulumi.Int(0),
	ExcludedUriDomains: pulumi.StringArray{
		pulumi.String("string"),
	},
	Format:       pulumi.String("string"),
	Namespace:    pulumi.String("string"),
	IssuerName:   pulumi.String("string"),
	NotAfter:     pulumi.String("string"),
	KeyName:      pulumi.String("string"),
	KeyRef:       pulumi.String("string"),
	KeyType:      pulumi.String("string"),
	Locality:     pulumi.String("string"),
	ManagedKeyId: pulumi.String("string"),
	AltNames: pulumi.StringArray{
		pulumi.String("string"),
	},
	ExcludedIpRanges: pulumi.StringArray{
		pulumi.String("string"),
	},
	ExcludeCnFromSans: pulumi.Bool(false),
	KeyBits:           pulumi.Int(0),
	Organization:      pulumi.String("string"),
	OtherSans: pulumi.StringArray{
		pulumi.String("string"),
	},
	Ou: pulumi.String("string"),
	PermittedDnsDomains: pulumi.StringArray{
		pulumi.String("string"),
	},
	PermittedEmailAddresses: pulumi.StringArray{
		pulumi.String("string"),
	},
	PermittedIpRanges: pulumi.StringArray{
		pulumi.String("string"),
	},
	PermittedUriDomains: pulumi.StringArray{
		pulumi.String("string"),
	},
	PostalCode:       pulumi.String("string"),
	PrivateKeyFormat: pulumi.String("string"),
	Province:         pulumi.String("string"),
	SignatureBits:    pulumi.Int(0),
	StreetAddress:    pulumi.String("string"),
	Ttl:              pulumi.String("string"),
	Country:          pulumi.String("string"),
	UriSans: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var secretBackendRootCertResource = new SecretBackendRootCert("secretBackendRootCertResource", SecretBackendRootCertArgs.builder()
    .type("string")
    .backend("string")
    .commonName("string")
    .managedKeyName("string")
    .ipSans("string")
    .excludedDnsDomains("string")
    .excludedEmailAddresses("string")
    .maxPathLength(0)
    .excludedUriDomains("string")
    .format("string")
    .namespace("string")
    .issuerName("string")
    .notAfter("string")
    .keyName("string")
    .keyRef("string")
    .keyType("string")
    .locality("string")
    .managedKeyId("string")
    .altNames("string")
    .excludedIpRanges("string")
    .excludeCnFromSans(false)
    .keyBits(0)
    .organization("string")
    .otherSans("string")
    .ou("string")
    .permittedDnsDomains("string")
    .permittedEmailAddresses("string")
    .permittedIpRanges("string")
    .permittedUriDomains("string")
    .postalCode("string")
    .privateKeyFormat("string")
    .province("string")
    .signatureBits(0)
    .streetAddress("string")
    .ttl("string")
    .country("string")
    .uriSans("string")
    .build());
Copy
secret_backend_root_cert_resource = vault.pki_secret.SecretBackendRootCert("secretBackendRootCertResource",
    type="string",
    backend="string",
    common_name="string",
    managed_key_name="string",
    ip_sans=["string"],
    excluded_dns_domains=["string"],
    excluded_email_addresses=["string"],
    max_path_length=0,
    excluded_uri_domains=["string"],
    format="string",
    namespace="string",
    issuer_name="string",
    not_after="string",
    key_name="string",
    key_ref="string",
    key_type="string",
    locality="string",
    managed_key_id="string",
    alt_names=["string"],
    excluded_ip_ranges=["string"],
    exclude_cn_from_sans=False,
    key_bits=0,
    organization="string",
    other_sans=["string"],
    ou="string",
    permitted_dns_domains=["string"],
    permitted_email_addresses=["string"],
    permitted_ip_ranges=["string"],
    permitted_uri_domains=["string"],
    postal_code="string",
    private_key_format="string",
    province="string",
    signature_bits=0,
    street_address="string",
    ttl="string",
    country="string",
    uri_sans=["string"])
Copy
const secretBackendRootCertResource = new vault.pkisecret.SecretBackendRootCert("secretBackendRootCertResource", {
    type: "string",
    backend: "string",
    commonName: "string",
    managedKeyName: "string",
    ipSans: ["string"],
    excludedDnsDomains: ["string"],
    excludedEmailAddresses: ["string"],
    maxPathLength: 0,
    excludedUriDomains: ["string"],
    format: "string",
    namespace: "string",
    issuerName: "string",
    notAfter: "string",
    keyName: "string",
    keyRef: "string",
    keyType: "string",
    locality: "string",
    managedKeyId: "string",
    altNames: ["string"],
    excludedIpRanges: ["string"],
    excludeCnFromSans: false,
    keyBits: 0,
    organization: "string",
    otherSans: ["string"],
    ou: "string",
    permittedDnsDomains: ["string"],
    permittedEmailAddresses: ["string"],
    permittedIpRanges: ["string"],
    permittedUriDomains: ["string"],
    postalCode: "string",
    privateKeyFormat: "string",
    province: "string",
    signatureBits: 0,
    streetAddress: "string",
    ttl: "string",
    country: "string",
    uriSans: ["string"],
});
Copy
type: vault:pkiSecret:SecretBackendRootCert
properties:
    altNames:
        - string
    backend: string
    commonName: string
    country: string
    excludeCnFromSans: false
    excludedDnsDomains:
        - string
    excludedEmailAddresses:
        - string
    excludedIpRanges:
        - string
    excludedUriDomains:
        - string
    format: string
    ipSans:
        - string
    issuerName: string
    keyBits: 0
    keyName: string
    keyRef: string
    keyType: string
    locality: string
    managedKeyId: string
    managedKeyName: string
    maxPathLength: 0
    namespace: string
    notAfter: string
    organization: string
    otherSans:
        - string
    ou: string
    permittedDnsDomains:
        - string
    permittedEmailAddresses:
        - string
    permittedIpRanges:
        - string
    permittedUriDomains:
        - string
    postalCode: string
    privateKeyFormat: string
    province: string
    signatureBits: 0
    streetAddress: string
    ttl: string
    type: string
    uriSans:
        - string
Copy

SecretBackendRootCert Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SecretBackendRootCert resource accepts the following input properties:

Backend
This property is required.
Changes to this property will trigger replacement.
string
The PKI secret backend the resource belongs to.
CommonName
This property is required.
Changes to this property will trigger replacement.
string
CN of intermediate to create
Type
This property is required.
Changes to this property will trigger replacement.
string
Type of intermediate to create. Must be either "exported", "internal" or "kms"
AltNames Changes to this property will trigger replacement. List<string>
List of alternative names
Country Changes to this property will trigger replacement. string
The country
ExcludeCnFromSans Changes to this property will trigger replacement. bool
Flag to exclude CN from SANs
ExcludedDnsDomains Changes to this property will trigger replacement. List<string>
List of domains for which certificates are not allowed to be issued. Requires Vault version 1.19+.
ExcludedEmailAddresses Changes to this property will trigger replacement. List<string>
List of email addresses for which certificates are not allowed to be issued. Requires Vault version 1.19+.
ExcludedIpRanges Changes to this property will trigger replacement. List<string>
List of IP ranges for which certificates are not allowed to be issued. Requires Vault version 1.19+.
ExcludedUriDomains Changes to this property will trigger replacement. List<string>
List of URI domains for which certificates are not allowed to be issued. Requires Vault version 1.19+.
Format Changes to this property will trigger replacement. string
The format of data
IpSans Changes to this property will trigger replacement. List<string>
List of alternative IPs
IssuerName Changes to this property will trigger replacement. string
Provides a name to the specified issuer. The name must be unique across all issuers and not be the reserved value default
KeyBits Changes to this property will trigger replacement. int
The number of bits to use
KeyName Changes to this property will trigger replacement. string
When a new key is created with this request, optionally specifies the name for this. The global ref default may not be used as a name.
KeyRef Changes to this property will trigger replacement. string
Specifies the key (either default, by name, or by identifier) to use for generating this request. Only suitable for type=existing requests.
KeyType Changes to this property will trigger replacement. string
The desired key type
Locality Changes to this property will trigger replacement. string
The locality
ManagedKeyId Changes to this property will trigger replacement. string
The ID of the previously configured managed key. This field is required if type is kms and it conflicts with managed_key_name
ManagedKeyName Changes to this property will trigger replacement. string
The name of the previously configured managed key. This field is required if type is kms and it conflicts with managed_key_id
MaxPathLength Changes to this property will trigger replacement. int
The maximum path length to encode in the generated certificate
Namespace Changes to this property will trigger replacement. string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
NotAfter string
Set the Not After field of the certificate with specified date value. The value format should be given in UTC format YYYY-MM-ddTHH:MM:SSZ. Supports the Y10K end date for IEEE 802.1AR-2018 standard devices, 9999-12-31T23:59:59Z.
Organization Changes to this property will trigger replacement. string
The organization
OtherSans Changes to this property will trigger replacement. List<string>
List of other SANs
Ou Changes to this property will trigger replacement. string
The organization unit
PermittedDnsDomains Changes to this property will trigger replacement. List<string>
List of domains for which certificates are allowed to be issued
PermittedEmailAddresses Changes to this property will trigger replacement. List<string>
List of email addresses for which certificates are allowed to be issued. Requires Vault version 1.19+.
PermittedIpRanges Changes to this property will trigger replacement. List<string>
List of IP ranges for which certificates are allowed to be issued. Requires Vault version 1.19+.
PermittedUriDomains Changes to this property will trigger replacement. List<string>
List of URI domains for which certificates are allowed to be issued. Requires Vault version 1.19+.
PostalCode Changes to this property will trigger replacement. string
The postal code
PrivateKeyFormat Changes to this property will trigger replacement. string
The private key format
Province Changes to this property will trigger replacement. string
The province
SignatureBits int
The number of bits to use in the signature algorithm
StreetAddress Changes to this property will trigger replacement. string
The street address
Ttl string
Time to live
UriSans Changes to this property will trigger replacement. List<string>
List of alternative URIs
Backend
This property is required.
Changes to this property will trigger replacement.
string
The PKI secret backend the resource belongs to.
CommonName
This property is required.
Changes to this property will trigger replacement.
string
CN of intermediate to create
Type
This property is required.
Changes to this property will trigger replacement.
string
Type of intermediate to create. Must be either "exported", "internal" or "kms"
AltNames Changes to this property will trigger replacement. []string
List of alternative names
Country Changes to this property will trigger replacement. string
The country
ExcludeCnFromSans Changes to this property will trigger replacement. bool
Flag to exclude CN from SANs
ExcludedDnsDomains Changes to this property will trigger replacement. []string
List of domains for which certificates are not allowed to be issued. Requires Vault version 1.19+.
ExcludedEmailAddresses Changes to this property will trigger replacement. []string
List of email addresses for which certificates are not allowed to be issued. Requires Vault version 1.19+.
ExcludedIpRanges Changes to this property will trigger replacement. []string
List of IP ranges for which certificates are not allowed to be issued. Requires Vault version 1.19+.
ExcludedUriDomains Changes to this property will trigger replacement. []string
List of URI domains for which certificates are not allowed to be issued. Requires Vault version 1.19+.
Format Changes to this property will trigger replacement. string
The format of data
IpSans Changes to this property will trigger replacement. []string
List of alternative IPs
IssuerName Changes to this property will trigger replacement. string
Provides a name to the specified issuer. The name must be unique across all issuers and not be the reserved value default
KeyBits Changes to this property will trigger replacement. int
The number of bits to use
KeyName Changes to this property will trigger replacement. string
When a new key is created with this request, optionally specifies the name for this. The global ref default may not be used as a name.
KeyRef Changes to this property will trigger replacement. string
Specifies the key (either default, by name, or by identifier) to use for generating this request. Only suitable for type=existing requests.
KeyType Changes to this property will trigger replacement. string
The desired key type
Locality Changes to this property will trigger replacement. string
The locality
ManagedKeyId Changes to this property will trigger replacement. string
The ID of the previously configured managed key. This field is required if type is kms and it conflicts with managed_key_name
ManagedKeyName Changes to this property will trigger replacement. string
The name of the previously configured managed key. This field is required if type is kms and it conflicts with managed_key_id
MaxPathLength Changes to this property will trigger replacement. int
The maximum path length to encode in the generated certificate
Namespace Changes to this property will trigger replacement. string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
NotAfter string
Set the Not After field of the certificate with specified date value. The value format should be given in UTC format YYYY-MM-ddTHH:MM:SSZ. Supports the Y10K end date for IEEE 802.1AR-2018 standard devices, 9999-12-31T23:59:59Z.
Organization Changes to this property will trigger replacement. string
The organization
OtherSans Changes to this property will trigger replacement. []string
List of other SANs
Ou Changes to this property will trigger replacement. string
The organization unit
PermittedDnsDomains Changes to this property will trigger replacement. []string
List of domains for which certificates are allowed to be issued
PermittedEmailAddresses Changes to this property will trigger replacement. []string
List of email addresses for which certificates are allowed to be issued. Requires Vault version 1.19+.
PermittedIpRanges Changes to this property will trigger replacement. []string
List of IP ranges for which certificates are allowed to be issued. Requires Vault version 1.19+.
PermittedUriDomains Changes to this property will trigger replacement. []string
List of URI domains for which certificates are allowed to be issued. Requires Vault version 1.19+.
PostalCode Changes to this property will trigger replacement. string
The postal code
PrivateKeyFormat Changes to this property will trigger replacement. string
The private key format
Province Changes to this property will trigger replacement. string
The province
SignatureBits int
The number of bits to use in the signature algorithm
StreetAddress Changes to this property will trigger replacement. string
The street address
Ttl string
Time to live
UriSans Changes to this property will trigger replacement. []string
List of alternative URIs
backend
This property is required.
Changes to this property will trigger replacement.
String
The PKI secret backend the resource belongs to.
commonName
This property is required.
Changes to this property will trigger replacement.
String
CN of intermediate to create
type
This property is required.
Changes to this property will trigger replacement.
String
Type of intermediate to create. Must be either "exported", "internal" or "kms"
altNames Changes to this property will trigger replacement. List<String>
List of alternative names
country Changes to this property will trigger replacement. String
The country
excludeCnFromSans Changes to this property will trigger replacement. Boolean
Flag to exclude CN from SANs
excludedDnsDomains Changes to this property will trigger replacement. List<String>
List of domains for which certificates are not allowed to be issued. Requires Vault version 1.19+.
excludedEmailAddresses Changes to this property will trigger replacement. List<String>
List of email addresses for which certificates are not allowed to be issued. Requires Vault version 1.19+.
excludedIpRanges Changes to this property will trigger replacement. List<String>
List of IP ranges for which certificates are not allowed to be issued. Requires Vault version 1.19+.
excludedUriDomains Changes to this property will trigger replacement. List<String>
List of URI domains for which certificates are not allowed to be issued. Requires Vault version 1.19+.
format Changes to this property will trigger replacement. String
The format of data
ipSans Changes to this property will trigger replacement. List<String>
List of alternative IPs
issuerName Changes to this property will trigger replacement. String
Provides a name to the specified issuer. The name must be unique across all issuers and not be the reserved value default
keyBits Changes to this property will trigger replacement. Integer
The number of bits to use
keyName Changes to this property will trigger replacement. String
When a new key is created with this request, optionally specifies the name for this. The global ref default may not be used as a name.
keyRef Changes to this property will trigger replacement. String
Specifies the key (either default, by name, or by identifier) to use for generating this request. Only suitable for type=existing requests.
keyType Changes to this property will trigger replacement. String
The desired key type
locality Changes to this property will trigger replacement. String
The locality
managedKeyId Changes to this property will trigger replacement. String
The ID of the previously configured managed key. This field is required if type is kms and it conflicts with managed_key_name
managedKeyName Changes to this property will trigger replacement. String
The name of the previously configured managed key. This field is required if type is kms and it conflicts with managed_key_id
maxPathLength Changes to this property will trigger replacement. Integer
The maximum path length to encode in the generated certificate
namespace Changes to this property will trigger replacement. String
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
notAfter String
Set the Not After field of the certificate with specified date value. The value format should be given in UTC format YYYY-MM-ddTHH:MM:SSZ. Supports the Y10K end date for IEEE 802.1AR-2018 standard devices, 9999-12-31T23:59:59Z.
organization Changes to this property will trigger replacement. String
The organization
otherSans Changes to this property will trigger replacement. List<String>
List of other SANs
ou Changes to this property will trigger replacement. String
The organization unit
permittedDnsDomains Changes to this property will trigger replacement. List<String>
List of domains for which certificates are allowed to be issued
permittedEmailAddresses Changes to this property will trigger replacement. List<String>
List of email addresses for which certificates are allowed to be issued. Requires Vault version 1.19+.
permittedIpRanges Changes to this property will trigger replacement. List<String>
List of IP ranges for which certificates are allowed to be issued. Requires Vault version 1.19+.
permittedUriDomains Changes to this property will trigger replacement. List<String>
List of URI domains for which certificates are allowed to be issued. Requires Vault version 1.19+.
postalCode Changes to this property will trigger replacement. String
The postal code
privateKeyFormat Changes to this property will trigger replacement. String
The private key format
province Changes to this property will trigger replacement. String
The province
signatureBits Integer
The number of bits to use in the signature algorithm
streetAddress Changes to this property will trigger replacement. String
The street address
ttl String
Time to live
uriSans Changes to this property will trigger replacement. List<String>
List of alternative URIs
backend
This property is required.
Changes to this property will trigger replacement.
string
The PKI secret backend the resource belongs to.
commonName
This property is required.
Changes to this property will trigger replacement.
string
CN of intermediate to create
type
This property is required.
Changes to this property will trigger replacement.
string
Type of intermediate to create. Must be either "exported", "internal" or "kms"
altNames Changes to this property will trigger replacement. string[]
List of alternative names
country Changes to this property will trigger replacement. string
The country
excludeCnFromSans Changes to this property will trigger replacement. boolean
Flag to exclude CN from SANs
excludedDnsDomains Changes to this property will trigger replacement. string[]
List of domains for which certificates are not allowed to be issued. Requires Vault version 1.19+.
excludedEmailAddresses Changes to this property will trigger replacement. string[]
List of email addresses for which certificates are not allowed to be issued. Requires Vault version 1.19+.
excludedIpRanges Changes to this property will trigger replacement. string[]
List of IP ranges for which certificates are not allowed to be issued. Requires Vault version 1.19+.
excludedUriDomains Changes to this property will trigger replacement. string[]
List of URI domains for which certificates are not allowed to be issued. Requires Vault version 1.19+.
format Changes to this property will trigger replacement. string
The format of data
ipSans Changes to this property will trigger replacement. string[]
List of alternative IPs
issuerName Changes to this property will trigger replacement. string
Provides a name to the specified issuer. The name must be unique across all issuers and not be the reserved value default
keyBits Changes to this property will trigger replacement. number
The number of bits to use
keyName Changes to this property will trigger replacement. string
When a new key is created with this request, optionally specifies the name for this. The global ref default may not be used as a name.
keyRef Changes to this property will trigger replacement. string
Specifies the key (either default, by name, or by identifier) to use for generating this request. Only suitable for type=existing requests.
keyType Changes to this property will trigger replacement. string
The desired key type
locality Changes to this property will trigger replacement. string
The locality
managedKeyId Changes to this property will trigger replacement. string
The ID of the previously configured managed key. This field is required if type is kms and it conflicts with managed_key_name
managedKeyName Changes to this property will trigger replacement. string
The name of the previously configured managed key. This field is required if type is kms and it conflicts with managed_key_id
maxPathLength Changes to this property will trigger replacement. number
The maximum path length to encode in the generated certificate
namespace Changes to this property will trigger replacement. string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
notAfter string
Set the Not After field of the certificate with specified date value. The value format should be given in UTC format YYYY-MM-ddTHH:MM:SSZ. Supports the Y10K end date for IEEE 802.1AR-2018 standard devices, 9999-12-31T23:59:59Z.
organization Changes to this property will trigger replacement. string
The organization
otherSans Changes to this property will trigger replacement. string[]
List of other SANs
ou Changes to this property will trigger replacement. string
The organization unit
permittedDnsDomains Changes to this property will trigger replacement. string[]
List of domains for which certificates are allowed to be issued
permittedEmailAddresses Changes to this property will trigger replacement. string[]
List of email addresses for which certificates are allowed to be issued. Requires Vault version 1.19+.
permittedIpRanges Changes to this property will trigger replacement. string[]
List of IP ranges for which certificates are allowed to be issued. Requires Vault version 1.19+.
permittedUriDomains Changes to this property will trigger replacement. string[]
List of URI domains for which certificates are allowed to be issued. Requires Vault version 1.19+.
postalCode Changes to this property will trigger replacement. string
The postal code
privateKeyFormat Changes to this property will trigger replacement. string
The private key format
province Changes to this property will trigger replacement. string
The province
signatureBits number
The number of bits to use in the signature algorithm
streetAddress Changes to this property will trigger replacement. string
The street address
ttl string
Time to live
uriSans Changes to this property will trigger replacement. string[]
List of alternative URIs
backend
This property is required.
Changes to this property will trigger replacement.
str
The PKI secret backend the resource belongs to.
common_name
This property is required.
Changes to this property will trigger replacement.
str
CN of intermediate to create
type
This property is required.
Changes to this property will trigger replacement.
str
Type of intermediate to create. Must be either "exported", "internal" or "kms"
alt_names Changes to this property will trigger replacement. Sequence[str]
List of alternative names
country Changes to this property will trigger replacement. str
The country
exclude_cn_from_sans Changes to this property will trigger replacement. bool
Flag to exclude CN from SANs
excluded_dns_domains Changes to this property will trigger replacement. Sequence[str]
List of domains for which certificates are not allowed to be issued. Requires Vault version 1.19+.
excluded_email_addresses Changes to this property will trigger replacement. Sequence[str]
List of email addresses for which certificates are not allowed to be issued. Requires Vault version 1.19+.
excluded_ip_ranges Changes to this property will trigger replacement. Sequence[str]
List of IP ranges for which certificates are not allowed to be issued. Requires Vault version 1.19+.
excluded_uri_domains Changes to this property will trigger replacement. Sequence[str]
List of URI domains for which certificates are not allowed to be issued. Requires Vault version 1.19+.
format Changes to this property will trigger replacement. str
The format of data
ip_sans Changes to this property will trigger replacement. Sequence[str]
List of alternative IPs
issuer_name Changes to this property will trigger replacement. str
Provides a name to the specified issuer. The name must be unique across all issuers and not be the reserved value default
key_bits Changes to this property will trigger replacement. int
The number of bits to use
key_name Changes to this property will trigger replacement. str
When a new key is created with this request, optionally specifies the name for this. The global ref default may not be used as a name.
key_ref Changes to this property will trigger replacement. str
Specifies the key (either default, by name, or by identifier) to use for generating this request. Only suitable for type=existing requests.
key_type Changes to this property will trigger replacement. str
The desired key type
locality Changes to this property will trigger replacement. str
The locality
managed_key_id Changes to this property will trigger replacement. str
The ID of the previously configured managed key. This field is required if type is kms and it conflicts with managed_key_name
managed_key_name Changes to this property will trigger replacement. str
The name of the previously configured managed key. This field is required if type is kms and it conflicts with managed_key_id
max_path_length Changes to this property will trigger replacement. int
The maximum path length to encode in the generated certificate
namespace Changes to this property will trigger replacement. str
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
not_after str
Set the Not After field of the certificate with specified date value. The value format should be given in UTC format YYYY-MM-ddTHH:MM:SSZ. Supports the Y10K end date for IEEE 802.1AR-2018 standard devices, 9999-12-31T23:59:59Z.
organization Changes to this property will trigger replacement. str
The organization
other_sans Changes to this property will trigger replacement. Sequence[str]
List of other SANs
ou Changes to this property will trigger replacement. str
The organization unit
permitted_dns_domains Changes to this property will trigger replacement. Sequence[str]
List of domains for which certificates are allowed to be issued
permitted_email_addresses Changes to this property will trigger replacement. Sequence[str]
List of email addresses for which certificates are allowed to be issued. Requires Vault version 1.19+.
permitted_ip_ranges Changes to this property will trigger replacement. Sequence[str]
List of IP ranges for which certificates are allowed to be issued. Requires Vault version 1.19+.
permitted_uri_domains Changes to this property will trigger replacement. Sequence[str]
List of URI domains for which certificates are allowed to be issued. Requires Vault version 1.19+.
postal_code Changes to this property will trigger replacement. str
The postal code
private_key_format Changes to this property will trigger replacement. str
The private key format
province Changes to this property will trigger replacement. str
The province
signature_bits int
The number of bits to use in the signature algorithm
street_address Changes to this property will trigger replacement. str
The street address
ttl str
Time to live
uri_sans Changes to this property will trigger replacement. Sequence[str]
List of alternative URIs
backend
This property is required.
Changes to this property will trigger replacement.
String
The PKI secret backend the resource belongs to.
commonName
This property is required.
Changes to this property will trigger replacement.
String
CN of intermediate to create
type
This property is required.
Changes to this property will trigger replacement.
String
Type of intermediate to create. Must be either "exported", "internal" or "kms"
altNames Changes to this property will trigger replacement. List<String>
List of alternative names
country Changes to this property will trigger replacement. String
The country
excludeCnFromSans Changes to this property will trigger replacement. Boolean
Flag to exclude CN from SANs
excludedDnsDomains Changes to this property will trigger replacement. List<String>
List of domains for which certificates are not allowed to be issued. Requires Vault version 1.19+.
excludedEmailAddresses Changes to this property will trigger replacement. List<String>
List of email addresses for which certificates are not allowed to be issued. Requires Vault version 1.19+.
excludedIpRanges Changes to this property will trigger replacement. List<String>
List of IP ranges for which certificates are not allowed to be issued. Requires Vault version 1.19+.
excludedUriDomains Changes to this property will trigger replacement. List<String>
List of URI domains for which certificates are not allowed to be issued. Requires Vault version 1.19+.
format Changes to this property will trigger replacement. String
The format of data
ipSans Changes to this property will trigger replacement. List<String>
List of alternative IPs
issuerName Changes to this property will trigger replacement. String
Provides a name to the specified issuer. The name must be unique across all issuers and not be the reserved value default
keyBits Changes to this property will trigger replacement. Number
The number of bits to use
keyName Changes to this property will trigger replacement. String
When a new key is created with this request, optionally specifies the name for this. The global ref default may not be used as a name.
keyRef Changes to this property will trigger replacement. String
Specifies the key (either default, by name, or by identifier) to use for generating this request. Only suitable for type=existing requests.
keyType Changes to this property will trigger replacement. String
The desired key type
locality Changes to this property will trigger replacement. String
The locality
managedKeyId Changes to this property will trigger replacement. String
The ID of the previously configured managed key. This field is required if type is kms and it conflicts with managed_key_name
managedKeyName Changes to this property will trigger replacement. String
The name of the previously configured managed key. This field is required if type is kms and it conflicts with managed_key_id
maxPathLength Changes to this property will trigger replacement. Number
The maximum path length to encode in the generated certificate
namespace Changes to this property will trigger replacement. String
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
notAfter String
Set the Not After field of the certificate with specified date value. The value format should be given in UTC format YYYY-MM-ddTHH:MM:SSZ. Supports the Y10K end date for IEEE 802.1AR-2018 standard devices, 9999-12-31T23:59:59Z.
organization Changes to this property will trigger replacement. String
The organization
otherSans Changes to this property will trigger replacement. List<String>
List of other SANs
ou Changes to this property will trigger replacement. String
The organization unit
permittedDnsDomains Changes to this property will trigger replacement. List<String>
List of domains for which certificates are allowed to be issued
permittedEmailAddresses Changes to this property will trigger replacement. List<String>
List of email addresses for which certificates are allowed to be issued. Requires Vault version 1.19+.
permittedIpRanges Changes to this property will trigger replacement. List<String>
List of IP ranges for which certificates are allowed to be issued. Requires Vault version 1.19+.
permittedUriDomains Changes to this property will trigger replacement. List<String>
List of URI domains for which certificates are allowed to be issued. Requires Vault version 1.19+.
postalCode Changes to this property will trigger replacement. String
The postal code
privateKeyFormat Changes to this property will trigger replacement. String
The private key format
province Changes to this property will trigger replacement. String
The province
signatureBits Number
The number of bits to use in the signature algorithm
streetAddress Changes to this property will trigger replacement. String
The street address
ttl String
Time to live
uriSans Changes to this property will trigger replacement. List<String>
List of alternative URIs

Outputs

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

Certificate string
The certificate.
Id string
The provider-assigned unique ID for this managed resource.
IssuerId string
The ID of the generated issuer.
IssuingCa string
The issuing CA certificate.
KeyId string
The ID of the generated key.
SerialNumber string
The certificate's serial number, hex formatted.
Certificate string
The certificate.
Id string
The provider-assigned unique ID for this managed resource.
IssuerId string
The ID of the generated issuer.
IssuingCa string
The issuing CA certificate.
KeyId string
The ID of the generated key.
SerialNumber string
The certificate's serial number, hex formatted.
certificate String
The certificate.
id String
The provider-assigned unique ID for this managed resource.
issuerId String
The ID of the generated issuer.
issuingCa String
The issuing CA certificate.
keyId String
The ID of the generated key.
serialNumber String
The certificate's serial number, hex formatted.
certificate string
The certificate.
id string
The provider-assigned unique ID for this managed resource.
issuerId string
The ID of the generated issuer.
issuingCa string
The issuing CA certificate.
keyId string
The ID of the generated key.
serialNumber string
The certificate's serial number, hex formatted.
certificate str
The certificate.
id str
The provider-assigned unique ID for this managed resource.
issuer_id str
The ID of the generated issuer.
issuing_ca str
The issuing CA certificate.
key_id str
The ID of the generated key.
serial_number str
The certificate's serial number, hex formatted.
certificate String
The certificate.
id String
The provider-assigned unique ID for this managed resource.
issuerId String
The ID of the generated issuer.
issuingCa String
The issuing CA certificate.
keyId String
The ID of the generated key.
serialNumber String
The certificate's serial number, hex formatted.

Look up Existing SecretBackendRootCert Resource

Get an existing SecretBackendRootCert 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?: SecretBackendRootCertState, opts?: CustomResourceOptions): SecretBackendRootCert
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alt_names: Optional[Sequence[str]] = None,
        backend: Optional[str] = None,
        certificate: Optional[str] = None,
        common_name: Optional[str] = None,
        country: Optional[str] = None,
        exclude_cn_from_sans: Optional[bool] = None,
        excluded_dns_domains: Optional[Sequence[str]] = None,
        excluded_email_addresses: Optional[Sequence[str]] = None,
        excluded_ip_ranges: Optional[Sequence[str]] = None,
        excluded_uri_domains: Optional[Sequence[str]] = None,
        format: Optional[str] = None,
        ip_sans: Optional[Sequence[str]] = None,
        issuer_id: Optional[str] = None,
        issuer_name: Optional[str] = None,
        issuing_ca: Optional[str] = None,
        key_bits: Optional[int] = None,
        key_id: Optional[str] = None,
        key_name: Optional[str] = None,
        key_ref: Optional[str] = None,
        key_type: Optional[str] = None,
        locality: Optional[str] = None,
        managed_key_id: Optional[str] = None,
        managed_key_name: Optional[str] = None,
        max_path_length: Optional[int] = None,
        namespace: Optional[str] = None,
        not_after: Optional[str] = None,
        organization: Optional[str] = None,
        other_sans: Optional[Sequence[str]] = None,
        ou: Optional[str] = None,
        permitted_dns_domains: Optional[Sequence[str]] = None,
        permitted_email_addresses: Optional[Sequence[str]] = None,
        permitted_ip_ranges: Optional[Sequence[str]] = None,
        permitted_uri_domains: Optional[Sequence[str]] = None,
        postal_code: Optional[str] = None,
        private_key_format: Optional[str] = None,
        province: Optional[str] = None,
        serial_number: Optional[str] = None,
        signature_bits: Optional[int] = None,
        street_address: Optional[str] = None,
        ttl: Optional[str] = None,
        type: Optional[str] = None,
        uri_sans: Optional[Sequence[str]] = None) -> SecretBackendRootCert
func GetSecretBackendRootCert(ctx *Context, name string, id IDInput, state *SecretBackendRootCertState, opts ...ResourceOption) (*SecretBackendRootCert, error)
public static SecretBackendRootCert Get(string name, Input<string> id, SecretBackendRootCertState? state, CustomResourceOptions? opts = null)
public static SecretBackendRootCert get(String name, Output<String> id, SecretBackendRootCertState state, CustomResourceOptions options)
resources:  _:    type: vault:pkiSecret:SecretBackendRootCert    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AltNames Changes to this property will trigger replacement. List<string>
List of alternative names
Backend Changes to this property will trigger replacement. string
The PKI secret backend the resource belongs to.
Certificate string
The certificate.
CommonName Changes to this property will trigger replacement. string
CN of intermediate to create
Country Changes to this property will trigger replacement. string
The country
ExcludeCnFromSans Changes to this property will trigger replacement. bool
Flag to exclude CN from SANs
ExcludedDnsDomains Changes to this property will trigger replacement. List<string>
List of domains for which certificates are not allowed to be issued. Requires Vault version 1.19+.
ExcludedEmailAddresses Changes to this property will trigger replacement. List<string>
List of email addresses for which certificates are not allowed to be issued. Requires Vault version 1.19+.
ExcludedIpRanges Changes to this property will trigger replacement. List<string>
List of IP ranges for which certificates are not allowed to be issued. Requires Vault version 1.19+.
ExcludedUriDomains Changes to this property will trigger replacement. List<string>
List of URI domains for which certificates are not allowed to be issued. Requires Vault version 1.19+.
Format Changes to this property will trigger replacement. string
The format of data
IpSans Changes to this property will trigger replacement. List<string>
List of alternative IPs
IssuerId Changes to this property will trigger replacement. string
The ID of the generated issuer.
IssuerName Changes to this property will trigger replacement. string
Provides a name to the specified issuer. The name must be unique across all issuers and not be the reserved value default
IssuingCa string
The issuing CA certificate.
KeyBits Changes to this property will trigger replacement. int
The number of bits to use
KeyId Changes to this property will trigger replacement. string
The ID of the generated key.
KeyName Changes to this property will trigger replacement. string
When a new key is created with this request, optionally specifies the name for this. The global ref default may not be used as a name.
KeyRef Changes to this property will trigger replacement. string
Specifies the key (either default, by name, or by identifier) to use for generating this request. Only suitable for type=existing requests.
KeyType Changes to this property will trigger replacement. string
The desired key type
Locality Changes to this property will trigger replacement. string
The locality
ManagedKeyId Changes to this property will trigger replacement. string
The ID of the previously configured managed key. This field is required if type is kms and it conflicts with managed_key_name
ManagedKeyName Changes to this property will trigger replacement. string
The name of the previously configured managed key. This field is required if type is kms and it conflicts with managed_key_id
MaxPathLength Changes to this property will trigger replacement. int
The maximum path length to encode in the generated certificate
Namespace Changes to this property will trigger replacement. string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
NotAfter string
Set the Not After field of the certificate with specified date value. The value format should be given in UTC format YYYY-MM-ddTHH:MM:SSZ. Supports the Y10K end date for IEEE 802.1AR-2018 standard devices, 9999-12-31T23:59:59Z.
Organization Changes to this property will trigger replacement. string
The organization
OtherSans Changes to this property will trigger replacement. List<string>
List of other SANs
Ou Changes to this property will trigger replacement. string
The organization unit
PermittedDnsDomains Changes to this property will trigger replacement. List<string>
List of domains for which certificates are allowed to be issued
PermittedEmailAddresses Changes to this property will trigger replacement. List<string>
List of email addresses for which certificates are allowed to be issued. Requires Vault version 1.19+.
PermittedIpRanges Changes to this property will trigger replacement. List<string>
List of IP ranges for which certificates are allowed to be issued. Requires Vault version 1.19+.
PermittedUriDomains Changes to this property will trigger replacement. List<string>
List of URI domains for which certificates are allowed to be issued. Requires Vault version 1.19+.
PostalCode Changes to this property will trigger replacement. string
The postal code
PrivateKeyFormat Changes to this property will trigger replacement. string
The private key format
Province Changes to this property will trigger replacement. string
The province
SerialNumber string
The certificate's serial number, hex formatted.
SignatureBits int
The number of bits to use in the signature algorithm
StreetAddress Changes to this property will trigger replacement. string
The street address
Ttl string
Time to live
Type Changes to this property will trigger replacement. string
Type of intermediate to create. Must be either "exported", "internal" or "kms"
UriSans Changes to this property will trigger replacement. List<string>
List of alternative URIs
AltNames Changes to this property will trigger replacement. []string
List of alternative names
Backend Changes to this property will trigger replacement. string
The PKI secret backend the resource belongs to.
Certificate string
The certificate.
CommonName Changes to this property will trigger replacement. string
CN of intermediate to create
Country Changes to this property will trigger replacement. string
The country
ExcludeCnFromSans Changes to this property will trigger replacement. bool
Flag to exclude CN from SANs
ExcludedDnsDomains Changes to this property will trigger replacement. []string
List of domains for which certificates are not allowed to be issued. Requires Vault version 1.19+.
ExcludedEmailAddresses Changes to this property will trigger replacement. []string
List of email addresses for which certificates are not allowed to be issued. Requires Vault version 1.19+.
ExcludedIpRanges Changes to this property will trigger replacement. []string
List of IP ranges for which certificates are not allowed to be issued. Requires Vault version 1.19+.
ExcludedUriDomains Changes to this property will trigger replacement. []string
List of URI domains for which certificates are not allowed to be issued. Requires Vault version 1.19+.
Format Changes to this property will trigger replacement. string
The format of data
IpSans Changes to this property will trigger replacement. []string
List of alternative IPs
IssuerId Changes to this property will trigger replacement. string
The ID of the generated issuer.
IssuerName Changes to this property will trigger replacement. string
Provides a name to the specified issuer. The name must be unique across all issuers and not be the reserved value default
IssuingCa string
The issuing CA certificate.
KeyBits Changes to this property will trigger replacement. int
The number of bits to use
KeyId Changes to this property will trigger replacement. string
The ID of the generated key.
KeyName Changes to this property will trigger replacement. string
When a new key is created with this request, optionally specifies the name for this. The global ref default may not be used as a name.
KeyRef Changes to this property will trigger replacement. string
Specifies the key (either default, by name, or by identifier) to use for generating this request. Only suitable for type=existing requests.
KeyType Changes to this property will trigger replacement. string
The desired key type
Locality Changes to this property will trigger replacement. string
The locality
ManagedKeyId Changes to this property will trigger replacement. string
The ID of the previously configured managed key. This field is required if type is kms and it conflicts with managed_key_name
ManagedKeyName Changes to this property will trigger replacement. string
The name of the previously configured managed key. This field is required if type is kms and it conflicts with managed_key_id
MaxPathLength Changes to this property will trigger replacement. int
The maximum path length to encode in the generated certificate
Namespace Changes to this property will trigger replacement. string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
NotAfter string
Set the Not After field of the certificate with specified date value. The value format should be given in UTC format YYYY-MM-ddTHH:MM:SSZ. Supports the Y10K end date for IEEE 802.1AR-2018 standard devices, 9999-12-31T23:59:59Z.
Organization Changes to this property will trigger replacement. string
The organization
OtherSans Changes to this property will trigger replacement. []string
List of other SANs
Ou Changes to this property will trigger replacement. string
The organization unit
PermittedDnsDomains Changes to this property will trigger replacement. []string
List of domains for which certificates are allowed to be issued
PermittedEmailAddresses Changes to this property will trigger replacement. []string
List of email addresses for which certificates are allowed to be issued. Requires Vault version 1.19+.
PermittedIpRanges Changes to this property will trigger replacement. []string
List of IP ranges for which certificates are allowed to be issued. Requires Vault version 1.19+.
PermittedUriDomains Changes to this property will trigger replacement. []string
List of URI domains for which certificates are allowed to be issued. Requires Vault version 1.19+.
PostalCode Changes to this property will trigger replacement. string
The postal code
PrivateKeyFormat Changes to this property will trigger replacement. string
The private key format
Province Changes to this property will trigger replacement. string
The province
SerialNumber string
The certificate's serial number, hex formatted.
SignatureBits int
The number of bits to use in the signature algorithm
StreetAddress Changes to this property will trigger replacement. string
The street address
Ttl string
Time to live
Type Changes to this property will trigger replacement. string
Type of intermediate to create. Must be either "exported", "internal" or "kms"
UriSans Changes to this property will trigger replacement. []string
List of alternative URIs
altNames Changes to this property will trigger replacement. List<String>
List of alternative names
backend Changes to this property will trigger replacement. String
The PKI secret backend the resource belongs to.
certificate String
The certificate.
commonName Changes to this property will trigger replacement. String
CN of intermediate to create
country Changes to this property will trigger replacement. String
The country
excludeCnFromSans Changes to this property will trigger replacement. Boolean
Flag to exclude CN from SANs
excludedDnsDomains Changes to this property will trigger replacement. List<String>
List of domains for which certificates are not allowed to be issued. Requires Vault version 1.19+.
excludedEmailAddresses Changes to this property will trigger replacement. List<String>
List of email addresses for which certificates are not allowed to be issued. Requires Vault version 1.19+.
excludedIpRanges Changes to this property will trigger replacement. List<String>
List of IP ranges for which certificates are not allowed to be issued. Requires Vault version 1.19+.
excludedUriDomains Changes to this property will trigger replacement. List<String>
List of URI domains for which certificates are not allowed to be issued. Requires Vault version 1.19+.
format Changes to this property will trigger replacement. String
The format of data
ipSans Changes to this property will trigger replacement. List<String>
List of alternative IPs
issuerId Changes to this property will trigger replacement. String
The ID of the generated issuer.
issuerName Changes to this property will trigger replacement. String
Provides a name to the specified issuer. The name must be unique across all issuers and not be the reserved value default
issuingCa String
The issuing CA certificate.
keyBits Changes to this property will trigger replacement. Integer
The number of bits to use
keyId Changes to this property will trigger replacement. String
The ID of the generated key.
keyName Changes to this property will trigger replacement. String
When a new key is created with this request, optionally specifies the name for this. The global ref default may not be used as a name.
keyRef Changes to this property will trigger replacement. String
Specifies the key (either default, by name, or by identifier) to use for generating this request. Only suitable for type=existing requests.
keyType Changes to this property will trigger replacement. String
The desired key type
locality Changes to this property will trigger replacement. String
The locality
managedKeyId Changes to this property will trigger replacement. String
The ID of the previously configured managed key. This field is required if type is kms and it conflicts with managed_key_name
managedKeyName Changes to this property will trigger replacement. String
The name of the previously configured managed key. This field is required if type is kms and it conflicts with managed_key_id
maxPathLength Changes to this property will trigger replacement. Integer
The maximum path length to encode in the generated certificate
namespace Changes to this property will trigger replacement. String
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
notAfter String
Set the Not After field of the certificate with specified date value. The value format should be given in UTC format YYYY-MM-ddTHH:MM:SSZ. Supports the Y10K end date for IEEE 802.1AR-2018 standard devices, 9999-12-31T23:59:59Z.
organization Changes to this property will trigger replacement. String
The organization
otherSans Changes to this property will trigger replacement. List<String>
List of other SANs
ou Changes to this property will trigger replacement. String
The organization unit
permittedDnsDomains Changes to this property will trigger replacement. List<String>
List of domains for which certificates are allowed to be issued
permittedEmailAddresses Changes to this property will trigger replacement. List<String>
List of email addresses for which certificates are allowed to be issued. Requires Vault version 1.19+.
permittedIpRanges Changes to this property will trigger replacement. List<String>
List of IP ranges for which certificates are allowed to be issued. Requires Vault version 1.19+.
permittedUriDomains Changes to this property will trigger replacement. List<String>
List of URI domains for which certificates are allowed to be issued. Requires Vault version 1.19+.
postalCode Changes to this property will trigger replacement. String
The postal code
privateKeyFormat Changes to this property will trigger replacement. String
The private key format
province Changes to this property will trigger replacement. String
The province
serialNumber String
The certificate's serial number, hex formatted.
signatureBits Integer
The number of bits to use in the signature algorithm
streetAddress Changes to this property will trigger replacement. String
The street address
ttl String
Time to live
type Changes to this property will trigger replacement. String
Type of intermediate to create. Must be either "exported", "internal" or "kms"
uriSans Changes to this property will trigger replacement. List<String>
List of alternative URIs
altNames Changes to this property will trigger replacement. string[]
List of alternative names
backend Changes to this property will trigger replacement. string
The PKI secret backend the resource belongs to.
certificate string
The certificate.
commonName Changes to this property will trigger replacement. string
CN of intermediate to create
country Changes to this property will trigger replacement. string
The country
excludeCnFromSans Changes to this property will trigger replacement. boolean
Flag to exclude CN from SANs
excludedDnsDomains Changes to this property will trigger replacement. string[]
List of domains for which certificates are not allowed to be issued. Requires Vault version 1.19+.
excludedEmailAddresses Changes to this property will trigger replacement. string[]
List of email addresses for which certificates are not allowed to be issued. Requires Vault version 1.19+.
excludedIpRanges Changes to this property will trigger replacement. string[]
List of IP ranges for which certificates are not allowed to be issued. Requires Vault version 1.19+.
excludedUriDomains Changes to this property will trigger replacement. string[]
List of URI domains for which certificates are not allowed to be issued. Requires Vault version 1.19+.
format Changes to this property will trigger replacement. string
The format of data
ipSans Changes to this property will trigger replacement. string[]
List of alternative IPs
issuerId Changes to this property will trigger replacement. string
The ID of the generated issuer.
issuerName Changes to this property will trigger replacement. string
Provides a name to the specified issuer. The name must be unique across all issuers and not be the reserved value default
issuingCa string
The issuing CA certificate.
keyBits Changes to this property will trigger replacement. number
The number of bits to use
keyId Changes to this property will trigger replacement. string
The ID of the generated key.
keyName Changes to this property will trigger replacement. string
When a new key is created with this request, optionally specifies the name for this. The global ref default may not be used as a name.
keyRef Changes to this property will trigger replacement. string
Specifies the key (either default, by name, or by identifier) to use for generating this request. Only suitable for type=existing requests.
keyType Changes to this property will trigger replacement. string
The desired key type
locality Changes to this property will trigger replacement. string
The locality
managedKeyId Changes to this property will trigger replacement. string
The ID of the previously configured managed key. This field is required if type is kms and it conflicts with managed_key_name
managedKeyName Changes to this property will trigger replacement. string
The name of the previously configured managed key. This field is required if type is kms and it conflicts with managed_key_id
maxPathLength Changes to this property will trigger replacement. number
The maximum path length to encode in the generated certificate
namespace Changes to this property will trigger replacement. string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
notAfter string
Set the Not After field of the certificate with specified date value. The value format should be given in UTC format YYYY-MM-ddTHH:MM:SSZ. Supports the Y10K end date for IEEE 802.1AR-2018 standard devices, 9999-12-31T23:59:59Z.
organization Changes to this property will trigger replacement. string
The organization
otherSans Changes to this property will trigger replacement. string[]
List of other SANs
ou Changes to this property will trigger replacement. string
The organization unit
permittedDnsDomains Changes to this property will trigger replacement. string[]
List of domains for which certificates are allowed to be issued
permittedEmailAddresses Changes to this property will trigger replacement. string[]
List of email addresses for which certificates are allowed to be issued. Requires Vault version 1.19+.
permittedIpRanges Changes to this property will trigger replacement. string[]
List of IP ranges for which certificates are allowed to be issued. Requires Vault version 1.19+.
permittedUriDomains Changes to this property will trigger replacement. string[]
List of URI domains for which certificates are allowed to be issued. Requires Vault version 1.19+.
postalCode Changes to this property will trigger replacement. string
The postal code
privateKeyFormat Changes to this property will trigger replacement. string
The private key format
province Changes to this property will trigger replacement. string
The province
serialNumber string
The certificate's serial number, hex formatted.
signatureBits number
The number of bits to use in the signature algorithm
streetAddress Changes to this property will trigger replacement. string
The street address
ttl string
Time to live
type Changes to this property will trigger replacement. string
Type of intermediate to create. Must be either "exported", "internal" or "kms"
uriSans Changes to this property will trigger replacement. string[]
List of alternative URIs
alt_names Changes to this property will trigger replacement. Sequence[str]
List of alternative names
backend Changes to this property will trigger replacement. str
The PKI secret backend the resource belongs to.
certificate str
The certificate.
common_name Changes to this property will trigger replacement. str
CN of intermediate to create
country Changes to this property will trigger replacement. str
The country
exclude_cn_from_sans Changes to this property will trigger replacement. bool
Flag to exclude CN from SANs
excluded_dns_domains Changes to this property will trigger replacement. Sequence[str]
List of domains for which certificates are not allowed to be issued. Requires Vault version 1.19+.
excluded_email_addresses Changes to this property will trigger replacement. Sequence[str]
List of email addresses for which certificates are not allowed to be issued. Requires Vault version 1.19+.
excluded_ip_ranges Changes to this property will trigger replacement. Sequence[str]
List of IP ranges for which certificates are not allowed to be issued. Requires Vault version 1.19+.
excluded_uri_domains Changes to this property will trigger replacement. Sequence[str]
List of URI domains for which certificates are not allowed to be issued. Requires Vault version 1.19+.
format Changes to this property will trigger replacement. str
The format of data
ip_sans Changes to this property will trigger replacement. Sequence[str]
List of alternative IPs
issuer_id Changes to this property will trigger replacement. str
The ID of the generated issuer.
issuer_name Changes to this property will trigger replacement. str
Provides a name to the specified issuer. The name must be unique across all issuers and not be the reserved value default
issuing_ca str
The issuing CA certificate.
key_bits Changes to this property will trigger replacement. int
The number of bits to use
key_id Changes to this property will trigger replacement. str
The ID of the generated key.
key_name Changes to this property will trigger replacement. str
When a new key is created with this request, optionally specifies the name for this. The global ref default may not be used as a name.
key_ref Changes to this property will trigger replacement. str
Specifies the key (either default, by name, or by identifier) to use for generating this request. Only suitable for type=existing requests.
key_type Changes to this property will trigger replacement. str
The desired key type
locality Changes to this property will trigger replacement. str
The locality
managed_key_id Changes to this property will trigger replacement. str
The ID of the previously configured managed key. This field is required if type is kms and it conflicts with managed_key_name
managed_key_name Changes to this property will trigger replacement. str
The name of the previously configured managed key. This field is required if type is kms and it conflicts with managed_key_id
max_path_length Changes to this property will trigger replacement. int
The maximum path length to encode in the generated certificate
namespace Changes to this property will trigger replacement. str
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
not_after str
Set the Not After field of the certificate with specified date value. The value format should be given in UTC format YYYY-MM-ddTHH:MM:SSZ. Supports the Y10K end date for IEEE 802.1AR-2018 standard devices, 9999-12-31T23:59:59Z.
organization Changes to this property will trigger replacement. str
The organization
other_sans Changes to this property will trigger replacement. Sequence[str]
List of other SANs
ou Changes to this property will trigger replacement. str
The organization unit
permitted_dns_domains Changes to this property will trigger replacement. Sequence[str]
List of domains for which certificates are allowed to be issued
permitted_email_addresses Changes to this property will trigger replacement. Sequence[str]
List of email addresses for which certificates are allowed to be issued. Requires Vault version 1.19+.
permitted_ip_ranges Changes to this property will trigger replacement. Sequence[str]
List of IP ranges for which certificates are allowed to be issued. Requires Vault version 1.19+.
permitted_uri_domains Changes to this property will trigger replacement. Sequence[str]
List of URI domains for which certificates are allowed to be issued. Requires Vault version 1.19+.
postal_code Changes to this property will trigger replacement. str
The postal code
private_key_format Changes to this property will trigger replacement. str
The private key format
province Changes to this property will trigger replacement. str
The province
serial_number str
The certificate's serial number, hex formatted.
signature_bits int
The number of bits to use in the signature algorithm
street_address Changes to this property will trigger replacement. str
The street address
ttl str
Time to live
type Changes to this property will trigger replacement. str
Type of intermediate to create. Must be either "exported", "internal" or "kms"
uri_sans Changes to this property will trigger replacement. Sequence[str]
List of alternative URIs
altNames Changes to this property will trigger replacement. List<String>
List of alternative names
backend Changes to this property will trigger replacement. String
The PKI secret backend the resource belongs to.
certificate String
The certificate.
commonName Changes to this property will trigger replacement. String
CN of intermediate to create
country Changes to this property will trigger replacement. String
The country
excludeCnFromSans Changes to this property will trigger replacement. Boolean
Flag to exclude CN from SANs
excludedDnsDomains Changes to this property will trigger replacement. List<String>
List of domains for which certificates are not allowed to be issued. Requires Vault version 1.19+.
excludedEmailAddresses Changes to this property will trigger replacement. List<String>
List of email addresses for which certificates are not allowed to be issued. Requires Vault version 1.19+.
excludedIpRanges Changes to this property will trigger replacement. List<String>
List of IP ranges for which certificates are not allowed to be issued. Requires Vault version 1.19+.
excludedUriDomains Changes to this property will trigger replacement. List<String>
List of URI domains for which certificates are not allowed to be issued. Requires Vault version 1.19+.
format Changes to this property will trigger replacement. String
The format of data
ipSans Changes to this property will trigger replacement. List<String>
List of alternative IPs
issuerId Changes to this property will trigger replacement. String
The ID of the generated issuer.
issuerName Changes to this property will trigger replacement. String
Provides a name to the specified issuer. The name must be unique across all issuers and not be the reserved value default
issuingCa String
The issuing CA certificate.
keyBits Changes to this property will trigger replacement. Number
The number of bits to use
keyId Changes to this property will trigger replacement. String
The ID of the generated key.
keyName Changes to this property will trigger replacement. String
When a new key is created with this request, optionally specifies the name for this. The global ref default may not be used as a name.
keyRef Changes to this property will trigger replacement. String
Specifies the key (either default, by name, or by identifier) to use for generating this request. Only suitable for type=existing requests.
keyType Changes to this property will trigger replacement. String
The desired key type
locality Changes to this property will trigger replacement. String
The locality
managedKeyId Changes to this property will trigger replacement. String
The ID of the previously configured managed key. This field is required if type is kms and it conflicts with managed_key_name
managedKeyName Changes to this property will trigger replacement. String
The name of the previously configured managed key. This field is required if type is kms and it conflicts with managed_key_id
maxPathLength Changes to this property will trigger replacement. Number
The maximum path length to encode in the generated certificate
namespace Changes to this property will trigger replacement. String
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
notAfter String
Set the Not After field of the certificate with specified date value. The value format should be given in UTC format YYYY-MM-ddTHH:MM:SSZ. Supports the Y10K end date for IEEE 802.1AR-2018 standard devices, 9999-12-31T23:59:59Z.
organization Changes to this property will trigger replacement. String
The organization
otherSans Changes to this property will trigger replacement. List<String>
List of other SANs
ou Changes to this property will trigger replacement. String
The organization unit
permittedDnsDomains Changes to this property will trigger replacement. List<String>
List of domains for which certificates are allowed to be issued
permittedEmailAddresses Changes to this property will trigger replacement. List<String>
List of email addresses for which certificates are allowed to be issued. Requires Vault version 1.19+.
permittedIpRanges Changes to this property will trigger replacement. List<String>
List of IP ranges for which certificates are allowed to be issued. Requires Vault version 1.19+.
permittedUriDomains Changes to this property will trigger replacement. List<String>
List of URI domains for which certificates are allowed to be issued. Requires Vault version 1.19+.
postalCode Changes to this property will trigger replacement. String
The postal code
privateKeyFormat Changes to this property will trigger replacement. String
The private key format
province Changes to this property will trigger replacement. String
The province
serialNumber String
The certificate's serial number, hex formatted.
signatureBits Number
The number of bits to use in the signature algorithm
streetAddress Changes to this property will trigger replacement. String
The street address
ttl String
Time to live
type Changes to this property will trigger replacement. String
Type of intermediate to create. Must be either "exported", "internal" or "kms"
uriSans Changes to this property will trigger replacement. List<String>
List of alternative URIs

Package Details

Repository
Vault pulumi/pulumi-vault
License
Apache-2.0
Notes
This Pulumi package is based on the vault Terraform Provider.