Pulumi Cloudflare

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-cloudflare repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-cloudflare repo.

class pulumi_cloudflare.AccessApplication(resource_name, opts=None, domain=None, name=None, session_duration=None, zone_id=None, __props__=None, __name__=None, __opts__=None)

Provides a Cloudflare Access Application resource. Access Applications are used to restrict access to a whole application using an authorisation gateway managed by Cloudflare.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • domain (pulumi.Input[str]) – The complete URL of the asset you wish to put Cloudflare Access in front of. Can include subdomains or paths. Or both.

  • name (pulumi.Input[str]) – Friendly name of the Access Application.

  • session_duration (pulumi.Input[str]) – How often a user will be forced to re-authorise. Must be one of 30m, 6h, 12h, 24h, 168h, 730h.

  • zone_id (pulumi.Input[str]) – The DNS zone to which the access rule should be added.

domain = None

The complete URL of the asset you wish to put Cloudflare Access in front of. Can include subdomains or paths. Or both.

name = None

Friendly name of the Access Application.

session_duration = None

How often a user will be forced to re-authorise. Must be one of 30m, 6h, 12h, 24h, 168h, 730h.

zone_id = None

The DNS zone to which the access rule should be added.

static get(resource_name, id, opts=None, aud=None, domain=None, name=None, session_duration=None, zone_id=None)

Get an existing AccessApplication resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • domain (pulumi.Input[str]) – The complete URL of the asset you wish to put Cloudflare Access in front of. Can include subdomains or paths. Or both.

  • name (pulumi.Input[str]) – Friendly name of the Access Application.

  • session_duration (pulumi.Input[str]) – How often a user will be forced to re-authorise. Must be one of 30m, 6h, 12h, 24h, 168h, 730h.

  • zone_id (pulumi.Input[str]) – The DNS zone to which the access rule should be added.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_cloudflare.AccessPolicy(resource_name, opts=None, application_id=None, decision=None, excludes=None, includes=None, name=None, precedence=None, requires=None, zone_id=None, __props__=None, __name__=None, __opts__=None)

Provides a Cloudflare Access Policy resource. Access Policies are used in conjunction with Access Applications to restrict access to a particular resource.

require, exclude and include arguments share the available conditions which can be applied. The conditions are:

  • ip - (Optional) A list of IP addresses or ranges. Example: ip = ["1.2.3.4", "10.0.0.0/2"]

  • email - (Optional) A list of email addresses. Example: email = ["test@example.com"]

  • email_domain - (Optional) A list of email domains. Example: email_domain = ["example.com"]

  • everyone - (Optional) Boolean indicating permitting access for all requests. Example: everyone = true

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • application_id (pulumi.Input[str]) – The ID of the application the policy is associated with.

  • decision (pulumi.Input[str]) – Defines the action Access will take if the policy matches the user. Allowed values: allow, deny, bypass

  • excludes (pulumi.Input[list]) – A series of access conditions, see below for full list.

  • includes (pulumi.Input[list]) – A series of access conditions, see below for full list.

  • name (pulumi.Input[str]) – Friendly name of the Access Application.

  • precedence (pulumi.Input[float]) – The unique precedence for policies on a single application. Integer.

  • requires (pulumi.Input[list]) – A series of access conditions, see below for full list.

  • zone_id (pulumi.Input[str]) – The DNS zone to which the access rule should be added.

The excludes object supports the following:

  • emails (pulumi.Input[list])

  • emailDomains (pulumi.Input[list])

  • everyone (pulumi.Input[bool])

  • ips (pulumi.Input[list])

The includes object supports the following:

  • emails (pulumi.Input[list])

  • emailDomains (pulumi.Input[list])

  • everyone (pulumi.Input[bool])

  • ips (pulumi.Input[list])

The requires object supports the following:

  • emails (pulumi.Input[list])

  • emailDomains (pulumi.Input[list])

  • everyone (pulumi.Input[bool])

  • ips (pulumi.Input[list])

application_id = None

The ID of the application the policy is associated with.

decision = None

Defines the action Access will take if the policy matches the user. Allowed values: allow, deny, bypass

excludes = None

A series of access conditions, see below for full list.

  • emails (list)

  • emailDomains (list)

  • everyone (bool)

  • ips (list)

includes = None

A series of access conditions, see below for full list.

  • emails (list)

  • emailDomains (list)

  • everyone (bool)

  • ips (list)

name = None

Friendly name of the Access Application.

precedence = None

The unique precedence for policies on a single application. Integer.

requires = None

A series of access conditions, see below for full list.

  • emails (list)

  • emailDomains (list)

  • everyone (bool)

  • ips (list)

zone_id = None

The DNS zone to which the access rule should be added.

static get(resource_name, id, opts=None, application_id=None, decision=None, excludes=None, includes=None, name=None, precedence=None, requires=None, zone_id=None)

Get an existing AccessPolicy resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • application_id (pulumi.Input[str]) – The ID of the application the policy is associated with.

  • decision (pulumi.Input[str]) – Defines the action Access will take if the policy matches the user. Allowed values: allow, deny, bypass

  • excludes (pulumi.Input[list]) – A series of access conditions, see below for full list.

  • includes (pulumi.Input[list]) – A series of access conditions, see below for full list.

  • name (pulumi.Input[str]) – Friendly name of the Access Application.

  • precedence (pulumi.Input[float]) – The unique precedence for policies on a single application. Integer.

  • requires (pulumi.Input[list]) – A series of access conditions, see below for full list.

  • zone_id (pulumi.Input[str]) – The DNS zone to which the access rule should be added.

The excludes object supports the following:

  • emails (pulumi.Input[list])

  • emailDomains (pulumi.Input[list])

  • everyone (pulumi.Input[bool])

  • ips (pulumi.Input[list])

The includes object supports the following:

  • emails (pulumi.Input[list])

  • emailDomains (pulumi.Input[list])

  • everyone (pulumi.Input[bool])

  • ips (pulumi.Input[list])

The requires object supports the following:

  • emails (pulumi.Input[list])

  • emailDomains (pulumi.Input[list])

  • everyone (pulumi.Input[bool])

  • ips (pulumi.Input[list])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_cloudflare.AccessRule(resource_name, opts=None, configuration=None, mode=None, notes=None, zone=None, zone_id=None, __props__=None, __name__=None, __opts__=None)

Provides a Cloudflare IP Firewall Access Rule resource. Access control can be applied on basis of IP addresses, IP ranges, AS numbers or countries.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • configuration (pulumi.Input[dict]) – Rule configuration to apply to a matched request. It’s a complex value. See description below.

  • mode (pulumi.Input[str]) – The action to apply to a matched request. Allowed values: “block”, “challenge”, “whitelist”, “js_challenge”

  • notes (pulumi.Input[str]) – A personal note about the rule. Typically used as a reminder or explanation for the rule.

  • zone (pulumi.Input[str]) – The DNS zone to which the access rule should be added. Will be resolved to zone_id upon creation.

  • zone_id (pulumi.Input[str]) – The DNS zone to which the access rule should be added.

The configuration object supports the following:

  • target (pulumi.Input[str]) - The request property to target. Allowed values: “ip”, “ip_range”, “asn”, “country”

  • value (pulumi.Input[str]) - The value to target. Depends on target’s type.

configuration = None

Rule configuration to apply to a matched request. It’s a complex value. See description below.

  • target (str) - The request property to target. Allowed values: “ip”, “ip_range”, “asn”, “country”

  • value (str) - The value to target. Depends on target’s type.

mode = None

The action to apply to a matched request. Allowed values: “block”, “challenge”, “whitelist”, “js_challenge”

notes = None

A personal note about the rule. Typically used as a reminder or explanation for the rule.

zone = None

The DNS zone to which the access rule should be added. Will be resolved to zone_id upon creation.

zone_id = None

The DNS zone to which the access rule should be added.

static get(resource_name, id, opts=None, configuration=None, mode=None, notes=None, zone=None, zone_id=None)

Get an existing AccessRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • configuration (pulumi.Input[dict]) – Rule configuration to apply to a matched request. It’s a complex value. See description below.

  • mode (pulumi.Input[str]) – The action to apply to a matched request. Allowed values: “block”, “challenge”, “whitelist”, “js_challenge”

  • notes (pulumi.Input[str]) – A personal note about the rule. Typically used as a reminder or explanation for the rule.

  • zone (pulumi.Input[str]) – The DNS zone to which the access rule should be added. Will be resolved to zone_id upon creation.

  • zone_id (pulumi.Input[str]) – The DNS zone to which the access rule should be added.

The configuration object supports the following:

  • target (pulumi.Input[str]) - The request property to target. Allowed values: “ip”, “ip_range”, “asn”, “country”

  • value (pulumi.Input[str]) - The value to target. Depends on target’s type.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_cloudflare.AccountMember(resource_name, opts=None, email_address=None, role_ids=None, __props__=None, __name__=None, __opts__=None)

Provides a resource which manages Cloudflare account members.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • email_address (pulumi.Input[str]) – The email address of the user who you wish to manage. Note: Following creation, this field becomes read only via the API and cannot be updated.

  • role_ids (pulumi.Input[list]) – Array of account role IDs that you want to assign to a member.

email_address = None

The email address of the user who you wish to manage. Note: Following creation, this field becomes read only via the API and cannot be updated.

role_ids = None

Array of account role IDs that you want to assign to a member.

static get(resource_name, id, opts=None, email_address=None, role_ids=None)

Get an existing AccountMember resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • email_address (pulumi.Input[str]) – The email address of the user who you wish to manage. Note: Following creation, this field becomes read only via the API and cannot be updated.

  • role_ids (pulumi.Input[list]) – Array of account role IDs that you want to assign to a member.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_cloudflare.Argo(resource_name, opts=None, smart_routing=None, tiered_caching=None, zone_id=None, __props__=None, __name__=None, __opts__=None)

Cloudflare Argo controls the routing to your origin and tiered caching options to speed up your website browsing experience.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • smart_routing (pulumi.Input[str]) – Whether smart routing is enabled. Valid values: on or off. Defaults to off.

  • tiered_caching (pulumi.Input[str]) – Whether tiered caching is enabled. Valid values: on or off. Defaults to off.

  • zone_id (pulumi.Input[str]) – The DNS zone ID that you wish to manage Argo on.

smart_routing = None

Whether smart routing is enabled. Valid values: on or off. Defaults to off.

tiered_caching = None

Whether tiered caching is enabled. Valid values: on or off. Defaults to off.

zone_id = None

The DNS zone ID that you wish to manage Argo on.

static get(resource_name, id, opts=None, smart_routing=None, tiered_caching=None, zone_id=None)

Get an existing Argo resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • smart_routing (pulumi.Input[str]) – Whether smart routing is enabled. Valid values: on or off. Defaults to off.

  • tiered_caching (pulumi.Input[str]) – Whether tiered caching is enabled. Valid values: on or off. Defaults to off.

  • zone_id (pulumi.Input[str]) – The DNS zone ID that you wish to manage Argo on.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_cloudflare.AwaitableGetIpRangesResult(cidr_blocks=None, ipv4_cidr_blocks=None, ipv6_cidr_blocks=None, id=None)
class pulumi_cloudflare.AwaitableGetZonesResult(filter=None, zones=None, id=None)
class pulumi_cloudflare.CustomPages(resource_name, opts=None, account_id=None, state=None, type=None, url=None, zone_id=None, __props__=None, __name__=None, __opts__=None)

Provides a resource which manages Cloudflare custom error pages.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • account_id (pulumi.Input[str]) – The account ID where the custom pages should be updated. Either account_id or zone_id must be provided. If account_id is present, it will override the zone setting.

  • type (pulumi.Input[str]) – The type of custom page you wish to update. Must be one of basic_challenge, waf_challenge, waf_block, ratelimit_block, country_challenge, ip_block, under_attack, 500_errors, 1000_errors, always_online.

  • url (pulumi.Input[str]) – URL of where the custom page source is located.

  • zone_id (pulumi.Input[str]) – The zone ID where the custom pages should be updated. Either zone_id or account_id must be provided.

account_id = None

The account ID where the custom pages should be updated. Either account_id or zone_id must be provided. If account_id is present, it will override the zone setting.

type = None

The type of custom page you wish to update. Must be one of basic_challenge, waf_challenge, waf_block, ratelimit_block, country_challenge, ip_block, under_attack, 500_errors, 1000_errors, always_online.

url = None

URL of where the custom page source is located.

zone_id = None

The zone ID where the custom pages should be updated. Either zone_id or account_id must be provided.

static get(resource_name, id, opts=None, account_id=None, state=None, type=None, url=None, zone_id=None)

