Certificate

akeyless 2.0.1, Apr 27 26

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

Create Certificate Resource

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

Constructor syntax

new Certificate(name: string, args?: CertificateArgs, opts?: CustomResourceOptions);

@overload
def Certificate(resource_name: str,
                args: Optional[CertificateArgs] = None,
                opts: Optional[ResourceOptions] = None)

@overload
def Certificate(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                certificate_data: Optional[str] = None,
                certificate_id: Optional[str] = None,
                delete_protection: Optional[str] = None,
                description: Optional[str] = None,
                expiration_event_ins: Optional[Sequence[str]] = None,
                format: Optional[str] = None,
                item_custom_fields: Optional[Mapping[str, str]] = None,
                keep_prev_version: Optional[str] = None,
                key: Optional[str] = None,
                key_data: Optional[str] = None,
                name: Optional[str] = None,
                tags: Optional[Sequence[str]] = None)

func NewCertificate(ctx *Context, name string, args *CertificateArgs, opts ...ResourceOption) (*Certificate, error)

public Certificate(string name, CertificateArgs? args = null, CustomResourceOptions? opts = null)

public Certificate(String name, CertificateArgs args)
public Certificate(String name, CertificateArgs args, CustomResourceOptions options)

type: akeyless:Certificate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "akeyless_certificate" "name" {
    # resource properties
}

Parameters

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.

Constructor example

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

var certificateResource = new Akeyless.Certificate("certificateResource", new()
{
    CertificateData = "string",
    CertificateId = "string",
    DeleteProtection = "string",
    Description = "string",
    ExpirationEventIns = new[]
    {
        "string",
    },
    Format = "string",
    ItemCustomFields = 
    {
        { "string", "string" },
    },
    KeepPrevVersion = "string",
    Key = "string",
    KeyData = "string",
    Name = "string",
    Tags = new[]
    {
        "string",
    },
});

