Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. TargetCustomDns
Viewing docs for akeyless 2.0.4
published on Monday, Aug 10, 2026 by akeyless-community
Schema (JSON)
akeyless-community/terraform-provider-akeyless

akeyless.TargetCustomDns

Viewing docs for akeyless 2.0.4
published on Monday, Aug 10, 2026 by akeyless-community
Schema (JSON)
akeyless-community/terraform-provider-akeyless

    Custom DNS Target resource

    Create TargetCustomDns Resource

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

    Constructor syntax

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

@overload
def TargetCustomDns(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    dns_parameter: Optional[Mapping[str, str]] = None,
                    provider_type: Optional[str] = None,
                    delete_protection: Optional[str] = None,
                    description: Optional[str] = None,
                    keep_prev_version: Optional[str] = None,
                    key: Optional[str] = None,
                    max_versions: Optional[str] = None,
                    name: Optional[str] = None,
                    target_custom_dns_id: Optional[str] = None)
    func NewTargetCustomDns(ctx *Context, name string, args TargetCustomDnsArgs, opts ...ResourceOption) (*TargetCustomDns, error)
    public TargetCustomDns(string name, TargetCustomDnsArgs args, CustomResourceOptions? opts = null)
    public TargetCustomDns(String name, TargetCustomDnsArgs args)
public TargetCustomDns(String name, TargetCustomDnsArgs args, CustomResourceOptions options)

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


    resource "akeyless_target_custom_dns" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args TargetCustomDnsArgs
    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 TargetCustomDnsArgs
    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 TargetCustomDnsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TargetCustomDnsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TargetCustomDnsArgs
    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 targetCustomDnsResource = new Akeyless.TargetCustomDns("targetCustomDnsResource", new()
{
    DnsParameter = 
    {
        { "string", "string" },
    },
    ProviderType = "string",
    DeleteProtection = "string",
    Description = "string",
    KeepPrevVersion = "string",
    Key = "string",
    MaxVersions = "string",
    Name = "string",
    TargetCustomDnsId = "string",
});

    example, err := akeyless.NewTargetCustomDns(ctx, "targetCustomDnsResource", &akeyless.TargetCustomDnsArgs{
	DnsParameter: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ProviderType:      pulumi.String("string"),
	DeleteProtection:  pulumi.String("string"),
	Description:       pulumi.String("string"),
	KeepPrevVersion:   pulumi.String("string"),
	Key:               pulumi.String("string"),
	MaxVersions:       pulumi.String("string"),
	Name:              pulumi.String("string"),
	TargetCustomDnsId: pulumi.String("string"),
})

    resource "akeyless_target_custom_dns" "targetCustomDnsResource" {
  lifecycle {
    create_before_destroy = true
  }
  dns_parameter = {
    "string" = "string"
  }
  provider_type        = "string"
  delete_protection    = "string"
  description          = "string"
  keep_prev_version    = "string"
  key                  = "string"
  max_versions         = "string"
  name                 = "string"
  target_custom_dns_id = "string"
}

    var targetCustomDnsResource = new TargetCustomDns("targetCustomDnsResource", TargetCustomDnsArgs.builder()
    .dnsParameter(Map.of("string", "string"))
    .providerType("string")
    .deleteProtection("string")
    .description("string")
    .keepPrevVersion("string")
    .key("string")
    .maxVersions("string")
    .name("string")
    .targetCustomDnsId("string")
    .build());

    target_custom_dns_resource = akeyless.TargetCustomDns("targetCustomDnsResource",
    dns_parameter={
        "string": "string",
    },
    provider_type="string",
    delete_protection="string",
    description="string",
    keep_prev_version="string",
    key="string",
    max_versions="string",
    name="string",
    target_custom_dns_id="string")

    const targetCustomDnsResource = new akeyless.TargetCustomDns("targetCustomDnsResource", {
    dnsParameter: {
        string: "string",
    },
    providerType: "string",
    deleteProtection: "string",
    description: "string",
    keepPrevVersion: "string",
    key: "string",
    maxVersions: "string",
    name: "string",
    targetCustomDnsId: "string",
});

    type: akeyless:TargetCustomDns
