Skip to content

zoneDnssec.python.md

Latest commit

 

History

History
1321 lines (842 loc) · 51.5 KB

zoneDnssec.python.md

File metadata and controls

1321 lines (842 loc) · 51.5 KB

zoneDnssec Submodule

Constructs

ZoneDnssec

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

Initializers 

from cdktn_provider_cloudflare import zone_dnssec

zoneDnssec.ZoneDnssec(
  scope: Construct,
  id: str,
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  zone_id: str,
  dnssec_multi_signer: bool | IResolvable = None,
  dnssec_presigned: bool | IResolvable = None,
  dnssec_use_nsec3: bool | IResolvable = None,
  status: str = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[cdktn.ITerraformDependable] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
zone_id str Identifier.
dnssec_multi_signer bool | 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.
dnssec_presigned bool | 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.
dnssec_use_nsec3 bool | cdktn.IResolvable If true, enables the use of NSEC3 together with DNSSEC on the zone.
status str Status of DNSSEC, based on user-desired state and presence of necessary records. Available values: "active", "disabled".
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
countOptional
  • Type: typing.Union[int, float] | cdktn.TerraformCount
depends_onOptional
  • Type: typing.List[cdktn.ITerraformDependable]
for_eachOptional
  • Type: cdktn.ITerraformIterator
lifecycleOptional
  • Type: cdktn.TerraformResourceLifecycle
providerOptional
  • Type: cdktn.TerraformProvider
provisionersOptional
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
zone_idRequired
  • Type: str

Identifier.

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

dnssec_multi_signerOptional
  • Type: bool | 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.19.1/docs/resources/zone_dnssec#dnssec_multi_signer ZoneDnssec#dnssec_multi_signer}

dnssec_presignedOptional
  • Type: bool | 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.19.1/docs/resources/zone_dnssec#dnssec_presigned ZoneDnssec#dnssec_presigned}

dnssec_use_nsec3Optional
  • Type: bool | 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.19.1/docs/resources/zone_dnssec#dnssec_use_nsec3 ZoneDnssec#dnssec_use_nsec3}

statusOptional
  • Type: str

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.19.1/docs/resources/zone_dnssec#status ZoneDnssec#status}

Methods

Name Description
to_string Returns a string representation of this construct.
with Applies one or more mixins to this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
reset_dnssec_multi_signer No description.
reset_dnssec_presigned No description.
reset_dnssec_use_nsec3 No description.
reset_status No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

with 
def with(
  mixins: *IMixin
) -> IConstruct

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: *constructs.IMixin

The mixins to apply.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

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

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

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

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveById
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktn.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

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: str

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

move_to 
def move_to(
  move_target: str,
  index: str | typing.Union[int, float] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

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

indexOptional
  • Type: str | typing.Union[int, float]

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

move_to_id 
def move_to_id(
  id: str
) -> None

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

idRequired
  • Type: str

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

reset_dnssec_multi_signer 
def reset_dnssec_multi_signer() -> None
reset_dnssec_presigned 
def reset_dnssec_presigned() -> None
reset_dnssec_use_nsec3 
def reset_dnssec_use_nsec3() -> None
reset_status 
def reset_status() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTN code for importing a ZoneDnssec resource upon running "cdktn plan ".
is_construct 
from cdktn_provider_cloudflare import zone_dnssec

zoneDnssec.ZoneDnssec.is_construct(
  x: typing.Any
)

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: typing.Any

Any object.

is_terraform_element 
from cdktn_provider_cloudflare import zone_dnssec

zoneDnssec.ZoneDnssec.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktn_provider_cloudflare import zone_dnssec

zoneDnssec.ZoneDnssec.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktn_provider_cloudflare import zone_dnssec

zoneDnssec.ZoneDnssec.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

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

import_from_idRequired
  • Type: str

The id of the existing ZoneDnssec that should be imported.

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

providerOptional
  • Type: cdktn.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktn.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktn.TerraformProviderGeneratorMetadata No description.
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[str] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
algorithm str No description.
digest str No description.
digest_algorithm str No description.
digest_type str No description.
ds str No description.
flags typing.Union[int, float] No description.
id str No description.
key_tag typing.Union[int, float] No description.
key_type str No description.
modified_on str No description.
public_key str No description.
dnssec_multi_signer_input bool | cdktn.IResolvable No description.
dnssec_presigned_input bool | cdktn.IResolvable No description.
dnssec_use_nsec3_input bool | cdktn.IResolvable No description.
status_input str No description.
zone_id_input str No description.
dnssec_multi_signer bool | cdktn.IResolvable No description.
dnssec_presigned bool | cdktn.IResolvable No description.
dnssec_use_nsec3 bool | cdktn.IResolvable No description.
status str No description.
zone_id str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktn.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktn.TerraformProviderGeneratorMetadata
connectionOptional 
connection: SSHProvisionerConnection | WinrmProvisionerConnection
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
countOptional 
count: typing.Union[int, float] | TerraformCount
  • Type: typing.Union[int, float] | cdktn.TerraformCount
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktn.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktn.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktn.TerraformProvider
provisionersOptional 
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
algorithmRequired 
algorithm: str
  • Type: str
digestRequired 
digest: str
  • Type: str
digest_algorithmRequired 
digest_algorithm: str
  • Type: str
digest_typeRequired 
digest_type: str
  • Type: str
dsRequired 
ds: str
  • Type: str
flagsRequired 
flags: typing.Union[int, float]
  • Type: typing.Union[int, float]
idRequired 
id: str
  • Type: str
key_tagRequired 
key_tag: typing.Union[int, float]
  • Type: typing.Union[int, float]
key_typeRequired 
key_type: str
  • Type: str
modified_onRequired 
modified_on: str
  • Type: str
public_keyRequired 
public_key: str
  • Type: str
dnssec_multi_signer_inputOptional 
dnssec_multi_signer_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
dnssec_presigned_inputOptional 
dnssec_presigned_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
dnssec_use_nsec3_inputOptional 
dnssec_use_nsec3_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
status_inputOptional 
status_input: str
  • Type: str
zone_id_inputOptional 
zone_id_input: str
  • Type: str
dnssec_multi_signerRequired 
dnssec_multi_signer: bool | IResolvable
  • Type: bool | cdktn.IResolvable
dnssec_presignedRequired 
dnssec_presigned: bool | IResolvable
  • Type: bool | cdktn.IResolvable
dnssec_use_nsec3Required 
dnssec_use_nsec3: bool | IResolvable
  • Type: bool | cdktn.IResolvable
statusRequired 
status: str
  • Type: str
zone_idRequired 
zone_id: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

ZoneDnssecConfig

Initializer 

from cdktn_provider_cloudflare import zone_dnssec

zoneDnssec.ZoneDnssecConfig(
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  zone_id: str,
  dnssec_multi_signer: bool | IResolvable = None,
  dnssec_presigned: bool | IResolvable = None,
  dnssec_use_nsec3: bool | IResolvable = None,
  status: str = None
)

Properties

Name Type Description
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[cdktn.ITerraformDependable] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
zone_id str Identifier.
dnssec_multi_signer bool | 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.
dnssec_presigned bool | 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.
dnssec_use_nsec3 bool | cdktn.IResolvable If true, enables the use of NSEC3 together with DNSSEC on the zone.
status str Status of DNSSEC, based on user-desired state and presence of necessary records. Available values: "active", "disabled".
connectionOptional 
connection: SSHProvisionerConnection | WinrmProvisionerConnection
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
countOptional 
count: typing.Union[int, float] | TerraformCount
  • Type: typing.Union[int, float] | cdktn.TerraformCount
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktn.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktn.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktn.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktn.TerraformProvider
provisionersOptional 
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
zone_idRequired 
zone_id: str
  • Type: str

Identifier.

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

dnssec_multi_signerOptional 
dnssec_multi_signer: bool | IResolvable
  • Type: bool | 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.19.1/docs/resources/zone_dnssec#dnssec_multi_signer ZoneDnssec#dnssec_multi_signer}

dnssec_presignedOptional 
dnssec_presigned: bool | IResolvable
  • Type: bool | 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.19.1/docs/resources/zone_dnssec#dnssec_presigned ZoneDnssec#dnssec_presigned}

dnssec_use_nsec3Optional 
dnssec_use_nsec3: bool | IResolvable
  • Type: bool | 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.19.1/docs/resources/zone_dnssec#dnssec_use_nsec3 ZoneDnssec#dnssec_use_nsec3}

statusOptional 
status: str
  • Type: str

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.19.1/docs/resources/zone_dnssec#status ZoneDnssec#status}