example, err := akeyless.NewCertificate(ctx, "certificateResource", &akeyless.CertificateArgs{
	CertificateData:  pulumi.String("string"),
	CertificateId:    pulumi.String("string"),
	DeleteProtection: pulumi.String("string"),
	Description:      pulumi.String("string"),
	ExpirationEventIns: pulumi.StringArray{
		pulumi.String("string"),
	},
	Format: pulumi.String("string"),
	ItemCustomFields: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	KeepPrevVersion: pulumi.String("string"),
	Key:             pulumi.String("string"),
	KeyData:         pulumi.String("string"),
	Name:            pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

resource "akeyless_certificate" "certificateResource" {
  certificate_data     = "string"
  certificate_id       = "string"
  delete_protection    = "string"
  description          = "string"
  expiration_event_ins = ["string"]
  format               = "string"
  item_custom_fields = {
    "string" = "string"
  }
  keep_prev_version = "string"
  key               = "string"
  key_data          = "string"
  name              = "string"
  tags              = ["string"]
}

var certificateResource = new Certificate("certificateResource", CertificateArgs.builder()
    .certificateData("string")
    .certificateId("string")
    .deleteProtection("string")
    .description("string")
    .expirationEventIns("string")
    .format("string")
    .itemCustomFields(Map.of("string", "string"))
    .keepPrevVersion("string")
    .key("string")
    .keyData("string")
    .name("string")
    .tags("string")
    .build());

certificate_resource = akeyless.Certificate("certificateResource",
    certificate_data="string",
    certificate_id="string",
    delete_protection="string",
    description="string",
    expiration_event_ins=["string"],
    format="string",
    item_custom_fields={
        "string": "string",
    },
    keep_prev_version="string",
    key="string",
    key_data="string",
    name="string",
    tags=["string"])

const certificateResource = new akeyless.Certificate("certificateResource", {
    certificateData: "string",
    certificateId: "string",
    deleteProtection: "string",
    description: "string",
    expirationEventIns: ["string"],
    format: "string",
    itemCustomFields: {
        string: "string",
    },
    keepPrevVersion: "string",
    key: "string",
    keyData: "string",
    name: "string",
    tags: ["string"],
});

type: akeyless:Certificate
properties:
    certificateData: string
    certificateId: string
    deleteProtection: string
    description: string
    expirationEventIns:
        - string
    format: string
    itemCustomFields:
        string: string
    keepPrevVersion: string
    key: string
    keyData: string
    name: string
    tags:
        - string

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

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

The Certificate resource accepts the following input properties:

CertificateData string: Content of the certificate in a Base64 format.
CertificateId string: The ID of this resource.
DeleteProtection string: Protection from accidental deletion of this object, [true/false]
Description string: Description of the object
ExpirationEventIns List<string>: How many days before the expiration of the certificate would you like to be notified.
Format string: CertificateFormat of the certificate and private key, possible values: cer,crt,pem,pfx,p12. Required when passing inline certificate content with --certificate-data or --key-data, otherwise format is derived from the file extension.
ItemCustomFields Dictionary<string, string>: Additional custom fields to associate with the item
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
Key string: The name of a key to use to encrypt the certificate's key (if empty, the account default protectionKey key will be used)
KeyData string: Content of the certificate's private key in a Base64 format.
Name string: Certificate name
Tags List<string>: Add tags attached to this object

CertificateData string: Content of the certificate in a Base64 format.
CertificateId string: The ID of this resource.
DeleteProtection string: Protection from accidental deletion of this object, [true/false]
Description string: Description of the object
ExpirationEventIns []string: How many days before the expiration of the certificate would you like to be notified.
Format string: CertificateFormat of the certificate and private key, possible values: cer,crt,pem,pfx,p12. Required when passing inline certificate content with --certificate-data or --key-data, otherwise format is derived from the file extension.
ItemCustomFields map[string]string: Additional custom fields to associate with the item
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
Key string: The name of a key to use to encrypt the certificate's key (if empty, the account default protectionKey key will be used)
KeyData string: Content of the certificate's private key in a Base64 format.
Name string: Certificate name
Tags []string: Add tags attached to this object

certificate_data string: Content of the certificate in a Base64 format.
certificate_id string: The ID of this resource.
delete_protection string: Protection from accidental deletion of this object, [true/false]
description string: Description of the object
expiration_event_ins list(string): How many days before the expiration of the certificate would you like to be notified.
format string: CertificateFormat of the certificate and private key, possible values: cer,crt,pem,pfx,p12. Required when passing inline certificate content with --certificate-data or --key-data, otherwise format is derived from the file extension.
item_custom_fields map(string): Additional custom fields to associate with the item
keep_prev_version string: Whether to keep previous version [true/false]. If not set, use default according to account settings
key string: The name of a key to use to encrypt the certificate's key (if empty, the account default protectionKey key will be used)
key_data string: Content of the certificate's private key in a Base64 format.
name string: Certificate name
tags list(string): Add tags attached to this object

certificateData String: Content of the certificate in a Base64 format.
certificateId String: The ID of this resource.
deleteProtection String: Protection from accidental deletion of this object, [true/false]
description String: Description of the object
expirationEventIns List<String>: How many days before the expiration of the certificate would you like to be notified.
format String: CertificateFormat of the certificate and private key, possible values: cer,crt,pem,pfx,p12. Required when passing inline certificate content with --certificate-data or --key-data, otherwise format is derived from the file extension.
itemCustomFields Map<String,String>: Additional custom fields to associate with the item
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
key String: The name of a key to use to encrypt the certificate's key (if empty, the account default protectionKey key will be used)
keyData String: Content of the certificate's private key in a Base64 format.
name String: Certificate name
tags List<String>: Add tags attached to this object

certificateData string: Content of the certificate in a Base64 format.
certificateId string: The ID of this resource.
deleteProtection string: Protection from accidental deletion of this object, [true/false]
description string: Description of the object
expirationEventIns string[]: How many days before the expiration of the certificate would you like to be notified.
format string: CertificateFormat of the certificate and private key, possible values: cer,crt,pem,pfx,p12. Required when passing inline certificate content with --certificate-data or --key-data, otherwise format is derived from the file extension.
itemCustomFields {[key: string]: string}: Additional custom fields to associate with the item
keepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
key string: The name of a key to use to encrypt the certificate's key (if empty, the account default protectionKey key will be used)
keyData string: Content of the certificate's private key in a Base64 format.
name string: Certificate name
tags string[]: Add tags attached to this object

certificate_data str: Content of the certificate in a Base64 format.
certificate_id str: The ID of this resource.
delete_protection str: Protection from accidental deletion of this object, [true/false]
description str: Description of the object
expiration_event_ins Sequence[str]: How many days before the expiration of the certificate would you like to be notified.
format str: CertificateFormat of the certificate and private key, possible values: cer,crt,pem,pfx,p12. Required when passing inline certificate content with --certificate-data or --key-data, otherwise format is derived from the file extension.
item_custom_fields Mapping[str, str]: Additional custom fields to associate with the item
keep_prev_version str: Whether to keep previous version [true/false]. If not set, use default according to account settings
key str: The name of a key to use to encrypt the certificate's key (if empty, the account default protectionKey key will be used)
key_data str: Content of the certificate's private key in a Base64 format.
name str: Certificate name
tags Sequence[str]: Add tags attached to this object

certificateData String: Content of the certificate in a Base64 format.
certificateId String: The ID of this resource.
deleteProtection String: Protection from accidental deletion of this object, [true/false]
description String: Description of the object
expirationEventIns List<String>: How many days before the expiration of the certificate would you like to be notified.
format String: CertificateFormat of the certificate and private key, possible values: cer,crt,pem,pfx,p12. Required when passing inline certificate content with --certificate-data or --key-data, otherwise format is derived from the file extension.
itemCustomFields Map<String>: Additional custom fields to associate with the item
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
key String: The name of a key to use to encrypt the certificate's key (if empty, the account default protectionKey key will be used)
keyData String: Content of the certificate's private key in a Base64 format.
name String: Certificate name
tags List<String>: Add tags attached to this object

Outputs

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

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

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

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

id String: The provider-assigned unique ID for this managed resource.

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

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

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,
        certificate_data: Optional[str] = None,
        certificate_id: Optional[str] = None,
        delete_protection: Optional[str] = None,
        description: Optional[str] = None,
        expiration_event_ins: Optional[Sequence[str]] = None,
        format: Optional[str] = None,
        item_custom_fields: Optional[Mapping[str, str]] = None,
        keep_prev_version: Optional[str] = None,
        key: Optional[str] = None,
        key_data: Optional[str] = None,
        name: Optional[str] = None,
        tags: Optional[Sequence[str]] = 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)

resources:  _:    type: akeyless:Certificate    get:      id: ${id}

import {
  to = akeyless_certificate.example
  id = "${id}"
}

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.

The following state arguments are supported:

CertificateData string: Content of the certificate in a Base64 format.
CertificateId string: The ID of this resource.
DeleteProtection string: Protection from accidental deletion of this object, [true/false]
Description string: Description of the object
ExpirationEventIns List<string>: How many days before the expiration of the certificate would you like to be notified.
Format string: CertificateFormat of the certificate and private key, possible values: cer,crt,pem,pfx,p12. Required when passing inline certificate content with --certificate-data or --key-data, otherwise format is derived from the file extension.
ItemCustomFields Dictionary<string, string>: Additional custom fields to associate with the item
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
Key string: The name of a key to use to encrypt the certificate's key (if empty, the account default protectionKey key will be used)
KeyData string: Content of the certificate's private key in a Base64 format.
Name string: Certificate name
Tags List<string>: Add tags attached to this object

CertificateData string: Content of the certificate in a Base64 format.
CertificateId string: The ID of this resource.
DeleteProtection string: Protection from accidental deletion of this object, [true/false]
Description string: Description of the object
ExpirationEventIns []string: How many days before the expiration of the certificate would you like to be notified.
Format string: CertificateFormat of the certificate and private key, possible values: cer,crt,pem,pfx,p12. Required when passing inline certificate content with --certificate-data or --key-data, otherwise format is derived from the file extension.
ItemCustomFields map[string]string: Additional custom fields to associate with the item
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
Key string: The name of a key to use to encrypt the certificate's key (if empty, the account default protectionKey key will be used)
KeyData string: Content of the certificate's private key in a Base64 format.
Name string: Certificate name
Tags []string: Add tags attached to this object

certificate_data string: Content of the certificate in a Base64 format.
certificate_id string: The ID of this resource.
delete_protection string: Protection from accidental deletion of this object, [true/false]
description string: Description of the object
expiration_event_ins list(string): How many days before the expiration of the certificate would you like to be notified.
format string: CertificateFormat of the certificate and private key, possible values: cer,crt,pem,pfx,p12. Required when passing inline certificate content with --certificate-data or --key-data, otherwise format is derived from the file extension.
item_custom_fields map(string): Additional custom fields to associate with the item
keep_prev_version string: Whether to keep previous version [true/false]. If not set, use default according to account settings
key string: The name of a key to use to encrypt the certificate's key (if empty, the account default protectionKey key will be used)
key_data string: Content of the certificate's private key in a Base64 format.
name string: Certificate name
tags list(string): Add tags attached to this object

certificateData String: Content of the certificate in a Base64 format.
certificateId String: The ID of this resource.
deleteProtection String: Protection from accidental deletion of this object, [true/false]
description String: Description of the object
expirationEventIns List<String>: How many days before the expiration of the certificate would you like to be notified.
format String: CertificateFormat of the certificate and private key, possible values: cer,crt,pem,pfx,p12. Required when passing inline certificate content with --certificate-data or --key-data, otherwise format is derived from the file extension.
itemCustomFields Map<String,String>: Additional custom fields to associate with the item
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
key String: The name of a key to use to encrypt the certificate's key (if empty, the account default protectionKey key will be used)
keyData String: Content of the certificate's private key in a Base64 format.
name String: Certificate name
tags List<String>: Add tags attached to this object

certificateData string: Content of the certificate in a Base64 format.
certificateId string: The ID of this resource.
deleteProtection string: Protection from accidental deletion of this object, [true/false]
description string: Description of the object
expirationEventIns string[]: How many days before the expiration of the certificate would you like to be notified.
format string: CertificateFormat of the certificate and private key, possible values: cer,crt,pem,pfx,p12. Required when passing inline certificate content with --certificate-data or --key-data, otherwise format is derived from the file extension.
itemCustomFields {[key: string]: string}: Additional custom fields to associate with the item
keepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
key string: The name of a key to use to encrypt the certificate's key (if empty, the account default protectionKey key will be used)
keyData string: Content of the certificate's private key in a Base64 format.
name string: Certificate name
tags string[]: Add tags attached to this object

certificate_data str: Content of the certificate in a Base64 format.
certificate_id str: The ID of this resource.
delete_protection str: Protection from accidental deletion of this object, [true/false]
description str: Description of the object
expiration_event_ins Sequence[str]: How many days before the expiration of the certificate would you like to be notified.
format str: CertificateFormat of the certificate and private key, possible values: cer,crt,pem,pfx,p12. Required when passing inline certificate content with --certificate-data or --key-data, otherwise format is derived from the file extension.
item_custom_fields Mapping[str, str]: Additional custom fields to associate with the item
keep_prev_version str: Whether to keep previous version [true/false]. If not set, use default according to account settings
key str: The name of a key to use to encrypt the certificate's key (if empty, the account default protectionKey key will be used)
key_data str: Content of the certificate's private key in a Base64 format.
name str: Certificate name
tags Sequence[str]: Add tags attached to this object

certificateData String: Content of the certificate in a Base64 format.
certificateId String: The ID of this resource.
deleteProtection String: Protection from accidental deletion of this object, [true/false]
description String: Description of the object
expirationEventIns List<String>: How many days before the expiration of the certificate would you like to be notified.
format String: CertificateFormat of the certificate and private key, possible values: cer,crt,pem,pfx,p12. Required when passing inline certificate content with --certificate-data or --key-data, otherwise format is derived from the file extension.
itemCustomFields Map<String>: Additional custom fields to associate with the item
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
key String: The name of a key to use to encrypt the certificate's key (if empty, the account default protectionKey key will be used)
keyData String: Content of the certificate's private key in a Base64 format.
name String: Certificate name
tags List<String>: Add tags attached to this object