pulumi-alicloud 3.74.0a1737782319__py3-none-any.whl → 3.75.0__py3-none-any.whl

pulumi_alicloud/vpc/get_enhanced_nat_available_zones.py

@@ -52,6 +52,9 @@ class GetEnhancedNatAvailableZonesResult:
     @property
     @pulumi.getter
     def ids(self) -> Sequence[str]:
+        """
+        (Optional) A list of available zones IDs by the enhanced NAT gateway.
+        """
         return pulumi.get(self, "ids")
 
     @property
@@ -62,6 +65,9 @@ class GetEnhancedNatAvailableZonesResult:
     @property
     @pulumi.getter
     def zones(self) -> Sequence['outputs.GetEnhancedNatAvailableZonesZoneResult']:
+        """
+        A list of available zones. Each element contains the following attributes:
+        """
         return pulumi.get(self, "zones")
 
 
@@ -80,7 +86,22 @@ class AwaitableGetEnhancedNatAvailableZonesResult(GetEnhancedNatAvailableZonesRe
 def get_enhanced_nat_available_zones(output_file: Optional[str] = None,
                                      opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetEnhancedNatAvailableZonesResult:
     """
-    Use this data source to access information about an existing resource.
+    This data source provides a list of available zones by the enhanced Nat Gateway.
+
+    > **NOTE:** Available since 1.102.0+.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_alicloud as alicloud
+
+    default = alicloud.vpc.get_enhanced_nat_available_zones()
+    pulumi.export("zones", default.zones[0].zone_id)
+    ```
+
+
+    :param str output_file: File name where to save data source results (after running `pulumi preview`).
     """
     __args__ = dict()
     __args__['outputFile'] = output_file
@@ -95,7 +116,22 @@ def get_enhanced_nat_available_zones(output_file: Optional[str] = None,
 def get_enhanced_nat_available_zones_output(output_file: Optional[pulumi.Input[Optional[str]]] = None,
                                             opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetEnhancedNatAvailableZonesResult]:
     """
-    Use this data source to access information about an existing resource.
+    This data source provides a list of available zones by the enhanced Nat Gateway.
+
+    > **NOTE:** Available since 1.102.0+.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_alicloud as alicloud
+
+    default = alicloud.vpc.get_enhanced_nat_available_zones()
+    pulumi.export("zones", default.zones[0].zone_id)
+    ```
+
+
+    :param str output_file: File name where to save data source results (after running `pulumi preview`).
     """
     __args__ = dict()
     __args__['outputFile'] = output_file

pulumi_alicloud/vpc/get_forward_entries.py

@@ -212,7 +212,7 @@ def get_forward_entries(external_ip: Optional[str] = None,
     """
     This data source provides a list of Forward Entries owned by an Alibaba Cloud account.
 
-    > **NOTE:** Available in 1.37.0+.
+    > **NOTE:** Available since v1.37.0.
 
     ## Example Usage
 
@@ -311,7 +311,7 @@ def get_forward_entries_output(external_ip: Optional[pulumi.Input[Optional[str]]
     """
     This data source provides a list of Forward Entries owned by an Alibaba Cloud account.
 
-    > **NOTE:** Available in 1.37.0+.
+    > **NOTE:** Available since v1.37.0.
 
     ## Example Usage
 

pulumi_alicloud/vpc/get_ipsec_servers.py

@@ -69,6 +69,9 @@ class GetIpsecServersResult:
     @property
     @pulumi.getter(name="ipsecServerName")
     def ipsec_server_name(self) -> Optional[str]:
+        """
+        The name of the IPsec server.
+        """
         return pulumi.get(self, "ipsec_server_name")
 
     @property
@@ -79,6 +82,9 @@ class GetIpsecServersResult:
     @property
     @pulumi.getter
     def names(self) -> Sequence[str]:
+        """
+        A list of Ipsec Server names.
+        """
         return pulumi.get(self, "names")
 
     @property
@@ -89,11 +95,17 @@ class GetIpsecServersResult:
     @property
     @pulumi.getter
     def servers(self) -> Sequence['outputs.GetIpsecServersServerResult']:
+        """
+        A list of Vpn Ipsec Servers. Each element contains the following attributes:
+        """
         return pulumi.get(self, "servers")
 
     @property
     @pulumi.getter(name="vpnGatewayId")
     def vpn_gateway_id(self) -> Optional[str]:
+        """
+        The ID of the VPN gateway.
+        """
         return pulumi.get(self, "vpn_gateway_id")
 
 
@@ -122,7 +134,7 @@ def get_ipsec_servers(ids: Optional[Sequence[str]] = None,
     """
     This data source provides the Vpn Ipsec Servers of the current Alibaba Cloud user.
 
-    > **NOTE:** Available in v1.161.0+.
+    > **NOTE:** Available since v1.161.0+.
 
     ## Example Usage
 
@@ -172,7 +184,7 @@ def get_ipsec_servers_output(ids: Optional[pulumi.Input[Optional[Sequence[str]]]
     """
     This data source provides the Vpn Ipsec Servers of the current Alibaba Cloud user.
 
-    > **NOTE:** Available in v1.161.0+.
+    > **NOTE:** Available since v1.161.0+.
 
     ## Example Usage
 

pulumi_alicloud/vpc/get_nat_gateways.py

@@ -264,7 +264,30 @@ def get_nat_gateways(dry_run: Optional[bool] = None,
     """
     This data source provides a list of Nat Gateways owned by an Alibaba Cloud account.
 
-    > **NOTE:** Available in 1.37.0+.
+    > **NOTE:** Available since v1.37.0.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_alicloud as alicloud
+
+    config = pulumi.Config()
+    name = config.get("name")
+    if name is None:
+        name = "natGatewaysDatasource"
+    default = alicloud.get_zones(available_resource_creation="VSwitch")
+    foo_network = alicloud.vpc.Network("foo",
+        vpc_name=name,
+        cidr_block="172.16.0.0/12")
+    foo_nat_gateway = alicloud.vpc.NatGateway("foo",
+        vpc_id=foo_network.id,
+        specification="Small",
+        nat_gateway_name=name)
+    foo = alicloud.vpc.get_nat_gateways_output(vpc_id=foo_network.id,
+        name_regex=foo_nat_gateway.name,
+        ids=[foo_nat_gateway.id])
+    ```
 
 
     :param bool dry_run: Specifies whether to only precheck the request.
@@ -339,7 +362,30 @@ def get_nat_gateways_output(dry_run: Optional[pulumi.Input[Optional[bool]]] = No
     """
     This data source provides a list of Nat Gateways owned by an Alibaba Cloud account.
 
-    > **NOTE:** Available in 1.37.0+.
+    > **NOTE:** Available since v1.37.0.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_alicloud as alicloud
+
+    config = pulumi.Config()
+    name = config.get("name")
+    if name is None:
+        name = "natGatewaysDatasource"
+    default = alicloud.get_zones(available_resource_creation="VSwitch")
+    foo_network = alicloud.vpc.Network("foo",
+        vpc_name=name,
+        cidr_block="172.16.0.0/12")
+    foo_nat_gateway = alicloud.vpc.NatGateway("foo",
+        vpc_id=foo_network.id,
+        specification="Small",
+        nat_gateway_name=name)
+    foo = alicloud.vpc.get_nat_gateways_output(vpc_id=foo_network.id,
+        name_regex=foo_nat_gateway.name,
+        ids=[foo_nat_gateway.id])
+    ```
 
 
     :param bool dry_run: Specifies whether to only precheck the request.

pulumi_alicloud/vpc/get_prefix_lists.py

@@ -74,6 +74,9 @@ class GetPrefixListsResult:
     @property
     @pulumi.getter
     def lists(self) -> Sequence['outputs.GetPrefixListsListResult']:
+        """
+        A list of Vpc Prefix Lists. Each element contains the following attributes:
+        """
         return pulumi.get(self, "lists")
 
     @property
@@ -84,6 +87,9 @@ class GetPrefixListsResult:
     @property
     @pulumi.getter
     def names(self) -> Sequence[str]:
+        """
+        A list of Prefix List names.
+        """
         return pulumi.get(self, "names")
 
     @property
@@ -94,6 +100,9 @@ class GetPrefixListsResult:
     @property
     @pulumi.getter(name="prefixListName")
     def prefix_list_name(self) -> Optional[str]:
+        """
+        The name of the prefix list.
+        """
         return pulumi.get(self, "prefix_list_name")
 
 
@@ -122,7 +131,7 @@ def get_prefix_lists(enable_details: Optional[bool] = None,
     """
     This data source provides the Vpc Prefix Lists of the current Alibaba Cloud user.
 
-    > **NOTE:** Available in v1.182.0+.
+    > **NOTE:** Available since v1.182.0.
 
     ## Example Usage
 
@@ -172,7 +181,7 @@ def get_prefix_lists_output(enable_details: Optional[pulumi.Input[Optional[bool]
     """
     This data source provides the Vpc Prefix Lists of the current Alibaba Cloud user.
 
-    > **NOTE:** Available in v1.182.0+.
+    > **NOTE:** Available since v1.182.0.
 
     ## Example Usage
 

pulumi_alicloud/vpc/get_snat_entries.py

@@ -97,6 +97,9 @@ class GetSnatEntriesResult:
     @property
     @pulumi.getter
     def names(self) -> Sequence[str]:
+        """
+        A list of Snat Entries names.
+        """
         return pulumi.get(self, "names")
 
     @property
@@ -183,7 +186,7 @@ def get_snat_entries(ids: Optional[Sequence[str]] = None,
     """
     This data source provides a list of Snat Entries owned by an Alibaba Cloud account.
 
-    > **NOTE:** Available in 1.37.0+.
+    > **NOTE:** Available since 1.37.0+.
 
     ## Example Usage
 
@@ -269,7 +272,7 @@ def get_snat_entries_output(ids: Optional[pulumi.Input[Optional[Sequence[str]]]]
     """
     This data source provides a list of Snat Entries owned by an Alibaba Cloud account.
 
-    > **NOTE:** Available in 1.37.0+.
+    > **NOTE:** Available since 1.37.0+.
 
     ## Example Usage
 

pulumi_alicloud/vpc/get_traffic_mirror_filters.py

@@ -56,6 +56,9 @@ class GetTrafficMirrorFiltersResult:
     @property
     @pulumi.getter
     def filters(self) -> Sequence['outputs.GetTrafficMirrorFiltersFilterResult']:
+        """
+        A list of Vpc Traffic Mirror Filters. Each element contains the following attributes:
+        """
         return pulumi.get(self, "filters")
 
     @property
@@ -79,6 +82,9 @@ class GetTrafficMirrorFiltersResult:
     @property
     @pulumi.getter
     def names(self) -> Sequence[str]:
+        """
+        A list of Traffic Mirror Filter names.
+        """
         return pulumi.get(self, "names")
 
     @property
@@ -89,11 +95,17 @@ class GetTrafficMirrorFiltersResult:
     @property
     @pulumi.getter
     def status(self) -> Optional[str]:
+        """
+        The state of the filter. Valid values:`Creating`, `Created`, `Modifying` and `Deleting`. `Creating`: The filter is being created. `Created`: The filter is created. `Modifying`: The filter is being modified. `Deleting`: The filter is being deleted.
+        """
         return pulumi.get(self, "status")
 
     @property
     @pulumi.getter(name="trafficMirrorFilterName")
     def traffic_mirror_filter_name(self) -> Optional[str]:
+        """
+        The name of the filter.
+        """
         return pulumi.get(self, "traffic_mirror_filter_name")
 
 
@@ -122,7 +134,7 @@ def get_traffic_mirror_filters(ids: Optional[Sequence[str]] = None,
     """
     This data source provides the Vpc Traffic Mirror Filters of the current Alibaba Cloud user.
 
-    > **NOTE:** Available in v1.140.0+.
+    > **NOTE:** Available since v1.140.0.
 
     ## Example Usage
 
@@ -176,7 +188,7 @@ def get_traffic_mirror_filters_output(ids: Optional[pulumi.Input[Optional[Sequen
     """
     This data source provides the Vpc Traffic Mirror Filters of the current Alibaba Cloud user.
 
-    > **NOTE:** Available in v1.140.0+.
+    > **NOTE:** Available since v1.140.0.
 
     ## Example Usage
 

pulumi_alicloud/vpc/ipam_ipam.py

@@ -28,7 +28,6 @@ class IpamIpamArgs:
         The set of arguments for constructing a IpamIpam resource.
         :param pulumi.Input[Sequence[pulumi.Input[str]]] operating_region_lists: List of IPAM effective regions.
         :param pulumi.Input[str] ipam_description: The description of IPAM.
-               
                It must be 2 to 256 characters in length and must start with an uppercase letter or a Chinese character, but cannot start with 'http: // 'or 'https. If the description is not filled in, it is blank. The default value is blank.
         :param pulumi.Input[str] ipam_name: The name of the resource.
         :param pulumi.Input[str] resource_group_id: The ID of the resource group.
@@ -61,7 +60,6 @@ class IpamIpamArgs:
     def ipam_description(self) -> Optional[pulumi.Input[str]]:
         """
         The description of IPAM.
-
         It must be 2 to 256 characters in length and must start with an uppercase letter or a Chinese character, but cannot start with 'http: // 'or 'https. If the description is not filled in, it is blank. The default value is blank.
         """
         return pulumi.get(self, "ipam_description")
@@ -123,7 +121,6 @@ class _IpamIpamState:
         Input properties used for looking up and filtering IpamIpam resources.
         :param pulumi.Input[str] create_time: The creation time of the resource.
         :param pulumi.Input[str] ipam_description: The description of IPAM.
-               
                It must be 2 to 256 characters in length and must start with an uppercase letter or a Chinese character, but cannot start with 'http: // 'or 'https. If the description is not filled in, it is blank. The default value is blank.
         :param pulumi.Input[str] ipam_name: The name of the resource.
         :param pulumi.Input[Sequence[pulumi.Input[str]]] operating_region_lists: List of IPAM effective regions.
@@ -169,7 +166,6 @@ class _IpamIpamState:
     def ipam_description(self) -> Optional[pulumi.Input[str]]:
         """
         The description of IPAM.
-
         It must be 2 to 256 characters in length and must start with an uppercase letter or a Chinese character, but cannot start with 'http: // 'or 'https. If the description is not filled in, it is blank. The default value is blank.
         """
         return pulumi.get(self, "ipam_description")
@@ -279,7 +275,7 @@ class IpamIpam(pulumi.CustomResource):
 
         IP Address Management.
 
-        For information about Vpc Ipam Ipam and how to use it, see [What is Ipam](https://www.alibabacloud.com/help/en/).
+        For information about Vpc Ipam Ipam and how to use it, see [What is Ipam](https://next.api.alibabacloud.com/document/VpcIpam/2023-02-28/CreateIpam).
 
         > **NOTE:** Available since v1.234.0.
 
@@ -313,7 +309,6 @@ class IpamIpam(pulumi.CustomResource):
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[str] ipam_description: The description of IPAM.
-               
                It must be 2 to 256 characters in length and must start with an uppercase letter or a Chinese character, but cannot start with 'http: // 'or 'https. If the description is not filled in, it is blank. The default value is blank.
         :param pulumi.Input[str] ipam_name: The name of the resource.
         :param pulumi.Input[Sequence[pulumi.Input[str]]] operating_region_lists: List of IPAM effective regions.
@@ -331,7 +326,7 @@ class IpamIpam(pulumi.CustomResource):
 
         IP Address Management.
 
-        For information about Vpc Ipam Ipam and how to use it, see [What is Ipam](https://www.alibabacloud.com/help/en/).
+        For information about Vpc Ipam Ipam and how to use it, see [What is Ipam](https://next.api.alibabacloud.com/document/VpcIpam/2023-02-28/CreateIpam).
 
         > **NOTE:** Available since v1.234.0.
 
@@ -430,7 +425,6 @@ class IpamIpam(pulumi.CustomResource):
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[str] create_time: The creation time of the resource.
         :param pulumi.Input[str] ipam_description: The description of IPAM.
-               
                It must be 2 to 256 characters in length and must start with an uppercase letter or a Chinese character, but cannot start with 'http: // 'or 'https. If the description is not filled in, it is blank. The default value is blank.
         :param pulumi.Input[str] ipam_name: The name of the resource.
         :param pulumi.Input[Sequence[pulumi.Input[str]]] operating_region_lists: List of IPAM effective regions.
@@ -468,7 +462,6 @@ class IpamIpam(pulumi.CustomResource):
     def ipam_description(self) -> pulumi.Output[Optional[str]]:
         """
         The description of IPAM.
-
         It must be 2 to 256 characters in length and must start with an uppercase letter or a Chinese character, but cannot start with 'http: // 'or 'https. If the description is not filled in, it is blank. The default value is blank.
         """
         return pulumi.get(self, "ipam_description")