pulumi-cloudflare 6.10.1__py3-none-any.whl → 6.11.0__py3-none-any.whl

pulumi_cloudflare/pulumi-plugin.json

@@ -1,5 +1,5 @@
 {
   "resource": true,
   "name": "cloudflare",
-  "version": "6.10.1"
+  "version": "6.11.0"
 }

pulumi_cloudflare/queue_consumer.py

@@ -285,6 +285,25 @@ class QueueConsumer(pulumi.CustomResource):
         """
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_cloudflare as cloudflare
+
+        example_queue_consumer = cloudflare.QueueConsumer("example_queue_consumer",
+            account_id="023e105f4ecef8ad9ca31a8372d0c353",
+            queue_id="023e105f4ecef8ad9ca31a8372d0c353",
+            dead_letter_queue="example-queue",
+            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")
+        ```
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[_builtins.str] account_id: A Resource identifier.
@@ -302,6 +321,25 @@ class QueueConsumer(pulumi.CustomResource):
         """
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_cloudflare as cloudflare
+
+        example_queue_consumer = cloudflare.QueueConsumer("example_queue_consumer",
+            account_id="023e105f4ecef8ad9ca31a8372d0c353",
+            queue_id="023e105f4ecef8ad9ca31a8372d0c353",
+            dead_letter_queue="example-queue",
+            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")
+        ```
+
         :param str resource_name: The name of the resource.
         :param QueueConsumerInitArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_cloudflare/r2_bucket_cors.py

@@ -166,6 +166,25 @@ class R2BucketCors(pulumi.CustomResource):
         """
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_cloudflare as cloudflare
+
+        example_r2_bucket_cors = cloudflare.R2BucketCors("example_r2_bucket_cors",
+            account_id="023e105f4ecef8ad9ca31a8372d0c353",
+            bucket_name="example-bucket",
+            rules=[{
+                "allowed": {
+                    "methods": ["GET"],
+                    "origins": ["http://localhost:3000"],
+                    "headers": ["x-requested-by"],
+                },
+                "id": "Allow Local Development",
+                "expose_headers": ["Content-Encoding"],
+                "max_age_seconds": 3600,
+            }])
+        ```
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[_builtins.str] account_id: Account ID.
@@ -181,6 +200,25 @@ class R2BucketCors(pulumi.CustomResource):
         """
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_cloudflare as cloudflare
+
+        example_r2_bucket_cors = cloudflare.R2BucketCors("example_r2_bucket_cors",
+            account_id="023e105f4ecef8ad9ca31a8372d0c353",
+            bucket_name="example-bucket",
+            rules=[{
+                "allowed": {
+                    "methods": ["GET"],
+                    "origins": ["http://localhost:3000"],
+                    "headers": ["x-requested-by"],
+                },
+                "id": "Allow Local Development",
+                "expose_headers": ["Content-Encoding"],
+                "max_age_seconds": 3600,
+            }])
+        ```
+
         :param str resource_name: The name of the resource.
         :param R2BucketCorsArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_cloudflare/r2_bucket_event_notification.py

@@ -24,23 +24,22 @@ class R2BucketEventNotificationArgs:
                  account_id: pulumi.Input[_builtins.str],
                  bucket_name: pulumi.Input[_builtins.str],
                  queue_id: pulumi.Input[_builtins.str],
-                 jurisdiction: Optional[pulumi.Input[_builtins.str]] = None,
-                 rules: Optional[pulumi.Input[Sequence[pulumi.Input['R2BucketEventNotificationRuleArgs']]]] = None):
+                 rules: pulumi.Input[Sequence[pulumi.Input['R2BucketEventNotificationRuleArgs']]],
+                 jurisdiction: Optional[pulumi.Input[_builtins.str]] = None):
         """
         The set of arguments for constructing a R2BucketEventNotification resource.
         :param pulumi.Input[_builtins.str] account_id: Account ID.
         :param pulumi.Input[_builtins.str] bucket_name: Name of the bucket.
         :param pulumi.Input[_builtins.str] queue_id: Queue ID.
-        :param pulumi.Input[_builtins.str] jurisdiction: Jurisdiction of the bucket
         :param pulumi.Input[Sequence[pulumi.Input['R2BucketEventNotificationRuleArgs']]] rules: Array of rules to drive notifications.
+        :param pulumi.Input[_builtins.str] jurisdiction: Jurisdiction of the bucket
         """
         pulumi.set(__self__, "account_id", account_id)
         pulumi.set(__self__, "bucket_name", bucket_name)
         pulumi.set(__self__, "queue_id", queue_id)
+        pulumi.set(__self__, "rules", rules)
         if jurisdiction is not None:
             pulumi.set(__self__, "jurisdiction", jurisdiction)
-        if rules is not None:
-            pulumi.set(__self__, "rules", rules)
 
     @_builtins.property
     @pulumi.getter(name="accountId")
@@ -80,27 +79,27 @@ class R2BucketEventNotificationArgs:
 
     @_builtins.property
     @pulumi.getter
-    def jurisdiction(self) -> Optional[pulumi.Input[_builtins.str]]:
+    def rules(self) -> pulumi.Input[Sequence[pulumi.Input['R2BucketEventNotificationRuleArgs']]]:
         """
-        Jurisdiction of the bucket
+        Array of rules to drive notifications.
         """
-        return pulumi.get(self, "jurisdiction")
+        return pulumi.get(self, "rules")
 
-    @jurisdiction.setter
-    def jurisdiction(self, value: Optional[pulumi.Input[_builtins.str]]):
-        pulumi.set(self, "jurisdiction", value)
+    @rules.setter
+    def rules(self, value: pulumi.Input[Sequence[pulumi.Input['R2BucketEventNotificationRuleArgs']]]):
+        pulumi.set(self, "rules", value)
 
     @_builtins.property
     @pulumi.getter
-    def rules(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['R2BucketEventNotificationRuleArgs']]]]:
+    def jurisdiction(self) -> Optional[pulumi.Input[_builtins.str]]:
         """
-        Array of rules to drive notifications.
+        Jurisdiction of the bucket
         """
-        return pulumi.get(self, "rules")
+        return pulumi.get(self, "jurisdiction")
 
-    @rules.setter
-    def rules(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['R2BucketEventNotificationRuleArgs']]]]):
-        pulumi.set(self, "rules", value)
+    @jurisdiction.setter
+    def jurisdiction(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "jurisdiction", value)
 
 
 @pulumi.input_type
@@ -316,6 +315,8 @@ class R2BucketEventNotification(pulumi.CustomResource):
             if queue_id is None and not opts.urn:
                 raise TypeError("Missing required property 'queue_id'")
             __props__.__dict__["queue_id"] = queue_id
+            if rules is None and not opts.urn:
+                raise TypeError("Missing required property 'rules'")
             __props__.__dict__["rules"] = rules
             __props__.__dict__["queue_name"] = None
         super(R2BucketEventNotification, __self__).__init__(
@@ -402,7 +403,7 @@ class R2BucketEventNotification(pulumi.CustomResource):
 
     @_builtins.property
     @pulumi.getter
-    def rules(self) -> pulumi.Output[Optional[Sequence['outputs.R2BucketEventNotificationRule']]]:
+    def rules(self) -> pulumi.Output[Sequence['outputs.R2BucketEventNotificationRule']]:
         """
         Array of rules to drive notifications.
         """

pulumi_cloudflare/r2_bucket_lifecycle.py

@@ -166,6 +166,41 @@ class R2BucketLifecycle(pulumi.CustomResource):
         """
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_cloudflare as cloudflare
+
+        example_r2_bucket_lifecycle = cloudflare.R2BucketLifecycle("example_r2_bucket_lifecycle",
+            account_id="023e105f4ecef8ad9ca31a8372d0c353",
+            bucket_name="example-bucket",
+            rules=[{
+                "id": "Expire all objects older than 24 hours",
+                "conditions": {
+                    "prefix": "prefix",
+                },
+                "enabled": True,
+                "abort_multipart_uploads_transition": {
+                    "condition": {
+                        "max_age": 0,
+                        "type": "Age",
+                    },
+                },
+                "delete_objects_transition": {
+                    "condition": {
+                        "max_age": 0,
+                        "type": "Age",
+                    },
+                },
+                "storage_class_transitions": [{
+                    "condition": {
+                        "max_age": 0,
+                        "type": "Age",
+                    },
+                    "storage_class": "InfrequentAccess",
+                }],
+            }])
+        ```
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[_builtins.str] account_id: Account ID.
@@ -181,6 +216,41 @@ class R2BucketLifecycle(pulumi.CustomResource):
         """
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_cloudflare as cloudflare
+
+        example_r2_bucket_lifecycle = cloudflare.R2BucketLifecycle("example_r2_bucket_lifecycle",
+            account_id="023e105f4ecef8ad9ca31a8372d0c353",
+            bucket_name="example-bucket",
+            rules=[{
+                "id": "Expire all objects older than 24 hours",
+                "conditions": {
+                    "prefix": "prefix",
+                },
+                "enabled": True,
+                "abort_multipart_uploads_transition": {
+                    "condition": {
+                        "max_age": 0,
+                        "type": "Age",
+                    },
+                },
+                "delete_objects_transition": {
+                    "condition": {
+                        "max_age": 0,
+                        "type": "Age",
+                    },
+                },
+                "storage_class_transitions": [{
+                    "condition": {
+                        "max_age": 0,
+                        "type": "Age",
+                    },
+                    "storage_class": "InfrequentAccess",
+                }],
+            }])
+        ```
+
         :param str resource_name: The name of the resource.
         :param R2BucketLifecycleArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_cloudflare/record.py

@@ -508,6 +508,25 @@ class Record(pulumi.CustomResource):
         """
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_cloudflare as cloudflare
+
+        example_dns_record = cloudflare.DnsRecord("example_dns_record",
+            zone_id="023e105f4ecef8ad9ca31a8372d0c353",
+            name="example.com",
+            ttl=3600,
+            type="A",
+            comment="Domain verification record",
+            content="198.51.100.4",
+            proxied=True,
+            settings={
+                "ipv4_only": True,
+                "ipv6_only": True,
+            },
+            tags=["owner:dns-team"])
+        ```
+
         ## Import
 
         ```sh
@@ -538,6 +557,25 @@ class Record(pulumi.CustomResource):
         """
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_cloudflare as cloudflare
+
+        example_dns_record = cloudflare.DnsRecord("example_dns_record",
+            zone_id="023e105f4ecef8ad9ca31a8372d0c353",
+            name="example.com",
+            ttl=3600,
+            type="A",
+            comment="Domain verification record",
+            content="198.51.100.4",
+            proxied=True,
+            settings={
+                "ipv4_only": True,
+                "ipv6_only": True,
+            },
+            tags=["owner:dns-team"])
+        ```
+
         ## Import
 
         ```sh

pulumi_cloudflare/snippet.py

@@ -204,6 +204,27 @@ class Snippet(pulumi.CustomResource):
         """
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_cloudflare as cloudflare
+
+        example_snippet = cloudflare.Snippet("example_snippet",
+            zone_id="9f1839b6152d298aca64c4e906b6d074",
+            snippet_name="my_snippet",
+            files=[{
+                "name": "main.js",
+                "content": \"\"\"export default {
+          async fetch(request) {
+            return new Response('Hello, World!');
+          }
+        }
+        \"\"\",
+            }],
+            metadata={
+                "main_module": "main.js",
+            })
+        ```
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[Sequence[pulumi.Input[Union['SnippetFileArgs', 'SnippetFileArgsDict']]]] files: The list of files belonging to the snippet.
@@ -220,6 +241,27 @@ class Snippet(pulumi.CustomResource):
         """
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_cloudflare as cloudflare
+
+        example_snippet = cloudflare.Snippet("example_snippet",
+            zone_id="9f1839b6152d298aca64c4e906b6d074",
+            snippet_name="my_snippet",
+            files=[{
+                "name": "main.js",
+                "content": \"\"\"export default {
+          async fetch(request) {
+            return new Response('Hello, World!');
+          }
+        }
+        \"\"\",
+            }],
+            metadata={
+                "main_module": "main.js",
+            })
+        ```
+
         :param str resource_name: The name of the resource.
         :param SnippetArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_cloudflare/snippet_rules.py

@@ -108,6 +108,20 @@ class SnippetRules(pulumi.CustomResource):
         """
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_cloudflare as cloudflare
+
+        example_snippet_rules = cloudflare.SnippetRules("example_snippet_rules",
+            zone_id="9f1839b6152d298aca64c4e906b6d074",
+            rules=[{
+                "expression": "ip.src eq 1.1.1.1",
+                "snippet_name": "my_snippet",
+                "description": "Execute my_snippet when IP address is 1.1.1.1.",
+                "enabled": True,
+            }])
+        ```
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[Sequence[pulumi.Input[Union['SnippetRulesRuleArgs', 'SnippetRulesRuleArgsDict']]]] rules: A list of snippet rules.
@@ -122,6 +136,20 @@ class SnippetRules(pulumi.CustomResource):
         """
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_cloudflare as cloudflare
+
+        example_snippet_rules = cloudflare.SnippetRules("example_snippet_rules",
+            zone_id="9f1839b6152d298aca64c4e906b6d074",
+            rules=[{
+                "expression": "ip.src eq 1.1.1.1",
+                "snippet_name": "my_snippet",
+                "description": "Execute my_snippet when IP address is 1.1.1.1.",
+                "enabled": True,
+            }])
+        ```
+
         :param str resource_name: The name of the resource.
         :param SnippetRulesArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_cloudflare/static_route.py

@@ -308,6 +308,23 @@ class StaticRoute(pulumi.CustomResource):
         """
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_cloudflare as cloudflare
+
+        example_magic_wan_static_route = cloudflare.MagicWanStaticRoute("example_magic_wan_static_route",
+            account_id="023e105f4ecef8ad9ca31a8372d0c353",
+            nexthop="203.0.113.1",
+            prefix="192.0.2.0/24",
+            priority=0,
+            description="New route for new prefix 203.0.113.1",
+            scope={
+                "colo_names": ["den01"],
+                "colo_regions": ["APAC"],
+            },
+            weight=0)
+        ```
+
         ## Import
 
         ```sh
