venafi.Certificate
Explore with Pulumi AI
Create Certificate Resource
new Certificate(name: string, args: CertificateArgs, opts?: CustomResourceOptions);
@overload
def Certificate(resource_name: str,
opts: Optional[ResourceOptions] = None,
algorithm: Optional[str] = None,
certificate_dn: Optional[str] = None,
common_name: Optional[str] = None,
csr_origin: Optional[str] = None,
csr_pem: Optional[str] = None,
custom_fields: Optional[Mapping[str, str]] = None,
ecdsa_curve: Optional[str] = None,
expiration_window: Optional[int] = None,
issuer_hint: Optional[str] = None,
key_password: Optional[str] = None,
nickname: Optional[str] = None,
pkcs12: Optional[str] = None,
private_key_pem: Optional[str] = None,
rsa_bits: Optional[int] = None,
san_dns: Optional[Sequence[str]] = None,
san_emails: Optional[Sequence[str]] = None,
san_ips: Optional[Sequence[str]] = None,
san_uris: Optional[Sequence[str]] = None,
valid_days: Optional[int] = None)
@overload
def Certificate(resource_name: str,
args: CertificateArgs,
opts: Optional[ResourceOptions] = None)
func NewCertificate(ctx *Context, name string, args CertificateArgs, opts ...ResourceOption) (*Certificate, error)
public Certificate(string name, CertificateArgs args, CustomResourceOptions? opts = null)
public Certificate(String name, CertificateArgs args)
public Certificate(String name, CertificateArgs args, CustomResourceOptions options)
type: venafi:Certificate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CertificateArgs
- 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 CertificateArgs
- 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 CertificateArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CertificateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CertificateArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Certificate 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 Certificate resource accepts the following input properties:
- Common
Name string The common name of the certificate.
- Algorithm string
Key encryption algorithm, either
RSA
orECDSA
. Defaults toRSA
.- Certificate
Dn string - Csr
Origin string Whether key-pair generation will be
local
orservice
generated. Default islocal
.- Csr
Pem string - Custom
Fields Dictionary<string, string> Collection of Custom Field name-value pairs to assign to the certificate.
- Ecdsa
Curve string ECDSA curve to use when generating a key
- Expiration
Window int Number of hours before certificate expiry to request a new certificate. Defaults to
168
.- Issuer
Hint string Used with valid_days to indicate the target issuer when using Trust Protection Platform. Relevant values are: "DigiCert", "Entrust", and "Microsoft".
- Key
Password string The password used to encrypt the private key.
- Nickname string
Use to specify a name for the new certificate object that will be created and placed in a policy. Only valid for TPP.
- Pkcs12 string
- Private
Key stringPem The private key in PEM format.
- Rsa
Bits int Number of bits to use when generating an RSA key. Applies when
algorithm=RSA
. Defaults to2048
.- San
Dns List<string> List of DNS names to use as alternative subjects of the certificate.
- San
Emails List<string> List of email addresses to use as alternative subjects of the certificate.
- San
Ips List<string> List of IP addresses to use as alternative subjects of the certificate.
- San
Uris List<string> List of Uniform Resource Identifiers (URIs) to use as alternative subjects of the certificate.
- Valid
Days int Desired number of days for which the new certificate will be valid.
- Common
Name string The common name of the certificate.
- Algorithm string
Key encryption algorithm, either
RSA
orECDSA
. Defaults toRSA
.- Certificate
Dn string - Csr
Origin string Whether key-pair generation will be
local
orservice
generated. Default islocal
.- Csr
Pem string - Custom
Fields map[string]string Collection of Custom Field name-value pairs to assign to the certificate.
- Ecdsa
Curve string ECDSA curve to use when generating a key
- Expiration
Window int Number of hours before certificate expiry to request a new certificate. Defaults to
168
.- Issuer
Hint string Used with valid_days to indicate the target issuer when using Trust Protection Platform. Relevant values are: "DigiCert", "Entrust", and "Microsoft".
- Key
Password string The password used to encrypt the private key.
- Nickname string
Use to specify a name for the new certificate object that will be created and placed in a policy. Only valid for TPP.
- Pkcs12 string
- Private
Key stringPem The private key in PEM format.
- Rsa
Bits int Number of bits to use when generating an RSA key. Applies when
algorithm=RSA
. Defaults to2048
.- San
Dns []string List of DNS names to use as alternative subjects of the certificate.
- San
Emails []string List of email addresses to use as alternative subjects of the certificate.
- San
Ips []string List of IP addresses to use as alternative subjects of the certificate.
- San
Uris []string List of Uniform Resource Identifiers (URIs) to use as alternative subjects of the certificate.
- Valid
Days int Desired number of days for which the new certificate will be valid.
- common
Name String The common name of the certificate.
- algorithm String
Key encryption algorithm, either
RSA
orECDSA
. Defaults toRSA
.- certificate
Dn String - csr
Origin String Whether key-pair generation will be
local
orservice
generated. Default islocal
.- csr
Pem String - custom
Fields Map<String,String> Collection of Custom Field name-value pairs to assign to the certificate.
- ecdsa
Curve String ECDSA curve to use when generating a key
- expiration
Window Integer Number of hours before certificate expiry to request a new certificate. Defaults to
168
.- issuer
Hint String Used with valid_days to indicate the target issuer when using Trust Protection Platform. Relevant values are: "DigiCert", "Entrust", and "Microsoft".
- key
Password String The password used to encrypt the private key.
- nickname String
Use to specify a name for the new certificate object that will be created and placed in a policy. Only valid for TPP.
- pkcs12 String
- private
Key StringPem The private key in PEM format.
- rsa
Bits Integer Number of bits to use when generating an RSA key. Applies when
algorithm=RSA
. Defaults to2048
.- san
Dns List<String> List of DNS names to use as alternative subjects of the certificate.
- san
Emails List<String> List of email addresses to use as alternative subjects of the certificate.
- san
Ips List<String> List of IP addresses to use as alternative subjects of the certificate.
- san
Uris List<String> List of Uniform Resource Identifiers (URIs) to use as alternative subjects of the certificate.
- valid
Days Integer Desired number of days for which the new certificate will be valid.
- common
Name string The common name of the certificate.
- algorithm string
Key encryption algorithm, either
RSA
orECDSA
. Defaults toRSA
.- certificate
Dn string - csr
Origin string Whether key-pair generation will be
local
orservice
generated. Default islocal
.- csr
Pem string - custom
Fields {[key: string]: string} Collection of Custom Field name-value pairs to assign to the certificate.
- ecdsa
Curve string ECDSA curve to use when generating a key
- expiration
Window number Number of hours before certificate expiry to request a new certificate. Defaults to
168
.- issuer
Hint string Used with valid_days to indicate the target issuer when using Trust Protection Platform. Relevant values are: "DigiCert", "Entrust", and "Microsoft".
- key
Password string The password used to encrypt the private key.
- nickname string
Use to specify a name for the new certificate object that will be created and placed in a policy. Only valid for TPP.
- pkcs12 string
- private
Key stringPem The private key in PEM format.
- rsa
Bits number Number of bits to use when generating an RSA key. Applies when
algorithm=RSA
. Defaults to2048
.- san
Dns string[] List of DNS names to use as alternative subjects of the certificate.
- san
Emails string[] List of email addresses to use as alternative subjects of the certificate.
- san
Ips string[] List of IP addresses to use as alternative subjects of the certificate.
- san
Uris string[] List of Uniform Resource Identifiers (URIs) to use as alternative subjects of the certificate.
- valid
Days number Desired number of days for which the new certificate will be valid.
- common_
name str The common name of the certificate.
- algorithm str
Key encryption algorithm, either
RSA
orECDSA
. Defaults toRSA
.- certificate_
dn str - csr_
origin str Whether key-pair generation will be
local
orservice
generated. Default islocal
.- csr_
pem str - custom_
fields Mapping[str, str] Collection of Custom Field name-value pairs to assign to the certificate.
- ecdsa_
curve str ECDSA curve to use when generating a key
- expiration_
window int Number of hours before certificate expiry to request a new certificate. Defaults to
168
.- issuer_
hint str Used with valid_days to indicate the target issuer when using Trust Protection Platform. Relevant values are: "DigiCert", "Entrust", and "Microsoft".
- key_
password str The password used to encrypt the private key.
- nickname str
Use to specify a name for the new certificate object that will be created and placed in a policy. Only valid for TPP.
- pkcs12 str
- private_
key_ strpem The private key in PEM format.
- rsa_
bits int Number of bits to use when generating an RSA key. Applies when
algorithm=RSA
. Defaults to2048
.- san_
dns Sequence[str] List of DNS names to use as alternative subjects of the certificate.
- san_
emails Sequence[str] List of email addresses to use as alternative subjects of the certificate.
- san_
ips Sequence[str] List of IP addresses to use as alternative subjects of the certificate.
- san_
uris Sequence[str] List of Uniform Resource Identifiers (URIs) to use as alternative subjects of the certificate.
- valid_
days int Desired number of days for which the new certificate will be valid.
- common
Name String The common name of the certificate.
- algorithm String
Key encryption algorithm, either
RSA
orECDSA
. Defaults toRSA
.- certificate
Dn String - csr
Origin String Whether key-pair generation will be
local
orservice
generated. Default islocal
.- csr
Pem String - custom
Fields Map<String> Collection of Custom Field name-value pairs to assign to the certificate.
- ecdsa
Curve String ECDSA curve to use when generating a key
- expiration
Window Number Number of hours before certificate expiry to request a new certificate. Defaults to
168
.- issuer
Hint String Used with valid_days to indicate the target issuer when using Trust Protection Platform. Relevant values are: "DigiCert", "Entrust", and "Microsoft".
- key
Password String The password used to encrypt the private key.
- nickname String
Use to specify a name for the new certificate object that will be created and placed in a policy. Only valid for TPP.
- pkcs12 String
- private
Key StringPem The private key in PEM format.
- rsa
Bits Number Number of bits to use when generating an RSA key. Applies when
algorithm=RSA
. Defaults to2048
.- san
Dns List<String> List of DNS names to use as alternative subjects of the certificate.
- san
Emails List<String> List of email addresses to use as alternative subjects of the certificate.
- san
Ips List<String> List of IP addresses to use as alternative subjects of the certificate.
- san
Uris List<String> List of Uniform Resource Identifiers (URIs) to use as alternative subjects of the certificate.
- valid
Days Number Desired number of days for which the new certificate will be valid.
Outputs
All input properties are implicitly available as output properties. Additionally, the Certificate resource produces the following output properties:
- Certificate
Details string The X509 certificate in PEM format.
- Chain string
The trust chain of X509 certificate authority certificates in PEM format concatenated together.
- Id string
The provider-assigned unique ID for this managed resource.
- Certificate string
The X509 certificate in PEM format.
- Chain string
The trust chain of X509 certificate authority certificates in PEM format concatenated together.
- Id string
The provider-assigned unique ID for this managed resource.
- certificate String
The X509 certificate in PEM format.
- chain String
The trust chain of X509 certificate authority certificates in PEM format concatenated together.
- id String
The provider-assigned unique ID for this managed resource.
- certificate string
The X509 certificate in PEM format.
- chain string
The trust chain of X509 certificate authority certificates in PEM format concatenated together.
- id string
The provider-assigned unique ID for this managed resource.
- certificate str
The X509 certificate in PEM format.
- chain str
The trust chain of X509 certificate authority certificates in PEM format concatenated together.
- id str
The provider-assigned unique ID for this managed resource.
- certificate String
The X509 certificate in PEM format.
- chain String
The trust chain of X509 certificate authority certificates in PEM format concatenated together.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing Certificate Resource
Get an existing Certificate 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?: CertificateState, opts?: CustomResourceOptions): Certificate
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
algorithm: Optional[str] = None,
certificate: Optional[str] = None,
certificate_dn: Optional[str] = None,
chain: Optional[str] = None,
common_name: Optional[str] = None,
csr_origin: Optional[str] = None,
csr_pem: Optional[str] = None,
custom_fields: Optional[Mapping[str, str]] = None,
ecdsa_curve: Optional[str] = None,
expiration_window: Optional[int] = None,
issuer_hint: Optional[str] = None,
key_password: Optional[str] = None,
nickname: Optional[str] = None,
pkcs12: Optional[str] = None,
private_key_pem: Optional[str] = None,
rsa_bits: Optional[int] = None,
san_dns: Optional[Sequence[str]] = None,
san_emails: Optional[Sequence[str]] = None,
san_ips: Optional[Sequence[str]] = None,
san_uris: Optional[Sequence[str]] = None,
valid_days: Optional[int] = None) -> Certificate
func GetCertificate(ctx *Context, name string, id IDInput, state *CertificateState, opts ...ResourceOption) (*Certificate, error)
public static Certificate Get(string name, Input<string> id, CertificateState? state, CustomResourceOptions? opts = null)
public static Certificate get(String name, Output<String> id, CertificateState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- 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.
- Algorithm string
Key encryption algorithm, either
RSA
orECDSA
. Defaults toRSA
.- Certificate
Details string The X509 certificate in PEM format.
- Certificate
Dn string - Chain string
The trust chain of X509 certificate authority certificates in PEM format concatenated together.
- Common
Name string The common name of the certificate.
- Csr
Origin string Whether key-pair generation will be
local
orservice
generated. Default islocal
.- Csr
Pem string - Custom
Fields Dictionary<string, string> Collection of Custom Field name-value pairs to assign to the certificate.
- Ecdsa
Curve string ECDSA curve to use when generating a key
- Expiration
Window int Number of hours before certificate expiry to request a new certificate. Defaults to
168
.- Issuer
Hint string Used with valid_days to indicate the target issuer when using Trust Protection Platform. Relevant values are: "DigiCert", "Entrust", and "Microsoft".
- Key
Password string The password used to encrypt the private key.
- Nickname string
Use to specify a name for the new certificate object that will be created and placed in a policy. Only valid for TPP.
- Pkcs12 string
- Private
Key stringPem The private key in PEM format.
- Rsa
Bits int Number of bits to use when generating an RSA key. Applies when
algorithm=RSA
. Defaults to2048
.- San
Dns List<string> List of DNS names to use as alternative subjects of the certificate.
- San
Emails List<string> List of email addresses to use as alternative subjects of the certificate.
- San
Ips List<string> List of IP addresses to use as alternative subjects of the certificate.
- San
Uris List<string> List of Uniform Resource Identifiers (URIs) to use as alternative subjects of the certificate.
- Valid
Days int Desired number of days for which the new certificate will be valid.
- Algorithm string
Key encryption algorithm, either
RSA
orECDSA
. Defaults toRSA
.- Certificate string
The X509 certificate in PEM format.
- Certificate
Dn string - Chain string
The trust chain of X509 certificate authority certificates in PEM format concatenated together.
- Common
Name string The common name of the certificate.
- Csr
Origin string Whether key-pair generation will be
local
orservice
generated. Default islocal
.- Csr
Pem string - Custom
Fields map[string]string Collection of Custom Field name-value pairs to assign to the certificate.
- Ecdsa
Curve string ECDSA curve to use when generating a key
- Expiration
Window int Number of hours before certificate expiry to request a new certificate. Defaults to
168
.- Issuer
Hint string Used with valid_days to indicate the target issuer when using Trust Protection Platform. Relevant values are: "DigiCert", "Entrust", and "Microsoft".
- Key
Password string The password used to encrypt the private key.
- Nickname string
Use to specify a name for the new certificate object that will be created and placed in a policy. Only valid for TPP.
- Pkcs12 string
- Private
Key stringPem The private key in PEM format.
- Rsa
Bits int Number of bits to use when generating an RSA key. Applies when
algorithm=RSA
. Defaults to2048
.- San
Dns []string List of DNS names to use as alternative subjects of the certificate.
- San
Emails []string List of email addresses to use as alternative subjects of the certificate.
- San
Ips []string List of IP addresses to use as alternative subjects of the certificate.
- San
Uris []string List of Uniform Resource Identifiers (URIs) to use as alternative subjects of the certificate.
- Valid
Days int Desired number of days for which the new certificate will be valid.
- algorithm String
Key encryption algorithm, either
RSA
orECDSA
. Defaults toRSA
.- certificate String
The X509 certificate in PEM format.
- certificate
Dn String - chain String
The trust chain of X509 certificate authority certificates in PEM format concatenated together.
- common
Name String The common name of the certificate.
- csr
Origin String Whether key-pair generation will be
local
orservice
generated. Default islocal
.- csr
Pem String - custom
Fields Map<String,String> Collection of Custom Field name-value pairs to assign to the certificate.
- ecdsa
Curve String ECDSA curve to use when generating a key
- expiration
Window Integer Number of hours before certificate expiry to request a new certificate. Defaults to
168
.- issuer
Hint String Used with valid_days to indicate the target issuer when using Trust Protection Platform. Relevant values are: "DigiCert", "Entrust", and "Microsoft".
- key
Password String The password used to encrypt the private key.
- nickname String
Use to specify a name for the new certificate object that will be created and placed in a policy. Only valid for TPP.
- pkcs12 String
- private
Key StringPem The private key in PEM format.
- rsa
Bits Integer Number of bits to use when generating an RSA key. Applies when
algorithm=RSA
. Defaults to2048
.- san
Dns List<String> List of DNS names to use as alternative subjects of the certificate.
- san
Emails List<String> List of email addresses to use as alternative subjects of the certificate.
- san
Ips List<String> List of IP addresses to use as alternative subjects of the certificate.
- san
Uris List<String> List of Uniform Resource Identifiers (URIs) to use as alternative subjects of the certificate.
- valid
Days Integer Desired number of days for which the new certificate will be valid.
- algorithm string
Key encryption algorithm, either
RSA
orECDSA
. Defaults toRSA
.- certificate string
The X509 certificate in PEM format.
- certificate
Dn string - chain string
The trust chain of X509 certificate authority certificates in PEM format concatenated together.
- common
Name string The common name of the certificate.
- csr
Origin string Whether key-pair generation will be
local
orservice
generated. Default islocal
.- csr
Pem string - custom
Fields {[key: string]: string} Collection of Custom Field name-value pairs to assign to the certificate.
- ecdsa
Curve string ECDSA curve to use when generating a key
- expiration
Window number Number of hours before certificate expiry to request a new certificate. Defaults to
168
.- issuer
Hint string Used with valid_days to indicate the target issuer when using Trust Protection Platform. Relevant values are: "DigiCert", "Entrust", and "Microsoft".
- key
Password string The password used to encrypt the private key.
- nickname string
Use to specify a name for the new certificate object that will be created and placed in a policy. Only valid for TPP.
- pkcs12 string
- private
Key stringPem The private key in PEM format.
- rsa
Bits number Number of bits to use when generating an RSA key. Applies when
algorithm=RSA
. Defaults to2048
.- san
Dns string[] List of DNS names to use as alternative subjects of the certificate.
- san
Emails string[] List of email addresses to use as alternative subjects of the certificate.
- san
Ips string[] List of IP addresses to use as alternative subjects of the certificate.
- san
Uris string[] List of Uniform Resource Identifiers (URIs) to use as alternative subjects of the certificate.
- valid
Days number Desired number of days for which the new certificate will be valid.
- algorithm str
Key encryption algorithm, either
RSA
orECDSA
. Defaults toRSA
.- certificate str
The X509 certificate in PEM format.
- certificate_
dn str - chain str
The trust chain of X509 certificate authority certificates in PEM format concatenated together.
- common_
name str The common name of the certificate.
- csr_
origin str Whether key-pair generation will be
local
orservice
generated. Default islocal
.- csr_
pem str - custom_
fields Mapping[str, str] Collection of Custom Field name-value pairs to assign to the certificate.
- ecdsa_
curve str ECDSA curve to use when generating a key
- expiration_
window int Number of hours before certificate expiry to request a new certificate. Defaults to
168
.- issuer_
hint str Used with valid_days to indicate the target issuer when using Trust Protection Platform. Relevant values are: "DigiCert", "Entrust", and "Microsoft".
- key_
password str The password used to encrypt the private key.
- nickname str
Use to specify a name for the new certificate object that will be created and placed in a policy. Only valid for TPP.
- pkcs12 str
- private_
key_ strpem The private key in PEM format.
- rsa_
bits int Number of bits to use when generating an RSA key. Applies when
algorithm=RSA
. Defaults to2048
.- san_
dns Sequence[str] List of DNS names to use as alternative subjects of the certificate.
- san_
emails Sequence[str] List of email addresses to use as alternative subjects of the certificate.
- san_
ips Sequence[str] List of IP addresses to use as alternative subjects of the certificate.
- san_
uris Sequence[str] List of Uniform Resource Identifiers (URIs) to use as alternative subjects of the certificate.
- valid_
days int Desired number of days for which the new certificate will be valid.
- algorithm String
Key encryption algorithm, either
RSA
orECDSA
. Defaults toRSA
.- certificate String
The X509 certificate in PEM format.
- certificate
Dn String - chain String
The trust chain of X509 certificate authority certificates in PEM format concatenated together.
- common
Name String The common name of the certificate.
- csr
Origin String Whether key-pair generation will be
local
orservice
generated. Default islocal
.- csr
Pem String - custom
Fields Map<String> Collection of Custom Field name-value pairs to assign to the certificate.
- ecdsa
Curve String ECDSA curve to use when generating a key
- expiration
Window Number Number of hours before certificate expiry to request a new certificate. Defaults to
168
.- issuer
Hint String Used with valid_days to indicate the target issuer when using Trust Protection Platform. Relevant values are: "DigiCert", "Entrust", and "Microsoft".
- key
Password String The password used to encrypt the private key.
- nickname String
Use to specify a name for the new certificate object that will be created and placed in a policy. Only valid for TPP.
- pkcs12 String
- private
Key StringPem The private key in PEM format.
- rsa
Bits Number Number of bits to use when generating an RSA key. Applies when
algorithm=RSA
. Defaults to2048
.- san
Dns List<String> List of DNS names to use as alternative subjects of the certificate.
- san
Emails List<String> List of email addresses to use as alternative subjects of the certificate.
- san
Ips List<String> List of IP addresses to use as alternative subjects of the certificate.
- san
Uris List<String> List of Uniform Resource Identifiers (URIs) to use as alternative subjects of the certificate.
- valid
Days Number Desired number of days for which the new certificate will be valid.
Package Details
- Repository
- Venafi pulumi/pulumi-venafi
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
venafi
Terraform Provider.