Skip to content

Latest commit

 

History

History
2779 lines (1761 loc) · 125 KB

certificatePack.python.md

File metadata and controls

2779 lines (1761 loc) · 125 KB

certificatePack Submodule

Constructs

CertificatePack

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack cloudflare_certificate_pack}.

Initializers 

from cdktf_cdktf_provider_cloudflare import certificate_pack

certificatePack.CertificatePack(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[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[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  certificate_authority: str,
  hosts: typing.List[str],
  type: str,
  validation_method: str,
  validity_days: typing.Union[int, float],
  zone_id: str,
  cloudflare_branding: typing.Union[bool, IResolvable] = None,
  id: str = None,
  validation_errors: typing.Union[IResolvable, typing.List[CertificatePackValidationErrors]] = None,
  validation_records: typing.Union[IResolvable, typing.List[CertificatePackValidationRecords]] = None,
  wait_for_active_status: typing.Union[bool, IResolvable] = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
certificate_authority str Which certificate authority to issue the certificate pack.
hosts typing.List[str] List of hostnames to provision the certificate pack for.
type str Certificate pack configuration type. Available values: advanced. Modifying this attribute will force creation of a new resource..
validation_method str Which validation method to use in order to prove domain ownership.
validity_days typing.Union[int, float] How long the certificate is valid for.
zone_id str The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource..
cloudflare_branding typing.Union[bool, cdktf.IResolvable] Whether or not to include Cloudflare branding.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#id CertificatePack#id}.
validation_errors typing.Union[cdktf.IResolvable, typing.List[CertificatePackValidationErrors]] validation_errors block.
validation_records typing.Union[cdktf.IResolvable, typing.List[CertificatePackValidationRecords]] validation_records block.
wait_for_active_status typing.Union[bool, cdktf.IResolvable] Whether or not to wait for a certificate pack to reach status active during creation.
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: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
certificate_authorityRequired
  • Type: str

Which certificate authority to issue the certificate pack.

Available values: digicert, lets_encrypt, google, ssl_com. Modifying this attribute will force creation of a new resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#certificate_authority CertificatePack#certificate_authority}

hostsRequired
  • Type: typing.List[str]

List of hostnames to provision the certificate pack for.

The zone name must be included as a host. Note: If using Let's Encrypt, you cannot use individual subdomains and only a wildcard for subdomain is available. Modifying this attribute will force creation of a new resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#hosts CertificatePack#hosts}

typeRequired
  • Type: str

Certificate pack configuration type. Available values: advanced. Modifying this attribute will force creation of a new resource..

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#type CertificatePack#type}

validation_methodRequired
  • Type: str

Which validation method to use in order to prove domain ownership.

Available values: txt, http, email. Modifying this attribute will force creation of a new resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#validation_method CertificatePack#validation_method}

validity_daysRequired
  • Type: typing.Union[int, float]

How long the certificate is valid for.

Note: If using Let's Encrypt, this value can only be 90 days. Available values: 14, 30, 90, 365. Modifying this attribute will force creation of a new resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#validity_days CertificatePack#validity_days}

zone_idRequired
  • Type: str

The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource..

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#zone_id CertificatePack#zone_id}

cloudflare_brandingOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether or not to include Cloudflare branding.

This will add sni.cloudflaressl.com as the Common Name if set to true. Modifying this attribute will force creation of a new resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#cloudflare_branding CertificatePack#cloudflare_branding}

idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#id CertificatePack#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

validation_errorsOptional

validation_errors block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#validation_errors CertificatePack#validation_errors}

validation_recordsOptional

validation_records block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#validation_records CertificatePack#validation_records}

wait_for_active_statusOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether or not to wait for a certificate pack to reach status active during creation.

Defaults to false. Modifying this attribute will force creation of a new resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#wait_for_active_status CertificatePack#wait_for_active_status}

Methods

Name Description
to_string Returns a string representation of 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".
put_validation_errors No description.
put_validation_records No description.
reset_cloudflare_branding No description.
reset_id No description.
reset_validation_errors No description.
reset_validation_records No description.
reset_wait_for_active_status No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

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() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.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: typing.Union[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: typing.Union[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".

put_validation_errors 
def put_validation_errors(
  value: typing.Union[IResolvable, typing.List[CertificatePackValidationErrors]]
) -> None
valueRequired
put_validation_records 
def put_validation_records(
  value: typing.Union[IResolvable, typing.List[CertificatePackValidationRecords]]
) -> None
valueRequired
reset_cloudflare_branding 
def reset_cloudflare_branding() -> None
reset_id 
def reset_id() -> None
reset_validation_errors 
def reset_validation_errors() -> None
reset_validation_records 
def reset_validation_records() -> None
reset_wait_for_active_status 
def reset_wait_for_active_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 CDKTF code for importing a CertificatePack resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_cloudflare import certificate_pack

certificatePack.CertificatePack.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 cdktf_cdktf_provider_cloudflare import certificate_pack

certificatePack.CertificatePack.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_cloudflare import certificate_pack

certificatePack.CertificatePack.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_cloudflare import certificate_pack

certificatePack.CertificatePack.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTF code for importing a CertificatePack resource upon running "cdktf 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 CertificatePack to import.

import_from_idRequired
  • Type: str

The id of the existing CertificatePack that should be imported.

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

providerOptional
  • Type: cdktf.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.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 cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
validation_errors CertificatePackValidationErrorsList No description.
validation_records CertificatePackValidationRecordsList No description.
certificate_authority_input str No description.
cloudflare_branding_input typing.Union[bool, cdktf.IResolvable] No description.
hosts_input typing.List[str] No description.
id_input str No description.
type_input str No description.
validation_errors_input typing.Union[cdktf.IResolvable, typing.List[CertificatePackValidationErrors]] No description.
validation_method_input str No description.
validation_records_input typing.Union[cdktf.IResolvable, typing.List[CertificatePackValidationRecords]] No description.
validity_days_input typing.Union[int, float] No description.
wait_for_active_status_input typing.Union[bool, cdktf.IResolvable] No description.
zone_id_input str No description.
certificate_authority str No description.
cloudflare_branding typing.Union[bool, cdktf.IResolvable] No description.
hosts typing.List[str] No description.
id str No description.
type str No description.
validation_method str No description.
validity_days typing.Union[int, float] No description.
wait_for_active_status typing.Union[bool, cdktf.IResolvable] No description.
zone_id str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.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: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
validation_errorsRequired 
validation_errors: CertificatePackValidationErrorsList
validation_recordsRequired 
validation_records: CertificatePackValidationRecordsList
certificate_authority_inputOptional 
certificate_authority_input: str
  • Type: str
cloudflare_branding_inputOptional 
cloudflare_branding_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
hosts_inputOptional 
hosts_input: typing.List[str]
  • Type: typing.List[str]
id_inputOptional 
id_input: str
  • Type: str
type_inputOptional 
type_input: str
  • Type: str
validation_errors_inputOptional 
validation_errors_input: typing.Union[IResolvable, typing.List[CertificatePackValidationErrors]]
validation_method_inputOptional 
validation_method_input: str
  • Type: str
validation_records_inputOptional 
validation_records_input: typing.Union[IResolvable, typing.List[CertificatePackValidationRecords]]
validity_days_inputOptional 
validity_days_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
wait_for_active_status_inputOptional 
wait_for_active_status_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
zone_id_inputOptional 
zone_id_input: str
  • Type: str
certificate_authorityRequired 
certificate_authority: str
  • Type: str
cloudflare_brandingRequired 
cloudflare_branding: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
hostsRequired 
hosts: typing.List[str]
  • Type: typing.List[str]
idRequired 
id: str
  • Type: str
typeRequired 
type: str
  • Type: str
validation_methodRequired 
validation_method: str
  • Type: str
validity_daysRequired 
validity_days: typing.Union[int, float]
  • Type: typing.Union[int, float]
wait_for_active_statusRequired 
wait_for_active_status: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
zone_idRequired 
zone_id: str
  • Type: str

Constants

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

Structs

CertificatePackConfig

Initializer 

from cdktf_cdktf_provider_cloudflare import certificate_pack

certificatePack.CertificatePackConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[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[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  certificate_authority: str,
  hosts: typing.List[str],
  type: str,
  validation_method: str,
  validity_days: typing.Union[int, float],
  zone_id: str,
  cloudflare_branding: typing.Union[bool, IResolvable] = None,
  id: str = None,
  validation_errors: typing.Union[IResolvable, typing.List[CertificatePackValidationErrors]] = None,
  validation_records: typing.Union[IResolvable, typing.List[CertificatePackValidationRecords]] = None,
  wait_for_active_status: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
certificate_authority str Which certificate authority to issue the certificate pack.
hosts typing.List[str] List of hostnames to provision the certificate pack for.
type str Certificate pack configuration type. Available values: advanced. Modifying this attribute will force creation of a new resource..
validation_method str Which validation method to use in order to prove domain ownership.
validity_days typing.Union[int, float] How long the certificate is valid for.
zone_id str The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource..
cloudflare_branding typing.Union[bool, cdktf.IResolvable] Whether or not to include Cloudflare branding.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#id CertificatePack#id}.
validation_errors typing.Union[cdktf.IResolvable, typing.List[CertificatePackValidationErrors]] validation_errors block.
validation_records typing.Union[cdktf.IResolvable, typing.List[CertificatePackValidationRecords]] validation_records block.
wait_for_active_status typing.Union[bool, cdktf.IResolvable] Whether or not to wait for a certificate pack to reach status active during creation.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
certificate_authorityRequired 
certificate_authority: str
  • Type: str

Which certificate authority to issue the certificate pack.

Available values: digicert, lets_encrypt, google, ssl_com. Modifying this attribute will force creation of a new resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#certificate_authority CertificatePack#certificate_authority}

hostsRequired 
hosts: typing.List[str]
  • Type: typing.List[str]

List of hostnames to provision the certificate pack for.

The zone name must be included as a host. Note: If using Let's Encrypt, you cannot use individual subdomains and only a wildcard for subdomain is available. Modifying this attribute will force creation of a new resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#hosts CertificatePack#hosts}

typeRequired 
type: str
  • Type: str

Certificate pack configuration type. Available values: advanced. Modifying this attribute will force creation of a new resource..

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#type CertificatePack#type}

validation_methodRequired 
validation_method: str
  • Type: str

Which validation method to use in order to prove domain ownership.

Available values: txt, http, email. Modifying this attribute will force creation of a new resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#validation_method CertificatePack#validation_method}

validity_daysRequired 
validity_days: typing.Union[int, float]
  • Type: typing.Union[int, float]

How long the certificate is valid for.

Note: If using Let's Encrypt, this value can only be 90 days. Available values: 14, 30, 90, 365. Modifying this attribute will force creation of a new resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#validity_days CertificatePack#validity_days}

zone_idRequired 
zone_id: str
  • Type: str

The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource..

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#zone_id CertificatePack#zone_id}

cloudflare_brandingOptional 
cloudflare_branding: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether or not to include Cloudflare branding.

This will add sni.cloudflaressl.com as the Common Name if set to true. Modifying this attribute will force creation of a new resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#cloudflare_branding CertificatePack#cloudflare_branding}

idOptional 
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#id CertificatePack#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

validation_errorsOptional 
validation_errors: typing.Union[IResolvable, typing.List[CertificatePackValidationErrors]]

validation_errors block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#validation_errors CertificatePack#validation_errors}

validation_recordsOptional 
validation_records: typing.Union[IResolvable, typing.List[CertificatePackValidationRecords]]

validation_records block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#validation_records CertificatePack#validation_records}

wait_for_active_statusOptional 
wait_for_active_status: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether or not to wait for a certificate pack to reach status active during creation.

Defaults to false. Modifying this attribute will force creation of a new resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#wait_for_active_status CertificatePack#wait_for_active_status}

CertificatePackValidationErrors

Initializer 

from cdktf_cdktf_provider_cloudflare import certificate_pack

certificatePack.CertificatePackValidationErrors()

CertificatePackValidationRecords

Initializer 

from cdktf_cdktf_provider_cloudflare import certificate_pack

certificatePack.CertificatePackValidationRecords(
  cname_name: str = None,
  cname_target: str = None,
  emails: typing.List[str] = None,
  http_body: str = None,
  http_url: str = None,
  txt_name: str = None,
  txt_value: str = None
)

Properties

Name Type Description
cname_name str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#cname_name CertificatePack#cname_name}.
cname_target str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#cname_target CertificatePack#cname_target}.
emails typing.List[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#emails CertificatePack#emails}.
http_body str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#http_body CertificatePack#http_body}.
http_url str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#http_url CertificatePack#http_url}.
txt_name str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#txt_name CertificatePack#txt_name}.
txt_value str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#txt_value CertificatePack#txt_value}.
cname_nameOptional 
cname_name: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#cname_name CertificatePack#cname_name}.

cname_targetOptional 
cname_target: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#cname_target CertificatePack#cname_target}.

emailsOptional 
emails: typing.List[str]
  • Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#emails CertificatePack#emails}.

http_bodyOptional 
http_body: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#http_body CertificatePack#http_body}.

http_urlOptional 
http_url: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#http_url CertificatePack#http_url}.

txt_nameOptional 
txt_name: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#txt_name CertificatePack#txt_name}.

txt_valueOptional 
txt_value: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/certificate_pack#txt_value CertificatePack#txt_value}.

Classes

CertificatePackValidationErrorsList

Initializers 

from cdktf_cdktf_provider_cloudflare import certificate_pack

certificatePack.CertificatePackValidationErrorsList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.
all_with_map_key 
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str
compute_fqn 
def compute_fqn() -> str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
def get(
  index: typing.Union[int, float]
) -> CertificatePackValidationErrorsOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
internal_value typing.Union[cdktf.IResolvable, typing.List[CertificatePackValidationErrors]] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, typing.List[CertificatePackValidationErrors]]

CertificatePackValidationErrorsOutputReference

Initializers 

from cdktf_cdktf_provider_cloudflare import certificate_pack

certificatePack.CertificatePackValidationErrorsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

complex_object_indexRequired
  • Type: typing.Union[int, float]

the index of this item in the list.

complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
compute_fqn No description.
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.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
compute_fqn 
def compute_fqn() -> str
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
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
message str No description.
internal_value typing.Union[cdktf.IResolvable, CertificatePackValidationErrors] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
messageRequired 
message: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, CertificatePackValidationErrors]

CertificatePackValidationRecordsList

Initializers 

from cdktf_cdktf_provider_cloudflare import certificate_pack

certificatePack.CertificatePackValidationRecordsList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.
all_with_map_key 
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str
compute_fqn 
def compute_fqn() -> str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
def get(
  index: typing.Union[int, float]
) -> CertificatePackValidationRecordsOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
internal_value typing.Union[cdktf.IResolvable, typing.List[CertificatePackValidationRecords]] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, typing.List[CertificatePackValidationRecords]]

CertificatePackValidationRecordsOutputReference

Initializers 

from cdktf_cdktf_provider_cloudflare import certificate_pack

certificatePack.CertificatePackValidationRecordsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

complex_object_indexRequired
  • Type: typing.Union[int, float]

the index of this item in the list.

complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
compute_fqn No description.
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.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_cname_name No description.
reset_cname_target No description.
reset_emails No description.
reset_http_body No description.
reset_http_url No description.
reset_txt_name No description.
reset_txt_value No description.
compute_fqn 
def compute_fqn() -> str
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
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_cname_name 
def reset_cname_name() -> None
reset_cname_target 
def reset_cname_target() -> None
reset_emails 
def reset_emails() -> None
reset_http_body 
def reset_http_body() -> None
reset_http_url 
def reset_http_url() -> None
reset_txt_name 
def reset_txt_name() -> None
reset_txt_value 
def reset_txt_value() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
cname_name_input str No description.
cname_target_input str No description.
emails_input typing.List[str] No description.
http_body_input str No description.
http_url_input str No description.
txt_name_input str No description.
txt_value_input str No description.
cname_name str No description.
cname_target str No description.
emails typing.List[str] No description.
http_body str No description.
http_url str No description.
txt_name str No description.
txt_value str No description.
internal_value typing.Union[cdktf.IResolvable, CertificatePackValidationRecords] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
cname_name_inputOptional 
cname_name_input: str
  • Type: str
cname_target_inputOptional 
cname_target_input: str
  • Type: str
emails_inputOptional 
emails_input: typing.List[str]
  • Type: typing.List[str]
http_body_inputOptional 
http_body_input: str
  • Type: str
http_url_inputOptional 
http_url_input: str
  • Type: str
txt_name_inputOptional 
txt_name_input: str
  • Type: str
txt_value_inputOptional 
txt_value_input: str
  • Type: str
cname_nameRequired 
cname_name: str
  • Type: str
cname_targetRequired 
cname_target: str
  • Type: str
emailsRequired 
emails: typing.List[str]
  • Type: typing.List[str]
http_bodyRequired 
http_body: str
  • Type: str
http_urlRequired 
http_url: str
  • Type: str
txt_nameRequired 
txt_name: str
  • Type: str
txt_valueRequired 
txt_value: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, CertificatePackValidationRecords]