@@ -333,6 +350,23 @@ class StaticRoute(pulumi.CustomResource):
         """
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_cloudflare as cloudflare
+
+        example_magic_wan_static_route = cloudflare.MagicWanStaticRoute("example_magic_wan_static_route",
+            account_id="023e105f4ecef8ad9ca31a8372d0c353",
+            nexthop="203.0.113.1",
+            prefix="192.0.2.0/24",
+            priority=0,
+            description="New route for new prefix 203.0.113.1",
+            scope={
+                "colo_names": ["den01"],
+                "colo_regions": ["APAC"],
+            },
+            weight=0)
+        ```
+
         ## Import
 
         ```sh

pulumi_cloudflare/teams_account.py

@@ -130,6 +130,80 @@ class TeamsAccount(pulumi.CustomResource):
         """
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_cloudflare as cloudflare
+
+        example_zero_trust_gateway_settings = cloudflare.ZeroTrustGatewaySettings("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,
+                        "include_context": True,
+                        "msg": "msg",
+                        "support_url": "support_url",
+                    },
+                },
+                "block_page": {
+                    "background_color": "background_color",
+                    "enabled": True,
+                    "footer_text": "--footer--",
+                    "header_text": "--header--",
+                    "include_context": True,
+                    "logo_path": "https://logos.com/a.png",
+                    "mailto_address": "admin@example.com",
+                    "mailto_subject": "Blocked User Inquiry",
+                    "mode": "",
+                    "name": "Cloudflare",
+                    "suppress_footer": False,
+                    "target_uri": "https://example.com",
+                },
+                "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",
+                },
+                "extended_email_matching": {
+                    "enabled": True,
+                },
+                "fips": {
+                    "tls": True,
+                },
+                "host_selector": {
+                    "enabled": False,
+                },
+                "inspection": {
+                    "mode": "static",
+                },
+                "protocol_detection": {
+                    "enabled": True,
+                },
+                "sandbox": {
+                    "enabled": True,
+                    "fallback_action": "allow",
+                },
+                "tls_decrypt": {
+                    "enabled": True,
+                },
+            })
+        ```
+
         ## Import
 
         ```sh
