oci logo
Oracle Cloud Infrastructure v0.6.0, Jan 23 23

oci.Dns.TsigKey

This resource provides the Tsig Key resource in Oracle Cloud Infrastructure DNS service.

Creates a new TSIG key in the specified compartment. There is no opc-retry-token header since TSIG key names must be globally unique.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testTsigKey = new Oci.Dns.TsigKey("testTsigKey", new()
    {
        Algorithm = @var.Tsig_key_algorithm,
        CompartmentId = @var.Compartment_id,
        Secret = @var.Tsig_key_secret,
        DefinedTags = @var.Tsig_key_defined_tags,
        FreeformTags = @var.Tsig_key_freeform_tags,
    });

});
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/Dns"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Dns.NewTsigKey(ctx, "testTsigKey", &Dns.TsigKeyArgs{
			Algorithm:     pulumi.Any(_var.Tsig_key_algorithm),
			CompartmentId: pulumi.Any(_var.Compartment_id),
			Secret:        pulumi.Any(_var.Tsig_key_secret),
			DefinedTags:   pulumi.Any(_var.Tsig_key_defined_tags),
			FreeformTags:  pulumi.Any(_var.Tsig_key_freeform_tags),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Dns.TsigKey;
import com.pulumi.oci.Dns.TsigKeyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        var testTsigKey = new TsigKey("testTsigKey", TsigKeyArgs.builder()        
            .algorithm(var_.tsig_key_algorithm())
            .compartmentId(var_.compartment_id())
            .secret(var_.tsig_key_secret())
            .definedTags(var_.tsig_key_defined_tags())
            .freeformTags(var_.tsig_key_freeform_tags())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_tsig_key = oci.dns.TsigKey("testTsigKey",
    algorithm=var["tsig_key_algorithm"],
    compartment_id=var["compartment_id"],
    secret=var["tsig_key_secret"],
    defined_tags=var["tsig_key_defined_tags"],
    freeform_tags=var["tsig_key_freeform_tags"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testTsigKey = new oci.dns.TsigKey("testTsigKey", {
    algorithm: _var.tsig_key_algorithm,
    compartmentId: _var.compartment_id,
    secret: _var.tsig_key_secret,
    definedTags: _var.tsig_key_defined_tags,
    freeformTags: _var.tsig_key_freeform_tags,
});
resources:
  testTsigKey:
    type: oci:Dns:TsigKey
    properties:
      #Required
      algorithm: ${var.tsig_key_algorithm}
      compartmentId: ${var.compartment_id}
      secret: ${var.tsig_key_secret}
      #Optional
      definedTags: ${var.tsig_key_defined_tags}
      freeformTags: ${var.tsig_key_freeform_tags}

Create TsigKey Resource

new TsigKey(name: string, args: TsigKeyArgs, opts?: CustomResourceOptions);
@overload
def TsigKey(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            algorithm: Optional[str] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            name: Optional[str] = None,
            secret: Optional[str] = None)
@overload
def TsigKey(resource_name: str,
            args: TsigKeyArgs,
            opts: Optional[ResourceOptions] = None)
func NewTsigKey(ctx *Context, name string, args TsigKeyArgs, opts ...ResourceOption) (*TsigKey, error)
public TsigKey(string name, TsigKeyArgs args, CustomResourceOptions? opts = null)
public TsigKey(String name, TsigKeyArgs args)
public TsigKey(String name, TsigKeyArgs args, CustomResourceOptions options)
type: oci:Dns:TsigKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

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

Algorithm string

TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see RFC 4635.

CompartmentId string

(Updatable) The OCID of the compartment containing the TSIG key.

Secret string

A base64 string encoding the binary shared secret.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

FreeformTags Dictionary<string, object>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Name string

A globally unique domain name identifying the key for a given pair of hosts.

Algorithm string

TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see RFC 4635.

CompartmentId string

(Updatable) The OCID of the compartment containing the TSIG key.

Secret string

A base64 string encoding the binary shared secret.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

FreeformTags map[string]interface{}

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Name string

A globally unique domain name identifying the key for a given pair of hosts.

algorithm String

TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see RFC 4635.

compartmentId String

(Updatable) The OCID of the compartment containing the TSIG key.

secret String

A base64 string encoding the binary shared secret.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeformTags Map<String,Object>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

name String

A globally unique domain name identifying the key for a given pair of hosts.

algorithm string

TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see RFC 4635.

compartmentId string

(Updatable) The OCID of the compartment containing the TSIG key.

secret string

A base64 string encoding the binary shared secret.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeformTags {[key: string]: any}

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

name string

A globally unique domain name identifying the key for a given pair of hosts.

algorithm str

TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see RFC 4635.

compartment_id str

(Updatable) The OCID of the compartment containing the TSIG key.

secret str

A base64 string encoding the binary shared secret.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeform_tags Mapping[str, Any]

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

name str

A globally unique domain name identifying the key for a given pair of hosts.

algorithm String

TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see RFC 4635.

compartmentId String

(Updatable) The OCID of the compartment containing the TSIG key.

secret String

A base64 string encoding the binary shared secret.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeformTags Map<Any>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

name String

A globally unique domain name identifying the key for a given pair of hosts.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Self string

The canonical absolute URL of the resource.

State string

The current state of the resource.

TimeCreated string

The date and time the resource was created, expressed in RFC 3339 timestamp format.

TimeUpdated string

The date and time the resource was last updated, expressed in RFC 3339 timestamp format.

Id string

The provider-assigned unique ID for this managed resource.

Self string

The canonical absolute URL of the resource.

State string

The current state of the resource.

TimeCreated string

The date and time the resource was created, expressed in RFC 3339 timestamp format.

TimeUpdated string

The date and time the resource was last updated, expressed in RFC 3339 timestamp format.

id String

The provider-assigned unique ID for this managed resource.

self String

The canonical absolute URL of the resource.

state String

The current state of the resource.

timeCreated String

The date and time the resource was created, expressed in RFC 3339 timestamp format.

timeUpdated String

The date and time the resource was last updated, expressed in RFC 3339 timestamp format.

id string

The provider-assigned unique ID for this managed resource.

self string

The canonical absolute URL of the resource.

state string

The current state of the resource.

timeCreated string

The date and time the resource was created, expressed in RFC 3339 timestamp format.

timeUpdated string

The date and time the resource was last updated, expressed in RFC 3339 timestamp format.

id str

The provider-assigned unique ID for this managed resource.

self str

The canonical absolute URL of the resource.

state str

The current state of the resource.

time_created str

The date and time the resource was created, expressed in RFC 3339 timestamp format.

time_updated str

The date and time the resource was last updated, expressed in RFC 3339 timestamp format.

id String

The provider-assigned unique ID for this managed resource.

self String

The canonical absolute URL of the resource.

state String

The current state of the resource.

timeCreated String

The date and time the resource was created, expressed in RFC 3339 timestamp format.

timeUpdated String

The date and time the resource was last updated, expressed in RFC 3339 timestamp format.

Look up Existing TsigKey Resource

Get an existing TsigKey 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?: TsigKeyState, opts?: CustomResourceOptions): TsigKey
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        algorithm: Optional[str] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        name: Optional[str] = None,
        secret: Optional[str] = None,
        self: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> TsigKey
func GetTsigKey(ctx *Context, name string, id IDInput, state *TsigKeyState, opts ...ResourceOption) (*TsigKey, error)
public static TsigKey Get(string name, Input<string> id, TsigKeyState? state, CustomResourceOptions? opts = null)
public static TsigKey get(String name, Output<String> id, TsigKeyState 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.
The following state arguments are supported:
Algorithm string

TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see RFC 4635.

CompartmentId string

(Updatable) The OCID of the compartment containing the TSIG key.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

FreeformTags Dictionary<string, object>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Name string

A globally unique domain name identifying the key for a given pair of hosts.

Secret string

A base64 string encoding the binary shared secret.

Self string

The canonical absolute URL of the resource.

State string

The current state of the resource.

TimeCreated string

The date and time the resource was created, expressed in RFC 3339 timestamp format.

TimeUpdated string

The date and time the resource was last updated, expressed in RFC 3339 timestamp format.

Algorithm string

TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see RFC 4635.

CompartmentId string

(Updatable) The OCID of the compartment containing the TSIG key.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

FreeformTags map[string]interface{}

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Name string

A globally unique domain name identifying the key for a given pair of hosts.

Secret string

A base64 string encoding the binary shared secret.

Self string

The canonical absolute URL of the resource.

State string

The current state of the resource.

TimeCreated string

The date and time the resource was created, expressed in RFC 3339 timestamp format.

TimeUpdated string

The date and time the resource was last updated, expressed in RFC 3339 timestamp format.

algorithm String

TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see RFC 4635.

compartmentId String

(Updatable) The OCID of the compartment containing the TSIG key.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeformTags Map<String,Object>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

name String

A globally unique domain name identifying the key for a given pair of hosts.

secret String

A base64 string encoding the binary shared secret.

self String

The canonical absolute URL of the resource.

state String

The current state of the resource.

timeCreated String

The date and time the resource was created, expressed in RFC 3339 timestamp format.

timeUpdated String

The date and time the resource was last updated, expressed in RFC 3339 timestamp format.

algorithm string

TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see RFC 4635.

compartmentId string

(Updatable) The OCID of the compartment containing the TSIG key.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeformTags {[key: string]: any}

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

name string

A globally unique domain name identifying the key for a given pair of hosts.

secret string

A base64 string encoding the binary shared secret.

self string

The canonical absolute URL of the resource.

state string

The current state of the resource.

timeCreated string

The date and time the resource was created, expressed in RFC 3339 timestamp format.

timeUpdated string

The date and time the resource was last updated, expressed in RFC 3339 timestamp format.

algorithm str

TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see RFC 4635.

compartment_id str

(Updatable) The OCID of the compartment containing the TSIG key.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeform_tags Mapping[str, Any]

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

name str

A globally unique domain name identifying the key for a given pair of hosts.

secret str

A base64 string encoding the binary shared secret.

self str

The canonical absolute URL of the resource.

state str

The current state of the resource.

time_created str

The date and time the resource was created, expressed in RFC 3339 timestamp format.

time_updated str

The date and time the resource was last updated, expressed in RFC 3339 timestamp format.

algorithm String

TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see RFC 4635.

compartmentId String

(Updatable) The OCID of the compartment containing the TSIG key.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeformTags Map<Any>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

name String

A globally unique domain name identifying the key for a given pair of hosts.

secret String

A base64 string encoding the binary shared secret.

self String

The canonical absolute URL of the resource.

state String

The current state of the resource.

timeCreated String

The date and time the resource was created, expressed in RFC 3339 timestamp format.

timeUpdated String

The date and time the resource was last updated, expressed in RFC 3339 timestamp format.

Import

TsigKeys can be imported using the id, e.g.

 $ pulumi import oci:Dns/tsigKey:TsigKey test_tsig_key "id"

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.