pulumi-aiven 6.13.0a1710156545__py3-none-any.whl → 6.31.0a1736831339__py3-none-any.whl

pulumi_aiven/flink_application_deployment.py

@@ -4,9 +4,14 @@
 
 import copy
 import warnings
+import sys
 import pulumi
 import pulumi.runtime
 from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
 from . import _utilities
 
 __all__ = ['FlinkApplicationDeploymentArgs', 'FlinkApplicationDeployment']
@@ -23,15 +28,13 @@ class FlinkApplicationDeploymentArgs:
                  starting_savepoint: Optional[pulumi.Input[str]] = None):
         """
         The set of arguments for constructing a FlinkApplicationDeployment resource.
-        :param pulumi.Input[str] application_id: Application ID
-        :param pulumi.Input[str] project: Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a
-               reference. This property cannot be changed, doing so forces recreation of the resource.
-        :param pulumi.Input[str] service_name: Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this
-               variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
-        :param pulumi.Input[str] version_id: ApplicationVersion ID
-        :param pulumi.Input[int] parallelism: Flink Job parallelism
-        :param pulumi.Input[bool] restart_enabled: Specifies whether a Flink Job is restarted in case it fails
-        :param pulumi.Input[str] starting_savepoint: Job savepoint
+        :param pulumi.Input[str] application_id: Application ID.
+        :param pulumi.Input[str] project: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
+        :param pulumi.Input[str] service_name: The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
+        :param pulumi.Input[str] version_id: Application version ID.
+        :param pulumi.Input[int] parallelism: The number of parallel instances for the task.
+        :param pulumi.Input[bool] restart_enabled: Restart a Flink job if it fails.
+        :param pulumi.Input[str] starting_savepoint: The savepoint to deploy from.
         """
         pulumi.set(__self__, "application_id", application_id)
         pulumi.set(__self__, "project", project)
@@ -48,7 +51,7 @@ class FlinkApplicationDeploymentArgs:
     @pulumi.getter(name="applicationId")
     def application_id(self) -> pulumi.Input[str]:
         """
-        Application ID
+        Application ID.
         """
         return pulumi.get(self, "application_id")
 
@@ -60,8 +63,7 @@ class FlinkApplicationDeploymentArgs:
     @pulumi.getter
     def project(self) -> pulumi.Input[str]:
         """
-        Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a
-        reference. This property cannot be changed, doing so forces recreation of the resource.
+        The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
         """
         return pulumi.get(self, "project")
 
@@ -73,8 +75,7 @@ class FlinkApplicationDeploymentArgs:
     @pulumi.getter(name="serviceName")
     def service_name(self) -> pulumi.Input[str]:
         """
-        Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this
-        variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
+        The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
         """
         return pulumi.get(self, "service_name")
 
@@ -86,7 +87,7 @@ class FlinkApplicationDeploymentArgs:
     @pulumi.getter(name="versionId")
     def version_id(self) -> pulumi.Input[str]:
         """
-        ApplicationVersion ID
+        Application version ID.
         """
         return pulumi.get(self, "version_id")
 
@@ -98,7 +99,7 @@ class FlinkApplicationDeploymentArgs:
     @pulumi.getter
     def parallelism(self) -> Optional[pulumi.Input[int]]:
         """
-        Flink Job parallelism
+        The number of parallel instances for the task.
         """
         return pulumi.get(self, "parallelism")
 
@@ -110,7 +111,7 @@ class FlinkApplicationDeploymentArgs:
     @pulumi.getter(name="restartEnabled")
     def restart_enabled(self) -> Optional[pulumi.Input[bool]]:
         """
-        Specifies whether a Flink Job is restarted in case it fails
+        Restart a Flink job if it fails.
         """
         return pulumi.get(self, "restart_enabled")
 
@@ -122,7 +123,7 @@ class FlinkApplicationDeploymentArgs:
     @pulumi.getter(name="startingSavepoint")
     def starting_savepoint(self) -> Optional[pulumi.Input[str]]:
         """
-        Job savepoint
+        The savepoint to deploy from.
         """
         return pulumi.get(self, "starting_savepoint")
 