Get an existing CustomPages resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • account_id (pulumi.Input[str]) – The account ID where the custom pages should be updated. Either account_id or zone_id must be provided. If account_id is present, it will override the zone setting.

  • type (pulumi.Input[str]) – The type of custom page you wish to update. Must be one of basic_challenge, waf_challenge, waf_block, ratelimit_block, country_challenge, ip_block, under_attack, 500_errors, 1000_errors, always_online.

  • url (pulumi.Input[str]) – URL of where the custom page source is located.

  • zone_id (pulumi.Input[str]) – The zone ID where the custom pages should be updated. Either zone_id or account_id must be provided.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_cloudflare.CustomSsl(resource_name, opts=None, custom_ssl_options=None, custom_ssl_priorities=None, zone_id=None, __props__=None, __name__=None, __opts__=None)

Provides a Cloudflare custom ssl resource.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • custom_ssl_options (pulumi.Input[dict]) – The certificate, private key and associated optional parameters, such as bundle_method, geo_restrictions, and type.

  • zone_id (pulumi.Input[str]) – The DNS zone id to the custom ssl cert should be added.

The custom_ssl_options object supports the following:

  • bundle_method (pulumi.Input[str]) - Method of building intermediate certificate chain. A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it. Valid values are ubiquitous (default), optimal, force.

  • certificate (pulumi.Input[str]) - Certificate certificate and the intermediate(s)

  • geo_restrictions (pulumi.Input[str]) - Specifies the region where your private key can be held locally. Valid values are us, eu, highest_security.

  • private_key (pulumi.Input[str]) - Certificate’s private key

  • type (pulumi.Input[str]) - Whether to enable support for legacy clients which do not include SNI in the TLS handshake. Valid values are legacy_custom (default), sni_custom.

The custom_ssl_priorities object supports the following:

  • id (pulumi.Input[str])

  • priority (pulumi.Input[float])

custom_ssl_options = None

The certificate, private key and associated optional parameters, such as bundle_method, geo_restrictions, and type.

  • bundle_method (str) - Method of building intermediate certificate chain. A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it. Valid values are ubiquitous (default), optimal, force.

  • certificate (str) - Certificate certificate and the intermediate(s)

  • geo_restrictions (str) - Specifies the region where your private key can be held locally. Valid values are us, eu, highest_security.

  • private_key (str) - Certificate’s private key

  • type (str) - Whether to enable support for legacy clients which do not include SNI in the TLS handshake. Valid values are legacy_custom (default), sni_custom.

zone_id = None

The DNS zone id to the custom ssl cert should be added.

static get(resource_name, id, opts=None, custom_ssl_options=None, custom_ssl_priorities=None, expires_on=None, hosts=None, issuer=None, modified_on=None, priority=None, signature=None, status=None, uploaded_on=None, zone_id=None)

Get an existing CustomSsl resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • custom_ssl_options (pulumi.Input[dict]) – The certificate, private key and associated optional parameters, such as bundle_method, geo_restrictions, and type.

  • zone_id (pulumi.Input[str]) – The DNS zone id to the custom ssl cert should be added.

The custom_ssl_options object supports the following:

  • bundle_method (pulumi.Input[str]) - Method of building intermediate certificate chain. A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it. Valid values are ubiquitous (default), optimal, force.

  • certificate (pulumi.Input[str]) - Certificate certificate and the intermediate(s)

  • geo_restrictions (pulumi.Input[str]) - Specifies the region where your private key can be held locally. Valid values are us, eu, highest_security.

  • private_key (pulumi.Input[str]) - Certificate’s private key

  • type (pulumi.Input[str]) - Whether to enable support for legacy clients which do not include SNI in the TLS handshake. Valid values are legacy_custom (default), sni_custom.

The custom_ssl_priorities object supports the following:

  • id (pulumi.Input[str])

  • priority (pulumi.Input[float])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_cloudflare.Filter(resource_name, opts=None, description=None, expression=None, paused=None, ref=None, zone=None, zone_id=None, __props__=None, __name__=None, __opts__=None)

Filter expressions that can be referenced across multiple features, e.g. Firewall Rule. The expression format is similar to Wireshark Display Filter.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • description (pulumi.Input[str]) – A note that you can use to describe the purpose of the filter.

  • expression (pulumi.Input[str]) – The filter expression to be used.

  • paused (pulumi.Input[bool]) – Whether this filter is currently paused. Boolean value.

  • ref (pulumi.Input[str]) – Short reference tag to quickly select related rules.

  • zone (pulumi.Input[str]) – The DNS zone to which the Filter should be added. Will be resolved to zone_id upon creation.

  • zone_id (pulumi.Input[str]) – The DNS zone to which the Filter should be added.

description = None

A note that you can use to describe the purpose of the filter.

expression = None

The filter expression to be used.

paused = None

Whether this filter is currently paused. Boolean value.

ref = None

Short reference tag to quickly select related rules.

zone = None

The DNS zone to which the Filter should be added. Will be resolved to zone_id upon creation.

zone_id = None

The DNS zone to which the Filter should be added.

static get(resource_name, id, opts=None, description=None, expression=None, paused=None, ref=None, zone=None, zone_id=None)

Get an existing Filter resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • description (pulumi.Input[str]) – A note that you can use to describe the purpose of the filter.

  • expression (pulumi.Input[str]) – The filter expression to be used.

  • paused (pulumi.Input[bool]) – Whether this filter is currently paused. Boolean value.

  • ref (pulumi.Input[str]) – Short reference tag to quickly select related rules.

  • zone (pulumi.Input[str]) – The DNS zone to which the Filter should be added. Will be resolved to zone_id upon creation.

  • zone_id (pulumi.Input[str]) – The DNS zone to which the Filter should be added.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_cloudflare.FirewallRule(resource_name, opts=None, action=None, description=None, filter_id=None, paused=None, priority=None, zone=None, zone_id=None, __props__=None, __name__=None, __opts__=None)

Define Firewall rules using filter expressions for more control over how traffic is matched to the rule. A filter expression permits selecting traffic by multiple criteria allowing greater freedom in rule creation.

Filter expressions needs to be created first before using Firewall Rule. See Filter.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • action (pulumi.Input[str]) – The action to apply to a matched request. Allowed values: “block”, “challenge”, “allow”, “js_challenge”. Enterprise plan also allows “log”.

  • description (pulumi.Input[str]) – A description of the rule to help identify it.

  • paused (pulumi.Input[bool]) – Whether this filter based firewall rule is currently paused. Boolean value.

  • priority (pulumi.Input[float]) – The priority of the rule to allow control of processing order. A lower number indicates high priority. If not provided, any rules with a priority will be sequenced before those without.

  • zone (pulumi.Input[str]) – The DNS zone to which the Firewall Rule should be added. Will be resolved to zone_id upon creation.

  • zone_id (pulumi.Input[str]) – The DNS zone to which the Filter should be added.

action = None

The action to apply to a matched request. Allowed values: “block”, “challenge”, “allow”, “js_challenge”. Enterprise plan also allows “log”.

description = None

A description of the rule to help identify it.

paused = None

Whether this filter based firewall rule is currently paused. Boolean value.

priority = None

The priority of the rule to allow control of processing order. A lower number indicates high priority. If not provided, any rules with a priority will be sequenced before those without.

zone = None

The DNS zone to which the Firewall Rule should be added. Will be resolved to zone_id upon creation.

zone_id = None

The DNS zone to which the Filter should be added.

static get(resource_name, id, opts=None, action=None, description=None, filter_id=None, paused=None, priority=None, zone=None, zone_id=None)

Get an existing FirewallRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • action (pulumi.Input[str]) – The action to apply to a matched request. Allowed values: “block”, “challenge”, “allow”, “js_challenge”. Enterprise plan also allows “log”.

  • description (pulumi.Input[str]) – A description of the rule to help identify it.

  • paused (pulumi.Input[bool]) – Whether this filter based firewall rule is currently paused. Boolean value.

  • priority (pulumi.Input[float]) – The priority of the rule to allow control of processing order. A lower number indicates high priority. If not provided, any rules with a priority will be sequenced before those without.

  • zone (pulumi.Input[str]) – The DNS zone to which the Firewall Rule should be added. Will be resolved to zone_id upon creation.

  • zone_id (pulumi.Input[str]) – The DNS zone to which the Filter should be added.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_cloudflare.GetIpRangesResult(cidr_blocks=None, ipv4_cidr_blocks=None, ipv6_cidr_blocks=None, id=None)

A collection of values returned by getIpRanges.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_cloudflare.GetZonesResult(filter=None, zones=None, id=None)

A collection of values returned by getZones.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_cloudflare.LoadBalancer(resource_name, opts=None, default_pool_ids=None, description=None, enabled=None, fallback_pool_id=None, name=None, pop_pools=None, proxied=None, region_pools=None, session_affinity=None, steering_policy=None, ttl=None, zone=None, zone_id=None, __props__=None, __name__=None, __opts__=None)

Provides a Cloudflare Load Balancer resource. This sits in front of a number of defined pools of origins and provides various options for geographically-aware load balancing. Note that the load balancing feature must be enabled in your Clouflare account before you can use this resource.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • default_pool_ids (pulumi.Input[list]) – A list of pool IDs ordered by their failover priority. Used whenever region/pop pools are not defined.

  • description (pulumi.Input[str]) – Free text description.

  • enabled (pulumi.Input[bool]) – Enable or disable the load balancer. Defaults to true (enabled).

  • fallback_pool_id (pulumi.Input[str]) – The pool ID to use when all other pools are detected as unhealthy.

  • name (pulumi.Input[str]) – The DNS name (FQDN, including the zone) to associate with the load balancer.

  • pop_pools (pulumi.Input[list]) – A set containing mappings of Cloudflare Point-of-Presence (PoP) identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). This feature is only available to enterprise customers. Fields documented below.

  • proxied (pulumi.Input[bool]) – Whether the hostname gets Cloudflare’s origin protection. Defaults to false.

  • region_pools (pulumi.Input[list]) – A set containing mappings of region/country codes to a list of pool IDs (ordered by their failover priority) for the given region. Fields documented below.

  • session_affinity (pulumi.Input[str]) – Associates all requests coming from an end-user with a single origin. Cloudflare will set a cookie on the initial response to the client, such that consequent requests with the cookie in the request will go to the same origin, so long as it is available.

  • steering_policy (pulumi.Input[str]) – Determine which method the load balancer uses to determine the fastest route to your origin. Valid values are: "off", "geo", "dynamic_latency", "random" or "". Default is "".

  • ttl (pulumi.Input[float]) – Time to live (TTL) of this load balancer’s DNS name. Conflicts with proxied - this cannot be set for proxied load balancers. Default is 30.

  • zone (pulumi.Input[str]) – The zone to add the load balancer to.

  • zone_id (pulumi.Input[str]) – ID associated with the specified zone.

The pop_pools object supports the following:

  • poolIds (pulumi.Input[list]) - A list of pool IDs in failover priority to use for traffic reaching the given PoP.

  • pop (pulumi.Input[str]) - A 3-letter code for the Point-of-Presence. Allowed values can be found in the list of datacenters on the status page. Multiple entries should not be specified with the same PoP.

The region_pools object supports the following:

  • poolIds (pulumi.Input[list]) - A list of pool IDs in failover priority to use for traffic reaching the given PoP.

  • region (pulumi.Input[str]) - A region code which must be in the list defined here. Multiple entries should not be specified with the same region.

created_on = None

The RFC3339 timestamp of when the load balancer was created.

default_pool_ids = None

A list of pool IDs ordered by their failover priority. Used whenever region/pop pools are not defined.

description = None

Free text description.

enabled = None

Enable or disable the load balancer. Defaults to true (enabled).

fallback_pool_id = None

The pool ID to use when all other pools are detected as unhealthy.

modified_on = None

The RFC3339 timestamp of when the load balancer was last modified.

name = None

The DNS name (FQDN, including the zone) to associate with the load balancer.

pop_pools = None

A set containing mappings of Cloudflare Point-of-Presence (PoP) identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). This feature is only available to enterprise customers. Fields documented below.

  • poolIds (list) - A list of pool IDs in failover priority to use for traffic reaching the given PoP.

  • pop (str) - A 3-letter code for the Point-of-Presence. Allowed values can be found in the list of datacenters on the status page. Multiple entries should not be specified with the same PoP.

proxied = None

Whether the hostname gets Cloudflare’s origin protection. Defaults to false.

region_pools = None

A set containing mappings of region/country codes to a list of pool IDs (ordered by their failover priority) for the given region. Fields documented below.

  • poolIds (list) - A list of pool IDs in failover priority to use for traffic reaching the given PoP.

  • region (str) - A region code which must be in the list defined here. Multiple entries should not be specified with the same region.

