TargetLetsEncrypt

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 TargetLetsEncrypt Resource

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

Constructor syntax

new TargetLetsEncrypt(name: string, args: TargetLetsEncryptArgs, opts?: CustomResourceOptions);

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

@overload
def TargetLetsEncrypt(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      email: Optional[str] = None,
                      keep_prev_version: Optional[str] = None,
                      dns_target_creds: Optional[str] = None,
                      description: Optional[str] = None,
                      gcp_project: Optional[str] = None,
                      hosted_zone: Optional[str] = None,
                      acme_challenge: Optional[str] = None,
                      key: Optional[str] = None,
                      lets_encrypt_url: Optional[str] = None,
                      max_versions: Optional[str] = None,
                      name: Optional[str] = None,
                      resource_group: Optional[str] = None,
                      target_lets_encrypt_id: Optional[str] = None,
                      timeout: Optional[str] = None)

func NewTargetLetsEncrypt(ctx *Context, name string, args TargetLetsEncryptArgs, opts ...ResourceOption) (*TargetLetsEncrypt, error)

public TargetLetsEncrypt(string name, TargetLetsEncryptArgs args, CustomResourceOptions? opts = null)

public TargetLetsEncrypt(String name, TargetLetsEncryptArgs args)
public TargetLetsEncrypt(String name, TargetLetsEncryptArgs args, CustomResourceOptions options)

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

Parameters

name string: The unique name of the resource.
args TargetLetsEncryptArgs: 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 TargetLetsEncryptArgs: 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 TargetLetsEncryptArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TargetLetsEncryptArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args TargetLetsEncryptArgs: 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 targetLetsEncryptResource = new Akeyless.TargetLetsEncrypt("targetLetsEncryptResource", new()
{
    Email = "string",
    KeepPrevVersion = "string",
    DnsTargetCreds = "string",
    Description = "string",
    GcpProject = "string",
    HostedZone = "string",
    AcmeChallenge = "string",
    Key = "string",
    LetsEncryptUrl = "string",
    MaxVersions = "string",
    Name = "string",
    ResourceGroup = "string",
    TargetLetsEncryptId = "string",
    Timeout = "string",
});

example, err := akeyless.NewTargetLetsEncrypt(ctx, "targetLetsEncryptResource", &akeyless.TargetLetsEncryptArgs{
	Email:               pulumi.String("string"),
	KeepPrevVersion:     pulumi.String("string"),
	DnsTargetCreds:      pulumi.String("string"),
	Description:         pulumi.String("string"),
	GcpProject:          pulumi.String("string"),
	HostedZone:          pulumi.String("string"),
	AcmeChallenge:       pulumi.String("string"),
	Key:                 pulumi.String("string"),
	LetsEncryptUrl:      pulumi.String("string"),
	MaxVersions:         pulumi.String("string"),
	Name:                pulumi.String("string"),
	ResourceGroup:       pulumi.String("string"),
	TargetLetsEncryptId: pulumi.String("string"),
	Timeout:             pulumi.String("string"),
})

var targetLetsEncryptResource = new TargetLetsEncrypt("targetLetsEncryptResource", TargetLetsEncryptArgs.builder()
    .email("string")
    .keepPrevVersion("string")
    .dnsTargetCreds("string")
    .description("string")
    .gcpProject("string")
    .hostedZone("string")
    .acmeChallenge("string")
    .key("string")
    .letsEncryptUrl("string")
    .maxVersions("string")
    .name("string")
    .resourceGroup("string")
    .targetLetsEncryptId("string")
    .timeout("string")
    .build());

target_lets_encrypt_resource = akeyless.TargetLetsEncrypt("targetLetsEncryptResource",
    email="string",
    keep_prev_version="string",
    dns_target_creds="string",
    description="string",
    gcp_project="string",
    hosted_zone="string",
    acme_challenge="string",
    key="string",
    lets_encrypt_url="string",
    max_versions="string",
    name="string",
    resource_group="string",
    target_lets_encrypt_id="string",
    timeout="string")