@@ -149,6 +223,80 @@ class TeamsAccount(pulumi.CustomResource):
         """
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_cloudflare as cloudflare
+
+        example_zero_trust_gateway_settings = cloudflare.ZeroTrustGatewaySettings("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,
+                        "include_context": True,
+                        "msg": "msg",
+                        "support_url": "support_url",
+                    },
+                },
+                "block_page": {
+                    "background_color": "background_color",
+                    "enabled": True,
+                    "footer_text": "--footer--",
+                    "header_text": "--header--",
+                    "include_context": True,
+                    "logo_path": "https://logos.com/a.png",
+                    "mailto_address": "admin@example.com",
+                    "mailto_subject": "Blocked User Inquiry",
+                    "mode": "",
+                    "name": "Cloudflare",
+                    "suppress_footer": False,
+                    "target_uri": "https://example.com",
+                },
+                "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",
+                },
+                "extended_email_matching": {
+                    "enabled": True,
+                },
+                "fips": {
+                    "tls": True,
+                },
+                "host_selector": {
+                    "enabled": False,
+                },
+                "inspection": {
+                    "mode": "static",
+                },
+                "protocol_detection": {
+                    "enabled": True,
+                },
+                "sandbox": {
+                    "enabled": True,
+                    "fallback_action": "allow",
+                },
+                "tls_decrypt": {
+                    "enabled": True,
+                },
+            })
+        ```
+
         ## Import
 
         ```sh