@@ -145,17 +146,15 @@ class _FlinkApplicationDeploymentState:
                  version_id: Optional[pulumi.Input[str]] = None):
         """
         Input properties used for looking up and filtering FlinkApplicationDeployment resources.
-        :param pulumi.Input[str] application_id: Application ID
-        :param pulumi.Input[str] created_at: Application deployment creation time
-        :param pulumi.Input[str] created_by: Application deployment creator
-        :param pulumi.Input[int] parallelism: Flink Job parallelism
-        :param pulumi.Input[str] project: Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a
-               reference. This property cannot be changed, doing so forces recreation of the resource.
-        :param pulumi.Input[bool] restart_enabled: Specifies whether a Flink Job is restarted in case it fails
-        :param pulumi.Input[str] service_name: Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this
-               variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
-        :param pulumi.Input[str] starting_savepoint: Job savepoint
-        :param pulumi.Input[str] version_id: ApplicationVersion ID
+        :param pulumi.Input[str] application_id: Application ID.
+        :param pulumi.Input[str] created_at: Application deployment creation time.
+        :param pulumi.Input[str] created_by: The user who deployed the application.
+        :param pulumi.Input[int] parallelism: The number of parallel instances for the task.
+        :param pulumi.Input[str] project: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
+        :param pulumi.Input[bool] restart_enabled: Restart a Flink job if it fails.
+        :param pulumi.Input[str] service_name: The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
+        :param pulumi.Input[str] starting_savepoint: The savepoint to deploy from.
+        :param pulumi.Input[str] version_id: Application version ID.
         """
         if application_id is not None:
             pulumi.set(__self__, "application_id", application_id)
@@ -180,7 +179,7 @@ class _FlinkApplicationDeploymentState:
     @pulumi.getter(name="applicationId")
     def application_id(self) -> Optional[pulumi.Input[str]]:
         """
-        Application ID
+        Application ID.
         """
         return pulumi.get(self, "application_id")
 
@@ -192,7 +191,7 @@ class _FlinkApplicationDeploymentState:
     @pulumi.getter(name="createdAt")
     def created_at(self) -> Optional[pulumi.Input[str]]:
         """
-        Application deployment creation time
+        Application deployment creation time.
         """
         return pulumi.get(self, "created_at")
 
@@ -204,7 +203,7 @@ class _FlinkApplicationDeploymentState:
     @pulumi.getter(name="createdBy")
     def created_by(self) -> Optional[pulumi.Input[str]]:
         """
-        Application deployment creator
+        The user who deployed the application.
         """
         return pulumi.get(self, "created_by")
 
@@ -216,7 +215,7 @@ class _FlinkApplicationDeploymentState:
     @pulumi.getter
     def parallelism(self) -> Optional[pulumi.Input[int]]:
         """
-        Flink Job parallelism
+        The number of parallel instances for the task.
         """
         return pulumi.get(self, "parallelism")
 
@@ -228,8 +227,7 @@ class _FlinkApplicationDeploymentState:
     @pulumi.getter
     def project(self) -> Optional[pulumi.Input[str]]:
         """
-        Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a
-        reference. This property cannot be changed, doing so forces recreation of the resource.
+        The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
         """
         return pulumi.get(self, "project")
 
@@ -241,7 +239,7 @@ class _FlinkApplicationDeploymentState:
     @pulumi.getter(name="restartEnabled")
     def restart_enabled(self) -> Optional[pulumi.Input[bool]]:
         """
-        Specifies whether a Flink Job is restarted in case it fails
+        Restart a Flink job if it fails.
         """
         return pulumi.get(self, "restart_enabled")
 
@@ -253,8 +251,7 @@ class _FlinkApplicationDeploymentState:
     @pulumi.getter(name="serviceName")
     def service_name(self) -> Optional[pulumi.Input[str]]:
         """
-        Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this
-        variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
+        The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
         """
         return pulumi.get(self, "service_name")
 
@@ -266,7 +263,7 @@ class _FlinkApplicationDeploymentState:
     @pulumi.getter(name="startingSavepoint")
     def starting_savepoint(self) -> Optional[pulumi.Input[str]]:
         """
-        Job savepoint
+        The savepoint to deploy from.
         """
         return pulumi.get(self, "starting_savepoint")
 
@@ -278,7 +275,7 @@ class _FlinkApplicationDeploymentState:
     @pulumi.getter(name="versionId")
     def version_id(self) -> Optional[pulumi.Input[str]]:
         """
-        ApplicationVersion ID
+        Application version ID.
         """
         return pulumi.get(self, "version_id")
 
