1. Packages
  2. Aiven Provider
  3. API Docs
  4. FlinkApplication
Aiven v6.28.0 published on Friday, Nov 15, 2024 by Pulumi

aiven.FlinkApplication

Explore with Pulumi AI

aiven logo
Aiven v6.28.0 published on Friday, Nov 15, 2024 by Pulumi

    Creates and manages an Aiven for Apache Flink® application.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aiven from "@pulumi/aiven";
    
    const exampleApp = new aiven.FlinkApplication("example_app", {
        project: exampleProject.project,
        serviceName: "example-flink-service",
        name: "example-app",
    });
    
    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")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := aiven.NewFlinkApplication(ctx, "example_app", &aiven.FlinkApplicationArgs{
    			Project:     pulumi.Any(exampleProject.Project),
    			ServiceName: pulumi.String("example-flink-service"),
    			Name:        pulumi.String("example-app"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aiven = Pulumi.Aiven;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleApp = new Aiven.FlinkApplication("example_app", new()
        {
            Project = exampleProject.Project,
            ServiceName = "example-flink-service",
            Name = "example-app",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aiven.FlinkApplication;
    import com.pulumi.aiven.FlinkApplicationArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var exampleApp = new FlinkApplication("exampleApp", FlinkApplicationArgs.builder()
                .project(exampleProject.project())
                .serviceName("example-flink-service")
                .name("example-app")
                .build());
    
        }
    }
    
    resources:
      exampleApp:
        type: aiven:FlinkApplication
        name: example_app
        properties:
          project: ${exampleProject.project}
          serviceName: example-flink-service
          name: example-app
    

    Create FlinkApplication Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new FlinkApplication(name: string, args: FlinkApplicationArgs, opts?: CustomResourceOptions);
    @overload
    def FlinkApplication(resource_name: str,
                         args: FlinkApplicationArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def FlinkApplication(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         project: Optional[str] = None,
                         service_name: Optional[str] = None,
                         name: Optional[str] = None)
    func NewFlinkApplication(ctx *Context, name string, args FlinkApplicationArgs, opts ...ResourceOption) (*FlinkApplication, error)
    public FlinkApplication(string name, FlinkApplicationArgs args, CustomResourceOptions? opts = null)
    public FlinkApplication(String name, FlinkApplicationArgs args)
    public FlinkApplication(String name, FlinkApplicationArgs args, CustomResourceOptions options)
    
    type: aiven:FlinkApplication
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args FlinkApplicationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FlinkApplicationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FlinkApplicationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FlinkApplicationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FlinkApplicationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var flinkApplicationResource = new Aiven.FlinkApplication("flinkApplicationResource", new()
    {
        Project = "string",
        ServiceName = "string",
        Name = "string",
    });
    
    example, err := aiven.NewFlinkApplication(ctx, "flinkApplicationResource", &aiven.FlinkApplicationArgs{
    	Project:     pulumi.String("string"),
    	ServiceName: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    })
    
    var flinkApplicationResource = new FlinkApplication("flinkApplicationResource", FlinkApplicationArgs.builder()
        .project("string")
        .serviceName("string")
        .name("string")
        .build());
    
    flink_application_resource = aiven.FlinkApplication("flinkApplicationResource",
        project="string",
        service_name="string",
        name="string")
    
    const flinkApplicationResource = new aiven.FlinkApplication("flinkApplicationResource", {
        project: "string",
        serviceName: "string",
        name: "string",
    });
    
    type: aiven:FlinkApplication
    properties:
        name: string
        project: string
        serviceName: string
    

    FlinkApplication Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The FlinkApplication resource accepts the following input properties:

    Project string
    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.
    ServiceName string
    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.
    Name string
    The name of the application.
    Project string
    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.
    ServiceName string
    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.
    Name string
    The name of the application.
    project String
    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.
    serviceName String
    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.
    name String
    The name of the application.
    project string
    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.
    serviceName string
    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.
    name string
    The name of the application.
    project str
    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.
    service_name str
    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.
    name str
    The name of the application.
    project String
    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.
    serviceName String
    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.
    name String
    The name of the application.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the FlinkApplication resource produces the following output properties:

    ApplicationId string
    Application ID.
    CreatedAt string
    Application creation time.
    CreatedBy string
    The user who created the application.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    When the application was updated.
    UpdatedBy string
    The user who updated the application.
    ApplicationId string
    Application ID.
    CreatedAt string
    Application creation time.
    CreatedBy string
    The user who created the application.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    When the application was updated.
    UpdatedBy string
    The user who updated the application.
    applicationId String
    Application ID.
    createdAt String
    Application creation time.
    createdBy String
    The user who created the application.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    When the application was updated.
    updatedBy String
    The user who updated the application.
    applicationId string
    Application ID.
    createdAt string
    Application creation time.
    createdBy string
    The user who created the application.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    When the application was updated.
    updatedBy string
    The user who updated the application.
    application_id str
    Application ID.
    created_at str
    Application creation time.
    created_by str
    The user who created the application.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    When the application was updated.
    updated_by str
    The user who updated the application.
    applicationId String
    Application ID.
    createdAt String
    Application creation time.
    createdBy String
    The user who created the application.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    When the application was updated.
    updatedBy String
    The user who updated the application.

    Look up Existing FlinkApplication Resource

    Get an existing FlinkApplication resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: FlinkApplicationState, opts?: CustomResourceOptions): FlinkApplication
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            application_id: Optional[str] = None,
            created_at: Optional[str] = None,
            created_by: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            service_name: Optional[str] = None,
            updated_at: Optional[str] = None,
            updated_by: Optional[str] = None) -> FlinkApplication
    func GetFlinkApplication(ctx *Context, name string, id IDInput, state *FlinkApplicationState, opts ...ResourceOption) (*FlinkApplication, error)
    public static FlinkApplication Get(string name, Input<string> id, FlinkApplicationState? state, CustomResourceOptions? opts = null)
    public static FlinkApplication get(String name, Output<String> id, FlinkApplicationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApplicationId string
    Application ID.
    CreatedAt string
    Application creation time.
    CreatedBy string
    The user who created the application.
    Name string
    The name of the application.
    Project string
    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.
    ServiceName string
    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.
    UpdatedAt string
    When the application was updated.
    UpdatedBy string
    The user who updated the application.
    ApplicationId string
    Application ID.
    CreatedAt string
    Application creation time.
    CreatedBy string
    The user who created the application.
    Name string
    The name of the application.
    Project string
    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.
    ServiceName string
    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.
    UpdatedAt string
    When the application was updated.
    UpdatedBy string
    The user who updated the application.
    applicationId String
    Application ID.
    createdAt String
    Application creation time.
    createdBy String
    The user who created the application.
    name String
    The name of the application.
    project String
    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.
    serviceName String
    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.
    updatedAt String
    When the application was updated.
    updatedBy String
    The user who updated the application.
    applicationId string
    Application ID.
    createdAt string
    Application creation time.
    createdBy string
    The user who created the application.
    name string
    The name of the application.
    project string
    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.
    serviceName string
    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.
    updatedAt string
    When the application was updated.
    updatedBy string
    The user who updated the application.
    application_id str
    Application ID.
    created_at str
    Application creation time.
    created_by str
    The user who created the application.
    name str
    The name of the application.
    project str
    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.
    service_name str
    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.
    updated_at str
    When the application was updated.
    updated_by str
    The user who updated the application.
    applicationId String
    Application ID.
    createdAt String
    Application creation time.
    createdBy String
    The user who created the application.
    name String
    The name of the application.
    project String
    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.
    serviceName String
    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.
    updatedAt String
    When the application was updated.
    updatedBy String
    The user who updated the application.

    Import

    $ pulumi import aiven:index/flinkApplication:FlinkApplication example_app PROJECT/SERVICE_NAME/APPLICATION_NAME
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo
    Aiven v6.28.0 published on Friday, Nov 15, 2024 by Pulumi