const targetLetsEncryptResource = new akeyless.TargetLetsEncrypt("targetLetsEncryptResource", {
    email: "string",
    keepPrevVersion: "string",
    dnsTargetCreds: "string",
    description: "string",
    gcpProject: "string",
    hostedZone: "string",
    acmeChallenge: "string",
    key: "string",
    letsEncryptUrl: "string",
    maxVersions: "string",
    name: "string",
    resourceGroup: "string",
    targetLetsEncryptId: "string",
    timeout: "string",
});

type: akeyless:TargetLetsEncrypt
properties:
    acmeChallenge: string
    description: string
    dnsTargetCreds: string
    email: string
    gcpProject: string
    hostedZone: string
    keepPrevVersion: string
    key: string
    letsEncryptUrl: string
    maxVersions: string
    name: string
    resourceGroup: string
    targetLetsEncryptId: string
    timeout: string

TargetLetsEncrypt 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 TargetLetsEncrypt resource accepts the following input properties:

Email string: Email address for ACME account registration
AcmeChallenge string: ACME challenge type. Options: [http/dns]
Description string: Description of the object
DnsTargetCreds string: Name of existing cloud target for DNS credentials. Required when acme-challenge=dns. Supported: AWS, Azure, GCP targets
GcpProject string: GCP Cloud DNS: Project ID. Optional - can be derived from service account
HostedZone string: AWS Route53 hosted zone ID. Required when dns-target-creds points to AWS target
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 that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
LetsEncryptUrl string: Let's Encrypt directory environment
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults.
Name string: Target name
ResourceGroup string: Azure resource group name. Required when dns-target-creds points to Azure target
TargetLetsEncryptId string: The ID of this resource.
Timeout string: Timeout for challenge validation

Email string: Email address for ACME account registration
AcmeChallenge string: ACME challenge type. Options: [http/dns]
Description string: Description of the object
DnsTargetCreds string: Name of existing cloud target for DNS credentials. Required when acme-challenge=dns. Supported: AWS, Azure, GCP targets
GcpProject string: GCP Cloud DNS: Project ID. Optional - can be derived from service account
HostedZone string: AWS Route53 hosted zone ID. Required when dns-target-creds points to AWS target
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 that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
LetsEncryptUrl string: Let's Encrypt directory environment
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults.
Name string: Target name
ResourceGroup string: Azure resource group name. Required when dns-target-creds points to Azure target
TargetLetsEncryptId string: The ID of this resource.
Timeout string: Timeout for challenge validation

email String: Email address for ACME account registration
acmeChallenge String: ACME challenge type. Options: [http/dns]
description String: Description of the object
dnsTargetCreds String: Name of existing cloud target for DNS credentials. Required when acme-challenge=dns. Supported: AWS, Azure, GCP targets
gcpProject String: GCP Cloud DNS: Project ID. Optional - can be derived from service account
hostedZone String: AWS Route53 hosted zone ID. Required when dns-target-creds points to AWS target
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 that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
letsEncryptUrl String: Let's Encrypt directory environment
maxVersions String: Set the maximum number of versions, limited by the account settings defaults.
name String: Target name
resourceGroup String: Azure resource group name. Required when dns-target-creds points to Azure target
targetLetsEncryptId String: The ID of this resource.
timeout String: Timeout for challenge validation

email string: Email address for ACME account registration
acmeChallenge string: ACME challenge type. Options: [http/dns]
description string: Description of the object
dnsTargetCreds string: Name of existing cloud target for DNS credentials. Required when acme-challenge=dns. Supported: AWS, Azure, GCP targets
gcpProject string: GCP Cloud DNS: Project ID. Optional - can be derived from service account
hostedZone string: AWS Route53 hosted zone ID. Required when dns-target-creds points to AWS target
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 that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
letsEncryptUrl string: Let's Encrypt directory environment
maxVersions string: Set the maximum number of versions, limited by the account settings defaults.
name string: Target name
resourceGroup string: Azure resource group name. Required when dns-target-creds points to Azure target
targetLetsEncryptId string: The ID of this resource.
timeout string: Timeout for challenge validation