@@ -301,18 +298,73 @@ class FlinkApplicationDeployment(pulumi.CustomResource):
                  version_id: Optional[pulumi.Input[str]] = None,
                  __props__=None):
         """
-        Create a FlinkApplicationDeployment resource with the given unique name, props, and options.
+        Creates and manages the deployment of an Aiven for Apache Flink® application.
+
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_aiven as aiven
+
+        example_app = aiven.FlinkApplication("example_app",
+            project=example_project["project"],
+            service_name="example-flink-service",
+            name="example-app")
+        main = aiven.FlinkApplicationVersion("main",
+            project=example_project["project"],
+            service_name=example_flink["serviceName"],
+            application_id=example_app.application_id,
+            statement="    INSERT INTO kafka_known_pizza SELECT * FROM kafka_pizza WHERE shop LIKE '%Luigis Pizza%'\\n",
+            sinks=[{
+                "create_table": \"\"\"      CREATE TABLE kafka_known_pizza (
+                shop STRING,
+                name STRING
+              ) WITH (
+                'connector' = 'kafka',
+                'properties.bootstrap.servers' = '',
+                'scan.startup.mode' = 'earliest-offset',
+                'topic' = 'sink_topic',
+                'value.format' = 'json'
+              )
+        \"\"\",
+                "integration_id": flink_to_kafka["integrationId"],
+            }],
+            sources=[{
+                "create_table": \"\"\"      CREATE TABLE kafka_pizza (
+                shop STRING,
+                name STRING
+              ) WITH (
+                'connector' = 'kafka',
+                'properties.bootstrap.servers' = '',
+                'scan.startup.mode' = 'earliest-offset',
+                'topic' = 'source_topic',
+                'value.format' = 'json'
+              )
+        \"\"\",
+                "integration_id": flink_to_kafka["integrationId"],
+            }])
+        main_flink_application_deployment = aiven.FlinkApplicationDeployment("main",
+            project=example_project["project"],
+            service_name=example_flink["serviceName"],
+            application_id=example_app.application_id,
+            version_id=main.application_version_id)
+        ```
+
+        ## Import
+
+        ```sh
+        $ pulumi import aiven:index/flinkApplicationDeployment:FlinkApplicationDeployment main PROJECT/SERVICE_NAME/APPLICATION_ID/APPLICATION_VERSION_ID/DEPLOYMENT_ID
+        ```
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
-        :param pulumi.Input[str] application_id: Application ID
-        :param pulumi.Input[int] parallelism: Flink Job parallelism
-        :param pulumi.Input[str] project: Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a
-               reference. This property cannot be changed, doing so forces recreation of the resource.
-        :param pulumi.Input[bool] restart_enabled: Specifies whether a Flink Job is restarted in case it fails
-        :param pulumi.Input[str] service_name: Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this
-               variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
-        :param pulumi.Input[str] starting_savepoint: Job savepoint
-        :param pulumi.Input[str] version_id: ApplicationVersion ID
+        :param pulumi.Input[str] application_id: Application ID.
+        :param pulumi.Input[int] parallelism: The number of parallel instances for the task.
+        :param pulumi.Input[str] project: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
+        :param pulumi.Input[bool] restart_enabled: Restart a Flink job if it fails.
+        :param pulumi.Input[str] service_name: The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
+        :param pulumi.Input[str] starting_savepoint: The savepoint to deploy from.
+        :param pulumi.Input[str] version_id: Application version ID.
         """
         ...
     @overload
@@ -321,7 +373,64 @@ class FlinkApplicationDeployment(pulumi.CustomResource):
                  args: FlinkApplicationDeploymentArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        Create a FlinkApplicationDeployment resource with the given unique name, props, and options.
