provider

README

provider

Refer to the Terraform Registory for docs: dns.

Documentation

Index

• func DnsProvider_IsConstruct(x interface{}) *bool
• func DnsProvider_IsTerraformElement(x interface{}) *bool
• func DnsProvider_IsTerraformProvider(x interface{}) *bool
• func DnsProvider_TfResourceType() *string
• func NewDnsProvider_Override(d DnsProvider, scope constructs.Construct, id *string, ...)
• type DnsProvider
  • func NewDnsProvider(scope constructs.Construct, id *string, config *DnsProviderConfig) DnsProvider
• type DnsProviderConfig
• type DnsProviderUpdate
• type DnsProviderUpdateGssapi

Functions

func DnsProvider_IsConstruct

func DnsProvider_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func DnsProvider_IsTerraformElement

func DnsProvider_IsTerraformElement(x interface{}) *bool

Experimental.

func DnsProvider_IsTerraformProvider

func DnsProvider_IsTerraformProvider(x interface{}) *bool

Experimental.

func DnsProvider_TfResourceType

func DnsProvider_TfResourceType() *string

func NewDnsProvider_Override

func NewDnsProvider_Override(d DnsProvider, scope constructs.Construct, id *string, config *DnsProviderConfig)

Create a new {@link https://registry.terraform.io/providers/hashicorp/dns/3.3.2/docs dns} Resource.

Types

type DnsProvider

type DnsProvider interface {
	cdktf.TerraformProvider
	Alias() *string
	SetAlias(val *string)
	AliasInput() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	// Experimental.
	MetaAttributes() *map[string]interface{}
	// The tree node.
	Node() constructs.Node
	// Experimental.
	RawOverrides() interface{}
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformProviderSource() *string
	// Experimental.
	TerraformResourceType() *string
	Update() interface{}
	SetUpdate(val interface{})
	UpdateInput() interface{}
	// Experimental.
	AddOverride(path *string, value interface{})
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetAlias()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetUpdate()
	SynthesizeAttributes() *map[string]interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://registry.terraform.io/providers/hashicorp/dns/3.3.2/docs dns}.

func NewDnsProvider

func NewDnsProvider(scope constructs.Construct, id *string, config *DnsProviderConfig) DnsProvider

Create a new {@link https://registry.terraform.io/providers/hashicorp/dns/3.3.2/docs dns} Resource.

type DnsProviderConfig

type DnsProviderConfig struct {
	// Alias name.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/dns/3.3.2/docs#alias DnsProvider#alias}
	Alias *string `field:"optional" json:"alias" yaml:"alias"`
	// update block.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/dns/3.3.2/docs#update DnsProvider#update}
	Update interface{} `field:"optional" json:"update" yaml:"update"`
}

type DnsProviderUpdate

type DnsProviderUpdate struct {
	// gssapi block.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/dns/3.3.2/docs#gssapi DnsProvider#gssapi}
	Gssapi interface{} `field:"optional" json:"gssapi" yaml:"gssapi"`
	// Required if `key_name` is set.
	//
	// When using TSIG authentication, the algorithm to use for HMAC. Valid values are `hmac-md5`, `hmac-sha1`, `hmac-sha256` or `hmac-sha512`. Value can also be sourced from the DNS_UPDATE_KEYALGORITHM environment variable.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/dns/3.3.2/docs#key_algorithm DnsProvider#key_algorithm}
	KeyAlgorithm *string `field:"optional" json:"keyAlgorithm" yaml:"keyAlgorithm"`
	// The name of the TSIG key used to sign the DNS update messages.
	//
	// Value can also be sourced from the DNS_UPDATE_KEYNAME environment variable.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/dns/3.3.2/docs#key_name DnsProvider#key_name}
	KeyName *string `field:"optional" json:"keyName" yaml:"keyName"`
	// Required if `key_name` is set A Base64-encoded string containing the shared secret to be used for TSIG.
	//
	// Value can also be sourced from the DNS_UPDATE_KEYSECRET environment variable.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/dns/3.3.2/docs#key_secret DnsProvider#key_secret}
	KeySecret *string `field:"optional" json:"keySecret" yaml:"keySecret"`
	// The target UDP port on the server where updates are sent to.
	//
	// Defaults to `53`. Value can also be sourced from the DNS_UPDATE_PORT environment variable.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/dns/3.3.2/docs#port DnsProvider#port}
	Port *float64 `field:"optional" json:"port" yaml:"port"`
	// How many times to retry on connection timeout.
	//
	// Defaults to `3`. Value can also be sourced from the DNS_UPDATE_RETRIES environment variable.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/dns/3.3.2/docs#retries DnsProvider#retries}
	Retries *float64 `field:"optional" json:"retries" yaml:"retries"`
	// The hostname or IP address of the DNS server to send updates to.
	//
	// Value can also be sourced from the DNS_UPDATE_SERVER environment variable.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/dns/3.3.2/docs#server DnsProvider#server}
	Server *string `field:"optional" json:"server" yaml:"server"`
	// Timeout for DNS queries.
	//
	// Valid values are durations expressed as `500ms`, etc. or a plain number which is treated as whole seconds. Value can also be sourced from the DNS_UPDATE_TIMEOUT environment variable.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/dns/3.3.2/docs#timeout DnsProvider#timeout}
	Timeout *string `field:"optional" json:"timeout" yaml:"timeout"`
	// Transport to use for DNS queries.
	//
	// Valid values are `udp`, `udp4`, `udp6`, `tcp`, `tcp4`, or `tcp6`. Any UDP transport will retry automatically with the equivalent TCP transport in the event of a truncated response. Defaults to `udp`. Value can also be sourced from the DNS_UPDATE_TRANSPORT environment variable.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/dns/3.3.2/docs#transport DnsProvider#transport}
	Transport *string `field:"optional" json:"transport" yaml:"transport"`
}

type DnsProviderUpdateGssapi

type DnsProviderUpdateGssapi struct {
	// This or `password` is required if `username` is set, not supported on Windows.
	//
	// The path to a keytab file containing a key for `username`. Value can also be sourced from the DNS_UPDATE_KEYTAB environment variable.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/dns/3.3.2/docs#keytab DnsProvider#keytab}
	Keytab *string `field:"optional" json:"keytab" yaml:"keytab"`
	// This or `keytab` is required if `username` is set.
	//
	// The matching password for `username`. Value can also be sourced from the DNS_UPDATE_PASSWORD environment variable.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/dns/3.3.2/docs#password DnsProvider#password}
	Password *string `field:"optional" json:"password" yaml:"password"`
	// The Kerberos realm or Active Directory domain. Value can also be sourced from the DNS_UPDATE_REALM environment variable.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/dns/3.3.2/docs#realm DnsProvider#realm}
	Realm *string `field:"optional" json:"realm" yaml:"realm"`
	// The name of the user to authenticate as.
	//
	// If not set the current user session will be used. Value can also be sourced from the DNS_UPDATE_USERNAME environment variable.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/dns/3.3.2/docs#username DnsProvider#username}
	Username *string `field:"optional" json:"username" yaml:"username"`
}