email str: Email address for ACME account registration
acme_challenge str: ACME challenge type. Options: [http/dns]
description str: Description of the object
dns_target_creds str: Name of existing cloud target for DNS credentials. Required when acme-challenge=dns. Supported: AWS, Azure, GCP targets
gcp_project str: GCP Cloud DNS: Project ID. Optional - can be derived from service account
hosted_zone str: AWS Route53 hosted zone ID. Required when dns-target-creds points to AWS target
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 that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
lets_encrypt_url str: Let's Encrypt directory environment
max_versions str: Set the maximum number of versions, limited by the account settings defaults.
name str: Target name
resource_group str: Azure resource group name. Required when dns-target-creds points to Azure target
target_lets_encrypt_id str: The ID of this resource.
timeout str: Timeout for challenge validation

email String: Email address for ACME account registration
acmeChallenge String: ACME challenge type. Options: [http/dns]
description String: Description of the object
dnsTargetCreds String: Name of existing cloud target for DNS credentials. Required when acme-challenge=dns. Supported: AWS, Azure, GCP targets
gcpProject String: GCP Cloud DNS: Project ID. Optional - can be derived from service account
hostedZone String: AWS Route53 hosted zone ID. Required when dns-target-creds points to AWS target
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 that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
letsEncryptUrl String: Let's Encrypt directory environment
maxVersions String: Set the maximum number of versions, limited by the account settings defaults.
name String: Target name
resourceGroup String: Azure resource group name. Required when dns-target-creds points to Azure target
targetLetsEncryptId String: The ID of this resource.
timeout String: Timeout for challenge validation

Outputs

All input properties are implicitly available as output properties. Additionally, the TargetLetsEncrypt 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 str: The provider-assigned unique ID for this managed resource.

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

Look up Existing TargetLetsEncrypt Resource

Get an existing TargetLetsEncrypt 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?: TargetLetsEncryptState, opts?: CustomResourceOptions): TargetLetsEncrypt

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        acme_challenge: Optional[str] = None,
        description: Optional[str] = None,
        dns_target_creds: Optional[str] = None,
        email: Optional[str] = None,
        gcp_project: Optional[str] = None,
        hosted_zone: Optional[str] = None,
        keep_prev_version: Optional[str] = None,
        key: Optional[str] = None,
        lets_encrypt_url: Optional[str] = None,
        max_versions: Optional[str] = None,
        name: Optional[str] = None,
        resource_group: Optional[str] = None,
        target_lets_encrypt_id: Optional[str] = None,
        timeout: Optional[str] = None) -> TargetLetsEncrypt

func GetTargetLetsEncrypt(ctx *Context, name string, id IDInput, state *TargetLetsEncryptState, opts ...ResourceOption) (*TargetLetsEncrypt, error)

public static TargetLetsEncrypt Get(string name, Input<string> id, TargetLetsEncryptState? state, CustomResourceOptions? opts = null)

public static TargetLetsEncrypt get(String name, Output<String> id, TargetLetsEncryptState state, CustomResourceOptions options)

resources:  _:    type: akeyless:TargetLetsEncrypt    get:      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:

AcmeChallenge string: ACME challenge type. Options: [http/dns]
Description string: Description of the object
DnsTargetCreds string: Name of existing cloud target for DNS credentials. Required when acme-challenge=dns. Supported: AWS, Azure, GCP targets
Email string: Email address for ACME account registration
GcpProject string: GCP Cloud DNS: Project ID. Optional - can be derived from service account
HostedZone string: AWS Route53 hosted zone ID. Required when dns-target-creds points to AWS target
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 that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
LetsEncryptUrl string: Let's Encrypt directory environment
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults.
Name string: Target name
ResourceGroup string: Azure resource group name. Required when dns-target-creds points to Azure target
TargetLetsEncryptId string: The ID of this resource.
Timeout string: Timeout for challenge validation