session_affinity = None

Associates all requests coming from an end-user with a single origin. Cloudflare will set a cookie on the initial response to the client, such that consequent requests with the cookie in the request will go to the same origin, so long as it is available.

steering_policy = None

Determine which method the load balancer uses to determine the fastest route to your origin. Valid values are: "off", "geo", "dynamic_latency", "random" or "". Default is "".

ttl = None

Time to live (TTL) of this load balancer’s DNS name. Conflicts with proxied - this cannot be set for proxied load balancers. Default is 30.

zone = None

The zone to add the load balancer to.

zone_id = None

ID associated with the specified zone.

static get(resource_name, id, opts=None, created_on=None, default_pool_ids=None, description=None, enabled=None, fallback_pool_id=None, modified_on=None, name=None, pop_pools=None, proxied=None, region_pools=None, session_affinity=None, steering_policy=None, ttl=None, zone=None, zone_id=None)

Get an existing LoadBalancer resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • created_on (pulumi.Input[str]) – The RFC3339 timestamp of when the load balancer was created.

  • default_pool_ids (pulumi.Input[list]) – A list of pool IDs ordered by their failover priority. Used whenever region/pop pools are not defined.

  • description (pulumi.Input[str]) – Free text description.

  • enabled (pulumi.Input[bool]) – Enable or disable the load balancer. Defaults to true (enabled).

  • fallback_pool_id (pulumi.Input[str]) – The pool ID to use when all other pools are detected as unhealthy.

  • modified_on (pulumi.Input[str]) – The RFC3339 timestamp of when the load balancer was last modified.

  • name (pulumi.Input[str]) – The DNS name (FQDN, including the zone) to associate with the load balancer.

  • pop_pools (pulumi.Input[list]) – A set containing mappings of Cloudflare Point-of-Presence (PoP) identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). This feature is only available to enterprise customers. Fields documented below.

  • proxied (pulumi.Input[bool]) – Whether the hostname gets Cloudflare’s origin protection. Defaults to false.

  • region_pools (pulumi.Input[list]) – A set containing mappings of region/country codes to a list of pool IDs (ordered by their failover priority) for the given region. Fields documented below.

  • session_affinity (pulumi.Input[str]) – Associates all requests coming from an end-user with a single origin. Cloudflare will set a cookie on the initial response to the client, such that consequent requests with the cookie in the request will go to the same origin, so long as it is available.

  • steering_policy (pulumi.Input[str]) – Determine which method the load balancer uses to determine the fastest route to your origin. Valid values are: "off", "geo", "dynamic_latency", "random" or "". Default is "".

  • ttl (pulumi.Input[float]) – Time to live (TTL) of this load balancer’s DNS name. Conflicts with proxied - this cannot be set for proxied load balancers. Default is 30.

  • zone (pulumi.Input[str]) – The zone to add the load balancer to.

  • zone_id (pulumi.Input[str]) – ID associated with the specified zone.

The pop_pools object supports the following:

  • poolIds (pulumi.Input[list]) - A list of pool IDs in failover priority to use for traffic reaching the given PoP.

  • pop (pulumi.Input[str]) - A 3-letter code for the Point-of-Presence. Allowed values can be found in the list of datacenters on the status page. Multiple entries should not be specified with the same PoP.

The region_pools object supports the following:

  • poolIds (pulumi.Input[list]) - A list of pool IDs in failover priority to use for traffic reaching the given PoP.

  • region (pulumi.Input[str]) - A region code which must be in the list defined here. Multiple entries should not be specified with the same region.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_cloudflare.LoadBalancerMonitor(resource_name, opts=None, allow_insecure=None, description=None, expected_body=None, expected_codes=None, follow_redirects=None, headers=None, interval=None, method=None, path=None, port=None, retries=None, timeout=None, type=None, __props__=None, __name__=None, __opts__=None)

If you’re using Cloudflare’s Load Balancing to load-balance across multiple origin servers or data centers, you configure one of these Monitors to actively check the availability of those servers over HTTP(S) or TCP.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • allow_insecure (pulumi.Input[bool]) – Do not validate the certificate when monitor use HTTPS. Only valid if type is “http” or “https”.

  • description (pulumi.Input[str]) – Free text description.

  • expected_body (pulumi.Input[str]) – A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. Only valid and required if type is “http” or “https”.

  • expected_codes (pulumi.Input[str]) – The expected HTTP response code or code range of the health check. Eg 2xx. Only valid and required if type is “http” or “https”.

  • follow_redirects (pulumi.Input[bool]) – Follow redirects if returned by the origin. Only valid if type is “http” or “https”.

  • headers (pulumi.Input[list]) – The header name.

  • interval (pulumi.Input[float]) – The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations. Default: 60.

  • method (pulumi.Input[str]) – The method to use for the health check. Valid values are any valid HTTP verb if type is “http” or “https”, or connection_established if type is “tcp”. Default: “GET” if type is “http” or “https”, or “connection_established” if type is “tcp” .

  • path (pulumi.Input[str]) – The endpoint path to health check against. Default: “/”. Only valid if type is “http” or “https”.

  • retries (pulumi.Input[float]) – The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. Default: 2.

  • timeout (pulumi.Input[float]) – The timeout (in seconds) before marking the health check as failed. Default: 5.

  • type (pulumi.Input[str]) – The protocol to use for the healthcheck. Currently supported protocols are ‘HTTP’, ‘HTTPS’ and ‘TCP’. Default: “http”.

The headers object supports the following:

  • header (pulumi.Input[str]) - The header name.

  • values (pulumi.Input[list]) - A list of string values for the header.

allow_insecure = None

Do not validate the certificate when monitor use HTTPS. Only valid if type is “http” or “https”.

created_on = None

The RFC3339 timestamp of when the load balancer monitor was created.

description = None

Free text description.

expected_body = None

A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. Only valid and required if type is “http” or “https”.

expected_codes = None

The expected HTTP response code or code range of the health check. Eg 2xx. Only valid and required if type is “http” or “https”.

follow_redirects = None

Follow redirects if returned by the origin. Only valid if type is “http” or “https”.

headers = None

The header name.

  • header (str) - The header name.

  • values (list) - A list of string values for the header.

interval = None

The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations. Default: 60.

method = None

The method to use for the health check. Valid values are any valid HTTP verb if type is “http” or “https”, or connection_established if type is “tcp”. Default: “GET” if type is “http” or “https”, or “connection_established” if type is “tcp” .

modified_on = None

The RFC3339 timestamp of when the load balancer monitor was last modified.

path = None

The endpoint path to health check against. Default: “/”. Only valid if type is “http” or “https”.

retries = None

The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. Default: 2.

timeout = None

The timeout (in seconds) before marking the health check as failed. Default: 5.

type = None

The protocol to use for the healthcheck. Currently supported protocols are ‘HTTP’, ‘HTTPS’ and ‘TCP’. Default: “http”.

static get(resource_name, id, opts=None, allow_insecure=None, created_on=None, description=None, expected_body=None, expected_codes=None, follow_redirects=None, headers=None, interval=None, method=None, modified_on=None, path=None, port=None, retries=None, timeout=None, type=None)

Get an existing LoadBalancerMonitor resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • allow_insecure (pulumi.Input[bool]) – Do not validate the certificate when monitor use HTTPS. Only valid if type is “http” or “https”.

  • created_on (pulumi.Input[str]) – The RFC3339 timestamp of when the load balancer monitor was created.

  • description (pulumi.Input[str]) – Free text description.

  • expected_body (pulumi.Input[str]) – A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. Only valid and required if type is “http” or “https”.

  • expected_codes (pulumi.Input[str]) – The expected HTTP response code or code range of the health check. Eg 2xx. Only valid and required if type is “http” or “https”.

  • follow_redirects (pulumi.Input[bool]) – Follow redirects if returned by the origin. Only valid if type is “http” or “https”.

  • headers (pulumi.Input[list]) – The header name.

  • interval (pulumi.Input[float]) – The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations. Default: 60.

  • method (pulumi.Input[str]) – The method to use for the health check. Valid values are any valid HTTP verb if type is “http” or “https”, or connection_established if type is “tcp”. Default: “GET” if type is “http” or “https”, or “connection_established” if type is “tcp” .

  • modified_on (pulumi.Input[str]) – The RFC3339 timestamp of when the load balancer monitor was last modified.

  • path (pulumi.Input[str]) – The endpoint path to health check against. Default: “/”. Only valid if type is “http” or “https”.

  • retries (pulumi.Input[float]) – The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. Default: 2.

  • timeout (pulumi.Input[float]) – The timeout (in seconds) before marking the health check as failed. Default: 5.

  • type (pulumi.Input[str]) – The protocol to use for the healthcheck. Currently supported protocols are ‘HTTP’, ‘HTTPS’ and ‘TCP’. Default: “http”.

The headers object supports the following:

  • header (pulumi.Input[str]) - The header name.

  • values (pulumi.Input[list]) - A list of string values for the header.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_cloudflare.LoadBalancerPool(resource_name, opts=None, check_regions=None, description=None, enabled=None, minimum_origins=None, monitor=None, name=None, notification_email=None, origins=None, __props__=None, __name__=None, __opts__=None)

Provides a Cloudflare Load Balancer pool resource. This provides a pool of origins that can be used by a Cloudflare Load Balancer. Note that the load balancing feature must be enabled in your Clouflare account before you can use this resource.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • check_regions (pulumi.Input[list]) –

    A list of regions (specified by region code) from which to run health checks. Empty means every Cloudflare data center (the default), but requires an Enterprise plan. Region codes can be found here.

  • description (pulumi.Input[str]) – Free text description.

  • enabled (pulumi.Input[bool]) – Whether to enable (the default) this origin within the Pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.

  • minimum_origins (pulumi.Input[float]) – The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and we will failover to the next available pool. Default: 1.

  • monitor (pulumi.Input[str]) – The ID of the Monitor to use for health checking origins within this pool.

  • name (pulumi.Input[str]) – A human-identifiable name for the origin.

  • notification_email (pulumi.Input[str]) – The email address to send health status notifications to. This can be an individual mailbox or a mailing list.

  • origins (pulumi.Input[list]) – The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy. It’s a complex value. See description below.

The origins object supports the following:

  • address (pulumi.Input[str]) - The IP address (IPv4 or IPv6) of the origin, or the publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare.

  • enabled (pulumi.Input[bool]) - Whether to enable (the default) this origin within the Pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.

  • name (pulumi.Input[str]) - A human-identifiable name for the origin.

  • weight (pulumi.Input[float]) - The weight (0.01 - 1.00) of this origin, relative to other origins in the pool. Equal values mean equal weighting. A weight of 0 means traffic will not be sent to this origin, but health is still checked. Default: 1.

check_regions = None

A list of regions (specified by region code) from which to run health checks. Empty means every Cloudflare data center (the default), but requires an Enterprise plan. Region codes can be found here.

created_on = None

The RFC3339 timestamp of when the load balancer was created.

description = None

Free text description.

enabled = None

Whether to enable (the default) this origin within the Pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.

minimum_origins = None

The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and we will failover to the next available pool. Default: 1.

modified_on = None

The RFC3339 timestamp of when the load balancer was last modified.

monitor = None

The ID of the Monitor to use for health checking origins within this pool.

name = None

A human-identifiable name for the origin.

notification_email = None

The email address to send health status notifications to. This can be an individual mailbox or a mailing list.

origins = None

The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy. It’s a complex value. See description below.

  • address (str) - The IP address (IPv4 or IPv6) of the origin, or the publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare.

  • enabled (bool) - Whether to enable (the default) this origin within the Pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.

  • name (str) - A human-identifiable name for the origin.

  • weight (float) - The weight (0.01 - 1.00) of this origin, relative to other origins in the pool. Equal values mean equal weighting. A weight of 0 means traffic will not be sent to this origin, but health is still checked. Default: 1.

static get(resource_name, id, opts=None, check_regions=None, created_on=None, description=None, enabled=None, minimum_origins=None, modified_on=None, monitor=None, name=None, notification_email=None, origins=None)

Get an existing LoadBalancerPool resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • check_regions (pulumi.Input[list]) –

    A list of regions (specified by region code) from which to run health checks. Empty means every Cloudflare data center (the default), but requires an Enterprise plan. Region codes can be found here.

  • created_on (pulumi.Input[str]) – The RFC3339 timestamp of when the load balancer was created.

  • description (pulumi.Input[str]) – Free text description.

  • enabled (pulumi.Input[bool]) – Whether to enable (the default) this origin within the Pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.

  • minimum_origins (pulumi.Input[float]) – The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and we will failover to the next available pool. Default: 1.

  • modified_on (pulumi.Input[str]) – The RFC3339 timestamp of when the load balancer was last modified.

  • monitor (pulumi.Input[str]) – The ID of the Monitor to use for health checking origins within this pool.

  • name (pulumi.Input[str]) – A human-identifiable name for the origin.

  • notification_email (pulumi.Input[str]) – The email address to send health status notifications to. This can be an individual mailbox or a mailing list.

  • origins (pulumi.Input[list]) – The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy. It’s a complex value. See description below.

The origins object supports the following:

  • address (pulumi.Input[str]) - The IP address (IPv4 or IPv6) of the origin, or the publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare.

  • enabled (pulumi.Input[bool]) - Whether to enable (the default) this origin within the Pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.

  • name (pulumi.Input[str]) - A human-identifiable name for the origin.

  • weight (pulumi.Input[float]) - The weight (0.01 - 1.00) of this origin, relative to other origins in the pool. Equal values mean equal weighting. A weight of 0 means traffic will not be sent to this origin, but health is still checked. Default: 1.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_cloudflare.LogpushJob(resource_name, opts=None, destination_conf=None, enabled=None, logpull_options=None, name=None, ownership_challenge=None, zone_id=None, __props__=None, __name__=None, __opts__=None)

Provides a resource which manages Cloudflare logpush jobs.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • destination_conf (pulumi.Input[str]) – Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included. See Logpush destination documentation.

  • logpull_options (pulumi.Input[str]) – Configuration string for the Logshare API. It specifies things like requested fields and timestamp formats. See Logpull options documentation.

  • name (pulumi.Input[str]) – The name of the logpush job to create. Must match the regular expression ^[a-zA-Z0-9\-\.]*$.

  • ownership_challenge (pulumi.Input[str]) – Ownership challenge token to prove destination ownership. See Developer documentation.

  • zone_id (pulumi.Input[str]) – The zone ID where the logpush job should be created.

destination_conf = None

Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included. See Logpush destination documentation.

logpull_options = None

Configuration string for the Logshare API. It specifies things like requested fields and timestamp formats. See Logpull options documentation.

name = None

The name of the logpush job to create. Must match the regular expression ^[a-zA-Z0-9\-\.]*$.

ownership_challenge = None

Ownership challenge token to prove destination ownership. See Developer documentation.

zone_id = None

The zone ID where the logpush job should be created.

static get(resource_name, id, opts=None, destination_conf=None, enabled=None, logpull_options=None, name=None, ownership_challenge=None, zone_id=None)

Get an existing LogpushJob resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • destination_conf (pulumi.Input[str]) –

    Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included. See Logpush destination documentation.

  • logpull_options (pulumi.Input[str]) –

    Configuration string for the Logshare API. It specifies things like requested fields and timestamp formats. See Logpull options documentation.

  • name (pulumi.Input[str]) – The name of the logpush job to create. Must match the regular expression ^[a-zA-Z0-9\-\.]*$.

  • ownership_challenge (pulumi.Input[str]) –

    Ownership challenge token to prove destination ownership. See Developer documentation.

  • zone_id (pulumi.Input[str]) – The zone ID where the logpush job should be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_cloudflare.PageRule(resource_name, opts=None, actions=None, priority=None, status=None, target=None, zone=None, zone_id=None, __props__=None, __name__=None, __opts__=None)

Provides a Cloudflare page rule resource.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • actions (pulumi.Input[dict]) – The actions taken by the page rule, options given below.

  • priority (pulumi.Input[float]) – The priority of the page rule among others for this target, the higher the number the higher the priority as per API documentation.

  • status (pulumi.Input[str]) – Whether the page rule is active or disabled.

  • target (pulumi.Input[str]) – The URL pattern to target with the page rule.

  • zone (pulumi.Input[str]) – The DNS zone to which the page rule should be added.

  • zone_id (pulumi.Input[str]) – The ID of the zone in which the page rule will be applied.

The actions object supports the following:

  • alwaysOnline (pulumi.Input[str]) - Whether this action is "on" or "off".

  • alwaysUseHttps (pulumi.Input[bool]) - Boolean of whether this action is enabled. Default: false.

  • automaticHttpsRewrites (pulumi.Input[str]) - Whether this action is "on" or "off".

  • browserCacheTtl (pulumi.Input[str]) - The Time To Live for the browser cache. 0 means ‘Respect Existing Headers’

  • browserCheck (pulumi.Input[str]) - Whether this action is "on" or "off".

  • bypassCacheOnCookie (pulumi.Input[str]) - String value of cookie name to conditionally bypass cache the page.

  • cacheByDeviceType (pulumi.Input[str]) - Whether this action is "on" or "off".

  • cacheDeceptionArmor (pulumi.Input[str]) - Whether this action is "on" or "off".

  • cacheLevel (pulumi.Input[str]) - Whether to set the cache level to "bypass", "basic", "simplified", "aggressive", or "cache_everything".

  • cacheOnCookie (pulumi.Input[str]) - String value of cookie name to conditionally cache the page.

  • disableApps (pulumi.Input[bool]) - Boolean of whether this action is enabled. Default: false.

  • disablePerformance (pulumi.Input[bool]) - Boolean of whether this action is enabled. Default: false.

  • disableRailgun (pulumi.Input[bool]) - Boolean of whether this action is enabled. Default: false.

  • disableSecurity (pulumi.Input[bool]) - Boolean of whether this action is enabled. Default: false.

  • edgeCacheTtl (pulumi.Input[float]) - The Time To Live for the edge cache.

  • emailObfuscation (pulumi.Input[str]) - Whether this action is "on" or "off".

  • explicitCacheControl (pulumi.Input[str]) - Whether origin Cache-Control action is "on" or "off".

  • forwardingUrl (pulumi.Input[dict]) - The URL to forward to, and with what status. See below.

    • statusCode (pulumi.Input[float]) - The status code to use for the redirection.

    • url (pulumi.Input[str]) - The URL to which the page rule should forward.

  • hostHeaderOverride (pulumi.Input[str]) - Value of the Host header to send.

  • ipGeolocation (pulumi.Input[str]) - Whether this action is "on" or "off".

  • minifies (pulumi.Input[list]) - The configuration for HTML, CSS and JS minification. See below for full list of options.

    • css (pulumi.Input[str]) - Whether CSS should be minified. Valid values are "on" or "off".

    • html (pulumi.Input[str]) - Whether HTML should be minified. Valid values are "on" or "off".

    • js (pulumi.Input[str]) - Whether Javascript should be minified. Valid values are "on" or "off".

  • mirage (pulumi.Input[str]) - Whether this action is "on" or "off".

  • opportunisticEncryption (pulumi.Input[str]) - Whether this action is "on" or "off".

  • originErrorPagePassThru (pulumi.Input[str]) - Whether this action is "on" or "off".

  • polish (pulumi.Input[str]) - Whether this action is "off", "lossless" or "lossy".

  • resolveOverride (pulumi.Input[str]) - Overridden origin server name.

  • respectStrongEtag (pulumi.Input[str]) - Whether this action is "on" or "off".

  • responseBuffering (pulumi.Input[str]) - Whether this action is "on" or "off".

  • rocketLoader (pulumi.Input[str]) - Whether to set the rocket loader to "on", "off".

  • securityLevel (pulumi.Input[str]) - Whether to set the security level to "off", "essentially_off", "low", "medium", "high", or "under_attack".

  • serverSideExclude (pulumi.Input[str]) - Whether this action is "on" or "off".

  • sortQueryStringForCache (pulumi.Input[str]) - Whether this action is "on" or "off".

  • ssl (pulumi.Input[str]) - Whether to set the SSL mode to "off", "flexible", "full", "strict", or "origin_pull".

  • trueClientIpHeader (pulumi.Input[str]) - Whether this action is "on" or "off".

  • waf (pulumi.Input[str]) - Whether this action is "on" or "off".

actions = None

The actions taken by the page rule, options given below.

  • alwaysOnline (str) - Whether this action is "on" or "off".

  • alwaysUseHttps (bool) - Boolean of whether this action is enabled. Default: false.

  • automaticHttpsRewrites (str) - Whether this action is "on" or "off".

  • browserCacheTtl (str) - The Time To Live for the browser cache. 0 means ‘Respect Existing Headers’

  • browserCheck (str) - Whether this action is "on" or "off".

  • bypassCacheOnCookie (str) - String value of cookie name to conditionally bypass cache the page.

  • cacheByDeviceType (str) - Whether this action is "on" or "off".

  • cacheDeceptionArmor (str) - Whether this action is "on" or "off".

  • cacheLevel (str) - Whether to set the cache level to "bypass", "basic", "simplified", "aggressive", or "cache_everything".

  • cacheOnCookie (str) - String value of cookie name to conditionally cache the page.

  • disableApps (bool) - Boolean of whether this action is enabled. Default: false.

  • disablePerformance (bool) - Boolean of whether this action is enabled. Default: false.

  • disableRailgun (bool) - Boolean of whether this action is enabled. Default: false.

  • disableSecurity (bool) - Boolean of whether this action is enabled. Default: false.

  • edgeCacheTtl (float) - The Time To Live for the edge cache.

  • emailObfuscation (str) - Whether this action is "on" or "off".

  • explicitCacheControl (str) - Whether origin Cache-Control action is "on" or "off".

  • forwardingUrl (dict) - The URL to forward to, and with what status. See below.

    • statusCode (float) - The status code to use for the redirection.

    • url (str) - The URL to which the page rule should forward.

  • hostHeaderOverride (str) - Value of the Host header to send.

  • ipGeolocation (str) - Whether this action is "on" or "off".

  • minifies (list) - The configuration for HTML, CSS and JS minification. See below for full list of options.

    • css (str) - Whether CSS should be minified. Valid values are "on" or "off".

    • html (str) - Whether HTML should be minified. Valid values are "on" or "off".

    • js (str) - Whether Javascript should be minified. Valid values are "on" or "off".

  • mirage (str) - Whether this action is "on" or "off".

  • opportunisticEncryption (str) - Whether this action is "on" or "off".

  • originErrorPagePassThru (str) - Whether this action is "on" or "off".

  • polish (str) - Whether this action is "off", "lossless" or "lossy".

  • resolveOverride (str) - Overridden origin server name.

  • respectStrongEtag (str) - Whether this action is "on" or "off".

  • responseBuffering (str) - Whether this action is "on" or "off".

  • rocketLoader (str) - Whether to set the rocket loader to "on", "off".

  • securityLevel (str) - Whether to set the security level to "off", "essentially_off", "low", "medium", "high", or "under_attack".

  • serverSideExclude (str) - Whether this action is "on" or "off".

  • sortQueryStringForCache (str) - Whether this action is "on" or "off".

  • ssl (str) - Whether to set the SSL mode to "off", "flexible", "full", "strict", or "origin_pull".

  • trueClientIpHeader (str) - Whether this action is "on" or "off".

  • waf (str) - Whether this action is "on" or "off".

priority = None

The priority of the page rule among others for this target, the higher the number the higher the priority as per API documentation.

status = None

Whether the page rule is active or disabled.

target = None

The URL pattern to target with the page rule.

zone = None

The DNS zone to which the page rule should be added.

zone_id = None

The ID of the zone in which the page rule will be applied.

static get(resource_name, id, opts=None, actions=None, priority=None, status=None, target=None, zone=None, zone_id=None)

Get an existing PageRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • actions (pulumi.Input[dict]) – The actions taken by the page rule, options given below.

  • priority (pulumi.Input[float]) –

    The priority of the page rule among others for this target, the higher the number the higher the priority as per API documentation.

  • status (pulumi.Input[str]) – Whether the page rule is active or disabled.

  • target (pulumi.Input[str]) – The URL pattern to target with the page rule.

  • zone (pulumi.Input[str]) – The DNS zone to which the page rule should be added.

  • zone_id (pulumi.Input[str]) – The ID of the zone in which the page rule will be applied.