properties:
    deleteProtection: string
    description: string
    dnsParameter:
        string: string
    keepPrevVersion: string
    key: string
    maxVersions: string
    name: string
    providerType: string
    targetCustomDnsId: string

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

    DnsParameter Dictionary<string, string>
    DNS provider parameters
    ProviderType string
    DNS provider type
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    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)
    MaxVersions string
    Set the maximum number of versions, limited by the account settings defaults.
    Name string
    Target name
    TargetCustomDnsId string
    The ID of this resource.
    DnsParameter map[string]string
    DNS provider parameters
    ProviderType string
    DNS provider type
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    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)
    MaxVersions string
    Set the maximum number of versions, limited by the account settings defaults.
    Name string
    Target name
    TargetCustomDnsId string
    The ID of this resource.
    dns_parameter map(string)
    DNS provider parameters
    provider_type string
    DNS provider type
    delete_protection string
    Protection from accidental deletion of this object [true/false]
    description string
    Description of the object
    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 that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
    max_versions string
    Set the maximum number of versions, limited by the account settings defaults.
    name string
    Target name
    target_custom_dns_id string
    The ID of this resource.
    dnsParameter Map<String,String>
    DNS provider parameters
    providerType String
    DNS provider type
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    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)
    maxVersions String
    Set the maximum number of versions, limited by the account settings defaults.
    name String
    Target name
    targetCustomDnsId String
    The ID of this resource.
    dnsParameter {[key: string]: string}
    DNS provider parameters
    providerType string
    DNS provider type
    deleteProtection string
    Protection from accidental deletion of this object [true/false]
    description string
    Description of the object
    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)
    maxVersions string
    Set the maximum number of versions, limited by the account settings defaults.
    name string
    Target name
    targetCustomDnsId string
    The ID of this resource.
    dns_parameter Mapping[str, str]
    DNS provider parameters
    provider_type str
    DNS provider type
    delete_protection str
    Protection from accidental deletion of this object [true/false]
    description str
    Description of the object
    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)
    max_versions str
    Set the maximum number of versions, limited by the account settings defaults.
    name str
    Target name
    target_custom_dns_id str
    The ID of this resource.
    dnsParameter Map<String>
    DNS provider parameters
    providerType String
    DNS provider type
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    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)
    maxVersions String
    Set the maximum number of versions, limited by the account settings defaults.
    name String
    Target name
    targetCustomDnsId String
    The ID of this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TargetCustomDns 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 TargetCustomDns Resource

    Get an existing TargetCustomDns 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?: TargetCustomDnsState, opts?: CustomResourceOptions): TargetCustomDns
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        delete_protection: Optional[str] = None,
        description: Optional[str] = None,
        dns_parameter: Optional[Mapping[str, str]] = None,
        keep_prev_version: Optional[str] = None,
        key: Optional[str] = None,
        max_versions: Optional[str] = None,
        name: Optional[str] = None,
        provider_type: Optional[str] = None,
        target_custom_dns_id: Optional[str] = None) -> TargetCustomDns
    func GetTargetCustomDns(ctx *Context, name string, id IDInput, state *TargetCustomDnsState, opts ...ResourceOption) (*TargetCustomDns, error)
    public static TargetCustomDns Get(string name, Input<string> id, TargetCustomDnsState? state, CustomResourceOptions? opts = null)
    public static TargetCustomDns get(String name, Output<String> id, TargetCustomDnsState state, CustomResourceOptions options)
    resources:  _:    type: akeyless:TargetCustomDns    get:      id: ${id}
    import {
  to = akeyless_target_custom_dns.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:
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    DnsParameter Dictionary<string, string>
    DNS provider parameters
    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)
    MaxVersions string
    Set the maximum number of versions, limited by the account settings defaults.
    Name string
    Target name
    ProviderType string
    DNS provider type
    TargetCustomDnsId string
    The ID of this resource.
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    DnsParameter map[string]string
    DNS provider parameters
    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)
    MaxVersions string
    Set the maximum number of versions, limited by the account settings defaults.
    Name string
    Target name
    ProviderType string
    DNS provider type
    TargetCustomDnsId string
    The ID of this resource.
    delete_protection string
    Protection from accidental deletion of this object [true/false]
    description string
    Description of the object
    dns_parameter map(string)
    DNS provider parameters
    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 that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
    max_versions string
    Set the maximum number of versions, limited by the account settings defaults.
    name string
    Target name
    provider_type string
    DNS provider type
    target_custom_dns_id string
    The ID of this resource.
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    dnsParameter Map<String,String>
    DNS provider parameters
    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)
    maxVersions String
    Set the maximum number of versions, limited by the account settings defaults.
    name String
    Target name
    providerType String
    DNS provider type
    targetCustomDnsId String
    The ID of this resource.
    deleteProtection string
    Protection from accidental deletion of this object [true/false]
    description string
    Description of the object
    dnsParameter {[key: string]: string}
    DNS provider parameters
    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)
    maxVersions string
    Set the maximum number of versions, limited by the account settings defaults.
    name string
    Target name
    providerType string
    DNS provider type
    targetCustomDnsId string
    The ID of this resource.
    delete_protection str
    Protection from accidental deletion of this object [true/false]
    description str
    Description of the object
    dns_parameter Mapping[str, str]
    DNS provider parameters
    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)
    max_versions str
    Set the maximum number of versions, limited by the account settings defaults.
    name str
    Target name
    provider_type str
    DNS provider type
    target_custom_dns_id str
    The ID of this resource.
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    dnsParameter Map<String>
    DNS provider parameters
    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)
    maxVersions String
    Set the maximum number of versions, limited by the account settings defaults.
    name String
    Target name
    providerType String
    DNS provider type
    targetCustomDnsId String
    The ID of this resource.

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    Viewing docs for akeyless 2.0.4
    published on Monday, Aug 10, 2026 by akeyless-community
    Schema (JSON)
    akeyless-community/terraform-provider-akeyless

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial