From e9b77c6d88da29042e1cff38dd5b16f4c836a871 Mon Sep 17 00:00:00 2001 From: Jacob Bednarz Date: Fri, 6 Dec 2024 15:03:00 +1100 Subject: [PATCH] docs: run generation --- docs/data-sources/access_rule.md | 9 + docs/data-sources/access_rules.md | 16 + docs/data-sources/account.md | 7 + docs/data-sources/account_member.md | 8 + docs/data-sources/account_members.md | 36 +- docs/data-sources/account_role.md | 8 + docs/data-sources/account_roles.md | 20 +- docs/data-sources/account_subscription.md | 7 + docs/data-sources/account_token.md | 8 + docs/data-sources/account_tokens.md | 10 +- docs/data-sources/accounts.md | 6 +- docs/data-sources/address_map.md | 8 + docs/data-sources/address_maps.md | 7 + docs/data-sources/api_shield.md | 8 + docs/data-sources/api_shield_operation.md | 17 + ...ld_operation_schema_validation_settings.md | 8 + docs/data-sources/api_shield_operations.md | 15 + docs/data-sources/api_shield_schema.md | 9 + .../api_shield_schema_validation_settings.md | 7 + docs/data-sources/api_shield_schemas.md | 8 + docs/data-sources/api_token.md | 7 + docs/data-sources/api_tokens.md | 9 +- docs/data-sources/argo_smart_routing.md | 7 + docs/data-sources/argo_tiered_caching.md | 7 + .../authenticated_origin_pulls.md | 8 + .../authenticated_origin_pulls_certificate.md | 8 + ...authenticated_origin_pulls_certificates.md | 7 + docs/data-sources/bot_management.md | 7 + docs/data-sources/byo_ip_prefix.md | 8 + docs/data-sources/byo_ip_prefixes.md | 7 + docs/data-sources/calls_sfu_app.md | 8 + docs/data-sources/calls_sfu_apps.md | 7 + docs/data-sources/calls_turn_app.md | 8 + docs/data-sources/calls_turn_apps.md | 7 + docs/data-sources/certificate_pack.md | 8 + docs/data-sources/certificate_packs.md | 8 + docs/data-sources/cloudforce_one_request.md | 8 + .../cloudforce_one_request_asset.md | 9 + .../cloudforce_one_request_message.md | 14 + .../cloudforce_one_request_priority.md | 8 + docs/data-sources/cloudforce_one_requests.md | 7 + docs/data-sources/custom_hostname.md | 8 + .../custom_hostname_fallback_origin.md | 7 + docs/data-sources/custom_hostnames.md | 11 + docs/data-sources/custom_ssl.md | 8 + docs/data-sources/custom_ssls.md | 8 + docs/data-sources/d1_database.md | 8 + docs/data-sources/d1_databases.md | 8 + docs/data-sources/dcv_delegation.md | 7 + docs/data-sources/dns_firewall.md | 8 + docs/data-sources/dns_firewalls.md | 7 + docs/data-sources/dns_record.md | 7 +- docs/data-sources/dns_records.md | 37 ++ ...y_dns_acl.md => dns_zone_transfers_acl.md} | 12 +- ...dns_acls.md => dns_zone_transfers_acls.md} | 11 +- .../dns_zone_transfers_incoming.md} | 19 +- .../dns_zone_transfers_outgoing.md} | 15 +- ...dns_peer.md => dns_zone_transfers_peer.md} | 12 +- ...s_peers.md => dns_zone_transfers_peers.md} | 11 +- ...dns_tsig.md => dns_zone_transfers_tsig.md} | 12 +- ...s_tsigs.md => dns_zone_transfers_tsigs.md} | 11 +- docs/data-sources/email_routing_address.md | 8 + docs/data-sources/email_routing_addresses.md | 7 + docs/data-sources/email_routing_catch_all.md | 7 + docs/data-sources/email_routing_dns.md | 8 + docs/data-sources/email_routing_rule.md | 8 + docs/data-sources/email_routing_rules.md | 8 + docs/data-sources/email_routing_settings.md | 7 + .../email_security_block_sender.md | 8 + .../email_security_block_senders.md | 11 + ...email_security_impersonation_registries.md | 11 + .../email_security_impersonation_registry.md | 8 + .../email_security_trusted_domains.md | 19 +- .../email_security_trusted_domains_list.md | 21 +- docs/data-sources/filter.md | 8 + docs/data-sources/filters.md | 12 + docs/data-sources/firewall_rule.md | 9 + docs/data-sources/firewall_rules.md | 11 + docs/data-sources/healthcheck.md | 8 + docs/data-sources/healthchecks.md | 7 + docs/data-sources/hostname_tls_setting.md | 8 + docs/data-sources/hyperdrive_config.md | 8 + docs/data-sources/hyperdrive_configs.md | 7 + docs/data-sources/image.md | 42 +- docs/data-sources/image_variant.md | 8 + docs/data-sources/images.md | 41 +- docs/data-sources/keyless_certificate.md | 8 + docs/data-sources/keyless_certificates.md | 7 + docs/data-sources/leaked_credential_check.md | 31 ++ docs/data-sources/list.md | 7 +- docs/data-sources/list_item.md | 9 + docs/data-sources/list_items.md | 9 + docs/data-sources/lists.md | 5 +- docs/data-sources/load_balancer.md | 8 + docs/data-sources/load_balancer_monitor.md | 8 + docs/data-sources/load_balancer_monitors.md | 7 + docs/data-sources/load_balancer_pool.md | 8 + docs/data-sources/load_balancer_pools.md | 9 +- docs/data-sources/load_balancers.md | 13 +- docs/data-sources/logpull_retention.md | 7 + docs/data-sources/logpush_dataset_field.md | 9 + docs/data-sources/logpush_dataset_job.md | 9 + docs/data-sources/logpush_job.md | 9 + docs/data-sources/logpush_jobs.md | 8 + .../magic_network_monitoring_configuration.md | 7 + .../magic_network_monitoring_rule.md | 8 + .../magic_network_monitoring_rules.md | 7 + docs/data-sources/magic_transit_connector.md | 8 + docs/data-sources/magic_transit_connectors.md | 7 + docs/data-sources/magic_transit_site.md | 8 + docs/data-sources/magic_transit_site_acl.md | 9 + docs/data-sources/magic_transit_site_acls.md | 8 + docs/data-sources/magic_transit_site_lan.md | 9 + docs/data-sources/magic_transit_site_lans.md | 8 + docs/data-sources/magic_transit_site_wan.md | 9 + docs/data-sources/magic_transit_site_wans.md | 8 + docs/data-sources/magic_transit_sites.md | 8 + docs/data-sources/magic_wan_gre_tunnel.md | 8 + docs/data-sources/magic_wan_ipsec_tunnel.md | 8 + docs/data-sources/magic_wan_static_route.md | 8 + docs/data-sources/managed_transforms.md | 7 + docs/data-sources/mtls_certificate.md | 8 + docs/data-sources/mtls_certificates.md | 7 + docs/data-sources/notification_policies.md | 7 + docs/data-sources/notification_policy.md | 8 + .../notification_policy_webhooks.md | 8 + .../notification_policy_webhooks_list.md | 7 + .../observatory_scheduled_test.md | 9 + docs/data-sources/origin_ca_certificate.md | 5 +- docs/data-sources/origin_ca_certificates.md | 7 + docs/data-sources/page_rule.md | 38 +- docs/data-sources/page_shield_connections.md | 8 + .../page_shield_connections_list.md | 19 + docs/data-sources/page_shield_cookies.md | 8 + docs/data-sources/page_shield_cookies_list.md | 21 + docs/data-sources/page_shield_policies.md | 7 + docs/data-sources/page_shield_policy.md | 8 + docs/data-sources/page_shield_scripts.md | 8 + docs/data-sources/page_shield_scripts_list.md | 18 + docs/data-sources/pages_domain.md | 9 + docs/data-sources/pages_domains.md | 8 + docs/data-sources/pages_project.md | 8 + docs/data-sources/pages_projects.md | 7 + docs/data-sources/permission_group.md | 8 + docs/data-sources/permission_groups.md | 10 + docs/data-sources/queue.md | 8 + docs/data-sources/queue_consumer.md | 8 + docs/data-sources/queues.md | 7 + docs/data-sources/r2_bucket.md | 8 + docs/data-sources/rate_limit.md | 8 + docs/data-sources/rate_limits.md | 7 + docs/data-sources/regional_hostname.md | 8 + docs/data-sources/regional_hostnames.md | 7 + docs/data-sources/regional_tiered_cache.md | 7 + docs/data-sources/registrar_domain.md | 8 + docs/data-sources/registrar_domains.md | 7 + docs/data-sources/resource_group.md | 8 + docs/data-sources/resource_groups.md | 9 + docs/data-sources/ruleset.md | 59 ++- docs/data-sources/rulesets.md | 10 +- docs/data-sources/secondary_dns_outgoing.md | 30 -- docs/data-sources/spectrum_application.md | 93 +--- docs/data-sources/spectrum_applications.md | 96 +--- docs/data-sources/stream.md | 8 + docs/data-sources/stream_audio_track.md | 8 + docs/data-sources/stream_caption_language.md | 9 + docs/data-sources/stream_download.md | 8 + docs/data-sources/stream_key.md | 7 + docs/data-sources/stream_live_input.md | 8 + docs/data-sources/stream_watermark.md | 8 + docs/data-sources/stream_watermarks.md | 7 + docs/data-sources/stream_webhook.md | 7 + docs/data-sources/streams.md | 13 + docs/data-sources/tiered_cache.md | 7 + docs/data-sources/total_tls.md | 7 + docs/data-sources/turnstile_widget.md | 8 + docs/data-sources/turnstile_widgets.md | 9 + .../url_normalization_settings.md | 7 + docs/data-sources/user_agent_blocking_rule.md | 8 + .../data-sources/user_agent_blocking_rules.md | 10 + docs/data-sources/waiting_room.md | 20 +- docs/data-sources/waiting_room_event.md | 9 + docs/data-sources/waiting_room_events.md | 8 + docs/data-sources/waiting_room_rules.md | 8 + docs/data-sources/waiting_room_settings.md | 7 + docs/data-sources/waiting_rooms.md | 19 +- docs/data-sources/web3_hostname.md | 8 + docs/data-sources/web3_hostnames.md | 7 + docs/data-sources/web_analytics_site.md | 8 + docs/data-sources/web_analytics_sites.md | 8 + docs/data-sources/workers_cron_trigger.md | 8 + docs/data-sources/workers_custom_domain.md | 8 + docs/data-sources/workers_custom_domains.md | 12 + docs/data-sources/workers_deployment.md | 8 + ...orkers_for_platforms_dispatch_namespace.md | 8 + ...rkers_for_platforms_dispatch_namespaces.md | 7 + docs/data-sources/workers_kv.md | 9 + docs/data-sources/workers_kv_namespace.md | 8 + docs/data-sources/workers_kv_namespaces.md | 9 + docs/data-sources/workers_script.md | 8 + docs/data-sources/workers_script_subdomain.md | 8 + docs/data-sources/workers_scripts.md | 7 + docs/data-sources/workers_secret.md | 10 + docs/data-sources/workers_secrets.md | 9 + .../zero_trust_access_application.md | 39 +- .../zero_trust_access_applications.md | 134 ++--- .../zero_trust_access_custom_page.md | 8 + .../zero_trust_access_custom_pages.md | 7 + docs/data-sources/zero_trust_access_group.md | 9 + docs/data-sources/zero_trust_access_groups.md | 10 + .../zero_trust_access_identity_provider.md | 22 +- .../zero_trust_access_identity_providers.md | 13 +- ...zero_trust_access_infrastructure_target.md | 12 +- ...ero_trust_access_infrastructure_targets.md | 18 +- .../zero_trust_access_key_configuration.md | 7 + .../zero_trust_access_mtls_certificate.md | 9 + .../zero_trust_access_mtls_certificates.md | 8 + ...ero_trust_access_mtls_hostname_settings.md | 8 + .../zero_trust_access_policies.md | 7 + docs/data-sources/zero_trust_access_policy.md | 8 + .../zero_trust_access_service_token.md | 9 + .../zero_trust_access_service_tokens.md | 10 + ...ro_trust_access_short_lived_certificate.md | 9 + ...o_trust_access_short_lived_certificates.md | 8 + docs/data-sources/zero_trust_access_tag.md | 8 + docs/data-sources/zero_trust_access_tags.md | 7 + .../zero_trust_device_custom_profile.md | 8 + ...ce_custom_profile_local_domain_fallback.md | 8 + .../zero_trust_device_custom_profiles.md | 7 + .../zero_trust_device_default_profile.md | 7 + ...ust_device_default_profile_certificates.md | 7 + ...e_default_profile_local_domain_fallback.md | 7 + .../zero_trust_device_managed_networks.md | 8 + ...zero_trust_device_managed_networks_list.md | 7 + .../zero_trust_device_posture_integration.md | 8 + .../zero_trust_device_posture_integrations.md | 7 + .../zero_trust_device_posture_rule.md | 10 +- .../zero_trust_device_posture_rules.md | 9 +- docs/data-sources/zero_trust_dex_test.md | 8 + docs/data-sources/zero_trust_dex_tests.md | 7 + .../zero_trust_dlp_custom_profile.md | 8 + docs/data-sources/zero_trust_dlp_dataset.md | 8 + docs/data-sources/zero_trust_dlp_datasets.md | 7 + .../zero_trust_dlp_predefined_profile.md | 8 + docs/data-sources/zero_trust_dns_location.md | 8 + docs/data-sources/zero_trust_dns_locations.md | 9 +- .../zero_trust_gateway_policies.md | 9 +- .../data-sources/zero_trust_gateway_policy.md | 8 + .../zero_trust_gateway_proxy_endpoint.md | 8 + .../zero_trust_gateway_settings.md | 7 + docs/data-sources/zero_trust_list.md | 8 + docs/data-sources/zero_trust_lists.md | 8 + docs/data-sources/zero_trust_organization.md | 8 + .../zero_trust_risk_scoring_integration.md | 8 + .../zero_trust_risk_scoring_integrations.md | 7 + .../zero_trust_tunnel_cloudflared.md | 7 +- .../zero_trust_tunnel_cloudflared_config.md | 10 +- .../zero_trust_tunnel_cloudflared_route.md | 8 + .../zero_trust_tunnel_cloudflared_routes.md | 16 + ...rust_tunnel_cloudflared_virtual_network.md | 8 + ...ust_tunnel_cloudflared_virtual_networks.md | 11 + .../zero_trust_tunnel_cloudflareds.md | 16 + docs/data-sources/zone.md | 13 +- docs/data-sources/zone_cache_reserve.md | 5 +- docs/data-sources/zone_cache_variants.md | 7 + docs/data-sources/zone_dnssec.md | 7 + docs/data-sources/zone_hold.md | 7 + docs/data-sources/zone_lockdown.md | 8 + docs/data-sources/zone_lockdowns.md | 16 + docs/data-sources/zone_setting.md | 8 + docs/data-sources/zone_subscription.md | 7 + docs/data-sources/zones.md | 51 +- docs/guides/version-5-upgrade.md | 15 +- docs/index.md | 12 +- docs/resources/access_rule.md | 52 +- docs/resources/account.md | 13 +- docs/resources/account_member.md | 15 +- docs/resources/account_subscription.md | 17 + docs/resources/account_token.md | 45 ++ docs/resources/address_map.md | 29 +- docs/resources/api_shield.md | 13 +- docs/resources/api_shield_operation.md | 10 +- ...ld_operation_schema_validation_settings.md | 22 +- docs/resources/api_shield_schema.md | 13 +- .../api_shield_schema_validation_settings.md | 13 +- docs/resources/api_token.md | 149 ++---- docs/resources/argo_smart_routing.md | 14 + docs/resources/argo_tiered_caching.md | 14 + docs/resources/authenticated_origin_pulls.md | 54 +- .../authenticated_origin_pulls_certificate.md | 72 ++- docs/resources/bot_management.md | 16 +- docs/resources/byo_ip_prefix.md | 13 +- docs/resources/calls_sfu_app.md | 8 + docs/resources/calls_turn_app.md | 8 + docs/resources/certificate_pack.md | 33 +- docs/resources/cloudforce_one_request.md | 18 + .../resources/cloudforce_one_request_asset.md | 10 + .../cloudforce_one_request_message.md | 15 + .../cloudforce_one_request_priority.md | 17 + docs/resources/custom_hostname.md | 58 +- .../custom_hostname_fallback_origin.md | 9 +- docs/resources/custom_ssl.md | 75 ++- docs/resources/d1_database.md | 9 +- docs/resources/dns_firewall.md | 26 + docs/resources/dns_record.md | 17 +- ...y_dns_acl.md => dns_zone_transfers_acl.md} | 19 +- .../dns_zone_transfers_incoming.md} | 28 +- docs/resources/dns_zone_transfers_outgoing.md | 45 ++ ...dns_peer.md => dns_zone_transfers_peer.md} | 18 +- docs/resources/dns_zone_transfers_tsig.md | 43 ++ docs/resources/email_routing_address.md | 9 +- docs/resources/email_routing_catch_all.md | 27 +- docs/resources/email_routing_dns.md | 14 + docs/resources/email_routing_rule.md | 26 +- docs/resources/email_routing_settings.md | 12 +- docs/resources/email_security_block_sender.md | 17 + .../email_security_impersonation_registry.md | 16 + .../email_security_trusted_domains.md | 34 +- docs/resources/filter.md | 13 +- docs/resources/firewall_rule.md | 34 +- docs/resources/healthcheck.md | 86 ++- docs/resources/hostname_tls_setting.md | 13 +- docs/resources/hyperdrive_config.md | 22 +- docs/resources/image.md | 21 + docs/resources/image_variant.md | 21 + docs/resources/keyless_certificate.md | 20 +- docs/resources/leaked_credential_check.md | 32 ++ docs/resources/list.md | 109 +--- docs/resources/list_item.md | 95 +--- docs/resources/load_balancer.md | 145 +++-- docs/resources/load_balancer_monitor.md | 51 +- docs/resources/load_balancer_pool.md | 64 ++- docs/resources/logpull_retention.md | 13 +- docs/resources/logpush_job.md | 111 +--- docs/resources/logpush_ownership_challenge.md | 7 +- .../magic_network_monitoring_configuration.md | 15 + .../magic_network_monitoring_rule.md | 19 + docs/resources/magic_transit_connector.md | 19 + docs/resources/magic_transit_site.md | 22 + docs/resources/magic_transit_site_acl.md | 30 ++ docs/resources/magic_transit_site_lan.md | 39 ++ docs/resources/magic_transit_site_wan.md | 17 + docs/resources/magic_wan_gre_tunnel.md | 21 +- docs/resources/magic_wan_ipsec_tunnel.md | 38 +- docs/resources/magic_wan_static_route.md | 22 +- docs/resources/managed_transforms.md | 21 + docs/resources/mtls_certificate.md | 23 +- docs/resources/notification_policy.md | 104 ++-- .../resources/notification_policy_webhooks.md | 13 +- docs/resources/observatory_scheduled_test.md | 11 +- docs/resources/origin_ca_certificate.md | 41 +- docs/resources/page_shield_policy.md | 18 + docs/resources/pages_domain.md | 10 +- docs/resources/pages_project.md | 284 +++++----- docs/resources/queue.md | 9 +- docs/resources/queue_consumer.md | 17 + docs/resources/r2_bucket.md | 11 +- docs/resources/rate_limit.md | 68 +-- docs/resources/regional_hostname.md | 27 +- docs/resources/regional_tiered_cache.md | 9 +- docs/resources/registrar_domain.md | 11 + docs/resources/ruleset.md | 496 +++--------------- docs/resources/secondary_dns_tsig.md | 27 - docs/resources/spectrum_application.md | 34 +- docs/resources/stream.md | 7 + docs/resources/stream_audio_track.md | 11 + docs/resources/stream_caption_language.md | 9 + docs/resources/stream_download.md | 8 + docs/resources/stream_key.md | 13 + docs/resources/stream_live_input.md | 19 + docs/resources/stream_watermark.md | 13 + docs/resources/stream_webhook.md | 8 + docs/resources/tiered_cache.md | 13 +- docs/resources/total_tls.md | 11 +- docs/resources/turnstile_widget.md | 18 +- docs/resources/url_normalization_settings.md | 15 +- docs/resources/user_agent_blocking_rule.md | 34 +- docs/resources/waiting_room.md | 55 +- docs/resources/waiting_room_event.md | 27 +- docs/resources/waiting_room_rules.md | 29 +- docs/resources/waiting_room_settings.md | 7 +- docs/resources/web3_hostname.md | 17 + docs/resources/web_analytics_rule.md | 28 +- docs/resources/web_analytics_site.md | 10 +- docs/resources/workers_cron_trigger.md | 24 +- docs/resources/workers_custom_domain.md | 17 + docs/resources/workers_deployment.md | 22 + ...orkers_for_platforms_dispatch_namespace.md | 17 +- docs/resources/workers_kv.md | 19 +- docs/resources/workers_kv_namespace.md | 9 +- docs/resources/workers_script.md | 110 ++-- docs/resources/workers_script_subdomain.md | 10 + docs/resources/workers_secret.md | 15 +- .../zero_trust_access_application.md | 104 +++- .../zero_trust_access_custom_page.md | 18 +- docs/resources/zero_trust_access_group.md | 48 +- .../zero_trust_access_identity_provider.md | 64 +-- ...zero_trust_access_infrastructure_target.md | 28 +- .../zero_trust_access_key_configuration.md | 14 + .../zero_trust_access_mtls_certificate.md | 22 +- ...ero_trust_access_mtls_hostname_settings.md | 19 +- docs/resources/zero_trust_access_policy.md | 42 +- .../zero_trust_access_service_token.md | 29 +- ...ro_trust_access_short_lived_certificate.md | 20 +- docs/resources/zero_trust_access_tag.md | 14 + .../zero_trust_device_custom_profile.md | 34 ++ ...ce_custom_profile_local_domain_fallback.md | 19 + .../zero_trust_device_default_profile.md | 21 + ...ust_device_default_profile_certificates.md | 8 + ...e_default_profile_local_domain_fallback.md | 12 + .../zero_trust_device_managed_networks.md | 15 +- .../zero_trust_device_posture_integration.md | 21 +- .../zero_trust_device_posture_rule.md | 38 +- docs/resources/zero_trust_dex_test.md | 25 +- .../zero_trust_dlp_custom_profile.md | 39 ++ docs/resources/zero_trust_dlp_dataset.md | 11 + .../zero_trust_dlp_predefined_profile.md | 27 + docs/resources/zero_trust_dns_location.md | 45 +- docs/resources/zero_trust_gateway_policy.md | 101 +++- .../zero_trust_gateway_proxy_endpoint.md | 11 +- docs/resources/zero_trust_gateway_settings.md | 122 ++--- docs/resources/zero_trust_list.md | 19 +- docs/resources/zero_trust_organization.md | 27 + .../zero_trust_risk_scoring_integration.md | 16 + .../zero_trust_tunnel_cloudflared.md | 12 +- .../zero_trust_tunnel_cloudflared_config.md | 106 ++-- .../zero_trust_tunnel_cloudflared_route.md | 17 + ...rust_tunnel_cloudflared_virtual_network.md | 16 + docs/resources/zone.md | 11 +- docs/resources/zone_cache_reserve.md | 9 +- docs/resources/zone_cache_variants.md | 35 +- docs/resources/zone_dnssec.md | 16 + docs/resources/zone_hold.md | 8 +- docs/resources/zone_lockdown.md | 18 +- docs/resources/zone_setting.md | 16 + docs/resources/zone_subscription.md | 17 + templates/data-sources.md.tmpl | 5 +- templates/resources.md.tmpl | 5 +- 438 files changed, 5515 insertions(+), 2972 deletions(-) rename docs/data-sources/{secondary_dns_acl.md => dns_zone_transfers_acl.md} (70%) rename docs/data-sources/{secondary_dns_acls.md => dns_zone_transfers_acls.md} (74%) rename docs/{resources/secondary_dns_incoming.md => data-sources/dns_zone_transfers_incoming.md} (68%) rename docs/{resources/secondary_dns_outgoing.md => data-sources/dns_zone_transfers_outgoing.md} (63%) rename docs/data-sources/{secondary_dns_peer.md => dns_zone_transfers_peer.md} (76%) rename docs/data-sources/{secondary_dns_peers.md => dns_zone_transfers_peers.md} (79%) rename docs/data-sources/{secondary_dns_tsig.md => dns_zone_transfers_tsig.md} (59%) rename docs/data-sources/{secondary_dns_tsigs.md => dns_zone_transfers_tsigs.md} (64%) create mode 100644 docs/data-sources/leaked_credential_check.md delete mode 100644 docs/data-sources/secondary_dns_outgoing.md rename docs/resources/{secondary_dns_acl.md => dns_zone_transfers_acl.md} (54%) rename docs/{data-sources/secondary_dns_incoming.md => resources/dns_zone_transfers_incoming.md} (52%) create mode 100644 docs/resources/dns_zone_transfers_outgoing.md rename docs/resources/{secondary_dns_peer.md => dns_zone_transfers_peer.md} (65%) create mode 100644 docs/resources/dns_zone_transfers_tsig.md create mode 100644 docs/resources/leaked_credential_check.md delete mode 100644 docs/resources/secondary_dns_tsig.md diff --git a/docs/data-sources/access_rule.md b/docs/data-sources/access_rule.md index dc2f5ff76b..0de3436232 100644 --- a/docs/data-sources/access_rule.md +++ b/docs/data-sources/access_rule.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_access_rule" "example_access_rule" { + rule_id = "023e105f4ecef8ad9ca31a8372d0c353" + account_id = "account_id" + zone_id = "zone_id" +} +``` ## Schema diff --git a/docs/data-sources/access_rules.md b/docs/data-sources/access_rules.md index ad8a12cd20..63af2f9911 100644 --- a/docs/data-sources/access_rules.md +++ b/docs/data-sources/access_rules.md @@ -9,6 +9,22 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_access_rules" "example_access_rules" { + account_id = "account_id" + zone_id = "zone_id" + configuration = { + target = "ip" + value = "198.51.100.4" + } + direction = "asc" + mode = "block" + notes = "my note" + order = "configuration.target" +} +``` ## Schema diff --git a/docs/data-sources/account.md b/docs/data-sources/account.md index 42fe1a0763..baec560381 100644 --- a/docs/data-sources/account.md +++ b/docs/data-sources/account.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_account" "example_account" { + account_id = "eb78d65290b24279ba6f44721b3ea3c4" +} +``` ## Schema diff --git a/docs/data-sources/account_member.md b/docs/data-sources/account_member.md index 31c4642ee0..4fb6508a64 100644 --- a/docs/data-sources/account_member.md +++ b/docs/data-sources/account_member.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_account_member" "example_account_member" { + account_id = "eb78d65290b24279ba6f44721b3ea3c4" + member_id = "4536bcfad5faccb111b47003c79917fa" +} +``` ## Schema diff --git a/docs/data-sources/account_members.md b/docs/data-sources/account_members.md index 29018b4cb7..41553ffebe 100644 --- a/docs/data-sources/account_members.md +++ b/docs/data-sources/account_members.md @@ -9,6 +9,16 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_account_members" "example_account_members" { + account_id = "eb78d65290b24279ba6f44721b3ea3c4" + direction = "asc" + order = "user.first_name" + status = "accepted" +} +``` ## Schema @@ -59,7 +69,7 @@ Read-Only: - `name` (String) Name of the group. -### Nested Schema for `result.policies.permission_groups.name` +### Nested Schema for `result.policies.permission_groups.meta` Read-Only: @@ -79,7 +89,7 @@ Read-Only: - `scope` (Attributes List) The scope associated to the resource group (see [below for nested schema](#nestedatt--result--policies--resource_groups--scope)) -### Nested Schema for `result.policies.resource_groups.scope` +### Nested Schema for `result.policies.resource_groups.meta` Read-Only: @@ -135,7 +145,7 @@ Read-Only: - `zones` (Attributes) (see [below for nested schema](#nestedatt--result--roles--permissions--zones)) -### Nested Schema for `result.roles.permissions.zones` +### Nested Schema for `result.roles.permissions.analytics` Read-Only: @@ -144,7 +154,7 @@ Read-Only: -### Nested Schema for `result.roles.permissions.zones` +### Nested Schema for `result.roles.permissions.billing` Read-Only: @@ -153,7 +163,7 @@ Read-Only: -### Nested Schema for `result.roles.permissions.zones` +### Nested Schema for `result.roles.permissions.cache_purge` Read-Only: @@ -162,7 +172,7 @@ Read-Only: -### Nested Schema for `result.roles.permissions.zones` +### Nested Schema for `result.roles.permissions.dns` Read-Only: @@ -171,7 +181,7 @@ Read-Only: -### Nested Schema for `result.roles.permissions.zones` +### Nested Schema for `result.roles.permissions.dns_records` Read-Only: @@ -180,7 +190,7 @@ Read-Only: -### Nested Schema for `result.roles.permissions.zones` +### Nested Schema for `result.roles.permissions.lb` Read-Only: @@ -189,7 +199,7 @@ Read-Only: -### Nested Schema for `result.roles.permissions.zones` +### Nested Schema for `result.roles.permissions.logs` Read-Only: @@ -198,7 +208,7 @@ Read-Only: -### Nested Schema for `result.roles.permissions.zones` +### Nested Schema for `result.roles.permissions.organization` Read-Only: @@ -207,7 +217,7 @@ Read-Only: -### Nested Schema for `result.roles.permissions.zones` +### Nested Schema for `result.roles.permissions.ssl` Read-Only: @@ -216,7 +226,7 @@ Read-Only: -### Nested Schema for `result.roles.permissions.zones` +### Nested Schema for `result.roles.permissions.waf` Read-Only: @@ -225,7 +235,7 @@ Read-Only: -### Nested Schema for `result.roles.permissions.zones` +### Nested Schema for `result.roles.permissions.zone_settings` Read-Only: diff --git a/docs/data-sources/account_role.md b/docs/data-sources/account_role.md index 1ec8868d2b..b06062de87 100644 --- a/docs/data-sources/account_role.md +++ b/docs/data-sources/account_role.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_account_role" "example_account_role" { + account_id = "eb78d65290b24279ba6f44721b3ea3c4" + role_id = "3536bcfad5faccb999b47003c79917fb" +} +``` ## Schema diff --git a/docs/data-sources/account_roles.md b/docs/data-sources/account_roles.md index 3b8d94d91c..6c8f2b5482 100644 --- a/docs/data-sources/account_roles.md +++ b/docs/data-sources/account_roles.md @@ -12,25 +12,11 @@ description: |- ## Example Usage ```terraform -data "cloudflare_account_roles" "account_roles" { - account_id = "f037e56e89293a057740de681ac9abbe" -} - -locals { - roles_by_name = { - for role in data.cloudflare_account_roles.account_roles.roles : - role.name => role - } -} - -resource "cloudflare_account_member" "member" { - account_id = "f037e56e89293a057740de681ac9abbe" - email_address = "user@example.com" - role_ids = [ - local.roles_by_name["Administrator"].id - ] +data "cloudflare_account_roles" "example_account_roles" { + account_id = "eb78d65290b24279ba6f44721b3ea3c4" } ``` + ## Schema diff --git a/docs/data-sources/account_subscription.md b/docs/data-sources/account_subscription.md index 37c2a82240..e3a1ef64d8 100644 --- a/docs/data-sources/account_subscription.md +++ b/docs/data-sources/account_subscription.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_account_subscription" "example_account_subscription" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/account_token.md b/docs/data-sources/account_token.md index 2607a4b229..22e857b4cc 100644 --- a/docs/data-sources/account_token.md +++ b/docs/data-sources/account_token.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_account_token" "example_account_token" { + account_id = "eb78d65290b24279ba6f44721b3ea3c4" + token_id = "ed17574386854bf78a67040be0a770b0" +} +``` ## Schema diff --git a/docs/data-sources/account_tokens.md b/docs/data-sources/account_tokens.md index 03352edcc4..58806f43da 100644 --- a/docs/data-sources/account_tokens.md +++ b/docs/data-sources/account_tokens.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_account_tokens" "example_account_tokens" { + account_id = "eb78d65290b24279ba6f44721b3ea3c4" + direction = "asc" +} +``` ## Schema @@ -79,7 +87,7 @@ Read-Only: - `name` (String) Name of the group. -### Nested Schema for `result.policies.permission_groups.name` +### Nested Schema for `result.policies.permission_groups.meta` Read-Only: diff --git a/docs/data-sources/accounts.md b/docs/data-sources/accounts.md index ce5c87b94d..f60964d7b5 100644 --- a/docs/data-sources/accounts.md +++ b/docs/data-sources/accounts.md @@ -12,10 +12,12 @@ description: |- ## Example Usage ```terraform -data "cloudflare_accounts" "example" { - name = "example account" +data "cloudflare_accounts" "example_accounts" { + direction = "asc" + name = "example.com" } ``` + ## Schema diff --git a/docs/data-sources/address_map.md b/docs/data-sources/address_map.md index 836118a036..926b1cac26 100644 --- a/docs/data-sources/address_map.md +++ b/docs/data-sources/address_map.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_address_map" "example_address_map" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + address_map_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/address_maps.md b/docs/data-sources/address_maps.md index 0dd8a7cf1c..edb00e7e18 100644 --- a/docs/data-sources/address_maps.md +++ b/docs/data-sources/address_maps.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_address_maps" "example_address_maps" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/api_shield.md b/docs/data-sources/api_shield.md index 3e1b698331..72ca443319 100644 --- a/docs/data-sources/api_shield.md +++ b/docs/data-sources/api_shield.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_api_shield" "example_api_shield" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + properties = ["auth_id_characteristics"] +} +``` ## Schema diff --git a/docs/data-sources/api_shield_operation.md b/docs/data-sources/api_shield_operation.md index d8da507291..0a97167c6f 100644 --- a/docs/data-sources/api_shield_operation.md +++ b/docs/data-sources/api_shield_operation.md @@ -9,6 +9,23 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_api_shield_operation" "example_api_shield_operation" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + diff = true + direction = "asc" + endpoint = "/api/v1" + host = ["api.cloudflare.com"] + method = ["GET"] + order = "host" + origin = "ML" + page = 1 + per_page = 5 + state = "review" +} +``` ## Schema diff --git a/docs/data-sources/api_shield_operation_schema_validation_settings.md b/docs/data-sources/api_shield_operation_schema_validation_settings.md index 5d94586ecd..4c0618e944 100644 --- a/docs/data-sources/api_shield_operation_schema_validation_settings.md +++ b/docs/data-sources/api_shield_operation_schema_validation_settings.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_api_shield_operation_schema_validation_settings" "example_api_shield_operation_schema_validation_settings" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + operation_id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" +} +``` ## Schema diff --git a/docs/data-sources/api_shield_operations.md b/docs/data-sources/api_shield_operations.md index 8b82beb91c..632e517b0f 100644 --- a/docs/data-sources/api_shield_operations.md +++ b/docs/data-sources/api_shield_operations.md @@ -9,6 +9,21 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_api_shield_operations" "example_api_shield_operations" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + diff = true + direction = "asc" + endpoint = "/api/v1" + host = ["api.cloudflare.com"] + method = ["GET"] + order = "host" + origin = "ML" + state = "review" +} +``` ## Schema diff --git a/docs/data-sources/api_shield_schema.md b/docs/data-sources/api_shield_schema.md index cffc5464e3..fbe97be23e 100644 --- a/docs/data-sources/api_shield_schema.md +++ b/docs/data-sources/api_shield_schema.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_api_shield_schema" "example_api_shield_schema" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + schema_id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" + omit_source = true +} +``` ## Schema diff --git a/docs/data-sources/api_shield_schema_validation_settings.md b/docs/data-sources/api_shield_schema_validation_settings.md index d2e42e2b1e..f658bcca37 100644 --- a/docs/data-sources/api_shield_schema_validation_settings.md +++ b/docs/data-sources/api_shield_schema_validation_settings.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_api_shield_schema_validation_settings" "example_api_shield_schema_validation_settings" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/api_shield_schemas.md b/docs/data-sources/api_shield_schemas.md index 065d4ed249..bd3013edc3 100644 --- a/docs/data-sources/api_shield_schemas.md +++ b/docs/data-sources/api_shield_schemas.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_api_shield_schemas" "example_api_shield_schemas" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + validation_enabled = true +} +``` ## Schema diff --git a/docs/data-sources/api_token.md b/docs/data-sources/api_token.md index 518c08263b..ff16cbd059 100644 --- a/docs/data-sources/api_token.md +++ b/docs/data-sources/api_token.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_api_token" "example_api_token" { + token_id = "ed17574386854bf78a67040be0a770b0" +} +``` ## Schema diff --git a/docs/data-sources/api_tokens.md b/docs/data-sources/api_tokens.md index fd31b930b2..f32848e044 100644 --- a/docs/data-sources/api_tokens.md +++ b/docs/data-sources/api_tokens.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_api_tokens" "example_api_tokens" { + direction = "asc" +} +``` ## Schema @@ -75,7 +82,7 @@ Read-Only: - `name` (String) Name of the group. -### Nested Schema for `result.policies.permission_groups.name` +### Nested Schema for `result.policies.permission_groups.meta` Read-Only: diff --git a/docs/data-sources/argo_smart_routing.md b/docs/data-sources/argo_smart_routing.md index 23e00264b8..484eba6429 100644 --- a/docs/data-sources/argo_smart_routing.md +++ b/docs/data-sources/argo_smart_routing.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_argo_smart_routing" "example_argo_smart_routing" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/argo_tiered_caching.md b/docs/data-sources/argo_tiered_caching.md index 400c3920da..4ed9add75f 100644 --- a/docs/data-sources/argo_tiered_caching.md +++ b/docs/data-sources/argo_tiered_caching.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_argo_tiered_caching" "example_argo_tiered_caching" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/authenticated_origin_pulls.md b/docs/data-sources/authenticated_origin_pulls.md index 2e9b7b42c2..596696e96a 100644 --- a/docs/data-sources/authenticated_origin_pulls.md +++ b/docs/data-sources/authenticated_origin_pulls.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_authenticated_origin_pulls" "example_authenticated_origin_pulls" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + hostname = "app.example.com" +} +``` ## Schema diff --git a/docs/data-sources/authenticated_origin_pulls_certificate.md b/docs/data-sources/authenticated_origin_pulls_certificate.md index e618340cde..040a395b54 100644 --- a/docs/data-sources/authenticated_origin_pulls_certificate.md +++ b/docs/data-sources/authenticated_origin_pulls_certificate.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_authenticated_origin_pulls_certificate" "example_authenticated_origin_pulls_certificate" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + certificate_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/authenticated_origin_pulls_certificates.md b/docs/data-sources/authenticated_origin_pulls_certificates.md index 31148b6a89..97e2650a37 100644 --- a/docs/data-sources/authenticated_origin_pulls_certificates.md +++ b/docs/data-sources/authenticated_origin_pulls_certificates.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_authenticated_origin_pulls_certificates" "example_authenticated_origin_pulls_certificates" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/bot_management.md b/docs/data-sources/bot_management.md index fbc0ea90fb..f8bdcfa1de 100644 --- a/docs/data-sources/bot_management.md +++ b/docs/data-sources/bot_management.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_bot_management" "example_bot_management" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/byo_ip_prefix.md b/docs/data-sources/byo_ip_prefix.md index 607e1881b1..baca0efcd2 100644 --- a/docs/data-sources/byo_ip_prefix.md +++ b/docs/data-sources/byo_ip_prefix.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_byo_ip_prefix" "example_byo_ip_prefix" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + prefix_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/byo_ip_prefixes.md b/docs/data-sources/byo_ip_prefixes.md index b6f55ff1e4..6dd21c4a80 100644 --- a/docs/data-sources/byo_ip_prefixes.md +++ b/docs/data-sources/byo_ip_prefixes.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_byo_ip_prefixes" "example_byo_ip_prefixes" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/calls_sfu_app.md b/docs/data-sources/calls_sfu_app.md index a727f0c4b7..bb9ad1cc6d 100644 --- a/docs/data-sources/calls_sfu_app.md +++ b/docs/data-sources/calls_sfu_app.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_calls_sfu_app" "example_calls_sfu_app" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + app_id = "2a95132c15732412d22c1476fa83f27a" +} +``` ## Schema diff --git a/docs/data-sources/calls_sfu_apps.md b/docs/data-sources/calls_sfu_apps.md index 2f51b735ce..bcbdd91ced 100644 --- a/docs/data-sources/calls_sfu_apps.md +++ b/docs/data-sources/calls_sfu_apps.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_calls_sfu_apps" "example_calls_sfu_apps" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/calls_turn_app.md b/docs/data-sources/calls_turn_app.md index ab811c7c6b..4c75ffd3de 100644 --- a/docs/data-sources/calls_turn_app.md +++ b/docs/data-sources/calls_turn_app.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_calls_turn_app" "example_calls_turn_app" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + key_id = "2a95132c15732412d22c1476fa83f27a" +} +``` ## Schema diff --git a/docs/data-sources/calls_turn_apps.md b/docs/data-sources/calls_turn_apps.md index e964ac82a6..65ec0f2a1c 100644 --- a/docs/data-sources/calls_turn_apps.md +++ b/docs/data-sources/calls_turn_apps.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_calls_turn_apps" "example_calls_turn_apps" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/certificate_pack.md b/docs/data-sources/certificate_pack.md index 1a57408461..170af198a9 100644 --- a/docs/data-sources/certificate_pack.md +++ b/docs/data-sources/certificate_pack.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_certificate_pack" "example_certificate_pack" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + certificate_pack_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/certificate_packs.md b/docs/data-sources/certificate_packs.md index 2c73664986..c4aeec7558 100644 --- a/docs/data-sources/certificate_packs.md +++ b/docs/data-sources/certificate_packs.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_certificate_packs" "example_certificate_packs" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + status = "all" +} +``` ## Schema diff --git a/docs/data-sources/cloudforce_one_request.md b/docs/data-sources/cloudforce_one_request.md index 61545a9d22..341302425d 100644 --- a/docs/data-sources/cloudforce_one_request.md +++ b/docs/data-sources/cloudforce_one_request.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_cloudforce_one_request" "example_cloudforce_one_request" { + account_identifier = "023e105f4ecef8ad9ca31a8372d0c353" + request_identifier = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" +} +``` ## Schema diff --git a/docs/data-sources/cloudforce_one_request_asset.md b/docs/data-sources/cloudforce_one_request_asset.md index 8d3b542211..407f6c6112 100644 --- a/docs/data-sources/cloudforce_one_request_asset.md +++ b/docs/data-sources/cloudforce_one_request_asset.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_cloudforce_one_request_asset" "example_cloudforce_one_request_asset" { + account_identifier = "023e105f4ecef8ad9ca31a8372d0c353" + request_identifier = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" + asset_identifer = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" +} +``` ## Schema diff --git a/docs/data-sources/cloudforce_one_request_message.md b/docs/data-sources/cloudforce_one_request_message.md index 6132590ff5..5894e1b222 100644 --- a/docs/data-sources/cloudforce_one_request_message.md +++ b/docs/data-sources/cloudforce_one_request_message.md @@ -9,6 +9,20 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_cloudforce_one_request_message" "example_cloudforce_one_request_message" { + account_identifier = "023e105f4ecef8ad9ca31a8372d0c353" + request_identifier = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" + page = 0 + per_page = 10 + after = "2022-01-01T00:00:00Z" + before = "2024-01-01T00:00:00Z" + sort_by = "created" + sort_order = "asc" +} +``` ## Schema diff --git a/docs/data-sources/cloudforce_one_request_priority.md b/docs/data-sources/cloudforce_one_request_priority.md index b6e061e820..ec2b90d2e0 100644 --- a/docs/data-sources/cloudforce_one_request_priority.md +++ b/docs/data-sources/cloudforce_one_request_priority.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_cloudforce_one_request_priority" "example_cloudforce_one_request_priority" { + account_identifier = "023e105f4ecef8ad9ca31a8372d0c353" + priority_identifer = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" +} +``` ## Schema diff --git a/docs/data-sources/cloudforce_one_requests.md b/docs/data-sources/cloudforce_one_requests.md index f42af87aa1..e6271c7bd6 100644 --- a/docs/data-sources/cloudforce_one_requests.md +++ b/docs/data-sources/cloudforce_one_requests.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_cloudforce_one_requests" "example_cloudforce_one_requests" { + account_identifier = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/custom_hostname.md b/docs/data-sources/custom_hostname.md index e1f43ec40f..6e0d765e8b 100644 --- a/docs/data-sources/custom_hostname.md +++ b/docs/data-sources/custom_hostname.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_custom_hostname" "example_custom_hostname" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + custom_hostname_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/custom_hostname_fallback_origin.md b/docs/data-sources/custom_hostname_fallback_origin.md index 61a31fba62..a2f75d461c 100644 --- a/docs/data-sources/custom_hostname_fallback_origin.md +++ b/docs/data-sources/custom_hostname_fallback_origin.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_custom_hostname_fallback_origin" "example_custom_hostname_fallback_origin" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/custom_hostnames.md b/docs/data-sources/custom_hostnames.md index 0cc3f91370..aedc414042 100644 --- a/docs/data-sources/custom_hostnames.md +++ b/docs/data-sources/custom_hostnames.md @@ -9,6 +9,17 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_custom_hostnames" "example_custom_hostnames" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + id = "0d89c70d-ad9f-4843-b99f-6cc0252067e9" + direction = "asc" + hostname = "app.example.com" + ssl = 0 +} +``` ## Schema diff --git a/docs/data-sources/custom_ssl.md b/docs/data-sources/custom_ssl.md index aa041efc91..6b0cbdb224 100644 --- a/docs/data-sources/custom_ssl.md +++ b/docs/data-sources/custom_ssl.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_custom_ssl" "example_custom_ssl" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + custom_certificate_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/custom_ssls.md b/docs/data-sources/custom_ssls.md index e3f4a31540..63a4872585 100644 --- a/docs/data-sources/custom_ssls.md +++ b/docs/data-sources/custom_ssls.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_custom_ssls" "example_custom_ssls" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + status = "active" +} +``` ## Schema diff --git a/docs/data-sources/d1_database.md b/docs/data-sources/d1_database.md index 4468a29b65..3126980ae6 100644 --- a/docs/data-sources/d1_database.md +++ b/docs/data-sources/d1_database.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_d1_database" "example_d1_database" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +} +``` ## Schema diff --git a/docs/data-sources/d1_databases.md b/docs/data-sources/d1_databases.md index e56c96799e..cfca2379f8 100644 --- a/docs/data-sources/d1_databases.md +++ b/docs/data-sources/d1_databases.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_d1_databases" "example_d1_databases" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + name = "name" +} +``` ## Schema diff --git a/docs/data-sources/dcv_delegation.md b/docs/data-sources/dcv_delegation.md index 2db547c236..67e0c6a374 100644 --- a/docs/data-sources/dcv_delegation.md +++ b/docs/data-sources/dcv_delegation.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_dcv_delegation" "example_dcv_delegation" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/dns_firewall.md b/docs/data-sources/dns_firewall.md index fc8b14b5cf..e6b070e5ea 100644 --- a/docs/data-sources/dns_firewall.md +++ b/docs/data-sources/dns_firewall.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_dns_firewall" "example_dns_firewall" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + dns_firewall_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/dns_firewalls.md b/docs/data-sources/dns_firewalls.md index a2abf742ed..af53a4b708 100644 --- a/docs/data-sources/dns_firewalls.md +++ b/docs/data-sources/dns_firewalls.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_dns_firewalls" "example_dns_firewalls" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/dns_record.md b/docs/data-sources/dns_record.md index ba89648071..ff0f8632c0 100644 --- a/docs/data-sources/dns_record.md +++ b/docs/data-sources/dns_record.md @@ -12,11 +12,12 @@ description: |- ## Example Usage ```terraform -data "cloudflare_dns_record" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - hostname = "example.com" +data "cloudflare_dns_record" "example_dns_record" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + dns_record_id = "023e105f4ecef8ad9ca31a8372d0c353" } ``` + ## Schema diff --git a/docs/data-sources/dns_records.md b/docs/data-sources/dns_records.md index 4c581b957e..26d355c10a 100644 --- a/docs/data-sources/dns_records.md +++ b/docs/data-sources/dns_records.md @@ -9,6 +9,43 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_dns_records" "example_dns_records" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + comment = { + absent = "absent" + contains = "ello, worl" + endswith = "o, world" + exact = "Hello, world" + present = "present" + startswith = "Hello, w" + } + content = { + contains = "7.0.0." + endswith = ".0.1" + exact = "127.0.0.1" + startswith = "127.0." + } + name = { + contains = "w.example." + endswith = ".example.com" + exact = "www.example.com" + startswith = "www.example" + } + search = "www.cloudflare.com" + tag = { + absent = "important" + contains = "greeting:ello, worl" + endswith = "greeting:o, world" + exact = "greeting:Hello, world" + present = "important" + startswith = "greeting:Hello, w" + } + type = "A" +} +``` ## Schema diff --git a/docs/data-sources/secondary_dns_acl.md b/docs/data-sources/dns_zone_transfers_acl.md similarity index 70% rename from docs/data-sources/secondary_dns_acl.md rename to docs/data-sources/dns_zone_transfers_acl.md index 03c37e0637..752110f78a 100644 --- a/docs/data-sources/secondary_dns_acl.md +++ b/docs/data-sources/dns_zone_transfers_acl.md @@ -1,14 +1,22 @@ --- -page_title: "cloudflare_secondary_dns_acl Data Source - Cloudflare" +page_title: "cloudflare_dns_zone_transfers_acl Data Source - Cloudflare" subcategory: "" description: |- --- -# cloudflare_secondary_dns_acl (Data Source) +# cloudflare_dns_zone_transfers_acl (Data Source) +## Example Usage + +```terraform +data "cloudflare_dns_zone_transfers_acl" "example_dns_zone_transfers_acl" { + account_id = "01a7362d577a6c3019a474fd6f485823" + acl_id = "23ff594956f20c2a721606e94745a8aa" +} +``` ## Schema diff --git a/docs/data-sources/secondary_dns_acls.md b/docs/data-sources/dns_zone_transfers_acls.md similarity index 74% rename from docs/data-sources/secondary_dns_acls.md rename to docs/data-sources/dns_zone_transfers_acls.md index 1cec33b9b1..eb8d3ec8fe 100644 --- a/docs/data-sources/secondary_dns_acls.md +++ b/docs/data-sources/dns_zone_transfers_acls.md @@ -1,14 +1,21 @@ --- -page_title: "cloudflare_secondary_dns_acls Data Source - Cloudflare" +page_title: "cloudflare_dns_zone_transfers_acls Data Source - Cloudflare" subcategory: "" description: |- --- -# cloudflare_secondary_dns_acls (Data Source) +# cloudflare_dns_zone_transfers_acls (Data Source) +## Example Usage + +```terraform +data "cloudflare_dns_zone_transfers_acls" "example_dns_zone_transfers_acls" { + account_id = "01a7362d577a6c3019a474fd6f485823" +} +``` ## Schema diff --git a/docs/resources/secondary_dns_incoming.md b/docs/data-sources/dns_zone_transfers_incoming.md similarity index 68% rename from docs/resources/secondary_dns_incoming.md rename to docs/data-sources/dns_zone_transfers_incoming.md index d6cb224d2a..734f93a5fb 100644 --- a/docs/resources/secondary_dns_incoming.md +++ b/docs/data-sources/dns_zone_transfers_incoming.md @@ -1,32 +1,39 @@ --- -page_title: "cloudflare_secondary_dns_incoming Resource - Cloudflare" +page_title: "cloudflare_dns_zone_transfers_incoming Data Source - Cloudflare" subcategory: "" description: |- --- -# cloudflare_secondary_dns_incoming (Resource) +# cloudflare_dns_zone_transfers_incoming (Data Source) +## Example Usage + +```terraform +data "cloudflare_dns_zone_transfers_incoming" "example_dns_zone_transfers_incoming" { + zone_id = "269d8f4853475ca241c4e730be286b20" +} +``` ## Schema ### Required -- `auto_refresh_seconds` (Number) How often should a secondary zone auto refresh regardless of DNS NOTIFY. -Not applicable for primary zones. -- `name` (String) Zone name. -- `peers` (List of String) A list of peer tags. - `zone_id` (String) ### Read-Only +- `auto_refresh_seconds` (Number) How often should a secondary zone auto refresh regardless of DNS NOTIFY. +Not applicable for primary zones. - `checked_time` (String) The time for a specific event. - `created_time` (String) The time for a specific event. - `id` (String) The ID of this resource. - `modified_time` (String) The time for a specific event. +- `name` (String) Zone name. +- `peers` (List of String) A list of peer tags. - `soa_serial` (Number) The serial number of the SOA for the given zone. diff --git a/docs/resources/secondary_dns_outgoing.md b/docs/data-sources/dns_zone_transfers_outgoing.md similarity index 63% rename from docs/resources/secondary_dns_outgoing.md rename to docs/data-sources/dns_zone_transfers_outgoing.md index 5fc4faeb35..1556a6d994 100644 --- a/docs/resources/secondary_dns_outgoing.md +++ b/docs/data-sources/dns_zone_transfers_outgoing.md @@ -1,22 +1,27 @@ --- -page_title: "cloudflare_secondary_dns_outgoing Resource - Cloudflare" +page_title: "cloudflare_dns_zone_transfers_outgoing Data Source - Cloudflare" subcategory: "" description: |- --- -# cloudflare_secondary_dns_outgoing (Resource) +# cloudflare_dns_zone_transfers_outgoing (Data Source) +## Example Usage + +```terraform +data "cloudflare_dns_zone_transfers_outgoing" "example_dns_zone_transfers_outgoing" { + zone_id = "269d8f4853475ca241c4e730be286b20" +} +``` ## Schema ### Required -- `name` (String) Zone name. -- `peers` (List of String) A list of peer tags. - `zone_id` (String) ### Read-Only @@ -25,6 +30,8 @@ description: |- - `created_time` (String) The time for a specific event. - `id` (String) The ID of this resource. - `last_transferred_time` (String) The time for a specific event. +- `name` (String) Zone name. +- `peers` (List of String) A list of peer tags. - `soa_serial` (Number) The serial number of the SOA for the given zone. diff --git a/docs/data-sources/secondary_dns_peer.md b/docs/data-sources/dns_zone_transfers_peer.md similarity index 76% rename from docs/data-sources/secondary_dns_peer.md rename to docs/data-sources/dns_zone_transfers_peer.md index 93f9bd470c..dfbeb0123b 100644 --- a/docs/data-sources/secondary_dns_peer.md +++ b/docs/data-sources/dns_zone_transfers_peer.md @@ -1,14 +1,22 @@ --- -page_title: "cloudflare_secondary_dns_peer Data Source - Cloudflare" +page_title: "cloudflare_dns_zone_transfers_peer Data Source - Cloudflare" subcategory: "" description: |- --- -# cloudflare_secondary_dns_peer (Data Source) +# cloudflare_dns_zone_transfers_peer (Data Source) +## Example Usage + +```terraform +data "cloudflare_dns_zone_transfers_peer" "example_dns_zone_transfers_peer" { + account_id = "01a7362d577a6c3019a474fd6f485823" + peer_id = "23ff594956f20c2a721606e94745a8aa" +} +``` ## Schema diff --git a/docs/data-sources/secondary_dns_peers.md b/docs/data-sources/dns_zone_transfers_peers.md similarity index 79% rename from docs/data-sources/secondary_dns_peers.md rename to docs/data-sources/dns_zone_transfers_peers.md index ad9023ccfe..769f3577f2 100644 --- a/docs/data-sources/secondary_dns_peers.md +++ b/docs/data-sources/dns_zone_transfers_peers.md @@ -1,14 +1,21 @@ --- -page_title: "cloudflare_secondary_dns_peers Data Source - Cloudflare" +page_title: "cloudflare_dns_zone_transfers_peers Data Source - Cloudflare" subcategory: "" description: |- --- -# cloudflare_secondary_dns_peers (Data Source) +# cloudflare_dns_zone_transfers_peers (Data Source) +## Example Usage + +```terraform +data "cloudflare_dns_zone_transfers_peers" "example_dns_zone_transfers_peers" { + account_id = "01a7362d577a6c3019a474fd6f485823" +} +``` ## Schema diff --git a/docs/data-sources/secondary_dns_tsig.md b/docs/data-sources/dns_zone_transfers_tsig.md similarity index 59% rename from docs/data-sources/secondary_dns_tsig.md rename to docs/data-sources/dns_zone_transfers_tsig.md index af88076bf2..61efb6fb7d 100644 --- a/docs/data-sources/secondary_dns_tsig.md +++ b/docs/data-sources/dns_zone_transfers_tsig.md @@ -1,14 +1,22 @@ --- -page_title: "cloudflare_secondary_dns_tsig Data Source - Cloudflare" +page_title: "cloudflare_dns_zone_transfers_tsig Data Source - Cloudflare" subcategory: "" description: |- --- -# cloudflare_secondary_dns_tsig (Data Source) +# cloudflare_dns_zone_transfers_tsig (Data Source) +## Example Usage + +```terraform +data "cloudflare_dns_zone_transfers_tsig" "example_dns_zone_transfers_tsig" { + account_id = "01a7362d577a6c3019a474fd6f485823" + tsig_id = "69cd1e104af3e6ed3cb344f263fd0d5a" +} +``` ## Schema diff --git a/docs/data-sources/secondary_dns_tsigs.md b/docs/data-sources/dns_zone_transfers_tsigs.md similarity index 64% rename from docs/data-sources/secondary_dns_tsigs.md rename to docs/data-sources/dns_zone_transfers_tsigs.md index 051dc8b500..f30a6e6049 100644 --- a/docs/data-sources/secondary_dns_tsigs.md +++ b/docs/data-sources/dns_zone_transfers_tsigs.md @@ -1,14 +1,21 @@ --- -page_title: "cloudflare_secondary_dns_tsigs Data Source - Cloudflare" +page_title: "cloudflare_dns_zone_transfers_tsigs Data Source - Cloudflare" subcategory: "" description: |- --- -# cloudflare_secondary_dns_tsigs (Data Source) +# cloudflare_dns_zone_transfers_tsigs (Data Source) +## Example Usage + +```terraform +data "cloudflare_dns_zone_transfers_tsigs" "example_dns_zone_transfers_tsigs" { + account_id = "01a7362d577a6c3019a474fd6f485823" +} +``` ## Schema diff --git a/docs/data-sources/email_routing_address.md b/docs/data-sources/email_routing_address.md index 38c7766285..302902a5bf 100644 --- a/docs/data-sources/email_routing_address.md +++ b/docs/data-sources/email_routing_address.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_email_routing_address" "example_email_routing_address" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + destination_address_identifier = "ea95132c15732412d22c1476fa83f27a" +} +``` ## Schema diff --git a/docs/data-sources/email_routing_addresses.md b/docs/data-sources/email_routing_addresses.md index c1a745ccb3..8221a07588 100644 --- a/docs/data-sources/email_routing_addresses.md +++ b/docs/data-sources/email_routing_addresses.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_email_routing_addresses" "example_email_routing_addresses" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/email_routing_catch_all.md b/docs/data-sources/email_routing_catch_all.md index 3d23b9d0dd..24cf7b7656 100644 --- a/docs/data-sources/email_routing_catch_all.md +++ b/docs/data-sources/email_routing_catch_all.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_email_routing_catch_all" "example_email_routing_catch_all" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/email_routing_dns.md b/docs/data-sources/email_routing_dns.md index 227f4389e2..1bcad6890a 100644 --- a/docs/data-sources/email_routing_dns.md +++ b/docs/data-sources/email_routing_dns.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_email_routing_dns" "example_email_routing_dns" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + subdomain = "example.net" +} +``` ## Schema diff --git a/docs/data-sources/email_routing_rule.md b/docs/data-sources/email_routing_rule.md index c9dfa1ac60..59154ec48c 100644 --- a/docs/data-sources/email_routing_rule.md +++ b/docs/data-sources/email_routing_rule.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_email_routing_rule" "example_email_routing_rule" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + rule_identifier = "a7e6fb77503c41d8a7f3113c6918f10c" +} +``` ## Schema diff --git a/docs/data-sources/email_routing_rules.md b/docs/data-sources/email_routing_rules.md index dde79347f5..f48ce9cd55 100644 --- a/docs/data-sources/email_routing_rules.md +++ b/docs/data-sources/email_routing_rules.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_email_routing_rules" "example_email_routing_rules" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + enabled = true +} +``` ## Schema diff --git a/docs/data-sources/email_routing_settings.md b/docs/data-sources/email_routing_settings.md index 14cd48b720..4cf14d77f2 100644 --- a/docs/data-sources/email_routing_settings.md +++ b/docs/data-sources/email_routing_settings.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_email_routing_settings" "example_email_routing_settings" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/email_security_block_sender.md b/docs/data-sources/email_security_block_sender.md index bcb09f2bd7..85bb656ec4 100644 --- a/docs/data-sources/email_security_block_sender.md +++ b/docs/data-sources/email_security_block_sender.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_email_security_block_sender" "example_email_security_block_sender" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + pattern_id = 2402 +} +``` ## Schema diff --git a/docs/data-sources/email_security_block_senders.md b/docs/data-sources/email_security_block_senders.md index 665157af57..1f3fd3c55f 100644 --- a/docs/data-sources/email_security_block_senders.md +++ b/docs/data-sources/email_security_block_senders.md @@ -9,6 +9,17 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_email_security_block_senders" "example_email_security_block_senders" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + direction = "asc" + order = "pattern" + pattern_type = "EMAIL" + search = "search" +} +``` ## Schema diff --git a/docs/data-sources/email_security_impersonation_registries.md b/docs/data-sources/email_security_impersonation_registries.md index 48de0ad212..7e76dd5a09 100644 --- a/docs/data-sources/email_security_impersonation_registries.md +++ b/docs/data-sources/email_security_impersonation_registries.md @@ -9,6 +9,17 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_email_security_impersonation_registries" "example_email_security_impersonation_registries" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + direction = "asc" + order = "name" + provenance = "A1S_INTERNAL" + search = "search" +} +``` ## Schema diff --git a/docs/data-sources/email_security_impersonation_registry.md b/docs/data-sources/email_security_impersonation_registry.md index 552865f067..a840d1944f 100644 --- a/docs/data-sources/email_security_impersonation_registry.md +++ b/docs/data-sources/email_security_impersonation_registry.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_email_security_impersonation_registry" "example_email_security_impersonation_registry" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + display_name_id = 2403 +} +``` ## Schema diff --git a/docs/data-sources/email_security_trusted_domains.md b/docs/data-sources/email_security_trusted_domains.md index 7b9182215b..50ec27b5e8 100644 --- a/docs/data-sources/email_security_trusted_domains.md +++ b/docs/data-sources/email_security_trusted_domains.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_email_security_trusted_domains" "example_email_security_trusted_domains" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + trusted_domain_id = 2401 +} +``` ## Schema @@ -17,16 +25,19 @@ description: |- - `account_id` (String) Account Identifier - `filter` (Attributes) (see [below for nested schema](#nestedatt--filter)) -- `pattern_id` (Number) +- `trusted_domain_id` (Number) The unique identifier for the trusted domain. ### Read-Only - `comments` (String) - `created_at` (String) -- `id` (Number) The ID of this resource. -- `is_recent` (Boolean) +- `id` (Number) The unique identifier for the trusted domain. +- `is_recent` (Boolean) Select to prevent recently registered domains from triggering a +Suspicious or Malicious disposition. - `is_regex` (Boolean) -- `is_similarity` (Boolean) +- `is_similarity` (Boolean) Select for partner or other approved domains that have similar +spelling to your connected domains. Prevents listed domains from +triggering a Spoof disposition. - `last_modified` (String) - `pattern` (String) diff --git a/docs/data-sources/email_security_trusted_domains_list.md b/docs/data-sources/email_security_trusted_domains_list.md index eadd1874e4..0077f49d60 100644 --- a/docs/data-sources/email_security_trusted_domains_list.md +++ b/docs/data-sources/email_security_trusted_domains_list.md @@ -9,6 +9,18 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_email_security_trusted_domains_list" "example_email_security_trusted_domains_list" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + direction = "asc" + is_recent = true + is_similarity = true + order = "pattern" + search = "search" +} +``` ## Schema @@ -40,10 +52,13 @@ Read-Only: - `comments` (String) - `created_at` (String) -- `id` (Number) -- `is_recent` (Boolean) +- `id` (Number) The unique identifier for the trusted domain. +- `is_recent` (Boolean) Select to prevent recently registered domains from triggering a +Suspicious or Malicious disposition. - `is_regex` (Boolean) -- `is_similarity` (Boolean) +- `is_similarity` (Boolean) Select for partner or other approved domains that have similar +spelling to your connected domains. Prevents listed domains from +triggering a Spoof disposition. - `last_modified` (String) - `pattern` (String) diff --git a/docs/data-sources/filter.md b/docs/data-sources/filter.md index 935c03b401..992d357701 100644 --- a/docs/data-sources/filter.md +++ b/docs/data-sources/filter.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_filter" "example_filter" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + filter_id = "372e67954025e0ba6aaa6d586b9e0b61" +} +``` ## Schema diff --git a/docs/data-sources/filters.md b/docs/data-sources/filters.md index 267d33d783..56a8f2c7c8 100644 --- a/docs/data-sources/filters.md +++ b/docs/data-sources/filters.md @@ -9,6 +9,18 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_filters" "example_filters" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + id = "372e67954025e0ba6aaa6d586b9e0b61" + description = "browsers" + expression = "php" + paused = false + ref = "FIL-100" +} +``` ## Schema diff --git a/docs/data-sources/firewall_rule.md b/docs/data-sources/firewall_rule.md index 80bb282c4d..6d1a283244 100644 --- a/docs/data-sources/firewall_rule.md +++ b/docs/data-sources/firewall_rule.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_firewall_rule" "example_firewall_rule" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + rule_id = "372e67954025e0ba6aaa6d586b9e0b60" + id = "372e67954025e0ba6aaa6d586b9e0b60" +} +``` ## Schema diff --git a/docs/data-sources/firewall_rules.md b/docs/data-sources/firewall_rules.md index 091aee854a..62a70f726b 100644 --- a/docs/data-sources/firewall_rules.md +++ b/docs/data-sources/firewall_rules.md @@ -9,6 +9,17 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_firewall_rules" "example_firewall_rules" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + id = "372e67954025e0ba6aaa6d586b9e0b60" + action = "block" + description = "mir" + paused = false +} +``` ## Schema diff --git a/docs/data-sources/healthcheck.md b/docs/data-sources/healthcheck.md index 34f9f09808..70f0ad7d4e 100644 --- a/docs/data-sources/healthcheck.md +++ b/docs/data-sources/healthcheck.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_healthcheck" "example_healthcheck" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + healthcheck_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/healthchecks.md b/docs/data-sources/healthchecks.md index ac88c94a61..f9145cb25b 100644 --- a/docs/data-sources/healthchecks.md +++ b/docs/data-sources/healthchecks.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_healthchecks" "example_healthchecks" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/hostname_tls_setting.md b/docs/data-sources/hostname_tls_setting.md index d2984b331a..3ca9b286f4 100644 --- a/docs/data-sources/hostname_tls_setting.md +++ b/docs/data-sources/hostname_tls_setting.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_hostname_tls_setting" "example_hostname_tls_setting" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + setting_id = "ciphers" +} +``` ## Schema diff --git a/docs/data-sources/hyperdrive_config.md b/docs/data-sources/hyperdrive_config.md index ebea3a0955..ac1334b8a7 100644 --- a/docs/data-sources/hyperdrive_config.md +++ b/docs/data-sources/hyperdrive_config.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_hyperdrive_config" "example_hyperdrive_config" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + hyperdrive_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/hyperdrive_configs.md b/docs/data-sources/hyperdrive_configs.md index 1e90c0d450..642c1e4e23 100644 --- a/docs/data-sources/hyperdrive_configs.md +++ b/docs/data-sources/hyperdrive_configs.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_hyperdrive_configs" "example_hyperdrive_configs" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/image.md b/docs/data-sources/image.md index 2c5ddb939f..b2db76cd5b 100644 --- a/docs/data-sources/image.md +++ b/docs/data-sources/image.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_image" "example_image" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + image_id = "image_id" +} +``` ## Schema @@ -21,14 +29,11 @@ description: |- ### Read-Only -- `errors` (Attributes List) (see [below for nested schema](#nestedatt--errors)) - `filename` (String) Image file name. - `id` (String) Image unique identifier. -- `messages` (Attributes List) (see [below for nested schema](#nestedatt--messages)) +- `images` (Attributes List) (see [below for nested schema](#nestedatt--images)) - `meta` (String) User modifiable key-value store. Can be used for keeping references to another system of record for managing images. Metadata must not exceed 1024 bytes. - `require_signed_urls` (Boolean) Indicates whether the image can be a accessed only using it's UID. If set to true, a signed token needs to be generated with a signing key to view the image. -- `result` (Attributes) (see [below for nested schema](#nestedatt--result)) -- `success` (Boolean) Whether the API call was successful - `uploaded` (String) When the media item was uploaded. - `variants` (List of String) Object specifying available variants for an image. @@ -40,33 +45,8 @@ Required: - `account_id` (String) Account identifier tag. - -### Nested Schema for `errors` - -Read-Only: - -- `code` (Number) -- `message` (String) - - - -### Nested Schema for `messages` - -Read-Only: - -- `code` (Number) -- `message` (String) - - - -### Nested Schema for `result` - -Read-Only: - -- `images` (Attributes List) (see [below for nested schema](#nestedatt--result--images)) - - -### Nested Schema for `result.images` + +### Nested Schema for `images` Read-Only: diff --git a/docs/data-sources/image_variant.md b/docs/data-sources/image_variant.md index 8545390d2c..fd786b812b 100644 --- a/docs/data-sources/image_variant.md +++ b/docs/data-sources/image_variant.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_image_variant" "example_image_variant" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + variant_id = "hero" +} +``` ## Schema diff --git a/docs/data-sources/images.md b/docs/data-sources/images.md index efc273e1b2..6f78eb456b 100644 --- a/docs/data-sources/images.md +++ b/docs/data-sources/images.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_images" "example_images" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema @@ -30,38 +37,10 @@ description: |- Read-Only: -- `errors` (Attributes List) (see [below for nested schema](#nestedatt--result--errors)) -- `messages` (Attributes List) (see [below for nested schema](#nestedatt--result--messages)) -- `result` (Attributes) (see [below for nested schema](#nestedatt--result--result)) -- `success` (Boolean) Whether the API call was successful - - -### Nested Schema for `result.errors` - -Read-Only: - -- `code` (Number) -- `message` (String) - - - -### Nested Schema for `result.messages` - -Read-Only: - -- `code` (Number) -- `message` (String) - - - -### Nested Schema for `result.result` - -Read-Only: - -- `images` (Attributes List) (see [below for nested schema](#nestedatt--result--result--images)) +- `images` (Attributes List) (see [below for nested schema](#nestedatt--result--images)) - -### Nested Schema for `result.result.images` + +### Nested Schema for `result.images` Read-Only: diff --git a/docs/data-sources/keyless_certificate.md b/docs/data-sources/keyless_certificate.md index 9c93378e5e..cc21d1ce09 100644 --- a/docs/data-sources/keyless_certificate.md +++ b/docs/data-sources/keyless_certificate.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_keyless_certificate" "example_keyless_certificate" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + keyless_certificate_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/keyless_certificates.md b/docs/data-sources/keyless_certificates.md index 76b6236156..521d428b2d 100644 --- a/docs/data-sources/keyless_certificates.md +++ b/docs/data-sources/keyless_certificates.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_keyless_certificates" "example_keyless_certificates" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/leaked_credential_check.md b/docs/data-sources/leaked_credential_check.md new file mode 100644 index 0000000000..03984a92fd --- /dev/null +++ b/docs/data-sources/leaked_credential_check.md @@ -0,0 +1,31 @@ +--- +page_title: "cloudflare_leaked_credential_check Data Source - Cloudflare" +subcategory: "" +description: |- + +--- + +# cloudflare_leaked_credential_check (Data Source) + + + +## Example Usage + +```terraform +data "cloudflare_leaked_credential_check" "example_leaked_credential_check" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` + + +## Schema + +### Required + +- `zone_id` (String) Identifier + +### Read-Only + +- `enabled` (Boolean) Whether or not Leaked Credential Checks are enabled + + diff --git a/docs/data-sources/list.md b/docs/data-sources/list.md index ec5d8a129d..3194175f4c 100644 --- a/docs/data-sources/list.md +++ b/docs/data-sources/list.md @@ -12,11 +12,12 @@ description: |- ## Example Usage ```terraform -data "cloudflare_list" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "list_name" +data "cloudflare_list" "example_list" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + list_id = "2c0fc9fa937b11eaa1b71c4d701ab86e" } ``` + ## Schema diff --git a/docs/data-sources/list_item.md b/docs/data-sources/list_item.md index 93a4cade60..832fc1cdcd 100644 --- a/docs/data-sources/list_item.md +++ b/docs/data-sources/list_item.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_list_item" "example_list_item" { + account_identifier = "023e105f4ecef8ad9ca31a8372d0c353" + list_id = "2c0fc9fa937b11eaa1b71c4d701ab86e" + item_id = "34b12448945f11eaa1b71c4d701ab86e" +} +``` ## Schema diff --git a/docs/data-sources/list_items.md b/docs/data-sources/list_items.md index 5761ad4e9c..1494b11d20 100644 --- a/docs/data-sources/list_items.md +++ b/docs/data-sources/list_items.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_list_items" "example_list_items" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + list_id = "2c0fc9fa937b11eaa1b71c4d701ab86e" + search = "1.1.1." +} +``` ## Schema diff --git a/docs/data-sources/lists.md b/docs/data-sources/lists.md index a1998a6711..d3af126024 100644 --- a/docs/data-sources/lists.md +++ b/docs/data-sources/lists.md @@ -12,10 +12,11 @@ description: |- ## Example Usage ```terraform -data "cloudflare_lists" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" +data "cloudflare_lists" "example_lists" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" } ``` + ## Schema diff --git a/docs/data-sources/load_balancer.md b/docs/data-sources/load_balancer.md index e499a54197..66868221a9 100644 --- a/docs/data-sources/load_balancer.md +++ b/docs/data-sources/load_balancer.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_load_balancer" "example_load_balancer" { + zone_id = "699d98642c564d2e855e9661899b7252" + load_balancer_id = "699d98642c564d2e855e9661899b7252" +} +``` ## Schema diff --git a/docs/data-sources/load_balancer_monitor.md b/docs/data-sources/load_balancer_monitor.md index 00210dcfcf..d6ef201678 100644 --- a/docs/data-sources/load_balancer_monitor.md +++ b/docs/data-sources/load_balancer_monitor.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_load_balancer_monitor" "example_load_balancer_monitor" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + monitor_id = "f1aba936b94213e5b8dca0c0dbf1f9cc" +} +``` ## Schema diff --git a/docs/data-sources/load_balancer_monitors.md b/docs/data-sources/load_balancer_monitors.md index 0377d22849..10453812a6 100644 --- a/docs/data-sources/load_balancer_monitors.md +++ b/docs/data-sources/load_balancer_monitors.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_load_balancer_monitors" "example_load_balancer_monitors" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/load_balancer_pool.md b/docs/data-sources/load_balancer_pool.md index 1543f7455a..3767194ac7 100644 --- a/docs/data-sources/load_balancer_pool.md +++ b/docs/data-sources/load_balancer_pool.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_load_balancer_pool" "example_load_balancer_pool" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + pool_id = "17b5962d775c646f3f9725cbc7a53df4" +} +``` ## Schema diff --git a/docs/data-sources/load_balancer_pools.md b/docs/data-sources/load_balancer_pools.md index fe721c2e66..e58ac323be 100644 --- a/docs/data-sources/load_balancer_pools.md +++ b/docs/data-sources/load_balancer_pools.md @@ -12,13 +12,12 @@ description: |- ## Example Usage ```terraform -data "cloudflare_load_balancer_pools" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - filter { - name = "example-lb-pool" - } +data "cloudflare_load_balancer_pools" "example_load_balancer_pools" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + monitor = "monitor" } ``` + ## Schema diff --git a/docs/data-sources/load_balancers.md b/docs/data-sources/load_balancers.md index 01f2a5d9cc..c876e54714 100644 --- a/docs/data-sources/load_balancers.md +++ b/docs/data-sources/load_balancers.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_load_balancers" "example_load_balancers" { + zone_id = "699d98642c564d2e855e9661899b7252" +} +``` ## Schema @@ -167,7 +174,7 @@ Read-Only: - `session_affinity_attributes` (Attributes) Configures attributes for session affinity. (see [below for nested schema](#nestedatt--result--rules--overrides--session_affinity_attributes)) -### Nested Schema for `result.rules.overrides.session_affinity_attributes` +### Nested Schema for `result.rules.overrides.adaptive_routing` Read-Only: @@ -175,7 +182,7 @@ Read-Only: -### Nested Schema for `result.rules.overrides.session_affinity_attributes` +### Nested Schema for `result.rules.overrides.location_strategy` Read-Only: @@ -190,7 +197,7 @@ Read-Only: -### Nested Schema for `result.rules.overrides.session_affinity_attributes` +### Nested Schema for `result.rules.overrides.random_steering` Read-Only: diff --git a/docs/data-sources/logpull_retention.md b/docs/data-sources/logpull_retention.md index 52ddc59bf9..d8ed02c095 100644 --- a/docs/data-sources/logpull_retention.md +++ b/docs/data-sources/logpull_retention.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_logpull_retention" "example_logpull_retention" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/logpush_dataset_field.md b/docs/data-sources/logpush_dataset_field.md index bdd835a227..0603e9d8c5 100644 --- a/docs/data-sources/logpush_dataset_field.md +++ b/docs/data-sources/logpush_dataset_field.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_logpush_dataset_field" "example_logpush_dataset_field" { + dataset_id = "gateway_dns" + account_id = "account_id" + zone_id = "zone_id" +} +``` ## Schema diff --git a/docs/data-sources/logpush_dataset_job.md b/docs/data-sources/logpush_dataset_job.md index 6c51cbfd4f..74cb55d76a 100644 --- a/docs/data-sources/logpush_dataset_job.md +++ b/docs/data-sources/logpush_dataset_job.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_logpush_dataset_job" "example_logpush_dataset_job" { + dataset_id = "gateway_dns" + account_id = "account_id" + zone_id = "zone_id" +} +``` ## Schema diff --git a/docs/data-sources/logpush_job.md b/docs/data-sources/logpush_job.md index 2d45a2882c..0238257231 100644 --- a/docs/data-sources/logpush_job.md +++ b/docs/data-sources/logpush_job.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_logpush_job" "example_logpush_job" { + job_id = 1 + account_id = "account_id" + zone_id = "zone_id" +} +``` ## Schema diff --git a/docs/data-sources/logpush_jobs.md b/docs/data-sources/logpush_jobs.md index 1dfbbd2c27..6cc78a7442 100644 --- a/docs/data-sources/logpush_jobs.md +++ b/docs/data-sources/logpush_jobs.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_logpush_jobs" "example_logpush_jobs" { + account_id = "account_id" + zone_id = "zone_id" +} +``` ## Schema diff --git a/docs/data-sources/magic_network_monitoring_configuration.md b/docs/data-sources/magic_network_monitoring_configuration.md index d7b3e8f6ac..4b4941d970 100644 --- a/docs/data-sources/magic_network_monitoring_configuration.md +++ b/docs/data-sources/magic_network_monitoring_configuration.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_magic_network_monitoring_configuration" "example_magic_network_monitoring_configuration" { + account_id = "6f91088a406011ed95aed352566e8d4c" +} +``` ## Schema diff --git a/docs/data-sources/magic_network_monitoring_rule.md b/docs/data-sources/magic_network_monitoring_rule.md index 2df2ad3475..ebfdb67e07 100644 --- a/docs/data-sources/magic_network_monitoring_rule.md +++ b/docs/data-sources/magic_network_monitoring_rule.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_magic_network_monitoring_rule" "example_magic_network_monitoring_rule" { + account_id = "6f91088a406011ed95aed352566e8d4c" + rule_id = "2890e6fa406311ed9b5a23f70f6fb8cf" +} +``` ## Schema diff --git a/docs/data-sources/magic_network_monitoring_rules.md b/docs/data-sources/magic_network_monitoring_rules.md index 99eb6984f8..c9c340c974 100644 --- a/docs/data-sources/magic_network_monitoring_rules.md +++ b/docs/data-sources/magic_network_monitoring_rules.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_magic_network_monitoring_rules" "example_magic_network_monitoring_rules" { + account_id = "6f91088a406011ed95aed352566e8d4c" +} +``` ## Schema diff --git a/docs/data-sources/magic_transit_connector.md b/docs/data-sources/magic_transit_connector.md index b3a05fe8ce..c213ac3dde 100644 --- a/docs/data-sources/magic_transit_connector.md +++ b/docs/data-sources/magic_transit_connector.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_magic_transit_connector" "example_magic_transit_connector" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + connector_id = "connector_id" +} +``` ## Schema diff --git a/docs/data-sources/magic_transit_connectors.md b/docs/data-sources/magic_transit_connectors.md index 070e79d1b7..394d746df4 100644 --- a/docs/data-sources/magic_transit_connectors.md +++ b/docs/data-sources/magic_transit_connectors.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_magic_transit_connectors" "example_magic_transit_connectors" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/magic_transit_site.md b/docs/data-sources/magic_transit_site.md index 090e5d8f42..972b3aa581 100644 --- a/docs/data-sources/magic_transit_site.md +++ b/docs/data-sources/magic_transit_site.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_magic_transit_site" "example_magic_transit_site" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + site_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/magic_transit_site_acl.md b/docs/data-sources/magic_transit_site_acl.md index 7d7c247146..5b41bc0cda 100644 --- a/docs/data-sources/magic_transit_site_acl.md +++ b/docs/data-sources/magic_transit_site_acl.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_magic_transit_site_acl" "example_magic_transit_site_acl" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + site_id = "023e105f4ecef8ad9ca31a8372d0c353" + acl_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/magic_transit_site_acls.md b/docs/data-sources/magic_transit_site_acls.md index c43b125046..ff8a63dba7 100644 --- a/docs/data-sources/magic_transit_site_acls.md +++ b/docs/data-sources/magic_transit_site_acls.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_magic_transit_site_acls" "example_magic_transit_site_acls" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + site_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/magic_transit_site_lan.md b/docs/data-sources/magic_transit_site_lan.md index d2db286a55..5cfb6ca470 100644 --- a/docs/data-sources/magic_transit_site_lan.md +++ b/docs/data-sources/magic_transit_site_lan.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_magic_transit_site_lan" "example_magic_transit_site_lan" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + site_id = "023e105f4ecef8ad9ca31a8372d0c353" + lan_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/magic_transit_site_lans.md b/docs/data-sources/magic_transit_site_lans.md index 37c5e44cd7..a3f0f055b9 100644 --- a/docs/data-sources/magic_transit_site_lans.md +++ b/docs/data-sources/magic_transit_site_lans.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_magic_transit_site_lans" "example_magic_transit_site_lans" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + site_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/magic_transit_site_wan.md b/docs/data-sources/magic_transit_site_wan.md index f1f82be5e3..f42fa55ead 100644 --- a/docs/data-sources/magic_transit_site_wan.md +++ b/docs/data-sources/magic_transit_site_wan.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_magic_transit_site_wan" "example_magic_transit_site_wan" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + site_id = "023e105f4ecef8ad9ca31a8372d0c353" + wan_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/magic_transit_site_wans.md b/docs/data-sources/magic_transit_site_wans.md index 3080cb70a2..a75ac32086 100644 --- a/docs/data-sources/magic_transit_site_wans.md +++ b/docs/data-sources/magic_transit_site_wans.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_magic_transit_site_wans" "example_magic_transit_site_wans" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + site_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/magic_transit_sites.md b/docs/data-sources/magic_transit_sites.md index 49bde40758..6e8854a3df 100644 --- a/docs/data-sources/magic_transit_sites.md +++ b/docs/data-sources/magic_transit_sites.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_magic_transit_sites" "example_magic_transit_sites" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + connector_identifier = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/magic_wan_gre_tunnel.md b/docs/data-sources/magic_wan_gre_tunnel.md index ca55ce4dcb..ad1ba2fce7 100644 --- a/docs/data-sources/magic_wan_gre_tunnel.md +++ b/docs/data-sources/magic_wan_gre_tunnel.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_magic_wan_gre_tunnel" "example_magic_wan_gre_tunnel" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + gre_tunnel_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/magic_wan_ipsec_tunnel.md b/docs/data-sources/magic_wan_ipsec_tunnel.md index 468dcb57fa..712f515733 100644 --- a/docs/data-sources/magic_wan_ipsec_tunnel.md +++ b/docs/data-sources/magic_wan_ipsec_tunnel.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_magic_wan_ipsec_tunnel" "example_magic_wan_ipsec_tunnel" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + ipsec_tunnel_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/magic_wan_static_route.md b/docs/data-sources/magic_wan_static_route.md index 95ad3c123d..8b01836f21 100644 --- a/docs/data-sources/magic_wan_static_route.md +++ b/docs/data-sources/magic_wan_static_route.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_magic_wan_static_route" "example_magic_wan_static_route" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + route_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/managed_transforms.md b/docs/data-sources/managed_transforms.md index 2c20fa36d4..619b66d83a 100644 --- a/docs/data-sources/managed_transforms.md +++ b/docs/data-sources/managed_transforms.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_managed_transforms" "example_managed_transforms" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/mtls_certificate.md b/docs/data-sources/mtls_certificate.md index 486bbe1741..e9e387ebd0 100644 --- a/docs/data-sources/mtls_certificate.md +++ b/docs/data-sources/mtls_certificate.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_mtls_certificate" "example_mtls_certificate" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + mtls_certificate_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/mtls_certificates.md b/docs/data-sources/mtls_certificates.md index 36d2ed7571..9a160469cb 100644 --- a/docs/data-sources/mtls_certificates.md +++ b/docs/data-sources/mtls_certificates.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_mtls_certificates" "example_mtls_certificates" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/notification_policies.md b/docs/data-sources/notification_policies.md index 30446f40aa..c1e31227c6 100644 --- a/docs/data-sources/notification_policies.md +++ b/docs/data-sources/notification_policies.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_notification_policies" "example_notification_policies" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/notification_policy.md b/docs/data-sources/notification_policy.md index 61b6eed568..698596ea86 100644 --- a/docs/data-sources/notification_policy.md +++ b/docs/data-sources/notification_policy.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_notification_policy" "example_notification_policy" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + policy_id = "0da2b59e-f118-439d-8097-bdfb215203c9" +} +``` ## Schema diff --git a/docs/data-sources/notification_policy_webhooks.md b/docs/data-sources/notification_policy_webhooks.md index 46ca4dc637..60b6e93c7f 100644 --- a/docs/data-sources/notification_policy_webhooks.md +++ b/docs/data-sources/notification_policy_webhooks.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_notification_policy_webhooks" "example_notification_policy_webhooks" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + webhook_id = "b115d5ec-15c6-41ee-8b76-92c449b5227b" +} +``` ## Schema diff --git a/docs/data-sources/notification_policy_webhooks_list.md b/docs/data-sources/notification_policy_webhooks_list.md index 244975bbab..e60d9071e7 100644 --- a/docs/data-sources/notification_policy_webhooks_list.md +++ b/docs/data-sources/notification_policy_webhooks_list.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_notification_policy_webhooks_list" "example_notification_policy_webhooks_list" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/observatory_scheduled_test.md b/docs/data-sources/observatory_scheduled_test.md index 00fc235549..2734f27fe8 100644 --- a/docs/data-sources/observatory_scheduled_test.md +++ b/docs/data-sources/observatory_scheduled_test.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_observatory_scheduled_test" "example_observatory_scheduled_test" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + url = "example.com" + region = "asia-east1" +} +``` ## Schema diff --git a/docs/data-sources/origin_ca_certificate.md b/docs/data-sources/origin_ca_certificate.md index a9cadccf0d..6268ba8954 100644 --- a/docs/data-sources/origin_ca_certificate.md +++ b/docs/data-sources/origin_ca_certificate.md @@ -12,10 +12,11 @@ description: |- ## Example Usage ```terraform -data "cloudflare_origin_ca_certificate" "example" { - id = "REPLACE_ME" +data "cloudflare_origin_ca_certificate" "example_origin_ca_certificate" { + certificate_id = "023e105f4ecef8ad9ca31a8372d0c353" } ``` + ## Schema diff --git a/docs/data-sources/origin_ca_certificates.md b/docs/data-sources/origin_ca_certificates.md index c39a48b304..01ab9c2afe 100644 --- a/docs/data-sources/origin_ca_certificates.md +++ b/docs/data-sources/origin_ca_certificates.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_origin_ca_certificates" "example_origin_ca_certificates" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/page_rule.md b/docs/data-sources/page_rule.md index b66e404396..a36fa99fb2 100644 --- a/docs/data-sources/page_rule.md +++ b/docs/data-sources/page_rule.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_page_rule" "example_page_rule" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + pagerule_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema @@ -20,9 +28,6 @@ description: |- ### Read-Only -- `actions` (Attributes List) The set of actions to perform if the targets of this rule match the -request. Actions can redirect to another URL or override settings, but -not both. (see [below for nested schema](#nestedatt--actions)) - `created_on` (String) The timestamp of when the Page Rule was created. - `id` (String) Identifier - `modified_on` (String) The timestamp of when the Page Rule was last modified. @@ -32,32 +37,5 @@ if you have a catch-all Page Rule (rule A: `/images/*`) but want a more specific Page Rule to take precedence (rule B: `/images/special/*`), specify a higher priority for rule B so it overrides rule A. - `status` (String) The status of the Page Rule. -- `targets` (Attributes List) The rule targets to evaluate on each request. (see [below for nested schema](#nestedatt--targets)) - - -### Nested Schema for `actions` - -Read-Only: - -- `id` (String) If enabled, any `http://`` URL is converted to `https://` through a -301 redirect. -- `value` (String) The status of Automatic HTTPS Rewrites. - - - -### Nested Schema for `targets` - -Read-Only: - -- `constraint` (Attributes) String constraint. (see [below for nested schema](#nestedatt--targets--constraint)) -- `target` (String) A target based on the URL of the request. - - -### Nested Schema for `targets.constraint` - -Read-Only: - -- `operator` (String) The matches operator can use asterisks and pipes as wildcard and 'or' operators. -- `value` (String) The URL pattern to match against the current request. The pattern may contain up to four asterisks ('*') as placeholders. diff --git a/docs/data-sources/page_shield_connections.md b/docs/data-sources/page_shield_connections.md index d40004342c..d4be2d78a4 100644 --- a/docs/data-sources/page_shield_connections.md +++ b/docs/data-sources/page_shield_connections.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_page_shield_connections" "example_page_shield_connections" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + connection_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/page_shield_connections_list.md b/docs/data-sources/page_shield_connections_list.md index 47f516a5d5..0b7733649f 100644 --- a/docs/data-sources/page_shield_connections_list.md +++ b/docs/data-sources/page_shield_connections_list.md @@ -9,6 +9,25 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_page_shield_connections_list" "example_page_shield_connections_list" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + direction = "asc" + exclude_cdn_cgi = true + exclude_urls = "blog.cloudflare.com,www.example" + export = "csv" + hosts = "blog.cloudflare.com,www.example*,*cloudflare.com" + order_by = "first_seen_at" + page = "2" + page_url = "example.com/page,*/checkout,example.com/*,*checkout*" + per_page = 100 + prioritize_malicious = true + status = "active,inactive" + urls = "blog.cloudflare.com,www.example" +} +``` ## Schema diff --git a/docs/data-sources/page_shield_cookies.md b/docs/data-sources/page_shield_cookies.md index 3b4f861f78..2d5caa2453 100644 --- a/docs/data-sources/page_shield_cookies.md +++ b/docs/data-sources/page_shield_cookies.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_page_shield_cookies" "example_page_shield_cookies" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + cookie_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/page_shield_cookies_list.md b/docs/data-sources/page_shield_cookies_list.md index f8abf0da19..9a4b2250ce 100644 --- a/docs/data-sources/page_shield_cookies_list.md +++ b/docs/data-sources/page_shield_cookies_list.md @@ -9,6 +9,27 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_page_shield_cookies_list" "example_page_shield_cookies_list" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + direction = "asc" + domain = "example.com" + export = "csv" + hosts = "blog.cloudflare.com,www.example*,*cloudflare.com" + http_only = true + name = "session_id" + order_by = "first_seen_at" + page = "2" + page_url = "example.com/page,*/checkout,example.com/*,*checkout*" + path = "/" + per_page = 100 + same_site = "lax" + secure = true + type = "first_party" +} +``` ## Schema diff --git a/docs/data-sources/page_shield_policies.md b/docs/data-sources/page_shield_policies.md index d51d375cd4..bec43ed6ff 100644 --- a/docs/data-sources/page_shield_policies.md +++ b/docs/data-sources/page_shield_policies.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_page_shield_policies" "example_page_shield_policies" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/page_shield_policy.md b/docs/data-sources/page_shield_policy.md index 6af9b37312..c313f3cc9e 100644 --- a/docs/data-sources/page_shield_policy.md +++ b/docs/data-sources/page_shield_policy.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_page_shield_policy" "example_page_shield_policy" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + policy_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/page_shield_scripts.md b/docs/data-sources/page_shield_scripts.md index fb67271205..0d7fa20236 100644 --- a/docs/data-sources/page_shield_scripts.md +++ b/docs/data-sources/page_shield_scripts.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_page_shield_scripts" "example_page_shield_scripts" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + script_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/page_shield_scripts_list.md b/docs/data-sources/page_shield_scripts_list.md index 6c11392605..5d38345662 100644 --- a/docs/data-sources/page_shield_scripts_list.md +++ b/docs/data-sources/page_shield_scripts_list.md @@ -9,6 +9,24 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_page_shield_scripts_list" "example_page_shield_scripts_list" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + direction = "asc" + exclude_urls = "blog.cloudflare.com,www.example" + export = "csv" + hosts = "blog.cloudflare.com,www.example*,*cloudflare.com" + order_by = "first_seen_at" + page = "2" + page_url = "example.com/page,*/checkout,example.com/*,*checkout*" + per_page = 100 + prioritize_malicious = true + status = "active,inactive" + urls = "blog.cloudflare.com,www.example" +} +``` ## Schema diff --git a/docs/data-sources/pages_domain.md b/docs/data-sources/pages_domain.md index b4e7a0aad1..2d602ce15a 100644 --- a/docs/data-sources/pages_domain.md +++ b/docs/data-sources/pages_domain.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_pages_domain" "example_pages_domain" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + project_name = "this-is-my-project-01" + domain_name = "this-is-my-domain-01.com" +} +``` ## Schema diff --git a/docs/data-sources/pages_domains.md b/docs/data-sources/pages_domains.md index 88158880c5..a6a8098a5d 100644 --- a/docs/data-sources/pages_domains.md +++ b/docs/data-sources/pages_domains.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_pages_domains" "example_pages_domains" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + project_name = "this-is-my-project-01" +} +``` ## Schema diff --git a/docs/data-sources/pages_project.md b/docs/data-sources/pages_project.md index 35bfd72997..37ca56edb4 100644 --- a/docs/data-sources/pages_project.md +++ b/docs/data-sources/pages_project.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_pages_project" "example_pages_project" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + project_name = "this-is-my-project-01" +} +``` ## Schema diff --git a/docs/data-sources/pages_projects.md b/docs/data-sources/pages_projects.md index 03e2c7fe12..a6414db496 100644 --- a/docs/data-sources/pages_projects.md +++ b/docs/data-sources/pages_projects.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_pages_projects" "example_pages_projects" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/permission_group.md b/docs/data-sources/permission_group.md index 7ce18aeca1..6180922beb 100644 --- a/docs/data-sources/permission_group.md +++ b/docs/data-sources/permission_group.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_permission_group" "example_permission_group" { + account_id = "eb78d65290b24279ba6f44721b3ea3c4" + permission_group_id = "6d7f2f5f5b1d4a0e9081fdc98d432fd1" +} +``` ## Schema diff --git a/docs/data-sources/permission_groups.md b/docs/data-sources/permission_groups.md index a67085ff6c..37ac14861a 100644 --- a/docs/data-sources/permission_groups.md +++ b/docs/data-sources/permission_groups.md @@ -9,6 +9,16 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_permission_groups" "example_permission_groups" { + account_id = "eb78d65290b24279ba6f44721b3ea3c4" + id = "6d7f2f5f5b1d4a0e9081fdc98d432fd1" + label = "labelOfThePermissionGroup" + name = "NameOfThePermissionGroup" +} +``` ## Schema diff --git a/docs/data-sources/queue.md b/docs/data-sources/queue.md index ad9366756b..d984b60d42 100644 --- a/docs/data-sources/queue.md +++ b/docs/data-sources/queue.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_queue" "example_queue" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + queue_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/queue_consumer.md b/docs/data-sources/queue_consumer.md index c770ab11e7..2e9272f4f5 100644 --- a/docs/data-sources/queue_consumer.md +++ b/docs/data-sources/queue_consumer.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_queue_consumer" "example_queue_consumer" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + queue_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/queues.md b/docs/data-sources/queues.md index 4e1dc20ee1..ec660c0f32 100644 --- a/docs/data-sources/queues.md +++ b/docs/data-sources/queues.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_queues" "example_queues" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/r2_bucket.md b/docs/data-sources/r2_bucket.md index 1200327ad9..204adfab37 100644 --- a/docs/data-sources/r2_bucket.md +++ b/docs/data-sources/r2_bucket.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_r2_bucket" "example_r2_bucket" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + bucket_name = "example-bucket" +} +``` ## Schema diff --git a/docs/data-sources/rate_limit.md b/docs/data-sources/rate_limit.md index 5d0b872ef4..78be52e58c 100644 --- a/docs/data-sources/rate_limit.md +++ b/docs/data-sources/rate_limit.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_rate_limit" "example_rate_limit" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + rate_limit_id = "372e67954025e0ba6aaa6d586b9e0b59" +} +``` ## Schema diff --git a/docs/data-sources/rate_limits.md b/docs/data-sources/rate_limits.md index ac52280276..0add5ee26d 100644 --- a/docs/data-sources/rate_limits.md +++ b/docs/data-sources/rate_limits.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_rate_limits" "example_rate_limits" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/regional_hostname.md b/docs/data-sources/regional_hostname.md index 15002c66cd..de71214bb6 100644 --- a/docs/data-sources/regional_hostname.md +++ b/docs/data-sources/regional_hostname.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_regional_hostname" "example_regional_hostname" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + hostname = "foo.example.com" +} +``` ## Schema diff --git a/docs/data-sources/regional_hostnames.md b/docs/data-sources/regional_hostnames.md index 5a457ba48b..6b9f07d1d4 100644 --- a/docs/data-sources/regional_hostnames.md +++ b/docs/data-sources/regional_hostnames.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_regional_hostnames" "example_regional_hostnames" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/regional_tiered_cache.md b/docs/data-sources/regional_tiered_cache.md index f9ab632b8f..c1731073c4 100644 --- a/docs/data-sources/regional_tiered_cache.md +++ b/docs/data-sources/regional_tiered_cache.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_regional_tiered_cache" "example_regional_tiered_cache" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/registrar_domain.md b/docs/data-sources/registrar_domain.md index e1a523b77e..00f9173d24 100644 --- a/docs/data-sources/registrar_domain.md +++ b/docs/data-sources/registrar_domain.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_registrar_domain" "example_registrar_domain" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + domain_name = "cloudflare.com" +} +``` ## Schema diff --git a/docs/data-sources/registrar_domains.md b/docs/data-sources/registrar_domains.md index 45a601852d..9f202d74fc 100644 --- a/docs/data-sources/registrar_domains.md +++ b/docs/data-sources/registrar_domains.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_registrar_domains" "example_registrar_domains" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/resource_group.md b/docs/data-sources/resource_group.md index df0ef0a73c..913c63f8c5 100644 --- a/docs/data-sources/resource_group.md +++ b/docs/data-sources/resource_group.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_resource_group" "example_resource_group" { + account_id = "eb78d65290b24279ba6f44721b3ea3c4" + resource_group_id = "6d7f2f5f5b1d4a0e9081fdc98d432fd1" +} +``` ## Schema diff --git a/docs/data-sources/resource_groups.md b/docs/data-sources/resource_groups.md index 57af6b81f2..1e58b8ed45 100644 --- a/docs/data-sources/resource_groups.md +++ b/docs/data-sources/resource_groups.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_resource_groups" "example_resource_groups" { + account_id = "eb78d65290b24279ba6f44721b3ea3c4" + id = "6d7f2f5f5b1d4a0e9081fdc98d432fd1" + name = "NameOfTheResourceGroup" +} +``` ## Schema diff --git a/docs/data-sources/ruleset.md b/docs/data-sources/ruleset.md index 0787f48d05..0428823804 100644 --- a/docs/data-sources/ruleset.md +++ b/docs/data-sources/ruleset.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_ruleset" "example_ruleset" { + ruleset_id = "2f2feab2026849078ba485f918791bdc" + account_id = "account_id" + zone_id = "zone_id" +} +``` ## Schema @@ -155,18 +164,18 @@ Read-Only: - `ignore_query_strings_order` (Boolean) Treat requests with the same query parameters the same, regardless of the order those query parameters are in. A value of true ignores the query strings' order. -### Nested Schema for `rules.action_parameters.cache_key.ignore_query_strings_order` +### Nested Schema for `rules.action_parameters.cache_key.custom_key` Read-Only: -- `cookie` (Attributes) The cookies to include in building the cache key. (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--ignore_query_strings_order--cookie)) -- `header` (Attributes) The header names and values to include in building the cache key. (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--ignore_query_strings_order--header)) -- `host` (Attributes) Whether to use the original host or the resolved host in the cache key. (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--ignore_query_strings_order--host)) -- `query_string` (Attributes) Use the presence or absence of parameters in the query string to build the cache key. (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--ignore_query_strings_order--query_string)) -- `user` (Attributes) Characteristics of the request user agent used in building the cache key. (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--ignore_query_strings_order--user)) +- `cookie` (Attributes) The cookies to include in building the cache key. (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--custom_key--cookie)) +- `header` (Attributes) The header names and values to include in building the cache key. (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--custom_key--header)) +- `host` (Attributes) Whether to use the original host or the resolved host in the cache key. (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--custom_key--host)) +- `query_string` (Attributes) Use the presence or absence of parameters in the query string to build the cache key. (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--custom_key--query_string)) +- `user` (Attributes) Characteristics of the request user agent used in building the cache key. (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--custom_key--user)) - -### Nested Schema for `rules.action_parameters.cache_key.ignore_query_strings_order.cookie` + +### Nested Schema for `rules.action_parameters.cache_key.custom_key.cookie` Read-Only: @@ -174,8 +183,8 @@ Read-Only: - `include` (List of String) Include these cookies' names and their values. - -### Nested Schema for `rules.action_parameters.cache_key.ignore_query_strings_order.header` + +### Nested Schema for `rules.action_parameters.cache_key.custom_key.header` Read-Only: @@ -185,24 +194,24 @@ Read-Only: - `include` (List of String) Include these headers' names and their values. - -### Nested Schema for `rules.action_parameters.cache_key.ignore_query_strings_order.host` + +### Nested Schema for `rules.action_parameters.cache_key.custom_key.host` Read-Only: - `resolved` (Boolean) Use the resolved host in the cache key. A value of true will use the resolved host, while a value or false will use the original host. - -### Nested Schema for `rules.action_parameters.cache_key.ignore_query_strings_order.query_string` + +### Nested Schema for `rules.action_parameters.cache_key.custom_key.query_string` Read-Only: -- `exclude` (Attributes) build the cache key using all query string parameters EXCECPT these excluded parameters (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--ignore_query_strings_order--query_string--exclude)) -- `include` (Attributes) build the cache key using a list of query string parameters that ARE in the request. (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--ignore_query_strings_order--query_string--include)) +- `exclude` (Attributes) build the cache key using all query string parameters EXCECPT these excluded parameters (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--custom_key--query_string--exclude)) +- `include` (Attributes) build the cache key using a list of query string parameters that ARE in the request. (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--custom_key--query_string--include)) - -### Nested Schema for `rules.action_parameters.cache_key.ignore_query_strings_order.query_string.include` + +### Nested Schema for `rules.action_parameters.cache_key.custom_key.query_string.exclude` Read-Only: @@ -210,8 +219,8 @@ Read-Only: - `list` (List of String) A list of query string parameters NOT used to build the cache key. All parameters present in the request but missing in this list will be used to build the cache key. - -### Nested Schema for `rules.action_parameters.cache_key.ignore_query_strings_order.query_string.include` + +### Nested Schema for `rules.action_parameters.cache_key.custom_key.query_string.include` Read-Only: @@ -220,8 +229,8 @@ Read-Only: - -### Nested Schema for `rules.action_parameters.cache_key.ignore_query_strings_order.user` + +### Nested Schema for `rules.action_parameters.cache_key.custom_key.user` Read-Only: @@ -345,7 +354,7 @@ Read-Only: - `sensitivity_level` (String) A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases. -### Nested Schema for `rules.action_parameters.overrides.sensitivity_level` +### Nested Schema for `rules.action_parameters.overrides.categories` Read-Only: @@ -356,7 +365,7 @@ Read-Only: -### Nested Schema for `rules.action_parameters.overrides.sensitivity_level` +### Nested Schema for `rules.action_parameters.overrides.rules` Read-Only: @@ -419,7 +428,7 @@ Read-Only: - `query` (Attributes) Query portion rewrite. (see [below for nested schema](#nestedatt--rules--action_parameters--uri--query)) -### Nested Schema for `rules.action_parameters.uri.query` +### Nested Schema for `rules.action_parameters.uri.path` Read-Only: diff --git a/docs/data-sources/rulesets.md b/docs/data-sources/rulesets.md index 2078e13928..36cf7d7a17 100644 --- a/docs/data-sources/rulesets.md +++ b/docs/data-sources/rulesets.md @@ -12,14 +12,12 @@ description: |- ## Example Usage ```terraform -data "cloudflare_rulesets" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - - filter { - name = ".*OWASP.*" - } +data "cloudflare_rulesets" "example_rulesets" { + account_id = "account_id" + zone_id = "zone_id" } ``` + ## Schema diff --git a/docs/data-sources/secondary_dns_outgoing.md b/docs/data-sources/secondary_dns_outgoing.md deleted file mode 100644 index 8d2113e85f..0000000000 --- a/docs/data-sources/secondary_dns_outgoing.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -page_title: "cloudflare_secondary_dns_outgoing Data Source - Cloudflare" -subcategory: "" -description: |- - ---- - -# cloudflare_secondary_dns_outgoing (Data Source) - - - - - -## Schema - -### Required - -- `zone_id` (String) - -### Read-Only - -- `checked_time` (String) The time for a specific event. -- `created_time` (String) The time for a specific event. -- `id` (String) The ID of this resource. -- `last_transferred_time` (String) The time for a specific event. -- `name` (String) Zone name. -- `peers` (List of String) A list of peer tags. -- `soa_serial` (Number) The serial number of the SOA for the given zone. - - diff --git a/docs/data-sources/spectrum_application.md b/docs/data-sources/spectrum_application.md index 41f68d0d51..0b5a44e572 100644 --- a/docs/data-sources/spectrum_application.md +++ b/docs/data-sources/spectrum_application.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_spectrum_application" "example_spectrum_application" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + app_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema @@ -26,11 +34,9 @@ Notes: Only available for TCP applications with traffic_type set to "direct". - `created_on` (String) When the Application was created. - `dns` (Attributes) The name and type of DNS record for the Spectrum application. (see [below for nested schema](#nestedatt--dns)) - `edge_ips` (Attributes) The anycast edge IP configuration for the hostname of this application. (see [below for nested schema](#nestedatt--edge_ips)) -- `errors` (Attributes List) (see [below for nested schema](#nestedatt--errors)) - `id` (String) App identifier. - `ip_firewall` (Boolean) Enables IP Access Rules for this application. Notes: Only available for TCP applications. -- `messages` (Attributes List) (see [below for nested schema](#nestedatt--messages)) - `modified_on` (String) When the Application was last modified. - `origin_direct` (List of String) List of origin IP addresses. Array may contain multiple IP addresses for load balancing. - `origin_dns` (Attributes) The name and type of DNS record for the Spectrum application. (see [below for nested schema](#nestedatt--origin_dns)) @@ -38,9 +44,6 @@ Notes: Only available for TCP applications. Notes: If specifying a port range, the number of ports in the range must match the number of ports specified in the "protocol" field. - `protocol` (String) The port configuration at Cloudflare's edge. May specify a single port, for example `"tcp/1000"`, or a range of ports, for example `"tcp/1000-2000"`. - `proxy_protocol` (String) Enables Proxy Protocol to the origin. Refer to [Enable Proxy protocol](https://developers.cloudflare.com/spectrum/getting-started/proxy-protocol/) for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple Proxy Protocol. -- `result` (Attributes List) (see [below for nested schema](#nestedatt--result)) -- `result_info` (Attributes) (see [below for nested schema](#nestedatt--result_info)) -- `success` (Boolean) Whether the API call was successful - `tls` (String) The type of TLS termination associated with the application. - `traffic_type` (String) Determines how data travels from the edge to your origin. When set to "direct", Spectrum will send traffic directly to your origin, and the application's type is derived from the `protocol`. When set to "http" or "https", Spectrum will apply Cloudflare's HTTP/HTTPS features as it sends traffic to your origin, and the application type matches this property exactly. @@ -76,24 +79,6 @@ Read-Only: - `type` (String) The type of edge IP configuration specified. Dynamically allocated edge IPs use Spectrum anycast IPs in accordance with the connectivity you specify. Only valid with CNAME DNS names. - -### Nested Schema for `errors` - -Read-Only: - -- `code` (Number) -- `message` (String) - - - -### Nested Schema for `messages` - -Read-Only: - -- `code` (Number) -- `message` (String) - - ### Nested Schema for `origin_dns` @@ -104,65 +89,3 @@ Read-Only: - `type` (String) The type of DNS record associated with the origin. "" is used to specify a combination of A/AAAA records. - -### Nested Schema for `result` - -Read-Only: - -- `argo_smart_routing` (Boolean) Enables Argo Smart Routing for this application. -Notes: Only available for TCP applications with traffic_type set to "direct". -- `created_on` (String) When the Application was created. -- `dns` (Attributes) The name and type of DNS record for the Spectrum application. (see [below for nested schema](#nestedatt--result--dns)) -- `edge_ips` (Attributes) The anycast edge IP configuration for the hostname of this application. (see [below for nested schema](#nestedatt--result--edge_ips)) -- `id` (String) App identifier. -- `ip_firewall` (Boolean) Enables IP Access Rules for this application. -Notes: Only available for TCP applications. -- `modified_on` (String) When the Application was last modified. -- `origin_direct` (List of String) List of origin IP addresses. Array may contain multiple IP addresses for load balancing. -- `origin_dns` (Attributes) The name and type of DNS record for the Spectrum application. (see [below for nested schema](#nestedatt--result--origin_dns)) -- `protocol` (String) The port configuration at Cloudflare's edge. May specify a single port, for example `"tcp/1000"`, or a range of ports, for example `"tcp/1000-2000"`. -- `proxy_protocol` (String) Enables Proxy Protocol to the origin. Refer to [Enable Proxy protocol](https://developers.cloudflare.com/spectrum/getting-started/proxy-protocol/) for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple Proxy Protocol. -- `tls` (String) The type of TLS termination associated with the application. -- `traffic_type` (String) Determines how data travels from the edge to your origin. When set to "direct", Spectrum will send traffic directly to your origin, and the application's type is derived from the `protocol`. When set to "http" or "https", Spectrum will apply Cloudflare's HTTP/HTTPS features as it sends traffic to your origin, and the application type matches this property exactly. - - -### Nested Schema for `result.dns` - -Read-Only: - -- `name` (String) The name of the DNS record associated with the application. -- `type` (String) The type of DNS record associated with the application. - - - -### Nested Schema for `result.edge_ips` - -Read-Only: - -- `connectivity` (String) The IP versions supported for inbound connections on Spectrum anycast IPs. -- `ips` (List of String) The array of customer owned IPs we broadcast via anycast for this hostname and application. -- `type` (String) The type of edge IP configuration specified. Dynamically allocated edge IPs use Spectrum anycast IPs in accordance with the connectivity you specify. Only valid with CNAME DNS names. - - - -### Nested Schema for `result.origin_dns` - -Read-Only: - -- `name` (String) The name of the DNS record associated with the origin. -- `ttl` (Number) The TTL of our resolution of your DNS record in seconds. -- `type` (String) The type of DNS record associated with the origin. "" is used to specify a combination of A/AAAA records. - - - - -### Nested Schema for `result_info` - -Read-Only: - -- `count` (Number) Total number of results for the requested service -- `page` (Number) Current page within paginated list of results -- `per_page` (Number) Number of results per page of results -- `total_count` (Number) Total results available without any search parameters - - diff --git a/docs/data-sources/spectrum_applications.md b/docs/data-sources/spectrum_applications.md index 64af2649b6..9174284f9b 100644 --- a/docs/data-sources/spectrum_applications.md +++ b/docs/data-sources/spectrum_applications.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_spectrum_applications" "example_spectrum_applications" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema @@ -30,93 +37,4 @@ description: |- ### Nested Schema for `result` -Read-Only: - -- `errors` (Attributes List) (see [below for nested schema](#nestedatt--result--errors)) -- `messages` (Attributes List) (see [below for nested schema](#nestedatt--result--messages)) -- `result` (Attributes List) (see [below for nested schema](#nestedatt--result--result)) -- `result_info` (Attributes) (see [below for nested schema](#nestedatt--result--result_info)) -- `success` (Boolean) Whether the API call was successful - - -### Nested Schema for `result.errors` - -Read-Only: - -- `code` (Number) -- `message` (String) - - - -### Nested Schema for `result.messages` - -Read-Only: - -- `code` (Number) -- `message` (String) - - - -### Nested Schema for `result.result` - -Read-Only: - -- `argo_smart_routing` (Boolean) Enables Argo Smart Routing for this application. -Notes: Only available for TCP applications with traffic_type set to "direct". -- `created_on` (String) When the Application was created. -- `dns` (Attributes) The name and type of DNS record for the Spectrum application. (see [below for nested schema](#nestedatt--result--result--dns)) -- `edge_ips` (Attributes) The anycast edge IP configuration for the hostname of this application. (see [below for nested schema](#nestedatt--result--result--edge_ips)) -- `id` (String) App identifier. -- `ip_firewall` (Boolean) Enables IP Access Rules for this application. -Notes: Only available for TCP applications. -- `modified_on` (String) When the Application was last modified. -- `origin_direct` (List of String) List of origin IP addresses. Array may contain multiple IP addresses for load balancing. -- `origin_dns` (Attributes) The name and type of DNS record for the Spectrum application. (see [below for nested schema](#nestedatt--result--result--origin_dns)) -- `origin_port` (Dynamic) The destination port at the origin. Only specified in conjunction with origin_dns. May use an integer to specify a single origin port, for example `1000`, or a string to specify a range of origin ports, for example `"1000-2000"`. -Notes: If specifying a port range, the number of ports in the range must match the number of ports specified in the "protocol" field. -- `protocol` (String) The port configuration at Cloudflare's edge. May specify a single port, for example `"tcp/1000"`, or a range of ports, for example `"tcp/1000-2000"`. -- `proxy_protocol` (String) Enables Proxy Protocol to the origin. Refer to [Enable Proxy protocol](https://developers.cloudflare.com/spectrum/getting-started/proxy-protocol/) for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple Proxy Protocol. -- `tls` (String) The type of TLS termination associated with the application. -- `traffic_type` (String) Determines how data travels from the edge to your origin. When set to "direct", Spectrum will send traffic directly to your origin, and the application's type is derived from the `protocol`. When set to "http" or "https", Spectrum will apply Cloudflare's HTTP/HTTPS features as it sends traffic to your origin, and the application type matches this property exactly. - - -### Nested Schema for `result.result.dns` - -Read-Only: - -- `name` (String) The name of the DNS record associated with the application. -- `type` (String) The type of DNS record associated with the application. - - - -### Nested Schema for `result.result.edge_ips` - -Read-Only: - -- `connectivity` (String) The IP versions supported for inbound connections on Spectrum anycast IPs. -- `ips` (List of String) The array of customer owned IPs we broadcast via anycast for this hostname and application. -- `type` (String) The type of edge IP configuration specified. Dynamically allocated edge IPs use Spectrum anycast IPs in accordance with the connectivity you specify. Only valid with CNAME DNS names. - - - -### Nested Schema for `result.result.origin_dns` - -Read-Only: - -- `name` (String) The name of the DNS record associated with the origin. -- `ttl` (Number) The TTL of our resolution of your DNS record in seconds. -- `type` (String) The type of DNS record associated with the origin. "" is used to specify a combination of A/AAAA records. - - - - -### Nested Schema for `result.result_info` - -Read-Only: - -- `count` (Number) Total number of results for the requested service -- `page` (Number) Current page within paginated list of results -- `per_page` (Number) Number of results per page of results -- `total_count` (Number) Total results available without any search parameters - diff --git a/docs/data-sources/stream.md b/docs/data-sources/stream.md index c81b982110..a5ff4edda5 100644 --- a/docs/data-sources/stream.md +++ b/docs/data-sources/stream.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_stream" "example_stream" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + identifier = "ea95132c15732412d22c1476fa83f27a" +} +``` ## Schema diff --git a/docs/data-sources/stream_audio_track.md b/docs/data-sources/stream_audio_track.md index fadf2f9582..5019b3cc00 100644 --- a/docs/data-sources/stream_audio_track.md +++ b/docs/data-sources/stream_audio_track.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_stream_audio_track" "example_stream_audio_track" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + identifier = "ea95132c15732412d22c1476fa83f27a" +} +``` ## Schema diff --git a/docs/data-sources/stream_caption_language.md b/docs/data-sources/stream_caption_language.md index 2f3eceff72..13e5edbaae 100644 --- a/docs/data-sources/stream_caption_language.md +++ b/docs/data-sources/stream_caption_language.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_stream_caption_language" "example_stream_caption_language" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + identifier = "ea95132c15732412d22c1476fa83f27a" + language = "tr" +} +``` ## Schema diff --git a/docs/data-sources/stream_download.md b/docs/data-sources/stream_download.md index 27c0a6fc7a..6bd575e1d0 100644 --- a/docs/data-sources/stream_download.md +++ b/docs/data-sources/stream_download.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_stream_download" "example_stream_download" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + identifier = "ea95132c15732412d22c1476fa83f27a" +} +``` ## Schema diff --git a/docs/data-sources/stream_key.md b/docs/data-sources/stream_key.md index 570cb25bff..a727d2bd1d 100644 --- a/docs/data-sources/stream_key.md +++ b/docs/data-sources/stream_key.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_stream_key" "example_stream_key" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/stream_live_input.md b/docs/data-sources/stream_live_input.md index 8714606ee3..7472d48fc4 100644 --- a/docs/data-sources/stream_live_input.md +++ b/docs/data-sources/stream_live_input.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_stream_live_input" "example_stream_live_input" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + live_input_identifier = "66be4bf738797e01e1fca35a7bdecdcd" +} +``` ## Schema diff --git a/docs/data-sources/stream_watermark.md b/docs/data-sources/stream_watermark.md index 046f0c8e3a..8665c56717 100644 --- a/docs/data-sources/stream_watermark.md +++ b/docs/data-sources/stream_watermark.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_stream_watermark" "example_stream_watermark" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + identifier = "ea95132c15732412d22c1476fa83f27a" +} +``` ## Schema diff --git a/docs/data-sources/stream_watermarks.md b/docs/data-sources/stream_watermarks.md index 4dfd5bfcd9..2efc4a6ef9 100644 --- a/docs/data-sources/stream_watermarks.md +++ b/docs/data-sources/stream_watermarks.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_stream_watermarks" "example_stream_watermarks" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/stream_webhook.md b/docs/data-sources/stream_webhook.md index 412f098000..2f1306d660 100644 --- a/docs/data-sources/stream_webhook.md +++ b/docs/data-sources/stream_webhook.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_stream_webhook" "example_stream_webhook" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/streams.md b/docs/data-sources/streams.md index 7f4e0a2bef..0ece0ad1f2 100644 --- a/docs/data-sources/streams.md +++ b/docs/data-sources/streams.md @@ -9,6 +9,19 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_streams" "example_streams" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + creator = "creator-id_abcde12345" + end = "2014-01-02T02:20:00Z" + search = "puppy.mp4" + start = "2014-01-02T02:20:00Z" + status = "pendingupload" + type = "live" +} +``` ## Schema diff --git a/docs/data-sources/tiered_cache.md b/docs/data-sources/tiered_cache.md index 6643ba3261..16d7f2d6aa 100644 --- a/docs/data-sources/tiered_cache.md +++ b/docs/data-sources/tiered_cache.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_tiered_cache" "example_tiered_cache" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/total_tls.md b/docs/data-sources/total_tls.md index 74e22e7d28..765b8633bb 100644 --- a/docs/data-sources/total_tls.md +++ b/docs/data-sources/total_tls.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_total_tls" "example_total_tls" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/turnstile_widget.md b/docs/data-sources/turnstile_widget.md index 8476595596..a23fa9f363 100644 --- a/docs/data-sources/turnstile_widget.md +++ b/docs/data-sources/turnstile_widget.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_turnstile_widget" "example_turnstile_widget" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + sitekey = "0x4AAF00AAAABn0R22HWm-YUc" +} +``` ## Schema diff --git a/docs/data-sources/turnstile_widgets.md b/docs/data-sources/turnstile_widgets.md index fa8350bd1d..79b8fea761 100644 --- a/docs/data-sources/turnstile_widgets.md +++ b/docs/data-sources/turnstile_widgets.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_turnstile_widgets" "example_turnstile_widgets" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + direction = "asc" + order = "id" +} +``` ## Schema diff --git a/docs/data-sources/url_normalization_settings.md b/docs/data-sources/url_normalization_settings.md index 02e6401bce..3422f65dae 100644 --- a/docs/data-sources/url_normalization_settings.md +++ b/docs/data-sources/url_normalization_settings.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_url_normalization_settings" "example_url_normalization_settings" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/user_agent_blocking_rule.md b/docs/data-sources/user_agent_blocking_rule.md index ece4068ca3..f0bef8f330 100644 --- a/docs/data-sources/user_agent_blocking_rule.md +++ b/docs/data-sources/user_agent_blocking_rule.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_user_agent_blocking_rule" "example_user_agent_blocking_rule" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + ua_rule_id = "372e67954025e0ba6aaa6d586b9e0b59" +} +``` ## Schema diff --git a/docs/data-sources/user_agent_blocking_rules.md b/docs/data-sources/user_agent_blocking_rules.md index 1747e966cd..c569d8393d 100644 --- a/docs/data-sources/user_agent_blocking_rules.md +++ b/docs/data-sources/user_agent_blocking_rules.md @@ -9,6 +9,16 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_user_agent_blocking_rules" "example_user_agent_blocking_rules" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + description = "abusive" + description_search = "abusive" + ua_search = "Safari" +} +``` ## Schema diff --git a/docs/data-sources/waiting_room.md b/docs/data-sources/waiting_room.md index e843ed28a1..b9e2010323 100644 --- a/docs/data-sources/waiting_room.md +++ b/docs/data-sources/waiting_room.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_waiting_room" "example_waiting_room" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + waiting_room_id = "699d98642c564d2e855e9661899b7252" +} +``` ## Schema @@ -26,12 +34,12 @@ description: |- - `cookie_suffix` (String) Appends a '_' + a custom suffix to the end of Cloudflare Waiting Room's cookie name(__cf_waitingroom). If `cookie_suffix` is "abcd", the cookie name will be `__cf_waitingroom_abcd`. This field is required if using `additional_routes`. - `created_on` (String) - `custom_page_html` (String) Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge: -1. waitTimeKnown Acts like a boolean value that indicates the behavior to take when wait time is not available, for instance when queue_all is **true**. -2. waitTimeFormatted Estimated wait time for the user. For example, five minutes. Alternatively, you can use: -3. waitTime Number of minutes of estimated wait for a user. -4. waitTimeHours Number of hours of estimated wait for a user (`Math.floor(waitTime/60)`). -5. waitTimeHourMinutes Number of minutes above the `waitTimeHours` value (`waitTime%60`). -6. queueIsFull Changes to **true** when no more people can be added to the queue. +1. {{`waitTimeKnown`}} Acts like a boolean value that indicates the behavior to take when wait time is not available, for instance when queue_all is **true**. +2. {{`waitTimeFormatted`}} Estimated wait time for the user. For example, five minutes. Alternatively, you can use: +3. {{`waitTime`}} Number of minutes of estimated wait for a user. +4. {{`waitTimeHours`}} Number of hours of estimated wait for a user (`Math.floor(waitTime/60)`). +5. {{`waitTimeHourMinutes`}} Number of minutes above the `waitTimeHours` value (`waitTime%60`). +6. {{`queueIsFull`}} Changes to **true** when no more people can be added to the queue. To view the full list of variables, look at the `cfWaitingRoom` object described under the `json_response_enabled` property in other Waiting Room API calls. - `default_template_language` (String) The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used. diff --git a/docs/data-sources/waiting_room_event.md b/docs/data-sources/waiting_room_event.md index 88d47109ba..10acef7c41 100644 --- a/docs/data-sources/waiting_room_event.md +++ b/docs/data-sources/waiting_room_event.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_waiting_room_event" "example_waiting_room_event" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + waiting_room_id = "699d98642c564d2e855e9661899b7252" + event_id = "25756b2dfe6e378a06b033b670413757" +} +``` ## Schema diff --git a/docs/data-sources/waiting_room_events.md b/docs/data-sources/waiting_room_events.md index 387b99fcea..db183835a0 100644 --- a/docs/data-sources/waiting_room_events.md +++ b/docs/data-sources/waiting_room_events.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_waiting_room_events" "example_waiting_room_events" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + waiting_room_id = "699d98642c564d2e855e9661899b7252" +} +``` ## Schema diff --git a/docs/data-sources/waiting_room_rules.md b/docs/data-sources/waiting_room_rules.md index 13f9fa5f6f..295e3ec996 100644 --- a/docs/data-sources/waiting_room_rules.md +++ b/docs/data-sources/waiting_room_rules.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_waiting_room_rules" "example_waiting_room_rules" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + waiting_room_id = "699d98642c564d2e855e9661899b7252" +} +``` ## Schema diff --git a/docs/data-sources/waiting_room_settings.md b/docs/data-sources/waiting_room_settings.md index 1340c8f29f..7fdae3b011 100644 --- a/docs/data-sources/waiting_room_settings.md +++ b/docs/data-sources/waiting_room_settings.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_waiting_room_settings" "example_waiting_room_settings" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/waiting_rooms.md b/docs/data-sources/waiting_rooms.md index 1955486284..afb9accb59 100644 --- a/docs/data-sources/waiting_rooms.md +++ b/docs/data-sources/waiting_rooms.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_waiting_rooms" "example_waiting_rooms" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema @@ -35,12 +42,12 @@ Read-Only: - `cookie_suffix` (String) Appends a '_' + a custom suffix to the end of Cloudflare Waiting Room's cookie name(__cf_waitingroom). If `cookie_suffix` is "abcd", the cookie name will be `__cf_waitingroom_abcd`. This field is required if using `additional_routes`. - `created_on` (String) - `custom_page_html` (String) Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge: -1. waitTimeKnown Acts like a boolean value that indicates the behavior to take when wait time is not available, for instance when queue_all is **true**. -2. waitTimeFormatted Estimated wait time for the user. For example, five minutes. Alternatively, you can use: -3. waitTime Number of minutes of estimated wait for a user. -4. waitTimeHours Number of hours of estimated wait for a user (`Math.floor(waitTime/60)`). -5. waitTimeHourMinutes Number of minutes above the `waitTimeHours` value (`waitTime%60`). -6. queueIsFull Changes to **true** when no more people can be added to the queue. +1. {{`waitTimeKnown`}} Acts like a boolean value that indicates the behavior to take when wait time is not available, for instance when queue_all is **true**. +2. {{`waitTimeFormatted`}} Estimated wait time for the user. For example, five minutes. Alternatively, you can use: +3. {{`waitTime`}} Number of minutes of estimated wait for a user. +4. {{`waitTimeHours`}} Number of hours of estimated wait for a user (`Math.floor(waitTime/60)`). +5. {{`waitTimeHourMinutes`}} Number of minutes above the `waitTimeHours` value (`waitTime%60`). +6. {{`queueIsFull`}} Changes to **true** when no more people can be added to the queue. To view the full list of variables, look at the `cfWaitingRoom` object described under the `json_response_enabled` property in other Waiting Room API calls. - `default_template_language` (String) The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used. diff --git a/docs/data-sources/web3_hostname.md b/docs/data-sources/web3_hostname.md index 69a5156fd9..2761ea7d7e 100644 --- a/docs/data-sources/web3_hostname.md +++ b/docs/data-sources/web3_hostname.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_web3_hostname" "example_web3_hostname" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + identifier = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/web3_hostnames.md b/docs/data-sources/web3_hostnames.md index 791d6f26a9..9959aa867d 100644 --- a/docs/data-sources/web3_hostnames.md +++ b/docs/data-sources/web3_hostnames.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_web3_hostnames" "example_web3_hostnames" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/web_analytics_site.md b/docs/data-sources/web_analytics_site.md index 8d525cb16c..d3fd7d5a41 100644 --- a/docs/data-sources/web_analytics_site.md +++ b/docs/data-sources/web_analytics_site.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_web_analytics_site" "example_web_analytics_site" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + site_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/web_analytics_sites.md b/docs/data-sources/web_analytics_sites.md index d1087ddab8..40c5e44156 100644 --- a/docs/data-sources/web_analytics_sites.md +++ b/docs/data-sources/web_analytics_sites.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_web_analytics_sites" "example_web_analytics_sites" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + order_by = "host" +} +``` ## Schema diff --git a/docs/data-sources/workers_cron_trigger.md b/docs/data-sources/workers_cron_trigger.md index a86d59181d..75227639fb 100644 --- a/docs/data-sources/workers_cron_trigger.md +++ b/docs/data-sources/workers_cron_trigger.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_workers_cron_trigger" "example_workers_cron_trigger" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + script_name = "this-is_my_script-01" +} +``` ## Schema diff --git a/docs/data-sources/workers_custom_domain.md b/docs/data-sources/workers_custom_domain.md index 67a53f5cd5..2c95b615e5 100644 --- a/docs/data-sources/workers_custom_domain.md +++ b/docs/data-sources/workers_custom_domain.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_workers_custom_domain" "example_workers_custom_domain" { + account_id = "9a7806061c88ada191ed06f989cc3dac" + domain_id = "dbe10b4bc17c295377eabd600e1787fd" +} +``` ## Schema diff --git a/docs/data-sources/workers_custom_domains.md b/docs/data-sources/workers_custom_domains.md index 50f11f9a9e..6098e9f4c6 100644 --- a/docs/data-sources/workers_custom_domains.md +++ b/docs/data-sources/workers_custom_domains.md @@ -9,6 +9,18 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_workers_custom_domains" "example_workers_custom_domains" { + account_id = "9a7806061c88ada191ed06f989cc3dac" + environment = "production" + hostname = "foo.example.com" + service = "foo" + zone_id = "593c9c94de529bbbfaac7c53ced0447d" + zone_name = "example.com" +} +``` ## Schema diff --git a/docs/data-sources/workers_deployment.md b/docs/data-sources/workers_deployment.md index 8dd55f5ef5..54fee236dd 100644 --- a/docs/data-sources/workers_deployment.md +++ b/docs/data-sources/workers_deployment.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_workers_deployment" "example_workers_deployment" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + script_name = "this-is_my_script-01" +} +``` ## Schema diff --git a/docs/data-sources/workers_for_platforms_dispatch_namespace.md b/docs/data-sources/workers_for_platforms_dispatch_namespace.md index 13d6c8bbe5..273b03be7e 100644 --- a/docs/data-sources/workers_for_platforms_dispatch_namespace.md +++ b/docs/data-sources/workers_for_platforms_dispatch_namespace.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_workers_for_platforms_dispatch_namespace" "example_workers_for_platforms_dispatch_namespace" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + dispatch_namespace = "my-dispatch-namespace" +} +``` ## Schema diff --git a/docs/data-sources/workers_for_platforms_dispatch_namespaces.md b/docs/data-sources/workers_for_platforms_dispatch_namespaces.md index 24804e7ecb..f47297344f 100644 --- a/docs/data-sources/workers_for_platforms_dispatch_namespaces.md +++ b/docs/data-sources/workers_for_platforms_dispatch_namespaces.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_workers_for_platforms_dispatch_namespaces" "example_workers_for_platforms_dispatch_namespaces" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/workers_kv.md b/docs/data-sources/workers_kv.md index 1c7059e5ff..65490c3ecd 100644 --- a/docs/data-sources/workers_kv.md +++ b/docs/data-sources/workers_kv.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_workers_kv" "example_workers_kv" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + namespace_id = "0f2ac74b498b48028cb68387c421e279" + key_name = "My-Key" +} +``` ## Schema diff --git a/docs/data-sources/workers_kv_namespace.md b/docs/data-sources/workers_kv_namespace.md index c7e8e9d024..d38e42a90c 100644 --- a/docs/data-sources/workers_kv_namespace.md +++ b/docs/data-sources/workers_kv_namespace.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_workers_kv_namespace" "example_workers_kv_namespace" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + namespace_id = "0f2ac74b498b48028cb68387c421e279" +} +``` ## Schema diff --git a/docs/data-sources/workers_kv_namespaces.md b/docs/data-sources/workers_kv_namespaces.md index dd04c8fa21..63cfff89c6 100644 --- a/docs/data-sources/workers_kv_namespaces.md +++ b/docs/data-sources/workers_kv_namespaces.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_workers_kv_namespaces" "example_workers_kv_namespaces" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + direction = "asc" + order = "id" +} +``` ## Schema diff --git a/docs/data-sources/workers_script.md b/docs/data-sources/workers_script.md index 904dc7756b..8a2881a509 100644 --- a/docs/data-sources/workers_script.md +++ b/docs/data-sources/workers_script.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_workers_script" "example_workers_script" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + script_name = "this-is_my_script-01" +} +``` ## Schema diff --git a/docs/data-sources/workers_script_subdomain.md b/docs/data-sources/workers_script_subdomain.md index b8f786c560..5965126e6f 100644 --- a/docs/data-sources/workers_script_subdomain.md +++ b/docs/data-sources/workers_script_subdomain.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_workers_script_subdomain" "example_workers_script_subdomain" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + script_name = "this-is_my_script-01" +} +``` ## Schema diff --git a/docs/data-sources/workers_scripts.md b/docs/data-sources/workers_scripts.md index 61858a6dfc..d4f57b02ce 100644 --- a/docs/data-sources/workers_scripts.md +++ b/docs/data-sources/workers_scripts.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_workers_scripts" "example_workers_scripts" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/workers_secret.md b/docs/data-sources/workers_secret.md index e26780490f..c4364807d7 100644 --- a/docs/data-sources/workers_secret.md +++ b/docs/data-sources/workers_secret.md @@ -9,6 +9,16 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_workers_secret" "example_workers_secret" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + dispatch_namespace = "my-dispatch-namespace" + script_name = "this-is_my_script-01" + secret_name = "mySecret" +} +``` ## Schema diff --git a/docs/data-sources/workers_secrets.md b/docs/data-sources/workers_secrets.md index 7b9a558606..7edc904431 100644 --- a/docs/data-sources/workers_secrets.md +++ b/docs/data-sources/workers_secrets.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_workers_secrets" "example_workers_secrets" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + dispatch_namespace = "my-dispatch-namespace" + script_name = "this-is_my_script-01" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_access_application.md b/docs/data-sources/zero_trust_access_application.md index e1f7bb653d..51d9986b48 100644 --- a/docs/data-sources/zero_trust_access_application.md +++ b/docs/data-sources/zero_trust_access_application.md @@ -12,42 +12,13 @@ description: |- ## Example Usage ```terraform -# For account level applications -resource "cloudflare_zero_trust_access_application" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "example" - domain = "example.com" -} - -# You can use either `name` or `domain` to identify the application -data "cloudflare_zero_trust_access_application" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "example" -} - -data "cloudflare_zero_trust_access_application" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - domain = "example.com" -} - -# For zone level applications -resource "cloudflare_zero_trust_access_application" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "example" - domain = "example.com" -} - -# You can use either `name` or `domain` to identify the application -data "cloudflare_zero_trust_access_application" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "example" -} - -data "cloudflare_zero_trust_access_application" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - domain = "example.com" +data "cloudflare_zero_trust_access_application" "example_zero_trust_access_application" { + app_id = "023e105f4ecef8ad9ca31a8372d0c353" + account_id = "account_id" + zone_id = "zone_id" } ``` + ## Schema diff --git a/docs/data-sources/zero_trust_access_applications.md b/docs/data-sources/zero_trust_access_applications.md index 20526ec3e1..8d252a4fb2 100644 --- a/docs/data-sources/zero_trust_access_applications.md +++ b/docs/data-sources/zero_trust_access_applications.md @@ -9,6 +9,18 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_access_applications" "example_zero_trust_access_applications" { + account_id = "account_id" + zone_id = "zone_id" + aud = "aud" + domain = "domain" + name = "name" + search = "search" +} +``` ## Schema @@ -158,11 +170,11 @@ Read-Only: - `service_token` (Attributes) (see [below for nested schema](#nestedatt--result--policies--exclude--service_token)) -### Nested Schema for `result.policies.exclude.service_token` +### Nested Schema for `result.policies.exclude.any_valid_service_token` -### Nested Schema for `result.policies.exclude.service_token` +### Nested Schema for `result.policies.exclude.auth_context` Read-Only: @@ -172,7 +184,7 @@ Read-Only: -### Nested Schema for `result.policies.exclude.service_token` +### Nested Schema for `result.policies.exclude.auth_method` Read-Only: @@ -180,7 +192,7 @@ Read-Only: -### Nested Schema for `result.policies.exclude.service_token` +### Nested Schema for `result.policies.exclude.azure_ad` Read-Only: @@ -189,11 +201,11 @@ Read-Only: -### Nested Schema for `result.policies.exclude.service_token` +### Nested Schema for `result.policies.exclude.certificate` -### Nested Schema for `result.policies.exclude.service_token` +### Nested Schema for `result.policies.exclude.common_name` Read-Only: @@ -201,7 +213,7 @@ Read-Only: -### Nested Schema for `result.policies.exclude.service_token` +### Nested Schema for `result.policies.exclude.device_posture` Read-Only: @@ -209,7 +221,7 @@ Read-Only: -### Nested Schema for `result.policies.exclude.service_token` +### Nested Schema for `result.policies.exclude.email` Read-Only: @@ -217,7 +229,7 @@ Read-Only: -### Nested Schema for `result.policies.exclude.service_token` +### Nested Schema for `result.policies.exclude.email_domain` Read-Only: @@ -225,7 +237,7 @@ Read-Only: -### Nested Schema for `result.policies.exclude.service_token` +### Nested Schema for `result.policies.exclude.email_list` Read-Only: @@ -233,11 +245,11 @@ Read-Only: -### Nested Schema for `result.policies.exclude.service_token` +### Nested Schema for `result.policies.exclude.everyone` -### Nested Schema for `result.policies.exclude.service_token` +### Nested Schema for `result.policies.exclude.external_evaluation` Read-Only: @@ -246,7 +258,7 @@ Read-Only: -### Nested Schema for `result.policies.exclude.service_token` +### Nested Schema for `result.policies.exclude.geo` Read-Only: @@ -254,7 +266,7 @@ Read-Only: -### Nested Schema for `result.policies.exclude.service_token` +### Nested Schema for `result.policies.exclude.github_organization` Read-Only: @@ -264,7 +276,7 @@ Read-Only: -### Nested Schema for `result.policies.exclude.service_token` +### Nested Schema for `result.policies.exclude.group` Read-Only: @@ -272,7 +284,7 @@ Read-Only: -### Nested Schema for `result.policies.exclude.service_token` +### Nested Schema for `result.policies.exclude.gsuite` Read-Only: @@ -281,7 +293,7 @@ Read-Only: -### Nested Schema for `result.policies.exclude.service_token` +### Nested Schema for `result.policies.exclude.ip` Read-Only: @@ -289,7 +301,7 @@ Read-Only: -### Nested Schema for `result.policies.exclude.service_token` +### Nested Schema for `result.policies.exclude.ip_list` Read-Only: @@ -297,7 +309,7 @@ Read-Only: -### Nested Schema for `result.policies.exclude.service_token` +### Nested Schema for `result.policies.exclude.okta` Read-Only: @@ -306,7 +318,7 @@ Read-Only: -### Nested Schema for `result.policies.exclude.service_token` +### Nested Schema for `result.policies.exclude.saml` Read-Only: @@ -352,11 +364,11 @@ Read-Only: - `service_token` (Attributes) (see [below for nested schema](#nestedatt--result--policies--include--service_token)) -### Nested Schema for `result.policies.include.service_token` +### Nested Schema for `result.policies.include.any_valid_service_token` -### Nested Schema for `result.policies.include.service_token` +### Nested Schema for `result.policies.include.auth_context` Read-Only: @@ -366,7 +378,7 @@ Read-Only: -### Nested Schema for `result.policies.include.service_token` +### Nested Schema for `result.policies.include.auth_method` Read-Only: @@ -374,7 +386,7 @@ Read-Only: -### Nested Schema for `result.policies.include.service_token` +### Nested Schema for `result.policies.include.azure_ad` Read-Only: @@ -383,11 +395,11 @@ Read-Only: -### Nested Schema for `result.policies.include.service_token` +### Nested Schema for `result.policies.include.certificate` -### Nested Schema for `result.policies.include.service_token` +### Nested Schema for `result.policies.include.common_name` Read-Only: @@ -395,7 +407,7 @@ Read-Only: -### Nested Schema for `result.policies.include.service_token` +### Nested Schema for `result.policies.include.device_posture` Read-Only: @@ -403,7 +415,7 @@ Read-Only: -### Nested Schema for `result.policies.include.service_token` +### Nested Schema for `result.policies.include.email` Read-Only: @@ -411,7 +423,7 @@ Read-Only: -### Nested Schema for `result.policies.include.service_token` +### Nested Schema for `result.policies.include.email_domain` Read-Only: @@ -419,7 +431,7 @@ Read-Only: -### Nested Schema for `result.policies.include.service_token` +### Nested Schema for `result.policies.include.email_list` Read-Only: @@ -427,11 +439,11 @@ Read-Only: -### Nested Schema for `result.policies.include.service_token` +### Nested Schema for `result.policies.include.everyone` -### Nested Schema for `result.policies.include.service_token` +### Nested Schema for `result.policies.include.external_evaluation` Read-Only: @@ -440,7 +452,7 @@ Read-Only: -### Nested Schema for `result.policies.include.service_token` +### Nested Schema for `result.policies.include.geo` Read-Only: @@ -448,7 +460,7 @@ Read-Only: -### Nested Schema for `result.policies.include.service_token` +### Nested Schema for `result.policies.include.github_organization` Read-Only: @@ -458,7 +470,7 @@ Read-Only: -### Nested Schema for `result.policies.include.service_token` +### Nested Schema for `result.policies.include.group` Read-Only: @@ -466,7 +478,7 @@ Read-Only: -### Nested Schema for `result.policies.include.service_token` +### Nested Schema for `result.policies.include.gsuite` Read-Only: @@ -475,7 +487,7 @@ Read-Only: -### Nested Schema for `result.policies.include.service_token` +### Nested Schema for `result.policies.include.ip` Read-Only: @@ -483,7 +495,7 @@ Read-Only: -### Nested Schema for `result.policies.include.service_token` +### Nested Schema for `result.policies.include.ip_list` Read-Only: @@ -491,7 +503,7 @@ Read-Only: -### Nested Schema for `result.policies.include.service_token` +### Nested Schema for `result.policies.include.okta` Read-Only: @@ -500,7 +512,7 @@ Read-Only: -### Nested Schema for `result.policies.include.service_token` +### Nested Schema for `result.policies.include.saml` Read-Only: @@ -546,11 +558,11 @@ Read-Only: - `service_token` (Attributes) (see [below for nested schema](#nestedatt--result--policies--require--service_token)) -### Nested Schema for `result.policies.require.service_token` +### Nested Schema for `result.policies.require.any_valid_service_token` -### Nested Schema for `result.policies.require.service_token` +### Nested Schema for `result.policies.require.auth_context` Read-Only: @@ -560,7 +572,7 @@ Read-Only: -### Nested Schema for `result.policies.require.service_token` +### Nested Schema for `result.policies.require.auth_method` Read-Only: @@ -568,7 +580,7 @@ Read-Only: -### Nested Schema for `result.policies.require.service_token` +### Nested Schema for `result.policies.require.azure_ad` Read-Only: @@ -577,11 +589,11 @@ Read-Only: -### Nested Schema for `result.policies.require.service_token` +### Nested Schema for `result.policies.require.certificate` -### Nested Schema for `result.policies.require.service_token` +### Nested Schema for `result.policies.require.common_name` Read-Only: @@ -589,7 +601,7 @@ Read-Only: -### Nested Schema for `result.policies.require.service_token` +### Nested Schema for `result.policies.require.device_posture` Read-Only: @@ -597,7 +609,7 @@ Read-Only: -### Nested Schema for `result.policies.require.service_token` +### Nested Schema for `result.policies.require.email` Read-Only: @@ -605,7 +617,7 @@ Read-Only: -### Nested Schema for `result.policies.require.service_token` +### Nested Schema for `result.policies.require.email_domain` Read-Only: @@ -613,7 +625,7 @@ Read-Only: -### Nested Schema for `result.policies.require.service_token` +### Nested Schema for `result.policies.require.email_list` Read-Only: @@ -621,11 +633,11 @@ Read-Only: -### Nested Schema for `result.policies.require.service_token` +### Nested Schema for `result.policies.require.everyone` -### Nested Schema for `result.policies.require.service_token` +### Nested Schema for `result.policies.require.external_evaluation` Read-Only: @@ -634,7 +646,7 @@ Read-Only: -### Nested Schema for `result.policies.require.service_token` +### Nested Schema for `result.policies.require.geo` Read-Only: @@ -642,7 +654,7 @@ Read-Only: -### Nested Schema for `result.policies.require.service_token` +### Nested Schema for `result.policies.require.github_organization` Read-Only: @@ -652,7 +664,7 @@ Read-Only: -### Nested Schema for `result.policies.require.service_token` +### Nested Schema for `result.policies.require.group` Read-Only: @@ -660,7 +672,7 @@ Read-Only: -### Nested Schema for `result.policies.require.service_token` +### Nested Schema for `result.policies.require.gsuite` Read-Only: @@ -669,7 +681,7 @@ Read-Only: -### Nested Schema for `result.policies.require.service_token` +### Nested Schema for `result.policies.require.ip` Read-Only: @@ -677,7 +689,7 @@ Read-Only: -### Nested Schema for `result.policies.require.service_token` +### Nested Schema for `result.policies.require.ip_list` Read-Only: @@ -685,7 +697,7 @@ Read-Only: -### Nested Schema for `result.policies.require.service_token` +### Nested Schema for `result.policies.require.okta` Read-Only: @@ -694,7 +706,7 @@ Read-Only: -### Nested Schema for `result.policies.require.service_token` +### Nested Schema for `result.policies.require.saml` Read-Only: @@ -844,7 +856,7 @@ Read-Only: - `transform_jsonata` (String) A [JSONata](https://jsonata.org/) expression that transforms the resource before provisioning it in the application. -### Nested Schema for `result.scim_config.mappings.transform_jsonata` +### Nested Schema for `result.scim_config.mappings.operations` Read-Only: diff --git a/docs/data-sources/zero_trust_access_custom_page.md b/docs/data-sources/zero_trust_access_custom_page.md index 0dd8f3e7cd..01ec6adb63 100644 --- a/docs/data-sources/zero_trust_access_custom_page.md +++ b/docs/data-sources/zero_trust_access_custom_page.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_access_custom_page" "example_zero_trust_access_custom_page" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + custom_page_id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_access_custom_pages.md b/docs/data-sources/zero_trust_access_custom_pages.md index 215c67ee55..c63a129474 100644 --- a/docs/data-sources/zero_trust_access_custom_pages.md +++ b/docs/data-sources/zero_trust_access_custom_pages.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_access_custom_pages" "example_zero_trust_access_custom_pages" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_access_group.md b/docs/data-sources/zero_trust_access_group.md index 81fe1e3e7f..07f5bdfae7 100644 --- a/docs/data-sources/zero_trust_access_group.md +++ b/docs/data-sources/zero_trust_access_group.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_access_group" "example_zero_trust_access_group" { + group_id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" + account_id = "account_id" + zone_id = "zone_id" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_access_groups.md b/docs/data-sources/zero_trust_access_groups.md index 0986e3a64f..8430524cd7 100644 --- a/docs/data-sources/zero_trust_access_groups.md +++ b/docs/data-sources/zero_trust_access_groups.md @@ -9,6 +9,16 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_access_groups" "example_zero_trust_access_groups" { + account_id = "account_id" + zone_id = "zone_id" + name = "name" + search = "search" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_access_identity_provider.md b/docs/data-sources/zero_trust_access_identity_provider.md index c57deaf83d..71bb535fb3 100644 --- a/docs/data-sources/zero_trust_access_identity_provider.md +++ b/docs/data-sources/zero_trust_access_identity_provider.md @@ -12,21 +12,13 @@ description: |- ## Example Usage ```terraform -data "cloudflare_zero_trust_access_identity_provider" "example" { - name = "Google SSO" - account_id = "f037e56e89293a057740de681ac9abbe" -} - -resource "cloudflare_zero_trust_access_application" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "name" - domain = "name.example.com" - type = "self_hosted" - session_duration = "24h" - allowed_idps = [data.cloudflare_zero_trust_access_identity_provider.example.id] - auto_redirect_to_identity = true +data "cloudflare_zero_trust_access_identity_provider" "example_zero_trust_access_identity_provider" { + identity_provider_id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" + account_id = "account_id" + zone_id = "zone_id" } ``` + ## Schema @@ -51,6 +43,7 @@ resource "cloudflare_zero_trust_access_application" "example" { Optional: - `account_id` (String) The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. +- `scim_enabled` (String) Indicates to Access to only retrieve identity providers that have the System for Cross-Domain Identity Management (SCIM) enabled. - `zone_id` (String) The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. @@ -79,6 +72,7 @@ Read-Only: - `okta_account` (String) Your okta account url - `onelogin_account` (String) Your OneLogin account url - `ping_env_id` (String) Your PingOne environment identifier +- `pkce_enabled` (Boolean) Enable Proof Key for Code Exchange (PKCE) - `prompt` (String) Indicates the type of user interaction that is required. prompt=login forces the user to enter their credentials on that request, negating single-sign on. prompt=none is the opposite. It ensures that the user isn't presented with any interactive prompt. If the request can't be completed silently by using single-sign on, the Microsoft identity platform returns an interaction_required error. prompt=select_account interrupts single sign-on providing account selection experience listing all the accounts either in session or any remembered account or an option to choose to use a different account altogether. - `redirect_url` (String) - `scopes` (List of String) OAuth scopes @@ -103,7 +97,7 @@ Read-Only: Read-Only: - `enabled` (Boolean) A flag to enable or disable SCIM for the identity provider. -- `identity_update_behavior` (String) Indicates how a SCIM event updates an Access identity. Use "automatic" to automatically update a user's Access identity and augment it with fields from the SCIM user resource. Use "reauth" to force re-authentication on group membership updates. With "reauth" Access identities will not contain fields from the SCIM user resource. +- `identity_update_behavior` (String) Indicates how a SCIM event updates a user identity used for policy evaluation. Use "automatic" to automatically update a user's identity and augment it with fields from the SCIM user resource. Use "reauth" to force re-authentication on group membership updates, user identity update will only occur after successful re-authentication. With "reauth" identities will not contain fields from the SCIM user resource. With "no_action" identities will not be changed by SCIM updates in any way and users will not be prompted to reauthenticate. - `seat_deprovision` (Boolean) A flag to remove a user's seat in Zero Trust when they have been deprovisioned in the Identity Provider. This cannot be enabled unless user_deprovision is also enabled. - `secret` (String) A read-only token generated when the SCIM integration is enabled for the first time. It is redacted on subsequent requests. If you lose this you will need to refresh it token at /access/identity_providers/:idpID/refresh_scim_secret. - `user_deprovision` (Boolean) A flag to enable revoking a user's session in Access and Gateway when they have been deprovisioned in the Identity Provider. diff --git a/docs/data-sources/zero_trust_access_identity_providers.md b/docs/data-sources/zero_trust_access_identity_providers.md index 2d0a54a7b7..0647d9e913 100644 --- a/docs/data-sources/zero_trust_access_identity_providers.md +++ b/docs/data-sources/zero_trust_access_identity_providers.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_access_identity_providers" "example_zero_trust_access_identity_providers" { + account_id = "account_id" + zone_id = "zone_id" + scim_enabled = "scim_enabled" +} +``` ## Schema @@ -17,6 +26,7 @@ description: |- - `account_id` (String) The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. - `max_items` (Number) Max items to fetch, default: 1000 +- `scim_enabled` (String) Indicates to Access to only retrieve identity providers that have the System for Cross-Domain Identity Management (SCIM) enabled. - `zone_id` (String) The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. ### Read-Only @@ -59,6 +69,7 @@ Read-Only: - `okta_account` (String) Your okta account url - `onelogin_account` (String) Your OneLogin account url - `ping_env_id` (String) Your PingOne environment identifier +- `pkce_enabled` (Boolean) Enable Proof Key for Code Exchange (PKCE) - `prompt` (String) Indicates the type of user interaction that is required. prompt=login forces the user to enter their credentials on that request, negating single-sign on. prompt=none is the opposite. It ensures that the user isn't presented with any interactive prompt. If the request can't be completed silently by using single-sign on, the Microsoft identity platform returns an interaction_required error. prompt=select_account interrupts single sign-on providing account selection experience listing all the accounts either in session or any remembered account or an option to choose to use a different account altogether. - `scopes` (List of String) OAuth scopes - `sign_request` (Boolean) Sign the SAML authentication request with Access credentials. To verify the signature, use the public key from the Access certs endpoints. @@ -82,7 +93,7 @@ Read-Only: Read-Only: - `enabled` (Boolean) A flag to enable or disable SCIM for the identity provider. -- `identity_update_behavior` (String) Indicates how a SCIM event updates an Access identity. Use "automatic" to automatically update a user's Access identity and augment it with fields from the SCIM user resource. Use "reauth" to force re-authentication on group membership updates. With "reauth" Access identities will not contain fields from the SCIM user resource. +- `identity_update_behavior` (String) Indicates how a SCIM event updates a user identity used for policy evaluation. Use "automatic" to automatically update a user's identity and augment it with fields from the SCIM user resource. Use "reauth" to force re-authentication on group membership updates, user identity update will only occur after successful re-authentication. With "reauth" identities will not contain fields from the SCIM user resource. With "no_action" identities will not be changed by SCIM updates in any way and users will not be prompted to reauthenticate. - `seat_deprovision` (Boolean) A flag to remove a user's seat in Zero Trust when they have been deprovisioned in the Identity Provider. This cannot be enabled unless user_deprovision is also enabled. - `secret` (String) A read-only token generated when the SCIM integration is enabled for the first time. It is redacted on subsequent requests. If you lose this you will need to refresh it token at /access/identity_providers/:idpID/refresh_scim_secret. - `user_deprovision` (Boolean) A flag to enable revoking a user's session in Access and Gateway when they have been deprovisioned in the Identity Provider. diff --git a/docs/data-sources/zero_trust_access_infrastructure_target.md b/docs/data-sources/zero_trust_access_infrastructure_target.md index 10daa8df8c..bdbb751e7e 100644 --- a/docs/data-sources/zero_trust_access_infrastructure_target.md +++ b/docs/data-sources/zero_trust_access_infrastructure_target.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_access_infrastructure_target" "example_zero_trust_access_infrastructure_target" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + target_id = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" +} +``` ## Schema @@ -59,7 +67,7 @@ Read-Only: Read-Only: - `ip_addr` (String) IP address of the target -- `virtual_network_id` (String) Private virtual network identifier for the target +- `virtual_network_id` (String) (optional) Private virtual network identifier for the target. If omitted, the default virtual network ID will be used. @@ -68,6 +76,6 @@ Read-Only: Read-Only: - `ip_addr` (String) IP address of the target -- `virtual_network_id` (String) Private virtual network identifier for the target +- `virtual_network_id` (String) (optional) Private virtual network identifier for the target. If omitted, the default virtual network ID will be used. diff --git a/docs/data-sources/zero_trust_access_infrastructure_targets.md b/docs/data-sources/zero_trust_access_infrastructure_targets.md index 1fe2cbe47d..30de90a7fe 100644 --- a/docs/data-sources/zero_trust_access_infrastructure_targets.md +++ b/docs/data-sources/zero_trust_access_infrastructure_targets.md @@ -9,6 +9,20 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_access_infrastructure_targets" "example_zero_trust_access_infrastructure_targets" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + created_after = "2019-12-27T18:11:19.117Z" + hostname = "hostname" + hostname_contains = "hostname_contains" + ip_v4 = "ip_v4" + ip_v6 = "ip_v6" + modified_after = "2019-12-27T18:11:19.117Z" + virtual_network_id = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" +} +``` ## Schema @@ -57,7 +71,7 @@ Read-Only: Read-Only: - `ip_addr` (String) IP address of the target -- `virtual_network_id` (String) Private virtual network identifier for the target +- `virtual_network_id` (String) (optional) Private virtual network identifier for the target. If omitted, the default virtual network ID will be used. @@ -66,6 +80,6 @@ Read-Only: Read-Only: - `ip_addr` (String) IP address of the target -- `virtual_network_id` (String) Private virtual network identifier for the target +- `virtual_network_id` (String) (optional) Private virtual network identifier for the target. If omitted, the default virtual network ID will be used. diff --git a/docs/data-sources/zero_trust_access_key_configuration.md b/docs/data-sources/zero_trust_access_key_configuration.md index eb6195a0c4..3120472662 100644 --- a/docs/data-sources/zero_trust_access_key_configuration.md +++ b/docs/data-sources/zero_trust_access_key_configuration.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_access_key_configuration" "example_zero_trust_access_key_configuration" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_access_mtls_certificate.md b/docs/data-sources/zero_trust_access_mtls_certificate.md index c0c654ed3b..151da6ef85 100644 --- a/docs/data-sources/zero_trust_access_mtls_certificate.md +++ b/docs/data-sources/zero_trust_access_mtls_certificate.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_access_mtls_certificate" "example_zero_trust_access_mtls_certificate" { + certificate_id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" + account_id = "account_id" + zone_id = "zone_id" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_access_mtls_certificates.md b/docs/data-sources/zero_trust_access_mtls_certificates.md index fb6b13918b..3b87efb0d8 100644 --- a/docs/data-sources/zero_trust_access_mtls_certificates.md +++ b/docs/data-sources/zero_trust_access_mtls_certificates.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_access_mtls_certificates" "example_zero_trust_access_mtls_certificates" { + account_id = "account_id" + zone_id = "zone_id" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_access_mtls_hostname_settings.md b/docs/data-sources/zero_trust_access_mtls_hostname_settings.md index a06c721584..5c6ddc7491 100644 --- a/docs/data-sources/zero_trust_access_mtls_hostname_settings.md +++ b/docs/data-sources/zero_trust_access_mtls_hostname_settings.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_access_mtls_hostname_settings" "example_zero_trust_access_mtls_hostname_settings" { + account_id = "account_id" + zone_id = "zone_id" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_access_policies.md b/docs/data-sources/zero_trust_access_policies.md index cfb7f3d191..770a94244b 100644 --- a/docs/data-sources/zero_trust_access_policies.md +++ b/docs/data-sources/zero_trust_access_policies.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_access_policies" "example_zero_trust_access_policies" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_access_policy.md b/docs/data-sources/zero_trust_access_policy.md index 1e37cdf5a9..57c22f095b 100644 --- a/docs/data-sources/zero_trust_access_policy.md +++ b/docs/data-sources/zero_trust_access_policy.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_access_policy" "example_zero_trust_access_policy" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + policy_id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_access_service_token.md b/docs/data-sources/zero_trust_access_service_token.md index 8dfb2e3b94..b27857494c 100644 --- a/docs/data-sources/zero_trust_access_service_token.md +++ b/docs/data-sources/zero_trust_access_service_token.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_access_service_token" "example_zero_trust_access_service_token" { + service_token_id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" + account_id = "account_id" + zone_id = "zone_id" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_access_service_tokens.md b/docs/data-sources/zero_trust_access_service_tokens.md index 4f29924fe2..a92d268c4a 100644 --- a/docs/data-sources/zero_trust_access_service_tokens.md +++ b/docs/data-sources/zero_trust_access_service_tokens.md @@ -9,6 +9,16 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_access_service_tokens" "example_zero_trust_access_service_tokens" { + account_id = "account_id" + zone_id = "zone_id" + name = "name" + search = "search" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_access_short_lived_certificate.md b/docs/data-sources/zero_trust_access_short_lived_certificate.md index 970abf6e65..cef5d23d86 100644 --- a/docs/data-sources/zero_trust_access_short_lived_certificate.md +++ b/docs/data-sources/zero_trust_access_short_lived_certificate.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_access_short_lived_certificate" "example_zero_trust_access_short_lived_certificate" { + app_id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" + account_id = "account_id" + zone_id = "zone_id" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_access_short_lived_certificates.md b/docs/data-sources/zero_trust_access_short_lived_certificates.md index cb415640d5..26d9da27d8 100644 --- a/docs/data-sources/zero_trust_access_short_lived_certificates.md +++ b/docs/data-sources/zero_trust_access_short_lived_certificates.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_access_short_lived_certificates" "example_zero_trust_access_short_lived_certificates" { + account_id = "account_id" + zone_id = "zone_id" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_access_tag.md b/docs/data-sources/zero_trust_access_tag.md index 2ca8eb636c..c4ac8875ed 100644 --- a/docs/data-sources/zero_trust_access_tag.md +++ b/docs/data-sources/zero_trust_access_tag.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_access_tag" "example_zero_trust_access_tag" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + tag_name = "engineers" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_access_tags.md b/docs/data-sources/zero_trust_access_tags.md index dbf857ce31..5ff5a83edf 100644 --- a/docs/data-sources/zero_trust_access_tags.md +++ b/docs/data-sources/zero_trust_access_tags.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_access_tags" "example_zero_trust_access_tags" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_device_custom_profile.md b/docs/data-sources/zero_trust_device_custom_profile.md index ed857d6a1c..06820b6ce4 100644 --- a/docs/data-sources/zero_trust_device_custom_profile.md +++ b/docs/data-sources/zero_trust_device_custom_profile.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_device_custom_profile" "example_zero_trust_device_custom_profile" { + account_id = "699d98642c564d2e855e9661899b7252" + policy_id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_device_custom_profile_local_domain_fallback.md b/docs/data-sources/zero_trust_device_custom_profile_local_domain_fallback.md index 7c8cb9acc2..71ddf357a8 100644 --- a/docs/data-sources/zero_trust_device_custom_profile_local_domain_fallback.md +++ b/docs/data-sources/zero_trust_device_custom_profile_local_domain_fallback.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_device_custom_profile_local_domain_fallback" "example_zero_trust_device_custom_profile_local_domain_fallback" { + account_id = "699d98642c564d2e855e9661899b7252" + policy_id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_device_custom_profiles.md b/docs/data-sources/zero_trust_device_custom_profiles.md index b5fd833e7b..0a987e8f96 100644 --- a/docs/data-sources/zero_trust_device_custom_profiles.md +++ b/docs/data-sources/zero_trust_device_custom_profiles.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_device_custom_profiles" "example_zero_trust_device_custom_profiles" { + account_id = "699d98642c564d2e855e9661899b7252" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_device_default_profile.md b/docs/data-sources/zero_trust_device_default_profile.md index bb7efde894..9e9cca114d 100644 --- a/docs/data-sources/zero_trust_device_default_profile.md +++ b/docs/data-sources/zero_trust_device_default_profile.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_device_default_profile" "example_zero_trust_device_default_profile" { + account_id = "699d98642c564d2e855e9661899b7252" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_device_default_profile_certificates.md b/docs/data-sources/zero_trust_device_default_profile_certificates.md index 3e7c864381..b7858866ff 100644 --- a/docs/data-sources/zero_trust_device_default_profile_certificates.md +++ b/docs/data-sources/zero_trust_device_default_profile_certificates.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_device_default_profile_certificates" "example_zero_trust_device_default_profile_certificates" { + zone_id = "699d98642c564d2e855e9661899b7252" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_device_default_profile_local_domain_fallback.md b/docs/data-sources/zero_trust_device_default_profile_local_domain_fallback.md index 62c6169905..2164ef4775 100644 --- a/docs/data-sources/zero_trust_device_default_profile_local_domain_fallback.md +++ b/docs/data-sources/zero_trust_device_default_profile_local_domain_fallback.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_device_default_profile_local_domain_fallback" "example_zero_trust_device_default_profile_local_domain_fallback" { + account_id = "699d98642c564d2e855e9661899b7252" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_device_managed_networks.md b/docs/data-sources/zero_trust_device_managed_networks.md index e50df1252b..bb2e7502c3 100644 --- a/docs/data-sources/zero_trust_device_managed_networks.md +++ b/docs/data-sources/zero_trust_device_managed_networks.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_device_managed_networks" "example_zero_trust_device_managed_networks" { + account_id = "699d98642c564d2e855e9661899b7252" + network_id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_device_managed_networks_list.md b/docs/data-sources/zero_trust_device_managed_networks_list.md index b1197c48a1..9751394d1d 100644 --- a/docs/data-sources/zero_trust_device_managed_networks_list.md +++ b/docs/data-sources/zero_trust_device_managed_networks_list.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_device_managed_networks_list" "example_zero_trust_device_managed_networks_list" { + account_id = "699d98642c564d2e855e9661899b7252" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_device_posture_integration.md b/docs/data-sources/zero_trust_device_posture_integration.md index 3a4a71ea16..5ff59f6a47 100644 --- a/docs/data-sources/zero_trust_device_posture_integration.md +++ b/docs/data-sources/zero_trust_device_posture_integration.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_device_posture_integration" "example_zero_trust_device_posture_integration" { + account_id = "699d98642c564d2e855e9661899b7252" + integration_id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_device_posture_integrations.md b/docs/data-sources/zero_trust_device_posture_integrations.md index 1cdd4303f9..60a42f08fe 100644 --- a/docs/data-sources/zero_trust_device_posture_integrations.md +++ b/docs/data-sources/zero_trust_device_posture_integrations.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_device_posture_integrations" "example_zero_trust_device_posture_integrations" { + account_id = "699d98642c564d2e855e9661899b7252" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_device_posture_rule.md b/docs/data-sources/zero_trust_device_posture_rule.md index 3c942e337c..ef554ad3b5 100644 --- a/docs/data-sources/zero_trust_device_posture_rule.md +++ b/docs/data-sources/zero_trust_device_posture_rule.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_device_posture_rule" "example_zero_trust_device_posture_rule" { + account_id = "699d98642c564d2e855e9661899b7252" + rule_id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" +} +``` ## Schema @@ -69,7 +77,7 @@ Read-Only: - `os` (String) Os Version - `os_distro_name` (String) Operating System Distribution Name (linux only) - `os_distro_revision` (String) Version of OS Distribution (linux only) -- `os_version_extra` (String) Additional version data. For Mac or iOS, the Product Verison Extra. For Linux, the kernel release version. (Mac, iOS, and Linux only) +- `os_version_extra` (String) Additional version data. For Mac or iOS, the Product Version Extra. For Linux, the kernel release version. (Mac, iOS, and Linux only) - `overall` (String) overall - `path` (String) File path. - `require_all` (Boolean) Whether to check all disks for encryption. diff --git a/docs/data-sources/zero_trust_device_posture_rules.md b/docs/data-sources/zero_trust_device_posture_rules.md index 45548db7bd..141c19e074 100644 --- a/docs/data-sources/zero_trust_device_posture_rules.md +++ b/docs/data-sources/zero_trust_device_posture_rules.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_device_posture_rules" "example_zero_trust_device_posture_rules" { + account_id = "699d98642c564d2e855e9661899b7252" +} +``` ## Schema @@ -70,7 +77,7 @@ Read-Only: - `os` (String) Os Version - `os_distro_name` (String) Operating System Distribution Name (linux only) - `os_distro_revision` (String) Version of OS Distribution (linux only) -- `os_version_extra` (String) Additional version data. For Mac or iOS, the Product Verison Extra. For Linux, the kernel release version. (Mac, iOS, and Linux only) +- `os_version_extra` (String) Additional version data. For Mac or iOS, the Product Version Extra. For Linux, the kernel release version. (Mac, iOS, and Linux only) - `overall` (String) overall - `path` (String) File path. - `require_all` (Boolean) Whether to check all disks for encryption. diff --git a/docs/data-sources/zero_trust_dex_test.md b/docs/data-sources/zero_trust_dex_test.md index 59b4cf6d4d..e06d6a006f 100644 --- a/docs/data-sources/zero_trust_dex_test.md +++ b/docs/data-sources/zero_trust_dex_test.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_dex_test" "example_zero_trust_dex_test" { + account_id = "699d98642c564d2e855e9661899b7252" + dex_test_id = "372e67954025e0ba6aaa6d586b9e0b59" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_dex_tests.md b/docs/data-sources/zero_trust_dex_tests.md index 50057617a2..601c7bcf64 100644 --- a/docs/data-sources/zero_trust_dex_tests.md +++ b/docs/data-sources/zero_trust_dex_tests.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_dex_tests" "example_zero_trust_dex_tests" { + account_id = "699d98642c564d2e855e9661899b7252" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_dlp_custom_profile.md b/docs/data-sources/zero_trust_dlp_custom_profile.md index 19e9b7ef61..752e65abcd 100644 --- a/docs/data-sources/zero_trust_dlp_custom_profile.md +++ b/docs/data-sources/zero_trust_dlp_custom_profile.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_dlp_custom_profile" "example_zero_trust_dlp_custom_profile" { + account_id = "account_id" + profile_id = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_dlp_dataset.md b/docs/data-sources/zero_trust_dlp_dataset.md index 87c9c0a7e0..b7401c7958 100644 --- a/docs/data-sources/zero_trust_dlp_dataset.md +++ b/docs/data-sources/zero_trust_dlp_dataset.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_dlp_dataset" "example_zero_trust_dlp_dataset" { + account_id = "account_id" + dataset_id = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_dlp_datasets.md b/docs/data-sources/zero_trust_dlp_datasets.md index 93df466853..eae0d01f8b 100644 --- a/docs/data-sources/zero_trust_dlp_datasets.md +++ b/docs/data-sources/zero_trust_dlp_datasets.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_dlp_datasets" "example_zero_trust_dlp_datasets" { + account_id = "account_id" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_dlp_predefined_profile.md b/docs/data-sources/zero_trust_dlp_predefined_profile.md index bf3f5631ea..fe3b5197d3 100644 --- a/docs/data-sources/zero_trust_dlp_predefined_profile.md +++ b/docs/data-sources/zero_trust_dlp_predefined_profile.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_dlp_predefined_profile" "example_zero_trust_dlp_predefined_profile" { + account_id = "account_id" + profile_id = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_dns_location.md b/docs/data-sources/zero_trust_dns_location.md index e6c570b3cf..8308a85d45 100644 --- a/docs/data-sources/zero_trust_dns_location.md +++ b/docs/data-sources/zero_trust_dns_location.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_dns_location" "example_zero_trust_dns_location" { + account_id = "699d98642c564d2e855e9661899b7252" + location_id = "ed35569b41ce4d1facfe683550f54086" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_dns_locations.md b/docs/data-sources/zero_trust_dns_locations.md index 463366950b..705c4cc895 100644 --- a/docs/data-sources/zero_trust_dns_locations.md +++ b/docs/data-sources/zero_trust_dns_locations.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_dns_locations" "example_zero_trust_dns_locations" { + account_id = "699d98642c564d2e855e9661899b7252" +} +``` ## Schema @@ -64,7 +71,7 @@ Read-Only: - `require_token` (Boolean) True if the endpoint requires [user identity](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/agentless/dns/dns-over-https/#filter-doh-requests-by-user) authentication. -### Nested Schema for `result.endpoints.doh.require_token` +### Nested Schema for `result.endpoints.doh.networks` Read-Only: diff --git a/docs/data-sources/zero_trust_gateway_policies.md b/docs/data-sources/zero_trust_gateway_policies.md index 613bd1ced9..dec45a3b75 100644 --- a/docs/data-sources/zero_trust_gateway_policies.md +++ b/docs/data-sources/zero_trust_gateway_policies.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_gateway_policies" "example_zero_trust_gateway_policies" { + account_id = "699d98642c564d2e855e9661899b7252" +} +``` ## Schema @@ -135,7 +142,7 @@ Read-Only: - `ipv6` (Attributes List) (see [below for nested schema](#nestedatt--result--rule_settings--dns_resolvers--ipv6)) -### Nested Schema for `result.rule_settings.dns_resolvers.ipv6` +### Nested Schema for `result.rule_settings.dns_resolvers.ipv4` Read-Only: diff --git a/docs/data-sources/zero_trust_gateway_policy.md b/docs/data-sources/zero_trust_gateway_policy.md index 22c3821eb8..ed15eea079 100644 --- a/docs/data-sources/zero_trust_gateway_policy.md +++ b/docs/data-sources/zero_trust_gateway_policy.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_gateway_policy" "example_zero_trust_gateway_policy" { + account_id = "699d98642c564d2e855e9661899b7252" + rule_id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_gateway_proxy_endpoint.md b/docs/data-sources/zero_trust_gateway_proxy_endpoint.md index e1b94a7a06..6ae11d0e20 100644 --- a/docs/data-sources/zero_trust_gateway_proxy_endpoint.md +++ b/docs/data-sources/zero_trust_gateway_proxy_endpoint.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_gateway_proxy_endpoint" "example_zero_trust_gateway_proxy_endpoint" { + account_id = "699d98642c564d2e855e9661899b7252" + proxy_endpoint_id = "ed35569b41ce4d1facfe683550f54086" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_gateway_settings.md b/docs/data-sources/zero_trust_gateway_settings.md index f483f0711d..36934477b6 100644 --- a/docs/data-sources/zero_trust_gateway_settings.md +++ b/docs/data-sources/zero_trust_gateway_settings.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_gateway_settings" "example_zero_trust_gateway_settings" { + account_id = "699d98642c564d2e855e9661899b7252" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_list.md b/docs/data-sources/zero_trust_list.md index 1bdea36cfb..8a5db0a0a7 100644 --- a/docs/data-sources/zero_trust_list.md +++ b/docs/data-sources/zero_trust_list.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_list" "example_zero_trust_list" { + account_id = "699d98642c564d2e855e9661899b7252" + list_id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_lists.md b/docs/data-sources/zero_trust_lists.md index 054c7cdcb9..eaca186c1d 100644 --- a/docs/data-sources/zero_trust_lists.md +++ b/docs/data-sources/zero_trust_lists.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_lists" "example_zero_trust_lists" { + account_id = "699d98642c564d2e855e9661899b7252" + type = "SERIAL" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_organization.md b/docs/data-sources/zero_trust_organization.md index 2637ada04f..13c636ed79 100644 --- a/docs/data-sources/zero_trust_organization.md +++ b/docs/data-sources/zero_trust_organization.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_organization" "example_zero_trust_organization" { + account_id = "account_id" + zone_id = "zone_id" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_risk_scoring_integration.md b/docs/data-sources/zero_trust_risk_scoring_integration.md index eca24cf2aa..1c3836e034 100644 --- a/docs/data-sources/zero_trust_risk_scoring_integration.md +++ b/docs/data-sources/zero_trust_risk_scoring_integration.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_risk_scoring_integration" "example_zero_trust_risk_scoring_integration" { + account_id = "account_id" + integration_id = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_risk_scoring_integrations.md b/docs/data-sources/zero_trust_risk_scoring_integrations.md index f099f58c90..84484a82d1 100644 --- a/docs/data-sources/zero_trust_risk_scoring_integrations.md +++ b/docs/data-sources/zero_trust_risk_scoring_integrations.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_risk_scoring_integrations" "example_zero_trust_risk_scoring_integrations" { + account_id = "account_id" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_tunnel_cloudflared.md b/docs/data-sources/zero_trust_tunnel_cloudflared.md index 287ef4131b..0cd6017c54 100644 --- a/docs/data-sources/zero_trust_tunnel_cloudflared.md +++ b/docs/data-sources/zero_trust_tunnel_cloudflared.md @@ -12,11 +12,12 @@ description: |- ## Example Usage ```terraform -data "cloudflare_zero_trust_tunnel_cloudflared" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "my-tunnel" +data "cloudflare_zero_trust_tunnel_cloudflared" "example_zero_trust_tunnel_cloudflared" { + account_id = "699d98642c564d2e855e9661899b7252" + tunnel_id = "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415" } ``` + ## Schema diff --git a/docs/data-sources/zero_trust_tunnel_cloudflared_config.md b/docs/data-sources/zero_trust_tunnel_cloudflared_config.md index ecbe2a809f..f474994c94 100644 --- a/docs/data-sources/zero_trust_tunnel_cloudflared_config.md +++ b/docs/data-sources/zero_trust_tunnel_cloudflared_config.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_tunnel_cloudflared_config" "example_zero_trust_tunnel_cloudflared_config" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + tunnel_id = "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415" +} +``` ## Schema @@ -62,7 +70,7 @@ Read-Only: - `tls_timeout` (Number) Timeout for completing a TLS handshake to your origin server, if you have chosen to connect Tunnel to an HTTPS server. -### Nested Schema for `config.ingress.origin_request.tls_timeout` +### Nested Schema for `config.ingress.origin_request.access` Read-Only: diff --git a/docs/data-sources/zero_trust_tunnel_cloudflared_route.md b/docs/data-sources/zero_trust_tunnel_cloudflared_route.md index 0a84836bed..c43a53429e 100644 --- a/docs/data-sources/zero_trust_tunnel_cloudflared_route.md +++ b/docs/data-sources/zero_trust_tunnel_cloudflared_route.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_tunnel_cloudflared_route" "example_zero_trust_tunnel_cloudflared_route" { + account_id = "699d98642c564d2e855e9661899b7252" + route_id = "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_tunnel_cloudflared_routes.md b/docs/data-sources/zero_trust_tunnel_cloudflared_routes.md index 51f34994b4..555a5aacc0 100644 --- a/docs/data-sources/zero_trust_tunnel_cloudflared_routes.md +++ b/docs/data-sources/zero_trust_tunnel_cloudflared_routes.md @@ -9,6 +9,22 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_tunnel_cloudflared_routes" "example_zero_trust_tunnel_cloudflared_routes" { + account_id = "699d98642c564d2e855e9661899b7252" + comment = "Example comment for this route." + existed_at = "2019-10-12T07:20:50.52Z" + is_deleted = true + network_subset = "172.16.0.0/16" + network_superset = "172.16.0.0/16" + route_id = "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415" + tun_types = "cfd_tunnel,warp_connector" + tunnel_id = "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415" + virtual_network_id = "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_tunnel_cloudflared_virtual_network.md b/docs/data-sources/zero_trust_tunnel_cloudflared_virtual_network.md index 9ddddcc78c..d46ae813cb 100644 --- a/docs/data-sources/zero_trust_tunnel_cloudflared_virtual_network.md +++ b/docs/data-sources/zero_trust_tunnel_cloudflared_virtual_network.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_tunnel_cloudflared_virtual_network" "example_zero_trust_tunnel_cloudflared_virtual_network" { + account_id = "699d98642c564d2e855e9661899b7252" + virtual_network_id = "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_tunnel_cloudflared_virtual_networks.md b/docs/data-sources/zero_trust_tunnel_cloudflared_virtual_networks.md index 655b295367..9fcf43fad4 100644 --- a/docs/data-sources/zero_trust_tunnel_cloudflared_virtual_networks.md +++ b/docs/data-sources/zero_trust_tunnel_cloudflared_virtual_networks.md @@ -9,6 +9,17 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_tunnel_cloudflared_virtual_networks" "example_zero_trust_tunnel_cloudflared_virtual_networks" { + account_id = "699d98642c564d2e855e9661899b7252" + id = "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415" + is_default = true + is_deleted = true + name = "us-east-1-vpc" +} +``` ## Schema diff --git a/docs/data-sources/zero_trust_tunnel_cloudflareds.md b/docs/data-sources/zero_trust_tunnel_cloudflareds.md index 246c5f19c9..f00cdb7252 100644 --- a/docs/data-sources/zero_trust_tunnel_cloudflareds.md +++ b/docs/data-sources/zero_trust_tunnel_cloudflareds.md @@ -9,6 +9,22 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zero_trust_tunnel_cloudflareds" "example_zero_trust_tunnel_cloudflareds" { + account_id = "699d98642c564d2e855e9661899b7252" + exclude_prefix = "vpc1-" + existed_at = "2019-10-12T07:20:50.52Z" + include_prefix = "vpc1-" + is_deleted = true + name = "blog" + status = "inactive" + uuid = "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415" + was_active_at = "2009-11-10T23:00:00Z" + was_inactive_at = "2009-11-10T23:00:00Z" +} +``` ## Schema diff --git a/docs/data-sources/zone.md b/docs/data-sources/zone.md index f6f8f3d9db..063611bc2b 100644 --- a/docs/data-sources/zone.md +++ b/docs/data-sources/zone.md @@ -12,18 +12,11 @@ description: |- ## Example Usage ```terraform -data "cloudflare_zone" "example" { - name = "example.com" -} - -resource "cloudflare_dns_record" "example" { - zone_id = data.cloudflare_zone.example.id - name = "www" - value = "203.0.113.1" - type = "A" - proxied = true +data "cloudflare_zone" "example_zone" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" } ``` + ## Schema diff --git a/docs/data-sources/zone_cache_reserve.md b/docs/data-sources/zone_cache_reserve.md index 76ebe62bf8..cd5448a521 100644 --- a/docs/data-sources/zone_cache_reserve.md +++ b/docs/data-sources/zone_cache_reserve.md @@ -12,10 +12,11 @@ description: |- ## Example Usage ```terraform -data "cloudflare_zone_cache_reserve" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" +data "cloudflare_zone_cache_reserve" "example_zone_cache_reserve" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" } ``` + ## Schema diff --git a/docs/data-sources/zone_cache_variants.md b/docs/data-sources/zone_cache_variants.md index 30a4f7e8e4..f3bc92b9dd 100644 --- a/docs/data-sources/zone_cache_variants.md +++ b/docs/data-sources/zone_cache_variants.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zone_cache_variants" "example_zone_cache_variants" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/zone_dnssec.md b/docs/data-sources/zone_dnssec.md index cfe71bd6f7..f3eb67594e 100644 --- a/docs/data-sources/zone_dnssec.md +++ b/docs/data-sources/zone_dnssec.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zone_dnssec" "example_zone_dnssec" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/zone_hold.md b/docs/data-sources/zone_hold.md index 7e3bbf5637..514c4df331 100644 --- a/docs/data-sources/zone_hold.md +++ b/docs/data-sources/zone_hold.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zone_hold" "example_zone_hold" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/data-sources/zone_lockdown.md b/docs/data-sources/zone_lockdown.md index 8df139287f..b2f8136c4e 100644 --- a/docs/data-sources/zone_lockdown.md +++ b/docs/data-sources/zone_lockdown.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zone_lockdown" "example_zone_lockdown" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + lock_downs_id = "372e67954025e0ba6aaa6d586b9e0b59" +} +``` ## Schema diff --git a/docs/data-sources/zone_lockdowns.md b/docs/data-sources/zone_lockdowns.md index ee7d4f5591..93e67bdb0a 100644 --- a/docs/data-sources/zone_lockdowns.md +++ b/docs/data-sources/zone_lockdowns.md @@ -9,6 +9,22 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zone_lockdowns" "example_zone_lockdowns" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + created_on = "2014-01-01T05:20:00.12345Z" + description = "endpoints" + description_search = "endpoints" + ip = "1.2.3.4" + ip_range_search = "1.2.3.0/16" + ip_search = "1.2.3.4" + modified_on = "2014-01-01T05:20:00.12345Z" + priority = 5 + uri_search = "/some/path" +} +``` ## Schema diff --git a/docs/data-sources/zone_setting.md b/docs/data-sources/zone_setting.md index 1ad71bffa2..74f203c446 100644 --- a/docs/data-sources/zone_setting.md +++ b/docs/data-sources/zone_setting.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zone_setting" "example_zone_setting" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + setting_id = "always_online" +} +``` ## Schema diff --git a/docs/data-sources/zone_subscription.md b/docs/data-sources/zone_subscription.md index 530a389a40..e5faf28298 100644 --- a/docs/data-sources/zone_subscription.md +++ b/docs/data-sources/zone_subscription.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +data "cloudflare_zone_subscription" "example_zone_subscription" { + identifier = "506e3185e9c882d175a2d0cb0093d9f2" +} +``` ## Schema diff --git a/docs/data-sources/zones.md b/docs/data-sources/zones.md index 96cbd7f703..af56e61e5e 100644 --- a/docs/data-sources/zones.md +++ b/docs/data-sources/zones.md @@ -12,51 +12,18 @@ description: |- ## Example Usage ```terraform -# Given you have the following zones in Cloudflare. -# -# - example.com -# - example.net -# - not-example.com -# -# Look for a single zone that you know exists using an exact match. -# API request will be for zones?name=example.com. Will not match not-example.com -# or example.net. -data "cloudflare_zones" "example" { - filter { - name = "example.com" - } -} - -# Look for all zones which include "example". -# API request will be for zones?name=contains:example. Will return all three -# zones. -data "cloudflare_zones" "example" { - filter { - name = "example" - lookup_type = "contains" - } -} - -# Look for all zones which include "example" but start with "not-". -# API request will be for zones?name=contains:example. Will perform client side -# filtering using the provided regex and will only match the single zone, -# not-example.com. -data "cloudflare_zones" "example" { - filter { - name = "example" - lookup_type = "contains" - match = "^not-" - } -} - -# Look for all active zones in an account. -data "cloudflare_zones" "example" { - filter { - account_id = "f037e56e89293a057740de681ac9abbe" - status = "active" +data "cloudflare_zones" "example_zones" { + account = { + id = "id" + name = "name" } + direction = "asc" + name = "name" + order = "name" + status = "initializing" } ``` + ## Schema diff --git a/docs/guides/version-5-upgrade.md b/docs/guides/version-5-upgrade.md index 9fabc84f73..c07f9dc702 100644 --- a/docs/guides/version-5-upgrade.md +++ b/docs/guides/version-5-upgrade.md @@ -9,7 +9,9 @@ description: Terraform Cloudflare Provider Version 5 Upgrade Guide Version 5 of the Cloudflare Terraform Provider is a ground-up rewrite of the provider, using code generation from our OpenAPI spec. While this introduces attribute and resource changes, it moves the provider to align more closely -with the service endpoints and makes automatic support going forward possible. +with the service endpoints. This allows automation the steps to get changes +into the provider lowering the delay between new features and complete +coverage. ## Provider Version Configuration @@ -53,6 +55,13 @@ This will allow you to rewrite the parts of your Terraform configuration (not st that have changed automatically. Once you [install Grit], you can run the following command in the directory where your Terraform configuration is located. +~> While all efforts have been made to ease the transition, some of the more complex +resources that may contain difficult to reconcile resources have been intentionally +skipped for the automatic migration and are only manually documented. If you are +using modules or other dynamic features of HCL, the provided codemods may not be +as effective. We recommend reviewing the migration notes below to verify all the +changes. + ```bash $ grit apply cloudflare_terraform_v5 ``` @@ -60,10 +69,6 @@ $ grit apply cloudflare_terraform_v5 We recommend ensuring you are using version control for these changes or make a backup prior to initiating the change to enable reverting if needed. -~> If you are using modules or other dynamic features of HCL, the provided -codemods may not be as effective. We recommend reviewing the migration notes below -to verify all the changes. - ```grit diff --git a/docs/index.md b/docs/index.md index 30de530b25..231b409373 100644 --- a/docs/index.md +++ b/docs/index.md @@ -34,14 +34,11 @@ as DNS records, zone settings, load balancers and much more! ## Example Usage ```terraform -# Configure the Cloudflare provider using the required_providers stanza -# required with Terraform 0.13 and beyond. You may optionally use version -# directive to prevent breaking changes occurring unannounced. terraform { required_providers { cloudflare = { source = "cloudflare/cloudflare" - version = "~> 4.0" + version = "~> 5" } } } @@ -50,15 +47,10 @@ provider "cloudflare" { api_token = var.cloudflare_api_token } -# Create a record +# Create a DNS record resource "cloudflare_dns_record" "www" { # ... } - -# Create a page rule -resource "cloudflare_page_rule" "www" { - # ... -} ``` diff --git a/docs/resources/access_rule.md b/docs/resources/access_rule.md index 6a4a6576b7..c5da6757e2 100644 --- a/docs/resources/access_rule.md +++ b/docs/resources/access_rule.md @@ -12,46 +12,17 @@ description: |- ## Example Usage ```terraform -# Challenge requests coming from known Tor exit nodes. -resource "cloudflare_access_rule" "tor_exit_nodes" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - notes = "Requests coming from known Tor exit nodes" - mode = "challenge" +resource "cloudflare_access_rule" "example_access_rule" { configuration = { - target = "country" - value = "T1" - } -} - -# Allowlist requests coming from Antarctica, but only for single zone. -resource "cloudflare_access_rule" "antarctica" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - notes = "Requests coming from Antarctica" - mode = "whitelist" - configuration = { - target = "country" - value = "AQ" - } -} - -# Allowlist office's network IP ranges on all account zones (or other lists of -# resources). -variable "my_office" { - type = list(string) - default = ["192.0.2.0/24", "198.51.100.0/24", "2001:db8::/56"] -} - -resource "cloudflare_access_rule" "office_network" { - account_id = "f037e56e89293a057740de681ac9abbe" - count = length(var.my_office) - notes = "Requests coming from office network" - mode = "whitelist" - configuration = { - target = "ip_range" - value = element(var.my_office, count.index) + target = "ip" + value = "198.51.100.4" } + mode = "block" + zone_id = "zone_id" + notes = "This rule is enabled because of an event that occurred on date X." } ``` + ## Schema @@ -97,12 +68,5 @@ Read-Only: Import is supported using the following syntax: ```shell -# User level access rule import. -$ terraform import cloudflare_access_rule.default user// - -# Zone level access rule import. -$ terraform import cloudflare_access_rule.default zone// - -# Account level access rule import. -$ terraform import cloudflare_access_rule.default account// +$ terraform import cloudflare_access_rule.example '<{accounts|zones}/{account_id|zone_id}>/' ``` diff --git a/docs/resources/account.md b/docs/resources/account.md index 50463561eb..423bb09d7a 100644 --- a/docs/resources/account.md +++ b/docs/resources/account.md @@ -12,12 +12,15 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_account" "example" { - name = "some-enterprise-account" - type = "enterprise" - enforce_twofactor = true +resource "cloudflare_account" "example_account" { + name = "name" + type = "standard" + unit = { + id = "f267e341f3dd4697bd3b9f71dd96247f" + } } ``` + ## Schema @@ -72,5 +75,5 @@ Optional: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_account.example +$ terraform import cloudflare_account.example '' ``` diff --git a/docs/resources/account_member.md b/docs/resources/account_member.md index d937481104..ad87306f9d 100644 --- a/docs/resources/account_member.md +++ b/docs/resources/account_member.md @@ -12,15 +12,14 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_account_member" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - email_address = "user@example.com" - role_ids = [ - "68b329da9893e34099c7d8ad5cb9c940", - "d784fa8b6d98d27699781bd9a7cf19f0" - ] +resource "cloudflare_account_member" "example_account_member" { + account_id = "eb78d65290b24279ba6f44721b3ea3c4" + email = "user@example.com" + roles = ["3536bcfad5faccb999b47003c79917fb"] + status = "accepted" } ``` + ## Schema @@ -86,5 +85,5 @@ Read-Only: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_account_member.example / +$ terraform import cloudflare_account_member.example '/' ``` diff --git a/docs/resources/account_subscription.md b/docs/resources/account_subscription.md index 00d0939aa3..bd3f458266 100644 --- a/docs/resources/account_subscription.md +++ b/docs/resources/account_subscription.md @@ -9,6 +9,23 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_account_subscription" "example_account_subscription" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + frequency = "weekly" + rate_plan = { + id = "free" + currency = "USD" + externally_managed = false + is_contract = false + public_name = "Business Plan" + scope = "zone" + sets = ["string"] + } +} +``` ## Schema diff --git a/docs/resources/account_token.md b/docs/resources/account_token.md index 0344b8e1c3..3a9d9a94ba 100644 --- a/docs/resources/account_token.md +++ b/docs/resources/account_token.md @@ -9,6 +9,45 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_account_token" "example_account_token" { + account_id = "eb78d65290b24279ba6f44721b3ea3c4" + name = "readonly token" + policies = [{ + id = "f267e341f3dd4697bd3b9f71dd96247f" + effect = "allow" + permission_groups = [{ + id = "c8fed203ed3043cba015a93ad1616f1f" + meta = { + key = "key" + value = "value" + } + name = "Zone Read" + }, { + id = "82e64a83756745bbbb1c9c2701bf816b" + meta = { + key = "key" + value = "value" + } + name = "Magic Network Monitoring" + }] + resources = { + resource = "resource" + scope = "scope" + } + }] + condition = { + request_ip = { + in = ["123.123.123.0/24", "2606:4700::/32"] + not_in = ["123.123.123.100/24", "2606:4700:4700::/48"] + } + } + expires_on = "2020-01-01T00:00:00Z" + not_before = "2018-07-01T05:20:00Z" +} +``` ## Schema @@ -94,4 +133,10 @@ Optional: - `in` (List of String) List of IPv4/IPv6 CIDR addresses. - `not_in` (List of String) List of IPv4/IPv6 CIDR addresses. +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_account_token.example '/' +``` diff --git a/docs/resources/address_map.md b/docs/resources/address_map.md index f1403b8412..67e2d75a97 100644 --- a/docs/resources/address_map.md +++ b/docs/resources/address_map.md @@ -12,27 +12,20 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_address_map" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - description = "My address map" - default_sni = "*.example.com" - enabled = true - - ips = [{ ip = "192.0.2.1" }, - { - ip = "203.0.113.1" - }] - +resource "cloudflare_address_map" "example_address_map" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + description = "My Ecommerce zones" + enabled = true + ips = ["192.0.2.1"] memberships = [{ - identifier = "92f17202ed8bd63d69a66b86a49a8f6b" - kind = "account" - }, - { - identifier = "023e105f4ecef8ad9ca31a8372d0c353" - kind = "zone" + can_delete = true + created_at = "2014-01-01T05:20:00.12345Z" + identifier = "023e105f4ecef8ad9ca31a8372d0c353" + kind = "zone" }] } ``` + ## Schema @@ -74,5 +67,5 @@ Read-Only: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_address_map.example / +$ terraform import cloudflare_address_map.example '/' ``` diff --git a/docs/resources/api_shield.md b/docs/resources/api_shield.md index 8707805499..e364c374f1 100644 --- a/docs/resources/api_shield.md +++ b/docs/resources/api_shield.md @@ -12,14 +12,15 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_api_shield" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" +resource "cloudflare_api_shield" "example_api_shield" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" auth_id_characteristics = [{ - name = "my-example-header" + name = "authorization" type = "header" }] } ``` + ## Schema @@ -61,4 +62,10 @@ Read-Only: - `code` (Number) - `message` (String) +## Import + +Import is supported using the following syntax: +```shell +$ terraform import cloudflare_api_shield.example '' +``` diff --git a/docs/resources/api_shield_operation.md b/docs/resources/api_shield_operation.md index 14cb3a00c0..f73593b69c 100644 --- a/docs/resources/api_shield_operation.md +++ b/docs/resources/api_shield_operation.md @@ -12,13 +12,13 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_api_shield_operation" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - method = "GET" - host = "api.example.com" - endpoint = "/path" +resource "cloudflare_api_shield_operation" "example_api_shield_operation" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + operation_id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" + state = "review" } ``` + ## Schema diff --git a/docs/resources/api_shield_operation_schema_validation_settings.md b/docs/resources/api_shield_operation_schema_validation_settings.md index 17dbb5c976..ed837eba06 100644 --- a/docs/resources/api_shield_operation_schema_validation_settings.md +++ b/docs/resources/api_shield_operation_schema_validation_settings.md @@ -12,19 +12,13 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_api_shield_operation" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - method = "GET" - host = "api.example.com" - endpoint = "/path" -} - -resource "cloudflare_api_shield_operation_schema_validation_settings" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - operation_id = cloudflare_api_shield_operation.example.id - mitigation_action = "block" +resource "cloudflare_api_shield_operation_schema_validation_settings" "example_api_shield_operation_schema_validation_settings" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + operation_id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" + mitigation_action = "log" } ``` + ## Schema @@ -46,4 +40,10 @@ resource "cloudflare_api_shield_operation_schema_validation_settings" "example" - `id` (String) UUID +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_api_shield_operation_schema_validation_settings.example '/' +``` diff --git a/docs/resources/api_shield_schema.md b/docs/resources/api_shield_schema.md index b1a1e79f5c..afd6a5c9fd 100644 --- a/docs/resources/api_shield_schema.md +++ b/docs/resources/api_shield_schema.md @@ -12,14 +12,15 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_api_shield_schema" "petstore_schema" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "myschema" - kind = "openapi_v3" # optional - validation_enabled = true # optional, default false - source = file("./schemas/petstore.json") +resource "cloudflare_api_shield_schema" "example_api_shield_schema" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + file = "file.txt" + kind = "openapi_v3" + name = "petstore schema" + validation_enabled = "true" } ``` + ## Schema diff --git a/docs/resources/api_shield_schema_validation_settings.md b/docs/resources/api_shield_schema_validation_settings.md index 08664ed903..b04382963e 100644 --- a/docs/resources/api_shield_schema_validation_settings.md +++ b/docs/resources/api_shield_schema_validation_settings.md @@ -12,12 +12,13 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_api_shield_schema_validation_settings" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - validation_default_mitigation_action = "log" +resource "cloudflare_api_shield_schema_validation_settings" "example_api_shield_schema_validation_settings" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + validation_default_mitigation_action = "none" validation_override_mitigation_action = "none" } ``` + ## Schema @@ -46,4 +47,10 @@ To clear any override, use the special value `disable_override` or `null` - `id` (String) Identifier +## Import + +Import is supported using the following syntax: +```shell +$ terraform import cloudflare_api_shield_schema_validation_settings.example '' +``` diff --git a/docs/resources/api_token.md b/docs/resources/api_token.md index 7b1f6a1f7a..ebe2dbbb5f 100644 --- a/docs/resources/api_token.md +++ b/docs/resources/api_token.md @@ -12,127 +12,42 @@ description: |- ## Example Usage ```terraform -# User permissions -data "cloudflare_api_token_permission_groups" "all" {} - -# Token allowed to create new tokens. -# Can only be used from specific ip range. -resource "cloudflare_api_token" "api_token_create" { - name = "api_token_create" - - policy = [{ - permission_groups = [ - data.cloudflare_api_token_permission_groups.all.user["API Tokens Write"], - ] - resources = { - "com.cloudflare.api.user.${var.user_id}" = "*" - } - }] - - not_before = "2018-07-01T05:20:00Z" - expires_on = "2020-01-01T00:00:00Z" - - condition = { - request_ip = [{ - in = ["192.0.2.1/32"] - not_in = ["198.51.100.1/32"] +resource "cloudflare_api_token" "example_api_token" { + name = "readonly token" + policies = [{ + id = "f267e341f3dd4697bd3b9f71dd96247f" + effect = "allow" + permission_groups = [{ + id = "c8fed203ed3043cba015a93ad1616f1f" + meta = { + key = "key" + value = "value" + } + name = "Zone Read" + }, { + id = "82e64a83756745bbbb1c9c2701bf816b" + meta = { + key = "key" + value = "value" + } + name = "Magic Network Monitoring" }] - } -} - -# Account permissions -data "cloudflare_api_token_permission_groups" "all" {} - -# Token allowed to read audit logs from all accounts. -resource "cloudflare_api_token" "logs_account_all" { - name = "logs_account_all" - - policy = [{ - permission_groups = [ - data.cloudflare_api_token_permission_groups.all.account["Access: Audit Logs Read"], - ] - resources = { - "com.cloudflare.api.account.*" = "*" - } - }] -} - -# Token allowed to read audit logs from specific account. -resource "cloudflare_api_token" "logs_account" { - name = "logs_account" - - policy = [{ - permission_groups = [ - data.cloudflare_api_token_permission_groups.all.account["Access: Audit Logs Read"], - ] resources = { - "com.cloudflare.api.account.${var.account_id}" = "*" + resource = "resource" + scope = "scope" } }] -} - -# Zone permissions -data "cloudflare_api_token_permission_groups" "all" {} - -# Token allowed to edit DNS entries and TLS certs for specific zone. -resource "cloudflare_api_token" "dns_tls_edit" { - name = "dns_tls_edit" - - policy = [{ - permission_groups = [ - data.cloudflare_api_token_permission_groups.all.zone["DNS Write"], - data.cloudflare_api_token_permission_groups.all.zone["SSL and Certificates Write"], - ] - resources = { - "com.cloudflare.api.account.zone.${var.zone_id}" = "*" - } - }] -} - -# Token allowed to edit DNS entries for all zones except one. -resource "cloudflare_api_token" "dns_tls_edit_all_except_one" { - name = "dns_tls_edit_all_except_one" - - # include all zones - policy = [{ - permission_groups = [ - data.cloudflare_api_token_permission_groups.all.zone["DNS Write"], - ] - resources = { - "com.cloudflare.api.account.zone.*" = "*" - } - }, - { - permission_groups = [ - data.cloudflare_api_token_permission_groups.all.zone["DNS Write"], - ] - resources = { - "com.cloudflare.api.account.zone.${var.zone_id}" = "*" - } - effect = "deny" - }] - - # exclude (deny) specific zone -} - - -# Token allowed to edit DNS entries for all zones from specific account. -resource "cloudflare_api_token" "dns_edit_all_account" { - name = "dns_edit_all_account" - - # include all zones from specific account - policy = [{ - permission_groups = [ - data.cloudflare_api_token_permission_groups.all.zone["DNS Write"], - ] - resources = { - "com.cloudflare.api.account.${var.account_id}" = jsonencode({ - "com.cloudflare.api.account.zone.*" = "*" - }) + condition = { + request_ip = { + in = ["123.123.123.0/24", "2606:4700::/32"] + not_in = ["123.123.123.100/24", "2606:4700:4700::/48"] } - }] + } + expires_on = "2020-01-01T00:00:00Z" + not_before = "2018-07-01T05:20:00Z" } ``` + ## Schema @@ -210,4 +125,10 @@ Optional: - `in` (List of String) List of IPv4/IPv6 CIDR addresses. - `not_in` (List of String) List of IPv4/IPv6 CIDR addresses. +## Import + +Import is supported using the following syntax: +```shell +$ terraform import cloudflare_api_token.example '' +``` diff --git a/docs/resources/argo_smart_routing.md b/docs/resources/argo_smart_routing.md index d369797e65..f422e3b439 100644 --- a/docs/resources/argo_smart_routing.md +++ b/docs/resources/argo_smart_routing.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_argo_smart_routing" "example_argo_smart_routing" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + value = "on" +} +``` ## Schema @@ -22,4 +30,10 @@ description: |- - `id` (String) Identifier +## Import + +Import is supported using the following syntax: +```shell +$ terraform import cloudflare_argo_smart_routing.example '' +``` diff --git a/docs/resources/argo_tiered_caching.md b/docs/resources/argo_tiered_caching.md index 16a5dbff14..9c00953b8e 100644 --- a/docs/resources/argo_tiered_caching.md +++ b/docs/resources/argo_tiered_caching.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_argo_tiered_caching" "example_argo_tiered_caching" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + value = "on" +} +``` ## Schema @@ -24,4 +32,10 @@ description: |- - `id` (String) Identifier - `modified_on` (String) The time when the setting was last modified +## Import + +Import is supported using the following syntax: +```shell +$ terraform import cloudflare_argo_tiered_caching.example '' +``` diff --git a/docs/resources/authenticated_origin_pulls.md b/docs/resources/authenticated_origin_pulls.md index 04cdf05ab2..5da62994cc 100644 --- a/docs/resources/authenticated_origin_pulls.md +++ b/docs/resources/authenticated_origin_pulls.md @@ -12,41 +12,16 @@ description: |- ## Example Usage ```terraform -# Authenticated Origin Pulls -resource "cloudflare_authenticated_origin_pulls" "my_aop" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - enabled = true -} - -# Per-Zone Authenticated Origin Pulls -resource "cloudflare_authenticated_origin_pulls_certificate" "my_per_zone_aop_cert" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - certificate = "-----INSERT CERTIFICATE-----" - private_key = "-----INSERT PRIVATE KEY-----" - type = "per-zone" -} - -resource "cloudflare_authenticated_origin_pulls" "my_per_zone_aop" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - authenticated_origin_pulls_certificate = cloudflare_authenticated_origin_pulls_certificate.my_per_zone_aop_cert.id - enabled = true -} - -# Per-Hostname Authenticated Origin Pulls -resource "cloudflare_authenticated_origin_pulls_certificate" "my_per_hostname_aop_cert" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - certificate = "-----INSERT CERTIFICATE-----" - private_key = "-----INSERT PRIVATE KEY-----" - type = "per-hostname" -} - -resource "cloudflare_authenticated_origin_pulls" "my_per_hostname_aop" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - authenticated_origin_pulls_certificate = cloudflare_authenticated_origin_pulls_certificate.my_per_hostname_aop_cert.id - hostname = "aop.example.com" - enabled = true +resource "cloudflare_authenticated_origin_pulls" "example_authenticated_origin_pulls" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + config = [{ + cert_id = "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60" + enabled = true + hostname = "app.example.com" + }] } ``` + ## Schema @@ -84,17 +59,4 @@ Optional: - `enabled` (Boolean) Indicates whether hostname-level authenticated origin pulls is enabled. A null value voids the association. - `hostname` (String) The hostname on the origin for which the client certificate uploaded will be used. -## Import - -Import is supported using the following syntax: -```shell -# global -$ terraform import cloudflare_authenticated_origin_pulls.example - -# per zone -$ terraform import cloudflare_authenticated_origin_pulls.example / - -# per hostname -$ terraform import cloudflare_authenticated_origin_pulls.example // -``` diff --git a/docs/resources/authenticated_origin_pulls_certificate.md b/docs/resources/authenticated_origin_pulls_certificate.md index ce7f6afa7b..944deafc16 100644 --- a/docs/resources/authenticated_origin_pulls_certificate.md +++ b/docs/resources/authenticated_origin_pulls_certificate.md @@ -12,22 +12,66 @@ description: |- ## Example Usage ```terraform -# Per-Zone Authenticated Origin Pulls certificate -resource "cloudflare_authenticated_origin_pulls_certificate" "my_per_zone_aop_cert" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - certificate = "-----INSERT CERTIFICATE-----" - private_key = "-----INSERT PRIVATE KEY-----" - type = "per-zone" -} +resource "cloudflare_authenticated_origin_pulls_certificate" "example_authenticated_origin_pulls_certificate" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + certificate = < ## Schema @@ -51,5 +95,5 @@ resource "cloudflare_authenticated_origin_pulls_certificate" "my_per_hostname_ao Import is supported using the following syntax: ```shell -$ terraform import cloudflare_authenticated_origin_pulls_certificate.example // +$ terraform import cloudflare_authenticated_origin_pulls_certificate.example '/' ``` diff --git a/docs/resources/bot_management.md b/docs/resources/bot_management.md index 599c252b3e..31ad9433d3 100644 --- a/docs/resources/bot_management.md +++ b/docs/resources/bot_management.md @@ -12,16 +12,14 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_bot_management" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - enable_js = true - sbfm_definitely_automated = "block" - sbfm_likely_automated = "managed_challenge" - sbfm_verified_bots = "allow" - sbfm_static_resource_protection = false - optimize_wordpress = true +resource "cloudflare_bot_management" "example_bot_management" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + ai_bots_protection = "block" + enable_js = true + fight_mode = true } ``` + ## Schema @@ -68,5 +66,5 @@ Read-Only: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_bot_management.example +$ terraform import cloudflare_bot_management.example '' ``` diff --git a/docs/resources/byo_ip_prefix.md b/docs/resources/byo_ip_prefix.md index c2cbe3c91c..2ba76cc1de 100644 --- a/docs/resources/byo_ip_prefix.md +++ b/docs/resources/byo_ip_prefix.md @@ -12,13 +12,14 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_byo_ip_prefix" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - prefix_id = "d41d8cd98f00b204e9800998ecf8427e" - description = "Example IP Prefix" - advertisement = "on" +resource "cloudflare_byo_ip_prefix" "example_byo_ip_prefix" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + asn = 209242 + cidr = "192.0.2.0/24" + loa_document_id = "d933b1530bc56c9953cf8ce166da8004" } ``` + ## Schema @@ -49,5 +50,5 @@ resource "cloudflare_byo_ip_prefix" "example" { Import is supported using the following syntax: ```shell -$ terraform import cloudflare_byo_ip_prefix.example / +$ terraform import cloudflare_byo_ip_prefix.example '/' ``` diff --git a/docs/resources/calls_sfu_app.md b/docs/resources/calls_sfu_app.md index 03b2478e0c..ba07b2f65f 100644 --- a/docs/resources/calls_sfu_app.md +++ b/docs/resources/calls_sfu_app.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_calls_sfu_app" "example_calls_sfu_app" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + name = "production-realtime-app" +} +``` ## Schema diff --git a/docs/resources/calls_turn_app.md b/docs/resources/calls_turn_app.md index 5b15dbb6dd..b5d407c72e 100644 --- a/docs/resources/calls_turn_app.md +++ b/docs/resources/calls_turn_app.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_calls_turn_app" "example_calls_turn_app" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + name = "my-turn-key" +} +``` ## Schema diff --git a/docs/resources/certificate_pack.md b/docs/resources/certificate_pack.md index 69cbf08786..44a97425e6 100644 --- a/docs/resources/certificate_pack.md +++ b/docs/resources/certificate_pack.md @@ -21,27 +21,14 @@ you've confirmed the certificate is available. ## Example Usage ```terraform -# Advanced certificate manager for DigiCert -resource "cloudflare_certificate_pack" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - type = "advanced" - hosts = ["example.com", "sub.example.com"] - validation_method = "txt" - validity_days = 30 - certificate_authority = "digicert" - cloudflare_branding = false -} - -# Advanced certificate manager for Let's Encrypt -resource "cloudflare_certificate_pack" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - type = "advanced" - hosts = ["example.com", "*.example.com"] - validation_method = "http" - validity_days = 90 - certificate_authority = "lets_encrypt" - cloudflare_branding = false - wait_for_active_status = true +resource "cloudflare_certificate_pack" "example_certificate_pack" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + certificate_authority = "google" + hosts = ["example.com", "*.example.com", "www.example.com"] + type = "advanced" + validation_method = "txt" + validity_days = 14 + cloudflare_branding = false } ``` @@ -58,7 +45,7 @@ resource "cloudflare_certificate_pack" "example" { ### Optional -- `cloudflare_branding` (Boolean) Whether or not to add Cloudflare Branding for the order. This will add sni.cloudflaressl.com as the Common Name if set true. +- `cloudflare_branding` (Boolean) Whether or not to add Cloudflare Branding for the order. This will add a subdomain of sni.cloudflaressl.com as the Common Name if set to true. ### Read-Only @@ -70,7 +57,7 @@ resource "cloudflare_certificate_pack" "example" { Import is supported using the following syntax: ```shell -$ terraform import cloudflare_certificate_pack.example / +$ terraform import cloudflare_certificate_pack.example '/' ``` While supported, importing isn't recommended and it is advised to replace the diff --git a/docs/resources/cloudforce_one_request.md b/docs/resources/cloudforce_one_request.md index f250a619e1..76dbaebefa 100644 --- a/docs/resources/cloudforce_one_request.md +++ b/docs/resources/cloudforce_one_request.md @@ -9,6 +9,18 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_cloudforce_one_request" "example_cloudforce_one_request" { + account_identifier = "023e105f4ecef8ad9ca31a8372d0c353" + content = "What regions were most effected by the recent DoS?" + priority = "routine" + request_type = "Victomology" + summary = "DoS attack" + tlp = "clear" +} +``` ## Schema @@ -37,4 +49,10 @@ description: |- - `tokens` (Number) Tokens for the request - `updated` (String) +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_cloudforce_one_request.example '/' +``` diff --git a/docs/resources/cloudforce_one_request_asset.md b/docs/resources/cloudforce_one_request_asset.md index ad31d308a9..6b0133f8a0 100644 --- a/docs/resources/cloudforce_one_request_asset.md +++ b/docs/resources/cloudforce_one_request_asset.md @@ -9,6 +9,16 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_cloudforce_one_request_asset" "example_cloudforce_one_request_asset" { + account_identifier = "023e105f4ecef8ad9ca31a8372d0c353" + request_identifier = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" + page = 0 + per_page = 10 +} +``` ## Schema diff --git a/docs/resources/cloudforce_one_request_message.md b/docs/resources/cloudforce_one_request_message.md index 9415904e29..e2cd080b09 100644 --- a/docs/resources/cloudforce_one_request_message.md +++ b/docs/resources/cloudforce_one_request_message.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_cloudforce_one_request_message" "example_cloudforce_one_request_message" { + account_identifier = "023e105f4ecef8ad9ca31a8372d0c353" + request_identifier = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" + content = "Can you elaborate on the type of DoS that occurred?" +} +``` ## Schema @@ -30,4 +39,10 @@ description: |- - `is_follow_on_request` (Boolean) Whether the message is a follow-on request - `updated` (String) Message last updated time +## Import + +Import is supported using the following syntax: +```shell +$ terraform import cloudflare_cloudforce_one_request_message.example '/' +``` diff --git a/docs/resources/cloudforce_one_request_priority.md b/docs/resources/cloudforce_one_request_priority.md index 95a49a9989..9276121445 100644 --- a/docs/resources/cloudforce_one_request_priority.md +++ b/docs/resources/cloudforce_one_request_priority.md @@ -9,6 +9,17 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_cloudforce_one_request_priority" "example_cloudforce_one_request_priority" { + account_identifier = "023e105f4ecef8ad9ca31a8372d0c353" + labels = ["DoS", "CVE"] + priority = 1 + requirement = "DoS attacks carried out by CVEs" + tlp = "clear" +} +``` ## Schema @@ -35,4 +46,10 @@ description: |- - `tokens` (Number) Tokens for the request - `updated` (String) +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_cloudforce_one_request_priority.example '/' +``` diff --git a/docs/resources/custom_hostname.md b/docs/resources/custom_hostname.md index 6e49f5bb9a..4de28ff4e1 100644 --- a/docs/resources/custom_hostname.md +++ b/docs/resources/custom_hostname.md @@ -12,14 +12,61 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_custom_hostname" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - hostname = "hostname.example.com" +resource "cloudflare_custom_hostname" "example_custom_hostname" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + hostname = "app.example.com" ssl = { - method = "txt" + bundle_method = "ubiquitous" + certificate_authority = "digicert" + cloudflare_branding = false + custom_certificate = "-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n" + custom_key = < ## Schema @@ -51,6 +98,7 @@ Optional: - `bundle_method` (String) 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. - `certificate_authority` (String) The Certificate Authority that will issue the certificate +- `cloudflare_branding` (Boolean) Whether or not to add Cloudflare Branding for the order. This will add a subdomain of sni.cloudflaressl.com as the Common Name if set to true - `custom_certificate` (String) If a custom uploaded certificate is used. - `custom_key` (String) The key for a custom uploaded certificate. - `method` (String) Domain control validation (DCV) method used for this hostname. @@ -94,5 +142,5 @@ Read-Only: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_custom_hostname.example 1d5fdc9e88c8a8c4518b068cd94331fe/0d89c70dcloudflare_access_service_tokenad9fcloudflare_access_service_token4843cloudflare_access_service_tokenb99fcloudflare_access_service_token6cc0252067e9 +$ terraform import cloudflare_custom_hostname.example '/' ``` diff --git a/docs/resources/custom_hostname_fallback_origin.md b/docs/resources/custom_hostname_fallback_origin.md index da7f97ac0d..73dde4b1cc 100644 --- a/docs/resources/custom_hostname_fallback_origin.md +++ b/docs/resources/custom_hostname_fallback_origin.md @@ -12,11 +12,12 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_custom_hostname_fallback_origin" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - origin = "fallback.example.com" +resource "cloudflare_custom_hostname_fallback_origin" "example_custom_hostname_fallback_origin" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + origin = "fallback.example.com" } ``` + ## Schema @@ -38,5 +39,5 @@ resource "cloudflare_custom_hostname_fallback_origin" "example" { Import is supported using the following syntax: ```shell -$ terraform import cloudflare_custom_hostname_fallback_origin.example / +$ terraform import cloudflare_custom_hostname_fallback_origin.example '' ``` diff --git a/docs/resources/custom_ssl.md b/docs/resources/custom_ssl.md index 9b80d2024f..cd5c1305e7 100644 --- a/docs/resources/custom_ssl.md +++ b/docs/resources/custom_ssl.md @@ -12,17 +12,72 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_custom_ssl" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - custom_ssl_options = [{ - certificate = "-----INSERT CERTIFICATE-----" - private_key = "-----INSERT PRIVATE KEY-----" - bundle_method = "ubiquitous" - geo_restrictions = "us" - type = "legacy_custom" - }] +resource "cloudflare_custom_ssl" "example_custom_ssl" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + certificate = < ## Schema @@ -89,5 +144,5 @@ Read-Only: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_custom_ssl.example / +$ terraform import cloudflare_custom_ssl.example '/' ``` diff --git a/docs/resources/d1_database.md b/docs/resources/d1_database.md index b9b833485c..a8d826a37f 100644 --- a/docs/resources/d1_database.md +++ b/docs/resources/d1_database.md @@ -16,9 +16,10 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_d1_database" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "terraform-database" +resource "cloudflare_d1_database" "example_d1_database" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + name = "my-database" + primary_location_hint = "wnam" } ``` @@ -48,5 +49,5 @@ resource "cloudflare_d1_database" "example" { Import is supported using the following syntax: ```shell -$ terraform import cloudflare_d1_database.example / +$ terraform import cloudflare_d1_database.example '/' ``` diff --git a/docs/resources/dns_firewall.md b/docs/resources/dns_firewall.md index 4a70dd74b9..9200b482f2 100644 --- a/docs/resources/dns_firewall.md +++ b/docs/resources/dns_firewall.md @@ -9,6 +9,26 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_dns_firewall" "example_dns_firewall" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + name = "My Awesome DNS Firewall cluster" + upstream_ips = ["192.0.2.1", "198.51.100.1", "string"] + attack_mitigation = { + enabled = true + only_when_upstream_unhealthy = false + } + deprecate_any_requests = true + ecs_fallback = false + maximum_cache_ttl = 900 + minimum_cache_ttl = 60 + negative_cache_ttl = 900 + ratelimit = 600 + retries = 2 +} +``` ## Schema @@ -44,4 +64,10 @@ Optional: - `enabled` (Boolean) When enabled, automatically mitigate random-prefix attacks to protect upstream DNS servers - `only_when_upstream_unhealthy` (Boolean) Only mitigate attacks when upstream servers seem unhealthy +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_dns_firewall.example '/' +``` diff --git a/docs/resources/dns_record.md b/docs/resources/dns_record.md index 36d2c0ecea..492a1d9285 100644 --- a/docs/resources/dns_record.md +++ b/docs/resources/dns_record.md @@ -12,14 +12,13 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_dns_record" "example" { - zone_id = var.cloudflare_zone_id - name = "terraform" - value = "192.0.2.1" - type = "A" - ttl = 3600 +resource "cloudflare_dns_record" "example_dns_record" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + content = "198.51.100.4" + type = "A" } ``` + ## Schema @@ -100,10 +99,4 @@ Optional: - `flatten_cname` (Boolean) If enabled, causes the CNAME record to be resolved externally and the resulting address records (e.g., A and AAAA) to be returned instead of the CNAME record itself. This setting has no effect on proxied records, which are always flattened. -## Import - -Import is supported using the following syntax: -```shell -$ terraform import cloudflare_dns_record.example / -``` diff --git a/docs/resources/secondary_dns_acl.md b/docs/resources/dns_zone_transfers_acl.md similarity index 54% rename from docs/resources/secondary_dns_acl.md rename to docs/resources/dns_zone_transfers_acl.md index 755f2df11c..3afa77fda2 100644 --- a/docs/resources/secondary_dns_acl.md +++ b/docs/resources/dns_zone_transfers_acl.md @@ -1,14 +1,23 @@ --- -page_title: "cloudflare_secondary_dns_acl Resource - Cloudflare" +page_title: "cloudflare_dns_zone_transfers_acl Resource - Cloudflare" subcategory: "" description: |- --- -# cloudflare_secondary_dns_acl (Resource) +# cloudflare_dns_zone_transfers_acl (Resource) +## Example Usage + +```terraform +resource "cloudflare_dns_zone_transfers_acl" "example_dns_zone_transfers_acl" { + account_id = "01a7362d577a6c3019a474fd6f485823" + ip_range = "192.0.2.53/28" + name = "my-acl-1" +} +``` ## Schema @@ -23,4 +32,10 @@ description: |- - `id` (String) The ID of this resource. +## Import + +Import is supported using the following syntax: +```shell +$ terraform import cloudflare_dns_zone_transfers_acl.example '/' +``` diff --git a/docs/data-sources/secondary_dns_incoming.md b/docs/resources/dns_zone_transfers_incoming.md similarity index 52% rename from docs/data-sources/secondary_dns_incoming.md rename to docs/resources/dns_zone_transfers_incoming.md index 3d87a88751..23613dc1db 100644 --- a/docs/data-sources/secondary_dns_incoming.md +++ b/docs/resources/dns_zone_transfers_incoming.md @@ -1,32 +1,48 @@ --- -page_title: "cloudflare_secondary_dns_incoming Data Source - Cloudflare" +page_title: "cloudflare_dns_zone_transfers_incoming Resource - Cloudflare" subcategory: "" description: |- --- -# cloudflare_secondary_dns_incoming (Data Source) +# cloudflare_dns_zone_transfers_incoming (Resource) +## Example Usage + +```terraform +resource "cloudflare_dns_zone_transfers_incoming" "example_dns_zone_transfers_incoming" { + zone_id = "269d8f4853475ca241c4e730be286b20" + auto_refresh_seconds = 86400 + name = "www.example.com." + peers = ["23ff594956f20c2a721606e94745a8aa", "00920f38ce07c2e2f4df50b1f61d4194"] +} +``` ## Schema ### Required +- `auto_refresh_seconds` (Number) How often should a secondary zone auto refresh regardless of DNS NOTIFY. +Not applicable for primary zones. +- `name` (String) Zone name. +- `peers` (List of String) A list of peer tags. - `zone_id` (String) ### Read-Only -- `auto_refresh_seconds` (Number) How often should a secondary zone auto refresh regardless of DNS NOTIFY. -Not applicable for primary zones. - `checked_time` (String) The time for a specific event. - `created_time` (String) The time for a specific event. - `id` (String) The ID of this resource. - `modified_time` (String) The time for a specific event. -- `name` (String) Zone name. -- `peers` (List of String) A list of peer tags. - `soa_serial` (Number) The serial number of the SOA for the given zone. +## Import + +Import is supported using the following syntax: +```shell +$ terraform import cloudflare_dns_zone_transfers_incoming.example '' +``` diff --git a/docs/resources/dns_zone_transfers_outgoing.md b/docs/resources/dns_zone_transfers_outgoing.md new file mode 100644 index 0000000000..f5af264b93 --- /dev/null +++ b/docs/resources/dns_zone_transfers_outgoing.md @@ -0,0 +1,45 @@ +--- +page_title: "cloudflare_dns_zone_transfers_outgoing Resource - Cloudflare" +subcategory: "" +description: |- + +--- + +# cloudflare_dns_zone_transfers_outgoing (Resource) + + + +## Example Usage + +```terraform +resource "cloudflare_dns_zone_transfers_outgoing" "example_dns_zone_transfers_outgoing" { + zone_id = "269d8f4853475ca241c4e730be286b20" + name = "www.example.com." + peers = ["23ff594956f20c2a721606e94745a8aa", "00920f38ce07c2e2f4df50b1f61d4194"] +} +``` + + +## Schema + +### Required + +- `name` (String) Zone name. +- `peers` (List of String) A list of peer tags. +- `zone_id` (String) + +### Read-Only + +- `checked_time` (String) The time for a specific event. +- `created_time` (String) The time for a specific event. +- `id` (String) The ID of this resource. +- `last_transferred_time` (String) The time for a specific event. +- `soa_serial` (Number) The serial number of the SOA for the given zone. + +## Import + +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_dns_zone_transfers_outgoing.example '' +``` diff --git a/docs/resources/secondary_dns_peer.md b/docs/resources/dns_zone_transfers_peer.md similarity index 65% rename from docs/resources/secondary_dns_peer.md rename to docs/resources/dns_zone_transfers_peer.md index 7aff3f373b..fbcca10d05 100644 --- a/docs/resources/secondary_dns_peer.md +++ b/docs/resources/dns_zone_transfers_peer.md @@ -1,14 +1,22 @@ --- -page_title: "cloudflare_secondary_dns_peer Resource - Cloudflare" +page_title: "cloudflare_dns_zone_transfers_peer Resource - Cloudflare" subcategory: "" description: |- --- -# cloudflare_secondary_dns_peer (Resource) +# cloudflare_dns_zone_transfers_peer (Resource) +## Example Usage + +```terraform +resource "cloudflare_dns_zone_transfers_peer" "example_dns_zone_transfers_peer" { + account_id = "01a7362d577a6c3019a474fd6f485823" + name = "my-peer-1" +} +``` ## Schema @@ -29,4 +37,10 @@ description: |- - `id` (String) The ID of this resource. +## Import + +Import is supported using the following syntax: +```shell +$ terraform import cloudflare_dns_zone_transfers_peer.example '/' +``` diff --git a/docs/resources/dns_zone_transfers_tsig.md b/docs/resources/dns_zone_transfers_tsig.md new file mode 100644 index 0000000000..720d594016 --- /dev/null +++ b/docs/resources/dns_zone_transfers_tsig.md @@ -0,0 +1,43 @@ +--- +page_title: "cloudflare_dns_zone_transfers_tsig Resource - Cloudflare" +subcategory: "" +description: |- + +--- + +# cloudflare_dns_zone_transfers_tsig (Resource) + + + +## Example Usage + +```terraform +resource "cloudflare_dns_zone_transfers_tsig" "example_dns_zone_transfers_tsig" { + account_id = "01a7362d577a6c3019a474fd6f485823" + algo = "hmac-sha512." + name = "tsig.customer.cf." + secret = "caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c" +} +``` + + +## Schema + +### Required + +- `account_id` (String) +- `algo` (String) TSIG algorithm. +- `name` (String) TSIG key name. +- `secret` (String) TSIG secret. + +### Read-Only + +- `id` (String) The ID of this resource. + +## Import + +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_dns_zone_transfers_tsig.example '/' +``` diff --git a/docs/resources/email_routing_address.md b/docs/resources/email_routing_address.md index 6c8e70a348..ece35ae4f8 100644 --- a/docs/resources/email_routing_address.md +++ b/docs/resources/email_routing_address.md @@ -12,11 +12,12 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_email_routing_address" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - email = "user@example.com" +resource "cloudflare_email_routing_address" "example_email_routing_address" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + email = "user@example.com" } ``` + ## Schema @@ -38,5 +39,5 @@ resource "cloudflare_email_routing_address" "example" { Import is supported using the following syntax: ```shell -$ terraform import cloudflare_email_routing_address.example / +$ terraform import cloudflare_email_routing_address.example '/' ``` diff --git a/docs/resources/email_routing_catch_all.md b/docs/resources/email_routing_catch_all.md index 489303589f..f0b210d4fc 100644 --- a/docs/resources/email_routing_catch_all.md +++ b/docs/resources/email_routing_catch_all.md @@ -12,21 +12,20 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_email_routing_catch_all" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "example catch all" - enabled = true - - matcher = [{ - type = "all" - }] - - action = [{ - type = "forward" +resource "cloudflare_email_routing_catch_all" "example_email_routing_catch_all" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + actions = [{ + type = "drop" value = ["destinationaddress@example.net"] }] + matchers = [{ + type = "all" + }] + enabled = true + name = "Send to user@example.net rule." } ``` + ## Schema @@ -65,4 +64,10 @@ Required: - `type` (String) Type of matcher. Default is 'all'. +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_email_routing_catch_all.example '' +``` diff --git a/docs/resources/email_routing_dns.md b/docs/resources/email_routing_dns.md index e7a8cf3f05..ef32389065 100644 --- a/docs/resources/email_routing_dns.md +++ b/docs/resources/email_routing_dns.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_email_routing_dns" "example_email_routing_dns" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + name = "example.net" +} +``` ## Schema @@ -108,4 +116,10 @@ Read-Only: - `per_page` (Number) Number of results per page of results - `total_count` (Number) Total results available without any search parameters +## Import + +Import is supported using the following syntax: +```shell +$ terraform import cloudflare_email_routing_dns.example '' +``` diff --git a/docs/resources/email_routing_rule.md b/docs/resources/email_routing_rule.md index 7d515d0b01..3086d24d77 100644 --- a/docs/resources/email_routing_rule.md +++ b/docs/resources/email_routing_rule.md @@ -12,23 +12,23 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_email_routing_rule" "main" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "terraform rule" - enabled = true - - matcher = [{ - type = "literal" +resource "cloudflare_email_routing_rule" "example_email_routing_rule" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + actions = [{ + type = "drop" + value = ["destinationaddress@example.net"] + }] + matchers = [{ field = "to" + type = "literal" value = "test@example.com" }] - - action = [{ - type = "forward" - value = ["destinationaddress@example.net"] - }] + enabled = true + name = "Send to user@example.net rule." + priority = 0 } ``` + ## Schema @@ -72,5 +72,5 @@ Required: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_email_routing_rule.example / +$ terraform import cloudflare_email_routing_rule.example '/' ``` diff --git a/docs/resources/email_routing_settings.md b/docs/resources/email_routing_settings.md index 9c43f2cdc7..43be2d4b56 100644 --- a/docs/resources/email_routing_settings.md +++ b/docs/resources/email_routing_settings.md @@ -12,11 +12,11 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_email_routing_settings" "my_zone" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - enabled = "true" +resource "cloudflare_email_routing_settings" "example_email_routing_settings" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" } ``` + ## Schema @@ -35,4 +35,10 @@ resource "cloudflare_email_routing_settings" "my_zone" { - `status` (String) Show the state of your account, and the type or configuration error. - `tag` (String) Email Routing settings tag. (Deprecated, replaced by Email Routing settings identifier) +## Import + +Import is supported using the following syntax: +```shell +$ terraform import cloudflare_email_routing_settings.example '' +``` diff --git a/docs/resources/email_security_block_sender.md b/docs/resources/email_security_block_sender.md index c93f655d1d..512f4859d7 100644 --- a/docs/resources/email_security_block_sender.md +++ b/docs/resources/email_security_block_sender.md @@ -9,6 +9,17 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_email_security_block_sender" "example_email_security_block_sender" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + is_regex = false + pattern = "test@example.com" + pattern_type = "EMAIL" + comments = "block sender with email test@example.com" +} +``` ## Schema @@ -44,4 +55,10 @@ Optional: - `comments` (String) +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_email_security_block_sender.example '/' +``` diff --git a/docs/resources/email_security_impersonation_registry.md b/docs/resources/email_security_impersonation_registry.md index 045c2c2654..0ee6cd9569 100644 --- a/docs/resources/email_security_impersonation_registry.md +++ b/docs/resources/email_security_impersonation_registry.md @@ -9,6 +9,16 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_email_security_impersonation_registry" "example_email_security_impersonation_registry" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + email = "email" + is_email_regex = true + name = "name" +} +``` ## Schema @@ -44,4 +54,10 @@ Required: - `is_email_regex` (Boolean) - `name` (String) +## Import + +Import is supported using the following syntax: +```shell +$ terraform import cloudflare_email_security_impersonation_registry.example '/' +``` diff --git a/docs/resources/email_security_trusted_domains.md b/docs/resources/email_security_trusted_domains.md index 50881fc7bb..7b5b9123e7 100644 --- a/docs/resources/email_security_trusted_domains.md +++ b/docs/resources/email_security_trusted_domains.md @@ -9,6 +9,18 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_email_security_trusted_domains" "example_email_security_trusted_domains" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + is_recent = true + is_regex = false + is_similarity = false + pattern = "example.com" + comments = null +} +``` ## Schema @@ -21,15 +33,18 @@ description: |- - `body` (Attributes List) (see [below for nested schema](#nestedatt--body)) - `comments` (String) -- `is_recent` (Boolean) +- `is_recent` (Boolean) Select to prevent recently registered domains from triggering a +Suspicious or Malicious disposition. - `is_regex` (Boolean) -- `is_similarity` (Boolean) +- `is_similarity` (Boolean) Select for partner or other approved domains that have similar +spelling to your connected domains. Prevents listed domains from +triggering a Spoof disposition. - `pattern` (String) ### Read-Only - `created_at` (String) -- `id` (Number) The ID of this resource. +- `id` (Number) The unique identifier for the trusted domain. - `last_modified` (String) @@ -37,13 +52,22 @@ description: |- Required: -- `is_recent` (Boolean) +- `is_recent` (Boolean) Select to prevent recently registered domains from triggering a +Suspicious or Malicious disposition. - `is_regex` (Boolean) -- `is_similarity` (Boolean) +- `is_similarity` (Boolean) Select for partner or other approved domains that have similar +spelling to your connected domains. Prevents listed domains from +triggering a Spoof disposition. - `pattern` (String) Optional: - `comments` (String) +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_email_security_trusted_domains.example '/' +``` diff --git a/docs/resources/filter.md b/docs/resources/filter.md index 9e5410e599..ba97e7d72a 100644 --- a/docs/resources/filter.md +++ b/docs/resources/filter.md @@ -19,10 +19,9 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_filter" "wordpress" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - description = "Wordpress break-in attempts that are outside of the office" - expression = "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.src ne 192.0.2.1" +resource "cloudflare_filter" "example_filter" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + expression = "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155" } ``` @@ -44,10 +43,4 @@ resource "cloudflare_filter" "wordpress" { - `paused` (Boolean) When true, indicates that the filter is currently paused. - `ref` (String) A short reference tag. Allows you to select related filters. -## Import -Import is supported using the following syntax: - -```shell -$ terraform import cloudflare_filter.example / -``` diff --git a/docs/resources/firewall_rule.md b/docs/resources/firewall_rule.md index 787e666de0..1e23524589 100644 --- a/docs/resources/firewall_rule.md +++ b/docs/resources/firewall_rule.md @@ -18,17 +18,23 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_filter" "wordpress" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - description = "Wordpress break-in attempts that are outside of the office" - expression = "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.src ne 192.0.2.1" -} - -resource "cloudflare_firewall_rule" "wordpress" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - description = "Block wordpress break-in attempts" - filter_id = cloudflare_filter.wordpress.id - action = "block" +resource "cloudflare_firewall_rule" "example_firewall_rule" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + action = { + mode = "simulate" + response = { + body = "This request has been rate-limited." + content_type = "text/xml" + } + timeout = 86400 + } + filter = { + id = "372e67954025e0ba6aaa6d586b9e0b61" + description = "Restrict access from these browsers on this address range." + expression = "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155" + paused = false + ref = "FIL-100" + } } ``` @@ -88,10 +94,4 @@ Read-Only: - `id` (String) The unique identifier of the filter. -## Import -Import is supported using the following syntax: - -```shell -$ terraform import cloudflare_firewall_rule.example / -``` diff --git a/docs/resources/healthcheck.md b/docs/resources/healthcheck.md index f85ddb2058..7925581703 100644 --- a/docs/resources/healthcheck.md +++ b/docs/resources/healthcheck.md @@ -12,60 +12,39 @@ description: |- ## Example Usage ```terraform -# HTTPS Healthcheck -resource "cloudflare_healthcheck" "http_health_check" { - zone_id = var.cloudflare_zone_id - name = "http-health-check" - description = "example http health check" - address = "example.com" - suspended = false - check_regions = [ - "WEU", - "EEU" - ] - type = "HTTPS" - port = 443 - method = "GET" - path = "/health" - expected_body = "alive" - expected_codes = [ - "2xx", - "301" - ] - follow_redirects = true - allow_insecure = false - header = [{ - header = "Host" - values = ["example.com"] - }] - timeout = 10 - retries = 2 - interval = 60 - consecutive_fails = 3 - consecutive_successes = 2 -} - -# TCP Healthcheck -resource "cloudflare_healthcheck" "tcp_health_check" { - zone_id = var.cloudflare_zone_id - name = "tcp-health-check" - description = "example tcp health check" - address = "example.com" - suspended = false - check_regions = [ - "WEU", - "EEU" - ] - type = "TCP" - port = 22 - method = "connection_established" - timeout = 10 - retries = 2 - interval = 60 - consecutive_fails = 3 - consecutive_successes = 2 +resource "cloudflare_healthcheck" "example_healthcheck" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + address = "www.example.com" + name = "server-1" + check_regions = ["WNAM", "ENAM"] + consecutive_fails = 0 + consecutive_successes = 0 + description = "Health check for www.example.com" + http_config = { + allow_insecure = true + expected_body = "success" + expected_codes = ["2xx", "302"] + follow_redirects = true + header = { + host = ["example.com"] + x_app_id = ["abc123"] + } + method = "GET" + path = "/health" + port = 0 + } + interval = 0 + retries = 0 + suspended = true + tcp_config = { + method = "connection_established" + port = 0 + } + timeout = 0 + type = "HTTPS" } ``` + ## Schema @@ -125,6 +104,5 @@ Optional: Import is supported using the following syntax: ```shell -# Use the Zone ID and Healthcheck ID to import. -$ terraform import cloudflare_healthcheck.example / +$ terraform import cloudflare_healthcheck.example '/' ``` diff --git a/docs/resources/hostname_tls_setting.md b/docs/resources/hostname_tls_setting.md index edbe890786..596b1ed8c0 100644 --- a/docs/resources/hostname_tls_setting.md +++ b/docs/resources/hostname_tls_setting.md @@ -12,13 +12,14 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_hostname_tls_setting" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - hostname = "sub.example.com" - setting = "min_tls_version" - value = "1.2" +resource "cloudflare_hostname_tls_setting" "example_hostname_tls_setting" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + setting_id = "ciphers" + hostname = "app.example.com" + value = ["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"] } ``` + ## Schema @@ -44,5 +45,5 @@ resource "cloudflare_hostname_tls_setting" "example" { Import is supported using the following syntax: ```shell -$ terraform import cloudflare_hostname_tls_setting.example // +$ terraform import cloudflare_hostname_tls_setting.example '/' ``` diff --git a/docs/resources/hyperdrive_config.md b/docs/resources/hyperdrive_config.md index e116852173..4d0a17c7d8 100644 --- a/docs/resources/hyperdrive_config.md +++ b/docs/resources/hyperdrive_config.md @@ -12,19 +12,23 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_hyperdrive_config" "no_defaults" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "my-hyperdrive-config" +resource "cloudflare_hyperdrive_config" "example_hyperdrive_config" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + name = "example-hyperdrive" origin = { database = "postgres" - password = "my-password" - host = "my-database.example.com" - port = 5432 - scheme = "postgres" - user = "my-user" + host = "database.example.com" + password = "password" + port = 5432 + scheme = "postgres" + user = "postgres" + } + caching = { + disabled = true } } ``` + ## Schema @@ -74,5 +78,5 @@ Optional: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_hyperdrive_config.example / +$ terraform import cloudflare_hyperdrive_config.example '/' ``` diff --git a/docs/resources/image.md b/docs/resources/image.md index 5256ec6c8b..fbde4aabf7 100644 --- a/docs/resources/image.md +++ b/docs/resources/image.md @@ -9,6 +9,21 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_image" "example_image" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + file = { + + } + metadata = { + + } + require_signed_urls = true + url = "https://example.com/path/to/logo.png" +} +``` ## Schema @@ -32,4 +47,10 @@ description: |- - `uploaded` (String) When the media item was uploaded. - `variants` (List of String) Object specifying available variants for an image. +## Import + +Import is supported using the following syntax: +```shell +$ terraform import cloudflare_image.example '/' +``` diff --git a/docs/resources/image_variant.md b/docs/resources/image_variant.md index 4af4366d4d..3428ea4af9 100644 --- a/docs/resources/image_variant.md +++ b/docs/resources/image_variant.md @@ -9,6 +9,21 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_image_variant" "example_image_variant" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + id = "hero" + options = { + fit = "scale-down" + height = 768 + metadata = "keep" + width = 1366 + } + never_require_signed_urls = true +} +``` ## Schema @@ -57,4 +72,10 @@ Read-Only: - `metadata` (String) What EXIF data should be preserved in the output image. - `width` (Number) Maximum width in image pixels. +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_image_variant.example '/' +``` diff --git a/docs/resources/keyless_certificate.md b/docs/resources/keyless_certificate.md index 0dedc46469..ab4e68934b 100644 --- a/docs/resources/keyless_certificate.md +++ b/docs/resources/keyless_certificate.md @@ -12,16 +12,20 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_keyless_certificate" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" +resource "cloudflare_keyless_certificate" "example_keyless_certificate" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + certificate = "-----BEGIN CERTIFICATE----- MIIDtTCCAp2gAwIBAgIJAM15n7fdxhRtMA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV BAYTAlVTMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX aWRnaXRzIFB0eSBMdGQwHhcNMTQwMzExMTkyMTU5WhcNMTQwNDEwMTkyMTU5WjBF MQswCQYDVQQGEwJVUzETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB CgKCAQEAvq3sKsHpeduJHimOK+fvQdKsI8z8A05MZyyLp2/R/GE8FjNv+hkVY1WQ LIyTNNQH7CJecE1nbTfo8Y56S7x/rhxC6/DJ8MIulapFPnorq46KU6yRxiM0MQ3N nTJHlHA2ozZta6YBBfVfhHWl1F0IfNbXCLKvGwWWMbCx43OfW6KTkbRnE6gFWKuO fSO5h2u5TaWVuSIzBvYs7Vza6m+gtYAvKAJV2nSZ+eSEFPDo29corOy8+huEOUL8 5FAw4BFPsr1TlrlGPFitduQUHGrSL7skk1ESGza0to3bOtrodKei2s9bk5MXm7lZ qI+WZJX4Zu9+mzZhc9pCVi8r/qlXuQIDAQABo4GnMIGkMB0GA1UdDgQWBBRvavf+ sWM4IwKiH9X9w1vl6nUVRDB1BgNVHSMEbjBsgBRvavf+sWM4IwKiH9X9w1vl6nUV RKFJpEcwRTELMAkGA1UEBhMCVVMxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAM15n7fdxhRtMAwGA1UdEwQF MAMBAf8wDQYJKoZIhvcNAQEFBQADggEBABY2ZzBaW0dMsAAT7tPJzrVWVzQx6KU4 UEBLudIlWPlkAwTnINCWR/8eNjCCmGA4heUdHmazdpPa8RzwOmc0NT1NQqzSyktt vTqb4iHD7+8f9MqJ9/FssCfTtqr/Qst/hGH4Wmdf1EJ/6FqYAAb5iRlPgshFZxU8 uXtA8hWn6fK6eISD9HBdcAFToUvKNZ1BIDPvh9f95Ine8ar6yGd56TUNrHR8eHBs ESxz5ddVR/oWRysNJ+aGAyYqHS8S/ttmC7r4XCAHqXptkHPCGRqkAhsterYhd4I8 /cBzejUobNCjjHFbtkAL/SjxZOLW+pNkZwfeYdM8iPkD54Uua1v2tdw= -----END CERTIFICATE-----" + host = "example.com" + port = 24008 bundle_method = "ubiquitous" - name = "example.com Keyless SSL" - host = "example.com" - port = 24008 - enabled = true - certificate = "-----INSERT CERTIFICATE-----" + name = "example.com Keyless SSL" + tunnel = { + private_ip = "10.0.0.1" + vnet_id = "7365377a-85a4-4390-9480-531ef7dc7a3c" + } } ``` + ## Schema @@ -60,5 +64,5 @@ Required: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_keyless_certificate.example / +$ terraform import cloudflare_keyless_certificate.example '/' ``` diff --git a/docs/resources/leaked_credential_check.md b/docs/resources/leaked_credential_check.md new file mode 100644 index 0000000000..6bc1f82063 --- /dev/null +++ b/docs/resources/leaked_credential_check.md @@ -0,0 +1,32 @@ +--- +page_title: "cloudflare_leaked_credential_check Resource - Cloudflare" +subcategory: "" +description: |- + +--- + +# cloudflare_leaked_credential_check (Resource) + + + +## Example Usage + +```terraform +resource "cloudflare_leaked_credential_check" "example_leaked_credential_check" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + enabled = true +} +``` + + +## Schema + +### Required + +- `zone_id` (String) Identifier + +### Optional + +- `enabled` (Boolean) Whether or not Leaked Credential Checks are enabled + + diff --git a/docs/resources/list.md b/docs/resources/list.md index 231d868a0e..16cc05abc3 100644 --- a/docs/resources/list.md +++ b/docs/resources/list.md @@ -18,108 +18,11 @@ description: |- ## Example Usage ```terraform -# IP list -resource "cloudflare_list" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "example_list" - description = "example IPs for a list" - kind = "ip" - - item = [{ - value = [{ - ip = "192.0.2.0" - }] - comment = "one" - }, - { - value = [{ - ip = "192.0.2.1" - }] - comment = "two" - }] - -} - -# Redirect list -resource "cloudflare_list" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "example_list" - description = "example redirects for a list" - kind = "redirect" - - item = [{ - value = [{ - redirect = [{ - source_url = "example.com/blog" - target_url = "https://blog.example.com" - }] - }] - comment = "one" - }, - { - value = [{ - redirect = [{ - source_url = "example.com/foo" - target_url = "https://foo.example.com" - include_subdomains = "enabled" - subpath_matching = "enabled" - status_code = 301 - preserve_query_string = "enabled" - preserve_path_suffix = "disabled" - }] - }] - comment = "two" - }] - -} - -# ASN list -resource "cloudflare_list" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "example_list" - description = "example ASNs for a list" - kind = "asn" - - item = [{ - value = [{ - asn = 677 - }] - comment = "one" - }, - { - value = [{ - asn = 989 - }] - comment = "two" - }] - -} - - -# Hostname list -resource "cloudflare_list" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "example_list" - description = "example hostnames for a list" - kind = "hostname" - - item = [{ - value = [{ - hostname = [{ - url_hostname = "example.com" - }] - }] - comment = "one" - }, - { - value = [{ - hostname = [{ - url_hostname = "*.example.com" - }] - }] - comment = "two" - }] - +resource "cloudflare_list" "example_list" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + kind = "ip" + name = "list1" + description = "This is a note" } ``` @@ -148,5 +51,5 @@ resource "cloudflare_list" "example" { Import is supported using the following syntax: ```shell -$ terraform import cloudflare_list.example / +$ terraform import cloudflare_list.example '/' ``` diff --git a/docs/resources/list_item.md b/docs/resources/list_item.md index 5b97f7feb9..9628f92a53 100644 --- a/docs/resources/list_item.md +++ b/docs/resources/list_item.md @@ -12,76 +12,29 @@ description: |- ## Example Usage ```terraform -# IP List -resource "cloudflare_list" "example_ip_list" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "example_list" - description = "example IPs for a list" - kind = "ip" -} - -# IP List Item -resource "cloudflare_list_item" "example_ip_item" { - account_id = "f037e56e89293a057740de681ac9abbe" - list_id = cloudflare_list.example_ip_list.id - comment = "List Item Comment" - ip = "192.0.2.0" -} - -# Redirect List -resource "cloudflare_list" "example_redirect_list" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "example_list" - description = "example Redirects for a list" - kind = "redirect" -} - -# Redirect List Item -resource "cloudflare_list_item" "example_redirect_item" { - account_id = "f037e56e89293a057740de681ac9abbe" - list_id = cloudflare_list.example_ip_list.id - redirect = { - source_url = "https://source.tld/" - target_url = "https://target.tld" - status_code = 302 - subpath_matching = true - } -} - -# ASN List -resource "cloudflare_list" "example_asn_list" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "example_asn_list" - description = "example ASNs for a list" - kind = "asn" -} - -# ASN List Item -resource "cloudflare_list_item" "example_asn_item" { - account_id = "f037e56e89293a057740de681ac9abbe" - list_id = cloudflare_list.example_asn_list.id - comment = "List Item Comment" - asn = 6789 -} - -# Hostname List -resource "cloudflare_list" "example_hostname_list" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "example_hostname_list" - description = "example Hostnames for a list" - kind = "hostname" -} - -# Hostname List Item -resource "cloudflare_list_item" "example_hostname_item" { - account_id = "f037e56e89293a057740de681ac9abbe" - list_id = cloudflare_list.example_hostname_list.id - comment = "List Item Comment" - hostname = { - url_hostname = "example.com" - } +resource "cloudflare_list_item" "example_list_item" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + list_id = "2c0fc9fa937b11eaa1b71c4d701ab86e" + body = [{ + asn = 5567 + comment = "Private IP address" + hostname = { + url_hostname = "example.com" + } + ip = "10.0.0.1" + redirect = { + source_url = "example.com/arch" + target_url = "https://archlinux.org/" + include_subdomains = true + preserve_path_suffix = true + preserve_query_string = true + status_code = 301 + subpath_matching = true + } + }] } ``` + ## Schema @@ -136,10 +89,4 @@ Optional: - `status_code` (Number) - `subpath_matching` (Boolean) -## Import -Import is supported using the following syntax: - -```shell -$ terraform import cloudflare_list_item.example // -``` diff --git a/docs/resources/load_balancer.md b/docs/resources/load_balancer.md index 08bdbf7034..0d2dfe2704 100644 --- a/docs/resources/load_balancer.md +++ b/docs/resources/load_balancer.md @@ -12,55 +12,112 @@ description: |- ## Example Usage ```terraform -# Define a load balancer which always points to a pool we define below. -# In normal usage, would have different pools set for different pops -# (cloudflare points-of-presence) and/or for different regions. -# Within each pop or region we can define multiple pools in failover order. -resource "cloudflare_load_balancer" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "example-load-balancer.example.com" - fallback_pool_id = cloudflare_load_balancer_pool.example.id - default_pool_ids = [cloudflare_load_balancer_pool.example.id] - description = "example load balancer using geo-balancing" - proxied = true - steering_policy = "geo" - - pop_pools = [{ - pop = "LAX" - pool_ids = [cloudflare_load_balancer_pool.example.id] - }] - - country_pools = [{ - country = "US" - pool_ids = [cloudflare_load_balancer_pool.example.id] - }] - - region_pools = [{ - region = "WNAM" - pool_ids = [cloudflare_load_balancer_pool.example.id] - }] - +resource "cloudflare_load_balancer" "example_load_balancer" { + zone_id = "699d98642c564d2e855e9661899b7252" + default_pools = ["17b5962d775c646f3f9725cbc7a53df4", "9290f38c5d07c2e2f4df57b1f61d4196", "00920f38ce07c2e2f4df50b1f61d4194"] + fallback_pool = "fallback_pool" + name = "www.example.com" + adaptive_routing = { + failover_across_pools = true + } + country_pools = { + gb = ["abd90f38ced07c2e2f4df50b1f61d4194"] + us = ["de90f38ced07c2e2f4df50b1f61d4194", "00920f38ce07c2e2f4df50b1f61d4194"] + } + description = "Load Balancer for www.example.com" + location_strategy = { + mode = "pop" + prefer_ecs = "always" + } + networks = ["string"] + pop_pools = { + lax = ["de90f38ced07c2e2f4df50b1f61d4194", "9290f38c5d07c2e2f4df57b1f61d4196"] + lhr = ["abd90f38ced07c2e2f4df50b1f61d4194", "f9138c5d07c2e2f4df57b1f61d4196"] + sjc = ["00920f38ce07c2e2f4df50b1f61d4194"] + } + proxied = true + random_steering = { + default_weight = 0.2 + pool_weights = { + 9290f38c5d07c2e2f4df57b1f61d4196 = 0.5 + de90f38ced07c2e2f4df50b1f61d4194 = 0.3 + } + } + region_pools = { + enam = ["00920f38ce07c2e2f4df50b1f61d4194"] + wnam = ["de90f38ced07c2e2f4df50b1f61d4194", "9290f38c5d07c2e2f4df57b1f61d4196"] + } rules = [{ - name = "example rule" - condition = "http.request.uri.path contains \"testing\"" + condition = "http.request.uri.path contains \"/testing\"" + disabled = true fixed_response = { - message_body = "hello" - status_code = 200 - content_type = "html" - location = "www.example.com" + content_type = "application/json" + location = "www.example.com" + message_body = "Testing Hello" + status_code = 0 } + name = "route the path /testing to testing datacenter." + overrides = { + adaptive_routing = { + failover_across_pools = true + } + country_pools = { + gb = ["abd90f38ced07c2e2f4df50b1f61d4194"] + us = ["de90f38ced07c2e2f4df50b1f61d4194", "00920f38ce07c2e2f4df50b1f61d4194"] + } + default_pools = ["17b5962d775c646f3f9725cbc7a53df4", "9290f38c5d07c2e2f4df57b1f61d4196", "00920f38ce07c2e2f4df50b1f61d4194"] + fallback_pool = "fallback_pool" + location_strategy = { + mode = "pop" + prefer_ecs = "always" + } + pop_pools = { + lax = ["de90f38ced07c2e2f4df50b1f61d4194", "9290f38c5d07c2e2f4df57b1f61d4196"] + lhr = ["abd90f38ced07c2e2f4df50b1f61d4194", "f9138c5d07c2e2f4df57b1f61d4196"] + sjc = ["00920f38ce07c2e2f4df50b1f61d4194"] + } + random_steering = { + default_weight = 0.2 + pool_weights = { + 9290f38c5d07c2e2f4df57b1f61d4196 = 0.5 + de90f38ced07c2e2f4df50b1f61d4194 = 0.3 + } + } + region_pools = { + enam = ["00920f38ce07c2e2f4df50b1f61d4194"] + wnam = ["de90f38ced07c2e2f4df50b1f61d4194", "9290f38c5d07c2e2f4df57b1f61d4196"] + } + session_affinity = "none" + session_affinity_attributes = { + drain_duration = 100 + headers = ["x"] + require_all_headers = true + samesite = "Auto" + secure = "Auto" + zero_downtime_failover = "none" + } + session_affinity_ttl = 1800 + steering_policy = "off" + ttl = 30 + } + priority = 0 + terminates = true }] -} - -resource "cloudflare_load_balancer_pool" "example" { - name = "example-lb-pool" - origins = [{ - name = "example-1" - address = "192.0.2.1" - enabled = false - }] + session_affinity = "none" + session_affinity_attributes = { + drain_duration = 100 + headers = ["x"] + require_all_headers = true + samesite = "Auto" + secure = "Auto" + zero_downtime_failover = "none" + } + session_affinity_ttl = 1800 + steering_policy = "off" + ttl = 30 } ``` + ## Schema @@ -277,5 +334,5 @@ Optional: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_load_balancer.example / +$ terraform import cloudflare_load_balancer.example '/' ``` diff --git a/docs/resources/load_balancer_monitor.md b/docs/resources/load_balancer_monitor.md index fa045476e8..7548dbace4 100644 --- a/docs/resources/load_balancer_monitor.md +++ b/docs/resources/load_balancer_monitor.md @@ -12,39 +12,30 @@ description: |- ## Example Usage ```terraform -# HTTP -resource "cloudflare_load_balancer_monitor" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - type = "http" - expected_body = "alive" +resource "cloudflare_load_balancer_monitor" "example_load_balancer_monitor" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + allow_insecure = true + consecutive_down = 0 + consecutive_up = 0 + description = "Login page monitor" + expected_body = "alive" expected_codes = "2xx" - method = "GET" - timeout = 7 - path = "/health" - interval = 60 - retries = 5 - description = "example http load balancer" - header = [{ - header = "Host" - values = ["example.com"] - }] - allow_insecure = false follow_redirects = true - probe_zone = "example.com" -} - -# TCP Monitor -resource "cloudflare_load_balancer_monitor" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - type = "tcp" - method = "connection_established" - timeout = 7 - port = 8080 - interval = 60 - retries = 5 - description = "example tcp load balancer" + header = { + host = ["example.com"] + x_app_id = ["abc123"] + } + interval = 0 + method = "GET" + path = "/health" + port = 0 + probe_zone = "example.com" + retries = 0 + timeout = 0 + type = "http" } ``` + ## Schema @@ -82,5 +73,5 @@ resource "cloudflare_load_balancer_monitor" "example" { Import is supported using the following syntax: ```shell -$ terraform import cloudflare_load_balancer_monitor.example / +$ terraform import cloudflare_load_balancer_monitor.example '/' ``` diff --git a/docs/resources/load_balancer_pool.md b/docs/resources/load_balancer_pool.md index db24d6627a..51dadebbf9 100644 --- a/docs/resources/load_balancer_pool.md +++ b/docs/resources/load_balancer_pool.md @@ -12,43 +12,49 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_load_balancer_pool" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "example-pool" +resource "cloudflare_load_balancer_pool" "example_load_balancer_pool" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + name = "primary-dc-1" origins = [{ - name = "example-1" - address = "192.0.2.1" - enabled = false - header = [{ - header = "Host" - values = ["example-1"] - }] - }, - { - name = "example-2" - address = "192.0.2.2" - header = [{ - header = "Host" - values = ["example-2"] - }] + address = "0.0.0.0" + disabled_at = "2019-12-27T18:11:19.117Z" + enabled = true + header = { + host = ["example.com"] + } + name = "app-server-1" + virtual_network_id = "a5624d4e-044a-4ff0-b3e1-e2465353d4b4" + weight = 0.6 }] - latitude = 55 - longitude = -12 - description = "example load balancer pool" - enabled = false - minimum_origins = 1 - notification_email = "someone@example.com" + description = "Primary data center - Provider XYZ" + enabled = false + latitude = 0 load_shedding = { - default_percent = 55 - default_policy = "random" - session_percent = 12 - session_policy = "hash" + default_percent = 0 + default_policy = "random" + session_percent = 0 + session_policy = "hash" + } + longitude = 0 + minimum_origins = 0 + monitor = "monitor" + notification_email = "someone@example.com,sometwo@example.com" + notification_filter = { + origin = { + disable = true + healthy = true + } + pool = { + disable = true + healthy = false + } } origin_steering = { policy = "random" } } ``` + ## Schema @@ -161,5 +167,5 @@ Optional: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_load_balancer_pool.example / +$ terraform import cloudflare_load_balancer_pool.example '/' ``` diff --git a/docs/resources/logpull_retention.md b/docs/resources/logpull_retention.md index 97be1159b0..65d7eada85 100644 --- a/docs/resources/logpull_retention.md +++ b/docs/resources/logpull_retention.md @@ -12,11 +12,12 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_logpull_retention" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - enabled = "true" +resource "cloudflare_logpull_retention" "example_logpull_retention" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + flag = true } ``` + ## Schema @@ -28,10 +29,4 @@ resource "cloudflare_logpull_retention" "example" { - `flag` (Boolean) The log retention flag for Logpull API. -## Import - -Import is supported using the following syntax: -```shell -$ terraform import cloudflare_logpull_retention.example -``` diff --git a/docs/resources/logpush_job.md b/docs/resources/logpush_job.md index 69c8feb8c9..dbf9a790c3 100644 --- a/docs/resources/logpush_job.md +++ b/docs/resources/logpush_job.md @@ -12,85 +12,36 @@ description: |- ## Example Usage ```terraform -# Example Usage (Cloudflare R2) -# -# When using Cloudflare R2, no ownership challenge is required. -data "cloudflare_api_token_permission_groups" "all" {} -resource "cloudflare_api_token" "logpush_r2_token" { - name = "logpush_r2_token" - policy = [{ - permission_groups = [ - data.cloudflare_api_token_permission_groups.all.account["Workers R2 Storage Write"], - ] - resources = { - "com.cloudflare.api.account.*" = "*" - } - }] -} - -resource "cloudflare_logpush_job" "http_requests" { - enabled = true - zone_id = var.zone_id - name = "http_requests" - logpull_options = "fields=ClientIP,ClientRequestHost,ClientRequestMethod,ClientRequestURI,EdgeEndTimestamp,EdgeResponseBytes,EdgeResponseStatus,EdgeStartTimestamp,RayID×tamps=rfc3339" - destination_conf = "r2://cloudflare-logs/http_requests/date={DATE}?account-id=${var.account_id}&access-key-id=${cloudflare_api_token.logpush_r2_token.id}&secret-access-key=${sha256(cloudflare_api_token.logpush_r2_token.value)}" - dataset = "http_requests" -} - - -# Example Usage (with AWS provider) -# -# Please see `cloudflare_logpush_ownership_challenge` for how to use that -# resource and the third party provider documentation if you -# choose to automate the intermediate step of fetching the ownership challenge -# contents. -# -# **Important:** If you're using this approach, the `destination_conf` values -# must match identically in all resources. Otherwise the challenge validation -# will fail. -resource "cloudflare_logpush_ownership_challenge" "ownership_challenge" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - destination_conf = "s3://my-bucket-path?region=us-west-2" -} - -data "aws_s3_bucket_object" "challenge_file" { - bucket = "my-bucket-path" - key = cloudflare_logpush_ownership_challenge.ownership_challenge.ownership_challenge_filename -} - -resource "cloudflare_logpush_job" "example_job" { - depends_on = [cloudflare_logpush_ownership_challenge.ownership_challenge] - enabled = true - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "My-logpush-job" - logpull_options = "fields=RayID,ClientIP,EdgeStartTimestamp×tamps=rfc3339" - destination_conf = "s3://my-bucket-path?region=us-west-2" - ownership_challenge = data.aws_s3_bucket_object.challenge_file.body - dataset = "http_requests" -} - -# Example Usage (manual inspection of S3 bucket) -# -# 1. Create `cloudflare_logpush_ownership_challenge` resource - -resource "cloudflare_logpush_ownership_challenge" "ownership_challenge" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - destination_conf = "s3://my-bucket-path?region=us-west-2" -} - -# 2. Check S3 bucket for your ownership challenge filename and grab the contents. -# 3. Create the `cloudflare_logpush_job` substituting in your manual `ownership_challenge`. -resource "cloudflare_logpush_job" "example_job" { - enabled = true - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "My-logpush-job" - logpull_options = "fields=RayID,ClientIP,EdgeStartTimestamp×tamps=rfc3339" - destination_conf = "s3://my-bucket-path?region=us-west-2" - ownership_challenge = "0000000000000" - dataset = "http_requests" - frequency = "high" +resource "cloudflare_logpush_job" "example_logpush_job" { + destination_conf = "s3://mybucket/logs?region=us-west-2" + zone_id = "zone_id" + dataset = "http_requests" + enabled = false + frequency = "high" + kind = "edge" + logpull_options = "fields=RayID,ClientIP,EdgeStartTimestamp×tamps=rfc3339" + max_upload_bytes = 5000000 + max_upload_interval_seconds = 30 + max_upload_records = 1000 + name = "example.com" + output_options = { + batch_prefix = "batch_prefix" + batch_suffix = "batch_suffix" + cve_2021_4428 = true + field_delimiter = "field_delimiter" + field_names = ["ClientIP", "EdgeStartTimestamp", "RayID"] + output_type = "ndjson" + record_delimiter = "record_delimiter" + record_prefix = "record_prefix" + record_suffix = "record_suffix" + record_template = "record_template" + sample_rate = 0 + timestamp_format = "unixnano" + } + ownership_challenge = "00000000000000000000" } ``` + ## Schema @@ -144,9 +95,5 @@ Optional: Import is supported using the following syntax: ```shell -# Import an accountcloudflare_access_service_tokenscoped job. -$ terraform import cloudflare_logpush_job.example account// - -# Import a zonecloudflare_access_service_tokenscoped job. -$ terraform import cloudflare_logpush_job.example zone// +$ terraform import cloudflare_logpush_job.example '<{accounts|zones}/{account_id|zone_id}>/' ``` diff --git a/docs/resources/logpush_ownership_challenge.md b/docs/resources/logpush_ownership_challenge.md index ccde12d42a..52f48a32af 100644 --- a/docs/resources/logpush_ownership_challenge.md +++ b/docs/resources/logpush_ownership_challenge.md @@ -12,11 +12,12 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_logpush_ownership_challenge" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - destination_conf = "s3://my-bucket-path?region=us-west-2" +resource "cloudflare_logpush_ownership_challenge" "example_logpush_ownership_challenge" { + destination_conf = "s3://mybucket/logs?region=us-west-2" + zone_id = "zone_id" } ``` + ## Schema diff --git a/docs/resources/magic_network_monitoring_configuration.md b/docs/resources/magic_network_monitoring_configuration.md index 6b41fd7bca..927014b7c2 100644 --- a/docs/resources/magic_network_monitoring_configuration.md +++ b/docs/resources/magic_network_monitoring_configuration.md @@ -9,6 +9,21 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_magic_network_monitoring_configuration" "example_magic_network_monitoring_configuration" { + account_id = "6f91088a406011ed95aed352566e8d4c" + default_sampling = 1 + name = "cloudflare user\'s account" + router_ips = ["203.0.113.1"] + warp_devices = [{ + id = "5360368d-b351-4791-abe1-93550dabd351" + name = "My warp device" + router_ip = "203.0.113.1" + }] +} +``` ## Schema diff --git a/docs/resources/magic_network_monitoring_rule.md b/docs/resources/magic_network_monitoring_rule.md index f2a40d1d71..9856ac3def 100644 --- a/docs/resources/magic_network_monitoring_rule.md +++ b/docs/resources/magic_network_monitoring_rule.md @@ -9,6 +9,19 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_magic_network_monitoring_rule" "example_magic_network_monitoring_rule" { + account_id = "6f91088a406011ed95aed352566e8d4c" + duration = "300s" + name = "my_rule_1" + automatic_advertisement = true + bandwidth = 1000 + packet_threshold = 10000 + prefixes = ["203.0.113.1/32"] +} +``` ## Schema @@ -31,4 +44,10 @@ description: |- - `bandwidth_threshold` (Number) The number of bits per second for the rule. When this value is exceeded for the set duration, an alert notification is sent. Minimum of 1 and no maximum. +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_magic_network_monitoring_rule.example '/' +``` diff --git a/docs/resources/magic_transit_connector.md b/docs/resources/magic_transit_connector.md index 31fe2d48dd..df31c159fe 100644 --- a/docs/resources/magic_transit_connector.md +++ b/docs/resources/magic_transit_connector.md @@ -9,6 +9,19 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_magic_transit_connector" "example_magic_transit_connector" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + connector_id = "connector_id" + activated = true + interrupt_window_duration_hours = 0 + interrupt_window_hour_of_day = 0 + notes = "notes" + timezone = "timezone" +} +``` ## Schema @@ -42,4 +55,10 @@ Read-Only: - `id` (String) - `serial_number` (String) +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_magic_transit_connector.example '/' +``` diff --git a/docs/resources/magic_transit_site.md b/docs/resources/magic_transit_site.md index 9459e37a1a..f833604a47 100644 --- a/docs/resources/magic_transit_site.md +++ b/docs/resources/magic_transit_site.md @@ -9,6 +9,22 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_magic_transit_site" "example_magic_transit_site" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + name = "site_1" + connector_id = "ac60d3d0435248289d446cedd870bcf4" + description = "description" + ha_mode = true + location = { + lat = "37.6192" + lon = "122.3816" + } + secondary_connector_id = "8d67040d3835dbcf46ce29da440dc482" +} +``` ## Schema @@ -38,4 +54,10 @@ Optional: - `lat` (String) Latitude - `lon` (String) Longitude +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_magic_transit_site.example '/' +``` diff --git a/docs/resources/magic_transit_site_acl.md b/docs/resources/magic_transit_site_acl.md index 42ba5b42c0..06efc23024 100644 --- a/docs/resources/magic_transit_site_acl.md +++ b/docs/resources/magic_transit_site_acl.md @@ -9,6 +9,30 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_magic_transit_site_acl" "example_magic_transit_site_acl" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + site_id = "023e105f4ecef8ad9ca31a8372d0c353" + lan_1 = { + lan_id = "lan_id" + lan_name = "lan_name" + ports = [1] + subnets = ["192.0.2.1"] + } + lan_2 = { + lan_id = "lan_id" + lan_name = "lan_name" + ports = [1] + subnets = ["192.0.2.1"] + } + name = "PIN Pad - Cash Register" + description = "Allows local traffic between PIN pads and cash register." + forward_locally = true + protocols = ["tcp"] +} +``` ## Schema @@ -58,4 +82,10 @@ Optional: - `ports` (List of Number) Array of ports on the provided LAN that will be included in the ACL. If no ports are provided, communication on any port on this LAN is allowed. - `subnets` (List of String) Array of subnet IPs within the LAN that will be included in the ACL. If no subnets are provided, communication on any subnets on this LAN are allowed. +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_magic_transit_site_acl.example '//' +``` diff --git a/docs/resources/magic_transit_site_lan.md b/docs/resources/magic_transit_site_lan.md index 0665264596..6dbfcf3bd7 100644 --- a/docs/resources/magic_transit_site_lan.md +++ b/docs/resources/magic_transit_site_lan.md @@ -9,6 +9,45 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_magic_transit_site_lan" "example_magic_transit_site_lan" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + site_id = "023e105f4ecef8ad9ca31a8372d0c353" + physport = 1 + vlan_tag = 0 + ha_link = true + name = "name" + nat = { + static_prefix = "192.0.2.0/24" + } + routed_subnets = [{ + next_hop = "192.0.2.1" + prefix = "192.0.2.0/24" + nat = { + static_prefix = "192.0.2.0/24" + } + }] + static_addressing = { + address = "192.0.2.0/24" + dhcp_relay = { + server_addresses = ["192.0.2.1"] + } + dhcp_server = { + dhcp_pool_end = "192.0.2.1" + dhcp_pool_start = "192.0.2.1" + dns_server = "192.0.2.1" + reservations = { + 00_11_22_33_44_55 = "192.0.2.100" + aa_bb_cc_dd_ee_ff = "192.168.1.101" + } + } + secondary_address = "192.0.2.0/24" + virtual_address = "192.0.2.0/24" + } +} +``` ## Schema diff --git a/docs/resources/magic_transit_site_wan.md b/docs/resources/magic_transit_site_wan.md index c9ac8cc8b3..acd8c6719c 100644 --- a/docs/resources/magic_transit_site_wan.md +++ b/docs/resources/magic_transit_site_wan.md @@ -9,6 +9,23 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_magic_transit_site_wan" "example_magic_transit_site_wan" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + site_id = "023e105f4ecef8ad9ca31a8372d0c353" + physport = 1 + vlan_tag = 0 + name = "name" + priority = 0 + static_addressing = { + address = "192.0.2.0/24" + gateway_address = "192.0.2.1" + secondary_address = "192.0.2.0/24" + } +} +``` ## Schema diff --git a/docs/resources/magic_wan_gre_tunnel.md b/docs/resources/magic_wan_gre_tunnel.md index 07d0187742..64cf81866d 100644 --- a/docs/resources/magic_wan_gre_tunnel.md +++ b/docs/resources/magic_wan_gre_tunnel.md @@ -12,20 +12,11 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_magic_wan_gre_tunnel" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "GRE_1" - customer_gre_endpoint = "203.0.113.1" - cloudflare_gre_endpoint = "203.0.113.2" - interface_address = "192.0.2.0/31" - description = "Tunnel for ISP X" - ttl = 64 - mtu = 1476 - health_check_enabled = true - health_check_target = "203.0.113.1" - health_check_type = "reply" +resource "cloudflare_magic_wan_gre_tunnel" "example_magic_wan_gre_tunnel" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" } ``` + ## Schema @@ -190,10 +181,4 @@ Read-Only: - `effective` (String) The effective health check target. If 'saved' is empty, then this field will be populated with the calculated default value on GET requests. Ignored in POST, PUT, and PATCH requests. - `saved` (String) The saved health check target. Setting the value to the empty string indicates that the calculated default value will be used. -## Import - -Import is supported using the following syntax: -```shell -$ terraform import cloudflare_magic_wan_gre_tunnel.example / -``` diff --git a/docs/resources/magic_wan_ipsec_tunnel.md b/docs/resources/magic_wan_ipsec_tunnel.md index b63e107ac5..dfae9eb768 100644 --- a/docs/resources/magic_wan_ipsec_tunnel.md +++ b/docs/resources/magic_wan_ipsec_tunnel.md @@ -12,20 +12,28 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_magic_wan_ipsec_tunnel" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "IPsec_1" - customer_endpoint = "203.0.113.1" - cloudflare_endpoint = "203.0.113.1" - interface_address = "192.0.2.0/31" - description = "Tunnel for ISP X" - health_check_enabled = true - health_check_target = "203.0.113.1" - health_check_type = "reply" - psk = "asdf12341234" - allow_null_cipher = false +resource "cloudflare_magic_wan_ipsec_tunnel" "example_magic_wan_ipsec_tunnel" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + cloudflare_endpoint = "203.0.113.1" + interface_address = "192.0.2.0/31" + name = "IPsec_1" + customer_endpoint = "203.0.113.1" + description = "Tunnel for ISP X" + health_check = { + direction = "unidirectional" + enabled = true + rate = "low" + target = { + effective = "203.0.113.1" + saved = "203.0.113.1" + } + type = "reply" + } + psk = "O3bwKSjnaoCxDoUxjcq4Rk8ZKkezQUiy" + replay_protection = false } ``` + ## Schema @@ -218,10 +226,4 @@ Read-Only: - `last_generated_on` (String) The date and time the tunnel was last modified. -## Import - -Import is supported using the following syntax: -```shell -$ terraform import cloudflare_magic_wan_ipsec_tunnel.example / -``` diff --git a/docs/resources/magic_wan_static_route.md b/docs/resources/magic_wan_static_route.md index 1be50af7ca..0e60485d44 100644 --- a/docs/resources/magic_wan_static_route.md +++ b/docs/resources/magic_wan_static_route.md @@ -12,21 +12,11 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_magic_wan_static_route" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - description = "New route for new prefix 192.0.2.0/24" - prefix = "192.0.2.0/24" - nexthop = "10.0.0.0" - priority = 100 - weight = 10 - colo_names = [ - "den01" - ] - colo_regions = [ - "APAC" - ] +resource "cloudflare_magic_wan_static_route" "example_magic_wan_static_route" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" } ``` + ## Schema @@ -133,10 +123,4 @@ Read-Only: - `colo_names` (List of String) List of colo names for the ECMP scope. - `colo_regions` (List of String) List of colo regions for the ECMP scope. -## Import - -Import is supported using the following syntax: -```shell -$ terraform import cloudflare_magic_wan_static_route.example / -``` diff --git a/docs/resources/managed_transforms.md b/docs/resources/managed_transforms.md index a0ffdf3c3d..78803b2ad4 100644 --- a/docs/resources/managed_transforms.md +++ b/docs/resources/managed_transforms.md @@ -9,6 +9,21 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_managed_transforms" "example_managed_transforms" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + managed_request_headers = [{ + id = "add_cf-bot-score_header" + enabled = true + }] + managed_response_headers = [{ + id = "add_cf-bot-score_header" + enabled = true + }] +} +``` ## Schema @@ -40,4 +55,10 @@ Optional: - `enabled` (Boolean) When true, the Managed Transform is enabled. - `id` (String) Human-readable identifier of the Managed Transform. +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_managed_transforms.example '' +``` diff --git a/docs/resources/mtls_certificate.md b/docs/resources/mtls_certificate.md index 1cd4a43c59..3b72887570 100644 --- a/docs/resources/mtls_certificate.md +++ b/docs/resources/mtls_certificate.md @@ -12,14 +12,23 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_mtls_certificate" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "example" - certificates = "-----BEGIN CERTIFICATE-----\nMIIDmDCCAoCgAwIBAgIUKTOAZNj...i4JhqeoTewsxndhDDE\n-----END CERTIFICATE-----" - private_key = "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQE...1IS3EnQRrz6WMYA=\n-----END PRIVATE KEY-----" - ca = true +resource "cloudflare_mtls_certificate" "example_mtls_certificate" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + ca = true + certificates = < ## Schema @@ -49,5 +58,5 @@ resource "cloudflare_mtls_certificate" "example" { Import is supported using the following syntax: ```shell -$ terraform import cloudflare_mtls_certificate.example / +$ terraform import cloudflare_mtls_certificate.example '/' ``` diff --git a/docs/resources/notification_policy.md b/docs/resources/notification_policy.md index e75ba223be..3e578673ed 100644 --- a/docs/resources/notification_policy.md +++ b/docs/resources/notification_policy.md @@ -12,52 +12,70 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_notification_policy" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "Policy for SSL notification events" - description = "Notification policy to alert when my SSL certificates are modified" - enabled = true - alert_type = "universal_ssl_event_type" - - email_integration = [{ - id = "myemail@example.com" - }] - - webhooks_integration = [{ - id = "1860572c5d964d27aa0f379d13645940" - }] - - pagerduty_integration = [{ - id = "850129d136459401860572c5d964d27k" - }] -} - -### With Filters -resource "cloudflare_notification_policy" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "Policy for Healthcheck notification" - description = "Notification policy to alert on unhealthy Healthcheck status" - enabled = true - alert_type = "health_check_status_notification" - - email_integration = [{ - id = "myemail@example.com" - }] - - webhooks_integration = [{ - id = "1860572c5d964d27aa0f379d13645940" - }] - - pagerduty_integration = [{ - id = "850129d136459401860572c5d964d27k" - }] - +resource "cloudflare_notification_policy" "example_notification_policy" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + alert_type = "access_custom_certificate_expiration_type" + enabled = true + mechanisms = { + email = [{ + id = "test@example.com" + }] + pagerduty = [{ + id = "e8133a15-00a4-4d69-aec1-32f70c51f6e5" + }] + webhooks = [{ + id = "14cc1190-5d2b-4b98-a696-c424cb2ad05f" + }] + } + name = "SSL Notification Event Policy" + alert_interval = "30m" + description = "Something describing the policy." filters = { - health_check_id = ["699d98642c564d2e855e9661899b7252"] - status = ["Unhealthy"] + actions = ["string"] + affected_asns = ["string"] + affected_components = ["string"] + affected_locations = ["string"] + airport_code = ["string"] + alert_trigger_preferences = ["string"] + alert_trigger_preferences_value = ["string"] + enabled = ["string"] + environment = ["string"] + event = ["string"] + event_source = ["string"] + event_type = ["string"] + group_by = ["string"] + health_check_id = ["string"] + incident_impact = ["INCIDENT_IMPACT_NONE"] + input_id = ["string"] + limit = ["string"] + logo_tag = ["string"] + megabits_per_second = ["string"] + new_health = ["string"] + new_status = ["string"] + packets_per_second = ["string"] + pool_id = ["string"] + pop_name = ["string"] + product = ["string"] + project_id = ["string"] + protocol = ["string"] + query_tag = ["string"] + requests_per_second = ["string"] + selectors = ["string"] + services = ["string"] + slo = ["99.9"] + status = ["string"] + target_hostname = ["string"] + target_ip = ["string"] + target_zone_name = ["string"] + traffic_exclusions = ["security_events"] + tunnel_id = ["string"] + tunnel_name = ["string"] + where = ["string"] + zones = ["string"] } } ``` + ## Schema @@ -133,5 +151,5 @@ Optional: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_notification_policy.example / +$ terraform import cloudflare_notification_policy.example '/' ``` diff --git a/docs/resources/notification_policy_webhooks.md b/docs/resources/notification_policy_webhooks.md index 1d0a0cd60f..92b30d568b 100644 --- a/docs/resources/notification_policy_webhooks.md +++ b/docs/resources/notification_policy_webhooks.md @@ -12,13 +12,14 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_notification_policy_webhooks" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "Webhooks destination" - url = "https://example.com" - secret = "my-secret" +resource "cloudflare_notification_policy_webhooks" "example_notification_policy_webhooks" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + name = "Slack Webhook" + url = "https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd" + secret = "secret" } ``` + ## Schema @@ -45,5 +46,5 @@ resource "cloudflare_notification_policy_webhooks" "example" { Import is supported using the following syntax: ```shell -$ terraform import cloudflare_notification_policy_webhooks.example / +$ terraform import cloudflare_notification_policy_webhooks.example '/' ``` diff --git a/docs/resources/observatory_scheduled_test.md b/docs/resources/observatory_scheduled_test.md index ba9fd73657..f1b1ede0e0 100644 --- a/docs/resources/observatory_scheduled_test.md +++ b/docs/resources/observatory_scheduled_test.md @@ -12,13 +12,12 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_observatory_scheduled_test" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - url = "example.com" - region = "us-central1" - frequency = "WEEKLY" +resource "cloudflare_observatory_scheduled_test" "example_observatory_scheduled_test" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + url = "example.com" } ``` + ## Schema @@ -129,5 +128,5 @@ Read-Only: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_observatory_scheduled_test.example :: +$ terraform import cloudflare_observatory_scheduled_test.example '/' ``` diff --git a/docs/resources/origin_ca_certificate.md b/docs/resources/origin_ca_certificate.md index 26d05d8748..eaecadd729 100644 --- a/docs/resources/origin_ca_certificate.md +++ b/docs/resources/origin_ca_certificate.md @@ -16,23 +16,28 @@ description: |- ## Example Usage ```terraform -resource "tls_private_key" "example" { - algorithm = "RSA" -} - -resource "tls_cert_request" "example" { - private_key_pem = tls_private_key.example.private_key_pem - - subject { - common_name = "" - organization = "Terraform Test" - } -} - -resource "cloudflare_origin_ca_certificate" "example" { - csr = tls_cert_request.example.cert_request_pem - hostnames = ["example.com"] - request_type = "origin-rsa" +resource "cloudflare_origin_ca_certificate" "example_origin_ca_certificate" { + csr = < +$ terraform import cloudflare_origin_ca_certificate.example '' ``` diff --git a/docs/resources/page_shield_policy.md b/docs/resources/page_shield_policy.md index 4b349ba703..30f6d17176 100644 --- a/docs/resources/page_shield_policy.md +++ b/docs/resources/page_shield_policy.md @@ -9,6 +9,18 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_page_shield_policy" "example_page_shield_policy" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + action = "allow" + description = "Checkout page CSP policy" + enabled = true + expression = "ends_with(http.request.uri.path, \"/checkout\")" + value = "script-src \'none\';" +} +``` ## Schema @@ -26,4 +38,10 @@ description: |- - `id` (String) Identifier +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_page_shield_policy.example '/' +``` diff --git a/docs/resources/pages_domain.md b/docs/resources/pages_domain.md index d45c62da19..bce883f7cd 100644 --- a/docs/resources/pages_domain.md +++ b/docs/resources/pages_domain.md @@ -15,10 +15,10 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_pages_domain" "my-domain" { - account_id = "f037e56e89293a057740de681ac9abbe" - project_name = "my-example-project" - domain = "example.com" +resource "cloudflare_pages_domain" "example_pages_domain" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + project_name = "this-is-my-project-01" + name = "example.com" } ``` @@ -69,5 +69,5 @@ Read-Only: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_pages_domain.example // +$ terraform import cloudflare_pages_domain.example '//' ``` diff --git a/docs/resources/pages_project.md b/docs/resources/pages_project.md index df93b73b64..a1122cdbf1 100644 --- a/docs/resources/pages_project.md +++ b/docs/resources/pages_project.md @@ -16,188 +16,172 @@ description: |- ## Example Usage ```terraform -# Direct upload Pages project -resource "cloudflare_pages_project" "basic_project" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "this-is-my-project-01" - production_branch = "main" -} - -# Pages project with managing build config -resource "cloudflare_pages_project" "build_config" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "this-is-my-project-01" - production_branch = "main" +resource "cloudflare_pages_project" "example_pages_project" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" build_config = { - build_command = "npm run build" - destination_dir = "build" - root_dir = "" - web_analytics_tag = "cee1c73f6e4743d0b5e6bb1a0bcaabcc" + build_caching = true + build_command = "npm run build" + destination_dir = "build" + root_dir = "/" + web_analytics_tag = "cee1c73f6e4743d0b5e6bb1a0bcaabcc" web_analytics_token = "021e1057c18547eca7b79f2516f06o7x" } -} - -# Pages project managing project source -resource "cloudflare_pages_project" "source_config" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "this-is-my-project-01" - production_branch = "main" - source = [{ - type = "github" - config = [{ - owner = "cloudflare" - repo_name = "ninjakittens" - production_branch = "main" - pr_comments_enabled = true - deployments_enabled = true - production_deployment_enabled = true - preview_deployment_setting = "custom" - preview_branch_includes = ["dev", "preview"] - preview_branch_excludes = ["main", "prod"] - }] - }] -} - -# Pages project managing deployment configs -resource "cloudflare_pages_project" "deployment_configs" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "this-is-my-project-01" - production_branch = "main" deployment_configs = { - preview = [{ - environment_variables = { - ENVIRONMENT = "preview" + preview = { + ai_bindings = { + ai_binding = { + project_id = "some-project-id" + } } - secrets = { - TURNSTILE_SECRET = "1x0000000000000000000000000000000AA" + analytics_engine_datasets = { + analytics_engine_binding = { + dataset = "api_analytics" + } } - kv_namespaces = { - KV_BINDING = "5eb63bbbe01eeed093cb22bb8f5acdc3" + browsers = { + browser = { + + } + } + compatibility_date = "2022-01-01" + compatibility_flags = ["url_standard"] + d1_databases = { + d1_binding = { + id = "445e2955-951a-43f8-a35b-a4d0c8138f63" + } } durable_object_namespaces = { - DO_BINDING = "5eb63bbbe01eeed093cb22bb8f5acdc3" + do_binding = { + namespace_id = "5eb63bbbe01eeed093cb22bb8f5acdc3" + } } - r2_buckets = { - R2_BINDING = "some-bucket" + env_vars = { + foo = { + value = "hello world" + type = "plain_text" + } } - d1_databases = { - D1_BINDING = "445e2955-951a-4358-a35b-a4d0c813f63" + hyperdrive_bindings = { + hyperdrive = { + id = "a76a99bc342644deb02c38d66082262a" + } } - compatibility_date = "2022-08-15" - compatibility_flags = ["nodejs_compat"] - }] - production = [{ - environment_variables = { - ENVIRONMENT = "production" - OTHER_VALUE = "other value" + kv_namespaces = { + kv_binding = { + namespace_id = "5eb63bbbe01eeed093cb22bb8f5acdc3" + } } - secrets = { - TURNSTILE_SECRET = "1x0000000000000000000000000000000AA" - TURNSTILE_INVIS_SECRET = "2x0000000000000000000000000000000AA" + mtls_certificates = { + mtls = { + certificate_id = "d7cdd17c-916f-4cb7-aabe-585eb382ec4e" + } } - kv_namespaces = { - KV_BINDING_1 = "5eb63bbbe01eeed093cb22bb8f5acdc3" - KV_BINDING_2 = "3cdca5f8bb22bc390deee10ebbb36be5" + placement = { + mode = "smart" } - durable_object_namespaces = { - DO_BINDING_1 = "5eb63bbbe01eeed093cb22bb8f5acdc3" - DO_BINDING_2 = "3cdca5f8bb22bc390deee10ebbb36be5" + queue_producers = { + queue_producer_binding = { + name = "some-queue" + } } r2_buckets = { - R2_BINDING_1 = "some-bucket" - R2_BINDING_2 = "other-bucket" + r2_binding = { + jurisdiction = "eu" + name = "some-bucket" + } } - d1_databases = { - D1_BINDING_1 = "445e2955-951a-4358-a35b-a4d0c813f63" - D1_BINDING_2 = "a399414b-c697-409a-a688-377db6433cd9" - } - compatibility_date = "2022-08-16" - compatibility_flags = ["nodejs_compat", "streams_enable_constructors"] - }] - } -} - -# Pages project managing all configs -resource "cloudflare_pages_project" "deployment_configs" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "this-is-my-project-01" - production_branch = "main" - - source = [{ - type = "github" - config = [{ - owner = "cloudflare" - repo_name = "ninjakittens" - production_branch = "main" - pr_comments_enabled = true - deployments_enabled = true - production_deployment_enabled = true - preview_deployment_setting = "custom" - preview_branch_includes = ["dev", "preview"] - preview_branch_excludes = ["main", "prod"] - }] - }] - - build_config = { - build_command = "npm run build" - destination_dir = "build" - root_dir = "" - web_analytics_tag = "cee1c73f6e4743d0b5e6bb1a0bcaabcc" - web_analytics_token = "021e1057c18547eca7b79f2516f06o7x" - } - - deployment_configs = { - preview = [{ - environment_variables = { - ENVIRONMENT = "preview" + services = { + service_binding = { + entrypoint = "MyHandler" + environment = "production" + service = "example-worker" + } } - secrets = { - TURNSTILE_SECRET = "1x0000000000000000000000000000000AA" + vectorize_bindings = { + vectorize = { + index_name = "my_index" + } } - kv_namespaces = { - KV_BINDING = "5eb63bbbe01eeed093cb22bb8f5acdc3" + } + production = { + ai_bindings = { + ai_binding = { + project_id = "some-project-id" + } } - durable_object_namespaces = { - DO_BINDING = "5eb63bbbe01eeed093cb22bb8f5acdc3" + analytics_engine_datasets = { + analytics_engine_binding = { + dataset = "api_analytics" + } } - r2_buckets = { - R2_BINDING = "some-bucket" + browsers = { + browser = { + + } } + compatibility_date = "2022-01-01" + compatibility_flags = ["url_standard"] d1_databases = { - D1_BINDING = "445e2955-951a-4358-a35b-a4d0c813f63" + d1_binding = { + id = "445e2955-951a-43f8-a35b-a4d0c8138f63" + } } - compatibility_date = "2022-08-15" - compatibility_flags = ["nodejs_compat"] - }] - production = [{ - environment_variables = { - ENVIRONMENT = "production" - OTHER_VALUE = "other value" + durable_object_namespaces = { + do_binding = { + namespace_id = "5eb63bbbe01eeed093cb22bb8f5acdc3" + } + } + env_vars = { + foo = { + value = "hello world" + type = "plain_text" + } } - secrets = { - TURNSTILE_SECRET = "1x0000000000000000000000000000000AA" - TURNSTILE_INVIS_SECRET = "2x0000000000000000000000000000000AA" + hyperdrive_bindings = { + hyperdrive = { + id = "a76a99bc342644deb02c38d66082262a" + } } kv_namespaces = { - KV_BINDING_1 = "5eb63bbbe01eeed093cb22bb8f5acdc3" - KV_BINDING_2 = "3cdca5f8bb22bc390deee10ebbb36be5" + kv_binding = { + namespace_id = "5eb63bbbe01eeed093cb22bb8f5acdc3" + } } - durable_object_namespaces = { - DO_BINDING_1 = "5eb63bbbe01eeed093cb22bb8f5acdc3" - DO_BINDING_2 = "3cdca5f8bb22bc390deee10ebbb36be5" + mtls_certificates = { + mtls = { + certificate_id = "d7cdd17c-916f-4cb7-aabe-585eb382ec4e" + } + } + placement = { + mode = "smart" + } + queue_producers = { + queue_producer_binding = { + name = "some-queue" + } } r2_buckets = { - R2_BINDING_1 = "some-bucket" - R2_BINDING_2 = "other-bucket" + r2_binding = { + jurisdiction = "eu" + name = "some-bucket" + } } - d1_databases = { - D1_BINDING_1 = "445e2955-951a-4358-a35b-a4d0c813f63" - D1_BINDING_2 = "a399414b-c697-409a-a688-377db6433cd9" + services = { + service_binding = { + entrypoint = "MyHandler" + environment = "production" + service = "example-worker" + } } - compatibility_date = "2022-08-16" - compatibility_flags = ["nodejs_compat", "streams_enable_constructors"] - }] + vectorize_bindings = { + vectorize = { + index_name = "my_index" + } + } + } } + name = "NextJS Blog" + production_branch = "main" } ``` @@ -780,5 +764,5 @@ Read-Only: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_pages_project.example / +$ terraform import cloudflare_pages_project.example '/' ``` diff --git a/docs/resources/queue.md b/docs/resources/queue.md index 5ff712394b..7ab335bd62 100644 --- a/docs/resources/queue.md +++ b/docs/resources/queue.md @@ -12,11 +12,12 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_queue" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "my-queue" +resource "cloudflare_queue" "example_queue" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + queue_name = "example-queue" } ``` + ## Schema @@ -90,5 +91,5 @@ Read-Only: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_queue.example / +$ terraform import cloudflare_queue.example '/' ``` diff --git a/docs/resources/queue_consumer.md b/docs/resources/queue_consumer.md index 7199e79f0f..2d341054aa 100644 --- a/docs/resources/queue_consumer.md +++ b/docs/resources/queue_consumer.md @@ -9,6 +9,23 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_queue_consumer" "example_queue_consumer" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + queue_id = "023e105f4ecef8ad9ca31a8372d0c353" + script_name = "my-consumer-worker" + settings = { + batch_size = 50 + max_concurrency = 10 + max_retries = 3 + max_wait_time_ms = 5000 + retry_delay = 10 + } + type = "worker" +} +``` ## Schema diff --git a/docs/resources/r2_bucket.md b/docs/resources/r2_bucket.md index 533dc1d8bb..df3f204e3a 100644 --- a/docs/resources/r2_bucket.md +++ b/docs/resources/r2_bucket.md @@ -10,10 +10,11 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_r2_bucket" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "terraform-bucket" - location = "enam" +resource "cloudflare_r2_bucket" "example_r2_bucket" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + name = "example-bucket" + location_hint = "apac" + storage_class = "Standard" } ``` @@ -42,5 +43,5 @@ resource "cloudflare_r2_bucket" "example" { Import is supported using the following syntax: ```shell -$ terraform import cloudflare_r2_bucket.default / +$ terraform import cloudflare_r2_bucket.example '/' ``` diff --git a/docs/resources/rate_limit.md b/docs/resources/rate_limit.md index 91f6cf8f88..6623dc90bd 100644 --- a/docs/resources/rate_limit.md +++ b/docs/resources/rate_limit.md @@ -19,47 +19,33 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_rate_limit" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - threshold = 2000 - period = 2 - match = [{ - request = [{ - url_pattern = "${var.cloudflare_zone}/*" - schemes = ["HTTP", "HTTPS"] - methods = ["GET", "POST", "PUT", "DELETE", "PATCH", "HEAD"] +resource "cloudflare_rate_limit" "example_rate_limit" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + action = { + mode = "simulate" + response = { + body = "This request has been rate-limited." + content_type = "text/xml" + } + timeout = 86400 + } + match = { + headers = [{ + name = "Cf-Cache-Status" + op = "eq" + value = "HIT" }] - response = [{ - statuses = [200, 201, 202, 301, 429] - origin_traffic = false - headers = [ - { - name = "Host" - op = "eq" - value = "localhost" - }, - { - name = "X-Example" - op = "ne" - value = "my-example" - } - ] - }] - }] - action = [{ - mode = "simulate" - timeout = 43200 - response = [{ - content_type = "text/plain" - body = "custom response body" - }] - }] - correlate = [{ - by = "nat" - }] - disabled = false - description = "example rate limit for a zone" - bypass_url_patterns = ["example.com/bypass1", "example.com/bypass2"] + request = { + methods = ["GET", "POST"] + schemes = ["HTTP", "HTTPS"] + url = "*.example.org/path*" + } + response = { + origin_traffic = true + } + } + period = 900 + threshold = 60 } ``` @@ -153,5 +139,5 @@ Read-Only: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_rate_limit.example / +$ terraform import cloudflare_rate_limit.example '/' ``` diff --git a/docs/resources/regional_hostname.md b/docs/resources/regional_hostname.md index 1a44aede74..4466b001ed 100644 --- a/docs/resources/regional_hostname.md +++ b/docs/resources/regional_hostname.md @@ -12,24 +12,13 @@ description: |- ## Example Usage ```terraform -# Regionalized hostname record resources are managed independently from the -# Regionalized Hostname resources. -resource "cloudflare_dns_record" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "example.com" - value = "192.0.2.1" - type = "A" - ttl = 3600 -} - -# The cloudflare_regional_hostname resource may exist with or without its -# corresponding record resource. -resource "cloudflare_regional_hostname" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - hostname = "example.com" - region_key = "eu" +resource "cloudflare_regional_hostname" "example_regional_hostname" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + hostname = "foo.example.com" + region_key = "ca" } ``` + ## Schema @@ -44,4 +33,10 @@ resource "cloudflare_regional_hostname" "example" { - `created_on` (String) When the regional hostname was created - `id` (String) DNS hostname to be regionalized, must be a subdomain of the zone. Wildcards are supported for one level, e.g `*.example.com` +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_regional_hostname.example '/' +``` diff --git a/docs/resources/regional_tiered_cache.md b/docs/resources/regional_tiered_cache.md index e0bb1ac0a0..317f80ddd3 100644 --- a/docs/resources/regional_tiered_cache.md +++ b/docs/resources/regional_tiered_cache.md @@ -12,11 +12,12 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_regional_tiered_cache" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - value = "on" +resource "cloudflare_regional_tiered_cache" "example_regional_tiered_cache" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + value = "on" } ``` + ## Schema @@ -38,5 +39,5 @@ resource "cloudflare_regional_tiered_cache" "example" { Import is supported using the following syntax: ```shell -$ terraform import cloudflare_regional_tiered_cache.example +$ terraform import cloudflare_regional_tiered_cache.example '' ``` diff --git a/docs/resources/registrar_domain.md b/docs/resources/registrar_domain.md index 516f56775d..4b16150bad 100644 --- a/docs/resources/registrar_domain.md +++ b/docs/resources/registrar_domain.md @@ -9,6 +9,17 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_registrar_domain" "example_registrar_domain" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + domain_name = "cloudflare.com" + auto_renew = true + locked = false + privacy = true +} +``` ## Schema diff --git a/docs/resources/ruleset.md b/docs/resources/ruleset.md index 8e07f62f26..666b419637 100644 --- a/docs/resources/ruleset.md +++ b/docs/resources/ruleset.md @@ -12,411 +12,55 @@ description: |- ## Example Usage ```terraform -# Magic Transit -resource "cloudflare_ruleset" "magic_transit_example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "account magic transit" - description = "example magic transit ruleset description" - kind = "root" - phase = "magic_transit" - - rules = [{ - action = "allow" - expression = "tcp.dstport in { 32768..65535 }" - description = "Allow TCP Ephemeral Ports" - }] -} - -# Zone-level WAF Managed Ruleset -resource "cloudflare_ruleset" "zone_level_managed_waf" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "managed WAF" - description = "managed WAF ruleset description" - kind = "zone" - phase = "http_request_firewall_managed" - - rules = [{ - action = "execute" - action_parameters = { - id = "efb7b8c949ac4650a09736fc376e9aee" - } - expression = "(http.host eq \"example.host.com\")" - description = "Execute Cloudflare Managed Ruleset on my zone-level phase entry point ruleset" - enabled = true - }] -} - -# Zone-level WAF with tag-based overrides -resource "cloudflare_ruleset" "zone_level_managed_waf_with_category_based_overrides" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "managed WAF with tag-based overrides" - description = "managed WAF with tag-based overrides ruleset description" - kind = "zone" - phase = "http_request_firewall_managed" - - rules = [{ - action = "execute" - action_parameters = { - id = "efb7b8c949ac4650a09736fc376e9aee" - overrides = { categories = [{ - category = "wordpress" - action = "block" - enabled = true - }, - { - category = "joomla" - action = "block" - enabled = true - }] } - } - - expression = "(http.host eq \"example.host.com\")" - description = "overrides to only enable wordpress rules to block" - enabled = false - }] -} - -# Rewrite the URI path component to a static path -resource "cloudflare_ruleset" "transform_uri_rule_path" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "transform rule for URI path" - description = "change the URI path to a new static path" - kind = "zone" - phase = "http_request_transform" - - rules = [{ - action = "rewrite" - action_parameters = { - uri = { - path = { - value = "/my-new-route" - } - } - } - - expression = "(http.host eq \"example.com\" and http.request.uri.path eq \"/old-path\")" - description = "example URI path transform rule" - enabled = true - }] -} - -# Rewrite the URI query component to a static query -resource "cloudflare_ruleset" "transform_uri_rule_query" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "transform rule for URI query parameter" - description = "change the URI query to a new static query" - kind = "zone" - phase = "http_request_transform" - - rules = [{ - action = "rewrite" - action_parameters = { - uri = { - query = { - value = "old=new_again" - } - } - } - - expression = "(http.host eq \"example.host.com\")" - description = "URI transformation query example" - enabled = true - }] -} - -# Rewrite HTTP headers to a modified values -resource "cloudflare_ruleset" "transform_uri_http_headers" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "transform rule for HTTP headers" - description = "modify HTTP headers before reaching origin" - kind = "zone" - phase = "http_request_late_transform" - - rules = [{ - action = "rewrite" - action_parameters = { - headers = [{ - name = "example-http-header-1" - operation = "set" - value = "my-http-header-value-1" - }, - { - name = "example-http-header-2" - operation = "set" - expression = "cf.zone.name" - }, - { - name = "example-http-header-3-to-remove" - operation = "remove" - }] - } - - expression = "(http.host eq \"example.host.com\")" - description = "example request header transform rule" - enabled = false - }] -} - -# HTTP rate limit for an API route -resource "cloudflare_ruleset" "rate_limiting_example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "restrict API requests count" - description = "apply HTTP rate limiting for a route" - kind = "zone" - phase = "http_ratelimit" - +resource "cloudflare_ruleset" "example_ruleset" { + kind = "managed" + name = "My ruleset" + phase = "ddos_l4" rules = [{ + last_updated = "2000-01-01T00:00:00.000000Z" + version = "1" + id = "3a03d665bac047339bb530ecb439a90d" action = "block" - ratelimit = { - characteristics = [ - "cf.colo.id", - "ip.src" - ] - period = 60 - requests_per_period = 100 - mitigation_timeout = 600 - } - - expression = "(http.request.uri.path matches \"^/api/\")" - description = "rate limit for API" - enabled = true - }] -} - -# Change origin for an API route -resource "cloudflare_ruleset" "http_origin_example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "Change to some origin" - description = "Change origin for a route" - kind = "zone" - phase = "http_request_origin" - - rules = [{ - action = "route" action_parameters = { - host_header = "some.host" - origin = { - host = "some.host" - port = 80 - } - } - expression = "(http.request.uri.path matches \"^/api/\")" - description = "change origin to some.host" - enabled = true - }] -} - -# Custom fields logging -resource "cloudflare_ruleset" "custom_fields_logging_example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "log custom fields" - description = "add custom fields to logging" - kind = "zone" - phase = "http_log_custom_fields" - - rules = [{ - action = "log_custom_field" - action_parameters = { - request_fields = [ - "content-type", - "x-forwarded-for", - "host" - ] - response_fields = [ - "server", - "content-type", - "allow" - ] - cookie_fields = [ - "__ga", - "accountNumber", - "__cfruid" - ] - } - - expression = "(http.host eq \"example.host.com\")" - description = "log custom fields rule" - enabled = true - }] -} - -# Custom cache keys + settings -resource "cloudflare_ruleset" "cache_settings_example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "set cache settings" - description = "set cache settings for the request" - kind = "zone" - phase = "http_request_cache_settings" - - rules = [{ - action = "set_cache_settings" - action_parameters = { - edge_ttl = { - mode = "override_origin" - default = 60 - status_code_ttl = [{ - status_code = 200 - value = 50 - }, - { - status_code_range = [{ - from = 201 - to = 300 - }] - value = 30 - }] - } - browser_ttl = { - mode = "respect_origin" - } - serve_stale = { - disable_stale_while_updating = true - } - respect_strong_etags = true - cache_key = { - ignore_query_strings_order = false - cache_deception_armor = true - custom_key = { - query_string = { - exclude = ["*"] - } - header = { - include = ["habc", "hdef"] - check_presence = ["habc_t", "hdef_t"] - exclude_origin = true - } - cookie = { - include = ["cabc", "cdef"] - check_presence = ["cabc_t", "cdef_t"] - } - user = { - device_type = true - geo = false - } - host = { - resolved = true - } - } - } - origin_error_page_passthru = false - } - expression = "(http.host eq \"example.host.com\")" - description = "set cache settings rule" - enabled = true - }] -} - -# Redirects based on a List resource -resource "cloudflare_ruleset" "redirect_from_list_example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "redirects" - description = "Redirect ruleset" - kind = "root" - phase = "http_request_redirect" - - rules = [{ - action = "redirect" - action_parameters = { - from_list = { - name = "redirect_list" - key = "http.request.full_uri" - } - } - expression = "http.request.full_uri in $redirect_list" - description = "Apply redirects from redirect_list" - enabled = true - }] -} - -# Dynamic Redirects from value resource -resource "cloudflare_ruleset" "redirect_from_value_example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "redirects" - description = "Redirect ruleset" - kind = "zone" - phase = "http_request_dynamic_redirect" - - rules = [{ - action = "redirect" - action_parameters = { - from_value = { - status_code = 301 - target_url = { - value = "some_host.com" - } - preserve_query_string = true - } - } - expression = "(http.request.uri.path matches \"^/api/\")" - description = "Apply redirect from value" - enabled = true - }] -} - -# Serve some custom error response -resource "cloudflare_ruleset" "http_custom_error_example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "Serve some error response" - description = "Serve some error response" - kind = "zone" - phase = "http_custom_errors" - rules = [{ - action = "serve_error" - action_parameters = { - content = "some error html" - content_type = "text/html" - status_code = "530" - } - expression = "(http.request.uri.path matches \"^/api/\")" - description = "serve some error response" - enabled = true - }] -} - -# Set Configuration Rules for an API route -resource "cloudflare_ruleset" "http_config_rules_example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "set config rules" - description = "set config rules for request" - kind = "zone" - phase = "http_config_settings" - - rules = [{ - action = "set_config" - action_parameters = { - email_obfuscation = true - bic = true - } - expression = "(http.request.uri.path matches \"^/api/\")" - description = "set config rules for matching request" - enabled = true - }] -} - -# Set compress algorithm for response. -resource "cloudflare_ruleset" "response_compress_brotli_html" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "Brotli response compression for HTML" - description = "Response compression ruleset" - kind = "zone" - phase = "http_response_compression" - - rules = [{ - action = "compress_response" - action_parameters = { - algorithms = [{ - name = "brotli" - }, + response = { + content = < ## Schema @@ -560,18 +204,18 @@ Optional: - `ignore_query_strings_order` (Boolean) Treat requests with the same query parameters the same, regardless of the order those query parameters are in. A value of true ignores the query strings' order. -### Nested Schema for `rules.action_parameters.cache_key.ignore_query_strings_order` +### Nested Schema for `rules.action_parameters.cache_key.custom_key` Optional: -- `cookie` (Attributes) The cookies to include in building the cache key. (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--ignore_query_strings_order--cookie)) -- `header` (Attributes) The header names and values to include in building the cache key. (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--ignore_query_strings_order--header)) -- `host` (Attributes) Whether to use the original host or the resolved host in the cache key. (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--ignore_query_strings_order--host)) -- `query_string` (Attributes) Use the presence or absence of parameters in the query string to build the cache key. (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--ignore_query_strings_order--query_string)) -- `user` (Attributes) Characteristics of the request user agent used in building the cache key. (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--ignore_query_strings_order--user)) +- `cookie` (Attributes) The cookies to include in building the cache key. (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--custom_key--cookie)) +- `header` (Attributes) The header names and values to include in building the cache key. (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--custom_key--header)) +- `host` (Attributes) Whether to use the original host or the resolved host in the cache key. (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--custom_key--host)) +- `query_string` (Attributes) Use the presence or absence of parameters in the query string to build the cache key. (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--custom_key--query_string)) +- `user` (Attributes) Characteristics of the request user agent used in building the cache key. (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--custom_key--user)) - -### Nested Schema for `rules.action_parameters.cache_key.ignore_query_strings_order.cookie` + +### Nested Schema for `rules.action_parameters.cache_key.custom_key.cookie` Optional: @@ -579,8 +223,8 @@ Optional: - `include` (List of String) Include these cookies' names and their values. - -### Nested Schema for `rules.action_parameters.cache_key.ignore_query_strings_order.header` + +### Nested Schema for `rules.action_parameters.cache_key.custom_key.header` Optional: @@ -590,24 +234,24 @@ Optional: - `include` (List of String) Include these headers' names and their values. - -### Nested Schema for `rules.action_parameters.cache_key.ignore_query_strings_order.host` + +### Nested Schema for `rules.action_parameters.cache_key.custom_key.host` Optional: - `resolved` (Boolean) Use the resolved host in the cache key. A value of true will use the resolved host, while a value or false will use the original host. - -### Nested Schema for `rules.action_parameters.cache_key.ignore_query_strings_order.query_string` + +### Nested Schema for `rules.action_parameters.cache_key.custom_key.query_string` Optional: -- `exclude` (Attributes) build the cache key using all query string parameters EXCECPT these excluded parameters (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--ignore_query_strings_order--query_string--exclude)) -- `include` (Attributes) build the cache key using a list of query string parameters that ARE in the request. (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--ignore_query_strings_order--query_string--include)) +- `exclude` (Attributes) build the cache key using all query string parameters EXCECPT these excluded parameters (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--custom_key--query_string--exclude)) +- `include` (Attributes) build the cache key using a list of query string parameters that ARE in the request. (see [below for nested schema](#nestedatt--rules--action_parameters--cache_key--custom_key--query_string--include)) - -### Nested Schema for `rules.action_parameters.cache_key.ignore_query_strings_order.query_string.include` + +### Nested Schema for `rules.action_parameters.cache_key.custom_key.query_string.exclude` Optional: @@ -615,8 +259,8 @@ Optional: - `list` (List of String) A list of query string parameters NOT used to build the cache key. All parameters present in the request but missing in this list will be used to build the cache key. - -### Nested Schema for `rules.action_parameters.cache_key.ignore_query_strings_order.query_string.include` + +### Nested Schema for `rules.action_parameters.cache_key.custom_key.query_string.include` Optional: @@ -625,8 +269,8 @@ Optional: - -### Nested Schema for `rules.action_parameters.cache_key.ignore_query_strings_order.user` + +### Nested Schema for `rules.action_parameters.cache_key.custom_key.user` Optional: @@ -759,7 +403,7 @@ Optional: - `sensitivity_level` (String) A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases. -### Nested Schema for `rules.action_parameters.overrides.sensitivity_level` +### Nested Schema for `rules.action_parameters.overrides.categories` Required: @@ -773,7 +417,7 @@ Optional: -### Nested Schema for `rules.action_parameters.overrides.sensitivity_level` +### Nested Schema for `rules.action_parameters.overrides.rules` Required: @@ -839,7 +483,7 @@ Optional: - `query` (Attributes) Query portion rewrite. (see [below for nested schema](#nestedatt--rules--action_parameters--uri--query)) -### Nested Schema for `rules.action_parameters.uri.query` +### Nested Schema for `rules.action_parameters.uri.path` Optional: @@ -897,9 +541,5 @@ Optional: Import is supported using the following syntax: ```shell -# Import an account scoped Ruleset configuration. -$ terraform import cloudflare_ruleset.example account// - -# Import a zone scoped Ruleset configuration. -$ terraform import cloudflare_ruleset.example zone// +$ terraform import cloudflare_ruleset.example '<{accounts|zones}/{account_id|zone_id}>/' ``` diff --git a/docs/resources/secondary_dns_tsig.md b/docs/resources/secondary_dns_tsig.md deleted file mode 100644 index 991ec905fe..0000000000 --- a/docs/resources/secondary_dns_tsig.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -page_title: "cloudflare_secondary_dns_tsig Resource - Cloudflare" -subcategory: "" -description: |- - ---- - -# cloudflare_secondary_dns_tsig (Resource) - - - - - -## Schema - -### Required - -- `account_id` (String) -- `algo` (String) TSIG algorithm. -- `name` (String) TSIG key name. -- `secret` (String) TSIG secret. - -### Read-Only - -- `id` (String) The ID of this resource. - - diff --git a/docs/resources/spectrum_application.md b/docs/resources/spectrum_application.md index 2aaddd2fb6..88d4ebcf6a 100644 --- a/docs/resources/spectrum_application.md +++ b/docs/resources/spectrum_application.md @@ -12,26 +12,32 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_spectrum_application" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - protocol = "tcp/22" - traffic_type = "direct" - +resource "cloudflare_spectrum_application" "example_spectrum_application" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" dns = { - type = "CNAME" name = "ssh.example.com" + type = "CNAME" } - - origin_direct = [ - "tcp://192.0.2.1:22" - ] - + ip_firewall = true + protocol = "tcp/22" + proxy_protocol = "off" + tls = "off" + traffic_type = "direct" + argo_smart_routing = true edge_ips = { - type = "static" - ips = ["203.0.113.1", "203.0.113.2"] + connectivity = "all" + type = "dynamic" } + origin_direct = ["tcp://127.0.0.1:8080"] + origin_dns = { + name = "origin.example.com" + ttl = 600 + type = "" + } + origin_port = 22 } ``` + ## Schema @@ -95,5 +101,5 @@ Optional: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_spectrum_application.example / +$ terraform import cloudflare_spectrum_application.example '/' ``` diff --git a/docs/resources/stream.md b/docs/resources/stream.md index 26f4528f07..9ad79c719d 100644 --- a/docs/resources/stream.md +++ b/docs/resources/stream.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_stream" "example_stream" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema diff --git a/docs/resources/stream_audio_track.md b/docs/resources/stream_audio_track.md index 7c3791e57b..c216c56bd6 100644 --- a/docs/resources/stream_audio_track.md +++ b/docs/resources/stream_audio_track.md @@ -9,6 +9,17 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_stream_audio_track" "example_stream_audio_track" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + identifier = "ea95132c15732412d22c1476fa83f27a" + audio_identifier = "ea95132c15732412d22c1476fa83f27a" + default = true + label = "director commentary" +} +``` ## Schema diff --git a/docs/resources/stream_caption_language.md b/docs/resources/stream_caption_language.md index aef5db5922..189eadd217 100644 --- a/docs/resources/stream_caption_language.md +++ b/docs/resources/stream_caption_language.md @@ -9,6 +9,15 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_stream_caption_language" "example_stream_caption_language" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + identifier = "ea95132c15732412d22c1476fa83f27a" + language = "tr" +} +``` ## Schema diff --git a/docs/resources/stream_download.md b/docs/resources/stream_download.md index 9478cc1ea6..9f18e97b85 100644 --- a/docs/resources/stream_download.md +++ b/docs/resources/stream_download.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_stream_download" "example_stream_download" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + identifier = "ea95132c15732412d22c1476fa83f27a" +} +``` ## Schema diff --git a/docs/resources/stream_key.md b/docs/resources/stream_key.md index 2ee8c0bb39..d3f289613c 100644 --- a/docs/resources/stream_key.md +++ b/docs/resources/stream_key.md @@ -9,6 +9,13 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_stream_key" "example_stream_key" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" +} +``` ## Schema @@ -24,4 +31,10 @@ description: |- - `jwk` (String) The signing key in JWK format. - `pem` (String) The signing key in PEM format. +## Import + +Import is supported using the following syntax: +```shell +$ terraform import cloudflare_stream_key.example '' +``` diff --git a/docs/resources/stream_live_input.md b/docs/resources/stream_live_input.md index 425c013827..115654037e 100644 --- a/docs/resources/stream_live_input.md +++ b/docs/resources/stream_live_input.md @@ -9,6 +9,25 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_stream_live_input" "example_stream_live_input" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + default_creator = "defaultCreator" + delete_recording_after_days = 45 + meta = { + name = "test stream 1" + } + recording = { + allowed_origins = ["example.com"] + hide_live_viewer_count = false + mode = "off" + require_signed_urls = false + timeout_seconds = 0 + } +} +``` ## Schema diff --git a/docs/resources/stream_watermark.md b/docs/resources/stream_watermark.md index e4785338d2..a0c5752cc9 100644 --- a/docs/resources/stream_watermark.md +++ b/docs/resources/stream_watermark.md @@ -9,6 +9,19 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_stream_watermark" "example_stream_watermark" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + file = "@/Users/rchen/Downloads/watermark.png" + name = "Marketing Videos" + opacity = 0.75 + padding = 0.1 + position = "center" + scale = 0.1 +} +``` ## Schema diff --git a/docs/resources/stream_webhook.md b/docs/resources/stream_webhook.md index 1dc3b52d31..92d5c94da5 100644 --- a/docs/resources/stream_webhook.md +++ b/docs/resources/stream_webhook.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_stream_webhook" "example_stream_webhook" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + notification_url = "https://example.com" +} +``` ## Schema diff --git a/docs/resources/tiered_cache.md b/docs/resources/tiered_cache.md index 7621d0f8ab..e0aa799e63 100644 --- a/docs/resources/tiered_cache.md +++ b/docs/resources/tiered_cache.md @@ -12,11 +12,12 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_tiered_cache" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - cache_type = "smart" +resource "cloudflare_tiered_cache" "example_tiered_cache" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + value = "on" } ``` + ## Schema @@ -31,4 +32,10 @@ resource "cloudflare_tiered_cache" "example" { - `id` (String) Identifier - `modified_on` (String) The time when the setting was last modified +## Import + +Import is supported using the following syntax: +```shell +$ terraform import cloudflare_tiered_cache.example '' +``` diff --git a/docs/resources/total_tls.md b/docs/resources/total_tls.md index e1a8a54c9e..7ce10ac3c8 100644 --- a/docs/resources/total_tls.md +++ b/docs/resources/total_tls.md @@ -12,12 +12,13 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_total_tls" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - enabled = true - certificate_authority = "lets_encrypt" +resource "cloudflare_total_tls" "example_total_tls" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + enabled = true + certificate_authority = "google" } ``` + ## Schema @@ -40,5 +41,5 @@ resource "cloudflare_total_tls" "example" { Import is supported using the following syntax: ```shell -$ terraform import cloudflare_total_tls.example +$ terraform import cloudflare_total_tls.example '' ``` diff --git a/docs/resources/turnstile_widget.md b/docs/resources/turnstile_widget.md index 99a4b63520..fa14b7e8af 100644 --- a/docs/resources/turnstile_widget.md +++ b/docs/resources/turnstile_widget.md @@ -12,15 +12,19 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_turnstile_widget" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "example widget" +resource "cloudflare_turnstile_widget" "example_turnstile_widget" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + domains = ["203.0.113.1", "cloudflare.com", "blog.example.com"] + mode = "non-interactive" + name = "blog.cloudflare.com login form" bot_fight_mode = false - domains = ["example.com"] - mode = "invisible" - region = "world" + clearance_level = "no_clearance" + ephemeral_id = false + offlabel = false + region = "world" } ``` + ## Schema @@ -56,5 +60,5 @@ this setting can determine the clearance level to be set Import is supported using the following syntax: ```shell -$ terraform import cloudflare_turnstile_widget.example / +$ terraform import cloudflare_turnstile_widget.example '/' ``` diff --git a/docs/resources/url_normalization_settings.md b/docs/resources/url_normalization_settings.md index 3f7b40ad58..6378787b15 100644 --- a/docs/resources/url_normalization_settings.md +++ b/docs/resources/url_normalization_settings.md @@ -12,12 +12,13 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_url_normalization_settings" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - type = "cloudflare" - scope = "incoming" +resource "cloudflare_url_normalization_settings" "example_url_normalization_settings" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + scope = "incoming" + type = "cloudflare" } ``` + ## Schema @@ -34,4 +35,10 @@ resource "cloudflare_url_normalization_settings" "example" { - `id` (String) Identifier +## Import + +Import is supported using the following syntax: +```shell +$ terraform import cloudflare_url_normalization_settings.example '' +``` diff --git a/docs/resources/user_agent_blocking_rule.md b/docs/resources/user_agent_blocking_rule.md index 8cc4b30dc3..fd587b9e2c 100644 --- a/docs/resources/user_agent_blocking_rule.md +++ b/docs/resources/user_agent_blocking_rule.md @@ -12,28 +12,16 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_user_agent_blocking_rule" "example_1" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - mode = "js_challenge" - paused = false - description = "My description 1" - configuration = [{ - target = "ua" - value = "Chrome" - }] -} - -resource "cloudflare_user_agent_blocking_rule" "example_2" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - mode = "challenge" - paused = true - description = "My description 22" - configuration = [{ - target = "ua" - value = "Mozilla" - }] +resource "cloudflare_user_agent_blocking_rule" "example_user_agent_blocking_rule" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + configuration = { + target = "ip" + value = "198.51.100.4" + } + mode = "block" } ``` + ## Schema @@ -55,10 +43,4 @@ Optional: - `target` (String) The configuration target. You must set the target to `ip` when specifying an IP address in the rule. - `value` (String) The IP address to match. This address will be compared to the IP address of incoming requests. -## Import -Import is supported using the following syntax: - -```shell -$ terraform import cloudflare_user_agent_blocking_rule.example / -``` diff --git a/docs/resources/waiting_room.md b/docs/resources/waiting_room.md index e271006a78..067a31ccea 100644 --- a/docs/resources/waiting_room.md +++ b/docs/resources/waiting_room.md @@ -12,28 +12,36 @@ description: |- ## Example Usage ```terraform -# Waiting Room -resource "cloudflare_waiting_room" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "foo" - host = "foo.example.com" - path = "/" +resource "cloudflare_waiting_room" "example_waiting_room" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + host = "shop.example.com" + name = "production_webinar" new_users_per_minute = 200 - total_active_users = 200 - cookie_suffix = "queue1" - + total_active_users = 200 additional_routes = [{ - host = "shop1.example.com" - path = "/example-path" - }, - { - host = "shop2.example.com" + host = "shop2.example.com" + path = "/shop2/checkout" }] - - + cookie_attributes = { + samesite = "auto" + secure = "auto" + } + cookie_suffix = "abcd" + custom_page_html = "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}" + default_template_language = "en-US" + description = "Production - DO NOT MODIFY" + disable_session_renewal = false + enabled_origin_commands = ["revoke"] + json_response_enabled = false + path = "/shop/checkout" + queue_all = true + queueing_method = "fifo" queueing_status_code = 200 + session_duration = 1 + suspended = true } ``` + ## Schema @@ -51,12 +59,12 @@ resource "cloudflare_waiting_room" "example" { - `cookie_attributes` (Attributes) Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position. (see [below for nested schema](#nestedatt--cookie_attributes)) - `cookie_suffix` (String) Appends a '_' + a custom suffix to the end of Cloudflare Waiting Room's cookie name(__cf_waitingroom). If `cookie_suffix` is "abcd", the cookie name will be `__cf_waitingroom_abcd`. This field is required if using `additional_routes`. - `custom_page_html` (String) Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge: -1. waitTimeKnown Acts like a boolean value that indicates the behavior to take when wait time is not available, for instance when queue_all is **true**. -2. waitTimeFormatted Estimated wait time for the user. For example, five minutes. Alternatively, you can use: -3. waitTime Number of minutes of estimated wait for a user. -4. waitTimeHours Number of hours of estimated wait for a user (`Math.floor(waitTime/60)`). -5. waitTimeHourMinutes Number of minutes above the `waitTimeHours` value (`waitTime%60`). -6. queueIsFull Changes to **true** when no more people can be added to the queue. +1. {{`waitTimeKnown`}} Acts like a boolean value that indicates the behavior to take when wait time is not available, for instance when queue_all is **true**. +2. {{`waitTimeFormatted`}} Estimated wait time for the user. For example, five minutes. Alternatively, you can use: +3. {{`waitTime`}} Number of minutes of estimated wait for a user. +4. {{`waitTimeHours`}} Number of hours of estimated wait for a user (`Math.floor(waitTime/60)`). +5. {{`waitTimeHourMinutes`}} Number of minutes above the `waitTimeHours` value (`waitTime%60`). +6. {{`queueIsFull`}} Changes to **true** when no more people can be added to the queue. To view the full list of variables, look at the `cfWaitingRoom` object described under the `json_response_enabled` property in other Waiting Room API calls. - `default_template_language` (String) The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used. @@ -193,6 +201,5 @@ Optional: Import is supported using the following syntax: ```shell -# Use the Zone ID and Waiting Room ID to import. -$ terraform import cloudflare_waiting_room.default / +$ terraform import cloudflare_waiting_room.example '/' ``` diff --git a/docs/resources/waiting_room_event.md b/docs/resources/waiting_room_event.md index 608028010b..54f6753d2c 100644 --- a/docs/resources/waiting_room_event.md +++ b/docs/resources/waiting_room_event.md @@ -12,15 +12,25 @@ description: |- ## Example Usage ```terraform -# Waiting Room Event -resource "cloudflare_waiting_room_event" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - waiting_room_id = "d41d8cd98f00b204e9800998ecf8427e" - name = "foo" - event_start_time = "2006-01-02T15:04:05Z" - event_end_time = "2006-01-02T20:04:05Z" +resource "cloudflare_waiting_room_event" "example_waiting_room_event" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + waiting_room_id = "699d98642c564d2e855e9661899b7252" + event_end_time = "2021-09-28T17:00:00.000Z" + event_start_time = "2021-09-28T15:30:00.000Z" + name = "production_webinar_event" + custom_page_html = "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}" + description = "Production event - DO NOT MODIFY" + disable_session_renewal = true + new_users_per_minute = 200 + prequeue_start_time = "2021-09-28T15:00:00.000Z" + queueing_method = "random" + session_duration = 1 + shuffle_at_event_start = true + suspended = true + total_active_users = 200 } ``` + ## Schema @@ -56,6 +66,5 @@ resource "cloudflare_waiting_room_event" "example" { Import is supported using the following syntax: ```shell -# Use the Zone ID, Waiting Room ID, and Event ID to import. -$ terraform import cloudflare_waiting_room_event.default // +$ terraform import cloudflare_waiting_room_event.example '//' ``` diff --git a/docs/resources/waiting_room_rules.md b/docs/resources/waiting_room_rules.md index 54461387f8..2ec927fbd6 100644 --- a/docs/resources/waiting_room_rules.md +++ b/docs/resources/waiting_room_rules.md @@ -12,25 +12,18 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_waiting_room_rules" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - waiting_room_id = "d41d8cd98f00b204e9800998ecf8427e" - +resource "cloudflare_waiting_room_rules" "example_waiting_room_rules" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + waiting_room_id = "699d98642c564d2e855e9661899b7252" rules = [{ - description = "bypass ip list" - expression = "src.ip in {192.0.2.0 192.0.2.1}" - action = "bypass_waiting_room" - status = "enabled" - }, - { - description = "bypass query string" - expression = "http.request.uri.query contains \"bypass=true\"" - action = "bypass_waiting_room" - status = "enabled" + action = "bypass_waiting_room" + expression = "ip.src in {10.20.30.40}" + description = "allow all traffic from 10.20.30.40" + enabled = true }] - } ``` + ## Schema @@ -57,10 +50,4 @@ Optional: - `description` (String) The description of the rule. - `enabled` (Boolean) When set to true, the rule is enabled. -## Import -Import is supported using the following syntax: - -```shell -$ terraform import cloudflare_waiting_room_event.default / -``` diff --git a/docs/resources/waiting_room_settings.md b/docs/resources/waiting_room_settings.md index a4e47156a0..cbaf5a3ea9 100644 --- a/docs/resources/waiting_room_settings.md +++ b/docs/resources/waiting_room_settings.md @@ -12,11 +12,12 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_waiting_room_settings" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" +resource "cloudflare_waiting_room_settings" "example_waiting_room_settings" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" search_engine_crawler_bypass = true } ``` + ## Schema @@ -39,5 +40,5 @@ and will not appear in waiting room analytics. Import is supported using the following syntax: ```shell -$ terraform import cloudflare_waiting_room_settings.example +$ terraform import cloudflare_waiting_room_settings.example '' ``` diff --git a/docs/resources/web3_hostname.md b/docs/resources/web3_hostname.md index c177aa3577..9ba1df4310 100644 --- a/docs/resources/web3_hostname.md +++ b/docs/resources/web3_hostname.md @@ -9,6 +9,17 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_web3_hostname" "example_web3_hostname" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + name = "gateway.example.com" + target = "ethereum" + description = "This is my IPFS gateway." + dnslink = "/ipns/onboarding.ipfs.cloudflare.com" +} +``` ## Schema @@ -31,4 +42,10 @@ description: |- - `modified_on` (String) - `status` (String) Status of the hostname's activation. +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_web3_hostname.example '/' +``` diff --git a/docs/resources/web_analytics_rule.md b/docs/resources/web_analytics_rule.md index 2e7672f6cc..7a5799a13d 100644 --- a/docs/resources/web_analytics_rule.md +++ b/docs/resources/web_analytics_rule.md @@ -12,22 +12,16 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_web_analytics_site" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - zone_tag = "0da42c8d2132a9ddaf714f9e7c920711" - auto_install = true -} - -resource "cloudflare_web_analytics_rule" "example" { - depends_on = [cloudflare_web_analytics_site.example] - account_id = "f037e56e89293a057740de681ac9abbe" - ruleset_id = cloudflare_web_analytics_site.example.ruleset_id - host = "*" - paths = ["/excluded"] - inclusive = false - is_paused = false +resource "cloudflare_web_analytics_rule" "example_web_analytics_rule" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + ruleset_id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" + host = "example.com" + inclusive = true + is_paused = false + paths = ["*"] } ``` + ## Schema @@ -49,10 +43,4 @@ resource "cloudflare_web_analytics_rule" "example" { - `id` (String) The Web Analytics rule identifier. - `priority` (Number) -## Import -Import is supported using the following syntax: - -```shell -$ terraform import cloudflare_web_analytics_rule.example // -``` diff --git a/docs/resources/web_analytics_site.md b/docs/resources/web_analytics_site.md index e71fd572a6..b6d3cd727c 100644 --- a/docs/resources/web_analytics_site.md +++ b/docs/resources/web_analytics_site.md @@ -12,12 +12,14 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_web_analytics_site" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - zone_tag = "0da42c8d2132a9ddaf714f9e7c920711" +resource "cloudflare_web_analytics_site" "example_web_analytics_site" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" auto_install = true + host = "example.com" + zone_tag = "023e105f4ecef8ad9ca31a8372d0c353" } ``` + ## Schema @@ -70,5 +72,5 @@ Read-Only: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_web_analytics_site.example / +$ terraform import cloudflare_web_analytics_site.example '/' ``` diff --git a/docs/resources/workers_cron_trigger.md b/docs/resources/workers_cron_trigger.md index db54d23bd0..7215caaf61 100644 --- a/docs/resources/workers_cron_trigger.md +++ b/docs/resources/workers_cron_trigger.md @@ -12,21 +12,17 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_workers_script" "example_script" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "example-script" - content = file("path/to/my.js") -} - -resource "cloudflare_workers_cron_trigger" "example_trigger" { - account_id = "f037e56e89293a057740de681ac9abbe" - script_name = cloudflare_workers_script.example_script.name - schedules = [ - "*/5 * * * *", # every 5 minutes - "10 7 * * mon-fri", # 7:10am every weekday - ] +resource "cloudflare_workers_cron_trigger" "example_workers_cron_trigger" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + script_name = "this-is_my_script-01" + body = [{ + created_on = "created_on" + cron = "*/30 * * * *" + modified_on = "modified_on" + }] } ``` + ## Schema @@ -52,5 +48,5 @@ Required: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_workers_cron_trigger.example / +$ terraform import cloudflare_workers_cron_trigger.example '/' ``` diff --git a/docs/resources/workers_custom_domain.md b/docs/resources/workers_custom_domain.md index 3f4e75240a..8ee6f87e89 100644 --- a/docs/resources/workers_custom_domain.md +++ b/docs/resources/workers_custom_domain.md @@ -9,6 +9,17 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_workers_custom_domain" "example_workers_custom_domain" { + account_id = "9a7806061c88ada191ed06f989cc3dac" + environment = "production" + hostname = "foo.example.com" + service = "foo" + zone_id = "593c9c94de529bbbfaac7c53ced0447d" +} +``` ## Schema @@ -26,4 +37,10 @@ description: |- - `id` (String) Identifer of the Worker Domain. - `zone_name` (String) Name of the zone. +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_workers_custom_domain.example '/' +``` diff --git a/docs/resources/workers_deployment.md b/docs/resources/workers_deployment.md index 979b781377..83f18329a1 100644 --- a/docs/resources/workers_deployment.md +++ b/docs/resources/workers_deployment.md @@ -9,6 +9,22 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_workers_deployment" "example_workers_deployment" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + script_name = "this-is_my_script-01" + strategy = "percentage" + versions = [{ + percentage = 100 + version_id = "bcf48806-b317-4351-9ee7-36e7d557d4de" + }] + annotations = { + workers_message = "Deploy bug fix." + } +} +``` ## Schema @@ -78,4 +94,10 @@ Read-Only: - `percentage` (Number) - `version_id` (String) +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_workers_deployment.example '/' +``` diff --git a/docs/resources/workers_for_platforms_dispatch_namespace.md b/docs/resources/workers_for_platforms_dispatch_namespace.md index 3a909c359c..128125e17d 100644 --- a/docs/resources/workers_for_platforms_dispatch_namespace.md +++ b/docs/resources/workers_for_platforms_dispatch_namespace.md @@ -12,19 +12,12 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_workers_for_platforms_dispatch_namespace" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "example-namespace" -} - -resource "cloudflare_workers_script" "customer_worker_1" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "customer-worker-1" - content = file("script.js") - dispatch_namespace = cloudflare_workers_for_platforms_dispatch_namespace.example.name - tags = ["free"] +resource "cloudflare_workers_for_platforms_dispatch_namespace" "example_workers_for_platforms_dispatch_namespace" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + name = "my-dispatch-namespace" } ``` + ## Schema @@ -52,5 +45,5 @@ resource "cloudflare_workers_script" "customer_worker_1" { Import is supported using the following syntax: ```shell -$ terraform import cloudflare_workers_for_platforms_dispatch_namespace.example / +$ terraform import cloudflare_workers_for_platforms_dispatch_namespace.example '/' ``` diff --git a/docs/resources/workers_kv.md b/docs/resources/workers_kv.md index 9e323aedde..baa91ac1bd 100644 --- a/docs/resources/workers_kv.md +++ b/docs/resources/workers_kv.md @@ -12,18 +12,15 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_workers_kv_namespace" "example_ns" { - account_id = "f037e56e89293a057740de681ac9abbe" - title = "test-namespace" -} - -resource "cloudflare_workers_kv" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - namespace_id = cloudflare_workers_kv_namespace.example_ns.id - key = "test-key" - value = "test value" +resource "cloudflare_workers_kv" "example_workers_kv" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + namespace_id = "0f2ac74b498b48028cb68387c421e279" + key_name = "My-Key" + metadata = "{\"someMetadataKey\": \"someMetadataValue\"}" + value = "Some Value" } ``` + ## Schema @@ -47,5 +44,5 @@ resource "cloudflare_workers_kv" "example" { Import is supported using the following syntax: ```shell -$ terraform import cloudflare_workers_kv.example // +$ terraform import cloudflare_workers_kv.example '//' ``` diff --git a/docs/resources/workers_kv_namespace.md b/docs/resources/workers_kv_namespace.md index 53d0bf8c7f..87788ad8a9 100644 --- a/docs/resources/workers_kv_namespace.md +++ b/docs/resources/workers_kv_namespace.md @@ -12,11 +12,12 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_workers_kv_namespace" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - title = "test-namespace" +resource "cloudflare_workers_kv_namespace" "example_workers_kv_namespace" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + title = "My Own Namespace" } ``` + ## Schema @@ -35,5 +36,5 @@ resource "cloudflare_workers_kv_namespace" "example" { Import is supported using the following syntax: ```shell -$ terraform import cloudflare_workers_kv_namespace.example / +$ terraform import cloudflare_workers_kv_namespace.example '/' ``` diff --git a/docs/resources/workers_script.md b/docs/resources/workers_script.md index ca700080b4..bf8ae1b03d 100644 --- a/docs/resources/workers_script.md +++ b/docs/resources/workers_script.md @@ -12,54 +12,67 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_workers_kv_namespace" "my_namespace" { - account_id = "f037e56e89293a057740de681ac9abbe" - title = "example" -} - -# Sets the script with the name "script_1" -resource "cloudflare_workers_script" "my_script" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "script_1" - content = file("script.js") - - kv_namespace_binding = [{ - name = "MY_EXAMPLE_KV_NAMESPACE" - namespace_id = cloudflare_workers_kv_namespace.my_namespace.id - }] - - plain_text_binding = [{ - name = "MY_EXAMPLE_PLAIN_TEXT" - text = "foobar" - }] - - secret_text_binding = [{ - name = "MY_EXAMPLE_SECRET_TEXT" - text = var.secret_foo_value - }] - - webassembly_binding = [{ - name = "MY_EXAMPLE_WASM" - module = filebase64("example.wasm") - }] - - service_binding = [{ - name = "MY_SERVICE_BINDING" - service = "MY_SERVICE" - environment = "production" - }] - - r2_bucket_binding = [{ - name = "MY_BUCKET" - bucket_name = "MY_BUCKET_NAME" - }] - - analytics_engine_binding = [{ - name = "MY_DATASET" - dataset = "dataset1" - }] +resource "cloudflare_workers_script" "example_workers_script" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + script_name = "this-is_my_script-01" + any_part_name = ["file.txt"] + metadata = { + assets = { + config = { + html_handling = "auto-trailing-slash" + not_found_handling = "none" + serve_directly = true + } + jwt = "jwt" + } + bindings = [{ + name = "MY_ENV_VAR" + type = "plain_text" + }] + body_part = "worker.js" + compatibility_date = "2023-07-25" + compatibility_flags = ["string"] + keep_assets = false + keep_bindings = ["string"] + logpush = false + main_module = "worker.js" + migrations = { + deleted_classes = ["string"] + new_classes = ["string"] + new_sqlite_classes = ["string"] + new_tag = "v2" + old_tag = "v1" + renamed_classes = [{ + from = "from" + to = "to" + }] + transferred_classes = [{ + from = "from" + from_script = "from_script" + to = "to" + }] + } + observability = { + enabled = true + head_sampling_rate = 0.1 + } + placement = { + mode = "smart" + } + tags = ["string"] + tail_consumers = [{ + service = "my-log-consumer" + environment = "production" + namespace = "my-namespace" + }] + usage_model = "bundled" + version_tags = { + foo = "string" + } + } } ``` + ## Schema @@ -125,6 +138,7 @@ Optional: - `html_handling` (String) Determines the redirects and rewrites of requests for HTML content. - `not_found_handling` (String) Determines the response when a request does not match a static asset, and there is no Worker script. +- `serve_directly` (Boolean) When true and the incoming request matches an asset, that will be served instead of invoking the Worker script. When false, requests will always invoke the Worker script. @@ -172,7 +186,7 @@ Optional: - `transferred_classes` (Attributes List) A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker. (see [below for nested schema](#nestedatt--metadata--migrations--steps--transferred_classes)) -### Nested Schema for `metadata.migrations.steps.transferred_classes` +### Nested Schema for `metadata.migrations.steps.renamed_classes` Optional: @@ -250,5 +264,5 @@ Read-Only: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_workers_script.example / +$ terraform import cloudflare_workers_script.example '/' ``` diff --git a/docs/resources/workers_script_subdomain.md b/docs/resources/workers_script_subdomain.md index 40820816d0..8e90eaf4c0 100644 --- a/docs/resources/workers_script_subdomain.md +++ b/docs/resources/workers_script_subdomain.md @@ -9,6 +9,16 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_workers_script_subdomain" "example_workers_script_subdomain" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + script_name = "this-is_my_script-01" + enabled = true + previews_enabled = true +} +``` ## Schema diff --git a/docs/resources/workers_secret.md b/docs/resources/workers_secret.md index 7b765a9575..dd8169aeeb 100644 --- a/docs/resources/workers_secret.md +++ b/docs/resources/workers_secret.md @@ -12,13 +12,16 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_workers_secret" "my_secret" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "MY_EXAMPLE_SECRET_TEXT" - script_name = "script_1" - secret_text = "my_secret_value" +resource "cloudflare_workers_secret" "example_workers_secret" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + dispatch_namespace = "my-dispatch-namespace" + script_name = "this-is_my_script-01" + name = "MY_SECRET" + text = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9" + type = "secret_text" } ``` + ## Schema @@ -43,5 +46,5 @@ resource "cloudflare_workers_secret" "my_secret" { Import is supported using the following syntax: ```shell -$ terraform import cloudflare_workers_secret.example // +$ terraform import cloudflare_workers_secret.example '///' ``` diff --git a/docs/resources/zero_trust_access_application.md b/docs/resources/zero_trust_access_application.md index 478a5e17d4..ebeb0150ec 100644 --- a/docs/resources/zero_trust_access_application.md +++ b/docs/resources/zero_trust_access_application.md @@ -12,38 +12,86 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_zero_trust_access_application" "staging_app" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "staging application" - domain = "staging.example.com" - type = "self_hosted" - session_duration = "24h" - auto_redirect_to_identity = false - policies = [ - cloudflare_zero_trust_access_policy.example_1.id, - cloudflare_zero_trust_access_policy.example_2.id - ] -} - -# With CORS configuration -resource "cloudflare_zero_trust_access_application" "staging_app" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "staging application" - domain = "staging.example.com" - type = "self_hosted" - session_duration = "24h" - policies = [ - cloudflare_zero_trust_access_policy.example_1.id, - cloudflare_zero_trust_access_policy.example_2.id - ] +resource "cloudflare_zero_trust_access_application" "example_zero_trust_access_application" { + domain = "test.example.com/admin" + type = "self_hosted" + zone_id = "zone_id" + allow_authenticate_via_warp = true + allowed_idps = ["699d98642c564d2e855e9661899b7252"] + app_launcher_visible = true + auto_redirect_to_identity = true cors_headers = { - allowed_methods = ["GET", "POST", "OPTIONS"] - allowed_origins = ["https://example.com"] + allow_all_headers = true + allow_all_methods = true + allow_all_origins = true allow_credentials = true - max_age = 10 + allowed_headers = ["string"] + allowed_methods = ["GET"] + allowed_origins = ["https://example.com"] + max_age = -1 } + custom_deny_message = "custom_deny_message" + custom_deny_url = "custom_deny_url" + custom_non_identity_deny_url = "custom_non_identity_deny_url" + custom_pages = ["699d98642c564d2e855e9661899b7252"] + destinations = [{ + type = "public" + uri = "test.example.com/admin" + }, { + type = "public" + uri = "test.anotherexample.com/staff" + }, { + type = "public" + uri = "10.5.0.2" + }, { + type = "public" + uri = "10.5.0.3/32:1234-4321" + }, { + type = "public" + uri = "private-sni.example.com" + }] + enable_binding_cookie = true + http_only_cookie_attribute = true + logo_url = "https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg" + name = "Admin Site" + options_preflight_bypass = true + path_cookie_attribute = true + policies = [{ + id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" + precedence = 0 + }] + same_site_cookie_attribute = "strict" + scim_config = { + idp_uid = "idp_uid" + remote_uri = "remote_uri" + authentication = { + password = "password" + scheme = "httpbasic" + user = "user" + } + deactivate_on_delete = true + enabled = true + mappings = [{ + schema = "urn:ietf:params:scim:schemas:core:2.0:User" + enabled = true + filter = "title pr or userType eq \"Intern\"" + operations = { + create = true + delete = true + update = true + } + strictness = "strict" + transform_jsonata = "$merge([$, {\'userName\': $substringBefore($.userName, \'@\') & \'+test@\' & $substringAfter($.userName, \'@\')}])" + }] + } + self_hosted_domains = ["test.example.com/admin", "test.anotherexample.com/staff"] + service_auth_401_redirect = true + session_duration = "24h" + skip_interstitial = true + tags = ["engineers"] } ``` + ## Schema @@ -911,5 +959,5 @@ Required: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_zero_trust_access_application.example / +$ terraform import cloudflare_zero_trust_access_application.example '<{accounts|zones}/{account_id|zone_id}>/' ``` diff --git a/docs/resources/zero_trust_access_custom_page.md b/docs/resources/zero_trust_access_custom_page.md index fc2ca041b1..7cf4ef9239 100644 --- a/docs/resources/zero_trust_access_custom_page.md +++ b/docs/resources/zero_trust_access_custom_page.md @@ -12,13 +12,15 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_zero_trust_access_custom_page" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "example" - type = "forbidden" - custom_html = "

Forbidden

" +resource "cloudflare_zero_trust_access_custom_page" "example_zero_trust_access_custom_page" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + custom_html = "

Access Denied

" + name = "name" + type = "identity_denied" + app_count = 0 } ``` + ## Schema @@ -40,4 +42,10 @@ resource "cloudflare_zero_trust_access_custom_page" "example" { - `uid` (String) UUID - `updated_at` (String) +## Import + +Import is supported using the following syntax: +```shell +$ terraform import cloudflare_zero_trust_access_custom_page.example '/' +``` diff --git a/docs/resources/zero_trust_access_group.md b/docs/resources/zero_trust_access_group.md index f76a680d1e..698347e123 100644 --- a/docs/resources/zero_trust_access_group.md +++ b/docs/resources/zero_trust_access_group.md @@ -12,44 +12,28 @@ description: |- ## Example Usage ```terraform -# Allowing access to `test@example.com` email address only -resource "cloudflare_zero_trust_access_group" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "staging group" - +resource "cloudflare_zero_trust_access_group" "example_zero_trust_access_group" { include = [{ - email = ["test@example.com"] + group = { + id = "aa0a4aab-672b-4bdb-bc33-a59f1130a11f" + } }] -} - -# Allowing `test@example.com` to access but only when coming from a -# specific IP. -resource "cloudflare_zero_trust_access_group" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "staging group" - - include = [{ - email = ["test@example.com"] + name = "Allow devs" + zone_id = "zone_id" + exclude = [{ + group = { + id = "aa0a4aab-672b-4bdb-bc33-a59f1130a11f" + } }] - + is_default = true require = [{ - ip = [var.office_ip] - }] -} - -# Allow members of an Azure Group. The ID is the group UUID (id) in Azure. -resource "cloudflare_zero_trust_access_group" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "test_group" - - include = [{ - azure = [{ - identity_provider_id = "ca298b82-93b5-41bf-bc2d-10493f09b761" - id = ["86773093-5feb-48dd-814b-7ccd3676ff50"] - }] + group = { + id = "aa0a4aab-672b-4bdb-bc33-a59f1130a11f" + } }] } ``` + ## Schema @@ -666,5 +650,5 @@ Required: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_zero_trust_access_group.example / +$ terraform import cloudflare_zero_trust_access_group.example '<{accounts|zones}/{account_id|zone_id}>/' ``` diff --git a/docs/resources/zero_trust_access_identity_provider.md b/docs/resources/zero_trust_access_identity_provider.md index a2d198da27..6647921923 100644 --- a/docs/resources/zero_trust_access_identity_provider.md +++ b/docs/resources/zero_trust_access_identity_provider.md @@ -12,51 +12,30 @@ description: |- ## Example Usage ```terraform -# one time pin -resource "cloudflare_zero_trust_access_identity_provider" "pin_login" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "PIN login" - type = "onetimepin" -} - -# oauth -resource "cloudflare_zero_trust_access_identity_provider" "github_oauth" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "GitHub OAuth" - type = "github" - config = { - client_id = "example" - client_secret = "secret_key" - } -} - -# saml -resource "cloudflare_zero_trust_access_identity_provider" "jumpcloud_saml" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "JumpCloud SAML" - type = "saml" +resource "cloudflare_zero_trust_access_identity_provider" "example_zero_trust_access_identity_provider" { config = { - issuer_url = "jumpcloud" - sso_target_url = "https://sso.myexample.jumpcloud.com/saml2/cloudflareaccess" - attributes = ["email", "username"] - sign_request = false - idp_public_cert = "MIIDpDCCAoygAwIBAgIGAV2ka+55MA0GCSqGSIb3DQEBCwUAMIGSMQswCQ...GF/Q2/MHadws97cZg\nuTnQyuOqPuHbnN83d/2l1NSYKCbHt24o" + claims = ["email_verified", "preferred_username", "custom_claim_name"] + client_id = "" + client_secret = "" + conditional_access_enabled = true + directory_id = "" + email_claim_name = "custom_claim_name" + prompt = "login" + support_groups = true } -} - -# okta -resource "cloudflare_zero_trust_access_identity_provider" "okta" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "Okta" - type = "okta" - config = { - client_id = "example" - client_secret = "secret_key" - api_token = "okta_api_token" - okta_account = "https://example.com" + name = "Widget Corps IDP" + type = "onetimepin" + zone_id = "zone_id" + scim_config = { + enabled = true + identity_update_behavior = "automatic" + seat_deprovision = true + secret = "secret" + user_deprovision = true } } ``` + ## Schema @@ -101,6 +80,7 @@ Optional: - `okta_account` (String) Your okta account url - `onelogin_account` (String) Your OneLogin account url - `ping_env_id` (String) Your PingOne environment identifier +- `pkce_enabled` (Boolean) Enable Proof Key for Code Exchange (PKCE) - `prompt` (String) Indicates the type of user interaction that is required. prompt=login forces the user to enter their credentials on that request, negating single-sign on. prompt=none is the opposite. It ensures that the user isn't presented with any interactive prompt. If the request can't be completed silently by using single-sign on, the Microsoft identity platform returns an interaction_required error. prompt=select_account interrupts single sign-on providing account selection experience listing all the accounts either in session or any remembered account or an option to choose to use a different account altogether. - `scopes` (List of String) OAuth scopes - `sign_request` (Boolean) Sign the SAML authentication request with Access credentials. To verify the signature, use the public key from the Access certs endpoints. @@ -128,7 +108,7 @@ Optional: Optional: - `enabled` (Boolean) A flag to enable or disable SCIM for the identity provider. -- `identity_update_behavior` (String) Indicates how a SCIM event updates an Access identity. Use "automatic" to automatically update a user's Access identity and augment it with fields from the SCIM user resource. Use "reauth" to force re-authentication on group membership updates. With "reauth" Access identities will not contain fields from the SCIM user resource. +- `identity_update_behavior` (String) Indicates how a SCIM event updates a user identity used for policy evaluation. Use "automatic" to automatically update a user's identity and augment it with fields from the SCIM user resource. Use "reauth" to force re-authentication on group membership updates, user identity update will only occur after successful re-authentication. With "reauth" identities will not contain fields from the SCIM user resource. With "no_action" identities will not be changed by SCIM updates in any way and users will not be prompted to reauthenticate. - `seat_deprovision` (Boolean) A flag to remove a user's seat in Zero Trust when they have been deprovisioned in the Identity Provider. This cannot be enabled unless user_deprovision is also enabled. - `user_deprovision` (Boolean) A flag to enable revoking a user's session in Access and Gateway when they have been deprovisioned in the Identity Provider. @@ -141,5 +121,5 @@ Read-Only: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_zero_trust_access_identity_provider.example / +$ terraform import cloudflare_zero_trust_access_identity_provider.example '<{accounts|zones}/{account_id|zone_id}>/' ``` diff --git a/docs/resources/zero_trust_access_infrastructure_target.md b/docs/resources/zero_trust_access_infrastructure_target.md index 11fa0b8079..bfe207c99d 100644 --- a/docs/resources/zero_trust_access_infrastructure_target.md +++ b/docs/resources/zero_trust_access_infrastructure_target.md @@ -9,6 +9,24 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_zero_trust_access_infrastructure_target" "example_zero_trust_access_infrastructure_target" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + hostname = "infra-access-target" + ip = { + ipv4 = { + ip_addr = "187.26.29.249" + virtual_network_id = "c77b744e-acc8-428f-9257-6878c046ed55" + } + ipv6 = { + ip_addr = "64c0:64e8:f0b4:8dbf:7104:72b0:ec8f:f5e0" + virtual_network_id = "c77b744e-acc8-428f-9257-6878c046ed55" + } + } +} +``` ## Schema @@ -42,7 +60,7 @@ Optional: Optional: - `ip_addr` (String) IP address of the target -- `virtual_network_id` (String) Private virtual network identifier for the target +- `virtual_network_id` (String) (optional) Private virtual network identifier for the target. If omitted, the default virtual network ID will be used. @@ -51,6 +69,12 @@ Optional: Optional: - `ip_addr` (String) IP address of the target -- `virtual_network_id` (String) Private virtual network identifier for the target +- `virtual_network_id` (String) (optional) Private virtual network identifier for the target. If omitted, the default virtual network ID will be used. +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_zero_trust_access_infrastructure_target.example '/' +``` diff --git a/docs/resources/zero_trust_access_key_configuration.md b/docs/resources/zero_trust_access_key_configuration.md index c0a3607933..d71a8c4404 100644 --- a/docs/resources/zero_trust_access_key_configuration.md +++ b/docs/resources/zero_trust_access_key_configuration.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_zero_trust_access_key_configuration" "example_zero_trust_access_key_configuration" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + key_rotation_interval_days = 30 +} +``` ## Schema @@ -24,4 +32,10 @@ description: |- - `id` (String) Identifier - `last_key_rotation_at` (String) The timestamp of the previous key rotation. +## Import + +Import is supported using the following syntax: +```shell +$ terraform import cloudflare_zero_trust_access_key_configuration.example '' +``` diff --git a/docs/resources/zero_trust_access_mtls_certificate.md b/docs/resources/zero_trust_access_mtls_certificate.md index 0de726d5d1..8a8ac30dfb 100644 --- a/docs/resources/zero_trust_access_mtls_certificate.md +++ b/docs/resources/zero_trust_access_mtls_certificate.md @@ -12,13 +12,19 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_zero_trust_access_mtls_certificate" "my_cert" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - name = "My Root Cert" - certificate = var.ca_pem - associated_hostnames = ["staging.example.com"] +resource "cloudflare_zero_trust_access_mtls_certificate" "example_zero_trust_access_mtls_certificate" { + certificate = < ## Schema @@ -46,9 +52,5 @@ resource "cloudflare_zero_trust_access_mtls_certificate" "my_cert" { Import is supported using the following syntax: ```shell -# Account level import. -$ terraform import cloudflare_zero_trust_access_mtls_certificate.example account// - -# Zone level import. -$ terraform import cloudflare_zero_trust_access_mtls_certificate.example zone// +$ terraform import cloudflare_zero_trust_access_mtls_certificate.example '<{accounts|zones}/{account_id|zone_id}>/' ``` diff --git a/docs/resources/zero_trust_access_mtls_hostname_settings.md b/docs/resources/zero_trust_access_mtls_hostname_settings.md index 3adeed943d..fca39f618a 100644 --- a/docs/resources/zero_trust_access_mtls_hostname_settings.md +++ b/docs/resources/zero_trust_access_mtls_hostname_settings.md @@ -12,15 +12,16 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_zero_trust_access_mtls_hostname_settings" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" +resource "cloudflare_zero_trust_access_mtls_hostname_settings" "example_zero_trust_access_mtls_hostname_settings" { settings = [{ - hostname = "example.com" + china_network = false client_certificate_forwarding = true - china_network = false + hostname = "admin.example.com" }] + zone_id = "zone_id" } ``` + ## Schema @@ -42,14 +43,4 @@ Required: - `client_certificate_forwarding` (Boolean) Client Certificate Forwarding is a feature that takes the client cert provided by the eyeball to the edge, and forwards it to the origin as a HTTP header to allow logging on the origin. - `hostname` (String) The hostname that these settings apply to. -## Import - -Import is supported using the following syntax: -```shell -# Account level mTLS hostname settings import. -$ terraform import cloudflare_zero_trust_access_mtls_hostname_settings.example account/ - -# Zone level mTLS hostname settings import. -$ terraform import cloudflare_zero_trust_access_mtls_hostname_settings.example zone/ -``` diff --git a/docs/resources/zero_trust_access_policy.md b/docs/resources/zero_trust_access_policy.md index a88b27ca9b..f76fec47de 100644 --- a/docs/resources/zero_trust_access_policy.md +++ b/docs/resources/zero_trust_access_policy.md @@ -17,36 +17,24 @@ description: |- ## Example Usage ```terraform -# Allowing access to `test@example.com` email address only -resource "cloudflare_zero_trust_access_policy" "test_policy" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "staging policy" - precedence = "1" - decision = "allow" - +resource "cloudflare_zero_trust_access_policy" "example_zero_trust_access_policy" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + decision = "allow" include = [{ - email = ["test@example.com"] + group = { + id = "aa0a4aab-672b-4bdb-bc33-a59f1130a11f" + } }] - - require = [{ - email = ["test@example.com"] + name = "Allow devs" + exclude = [{ + group = { + id = "aa0a4aab-672b-4bdb-bc33-a59f1130a11f" + } }] -} - -# Allowing `test@example.com` to access but only when coming from a -# specific IP. -resource "cloudflare_zero_trust_access_policy" "test_policy" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "staging policy" - precedence = "1" - decision = "allow" - - include = [{ - email = ["test@example.com"] - }] - require = [{ - ip = [var.office_ip] + group = { + id = "aa0a4aab-672b-4bdb-bc33-a59f1130a11f" + } }] } ``` @@ -665,5 +653,5 @@ Required: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_zero_trust_access_policy.example account/// +$ terraform import cloudflare_zero_trust_access_policy.example '/' ``` diff --git a/docs/resources/zero_trust_access_service_token.md b/docs/resources/zero_trust_access_service_token.md index 95063bca6b..80a9b636bb 100644 --- a/docs/resources/zero_trust_access_service_token.md +++ b/docs/resources/zero_trust_access_service_token.md @@ -12,26 +12,13 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_zero_trust_access_ssd -ce_token" "my_app" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "CI/CD app" -} - -# Generate a service token that will renew if terraform is ran within 30 days of expiration -resource "cloudflare_zero_trust_access_ssd -ce_token" "my_app" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "CI/CD app renewed" - - min_days_for_renewal = 30 - - # This flag is important to set if min_days_for_renewal is defined otherwise - # there will be a brief period where the service relying on that token - # will not have access due to the resource being deleted - lifecycle { - create_before_destroy = true - } +resource "cloudflare_zero_trust_access_service_token" "example_zero_trust_access_service_token" { + name = "CI/CD token" + zone_id = "zone_id" + duration = "60m" } ``` + ## Schema @@ -59,9 +46,5 @@ resource "cloudflare_zero_trust_access_ssd -ce_token" "my_app" { Import is supported using the following syntax: ```shell -# If you are importing an Access Service Token you will not have the -# client_secret available in the state for use. The client_secret is only -# available once, at creation. In most cases, it is better to just create a new -# resource should you need to reference it in other resources. -$ terraform import cloudflare_access_service_token.example / +$ terraform import cloudflare_zero_trust_access_service_token.example '<{accounts|zones}/{account_id|zone_id}>/' ``` diff --git a/docs/resources/zero_trust_access_short_lived_certificate.md b/docs/resources/zero_trust_access_short_lived_certificate.md index b70decf0a9..d5f314b219 100644 --- a/docs/resources/zero_trust_access_short_lived_certificate.md +++ b/docs/resources/zero_trust_access_short_lived_certificate.md @@ -12,18 +12,12 @@ description: |- ## Example Usage ```terraform -# account level -resource "cloudflare_zero_trust_access_short_lived_certificate" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - application_id = "6cd6cea3-3ef2-4542-9aea-85a0bbcd5414" -} - -# zone level -resource "cloudflare_zero_trust_access_short_lived_certificate" "another_example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - application_id = "fe2be0ff-7f13-4350-8c8e-a9b9795fe3c2" +resource "cloudflare_zero_trust_access_short_lived_certificate" "example_zero_trust_access_short_lived_certificate" { + app_id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" + zone_id = "zone_id" } ``` + ## Schema @@ -47,9 +41,5 @@ resource "cloudflare_zero_trust_access_short_lived_certificate" "another_example Import is supported using the following syntax: ```shell -# Account level CA certificate import. -$ terraform import cloudflare_zero_trust_access_short_lived_certificate.example account// - -# Zone level CA certificate import. -$ terraform import cloudflare_zero_trust_access_short_lived_certificate.example account// +$ terraform import cloudflare_zero_trust_access_short_lived_certificate.example '<{accounts|zones}/{account_id|zone_id}>/' ``` diff --git a/docs/resources/zero_trust_access_tag.md b/docs/resources/zero_trust_access_tag.md index 0d62636bd0..4684a03301 100644 --- a/docs/resources/zero_trust_access_tag.md +++ b/docs/resources/zero_trust_access_tag.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_zero_trust_access_tag" "example_zero_trust_access_tag" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + name = "engineers" +} +``` ## Schema @@ -25,4 +33,10 @@ description: |- - `id` (String) The name of the tag - `updated_at` (String) +## Import + +Import is supported using the following syntax: +```shell +$ terraform import cloudflare_zero_trust_access_tag.example '/' +``` diff --git a/docs/resources/zero_trust_device_custom_profile.md b/docs/resources/zero_trust_device_custom_profile.md index b55b330cc5..1ec3f3b440 100644 --- a/docs/resources/zero_trust_device_custom_profile.md +++ b/docs/resources/zero_trust_device_custom_profile.md @@ -9,6 +9,34 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_zero_trust_device_custom_profile" "example_zero_trust_device_custom_profile" { + account_id = "699d98642c564d2e855e9661899b7252" + match = "user.identity == \"test@cloudflare.com\"" + name = "Allow Developers" + precedence = 100 + allow_mode_switch = true + allow_updates = true + allowed_to_leave = true + auto_connect = 0 + captive_portal = 180 + description = "Policy for test teams." + disable_auto_fallback = true + enabled = true + exclude_office_ips = true + lan_allow_minutes = 30 + lan_allow_subnet_size = 24 + service_mode_v2 = { + mode = "proxy" + port = 3000 + } + support_url = "https://1.1.1.1/help" + switch_locked = true + tunnel_protocol = "wireguard" +} +``` ## Schema @@ -96,4 +124,10 @@ Read-Only: - `id` (String) The id of the DEX test targeting this policy - `name` (String) The name of the DEX test targeting this policy +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_zero_trust_device_custom_profile.example '/' +``` diff --git a/docs/resources/zero_trust_device_custom_profile_local_domain_fallback.md b/docs/resources/zero_trust_device_custom_profile_local_domain_fallback.md index 86c931d5b7..75bc45607a 100644 --- a/docs/resources/zero_trust_device_custom_profile_local_domain_fallback.md +++ b/docs/resources/zero_trust_device_custom_profile_local_domain_fallback.md @@ -9,6 +9,19 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_zero_trust_device_custom_profile_local_domain_fallback" "example_zero_trust_device_custom_profile_local_domain_fallback" { + account_id = "699d98642c564d2e855e9661899b7252" + policy_id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" + domains = [{ + suffix = "example.com" + description = "Domain bypass for local development" + dns_server = ["1.1.1.1"] + }] +} +``` ## Schema @@ -35,4 +48,10 @@ Optional: - `description` (String) A description of the fallback domain, displayed in the client UI. - `dns_server` (List of String) A list of IP addresses to handle domain resolution. +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_zero_trust_device_custom_profile_local_domain_fallback.example '/' +``` diff --git a/docs/resources/zero_trust_device_default_profile.md b/docs/resources/zero_trust_device_default_profile.md index 33b2b9ebd0..a12c132943 100644 --- a/docs/resources/zero_trust_device_default_profile.md +++ b/docs/resources/zero_trust_device_default_profile.md @@ -9,6 +9,27 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_zero_trust_device_default_profile" "example_zero_trust_device_default_profile" { + account_id = "699d98642c564d2e855e9661899b7252" + allow_mode_switch = true + allow_updates = true + allowed_to_leave = true + auto_connect = 0 + captive_portal = 180 + disable_auto_fallback = true + exclude_office_ips = true + service_mode_v2 = { + mode = "proxy" + port = 3000 + } + support_url = "https://1.1.1.1/help" + switch_locked = true + tunnel_protocol = "wireguard" +} +``` ## Schema diff --git a/docs/resources/zero_trust_device_default_profile_certificates.md b/docs/resources/zero_trust_device_default_profile_certificates.md index 88d5cf5946..51e5d3ce44 100644 --- a/docs/resources/zero_trust_device_default_profile_certificates.md +++ b/docs/resources/zero_trust_device_default_profile_certificates.md @@ -9,6 +9,14 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_zero_trust_device_default_profile_certificates" "example_zero_trust_device_default_profile_certificates" { + zone_id = "699d98642c564d2e855e9661899b7252" + enabled = true +} +``` ## Schema diff --git a/docs/resources/zero_trust_device_default_profile_local_domain_fallback.md b/docs/resources/zero_trust_device_default_profile_local_domain_fallback.md index e6d1c1ea4c..d348cef771 100644 --- a/docs/resources/zero_trust_device_default_profile_local_domain_fallback.md +++ b/docs/resources/zero_trust_device_default_profile_local_domain_fallback.md @@ -9,6 +9,18 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_zero_trust_device_default_profile_local_domain_fallback" "example_zero_trust_device_default_profile_local_domain_fallback" { + account_id = "699d98642c564d2e855e9661899b7252" + domains = [{ + suffix = "example.com" + description = "Domain bypass for local development" + dns_server = ["1.1.1.1"] + }] +} +``` ## Schema diff --git a/docs/resources/zero_trust_device_managed_networks.md b/docs/resources/zero_trust_device_managed_networks.md index fb7dea7f4d..19918db491 100644 --- a/docs/resources/zero_trust_device_managed_networks.md +++ b/docs/resources/zero_trust_device_managed_networks.md @@ -12,16 +12,17 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_zero_trust_device_managed_networks" "managed_networks" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "managed-network-1" - type = "tls" +resource "cloudflare_zero_trust_device_managed_networks" "example_zero_trust_device_managed_networks" { + account_id = "699d98642c564d2e855e9661899b7252" config = { - tls_sockaddr = "foobar:1234" - sha256 = "b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c" + tls_sockaddr = "foo.bar:1234" + sha256 = "b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c" } + name = "managed-network-1" + type = "tls" } ``` + ## Schema @@ -53,5 +54,5 @@ Optional: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_zero_trust_device_managed_networks.example / +$ terraform import cloudflare_zero_trust_device_managed_networks.example '/' ``` diff --git a/docs/resources/zero_trust_device_posture_integration.md b/docs/resources/zero_trust_device_posture_integration.md index f7ffb40cee..1ac33f4c03 100644 --- a/docs/resources/zero_trust_device_posture_integration.md +++ b/docs/resources/zero_trust_device_posture_integration.md @@ -12,19 +12,20 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_zero_trust_device_posture_integration" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "Device posture integration" - type = "workspace_one" - interval = "24h" +resource "cloudflare_zero_trust_device_posture_integration" "example_zero_trust_device_posture_integration" { + account_id = "699d98642c564d2e855e9661899b7252" config = { - api_url = "https://example.com/api" - auth_url = "https://example.com/connect/token" - client_id = "client-id" - client_secret = "client-secret" + api_url = "https://as123.awmdm.com/API" + auth_url = "https://na.uemauth.vmwservices.com/connect/token" + client_id = "example client id" + client_secret = "example client secret" } + interval = "10m" + name = "My Workspace One Integration" + type = "workspace_one" } ``` + ## Schema @@ -59,5 +60,5 @@ Optional: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_zero_trust_device_posture_integration.example / +$ terraform import cloudflare_zero_trust_device_posture_integration.example '/' ``` diff --git a/docs/resources/zero_trust_device_posture_rule.md b/docs/resources/zero_trust_device_posture_rule.md index 0cadb233d2..042b23e9dc 100644 --- a/docs/resources/zero_trust_device_posture_rule.md +++ b/docs/resources/zero_trust_device_posture_rule.md @@ -12,28 +12,26 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_zero_trust_device_posture_rule" "eaxmple" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "Corporate devices posture rule" - type = "os_version" - description = "Device posture rule for corporate devices." - schedule = "24h" - expiration = "24h" - - match = [{ - platform = "linux" - }] - +resource "cloudflare_zero_trust_device_posture_rule" "example_zero_trust_device_posture_rule" { + account_id = "699d98642c564d2e855e9661899b7252" + name = "Admin Serial Numbers" + type = "file" + description = "The rule for admin serial numbers" + expiration = "1h" input = { - id = cloudflare_zero_trust_list.corporate_devices.id - version = "1.0.0" - operator = "<" - os_distro_name = "ubuntu" - os_distro_revision = "1.0.0" - os_version_extra = "(a)" + operating_system = "windows" + path = "/bin/cat" + exists = true + sha256 = "https://api.us-2.crowdstrike.com" + thumbprint = "0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e" } + match = [{ + platform = "windows" + }] + schedule = "1h" } ``` + ## Schema @@ -86,7 +84,7 @@ Optional: - `os` (String) Os Version - `os_distro_name` (String) Operating System Distribution Name (linux only) - `os_distro_revision` (String) Version of OS Distribution (linux only) -- `os_version_extra` (String) Additional version data. For Mac or iOS, the Product Verison Extra. For Linux, the kernel release version. (Mac, iOS, and Linux only) +- `os_version_extra` (String) Additional version data. For Mac or iOS, the Product Version Extra. For Linux, the kernel release version. (Mac, iOS, and Linux only) - `overall` (String) overall - `path` (String) File path. - `require_all` (Boolean) Whether to check all disks for encryption. @@ -123,5 +121,5 @@ Optional: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_zero_trust_device_posture_rule.example / +$ terraform import cloudflare_zero_trust_device_posture_rule.example '/' ``` diff --git a/docs/resources/zero_trust_dex_test.md b/docs/resources/zero_trust_dex_test.md index 8dcafeeb76..f7076d8025 100644 --- a/docs/resources/zero_trust_dex_test.md +++ b/docs/resources/zero_trust_dex_test.md @@ -12,19 +12,26 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_zero_trust_dex_test" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "GET homepage" - description = "Send a HTTP GET request to the home endpoint every half hour." - interval = "0h30m0s" - enabled = true +resource "cloudflare_zero_trust_dex_test" "example_zero_trust_dex_test" { + account_id = "699d98642c564d2e855e9661899b7252" data = { - host = "https://example.com/home" - kind = "http" + host = "https://dash.cloudflare.com" + kind = "http" method = "GET" } + enabled = true + interval = "30m" + name = "HTTP dash health check" + description = "Checks the dash endpoint every 30 minutes" + target_policies = [{ + id = "id" + default = true + name = "name" + }] + targeted = true } ``` + ## Schema @@ -71,5 +78,5 @@ Optional: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_zero_trust_dex_test.example / +$ terraform import cloudflare_zero_trust_dex_test.example '/' ``` diff --git a/docs/resources/zero_trust_dlp_custom_profile.md b/docs/resources/zero_trust_dlp_custom_profile.md index a4b0484e56..846a436f16 100644 --- a/docs/resources/zero_trust_dlp_custom_profile.md +++ b/docs/resources/zero_trust_dlp_custom_profile.md @@ -9,6 +9,39 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_zero_trust_dlp_custom_profile" "example_zero_trust_dlp_custom_profile" { + account_id = "account_id" + profiles = [{ + entries = [{ + enabled = true + name = "name" + pattern = { + regex = "regex" + validation = "luhn" + } + }] + name = "name" + allowed_match_count = 5 + confidence_threshold = "confidence_threshold" + context_awareness = { + enabled = true + skip = { + files = true + } + } + description = "description" + ocr_enabled = true + shared_entries = [{ + enabled = true + entry_id = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" + entry_type = "custom" + }] + }] +} +``` ## Schema @@ -160,4 +193,10 @@ Required: - `entry_id` (String) - `entry_type` (String) +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_zero_trust_dlp_custom_profile.example '/' +``` diff --git a/docs/resources/zero_trust_dlp_dataset.md b/docs/resources/zero_trust_dlp_dataset.md index 73b048db10..e8c5807325 100644 --- a/docs/resources/zero_trust_dlp_dataset.md +++ b/docs/resources/zero_trust_dlp_dataset.md @@ -9,6 +9,17 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_zero_trust_dlp_dataset" "example_zero_trust_dlp_dataset" { + account_id = "account_id" + name = "name" + description = "description" + encoding_version = 0 + secret = true +} +``` ## Schema diff --git a/docs/resources/zero_trust_dlp_predefined_profile.md b/docs/resources/zero_trust_dlp_predefined_profile.md index 82547da05f..346942fb3c 100644 --- a/docs/resources/zero_trust_dlp_predefined_profile.md +++ b/docs/resources/zero_trust_dlp_predefined_profile.md @@ -9,6 +9,27 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_zero_trust_dlp_predefined_profile" "example_zero_trust_dlp_predefined_profile" { + account_id = "account_id" + profile_id = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" + entries = [{ + id = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" + enabled = true + }] + allowed_match_count = 0 + confidence_threshold = "confidence_threshold" + context_awareness = { + enabled = true + skip = { + files = true + } + } + ocr_enabled = true +} +``` ## Schema @@ -60,4 +81,10 @@ Required: - `files` (Boolean) If the content type is a file, skip context analysis and return all matches. +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_zero_trust_dlp_predefined_profile.example '/' +``` diff --git a/docs/resources/zero_trust_dns_location.md b/docs/resources/zero_trust_dns_location.md index f027414692..aa799905c8 100644 --- a/docs/resources/zero_trust_dns_location.md +++ b/docs/resources/zero_trust_dns_location.md @@ -12,21 +12,42 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_zero_trust_dns_location" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "office" - client_default = true - ecs_support = false - +resource "cloudflare_zero_trust_dns_location" "example_zero_trust_dns_location" { + account_id = "699d98642c564d2e855e9661899b7252" + name = "Austin Office Location" + client_default = false + dns_destination_ips_id = "0e4a32c6-6fb8-4858-9296-98f51631e8e6" + ecs_support = false + endpoints = { + doh = { + enabled = true + networks = [{ + network = "2001:85a3::/64" + }] + require_token = true + } + dot = { + enabled = true + networks = [{ + network = "2001:85a3::/64" + }] + } + ipv4 = { + enabled = true + } + ipv6 = { + enabled = true + networks = [{ + network = "2001:85a3::/64" + }] + } + } networks = [{ - network = "203.0.113.1/32" - }, - { - network = "203.0.113.2/32" + network = "192.0.2.1/32" }] - } ``` + ## Schema @@ -136,5 +157,5 @@ Required: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_zero_trust_dns_location.example / +$ terraform import cloudflare_zero_trust_dns_location.example '/' ``` diff --git a/docs/resources/zero_trust_gateway_policy.md b/docs/resources/zero_trust_gateway_policy.md index 0c213ea572..04b7c6b195 100644 --- a/docs/resources/zero_trust_gateway_policy.md +++ b/docs/resources/zero_trust_gateway_policy.md @@ -12,20 +12,101 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_zero_trust_gateway_policy" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "office" - description = "desc" - precedence = 1 - action = "block" - filters = ["http"] - traffic = "http.request.uri == \"https://www.example.com/malicious\"" +resource "cloudflare_zero_trust_gateway_policy" "example_zero_trust_gateway_policy" { + account_id = "699d98642c564d2e855e9661899b7252" + action = "on" + name = "block bad websites" + description = "Block bad websites based on their host name." + device_posture = "any(device_posture.checks.passed[*] in {\"1308749e-fcfb-4ebc-b051-fe022b632644\"})" + enabled = true + expiration = { + expires_at = "2014-01-01T05:20:20Z" + duration = 10 + } + filters = ["http"] + identity = "any(identity.groups.name[*] in {\"finance\"})" + precedence = 0 rule_settings = { + add_headers = { + foo = "string" + } + allow_child_bypass = false + audit_ssh = { + command_logging = false + } + biso_admin_controls = { + dcp = false + dd = false + dk = false + dp = false + du = false + } block_page_enabled = true - block_page_reason = "access not permitted" + block_reason = "This website is a security risk" + bypass_parent_rule = false + check_session = { + duration = "300s" + enforce = true + } + dns_resolvers = { + ipv4 = [{ + ip = "2.2.2.2" + port = 5053 + route_through_private_network = true + vnet_id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" + }] + ipv6 = [{ + ip = "2001:DB8::" + port = 5053 + route_through_private_network = true + vnet_id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415" + }] + } + egress = { + ipv4 = "192.0.2.2" + ipv4_fallback = "192.0.2.3" + ipv6 = "2001:DB8::/64" + } + ignore_cname_category_matches = true + insecure_disable_dnssec_validation = false + ip_categories = true + ip_indicator_feeds = true + l4override = { + ip = "1.1.1.1" + port = 0 + } + notification_settings = { + enabled = true + msg = "msg" + support_url = "support_url" + } + override_host = "example.com" + override_ips = ["1.1.1.1", "2.2.2.2"] + payload_log = { + enabled = true + } + quarantine = { + file_types = ["exe"] + } + resolve_dns_through_cloudflare = true + untrusted_cert = { + action = "pass_through" + } + } + schedule = { + fri = "08:00-12:30,13:30-17:00" + mon = "08:00-12:30,13:30-17:00" + sat = "08:00-12:30,13:30-17:00" + sun = "08:00-12:30,13:30-17:00" + thu = "08:00-12:30,13:30-17:00" + time_zone = "America/New York" + tue = "08:00-12:30,13:30-17:00" + wed = "08:00-12:30,13:30-17:00" } + traffic = "http.request.uri matches \".*a/partial/uri.*\" and http.request.host in $01302951-49f9-47c9-a400-0297e60b6a10" } ``` + ## Schema @@ -247,5 +328,5 @@ Optional: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_zero_trust_gateway_policy.example / +$ terraform import cloudflare_zero_trust_gateway_policy.example '/' ``` diff --git a/docs/resources/zero_trust_gateway_proxy_endpoint.md b/docs/resources/zero_trust_gateway_proxy_endpoint.md index e9ecdd083b..532a302716 100644 --- a/docs/resources/zero_trust_gateway_proxy_endpoint.md +++ b/docs/resources/zero_trust_gateway_proxy_endpoint.md @@ -12,12 +12,13 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_zero_trust_gateway_proxy_endpoint" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "office" - ips = ["192.0.2.0/24"] +resource "cloudflare_zero_trust_gateway_proxy_endpoint" "example_zero_trust_gateway_proxy_endpoint" { + account_id = "699d98642c564d2e855e9661899b7252" + ips = ["192.0.2.1/32"] + name = "Devops team" } ``` + ## Schema @@ -39,5 +40,5 @@ resource "cloudflare_zero_trust_gateway_proxy_endpoint" "example" { Import is supported using the following syntax: ```shell -$ terraform import cloudflare_zero_trust_gateway_proxy_endpoint.example / +$ terraform import cloudflare_zero_trust_gateway_proxy_endpoint.example '/' ``` diff --git a/docs/resources/zero_trust_gateway_settings.md b/docs/resources/zero_trust_gateway_settings.md index 3e3fb3b33e..ae92438dda 100644 --- a/docs/resources/zero_trust_gateway_settings.md +++ b/docs/resources/zero_trust_gateway_settings.md @@ -12,69 +12,69 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_zero_trust_gateway_settings" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - tls_decrypt_enabled = true - protocol_detection_enabled = true - - block_page = { - footer_text = "hello" - header_text = "hello" - logo_path = "https://example.com/logo.jpg" - background_color = "#000000" +resource "cloudflare_zero_trust_gateway_settings" "example_zero_trust_gateway_settings" { + account_id = "699d98642c564d2e855e9661899b7252" + settings = { + activity_log = { + enabled = true + } + antivirus = { + enabled_download_phase = false + enabled_upload_phase = false + fail_closed = false + notification_settings = { + enabled = true + msg = "msg" + support_url = "support_url" + } + } + block_page = { + background_color = "background_color" + enabled = true + footer_text = "--footer--" + header_text = "--header--" + logo_path = "https://logos.com/a.png" + mailto_address = "admin@example.com" + mailto_subject = "Blocked User Inquiry" + name = "Cloudflare" + suppress_footer = false + } + body_scanning = { + inspection_mode = "deep" + } + browser_isolation = { + non_identity_enabled = true + url_browser_isolation_enabled = true + } + certificate = { + id = "d1b364c5-1311-466e-a194-f0e943e0799f" + } + custom_certificate = { + enabled = true + id = "d1b364c5-1311-466e-a194-f0e943e0799f" + binding_status = "pending_deployment" + updated_at = "2019-12-27T18:11:19.117Z" + } + extended_email_matching = { + enabled = true + } + fips = { + tls = true + } + protocol_detection = { + enabled = true + } + sandbox = { + enabled = true + fallback_action = "allow" + } + tls_decrypt = { + enabled = true + } } - - body_scanning = { - inspection_mode = "deep" - } - - antivirus = { - enabled_download_phase = true - enabled_upload_phase = false - fail_closed = true - notification_settings = [{ - enabled = true - message = "you are blocked" - support_url = "https://example.com/blocked" - }] - } - - fips = { - tls = true - } - - proxy = { - tcp = true - udp = true - root_ca = true - virtual_ip = false - } - - url_browser_isolation_enabled = true - - logging = { - redact_pii = true - settings_by_rule_type = [{ - dns = { - log_all = false - log_blocks = true - } - http = { - log_all = true - log_blocks = true - } - l4 = { - log_all = false - log_blocks = true - } - }] - } - - extended_email_matching = [{ - enabled = true - }] } ``` + ## Schema @@ -242,5 +242,5 @@ Optional: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_zero_trust_gateway_settings.example +$ terraform import cloudflare_zero_trust_gateway_settings.example '' ``` diff --git a/docs/resources/zero_trust_list.md b/docs/resources/zero_trust_list.md index 665111eee3..341cd609f9 100644 --- a/docs/resources/zero_trust_list.md +++ b/docs/resources/zero_trust_list.md @@ -12,14 +12,19 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_zero_trust_list" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "Corporate devices" - type = "SERIAL" - description = "Serial numbers for all corporate devices." - items = ["8GE8721REF", "5RE8543EGG", "1YE2880LNP"] +resource "cloudflare_zero_trust_list" "example_zero_trust_list" { + account_id = "699d98642c564d2e855e9661899b7252" + name = "Admin Serial Numbers" + type = "SERIAL" + description = "The serial numbers for administrators" + items = [{ + created_at = "2014-01-01T05:20:00.12345Z" + description = "Austin office IP" + value = "8GE8721REF" + }] } ``` + ## Schema @@ -58,5 +63,5 @@ Read-Only: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_zero_trust_list.example / +$ terraform import cloudflare_zero_trust_list.example '/' ``` diff --git a/docs/resources/zero_trust_organization.md b/docs/resources/zero_trust_organization.md index 0c0023f929..2432f83d17 100644 --- a/docs/resources/zero_trust_organization.md +++ b/docs/resources/zero_trust_organization.md @@ -9,6 +9,33 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_zero_trust_organization" "example_zero_trust_organization" { + zone_id = "zone_id" + allow_authenticate_via_warp = true + auth_domain = "test.cloudflareaccess.com" + auto_redirect_to_identity = true + custom_pages = { + forbidden = "699d98642c564d2e855e9661899b7252" + identity_denied = "699d98642c564d2e855e9661899b7252" + } + is_ui_read_only = true + login_design = { + background_color = "#c5ed1b" + footer_text = "This is an example description." + header_text = "This is an example description." + logo_path = "https://example.com/logo.png" + text_color = "#c5ed1b" + } + name = "Widget Corps Internal Applications" + session_duration = "24h" + ui_read_only_toggle_reason = "Temporarily turn off the UI read only lock to make a change via the UI" + user_seat_expiration_inactive_time = "730h" + warp_auth_session_duration = "24h" +} +``` ## Schema diff --git a/docs/resources/zero_trust_risk_scoring_integration.md b/docs/resources/zero_trust_risk_scoring_integration.md index 2dcf6ec720..a002813dc7 100644 --- a/docs/resources/zero_trust_risk_scoring_integration.md +++ b/docs/resources/zero_trust_risk_scoring_integration.md @@ -9,6 +9,16 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_zero_trust_risk_scoring_integration" "example_zero_trust_risk_scoring_integration" { + account_id = "account_id" + integration_type = "Okta" + tenant_url = "https://example.com" + reference_id = "reference_id" +} +``` ## Schema @@ -32,4 +42,10 @@ https://developers.cloudflare.com/api/operations/access-identity-providers-get-a - `id` (String) The id of the integration, a UUIDv4. - `well_known_url` (String) The URL for the Shared Signals Framework configuration, e.g. "/.well-known/sse-configuration/{integration_uuid}/". https://openid.net/specs/openid-sse-framework-1_0.html#rfc.section.6.2.1 +## Import + +Import is supported using the following syntax: +```shell +$ terraform import cloudflare_zero_trust_risk_scoring_integration.example '/' +``` diff --git a/docs/resources/zero_trust_tunnel_cloudflared.md b/docs/resources/zero_trust_tunnel_cloudflared.md index 786ec34f03..a6284eb6b3 100644 --- a/docs/resources/zero_trust_tunnel_cloudflared.md +++ b/docs/resources/zero_trust_tunnel_cloudflared.md @@ -12,12 +12,14 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_zero_trust_tunnel_cloudflared" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "my-tunnel" - secret = "AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg=" +resource "cloudflare_zero_trust_tunnel_cloudflared" "example_zero_trust_tunnel_cloudflared" { + account_id = "699d98642c564d2e855e9661899b7252" + name = "blog" + config_src = "local" + tunnel_secret = "AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg=" } ``` + ## Schema @@ -64,5 +66,5 @@ Read-Only: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_zero_trust_tunnel_cloudflared.example / +$ terraform import cloudflare_zero_trust_tunnel_cloudflared.example '/' ``` diff --git a/docs/resources/zero_trust_tunnel_cloudflared_config.md b/docs/resources/zero_trust_tunnel_cloudflared_config.md index b9c9d68698..a729ec5d82 100644 --- a/docs/resources/zero_trust_tunnel_cloudflared_config.md +++ b/docs/resources/zero_trust_tunnel_cloudflared_config.md @@ -12,62 +12,62 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_zero_trust_tunnel_cloudflared" "example_tunnel" { - account_id = "f037e56e89293a057740de681ac9abbe" - name = "example_tunnel" - secret = "<32 character secret>" -} - -resource "cloudflare_zero_trust_tunnel_cloudflared_config" "example_config" { - account_id = "f037e56e89293a057740de681ac9abbe" - tunnel_id = cloudflare_zero_trust_tunnel_cloudflared.example_tunnel.id - +resource "cloudflare_zero_trust_tunnel_cloudflared_config" "example_zero_trust_tunnel_cloudflared_config" { + account_id = "023e105f4ecef8ad9ca31a8372d0c353" + tunnel_id = "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415" config = { - warp_routing = [{ - enabled = true - }] - origin_request = [{ - connect_timeout = "1m0s" - tls_timeout = "1m0s" - tcp_keep_alive = "1m0s" - no_happy_eyeballs = false - keep_alive_connections = 1024 - keep_alive_timeout = "1m0s" - http_host_header = "baz" - origin_server_name = "foobar" - ca_pool = "/path/to/unsigned/ca/pool" - no_tls_verify = false - disable_chunked_encoding = false - bastion_mode = false - proxy_address = "10.0.0.1" - proxy_port = "8123" - proxy_type = "socks" - ip_rules = [{ - prefix = "/web" - ports = [80, 443] - allow = false - }] + ingress = [{ + hostname = "tunnel.example.com" + service = "https://localhost:8001" + origin_request = { + access = { + aud_tag = ["string"] + team_name = "teamName" + required = true + } + ca_pool = "caPool" + connect_timeout = 0 + disable_chunked_encoding = true + http2_origin = true + http_host_header = "httpHostHeader" + keep_alive_connections = 0 + keep_alive_timeout = 0 + no_happy_eyeballs = true + no_tls_verify = true + origin_server_name = "originServerName" + proxy_type = "proxyType" + tcp_keep_alive = 0 + tls_timeout = 0 + } + path = "subpath" }] - ingress_rule = [{ - hostname = "foo" - path = "/bar" - service = "http://10.0.0.2:8080" - origin_request = [{ - connect_timeout = "2m0s" - access = [{ - required = true - team_name = "terraform" - aud_tag = ["AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"] - }] - }] - }, - { - service = "https://10.0.0.3:8081" - }] - + origin_request = { + access = { + aud_tag = ["string"] + team_name = "teamName" + required = true + } + ca_pool = "caPool" + connect_timeout = 0 + disable_chunked_encoding = true + http2_origin = true + http_host_header = "httpHostHeader" + keep_alive_connections = 0 + keep_alive_timeout = 0 + no_happy_eyeballs = true + no_tls_verify = true + origin_server_name = "originServerName" + proxy_type = "proxyType" + tcp_keep_alive = 0 + tls_timeout = 0 + } + warp_routing = { + enabled = true + } } } ``` + ## Schema @@ -130,7 +130,7 @@ Optional: - `tls_timeout` (Number) Timeout for completing a TLS handshake to your origin server, if you have chosen to connect Tunnel to an HTTPS server. -### Nested Schema for `config.ingress.origin_request.tls_timeout` +### Nested Schema for `config.ingress.origin_request.access` Required: @@ -190,5 +190,5 @@ Optional: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_zero_trust_tunnel_cloudflared_config.example / +$ terraform import cloudflare_zero_trust_tunnel_cloudflared_config.example '/' ``` diff --git a/docs/resources/zero_trust_tunnel_cloudflared_route.md b/docs/resources/zero_trust_tunnel_cloudflared_route.md index 3ab360f977..64d4c7902e 100644 --- a/docs/resources/zero_trust_tunnel_cloudflared_route.md +++ b/docs/resources/zero_trust_tunnel_cloudflared_route.md @@ -9,6 +9,17 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_zero_trust_tunnel_cloudflared_route" "example_zero_trust_tunnel_cloudflared_route" { + account_id = "699d98642c564d2e855e9661899b7252" + network = "172.16.0.0/16" + tunnel_id = "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415" + comment = "Example comment for this route." + virtual_network_id = "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415" +} +``` ## Schema @@ -30,4 +41,10 @@ description: |- - `deleted_at` (String) Timestamp of when the resource was deleted. If `null`, the resource has not been deleted. - `id` (String) UUID of the route. +## Import +Import is supported using the following syntax: + +```shell +$ terraform import cloudflare_zero_trust_tunnel_cloudflared_route.example '/' +``` diff --git a/docs/resources/zero_trust_tunnel_cloudflared_virtual_network.md b/docs/resources/zero_trust_tunnel_cloudflared_virtual_network.md index 69c49fc25d..8f00dd654f 100644 --- a/docs/resources/zero_trust_tunnel_cloudflared_virtual_network.md +++ b/docs/resources/zero_trust_tunnel_cloudflared_virtual_network.md @@ -9,6 +9,16 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_zero_trust_tunnel_cloudflared_virtual_network" "example_zero_trust_tunnel_cloudflared_virtual_network" { + account_id = "699d98642c564d2e855e9661899b7252" + name = "us-east-1-vpc" + comment = "Staging VPC for data science" + is_default = true +} +``` ## Schema @@ -30,4 +40,10 @@ description: |- - `deleted_at` (String) Timestamp of when the resource was deleted. If `null`, the resource has not been deleted. - `id` (String) UUID of the virtual network. +## Import + +Import is supported using the following syntax: +```shell +$ terraform import cloudflare_zero_trust_tunnel_cloudflared_virtual_network.example '/' +``` diff --git a/docs/resources/zone.md b/docs/resources/zone.md index b1132fe74e..2294086190 100644 --- a/docs/resources/zone.md +++ b/docs/resources/zone.md @@ -14,9 +14,12 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_zone" "example" { - account_id = "f037e56e89293a057740de681ac9abbe" - zone = "example.com" +resource "cloudflare_zone" "example_zone" { + account = { + id = "023e105f4ecef8ad9ca31a8372d0c353" + } + name = "example.com" + type = "full" } ``` @@ -91,5 +94,5 @@ Read-Only: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_zone.example +$ terraform import cloudflare_zone.example '' ``` diff --git a/docs/resources/zone_cache_reserve.md b/docs/resources/zone_cache_reserve.md index f8de3642d8..3fa5db7dd2 100644 --- a/docs/resources/zone_cache_reserve.md +++ b/docs/resources/zone_cache_reserve.md @@ -12,11 +12,12 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_zone_cache_reserve" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - enabled = true +resource "cloudflare_zone_cache_reserve" "example_zone_cache_reserve" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + value = "on" } ``` + ## Schema @@ -39,5 +40,5 @@ resource "cloudflare_zone_cache_reserve" "example" { Import is supported using the following syntax: ```shell -$ terraform import cloudflare_zone_cache_reserve.example +$ terraform import cloudflare_zone_cache_reserve.example '' ``` diff --git a/docs/resources/zone_cache_variants.md b/docs/resources/zone_cache_variants.md index a7beb95126..72b478ea27 100644 --- a/docs/resources/zone_cache_variants.md +++ b/docs/resources/zone_cache_variants.md @@ -12,21 +12,24 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_zone_cache_variants" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - avif = ["image/avif", "image/webp"] - bmp = ["image/bmp", "image/webp"] - gif = ["image/gif", "image/webp"] - jpeg = ["image/jpeg", "image/webp"] - jpg = ["image/jpg", "image/webp"] - jpg2 = ["image/jpg2", "image/webp"] - jp2 = ["image/jp2", "image/webp"] - png = ["image/png", "image/webp"] - tiff = ["image/tiff", "image/webp"] - tif = ["image/tif", "image/webp"] - webp = ["image/jpeg", "image/webp"] +resource "cloudflare_zone_cache_variants" "example_zone_cache_variants" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + value = { + avif = ["image/webp", "image/jpeg"] + bmp = ["image/webp", "image/jpeg"] + gif = ["image/webp", "image/jpeg"] + jp2 = ["image/webp", "image/avif"] + jpeg = ["image/webp", "image/avif"] + jpg = ["image/webp", "image/avif"] + jpg2 = ["image/webp", "image/avif"] + png = ["image/webp", "image/avif"] + tif = ["image/webp", "image/avif"] + tiff = ["image/webp", "image/avif"] + webp = ["image/jpeg", "image/avif"] + } } ``` + ## Schema @@ -57,4 +60,10 @@ Optional: - `tiff` (List of String) List of strings with the MIME types of all the variants that should be served for tiff. - `webp` (List of String) List of strings with the MIME types of all the variants that should be served for webp. +## Import + +Import is supported using the following syntax: +```shell +$ terraform import cloudflare_zone_cache_variants.example '' +``` diff --git a/docs/resources/zone_dnssec.md b/docs/resources/zone_dnssec.md index 206ec736f5..dfee5251c6 100644 --- a/docs/resources/zone_dnssec.md +++ b/docs/resources/zone_dnssec.md @@ -9,6 +9,16 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_zone_dnssec" "example_zone_dnssec" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + dnssec_multi_signer = false + dnssec_presigned = true + status = "active" +} +``` ## Schema @@ -47,4 +57,10 @@ See [Cloudflare as Secondary](https://developers.cloudflare.com/dns/zone-setups/ - `modified_on` (String) When DNSSEC was last modified. - `public_key` (String) Public key for DS record. +## Import + +Import is supported using the following syntax: +```shell +$ terraform import cloudflare_zone_dnssec.example '' +``` diff --git a/docs/resources/zone_hold.md b/docs/resources/zone_hold.md index 6a02d0651b..c70074ab22 100644 --- a/docs/resources/zone_hold.md +++ b/docs/resources/zone_hold.md @@ -12,11 +12,11 @@ description: |- ## Example Usage ```terraform -resource "cloudflare_zone_hold" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - hold = true +resource "cloudflare_zone_hold" "example_zone_hold" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" } ``` + ## Schema @@ -36,5 +36,5 @@ resource "cloudflare_zone_hold" "example" { Import is supported using the following syntax: ```shell -$ terraform import cloudflare_zone_hold.example +$ terraform import cloudflare_zone_hold.example '' ``` diff --git a/docs/resources/zone_lockdown.md b/docs/resources/zone_lockdown.md index f895b715b0..9d54aebc80 100644 --- a/docs/resources/zone_lockdown.md +++ b/docs/resources/zone_lockdown.md @@ -12,20 +12,16 @@ description: |- ## Example Usage ```terraform -# Restrict access to these endpoints to requests from a known IP address range. -resource "cloudflare_zone_lockdown" "example" { - zone_id = "0da42c8d2132a9ddaf714f9e7c920711" - paused = "false" - description = "Restrict access to these endpoints to requests from a known IP address range" - urls = [ - "api.mysite.com/some/endpoint*", - ] +resource "cloudflare_zone_lockdown" "example_zone_lockdown" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" configurations = [{ - target = "ip_range" - value = "192.0.2.0/24" + target = "ip" + value = "198.51.100.4" }] + urls = ["shop.example.com/*"] } ``` + ## Schema @@ -56,5 +52,5 @@ Optional: Import is supported using the following syntax: ```shell -$ terraform import cloudflare_zone_lockdown.example / +$ terraform import cloudflare_zone_lockdown.example '/' ``` diff --git a/docs/resources/zone_setting.md b/docs/resources/zone_setting.md index 94a62d7b74..8c3e6f1cad 100644 --- a/docs/resources/zone_setting.md +++ b/docs/resources/zone_setting.md @@ -9,6 +9,16 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_zone_setting" "example_zone_setting" { + zone_id = "023e105f4ecef8ad9ca31a8372d0c353" + setting_id = "always_online" + id = "0rtt" + value = "on" +} +``` ## Schema @@ -30,4 +40,10 @@ description: |- - `time_remaining` (Number) Value of the zone setting. Notes: The interval (in seconds) from when development mode expires (positive integer) or last expired (negative integer) for the domain. If development mode has never been enabled, this value is false. +## Import + +Import is supported using the following syntax: +```shell +$ terraform import cloudflare_zone_setting.example '/' +``` diff --git a/docs/resources/zone_subscription.md b/docs/resources/zone_subscription.md index e5add46f94..deb8d02e43 100644 --- a/docs/resources/zone_subscription.md +++ b/docs/resources/zone_subscription.md @@ -9,6 +9,23 @@ description: |- +## Example Usage + +```terraform +resource "cloudflare_zone_subscription" "example_zone_subscription" { + identifier = "506e3185e9c882d175a2d0cb0093d9f2" + frequency = "weekly" + rate_plan = { + id = "free" + currency = "USD" + externally_managed = false + is_contract = false + public_name = "Business Plan" + scope = "zone" + sets = ["string"] + } +} +``` ## Schema diff --git a/templates/data-sources.md.tmpl b/templates/data-sources.md.tmpl index 3d4e6993ed..f18f334203 100644 --- a/templates/data-sources.md.tmpl +++ b/templates/data-sources.md.tmpl @@ -12,8 +12,9 @@ description: |- {{ if .HasExample -}} ## Example Usage -{{codefile "terraform" .ExampleFile}} +{{tffile .ExampleFile}} {{- end }} + {{ .SchemaMarkdown | trimspace }} {{ if .HasImport -}} @@ -21,5 +22,5 @@ description: |- Import is supported using the following syntax: -{{codefile "shell" .ImportFile}} +{{ codefile "shell" .ImportFile }} {{- end }} diff --git a/templates/resources.md.tmpl b/templates/resources.md.tmpl index 3d4e6993ed..05f3d51f49 100644 --- a/templates/resources.md.tmpl +++ b/templates/resources.md.tmpl @@ -12,8 +12,9 @@ description: |- {{ if .HasExample -}} ## Example Usage -{{codefile "terraform" .ExampleFile}} +{{ tffile .ExampleFile }} {{- end }} + {{ .SchemaMarkdown | trimspace }} {{ if .HasImport -}} @@ -21,5 +22,5 @@ description: |- Import is supported using the following syntax: -{{codefile "shell" .ImportFile}} +{{ codefile "shell" .ImportFile }} {{- end }}