The actions object supports the following:

  • alwaysOnline (pulumi.Input[str]) - Whether this action is "on" or "off".

  • alwaysUseHttps (pulumi.Input[bool]) - Boolean of whether this action is enabled. Default: false.

  • automaticHttpsRewrites (pulumi.Input[str]) - Whether this action is "on" or "off".

  • browserCacheTtl (pulumi.Input[str]) - The Time To Live for the browser cache. 0 means ‘Respect Existing Headers’

  • browserCheck (pulumi.Input[str]) - Whether this action is "on" or "off".

  • bypassCacheOnCookie (pulumi.Input[str]) - String value of cookie name to conditionally bypass cache the page.

  • cacheByDeviceType (pulumi.Input[str]) - Whether this action is "on" or "off".

  • cacheDeceptionArmor (pulumi.Input[str]) - Whether this action is "on" or "off".

  • cacheLevel (pulumi.Input[str]) - Whether to set the cache level to "bypass", "basic", "simplified", "aggressive", or "cache_everything".

  • cacheOnCookie (pulumi.Input[str]) - String value of cookie name to conditionally cache the page.

  • disableApps (pulumi.Input[bool]) - Boolean of whether this action is enabled. Default: false.

  • disablePerformance (pulumi.Input[bool]) - Boolean of whether this action is enabled. Default: false.

  • disableRailgun (pulumi.Input[bool]) - Boolean of whether this action is enabled. Default: false.

  • disableSecurity (pulumi.Input[bool]) - Boolean of whether this action is enabled. Default: false.

  • edgeCacheTtl (pulumi.Input[float]) - The Time To Live for the edge cache.

  • emailObfuscation (pulumi.Input[str]) - Whether this action is "on" or "off".

  • explicitCacheControl (pulumi.Input[str]) - Whether origin Cache-Control action is "on" or "off".

  • forwardingUrl (pulumi.Input[dict]) - The URL to forward to, and with what status. See below.

    • statusCode (pulumi.Input[float]) - The status code to use for the redirection.

    • url (pulumi.Input[str]) - The URL to which the page rule should forward.

  • hostHeaderOverride (pulumi.Input[str]) - Value of the Host header to send.

  • ipGeolocation (pulumi.Input[str]) - Whether this action is "on" or "off".

  • minifies (pulumi.Input[list]) - The configuration for HTML, CSS and JS minification. See below for full list of options.

    • css (pulumi.Input[str]) - Whether CSS should be minified. Valid values are "on" or "off".

    • html (pulumi.Input[str]) - Whether HTML should be minified. Valid values are "on" or "off".

    • js (pulumi.Input[str]) - Whether Javascript should be minified. Valid values are "on" or "off".

  • mirage (pulumi.Input[str]) - Whether this action is "on" or "off".

  • opportunisticEncryption (pulumi.Input[str]) - Whether this action is "on" or "off".

  • originErrorPagePassThru (pulumi.Input[str]) - Whether this action is "on" or "off".

  • polish (pulumi.Input[str]) - Whether this action is "off", "lossless" or "lossy".

  • resolveOverride (pulumi.Input[str]) - Overridden origin server name.

  • respectStrongEtag (pulumi.Input[str]) - Whether this action is "on" or "off".

  • responseBuffering (pulumi.Input[str]) - Whether this action is "on" or "off".

  • rocketLoader (pulumi.Input[str]) - Whether to set the rocket loader to "on", "off".

  • securityLevel (pulumi.Input[str]) - Whether to set the security level to "off", "essentially_off", "low", "medium", "high", or "under_attack".

  • serverSideExclude (pulumi.Input[str]) - Whether this action is "on" or "off".

  • sortQueryStringForCache (pulumi.Input[str]) - Whether this action is "on" or "off".

  • ssl (pulumi.Input[str]) - Whether to set the SSL mode to "off", "flexible", "full", "strict", or "origin_pull".

  • trueClientIpHeader (pulumi.Input[str]) - Whether this action is "on" or "off".

  • waf (pulumi.Input[str]) - Whether this action is "on" or "off".

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_cloudflare.Provider(resource_name, opts=None, api_client_logging=None, api_token=None, email=None, max_backoff=None, min_backoff=None, org_id=None, retries=None, rps=None, token=None, use_org_from_zone=None, __props__=None, __name__=None, __opts__=None)

The provider type for the cloudflare package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

static get(resource_name, id, opts=None)

Get an existing Provider resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_cloudflare.RateLimit(resource_name, opts=None, action=None, bypass_url_patterns=None, correlate=None, description=None, disabled=None, match=None, period=None, threshold=None, zone=None, zone_id=None, __props__=None, __name__=None, __opts__=None)

Provides a Cloudflare rate limit resource for a given zone. This can be used to limit the traffic you receive zone-wide, or matching more specific types of requests/responses.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • action (pulumi.Input[dict]) – The action to be performed when the threshold of matched traffic within the period defined is exceeded.

  • bypass_url_patterns (pulumi.Input[list]) – URLs matching the patterns specified here will be excluded from rate limiting.

  • correlate (pulumi.Input[dict]) – Determines how rate limiting is applied. By default if not specified, rate limiting applies to the clients IP address.

  • description (pulumi.Input[str]) – A note that you can use to describe the reason for a rate limit. This value is sanitized and all tags are removed.

  • disabled (pulumi.Input[bool]) – Whether this ratelimit is currently disabled. Default: false.

  • match (pulumi.Input[dict]) – Determines which traffic the rate limit counts towards the threshold. By default matches all traffic in the zone. See definition below.

  • period (pulumi.Input[float]) – The time in seconds to count matching traffic. If the count exceeds threshold within this period the action will be performed (min: 1, max: 86,400).

  • threshold (pulumi.Input[float]) – The threshold that triggers the rate limit mitigations, combine with period. i.e. threshold per period (min: 2, max: 1,000,000).

  • zone (pulumi.Input[str]) – The DNS zone to apply rate limiting to.

  • zone_id (pulumi.Input[str]) – The DNS zone ID.

The action object supports the following:

  • mode (pulumi.Input[str]) - The type of action to perform. Allowable values are ‘simulate’, ‘ban’, ‘challenge’ and ‘js_challenge’.

  • response (pulumi.Input[dict]) - Custom content-type and body to return, this overrides the custom error for the zone. This field is not required. Omission will result in default HTML error page. Definition below.

    • body (pulumi.Input[str]) - The body to return, the content here should conform to the content_type.

    • contentType (pulumi.Input[str]) - The content-type of the body, must be one of: ‘text/plain’, ‘text/xml’, ‘application/json’.

  • timeout (pulumi.Input[float]) - The time in seconds as an integer to perform the mitigation action. This field is required if the mode is either simulate or ban. Must be the same or greater than the period (min: 1, max: 86400).

The correlate object supports the following:

  • by (pulumi.Input[str]) - If set to ‘nat’, NAT support will be enabled for rate limiting.

The match object supports the following:

  • request (pulumi.Input[dict]) - Matches HTTP requests (from the client to Cloudflare). See definition below.

    • methods (pulumi.Input[list]) - HTTP Methods, can be a subset [‘POST’,’PUT’] or all [‘_ALL_’]. Default: [‘_ALL_’].

    • schemes (pulumi.Input[list]) - HTTP Schemes, can be one [‘HTTPS’], both [‘HTTP’,’HTTPS’] or all [‘_ALL_’]. Default: [‘_ALL_’].

    • urlPattern (pulumi.Input[str]) - The URL pattern to match comprised of the host and path, i.e. example.org/path. Wildcard are expanded to match applicable traffic, query strings are not matched. Use * for all traffic to your zone. Default: ‘*’.

  • response (pulumi.Input[dict]) - Custom content-type and body to return, this overrides the custom error for the zone. This field is not required. Omission will result in default HTML error page. Definition below.

    • originTraffic (pulumi.Input[bool]) - Only count traffic that has come from your origin servers. If true, cached items that Cloudflare serve will not count towards rate limiting. Default: true.

    • statuses (pulumi.Input[list]) - HTTP Status codes, can be one [403], many [401,403] or indicate all by not providing this value.

action = None

The action to be performed when the threshold of matched traffic within the period defined is exceeded.

  • mode (str) - The type of action to perform. Allowable values are ‘simulate’, ‘ban’, ‘challenge’ and ‘js_challenge’.

  • response (dict) - Custom content-type and body to return, this overrides the custom error for the zone. This field is not required. Omission will result in default HTML error page. Definition below.

    • body (str) - The body to return, the content here should conform to the content_type.

    • contentType (str) - The content-type of the body, must be one of: ‘text/plain’, ‘text/xml’, ‘application/json’.

  • timeout (float) - The time in seconds as an integer to perform the mitigation action. This field is required if the mode is either simulate or ban. Must be the same or greater than the period (min: 1, max: 86400).

bypass_url_patterns = None

URLs matching the patterns specified here will be excluded from rate limiting.

correlate = None

Determines how rate limiting is applied. By default if not specified, rate limiting applies to the clients IP address.

  • by (str) - If set to ‘nat’, NAT support will be enabled for rate limiting.

description = None

A note that you can use to describe the reason for a rate limit. This value is sanitized and all tags are removed.

disabled = None

Whether this ratelimit is currently disabled. Default: false.

match = None

Determines which traffic the rate limit counts towards the threshold. By default matches all traffic in the zone. See definition below.

  • request (dict) - Matches HTTP requests (from the client to Cloudflare). See definition below.

    • methods (list) - HTTP Methods, can be a subset [‘POST’,’PUT’] or all [‘_ALL_’]. Default: [‘_ALL_’].

    • schemes (list) - HTTP Schemes, can be one [‘HTTPS’], both [‘HTTP’,’HTTPS’] or all [‘_ALL_’]. Default: [‘_ALL_’].

    • urlPattern (str) - The URL pattern to match comprised of the host and path, i.e. example.org/path. Wildcard are expanded to match applicable traffic, query strings are not matched. Use * for all traffic to your zone. Default: ‘*’.

  • response (dict) - Custom content-type and body to return, this overrides the custom error for the zone. This field is not required. Omission will result in default HTML error page. Definition below.

    • originTraffic (bool) - Only count traffic that has come from your origin servers. If true, cached items that Cloudflare serve will not count towards rate limiting. Default: true.

    • statuses (list) - HTTP Status codes, can be one [403], many [401,403] or indicate all by not providing this value.

period = None

The time in seconds to count matching traffic. If the count exceeds threshold within this period the action will be performed (min: 1, max: 86,400).

threshold = None

The threshold that triggers the rate limit mitigations, combine with period. i.e. threshold per period (min: 2, max: 1,000,000).

zone = None

The DNS zone to apply rate limiting to.

zone_id = None

The DNS zone ID.

static get(resource_name, id, opts=None, action=None, bypass_url_patterns=None, correlate=None, description=None, disabled=None, match=None, period=None, threshold=None, zone=None, zone_id=None)

Get an existing RateLimit resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • action (pulumi.Input[dict]) – The action to be performed when the threshold of matched traffic within the period defined is exceeded.

  • bypass_url_patterns (pulumi.Input[list]) – URLs matching the patterns specified here will be excluded from rate limiting.

  • correlate (pulumi.Input[dict]) – Determines how rate limiting is applied. By default if not specified, rate limiting applies to the clients IP address.

  • description (pulumi.Input[str]) – A note that you can use to describe the reason for a rate limit. This value is sanitized and all tags are removed.

  • disabled (pulumi.Input[bool]) – Whether this ratelimit is currently disabled. Default: false.

  • match (pulumi.Input[dict]) – Determines which traffic the rate limit counts towards the threshold. By default matches all traffic in the zone. See definition below.

  • period (pulumi.Input[float]) – The time in seconds to count matching traffic. If the count exceeds threshold within this period the action will be performed (min: 1, max: 86,400).

  • threshold (pulumi.Input[float]) – The threshold that triggers the rate limit mitigations, combine with period. i.e. threshold per period (min: 2, max: 1,000,000).

  • zone (pulumi.Input[str]) – The DNS zone to apply rate limiting to.

  • zone_id (pulumi.Input[str]) – The DNS zone ID.

The action object supports the following:

  • mode (pulumi.Input[str]) - The type of action to perform. Allowable values are ‘simulate’, ‘ban’, ‘challenge’ and ‘js_challenge’.

  • response (pulumi.Input[dict]) - Custom content-type and body to return, this overrides the custom error for the zone. This field is not required. Omission will result in default HTML error page. Definition below.

    • body (pulumi.Input[str]) - The body to return, the content here should conform to the content_type.

    • contentType (pulumi.Input[str]) - The content-type of the body, must be one of: ‘text/plain’, ‘text/xml’, ‘application/json’.

  • timeout (pulumi.Input[float]) - The time in seconds as an integer to perform the mitigation action. This field is required if the mode is either simulate or ban. Must be the same or greater than the period (min: 1, max: 86400).

The correlate object supports the following:

  • by (pulumi.Input[str]) - If set to ‘nat’, NAT support will be enabled for rate limiting.

