Skip to content

zoneDnssec.csharp.md

Latest commit

 

History

History
1144 lines (713 loc) · 44.4 KB

zoneDnssec.csharp.md

File metadata and controls

1144 lines (713 loc) · 44.4 KB
Raw

zoneDnssec Submodule

Constructs

ZoneDnssec

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/zone_dnssec cloudflare_zone_dnssec}.

Initializers 

using Io.Cdktn.Providers.Cloudflare;

new ZoneDnssec(Construct Scope, string Id, ZoneDnssecConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config ZoneDnssecConfig No description.
ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

ConfigRequired

Methods

Name Description
ToString Returns a string representation of this construct.
With Applies one or more mixins to this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform No description.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
AddMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
HasResourceMove No description.
ImportFrom No description.
InterpolationForAttribute No description.
MoveFromId Move the resource corresponding to "id" to this resource.
MoveTo Moves this resource to the target resource given by moveTarget.
MoveToId Moves this resource to the resource corresponding to "id".
ResetDnssecMultiSigner No description.
ResetDnssecPresigned No description.
ResetDnssecUseNsec3 No description.
ResetStatus No description.
ToString 
private string ToString()

Returns a string representation of this construct.

With 
private IConstruct With(params IMixin[] Mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

MixinsRequired
  • Type: params Constructs.IMixin[]

The mixins to apply.

AddOverride 
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string
ValueRequired
  • Type: object
OverrideLogicalId 
private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

NewLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

ResetOverrideLogicalId 
private void ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform 
private object ToHclTerraform()
ToMetadata 
private object ToMetadata()
ToTerraform 
private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget 
private void AddMoveTarget(string MoveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

MoveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

GetAnyMapAttribute 
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanAttribute 
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanMapAttribute 
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetListAttribute 
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberAttribute 
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberListAttribute 
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberMapAttribute 
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringAttribute 
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringMapAttribute 
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
HasResourceMove 
private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove()
ImportFrom 
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string
ProviderOptional
  • Type: Io.Cdktn.TerraformProvider
InterpolationForAttribute 
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
MoveFromId 
private void MoveFromId(string Id)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

IdRequired
  • Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

MoveTo 
private void MoveTo(string MoveTarget, string|double Index = null)

Moves this resource to the target resource given by moveTarget.

MoveTargetRequired
  • Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

IndexOptional
  • Type: string|double

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

MoveToId 
private void MoveToId(string Id)

Moves this resource to the resource corresponding to "id".

IdRequired
  • Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

ResetDnssecMultiSigner 
private void ResetDnssecMultiSigner()
ResetDnssecPresigned 
private void ResetDnssecPresigned()
ResetDnssecUseNsec3 
private void ResetDnssecUseNsec3()
ResetStatus 
private void ResetStatus()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTN code for importing a ZoneDnssec resource upon running "cdktn plan ".
IsConstruct 
using Io.Cdktn.Providers.Cloudflare;

ZoneDnssec.IsConstruct(object X);

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.

XRequired
  • Type: object

Any object.

IsTerraformElement 
using Io.Cdktn.Providers.Cloudflare;

ZoneDnssec.IsTerraformElement(object X);
XRequired
  • Type: object
IsTerraformResource 
using Io.Cdktn.Providers.Cloudflare;

ZoneDnssec.IsTerraformResource(object X);
XRequired
  • Type: object
GenerateConfigForImport 
using Io.Cdktn.Providers.Cloudflare;

ZoneDnssec.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

Generates CDKTN code for importing a ZoneDnssec resource upon running "cdktn plan ".

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

ImportToIdRequired
  • Type: string

The construct id used in the generated config for the ZoneDnssec to import.

ImportFromIdRequired
  • Type: string

The id of the existing ZoneDnssec that should be imported.

Refer to the {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/zone_dnssec#import import section} in the documentation of this resource for the id to use

ProviderOptional
  • Type: Io.Cdktn.TerraformProvider

? Optional instance of the provider where the ZoneDnssec to import is found.

Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack Io.Cdktn.TerraformStack No description.
Fqn string No description.
FriendlyUniqueId string No description.
TerraformMetaArguments System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata Io.Cdktn.TerraformProviderGeneratorMetadata No description.
Connection Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection No description.
Count double|Io.Cdktn.TerraformCount No description.
DependsOn string[] No description.
ForEach Io.Cdktn.ITerraformIterator No description.
Lifecycle Io.Cdktn.TerraformResourceLifecycle No description.
Provider Io.Cdktn.TerraformProvider No description.
Provisioners Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] No description.
Algorithm string No description.
Digest string No description.
DigestAlgorithm string No description.
DigestType string No description.
Ds string No description.
Flags double No description.
Id string No description.
KeyTag double No description.
KeyType string No description.
ModifiedOn string No description.
PublicKey string No description.
DnssecMultiSignerInput bool|Io.Cdktn.IResolvable No description.
DnssecPresignedInput bool|Io.Cdktn.IResolvable No description.
DnssecUseNsec3Input bool|Io.Cdktn.IResolvable No description.
StatusInput string No description.
ZoneIdInput string No description.
DnssecMultiSigner bool|Io.Cdktn.IResolvable No description.
DnssecPresigned bool|Io.Cdktn.IResolvable No description.
DnssecUseNsec3 bool|Io.Cdktn.IResolvable No description.
Status string No description.
ZoneId string No description.
NodeRequired 
public Node Node { get; }
  • Type: Constructs.Node

The tree node.

CdktfStackRequired 
public TerraformStack CdktfStack { get; }
  • Type: Io.Cdktn.TerraformStack
FqnRequired 
public string Fqn { get; }
  • Type: string
FriendlyUniqueIdRequired 
public string FriendlyUniqueId { get; }
  • Type: string
TerraformMetaArgumentsRequired 
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>
TerraformResourceTypeRequired 
public string TerraformResourceType { get; }
  • Type: string
TerraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: Io.Cdktn.TerraformProviderGeneratorMetadata
ConnectionOptional 
public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; }
  • Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection
CountOptional 
public double|TerraformCount Count { get; }
  • Type: double|Io.Cdktn.TerraformCount
DependsOnOptional 
public string[] DependsOn { get; }
  • Type: string[]
ForEachOptional 
public ITerraformIterator ForEach { get; }
  • Type: Io.Cdktn.ITerraformIterator
LifecycleOptional 
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: Io.Cdktn.TerraformResourceLifecycle
ProviderOptional 
public TerraformProvider Provider { get; }
  • Type: Io.Cdktn.TerraformProvider
ProvisionersOptional 
public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; }
  • Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]