+        Creates and manages the deployment of an Aiven for Apache Flink® application.
+
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_aiven as aiven
+
+        example_app = aiven.FlinkApplication("example_app",
+            project=example_project["project"],
+            service_name="example-flink-service",
+            name="example-app")
+        main = aiven.FlinkApplicationVersion("main",
+            project=example_project["project"],
+            service_name=example_flink["serviceName"],
+            application_id=example_app.application_id,
+            statement="    INSERT INTO kafka_known_pizza SELECT * FROM kafka_pizza WHERE shop LIKE '%Luigis Pizza%'\\n",
+            sinks=[{
+                "create_table": \"\"\"      CREATE TABLE kafka_known_pizza (
+                shop STRING,
+                name STRING
+              ) WITH (
+                'connector' = 'kafka',
+                'properties.bootstrap.servers' = '',
+                'scan.startup.mode' = 'earliest-offset',
+                'topic' = 'sink_topic',
+                'value.format' = 'json'
+              )
+        \"\"\",
+                "integration_id": flink_to_kafka["integrationId"],
+            }],
+            sources=[{
+                "create_table": \"\"\"      CREATE TABLE kafka_pizza (
+                shop STRING,
+                name STRING
+              ) WITH (
+                'connector' = 'kafka',
+                'properties.bootstrap.servers' = '',
+                'scan.startup.mode' = 'earliest-offset',
+                'topic' = 'source_topic',
+                'value.format' = 'json'
+              )
+        \"\"\",
+                "integration_id": flink_to_kafka["integrationId"],
+            }])
+        main_flink_application_deployment = aiven.FlinkApplicationDeployment("main",
+            project=example_project["project"],
+            service_name=example_flink["serviceName"],
+            application_id=example_app.application_id,
+            version_id=main.application_version_id)
+        ```
+
+        ## Import
+
+        ```sh
+        $ pulumi import aiven:index/flinkApplicationDeployment:FlinkApplicationDeployment main PROJECT/SERVICE_NAME/APPLICATION_ID/APPLICATION_VERSION_ID/DEPLOYMENT_ID
+        ```
+
         :param str resource_name: The name of the resource.
         :param FlinkApplicationDeploymentArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.
@@ -396,17 +505,15 @@ class FlinkApplicationDeployment(pulumi.CustomResource):
         :param str resource_name: The unique name of the resulting resource.
         :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
         :param pulumi.ResourceOptions opts: Options for the resource.
-        :param pulumi.Input[str] application_id: Application ID
-        :param pulumi.Input[str] created_at: Application deployment creation time
-        :param pulumi.Input[str] created_by: Application deployment creator
-        :param pulumi.Input[int] parallelism: Flink Job parallelism
-        :param pulumi.Input[str] project: Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a
-               reference. This property cannot be changed, doing so forces recreation of the resource.
-        :param pulumi.Input[bool] restart_enabled: Specifies whether a Flink Job is restarted in case it fails
-        :param pulumi.Input[str] service_name: Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this
-               variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
-        :param pulumi.Input[str] starting_savepoint: Job savepoint
-        :param pulumi.Input[str] version_id: ApplicationVersion ID
+        :param pulumi.Input[str] application_id: Application ID.
+        :param pulumi.Input[str] created_at: Application deployment creation time.
+        :param pulumi.Input[str] created_by: The user who deployed the application.
+        :param pulumi.Input[int] parallelism: The number of parallel instances for the task.
+        :param pulumi.Input[str] project: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
+        :param pulumi.Input[bool] restart_enabled: Restart a Flink job if it fails.
+        :param pulumi.Input[str] service_name: The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
+        :param pulumi.Input[str] starting_savepoint: The savepoint to deploy from.
+        :param pulumi.Input[str] version_id: Application version ID.
         """
         opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
 
@@ -427,7 +534,7 @@ class FlinkApplicationDeployment(pulumi.CustomResource):
     @pulumi.getter(name="applicationId")
     def application_id(self) -> pulumi.Output[str]:
         """
-        Application ID
+        Application ID.
         """
         return pulumi.get(self, "application_id")
 
@@ -435,7 +542,7 @@ class FlinkApplicationDeployment(pulumi.CustomResource):
     @pulumi.getter(name="createdAt")
     def created_at(self) -> pulumi.Output[str]:
         """
-        Application deployment creation time
+        Application deployment creation time.
         """
         return pulumi.get(self, "created_at")
 
@@ -443,7 +550,7 @@ class FlinkApplicationDeployment(pulumi.CustomResource):
     @pulumi.getter(name="createdBy")
     def created_by(self) -> pulumi.Output[str]:
         """
-        Application deployment creator
+        The user who deployed the application.
         """
         return pulumi.get(self, "created_by")
 
@@ -451,7 +558,7 @@ class FlinkApplicationDeployment(pulumi.CustomResource):
     @pulumi.getter
     def parallelism(self) -> pulumi.Output[Optional[int]]:
         """
-        Flink Job parallelism
+        The number of parallel instances for the task.
         """
         return pulumi.get(self, "parallelism")
 
@@ -459,8 +566,7 @@ class FlinkApplicationDeployment(pulumi.CustomResource):
     @pulumi.getter
     def project(self) -> pulumi.Output[str]:
         """
-        Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a
-        reference. This property cannot be changed, doing so forces recreation of the resource.
+        The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
         """
         return pulumi.get(self, "project")
 
@@ -468,7 +574,7 @@ class FlinkApplicationDeployment(pulumi.CustomResource):
     @pulumi.getter(name="restartEnabled")
     def restart_enabled(self) -> pulumi.Output[Optional[bool]]:
         """
-        Specifies whether a Flink Job is restarted in case it fails
+        Restart a Flink job if it fails.
         """
         return pulumi.get(self, "restart_enabled")
 
@@ -476,8 +582,7 @@ class FlinkApplicationDeployment(pulumi.CustomResource):
     @pulumi.getter(name="serviceName")
     def service_name(self) -> pulumi.Output[str]:
         """
-        Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this
-        variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
+        The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
         """
         return pulumi.get(self, "service_name")
 
@@ -485,7 +590,7 @@ class FlinkApplicationDeployment(pulumi.CustomResource):
     @pulumi.getter(name="startingSavepoint")
     def starting_savepoint(self) -> pulumi.Output[Optional[str]]:
         """
-        Job savepoint
+        The savepoint to deploy from.
         """
         return pulumi.get(self, "starting_savepoint")
 
@@ -493,7 +598,7 @@ class FlinkApplicationDeployment(pulumi.CustomResource):
     @pulumi.getter(name="versionId")
     def version_id(self) -> pulumi.Output[str]:
         """
-        ApplicationVersion ID
+        Application version ID.
         """
         return pulumi.get(self, "version_id")