The match object supports the following:

  • request (pulumi.Input[dict]) - Matches HTTP requests (from the client to Cloudflare). See definition below.

    • methods (pulumi.Input[list]) - HTTP Methods, can be a subset [‘POST’,’PUT’] or all [‘_ALL_’]. Default: [‘_ALL_’].

    • schemes (pulumi.Input[list]) - HTTP Schemes, can be one [‘HTTPS’], both [‘HTTP’,’HTTPS’] or all [‘_ALL_’]. Default: [‘_ALL_’].

    • urlPattern (pulumi.Input[str]) - The URL pattern to match comprised of the host and path, i.e. example.org/path. Wildcard are expanded to match applicable traffic, query strings are not matched. Use * for all traffic to your zone. Default: ‘*’.

  • response (pulumi.Input[dict]) - Custom content-type and body to return, this overrides the custom error for the zone. This field is not required. Omission will result in default HTML error page. Definition below.

    • originTraffic (pulumi.Input[bool]) - Only count traffic that has come from your origin servers. If true, cached items that Cloudflare serve will not count towards rate limiting. Default: true.

    • statuses (pulumi.Input[list]) - HTTP Status codes, can be one [403], many [401,403] or indicate all by not providing this value.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_cloudflare.Record(resource_name, opts=None, data=None, domain=None, name=None, priority=None, proxied=None, ttl=None, type=None, value=None, __props__=None, __name__=None, __opts__=None)

Provides a Cloudflare record resource.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • data (pulumi.Input[dict]) – Map of attributes that constitute the record value. Primarily used for LOC and SRV record types. Either this or value must be specified

  • domain (pulumi.Input[str]) – The DNS zone to add the record to

  • name (pulumi.Input[str]) – The name of the record

  • priority (pulumi.Input[float]) – The priority of the record

  • proxied (pulumi.Input[bool]) – Whether the record gets Cloudflare’s origin protection; defaults to false.

  • ttl (pulumi.Input[float]) – The TTL of the record (automatic: ‘1’)

  • type (pulumi.Input[str]) – The type of the record

  • value (pulumi.Input[str]) – The (string) value of the record. Either this or data must be specified

The data object supports the following:

  • algorithm (pulumi.Input[float])

  • altitude (pulumi.Input[float])

  • certificate (pulumi.Input[str])

  • content (pulumi.Input[str])

  • digest (pulumi.Input[str])

  • digest_type (pulumi.Input[float])

  • fingerprint (pulumi.Input[str])

  • flags (pulumi.Input[str])

  • key_tag (pulumi.Input[float])

  • lat_degrees (pulumi.Input[float])

  • lat_direction (pulumi.Input[str])

  • lat_minutes (pulumi.Input[float])

  • lat_seconds (pulumi.Input[float])

  • long_degrees (pulumi.Input[float])

  • long_direction (pulumi.Input[str])

  • long_minutes (pulumi.Input[float])

  • long_seconds (pulumi.Input[float])

  • matching_type (pulumi.Input[float])

  • name (pulumi.Input[str]) - The name of the record

  • order (pulumi.Input[float])

  • port (pulumi.Input[float])

  • precision_horz (pulumi.Input[float])

  • precision_vert (pulumi.Input[float])

  • preference (pulumi.Input[float])

  • priority (pulumi.Input[float]) - The priority of the record

  • proto (pulumi.Input[str])

  • protocol (pulumi.Input[float])

  • public_key (pulumi.Input[str])

  • regex (pulumi.Input[str])

  • replacement (pulumi.Input[str])

  • selector (pulumi.Input[float])

  • service (pulumi.Input[str])

  • size (pulumi.Input[float])

  • target (pulumi.Input[str])

  • type (pulumi.Input[float]) - The type of the record

  • usage (pulumi.Input[float])

  • weight (pulumi.Input[float])

created_on = None

The RFC3339 timestamp of when the record was created

data = None

Map of attributes that constitute the record value. Primarily used for LOC and SRV record types. Either this or value must be specified

  • algorithm (float)

  • altitude (float)

  • certificate (str)

  • content (str)

  • digest (str)

  • digest_type (float)

  • fingerprint (str)

  • flags (str)

  • key_tag (float)

  • lat_degrees (float)

  • lat_direction (str)

  • lat_minutes (float)

  • lat_seconds (float)

  • long_degrees (float)

  • long_direction (str)

  • long_minutes (float)

  • long_seconds (float)

  • matching_type (float)

  • name (str) - The name of the record

  • order (float)

  • port (float)

  • precision_horz (float)

  • precision_vert (float)

  • preference (float)

  • priority (float) - The priority of the record

  • proto (str)

  • protocol (float)

  • public_key (str)

  • regex (str)

  • replacement (str)

  • selector (float)

  • service (str)

  • size (float)

  • target (str)

  • type (float) - The type of the record

  • usage (float)

  • weight (float)

domain = None

The DNS zone to add the record to

hostname = None

The FQDN of the record

metadata = None

A key-value map of string metadata cloudflare associates with the record

modified_on = None

The RFC3339 timestamp of when the record was last modified

name = None

The name of the record

priority = None

The priority of the record

proxiable = None

Shows whether this record can be proxied, must be true if setting proxied=true

proxied = None

Whether the record gets Cloudflare’s origin protection; defaults to false.

ttl = None

The TTL of the record (automatic: ‘1’)

type = None

The type of the record

value = None

The (string) value of the record. Either this or data must be specified

zone_id = None

The zone id of the record

static get(resource_name, id, opts=None, created_on=None, data=None, domain=None, hostname=None, metadata=None, modified_on=None, name=None, priority=None, proxiable=None, proxied=None, ttl=None, type=None, value=None, zone_id=None)

Get an existing Record resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • created_on (pulumi.Input[str]) – The RFC3339 timestamp of when the record was created

  • data (pulumi.Input[dict]) – Map of attributes that constitute the record value. Primarily used for LOC and SRV record types. Either this or value must be specified

  • domain (pulumi.Input[str]) – The DNS zone to add the record to

  • hostname (pulumi.Input[str]) – The FQDN of the record

  • metadata (pulumi.Input[dict]) – A key-value map of string metadata cloudflare associates with the record

  • modified_on (pulumi.Input[str]) – The RFC3339 timestamp of when the record was last modified

  • name (pulumi.Input[str]) – The name of the record

  • priority (pulumi.Input[float]) – The priority of the record

  • proxiable (pulumi.Input[bool]) – Shows whether this record can be proxied, must be true if setting proxied=true

  • proxied (pulumi.Input[bool]) – Whether the record gets Cloudflare’s origin protection; defaults to false.

  • ttl (pulumi.Input[float]) –

    The TTL of the record (automatic: ‘1’)

  • type (pulumi.Input[str]) – The type of the record

  • value (pulumi.Input[str]) – The (string) value of the record. Either this or data must be specified

  • zone_id (pulumi.Input[str]) – The zone id of the record

The data object supports the following:

  • algorithm (pulumi.Input[float])

  • altitude (pulumi.Input[float])

  • certificate (pulumi.Input[str])

  • content (pulumi.Input[str])

  • digest (pulumi.Input[str])

  • digest_type (pulumi.Input[float])

  • fingerprint (pulumi.Input[str])

  • flags (pulumi.Input[str])

  • key_tag (pulumi.Input[float])

  • lat_degrees (pulumi.Input[float])

  • lat_direction (pulumi.Input[str])

  • lat_minutes (pulumi.Input[float])

  • lat_seconds (pulumi.Input[float])

  • long_degrees (pulumi.Input[float])

  • long_direction (pulumi.Input[str])

  • long_minutes (pulumi.Input[float])

  • long_seconds (pulumi.Input[float])

  • matching_type (pulumi.Input[float])

  • name (pulumi.Input[str]) - The name of the record

  • order (pulumi.Input[float])

  • port (pulumi.Input[float])

  • precision_horz (pulumi.Input[float])

  • precision_vert (pulumi.Input[float])

  • preference (pulumi.Input[float])

  • priority (pulumi.Input[float]) - The priority of the record

  • proto (pulumi.Input[str])

  • protocol (pulumi.Input[float])

  • public_key (pulumi.Input[str])

  • regex (pulumi.Input[str])

  • replacement (pulumi.Input[str])

  • selector (pulumi.Input[float])

  • service (pulumi.Input[str])

  • size (pulumi.Input[float])

  • target (pulumi.Input[str])

  • type (pulumi.Input[float]) - The type of the record

  • usage (pulumi.Input[float])

  • weight (pulumi.Input[float])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_cloudflare.SpectrumApplication(resource_name, opts=None, dns=None, ip_firewall=None, origin_directs=None, origin_dns=None, origin_port=None, protocol=None, proxy_protocol=None, tls=None, zone_id=None, __props__=None, __name__=None, __opts__=None)

Provides a Cloudflare Spectrum Application. You can extend the power of Cloudflare’s DDoS, TLS, and IP Firewall to your other TCP-based services.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • dns (pulumi.Input[dict]) – The name and type of DNS record for the Spectrum application. Fields documented below.

  • ip_firewall (pulumi.Input[bool]) – Enables the IP Firewall for this application. Defaults to true.

  • origin_directs (pulumi.Input[list]) – A list of destination addresses to the origin. e.g. tcp://192.0.2.1:22.

  • origin_dns (pulumi.Input[dict]) – A destination DNS addresses to the origin. Fields documented below.

  • origin_port (pulumi.Input[float]) – If using origin_dns this is a required attribute. Origin port to proxy traffice to e.g. 22.

  • protocol (pulumi.Input[str]) – The port configuration at Cloudflare’s edge. e.g. tcp/22.

  • proxy_protocol (pulumi.Input[bool]) – Enables Proxy Protocol v1 to the origin. Defaults to false.

  • tls (pulumi.Input[str]) – TLS configuration option for Cloudflare to connect to your origin. Valid values are: off, flexible, full and strict. Defaults to off.

The dns object supports the following:

  • name (pulumi.Input[str]) - Fully qualified domain name of the origin e.g. origin-ssh.example.com.

  • type (pulumi.Input[str]) - The type of DNS record associated with the application. Valid values: CNAME.

The origin_dns object supports the following:

  • name (pulumi.Input[str]) - Fully qualified domain name of the origin e.g. origin-ssh.example.com.

dns = None

The name and type of DNS record for the Spectrum application. Fields documented below.

  • name (str) - Fully qualified domain name of the origin e.g. origin-ssh.example.com.

  • type (str) - The type of DNS record associated with the application. Valid values: CNAME.

ip_firewall = None

Enables the IP Firewall for this application. Defaults to true.

origin_directs = None

A list of destination addresses to the origin. e.g. tcp://192.0.2.1:22.

origin_dns = None

A destination DNS addresses to the origin. Fields documented below.

  • name (str) - Fully qualified domain name of the origin e.g. origin-ssh.example.com.

origin_port = None

If using origin_dns this is a required attribute. Origin port to proxy traffice to e.g. 22.

protocol = None

The port configuration at Cloudflare’s edge. e.g. tcp/22.

proxy_protocol = None

Enables Proxy Protocol v1 to the origin. Defaults to false.

tls = None

TLS configuration option for Cloudflare to connect to your origin. Valid values are: off, flexible, full and strict. Defaults to off.

static get(resource_name, id, opts=None, dns=None, ip_firewall=None, origin_directs=None, origin_dns=None, origin_port=None, protocol=None, proxy_protocol=None, tls=None, zone_id=None)

Get an existing SpectrumApplication resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • dns (pulumi.Input[dict]) – The name and type of DNS record for the Spectrum application. Fields documented below.

  • ip_firewall (pulumi.Input[bool]) – Enables the IP Firewall for this application. Defaults to true.

  • origin_directs (pulumi.Input[list]) – A list of destination addresses to the origin. e.g. tcp://192.0.2.1:22.

  • origin_dns (pulumi.Input[dict]) – A destination DNS addresses to the origin. Fields documented below.

  • origin_port (pulumi.Input[float]) – If using origin_dns this is a required attribute. Origin port to proxy traffice to e.g. 22.

  • protocol (pulumi.Input[str]) – The port configuration at Cloudflare’s edge. e.g. tcp/22.

  • proxy_protocol (pulumi.Input[bool]) – Enables Proxy Protocol v1 to the origin. Defaults to false.

  • tls (pulumi.Input[str]) – TLS configuration option for Cloudflare to connect to your origin. Valid values are: off, flexible, full and strict. Defaults to off.

The dns object supports the following:

  • name (pulumi.Input[str]) - Fully qualified domain name of the origin e.g. origin-ssh.example.com.

  • type (pulumi.Input[str]) - The type of DNS record associated with the application. Valid values: CNAME.

The origin_dns object supports the following:

  • name (pulumi.Input[str]) - Fully qualified domain name of the origin e.g. origin-ssh.example.com.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_cloudflare.WafRule(resource_name, opts=None, mode=None, rule_id=None, zone=None, zone_id=None, __props__=None, __name__=None, __opts__=None)