AlgorithmRequired 
public string Algorithm { get; }
  • Type: string
DigestRequired 
public string Digest { get; }
  • Type: string
DigestAlgorithmRequired 
public string DigestAlgorithm { get; }
  • Type: string
DigestTypeRequired 
public string DigestType { get; }
  • Type: string
DsRequired 
public string Ds { get; }
  • Type: string
FlagsRequired 
public double Flags { get; }
  • Type: double
IdRequired 
public string Id { get; }
  • Type: string
KeyTagRequired 
public double KeyTag { get; }
  • Type: double
KeyTypeRequired 
public string KeyType { get; }
  • Type: string
ModifiedOnRequired 
public string ModifiedOn { get; }
  • Type: string
PublicKeyRequired 
public string PublicKey { get; }
  • Type: string
DnssecMultiSignerInputOptional 
public bool|IResolvable DnssecMultiSignerInput { get; }
  • Type: bool|Io.Cdktn.IResolvable
DnssecPresignedInputOptional 
public bool|IResolvable DnssecPresignedInput { get; }
  • Type: bool|Io.Cdktn.IResolvable
DnssecUseNsec3InputOptional 
public bool|IResolvable DnssecUseNsec3Input { get; }
  • Type: bool|Io.Cdktn.IResolvable
StatusInputOptional 
public string StatusInput { get; }
  • Type: string
ZoneIdInputOptional 
public string ZoneIdInput { get; }
  • Type: string
DnssecMultiSignerRequired 
public bool|IResolvable DnssecMultiSigner { get; }
  • Type: bool|Io.Cdktn.IResolvable
DnssecPresignedRequired 
public bool|IResolvable DnssecPresigned { get; }
  • Type: bool|Io.Cdktn.IResolvable
DnssecUseNsec3Required 
public bool|IResolvable DnssecUseNsec3 { get; }
  • Type: bool|Io.Cdktn.IResolvable
StatusRequired 
public string Status { get; }
  • Type: string
