pulumi-gcp 8.0.0a1__py3-none-any.whl → 8.0.0a1726253601__py3-none-any.whl

pulumi_gcp/certificateauthority/get_authority.py

@@ -288,6 +288,16 @@ def get_authority(certificate_authority_id: Optional[str] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    default = gcp.certificateauthority.get_authority(location="us-west1",
+        pool="pool-name",
+        certificate_authority_id="ca-id")
+    pulumi.export("csr", default.pem_csr)
+    ```
+
 
     :param str certificate_authority_id: ID of the certificate authority.
            
@@ -345,6 +355,16 @@ def get_authority_output(certificate_authority_id: Optional[pulumi.Input[Optiona
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    default = gcp.certificateauthority.get_authority(location="us-west1",
+        pool="pool-name",
+        certificate_authority_id="ca-id")
+    pulumi.export("csr", default.pem_csr)
+    ```
+
 
     :param str certificate_authority_id: ID of the certificate authority.
            

pulumi_gcp/certificatemanager/get_certificate_map.py

@@ -139,6 +139,13 @@ def get_certificate_map(name: Optional[str] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    default = gcp.certificatemanager.get_certificate_map(name="cert-map")
+    ```
+
 
     :param str name: The name of the certificate map.
            
@@ -174,6 +181,13 @@ def get_certificate_map_output(name: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    default = gcp.certificatemanager.get_certificate_map(name="cert-map")
+    ```
+
 
     :param str name: The name of the certificate map.
            

pulumi_gcp/cloudidentity/get_group_lookup.py

@@ -81,6 +81,15 @@ def get_group_lookup(group_key: Optional[Union['GetGroupLookupGroupKeyArgs', 'Ge
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    group = gcp.cloudidentity.get_group_lookup(group_key={
+        "id": "my-group@example.com",
+    })
+    ```
+
 
     :param Union['GetGroupLookupGroupKeyArgs', 'GetGroupLookupGroupKeyArgsDict'] group_key: The EntityKey of the Group to lookup. A unique identifier for an entity in the Cloud Identity Groups API.
            An entity can represent either a group with an optional namespace or a user without a namespace.
@@ -107,6 +116,15 @@ def get_group_lookup_output(group_key: Optional[pulumi.Input[Union['GetGroupLook
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    group = gcp.cloudidentity.get_group_lookup(group_key={
+        "id": "my-group@example.com",
+    })
+    ```
+
 
     :param Union['GetGroupLookupGroupKeyArgs', 'GetGroupLookupGroupKeyArgsDict'] group_key: The EntityKey of the Group to lookup. A unique identifier for an entity in the Cloud Identity Groups API.
            An entity can represent either a group with an optional namespace or a user without a namespace.

pulumi_gcp/cloudidentity/get_group_memberships.py

@@ -86,6 +86,13 @@ def get_group_memberships(group: Optional[str] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    members = gcp.cloudidentity.get_group_memberships(group="groups/123eab45c6defghi")
+    ```
+
 
     :param str group: The parent Group resource under which to lookup the Membership names. Must be of the form groups/{group_id}.
     """
@@ -116,6 +123,13 @@ def get_group_memberships_output(group: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    members = gcp.cloudidentity.get_group_memberships(group="groups/123eab45c6defghi")
+    ```
+
 
     :param str group: The parent Group resource under which to lookup the Membership names. Must be of the form groups/{group_id}.
     """

pulumi_gcp/cloudidentity/get_groups.py

@@ -80,6 +80,13 @@ def get_groups(parent: Optional[str] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    groups = gcp.cloudidentity.get_groups(parent="customers/A01b123xz")
+    ```
+
 
     :param str parent: The parent resource under which to list all Groups. Must be of the form identitysources/{identity_source_id} for external- identity-mapped groups or customers/{customer_id} for Google Groups.
     """
@@ -104,6 +111,13 @@ def get_groups_output(parent: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    groups = gcp.cloudidentity.get_groups(parent="customers/A01b123xz")
+    ```
+
 
     :param str parent: The parent resource under which to list all Groups. Must be of the form identitysources/{identity_source_id} for external- identity-mapped groups or customers/{customer_id} for Google Groups.
     """

pulumi_gcp/compute/disk_async_replication.py

@@ -119,6 +119,30 @@ class DiskAsyncReplication(pulumi.CustomResource):
 
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_gcp as gcp
+
+        primary_disk = gcp.compute.Disk("primary-disk",
+            name="primary-disk",
+            type="pd-ssd",
+            zone="europe-west4-a",
+            physical_block_size_bytes=4096)
+        secondary_disk = gcp.compute.Disk("secondary-disk",
+            name="secondary-disk",
+            type="pd-ssd",
+            zone="europe-west3-a",
+            async_primary_disk={
+                "disk": primary_disk.id,
+            },
+            physical_block_size_bytes=4096)
+        replication = gcp.compute.DiskAsyncReplication("replication",
+            primary_disk=primary_disk.id,
+            secondary_disk={
+                "disk": secondary_disk.id,
+            })
+        ```
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[str] primary_disk: The primary disk (source of replication).
@@ -139,6 +163,30 @@ class DiskAsyncReplication(pulumi.CustomResource):
 
         ## Example Usage
 
+        ```python
+        import pulumi
+        import pulumi_gcp as gcp
+
+        primary_disk = gcp.compute.Disk("primary-disk",
+            name="primary-disk",
+            type="pd-ssd",
+            zone="europe-west4-a",
+            physical_block_size_bytes=4096)
+        secondary_disk = gcp.compute.Disk("secondary-disk",
+            name="secondary-disk",
+            type="pd-ssd",
+            zone="europe-west3-a",
+            async_primary_disk={
+                "disk": primary_disk.id,
+            },
+            physical_block_size_bytes=4096)
+        replication = gcp.compute.DiskAsyncReplication("replication",
+            primary_disk=primary_disk.id,
+            secondary_disk={
+                "disk": secondary_disk.id,
+            })
+        ```
+
         :param str resource_name: The name of the resource.
         :param DiskAsyncReplicationArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_gcp/compute/get_backend_bucket.py

@@ -157,6 +157,13 @@ def get_backend_bucket(name: Optional[str] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    my_backend_bucket = gcp.compute.get_backend_bucket(name="my-backend")
+    ```
+
 
     :param str name: Name of the resource.
            
@@ -194,6 +201,13 @@ def get_backend_bucket_output(name: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    my_backend_bucket = gcp.compute.get_backend_bucket(name="my-backend")
+    ```
+
 
     :param str name: Name of the resource.
            

pulumi_gcp/compute/get_backend_service.py

@@ -384,6 +384,16 @@ def get_backend_service(name: Optional[str] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    baz = gcp.compute.get_backend_service(name="foobar")
+    default = gcp.compute.BackendService("default",
+        name="backend-service",
+        health_checks=baz.health_checks[0])
+    ```
+
 
     :param str name: The name of the Backend Service.
            
@@ -443,6 +453,16 @@ def get_backend_service_output(name: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    baz = gcp.compute.get_backend_service(name="foobar")
+    default = gcp.compute.BackendService("default",
+        name="backend-service",
+        health_checks=baz.health_checks[0])
+    ```
+
 
     :param str name: The name of the Backend Service.
            

pulumi_gcp/compute/get_certificate.py

@@ -147,6 +147,16 @@ def get_certificate(name: Optional[str] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    my_cert = gcp.compute.get_certificate(name="my-cert")
+    pulumi.export("certificate", my_cert.certificate)
+    pulumi.export("certificateId", my_cert.certificate_id)
+    pulumi.export("selfLink", my_cert.self_link)
+    ```
+
 
     :param str name: The name of the certificate.
            
@@ -183,6 +193,16 @@ def get_certificate_output(name: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    my_cert = gcp.compute.get_certificate(name="my-cert")
+    pulumi.export("certificate", my_cert.certificate)
+    pulumi.export("certificateId", my_cert.certificate_id)
+    pulumi.export("selfLink", my_cert.self_link)
+    ```
+
 
     :param str name: The name of the certificate.
            

pulumi_gcp/compute/get_forwarding_rule.py

@@ -374,6 +374,13 @@ def get_forwarding_rule(name: Optional[str] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    my_forwarding_rule = gcp.compute.get_forwarding_rule(name="forwarding-rule-us-east1")
+    ```
+
 
     :param str name: The name of the forwarding rule.
            
@@ -440,6 +447,13 @@ def get_forwarding_rule_output(name: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    my_forwarding_rule = gcp.compute.get_forwarding_rule(name="forwarding-rule-us-east1")
+    ```
+
 
     :param str name: The name of the forwarding rule.
            

pulumi_gcp/compute/get_forwarding_rules.py

@@ -94,6 +94,14 @@ def get_forwarding_rules(project: Optional[str] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    my_forwarding_rules = gcp.compute.get_forwarding_rules(project="my-cloud-project",
+        region="us-central1")
+    ```
+
 
     :param str project: The name of the project.
     :param str region: The region you want to get the forwarding rules from.
@@ -122,6 +130,14 @@ def get_forwarding_rules_output(project: Optional[pulumi.Input[Optional[str]]] =
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    my_forwarding_rules = gcp.compute.get_forwarding_rules(project="my-cloud-project",
+        region="us-central1")
+    ```
+
 
     :param str project: The name of the project.
     :param str region: The region you want to get the forwarding rules from.

pulumi_gcp/compute/get_global_forwarding_rule.py

@@ -274,6 +274,13 @@ def get_global_forwarding_rule(name: Optional[str] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    my_forwarding_rule = gcp.compute.get_global_forwarding_rule(name="forwarding-rule-global")
+    ```
+
 
     :param str name: The name of the global forwarding rule.
            
@@ -324,6 +331,13 @@ def get_global_forwarding_rule_output(name: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    my_forwarding_rule = gcp.compute.get_global_forwarding_rule(name="forwarding-rule-global")
+    ```
+
 
     :param str name: The name of the global forwarding rule.
            

pulumi_gcp/compute/get_hc_vpn_gateway.py

@@ -140,6 +140,13 @@ def get_hc_vpn_gateway(name: Optional[str] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    gateway = gcp.compute.get_hc_vpn_gateway(name="foobar")
+    ```
+
 
     :param str name: The name of the forwarding rule.
            
@@ -180,6 +187,13 @@ def get_hc_vpn_gateway_output(name: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    gateway = gcp.compute.get_hc_vpn_gateway(name="foobar")
+    ```
+
 
     :param str name: The name of the forwarding rule.
            

pulumi_gcp/compute/get_health_check.py

@@ -220,6 +220,13 @@ def get_health_check(name: Optional[str] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    health_check = gcp.compute.get_health_check(name="my-hc")
+    ```
+
 
     :param str name: Name of the resource.
            
@@ -264,6 +271,13 @@ def get_health_check_output(name: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    health_check = gcp.compute.get_health_check(name="my-hc")
+    ```
+
 
     :param str name: Name of the resource.
            

pulumi_gcp/compute/get_lbip_ranges.py

@@ -80,6 +80,22 @@ def get_lbip_ranges(opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGet
     https://cloud.google.com/compute/docs/load-balancing/health-checks#health_check_source_ips_and_firewall_rules
 
     ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    ranges = gcp.compute.get_lbip_ranges()
+    lb = gcp.compute.Firewall("lb",
+        name="lb-firewall",
+        network=main["name"],
+        allows=[{
+            "protocol": "tcp",
+            "ports": ["80"],
+        }],
+        source_ranges=ranges.networks,
+        target_tags=["InstanceBehindLoadBalancer"])
+    ```
     """
     __args__ = dict()
     opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
@@ -99,5 +115,21 @@ def get_lbip_ranges_output(opts: Optional[pulumi.InvokeOptions] = None) -> pulum
     https://cloud.google.com/compute/docs/load-balancing/health-checks#health_check_source_ips_and_firewall_rules
 
     ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    ranges = gcp.compute.get_lbip_ranges()
+    lb = gcp.compute.Firewall("lb",
+        name="lb-firewall",
+        network=main["name"],
+        allows=[{
+            "protocol": "tcp",
+            "ports": ["80"],
+        }],
+        source_ranges=ranges.networks,
+        target_tags=["InstanceBehindLoadBalancer"])
+    ```
     """
     ...

pulumi_gcp/compute/get_netblock_ip_ranges.py

@@ -103,8 +103,34 @@ def get_netblock_ip_ranges(range_type: Optional[str] = None,
 
     ### Cloud Ranges
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    netblock = gcp.compute.get_netblock_ip_ranges()
+    pulumi.export("cidrBlocks", netblock.cidr_blocks)
+    pulumi.export("cidrBlocksIpv4", netblock.cidr_blocks_ipv4s)
+    pulumi.export("cidrBlocksIpv6", netblock.cidr_blocks_ipv6s)
+    ```
+
     ### Allow Health Checks
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    legacy_hcs = gcp.compute.get_netblock_ip_ranges(range_type="legacy-health-checkers")
+    default = gcp.compute.Network("default", name="test-network")
+    allow_hcs = gcp.compute.Firewall("allow-hcs",
+        name="allow-hcs",
+        network=default.name,
+        allows=[{
+            "protocol": "tcp",
+            "ports": ["80"],
+        }],
+        source_ranges=legacy_hcs.cidr_blocks_ipv4s)
+    ```
+
 
     :param str range_type: The type of range for which to provide results.
            
@@ -149,8 +175,34 @@ def get_netblock_ip_ranges_output(range_type: Optional[pulumi.Input[Optional[str
 
     ### Cloud Ranges
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    netblock = gcp.compute.get_netblock_ip_ranges()
+    pulumi.export("cidrBlocks", netblock.cidr_blocks)
+    pulumi.export("cidrBlocksIpv4", netblock.cidr_blocks_ipv4s)
+    pulumi.export("cidrBlocksIpv6", netblock.cidr_blocks_ipv6s)
+    ```
+
     ### Allow Health Checks
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    legacy_hcs = gcp.compute.get_netblock_ip_ranges(range_type="legacy-health-checkers")
+    default = gcp.compute.Network("default", name="test-network")
+    allow_hcs = gcp.compute.Firewall("allow-hcs",
+        name="allow-hcs",
+        network=default.name,
+        allows=[{
+            "protocol": "tcp",
+            "ports": ["80"],
+        }],
+        source_ranges=legacy_hcs.cidr_blocks_ipv4s)
+    ```
+
 
     :param str range_type: The type of range for which to provide results.
            

pulumi_gcp/compute/get_network.py

@@ -135,6 +135,13 @@ def get_network(name: Optional[str] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    my_network = gcp.compute.get_network(name="default-us-east1")
+    ```
+
 
     :param str name: The name of the network.
            
@@ -169,6 +176,13 @@ def get_network_output(name: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    my_network = gcp.compute.get_network(name="default-us-east1")
+    ```
+
 
     :param str name: The name of the network.
            

pulumi_gcp/compute/get_networks.py

@@ -92,6 +92,13 @@ def get_networks(project: Optional[str] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    my_networks = gcp.compute.get_networks(project="my-cloud-project")
+    ```
+
 
     :param str project: The name of the project.
     """
@@ -115,6 +122,13 @@ def get_networks_output(project: Optional[pulumi.Input[Optional[str]]] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    my_networks = gcp.compute.get_networks(project="my-cloud-project")
+    ```
+
 
     :param str project: The name of the project.
     """

pulumi_gcp/compute/get_region_ssl_certificate.py

@@ -157,6 +157,16 @@ def get_region_ssl_certificate(name: Optional[str] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    my_cert = gcp.compute.get_region_ssl_certificate(name="my-cert")
+    pulumi.export("certificate", my_cert.certificate)
+    pulumi.export("certificateId", my_cert.certificate_id)
+    pulumi.export("selfLink", my_cert.self_link)
+    ```
+
 
     :param str name: The name of the certificate.
            
@@ -198,6 +208,16 @@ def get_region_ssl_certificate_output(name: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    my_cert = gcp.compute.get_region_ssl_certificate(name="my-cert")
+    pulumi.export("certificate", my_cert.certificate)
+    pulumi.export("certificateId", my_cert.certificate_id)
+    pulumi.export("selfLink", my_cert.self_link)
+    ```
+
 
     :param str name: The name of the certificate.
            

pulumi_gcp/compute/get_ssl_policy.py

@@ -171,6 +171,13 @@ def get_ssl_policy(name: Optional[str] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    my_ssl_policy = gcp.compute.get_ssl_policy(name="production-ssl-policy")
+    ```
+
 
     :param str name: The name of the SSL Policy.
            
@@ -208,6 +215,13 @@ def get_ssl_policy_output(name: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    my_ssl_policy = gcp.compute.get_ssl_policy(name="production-ssl-policy")
+    ```
+
 
     :param str name: The name of the SSL Policy.