Provides a Cloudflare WAF rule resource for a particular zone. This can be used to configure firewall behaviour for pre-defined firewall rules.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • mode (pulumi.Input[str]) – The mode of the rule, can be one of [“block”, “challenge”, “default”, “disable”, “simulate”].

  • rule_id (pulumi.Input[str]) – The WAF Rule ID.

  • zone (pulumi.Input[str]) – The DNS zone to apply to.

  • zone_id (pulumi.Input[str]) – The DNS zone ID.

mode = None

The mode of the rule, can be one of [“block”, “challenge”, “default”, “disable”, “simulate”].

package_id = None

The ID of the WAF Rule Package that contains the rule.

rule_id = None

The WAF Rule ID.

zone = None

The DNS zone to apply to.

zone_id = None

The DNS zone ID.

static get(resource_name, id, opts=None, mode=None, package_id=None, rule_id=None, zone=None, zone_id=None)

Get an existing WafRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • mode (pulumi.Input[str]) – The mode of the rule, can be one of [“block”, “challenge”, “default”, “disable”, “simulate”].

  • package_id (pulumi.Input[str]) – The ID of the WAF Rule Package that contains the rule.

  • rule_id (pulumi.Input[str]) – The WAF Rule ID.

  • zone (pulumi.Input[str]) – The DNS zone to apply to.

  • zone_id (pulumi.Input[str]) – The DNS zone ID.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_cloudflare.WorkerRoute(resource_name, opts=None, enabled=None, pattern=None, script_name=None, zone=None, zone_id=None, __props__=None, __name__=None, __opts__=None)

Provides a Cloudflare worker route resource. A route will also require a .WorkerScript.

Parameters
* `enabled` (For single-script accounts only) Whether to run the worker script for requests that match the route pattern. Default is `false`
* `script_name` (For multi-script accounts only) Which worker script to run for requests that match the route pattern. If `script_name` is empty, workers will be skipped for matching requests.
Parameters
  • zone (pulumi.Input[str]) – The zone to add the route to.

  • zone_id (pulumi.Input[str]) – The zone id of the route

pattern = None

The route pattern

  • enabled (For single-script accounts only) Whether to run the worker script for requests that match the route pattern. Default is false

  • script_name (For multi-script accounts only) Which worker script to run for requests that match the route pattern. If script_name is empty, workers will be skipped for matching requests.

zone = None

The zone to add the route to.

zone_id = None

The zone id of the route

static get(resource_name, id, opts=None, enabled=None, multi_script=None, pattern=None, script_name=None, zone=None, zone_id=None)

Get an existing WorkerRoute resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • pattern (pulumi.Input[str]) –

    The route pattern

* `enabled` (For single-script accounts only) Whether to run the worker script for requests that match the route pattern. Default is `false`
* `script_name` (For multi-script accounts only) Which worker script to run for requests that match the route pattern. If `script_name` is empty, workers will be skipped for matching requests.
Parameters
  • zone (pulumi.Input[str]) – The zone to add the route to.

  • zone_id (pulumi.Input[str]) – The zone id of the route

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_cloudflare.WorkerScript(resource_name, opts=None, content=None, name=None, zone=None, zone_id=None, __props__=None, __name__=None, __opts__=None)

Provides a Cloudflare worker script resource. In order for a script to be active, you’ll also need to setup a .WorkerRoute.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • content (pulumi.Input[str]) – The script content.

  • name (pulumi.Input[str]) – The name for the script.

  • zone (pulumi.Input[str]) – The zone for the script.

  • zone_id (pulumi.Input[str]) – The zone id of the script (only for non-multi-script resources)

content = None

The script content.

name = None

The name for the script.

zone = None

The zone for the script.

zone_id = None

The zone id of the script (only for non-multi-script resources)

static get(resource_name, id, opts=None, content=None, name=None, zone=None, zone_id=None)

Get an existing WorkerScript resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • content (pulumi.Input[str]) – The script content.

  • name (pulumi.Input[str]) – The name for the script.

  • zone (pulumi.Input[str]) – The zone for the script.

  • zone_id (pulumi.Input[str]) – The zone id of the script (only for non-multi-script resources)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_cloudflare.Zone(resource_name, opts=None, jump_start=None, paused=None, plan=None, type=None, zone=None, __props__=None, __name__=None, __opts__=None)

Provides a Cloudflare Zone resource. Zone is the basic resource for working with Cloudflare and is roughly equivalent to a domain name that the user purchases.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • jump_start (pulumi.Input[bool]) – Boolean of whether to scan for DNS records on creation. Ignored after zone is created. Default: false.

  • paused (pulumi.Input[bool]) – Boolean of whether this zone is paused (traffic bypasses Cloudflare). Default: false.

  • plan (pulumi.Input[str]) – The name of the commercial plan to apply to the zone, can be updated once the one is created; one of free, pro, business, enterprise.

  • type (pulumi.Input[str]) – A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. Valid values: full, partial. Default is full.

  • zone (pulumi.Input[str]) – The DNS zone name which will be added.

jump_start = None

Boolean of whether to scan for DNS records on creation. Ignored after zone is created. Default: false.

name_servers = None

Cloudflare-assigned name servers. This is only populated for zones that use Cloudflare DNS.

paused = None

Boolean of whether this zone is paused (traffic bypasses Cloudflare). Default: false.

plan = None

The name of the commercial plan to apply to the zone, can be updated once the one is created; one of free, pro, business, enterprise.

status = None

Status of the zone. Valid values: active, pending, initializing, moved, deleted, deactivated.

type = None

A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. Valid values: full, partial. Default is full.

vanity_name_servers = None

List of Vanity Nameservers (if set).

  • meta.wildcard_proxiable - Indicates whether wildcard DNS records can receive Cloudflare security and performance features.

  • meta.phishing_detected - Indicates if URLs on the zone have been identified as hosting phishing content.

zone = None

The DNS zone name which will be added.

static get(resource_name, id, opts=None, jump_start=None, meta=None, name_servers=None, paused=None, plan=None, status=None, type=None, vanity_name_servers=None, zone=None)

Get an existing Zone resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • jump_start (pulumi.Input[bool]) – Boolean of whether to scan for DNS records on creation. Ignored after zone is created. Default: false.

  • name_servers (pulumi.Input[list]) – Cloudflare-assigned name servers. This is only populated for zones that use Cloudflare DNS.

  • paused (pulumi.Input[bool]) – Boolean of whether this zone is paused (traffic bypasses Cloudflare). Default: false.

  • plan (pulumi.Input[str]) – The name of the commercial plan to apply to the zone, can be updated once the one is created; one of free, pro, business, enterprise.

  • status (pulumi.Input[str]) – Status of the zone. Valid values: active, pending, initializing, moved, deleted, deactivated.

  • type (pulumi.Input[str]) – A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. Valid values: full, partial. Default is full.

  • vanity_name_servers (pulumi.Input[list]) – List of Vanity Nameservers (if set).

* `meta.wildcard_proxiable` - Indicates whether wildcard DNS records can receive Cloudflare security and performance features.
* `meta.phishing_detected` - Indicates if URLs on the zone have been identified as hosting phishing content.
Parameters

zone (pulumi.Input[str]) – The DNS zone name which will be added.

The meta object supports the following:

  • phishing_detected (pulumi.Input[bool])

  • wildcard_proxiable (pulumi.Input[bool])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_cloudflare.ZoneLockdown(resource_name, opts=None, configurations=None, description=None, paused=None, priority=None, urls=None, zone=None, zone_id=None, __props__=None, __name__=None, __opts__=None)

Provides a Cloudflare Zone Lockdown resource. Zone Lockdown allows you to define one or more URLs (with wildcard matching on the domain or path) that will only permit access if the request originates from an IP address that matches a safelist of one or more IP addresses and/or IP ranges.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • configurations (pulumi.Input[list]) – A list of IP addresses or IP ranges to match the request against specified in target, value pairs. It’s a complex value. See description below. The order of the configuration entries is unimportant.

  • description (pulumi.Input[str]) – A description about the lockdown entry. Typically used as a reminder or explanation for the lockdown.

  • paused (pulumi.Input[bool]) – Boolean of whether this zone lockdown is currently paused. Default: false.

  • urls (pulumi.Input[list]) – A list of simple wildcard patterns to match requests against. The order of the urls is unimportant.

  • zone (pulumi.Input[str]) – The DNS zone to which the lockdown will be added. Will be resolved to zone_id upon creation.

  • zone_id (pulumi.Input[str]) – The DNS zone to which the access rule should be added.

The configurations object supports the following:

  • target (pulumi.Input[str]) - The request property to target. Allowed values: “ip”, “ip_range”

  • value (pulumi.Input[str]) - The value to target. Depends on target’s type. IP addresses should just be standard IPv4/IPv6 notation i.e. 198.51.100.4 or 2001:db8::/32 and IP ranges in CIDR format i.e. 198.51.0.0/16.

configurations = None

A list of IP addresses or IP ranges to match the request against specified in target, value pairs. It’s a complex value. See description below. The order of the configuration entries is unimportant.

  • target (str) - The request property to target. Allowed values: “ip”, “ip_range”

  • value (str) - The value to target. Depends on target’s type. IP addresses should just be standard IPv4/IPv6 notation i.e. 198.51.100.4 or 2001:db8::/32 and IP ranges in CIDR format i.e. 198.51.0.0/16.

description = None

A description about the lockdown entry. Typically used as a reminder or explanation for the lockdown.

paused = None

Boolean of whether this zone lockdown is currently paused. Default: false.

urls = None

A list of simple wildcard patterns to match requests against. The order of the urls is unimportant.

zone = None

The DNS zone to which the lockdown will be added. Will be resolved to zone_id upon creation.

zone_id = None

The DNS zone to which the access rule should be added.

static get(resource_name, id, opts=None, configurations=None, description=None, paused=None, priority=None, urls=None, zone=None, zone_id=None)

Get an existing ZoneLockdown resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • configurations (pulumi.Input[list]) – A list of IP addresses or IP ranges to match the request against specified in target, value pairs. It’s a complex value. See description below. The order of the configuration entries is unimportant.

  • description (pulumi.Input[str]) – A description about the lockdown entry. Typically used as a reminder or explanation for the lockdown.

  • paused (pulumi.Input[bool]) – Boolean of whether this zone lockdown is currently paused. Default: false.

  • urls (pulumi.Input[list]) – A list of simple wildcard patterns to match requests against. The order of the urls is unimportant.

  • zone (pulumi.Input[str]) – The DNS zone to which the lockdown will be added. Will be resolved to zone_id upon creation.

  • zone_id (pulumi.Input[str]) – The DNS zone to which the access rule should be added.

The configurations object supports the following:

  • target (pulumi.Input[str]) - The request property to target. Allowed values: “ip”, “ip_range”

  • value (pulumi.Input[str]) - The value to target. Depends on target’s type. IP addresses should just be standard IPv4/IPv6 notation i.e. 198.51.100.4 or 2001:db8::/32 and IP ranges in CIDR format i.e. 198.51.0.0/16.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_cloudflare.ZoneSettingsOverride(resource_name, opts=None, name=None, settings=None, __props__=None, __name__=None, __opts__=None)

Provides a resource which customizes Cloudflare zone settings. Note that after destroying this resource Zone Settings will be reset to their initial values.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The DNS zone to which apply settings.

  • settings (pulumi.Input[dict]) – Settings overrides that will be applied to the zone. If a setting is not specified the existing setting will be used. For a full list of available settings see below.