AcmeChallenge string: ACME challenge type. Options: [http/dns]
Description string: Description of the object
DnsTargetCreds string: Name of existing cloud target for DNS credentials. Required when acme-challenge=dns. Supported: AWS, Azure, GCP targets
Email string: Email address for ACME account registration
GcpProject string: GCP Cloud DNS: Project ID. Optional - can be derived from service account
HostedZone string: AWS Route53 hosted zone ID. Required when dns-target-creds points to AWS target
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 that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
LetsEncryptUrl string: Let's Encrypt directory environment
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults.
Name string: Target name
ResourceGroup string: Azure resource group name. Required when dns-target-creds points to Azure target
TargetLetsEncryptId string: The ID of this resource.
Timeout string: Timeout for challenge validation

acmeChallenge String: ACME challenge type. Options: [http/dns]
description String: Description of the object
dnsTargetCreds String: Name of existing cloud target for DNS credentials. Required when acme-challenge=dns. Supported: AWS, Azure, GCP targets
email String: Email address for ACME account registration
gcpProject String: GCP Cloud DNS: Project ID. Optional - can be derived from service account
hostedZone String: AWS Route53 hosted zone ID. Required when dns-target-creds points to AWS target
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 that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
letsEncryptUrl String: Let's Encrypt directory environment
maxVersions String: Set the maximum number of versions, limited by the account settings defaults.
name String: Target name
resourceGroup String: Azure resource group name. Required when dns-target-creds points to Azure target
targetLetsEncryptId String: The ID of this resource.
timeout String: Timeout for challenge validation

acmeChallenge string: ACME challenge type. Options: [http/dns]
description string: Description of the object
dnsTargetCreds string: Name of existing cloud target for DNS credentials. Required when acme-challenge=dns. Supported: AWS, Azure, GCP targets
email string: Email address for ACME account registration
gcpProject string: GCP Cloud DNS: Project ID. Optional - can be derived from service account
hostedZone string: AWS Route53 hosted zone ID. Required when dns-target-creds points to AWS target
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 that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
letsEncryptUrl string: Let's Encrypt directory environment
maxVersions string: Set the maximum number of versions, limited by the account settings defaults.
name string: Target name
resourceGroup string: Azure resource group name. Required when dns-target-creds points to Azure target
targetLetsEncryptId string: The ID of this resource.
timeout string: Timeout for challenge validation

acme_challenge str: ACME challenge type. Options: [http/dns]
description str: Description of the object
dns_target_creds str: Name of existing cloud target for DNS credentials. Required when acme-challenge=dns. Supported: AWS, Azure, GCP targets
email str: Email address for ACME account registration
gcp_project str: GCP Cloud DNS: Project ID. Optional - can be derived from service account
hosted_zone str: AWS Route53 hosted zone ID. Required when dns-target-creds points to AWS target
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 that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
lets_encrypt_url str: Let's Encrypt directory environment
max_versions str: Set the maximum number of versions, limited by the account settings defaults.
name str: Target name
resource_group str: Azure resource group name. Required when dns-target-creds points to Azure target
target_lets_encrypt_id str: The ID of this resource.
timeout str: Timeout for challenge validation

acmeChallenge String: ACME challenge type. Options: [http/dns]
description String: Description of the object
dnsTargetCreds String: Name of existing cloud target for DNS credentials. Required when acme-challenge=dns. Supported: AWS, Azure, GCP targets
email String: Email address for ACME account registration
gcpProject String: GCP Cloud DNS: Project ID. Optional - can be derived from service account
hostedZone String: AWS Route53 hosted zone ID. Required when dns-target-creds points to AWS target
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 that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
letsEncryptUrl String: Let's Encrypt directory environment
maxVersions String: Set the maximum number of versions, limited by the account settings defaults.
name String: Target name
resourceGroup String: Azure resource group name. Required when dns-target-creds points to Azure target
targetLetsEncryptId String: The ID of this resource.
timeout String: Timeout for challenge validation