pulumi-gcp 7.13.0__py3-none-any.whl → 7.14.0__py3-none-any.whl

pulumi_gcp/dns/get_keys.py

@@ -104,6 +104,7 @@ def get_keys(managed_zone: Optional[str] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_gcp as gcp
@@ -118,6 +119,7 @@ def get_keys(managed_zone: Optional[str] = None,
     foo_dns_keys = gcp.dns.get_keys_output(managed_zone=foo.id)
     pulumi.export("fooDnsDsRecord", foo_dns_keys.key_signing_keys[0].ds_record)
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str managed_zone: The name or id of the Cloud DNS managed zone.
@@ -155,6 +157,7 @@ def get_keys_output(managed_zone: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_gcp as gcp
@@ -169,6 +172,7 @@ def get_keys_output(managed_zone: Optional[pulumi.Input[str]] = None,
     foo_dns_keys = gcp.dns.get_keys_output(managed_zone=foo.id)
     pulumi.export("fooDnsDsRecord", foo_dns_keys.key_signing_keys[0].ds_record)
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str managed_zone: The name or id of the Cloud DNS managed zone.

pulumi_gcp/dns/get_managed_zone.py

@@ -129,6 +129,7 @@ def get_managed_zone(name: Optional[str] = None,
     and
     [API](https://cloud.google.com/dns/api/v1/managedZones).
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_gcp as gcp
@@ -141,6 +142,7 @@ def get_managed_zone(name: Optional[str] = None,
         managed_zone=env_dns_zone.name,
         rrdatas=["test"])
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str name: A unique name for the resource.
@@ -174,6 +176,7 @@ def get_managed_zone_output(name: Optional[pulumi.Input[str]] = None,
     and
     [API](https://cloud.google.com/dns/api/v1/managedZones).
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_gcp as gcp
@@ -186,6 +189,7 @@ def get_managed_zone_output(name: Optional[pulumi.Input[str]] = None,
         managed_zone=env_dns_zone.name,
         rrdatas=["test"])
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str name: A unique name for the resource.

pulumi_gcp/dns/get_managed_zone_iam_policy.py

@@ -95,6 +95,7 @@ def get_managed_zone_iam_policy(managed_zone: Optional[str] = None,
 
     ## example
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_gcp as gcp
@@ -102,6 +103,7 @@ def get_managed_zone_iam_policy(managed_zone: Optional[str] = None,
     policy = gcp.dns.get_managed_zone_iam_policy(project=default["project"],
         managed_zone=default["name"])
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str managed_zone: Used to find the parent resource to bind the IAM policy to
@@ -131,6 +133,7 @@ def get_managed_zone_iam_policy_output(managed_zone: Optional[pulumi.Input[str]]
 
     ## example
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_gcp as gcp
@@ -138,6 +141,7 @@ def get_managed_zone_iam_policy_output(managed_zone: Optional[pulumi.Input[str]]
     policy = gcp.dns.get_managed_zone_iam_policy(project=default["project"],
         managed_zone=default["name"])
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str managed_zone: Used to find the parent resource to bind the IAM policy to

pulumi_gcp/dns/get_managed_zones.py

@@ -74,12 +74,14 @@ def get_managed_zones(managed_zones: Optional[Sequence[pulumi.InputType['GetMana
     and
     [API](https://cloud.google.com/dns/api/v1/managedZones).
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_gcp as gcp
 
     zones = gcp.dns.get_managed_zones(project="my-project-id")
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param Sequence[pulumi.InputType['GetManagedZonesManagedZoneArgs']] managed_zones: A list of managed zones.
@@ -108,12 +110,14 @@ def get_managed_zones_output(managed_zones: Optional[pulumi.Input[Optional[Seque
     and
     [API](https://cloud.google.com/dns/api/v1/managedZones).
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_gcp as gcp
 
     zones = gcp.dns.get_managed_zones(project="my-project-id")
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param Sequence[pulumi.InputType['GetManagedZonesManagedZoneArgs']] managed_zones: A list of managed zones.

pulumi_gcp/dns/get_record_set.py

@@ -115,16 +115,6 @@ def get_record_set(managed_zone: Optional[str] = None,
 
     ## Example Usage
 
-    ```python
-    import pulumi
-    import pulumi_gcp as gcp
-
-    sample = gcp.dns.get_managed_zone(name="sample-zone")
-    rs = gcp.dns.get_record_set(managed_zone=sample.name,
-        name=f"my-record.{sample.dns_name}",
-        type="A")
-    ```
-
 
     :param str managed_zone: The Name of the zone.
     :param str name: The DNS name for the resource.
@@ -164,16 +154,6 @@ def get_record_set_output(managed_zone: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
-    ```python
-    import pulumi
-    import pulumi_gcp as gcp
-
-    sample = gcp.dns.get_managed_zone(name="sample-zone")
-    rs = gcp.dns.get_record_set(managed_zone=sample.name,
-        name=f"my-record.{sample.dns_name}",
-        type="A")
-    ```
-
 
     :param str managed_zone: The Name of the zone.
     :param str name: The DNS name for the resource.

pulumi_gcp/dns/managed_zone.py

@@ -686,8 +686,10 @@ class ManagedZone(pulumi.CustomResource):
             * [Managing Zones](https://cloud.google.com/dns/zones/)
 
         ## Example Usage
+
         ### Dns Managed Zone Basic
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -700,8 +702,10 @@ class ManagedZone(pulumi.CustomResource):
                 "foo": "bar",
             })
         ```
+        <!--End PulumiCodeChooser -->
         ### Dns Managed Zone Private
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -731,8 +735,10 @@ class ManagedZone(pulumi.CustomResource):
                 ],
             ))
         ```
+        <!--End PulumiCodeChooser -->
         ### Dns Managed Zone Private Forwarding
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -772,8 +778,10 @@ class ManagedZone(pulumi.CustomResource):
                 ],
             ))
         ```
+        <!--End PulumiCodeChooser -->
         ### Dns Managed Zone Private Gke
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -835,8 +843,10 @@ class ManagedZone(pulumi.CustomResource):
                 )],
             ))
         ```
+        <!--End PulumiCodeChooser -->
         ### Dns Managed Zone Private Peering
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -863,8 +873,10 @@ class ManagedZone(pulumi.CustomResource):
                 ),
             ))
         ```
+        <!--End PulumiCodeChooser -->
         ### Dns Managed Zone Service Directory
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -886,8 +898,10 @@ class ManagedZone(pulumi.CustomResource):
             name="network",
             auto_create_subnetworks=False)
         ```
+        <!--End PulumiCodeChooser -->
         ### Dns Managed Zone Cloud Logging
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -903,18 +917,19 @@ class ManagedZone(pulumi.CustomResource):
                 enable_logging=True,
             ))
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
         ManagedZone can be imported using any of these accepted formats:
 
-         * `projects/{{project}}/managedZones/{{name}}`
+        * `projects/{{project}}/managedZones/{{name}}`
 
-         * `{{project}}/{{name}}`
+        * `{{project}}/{{name}}`
 
-         * `{{name}}`
+        * `{{name}}`
 
-         When using the `pulumi import` command, ManagedZone can be imported using one of the formats above. For example:
+        When using the `pulumi import` command, ManagedZone can be imported using one of the formats above. For example:
 
         ```sh
         $ pulumi import gcp:dns/managedZone:ManagedZone default projects/{{project}}/managedZones/{{name}}
@@ -985,8 +1000,10 @@ class ManagedZone(pulumi.CustomResource):
             * [Managing Zones](https://cloud.google.com/dns/zones/)
 
         ## Example Usage
+
         ### Dns Managed Zone Basic
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -999,8 +1016,10 @@ class ManagedZone(pulumi.CustomResource):
                 "foo": "bar",
             })
         ```
+        <!--End PulumiCodeChooser -->
         ### Dns Managed Zone Private
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -1030,8 +1049,10 @@ class ManagedZone(pulumi.CustomResource):
                 ],
             ))
         ```
+        <!--End PulumiCodeChooser -->
         ### Dns Managed Zone Private Forwarding
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -1071,8 +1092,10 @@ class ManagedZone(pulumi.CustomResource):
                 ],
             ))
         ```
+        <!--End PulumiCodeChooser -->
         ### Dns Managed Zone Private Gke
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -1134,8 +1157,10 @@ class ManagedZone(pulumi.CustomResource):
                 )],
             ))
         ```
+        <!--End PulumiCodeChooser -->
         ### Dns Managed Zone Private Peering
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -1162,8 +1187,10 @@ class ManagedZone(pulumi.CustomResource):
                 ),
             ))
         ```
+        <!--End PulumiCodeChooser -->
         ### Dns Managed Zone Service Directory
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -1185,8 +1212,10 @@ class ManagedZone(pulumi.CustomResource):
             name="network",
             auto_create_subnetworks=False)
         ```
+        <!--End PulumiCodeChooser -->
         ### Dns Managed Zone Cloud Logging
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -1202,18 +1231,19 @@ class ManagedZone(pulumi.CustomResource):
                 enable_logging=True,
             ))
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
         ManagedZone can be imported using any of these accepted formats:
 
-         * `projects/{{project}}/managedZones/{{name}}`
+        * `projects/{{project}}/managedZones/{{name}}`
 
-         * `{{project}}/{{name}}`
+        * `{{project}}/{{name}}`
 
-         * `{{name}}`
+        * `{{name}}`
 
-         When using the `pulumi import` command, ManagedZone can be imported using one of the formats above. For example:
+        When using the `pulumi import` command, ManagedZone can be imported using one of the formats above. For example:
 
         ```sh
         $ pulumi import gcp:dns/managedZone:ManagedZone default projects/{{project}}/managedZones/{{name}}

pulumi_gcp/dns/policy.py

@@ -325,8 +325,10 @@ class Policy(pulumi.CustomResource):
             * [Using DNS server policies](https://cloud.google.com/dns/zones/#using-dns-server-policies)
 
         ## Example Usage
+
         ### Dns Policy Basic
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -361,18 +363,19 @@ class Policy(pulumi.CustomResource):
                 ),
             ])
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
         Policy can be imported using any of these accepted formats:
 
-         * `projects/{{project}}/policies/{{name}}`
+        * `projects/{{project}}/policies/{{name}}`
 
-         * `{{project}}/{{name}}`
+        * `{{project}}/{{name}}`
 
-         * `{{name}}`
+        * `{{name}}`
 
-         When using the `pulumi import` command, Policy can be imported using one of the formats above. For example:
+        When using the `pulumi import` command, Policy can be imported using one of the formats above. For example:
 
         ```sh
         $ pulumi import gcp:dns/policy:Policy default projects/{{project}}/policies/{{name}}
@@ -425,8 +428,10 @@ class Policy(pulumi.CustomResource):
             * [Using DNS server policies](https://cloud.google.com/dns/zones/#using-dns-server-policies)
 
         ## Example Usage
+
         ### Dns Policy Basic
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -461,18 +466,19 @@ class Policy(pulumi.CustomResource):
                 ),
             ])
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
         Policy can be imported using any of these accepted formats:
 
-         * `projects/{{project}}/policies/{{name}}`
+        * `projects/{{project}}/policies/{{name}}`
 
-         * `{{project}}/{{name}}`
+        * `{{project}}/{{name}}`
 
-         * `{{name}}`
+        * `{{name}}`
 
-         When using the `pulumi import` command, Policy can be imported using one of the formats above. For example:
+        When using the `pulumi import` command, Policy can be imported using one of the formats above. For example:
 
         ```sh
         $ pulumi import gcp:dns/policy:Policy default projects/{{project}}/policies/{{name}}

pulumi_gcp/dns/record_set.py

@@ -301,8 +301,10 @@ class RecordSet(pulumi.CustomResource):
                  __props__=None):
         """
         ## Example Usage
+
         ### Binding a DNS name to the ephemeral IP of a new instance:
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -330,8 +332,11 @@ class RecordSet(pulumi.CustomResource):
             managed_zone=prod.name,
             rrdatas=[frontend_instance.network_interfaces[0].access_configs[0].nat_ip])
         ```
+        <!--End PulumiCodeChooser -->
+
         ### Adding an A record
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -346,8 +351,11 @@ class RecordSet(pulumi.CustomResource):
             ttl=300,
             rrdatas=["8.8.8.8"])
         ```
+        <!--End PulumiCodeChooser -->
+
         ### Adding an MX record
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -368,10 +376,13 @@ class RecordSet(pulumi.CustomResource):
                 "10 alt4.aspmx.l.google.com.",
             ])
         ```
+        <!--End PulumiCodeChooser -->
+
         ### Adding an SPF record
 
         Quotes (`""`) must be added around your `rrdatas` for a SPF record. Otherwise `rrdatas` string gets split on spaces.
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -386,10 +397,13 @@ class RecordSet(pulumi.CustomResource):
             ttl=300,
             rrdatas=["\\"v=spf1 ip4:111.111.111.111 include:backoff.email-example.com -all\\""])
         ```
+        <!--End PulumiCodeChooser -->
+
         ### Adding a CNAME record
 
          The list of `rrdatas` should only contain a single string corresponding to the Canonical Name intended.
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -404,9 +418,12 @@ class RecordSet(pulumi.CustomResource):
             ttl=300,
             rrdatas=["frontend.mydomain.com."])
         ```
+        <!--End PulumiCodeChooser -->
+
         ### Setting Routing Policy instead of using rrdatas
         ### Geolocation
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -429,8 +446,11 @@ class RecordSet(pulumi.CustomResource):
                 ],
             ))
         ```
+        <!--End PulumiCodeChooser -->
+
         ### Primary-Backup
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -482,18 +502,19 @@ class RecordSet(pulumi.CustomResource):
                 ),
             ))
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
         DNS record sets can be imported using either of these accepted formats:
 
-         * `projects/{{project}}/managedZones/{{zone}}/rrsets/{{name}}/{{type}}`
+        * `projects/{{project}}/managedZones/{{zone}}/rrsets/{{name}}/{{type}}`
 
-         * `{{project}}/{{zone}}/{{name}}/{{type}}`
+        * `{{project}}/{{zone}}/{{name}}/{{type}}`
 
-         * `{{zone}}/{{name}}/{{type}}`
+        * `{{zone}}/{{name}}/{{type}}`
 
-         When using the `pulumi import` command, DNS record sets can be imported using one of the formats above. For example:
+        When using the `pulumi import` command, DNS record sets can be imported using one of the formats above. For example:
 
         ```sh
         $ pulumi import gcp:dns/recordSet:RecordSet default projects/{{project}}/managedZones/{{zone}}/rrsets/{{name}}/{{type}}
@@ -507,7 +528,7 @@ class RecordSet(pulumi.CustomResource):
         $ pulumi import gcp:dns/recordSet:RecordSet default {{zone}}/{{name}}/{{type}}
         ```
 
-         Note: The record name must include the trailing dot at the end.
+        Note: The record name must include the trailing dot at the end.
 
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
@@ -536,8 +557,10 @@ class RecordSet(pulumi.CustomResource):
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
         ## Example Usage
+
         ### Binding a DNS name to the ephemeral IP of a new instance:
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -565,8 +588,11 @@ class RecordSet(pulumi.CustomResource):
             managed_zone=prod.name,
             rrdatas=[frontend_instance.network_interfaces[0].access_configs[0].nat_ip])
         ```
+        <!--End PulumiCodeChooser -->
+
         ### Adding an A record
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -581,8 +607,11 @@ class RecordSet(pulumi.CustomResource):
             ttl=300,
             rrdatas=["8.8.8.8"])
         ```
+        <!--End PulumiCodeChooser -->
+
         ### Adding an MX record
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -603,10 +632,13 @@ class RecordSet(pulumi.CustomResource):
                 "10 alt4.aspmx.l.google.com.",
             ])
         ```
+        <!--End PulumiCodeChooser -->
+
         ### Adding an SPF record
 
         Quotes (`""`) must be added around your `rrdatas` for a SPF record. Otherwise `rrdatas` string gets split on spaces.
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -621,10 +653,13 @@ class RecordSet(pulumi.CustomResource):
             ttl=300,
             rrdatas=["\\"v=spf1 ip4:111.111.111.111 include:backoff.email-example.com -all\\""])
         ```
+        <!--End PulumiCodeChooser -->
+
         ### Adding a CNAME record
 
          The list of `rrdatas` should only contain a single string corresponding to the Canonical Name intended.
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -639,9 +674,12 @@ class RecordSet(pulumi.CustomResource):
             ttl=300,
             rrdatas=["frontend.mydomain.com."])
         ```
+        <!--End PulumiCodeChooser -->
+
         ### Setting Routing Policy instead of using rrdatas
         ### Geolocation
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -664,8 +702,11 @@ class RecordSet(pulumi.CustomResource):
                 ],
             ))
         ```
+        <!--End PulumiCodeChooser -->
+
         ### Primary-Backup
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_gcp as gcp
@@ -717,18 +758,19 @@ class RecordSet(pulumi.CustomResource):
                 ),
             ))
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
         DNS record sets can be imported using either of these accepted formats:
 
-         * `projects/{{project}}/managedZones/{{zone}}/rrsets/{{name}}/{{type}}`
+        * `projects/{{project}}/managedZones/{{zone}}/rrsets/{{name}}/{{type}}`
 
-         * `{{project}}/{{zone}}/{{name}}/{{type}}`
+        * `{{project}}/{{zone}}/{{name}}/{{type}}`
 
-         * `{{zone}}/{{name}}/{{type}}`
+        * `{{zone}}/{{name}}/{{type}}`
 
-         When using the `pulumi import` command, DNS record sets can be imported using one of the formats above. For example:
+        When using the `pulumi import` command, DNS record sets can be imported using one of the formats above. For example:
 
         ```sh
         $ pulumi import gcp:dns/recordSet:RecordSet default projects/{{project}}/managedZones/{{zone}}/rrsets/{{name}}/{{type}}
@@ -742,7 +784,7 @@ class RecordSet(pulumi.CustomResource):
         $ pulumi import gcp:dns/recordSet:RecordSet default {{zone}}/{{name}}/{{type}}
         ```
 
-         Note: The record name must include the trailing dot at the end.
+        Note: The record name must include the trailing dot at the end.
 
         :param str resource_name: The name of the resource.
         :param RecordSetArgs args: The arguments to use to populate this resource's properties.