The settings object supports the following:

  • alwaysOnline (pulumi.Input[str])

  • alwaysUseHttps (pulumi.Input[str])

  • automaticHttpsRewrites (pulumi.Input[str])

  • brotli (pulumi.Input[str])

  • browserCacheTtl (pulumi.Input[float])

  • browserCheck (pulumi.Input[str])

  • cacheLevel (pulumi.Input[str])

  • challengeTtl (pulumi.Input[float])

  • cnameFlattening (pulumi.Input[str])

  • developmentMode (pulumi.Input[str])

  • edgeCacheTtl (pulumi.Input[float])

  • emailObfuscation (pulumi.Input[str])

  • h2Prioritization (pulumi.Input[str])

  • hotlinkProtection (pulumi.Input[str])

  • http2 (pulumi.Input[str])

  • imageResizing (pulumi.Input[str])

  • ipGeolocation (pulumi.Input[str])

  • ipv6 (pulumi.Input[str])

  • maxUpload (pulumi.Input[float])

  • minTlsVersion (pulumi.Input[str])

  • minify (pulumi.Input[dict])

    • css (pulumi.Input[str]) - “on”/”off”

    • html (pulumi.Input[str]) - “on”/”off”

      • js (Required)”on”/”off”

    • js (pulumi.Input[str])

  • mirage (pulumi.Input[str])

  • mobileRedirect (pulumi.Input[dict])

    • mobileSubdomain (pulumi.Input[str]) - String value

    • status (pulumi.Input[str]) - “on”/”off”

    • stripUri (pulumi.Input[bool]) - true/false

  • opportunisticEncryption (pulumi.Input[str])

  • opportunisticOnion (pulumi.Input[str])

  • originErrorPagePassThru (pulumi.Input[str])

  • polish (pulumi.Input[str])

  • prefetchPreload (pulumi.Input[str])

  • privacyPass (pulumi.Input[str])

  • pseudoIpv4 (pulumi.Input[str])

  • responseBuffering (pulumi.Input[str])

  • rocketLoader (pulumi.Input[str])

  • securityHeader (pulumi.Input[dict])

    • enabled (pulumi.Input[bool]) - true/false

    • includeSubdomains (pulumi.Input[bool]) - true/false

    • maxAge (pulumi.Input[float]) - Integer

    • nosniff (pulumi.Input[bool]) - true/false

    • preload (pulumi.Input[bool]) - true/false

  • securityLevel (pulumi.Input[str])

  • serverSideExclude (pulumi.Input[str])

  • sortQueryStringForCache (pulumi.Input[str])

  • ssl (pulumi.Input[str])

  • tls12Only (pulumi.Input[str])

  • tls13 (pulumi.Input[str])

  • tlsClientAuth (pulumi.Input[str])

  • trueClientIpHeader (pulumi.Input[str])

  • waf (pulumi.Input[str])

  • webp (pulumi.Input[str])

  • websockets (pulumi.Input[str])

initial_settings = None

Settings present in the zone at the time the resource is created. This will be used to restore the original settings when this resource is destroyed. Shares the same schema as the settings attribute (Above).

  • alwaysOnline (str)

  • alwaysUseHttps (str)

  • automaticHttpsRewrites (str)

  • brotli (str)

  • browserCacheTtl (float)

  • browserCheck (str)

  • cacheLevel (str)

  • challengeTtl (float)

  • cnameFlattening (str)

  • developmentMode (str)

  • edgeCacheTtl (float)

  • emailObfuscation (str)

  • h2Prioritization (str)

  • hotlinkProtection (str)

  • http2 (str)

  • imageResizing (str)

  • ipGeolocation (str)

  • ipv6 (str)

  • maxUpload (float)

  • minTlsVersion (str)

  • minify (dict)

    • css (str) - “on”/”off”

    • html (str) - “on”/”off”

      • js (Required)”on”/”off”

    • js (str)

  • mirage (str)

  • mobileRedirect (dict)

    • mobileSubdomain (str) - String value

    • status (str) - “on”/”off”

    • stripUri (bool) - true/false

  • opportunisticEncryption (str)

  • opportunisticOnion (str)

  • originErrorPagePassThru (str)

  • polish (str)

  • prefetchPreload (str)

  • privacyPass (str)

  • pseudoIpv4 (str)

  • responseBuffering (str)

  • rocketLoader (str)

  • securityHeader (dict)

    • enabled (bool) - true/false

    • includeSubdomains (bool) - true/false

    • maxAge (float) - Integer

    • nosniff (bool) - true/false

    • preload (bool) - true/false

  • securityLevel (str)

  • serverSideExclude (str)

  • sortQueryStringForCache (str)

  • ssl (str)

  • tls12Only (str)

  • tls13 (str)

  • tlsClientAuth (str)

  • trueClientIpHeader (str)

  • waf (str)

  • webp (str)

  • websockets (str)

name = None

The DNS zone to which apply settings.

readonly_settings = None

Which of the current settings are not able to be set by the user. Which settings these are is determined by plan level and user permissions.

  • zone_status. A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup.

  • zone_type. Status of the zone. Valid values: active, pending, initializing, moved, deleted, deactivated.

settings = None

Settings overrides that will be applied to the zone. If a setting is not specified the existing setting will be used. For a full list of available settings see below.

  • alwaysOnline (str)

  • alwaysUseHttps (str)

  • automaticHttpsRewrites (str)

  • brotli (str)

  • browserCacheTtl (float)

  • browserCheck (str)

  • cacheLevel (str)

  • challengeTtl (float)

  • cnameFlattening (str)

  • developmentMode (str)

  • edgeCacheTtl (float)

  • emailObfuscation (str)

  • h2Prioritization (str)

  • hotlinkProtection (str)

  • http2 (str)

  • imageResizing (str)

  • ipGeolocation (str)

  • ipv6 (str)

  • maxUpload (float)

  • minTlsVersion (str)

  • minify (dict)

    • css (str) - “on”/”off”

    • html (str) - “on”/”off”

      • js (Required)”on”/”off”

    • js (str)

  • mirage (str)

  • mobileRedirect (dict)

    • mobileSubdomain (str) - String value

    • status (str) - “on”/”off”

    • stripUri (bool) - true/false

  • opportunisticEncryption (str)

  • opportunisticOnion (str)

  • originErrorPagePassThru (str)

  • polish (str)

  • prefetchPreload (str)

  • privacyPass (str)

  • pseudoIpv4 (str)

  • responseBuffering (str)

  • rocketLoader (str)

  • securityHeader (dict)

    • enabled (bool) - true/false

    • includeSubdomains (bool) - true/false

    • maxAge (float) - Integer

    • nosniff (bool) - true/false

    • preload (bool) - true/false

  • securityLevel (str)

  • serverSideExclude (str)

  • sortQueryStringForCache (str)

  • ssl (str)

  • tls12Only (str)

  • tls13 (str)

  • tlsClientAuth (str)

  • trueClientIpHeader (str)

  • waf (str)

  • webp (str)

  • websockets (str)

static get(resource_name, id, opts=None, initial_settings=None, initial_settings_read_at=None, name=None, readonly_settings=None, settings=None, zone_status=None, zone_type=None)

Get an existing ZoneSettingsOverride resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • initial_settings (pulumi.Input[dict]) – Settings present in the zone at the time the resource is created. This will be used to restore the original settings when this resource is destroyed. Shares the same schema as the settings attribute (Above).

  • name (pulumi.Input[str]) – The DNS zone to which apply settings.

  • readonly_settings (pulumi.Input[list]) – Which of the current settings are not able to be set by the user. Which settings these are is determined by plan level and user permissions.

* `zone_status`. A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup.
* `zone_type`. Status of the zone. Valid values: active, pending, initializing, moved, deleted, deactivated.
Parameters

settings (pulumi.Input[dict]) – Settings overrides that will be applied to the zone. If a setting is not specified the existing setting will be used. For a full list of available settings see below.

The initial_settings object supports the following:

  • alwaysOnline (pulumi.Input[str])

  • alwaysUseHttps (pulumi.Input[str])

  • automaticHttpsRewrites (pulumi.Input[str])

  • brotli (pulumi.Input[str])

  • browserCacheTtl (pulumi.Input[float])

  • browserCheck (pulumi.Input[str])

  • cacheLevel (pulumi.Input[str])

  • challengeTtl (pulumi.Input[float])

  • cnameFlattening (pulumi.Input[str])

  • developmentMode (pulumi.Input[str])

  • edgeCacheTtl (pulumi.Input[float])

  • emailObfuscation (pulumi.Input[str])

  • h2Prioritization (pulumi.Input[str])

  • hotlinkProtection (pulumi.Input[str])

  • http2 (pulumi.Input[str])

  • imageResizing (pulumi.Input[str])

  • ipGeolocation (pulumi.Input[str])

  • ipv6 (pulumi.Input[str])

  • maxUpload (pulumi.Input[float])

  • minTlsVersion (pulumi.Input[str])

  • minify (pulumi.Input[dict])

    • css (pulumi.Input[str]) - “on”/”off”

    • html (pulumi.Input[str]) - “on”/”off”

      • js (Required)”on”/”off”

    • js (pulumi.Input[str])

  • mirage (pulumi.Input[str])

  • mobileRedirect (pulumi.Input[dict])

    • mobileSubdomain (pulumi.Input[str]) - String value

    • status (pulumi.Input[str]) - “on”/”off”

    • stripUri (pulumi.Input[bool]) - true/false

  • opportunisticEncryption (pulumi.Input[str])

  • opportunisticOnion (pulumi.Input[str])

  • originErrorPagePassThru (pulumi.Input[str])

  • polish (pulumi.Input[str])

  • prefetchPreload (pulumi.Input[str])

  • privacyPass (pulumi.Input[str])

  • pseudoIpv4 (pulumi.Input[str])

  • responseBuffering (pulumi.Input[str])

  • rocketLoader (pulumi.Input[str])

  • securityHeader (pulumi.Input[dict])

    • enabled (pulumi.Input[bool]) - true/false

    • includeSubdomains (pulumi.Input[bool]) - true/false

    • maxAge (pulumi.Input[float]) - Integer

    • nosniff (pulumi.Input[bool]) - true/false

    • preload (pulumi.Input[bool]) - true/false

  • securityLevel (pulumi.Input[str])

  • serverSideExclude (pulumi.Input[str])

  • sortQueryStringForCache (pulumi.Input[str])

  • ssl (pulumi.Input[str])

  • tls12Only (pulumi.Input[str])

  • tls13 (pulumi.Input[str])

  • tlsClientAuth (pulumi.Input[str])

  • trueClientIpHeader (pulumi.Input[str])

  • waf (pulumi.Input[str])

  • webp (pulumi.Input[str])

  • websockets (pulumi.Input[str])

The settings object supports the following:

  • alwaysOnline (pulumi.Input[str])

  • alwaysUseHttps (pulumi.Input[str])

  • automaticHttpsRewrites (pulumi.Input[str])

  • brotli (pulumi.Input[str])

  • browserCacheTtl (pulumi.Input[float])

  • browserCheck (pulumi.Input[str])

  • cacheLevel (pulumi.Input[str])

  • challengeTtl (pulumi.Input[float])

  • cnameFlattening (pulumi.Input[str])

  • developmentMode (pulumi.Input[str])

  • edgeCacheTtl (pulumi.Input[float])

  • emailObfuscation (pulumi.Input[str])

  • h2Prioritization (pulumi.Input[str])

  • hotlinkProtection (pulumi.Input[str])

  • http2 (pulumi.Input[str])

  • imageResizing (pulumi.Input[str])

  • ipGeolocation (pulumi.Input[str])

  • ipv6 (pulumi.Input[str])

  • maxUpload (pulumi.Input[float])

  • minTlsVersion (pulumi.Input[str])

  • minify (pulumi.Input[dict])

    • css (pulumi.Input[str]) - “on”/”off”

    • html (pulumi.Input[str]) - “on”/”off”

      • js (Required)”on”/”off”

    • js (pulumi.Input[str])

  • mirage (pulumi.Input[str])

  • mobileRedirect (pulumi.Input[dict])

    • mobileSubdomain (pulumi.Input[str]) - String value

    • status (pulumi.Input[str]) - “on”/”off”

    • stripUri (pulumi.Input[bool]) - true/false

  • opportunisticEncryption (pulumi.Input[str])

  • opportunisticOnion (pulumi.Input[str])

  • originErrorPagePassThru (pulumi.Input[str])

  • polish (pulumi.Input[str])

  • prefetchPreload (pulumi.Input[str])

  • privacyPass (pulumi.Input[str])

  • pseudoIpv4 (pulumi.Input[str])

  • responseBuffering (pulumi.Input[str])

  • rocketLoader (pulumi.Input[str])

  • securityHeader (pulumi.Input[dict])

    • enabled (pulumi.Input[bool]) - true/false

    • includeSubdomains (pulumi.Input[bool]) - true/false

    • maxAge (pulumi.Input[float]) - Integer

    • nosniff (pulumi.Input[bool]) - true/false

    • preload (pulumi.Input[bool]) - true/false

  • securityLevel (pulumi.Input[str])

  • serverSideExclude (pulumi.Input[str])

  • sortQueryStringForCache (pulumi.Input[str])

  • ssl (pulumi.Input[str])

  • tls12Only (pulumi.Input[str])

  • tls13 (pulumi.Input[str])

  • tlsClientAuth (pulumi.Input[str])

  • trueClientIpHeader (pulumi.Input[str])

  • waf (pulumi.Input[str])

  • webp (pulumi.Input[str])

  • websockets (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_cloudflare.get_ip_ranges(opts=None)

Use this data source to get the [IP ranges][1] of Cloudflare edge nodes.

pulumi_cloudflare.get_zones(filter=None, opts=None)

Use this data source to look up [Zone][1] records.

The filter object supports the following:

  • name (str)

  • paused (bool)

  • status (str)