ZoneIdRequired 
public string ZoneId { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.
TfResourceTypeRequired 
public string TfResourceType { get; }
  • Type: string

Structs

ZoneDnssecConfig

Initializer 

using Io.Cdktn.Providers.Cloudflare;

new ZoneDnssecConfig {
    SSHProvisionerConnection|WinrmProvisionerConnection Connection = null,
    double|TerraformCount Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners = null,
    string ZoneId,
    bool|IResolvable DnssecMultiSigner = null,
    bool|IResolvable DnssecPresigned = null,
    bool|IResolvable DnssecUseNsec3 = null,
    string Status = null
};

Properties

Name Type Description
Connection Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection No description.
Count double|Io.Cdktn.TerraformCount No description.
DependsOn Io.Cdktn.ITerraformDependable[] No description.
ForEach Io.Cdktn.ITerraformIterator No description.
Lifecycle Io.Cdktn.TerraformResourceLifecycle No description.
Provider Io.Cdktn.TerraformProvider No description.
Provisioners Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] No description.
ZoneId string Identifier.
DnssecMultiSigner bool|Io.Cdktn.IResolvable If true, multi-signer DNSSEC is enabled on the zone, allowing multiple providers to serve a DNSSEC-signed zone at the same time.
DnssecPresigned bool|Io.Cdktn.IResolvable If true, allows Cloudflare to transfer in a DNSSEC-signed zone including signatures from an external provider, without requiring Cloudflare to sign any records on the fly.
DnssecUseNsec3 bool|Io.Cdktn.IResolvable If true, enables the use of NSEC3 together with DNSSEC on the zone.
Status string Status of DNSSEC, based on user-desired state and presence of necessary records. Available values: "active", "disabled".
ConnectionOptional 
public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; }
  • Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection
CountOptional 
public double|TerraformCount Count { get; set; }
  • Type: double|Io.Cdktn.TerraformCount
DependsOnOptional 
public ITerraformDependable[] DependsOn { get; set; }
  • Type: Io.Cdktn.ITerraformDependable[]
ForEachOptional 
public ITerraformIterator ForEach { get; set; }
  • Type: Io.Cdktn.ITerraformIterator
LifecycleOptional 
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: Io.Cdktn.TerraformResourceLifecycle
ProviderOptional 
public TerraformProvider Provider { get; set; }
  • Type: Io.Cdktn.TerraformProvider
ProvisionersOptional 
public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; }
  • Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]
ZoneIdRequired 
public string ZoneId { get; set; }
  • Type: string

Identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/zone_dnssec#zone_id ZoneDnssec#zone_id}

DnssecMultiSignerOptional 
public bool|IResolvable DnssecMultiSigner { get; set; }
  • Type: bool|Io.Cdktn.IResolvable

If true, multi-signer DNSSEC is enabled on the zone, allowing multiple providers to serve a DNSSEC-signed zone at the same time.

This is required for DNSKEY records (except those automatically generated by Cloudflare) to be added to the zone.

See Multi-signer DNSSEC for details.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/zone_dnssec#dnssec_multi_signer ZoneDnssec#dnssec_multi_signer}

DnssecPresignedOptional 
public bool|IResolvable DnssecPresigned { get; set; }
  • Type: bool|Io.Cdktn.IResolvable

If true, allows Cloudflare to transfer in a DNSSEC-signed zone including signatures from an external provider, without requiring Cloudflare to sign any records on the fly.

Note that this feature has some limitations. See Cloudflare as Secondary for details.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/zone_dnssec#dnssec_presigned ZoneDnssec#dnssec_presigned}

DnssecUseNsec3Optional 
public bool|IResolvable DnssecUseNsec3 { get; set; }
  • Type: bool|Io.Cdktn.IResolvable

If true, enables the use of NSEC3 together with DNSSEC on the zone.

Combined with setting dnssec_presigned to true, this enables the use of NSEC3 records when transferring in from an external provider. If dnssec_presigned is instead set to false (default), NSEC3 records will be generated and signed at request time.

See DNSSEC with NSEC3 for details.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/zone_dnssec#dnssec_use_nsec3 ZoneDnssec#dnssec_use_nsec3}

StatusOptional 
public string Status { get; set; }
  • Type: string

Status of DNSSEC, based on user-desired state and presence of necessary records. Available values: "active", "disabled".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/zone_dnssec#status ZoneDnssec#status}