confluentcloud.FlinkArtifact
Explore with Pulumi AI
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as confluentcloud from "@pulumi/confluentcloud";
const development = new confluentcloud.Environment("development", {displayName: "Development"});
const main = new confluentcloud.FlinkArtifact("main", {
"class": "io.confluent.example.SumScalarFunction",
region: "us-west-2",
cloud: "AWS",
displayName: "flink_sumscalar_artifact",
contentFormat: "JAR",
environment: {
id: development.id,
},
});
import pulumi
import pulumi_confluentcloud as confluentcloud
development = confluentcloud.Environment("development", display_name="Development")
main = confluentcloud.FlinkArtifact("main",
class_="io.confluent.example.SumScalarFunction",
region="us-west-2",
cloud="AWS",
display_name="flink_sumscalar_artifact",
content_format="JAR",
environment={
"id": development.id,
})
package main
import (
"github.com/pulumi/pulumi-confluentcloud/sdk/v2/go/confluentcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
development, err := confluentcloud.NewEnvironment(ctx, "development", &confluentcloud.EnvironmentArgs{
DisplayName: pulumi.String("Development"),
})
if err != nil {
return err
}
_, err = confluentcloud.NewFlinkArtifact(ctx, "main", &confluentcloud.FlinkArtifactArgs{
Class: pulumi.String("io.confluent.example.SumScalarFunction"),
Region: pulumi.String("us-west-2"),
Cloud: pulumi.String("AWS"),
DisplayName: pulumi.String("flink_sumscalar_artifact"),
ContentFormat: pulumi.String("JAR"),
Environment: &confluentcloud.FlinkArtifactEnvironmentArgs{
Id: development.ID(),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;
return await Deployment.RunAsync(() =>
{
var development = new ConfluentCloud.Environment("development", new()
{
DisplayName = "Development",
});
var main = new ConfluentCloud.FlinkArtifact("main", new()
{
Class = "io.confluent.example.SumScalarFunction",
Region = "us-west-2",
Cloud = "AWS",
DisplayName = "flink_sumscalar_artifact",
ContentFormat = "JAR",
Environment = new ConfluentCloud.Inputs.FlinkArtifactEnvironmentArgs
{
Id = development.Id,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.Environment;
import com.pulumi.confluentcloud.EnvironmentArgs;
import com.pulumi.confluentcloud.FlinkArtifact;
import com.pulumi.confluentcloud.FlinkArtifactArgs;
import com.pulumi.confluentcloud.inputs.FlinkArtifactEnvironmentArgs;
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 development = new Environment("development", EnvironmentArgs.builder()
.displayName("Development")
.build());
var main = new FlinkArtifact("main", FlinkArtifactArgs.builder()
.class_("io.confluent.example.SumScalarFunction")
.region("us-west-2")
.cloud("AWS")
.displayName("flink_sumscalar_artifact")
.contentFormat("JAR")
.environment(FlinkArtifactEnvironmentArgs.builder()
.id(development.id())
.build())
.build());
}
}
resources:
development:
type: confluentcloud:Environment
properties:
displayName: Development
main:
type: confluentcloud:FlinkArtifact
properties:
class: io.confluent.example.SumScalarFunction
region: us-west-2
cloud: AWS
displayName: flink_sumscalar_artifact
contentFormat: JAR
environment:
id: ${development.id}
Create FlinkArtifact Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new FlinkArtifact(name: string, args: FlinkArtifactArgs, opts?: CustomResourceOptions);
@overload
def FlinkArtifact(resource_name: str,
args: FlinkArtifactArgs,
opts: Optional[ResourceOptions] = None)
@overload
def FlinkArtifact(resource_name: str,
opts: Optional[ResourceOptions] = None,
class_: Optional[str] = None,
cloud: Optional[str] = None,
display_name: Optional[str] = None,
environment: Optional[FlinkArtifactEnvironmentArgs] = None,
region: Optional[str] = None,
artifact_file: Optional[str] = None,
content_format: Optional[str] = None,
description: Optional[str] = None,
runtime_language: Optional[str] = None)
func NewFlinkArtifact(ctx *Context, name string, args FlinkArtifactArgs, opts ...ResourceOption) (*FlinkArtifact, error)
public FlinkArtifact(string name, FlinkArtifactArgs args, CustomResourceOptions? opts = null)
public FlinkArtifact(String name, FlinkArtifactArgs args)
public FlinkArtifact(String name, FlinkArtifactArgs args, CustomResourceOptions options)
type: confluentcloud:FlinkArtifact
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 FlinkArtifactArgs
- 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 FlinkArtifactArgs
- 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 FlinkArtifactArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FlinkArtifactArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FlinkArtifactArgs
- 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 flinkArtifactResource = new ConfluentCloud.FlinkArtifact("flinkArtifactResource", new()
{
Class = "string",
Cloud = "string",
DisplayName = "string",
Environment = new ConfluentCloud.Inputs.FlinkArtifactEnvironmentArgs
{
Id = "string",
},
Region = "string",
ArtifactFile = "string",
ContentFormat = "string",
Description = "string",
RuntimeLanguage = "string",
});
example, err := confluentcloud.NewFlinkArtifact(ctx, "flinkArtifactResource", &confluentcloud.FlinkArtifactArgs{
Class: pulumi.String("string"),
Cloud: pulumi.String("string"),
DisplayName: pulumi.String("string"),
Environment: &confluentcloud.FlinkArtifactEnvironmentArgs{
Id: pulumi.String("string"),
},
Region: pulumi.String("string"),
ArtifactFile: pulumi.String("string"),
ContentFormat: pulumi.String("string"),
Description: pulumi.String("string"),
RuntimeLanguage: pulumi.String("string"),
})
var flinkArtifactResource = new FlinkArtifact("flinkArtifactResource", FlinkArtifactArgs.builder()
.class_("string")
.cloud("string")
.displayName("string")
.environment(FlinkArtifactEnvironmentArgs.builder()
.id("string")
.build())
.region("string")
.artifactFile("string")
.contentFormat("string")
.description("string")
.runtimeLanguage("string")
.build());
flink_artifact_resource = confluentcloud.FlinkArtifact("flinkArtifactResource",
class_="string",
cloud="string",
display_name="string",
environment={
"id": "string",
},
region="string",
artifact_file="string",
content_format="string",
description="string",
runtime_language="string")
const flinkArtifactResource = new confluentcloud.FlinkArtifact("flinkArtifactResource", {
"class": "string",
cloud: "string",
displayName: "string",
environment: {
id: "string",
},
region: "string",
artifactFile: "string",
contentFormat: "string",
description: "string",
runtimeLanguage: "string",
});
type: confluentcloud:FlinkArtifact
properties:
artifactFile: string
class: string
cloud: string
contentFormat: string
description: string
displayName: string
environment:
id: string
region: string
runtimeLanguage: string
FlinkArtifact 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 FlinkArtifact resource accepts the following input properties:
- Class string
- Java class or alias for the Flink Artifact as provided by developer.
- Cloud string
- The cloud service provider that runs the Flink Artifact.
- Display
Name string - The display name of Flink Artifact.
- Environment
Pulumi.
Confluent Cloud. Inputs. Flink Artifact Environment - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- Region string
- The cloud service provider region that hosts the Flink Artifact.
- Artifact
File string - The artifact file for Flink Artifact.
- Content
Format string - (Optional String) Archive format of the Flink Artifact.
- Description string
- (Optional String) Description of the Flink Artifact.
- Runtime
Language string - (Optional String) Runtime language of the Flink Artifact. The default runtime language is Java.
- Class string
- Java class or alias for the Flink Artifact as provided by developer.
- Cloud string
- The cloud service provider that runs the Flink Artifact.
- Display
Name string - The display name of Flink Artifact.
- Environment
Flink
Artifact Environment Args - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- Region string
- The cloud service provider region that hosts the Flink Artifact.
- Artifact
File string - The artifact file for Flink Artifact.
- Content
Format string - (Optional String) Archive format of the Flink Artifact.
- Description string
- (Optional String) Description of the Flink Artifact.
- Runtime
Language string - (Optional String) Runtime language of the Flink Artifact. The default runtime language is Java.
- class_ String
- Java class or alias for the Flink Artifact as provided by developer.
- cloud String
- The cloud service provider that runs the Flink Artifact.
- display
Name String - The display name of Flink Artifact.
- environment
Flink
Artifact Environment - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- region String
- The cloud service provider region that hosts the Flink Artifact.
- artifact
File String - The artifact file for Flink Artifact.
- content
Format String - (Optional String) Archive format of the Flink Artifact.
- description String
- (Optional String) Description of the Flink Artifact.
- runtime
Language String - (Optional String) Runtime language of the Flink Artifact. The default runtime language is Java.
- class string
- Java class or alias for the Flink Artifact as provided by developer.
- cloud string
- The cloud service provider that runs the Flink Artifact.
- display
Name string - The display name of Flink Artifact.
- environment
Flink
Artifact Environment - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- region string
- The cloud service provider region that hosts the Flink Artifact.
- artifact
File string - The artifact file for Flink Artifact.
- content
Format string - (Optional String) Archive format of the Flink Artifact.
- description string
- (Optional String) Description of the Flink Artifact.
- runtime
Language string - (Optional String) Runtime language of the Flink Artifact. The default runtime language is Java.
- class_ str
- Java class or alias for the Flink Artifact as provided by developer.
- cloud str
- The cloud service provider that runs the Flink Artifact.
- display_
name str - The display name of Flink Artifact.
- environment
Flink
Artifact Environment Args - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- region str
- The cloud service provider region that hosts the Flink Artifact.
- artifact_
file str - The artifact file for Flink Artifact.
- content_
format str - (Optional String) Archive format of the Flink Artifact.
- description str
- (Optional String) Description of the Flink Artifact.
- runtime_
language str - (Optional String) Runtime language of the Flink Artifact. The default runtime language is Java.
- class String
- Java class or alias for the Flink Artifact as provided by developer.
- cloud String
- The cloud service provider that runs the Flink Artifact.
- display
Name String - The display name of Flink Artifact.
- environment Property Map
- Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- region String
- The cloud service provider region that hosts the Flink Artifact.
- artifact
File String - The artifact file for Flink Artifact.
- content
Format String - (Optional String) Archive format of the Flink Artifact.
- description String
- (Optional String) Description of the Flink Artifact.
- runtime
Language String - (Optional String) Runtime language of the Flink Artifact. The default runtime language is Java.
Outputs
All input properties are implicitly available as output properties. Additionally, the FlinkArtifact resource produces the following output properties:
- Api
Version string - (Required String) The API Version of the schema version of the Flink Artifact Pool, for example,
fa/v2
. - Id string
- The provider-assigned unique ID for this managed resource.
- Kind string
- (Required String) The kind of the Flink Artifact Pool, for example,
FlinkArtifact
. - Versions
List<Pulumi.
Confluent Cloud. Outputs. Flink Artifact Version> - List of versions for this Flink Artifact.
- Api
Version string - (Required String) The API Version of the schema version of the Flink Artifact Pool, for example,
fa/v2
. - Id string
- The provider-assigned unique ID for this managed resource.
- Kind string
- (Required String) The kind of the Flink Artifact Pool, for example,
FlinkArtifact
. - Versions
[]Flink
Artifact Version - List of versions for this Flink Artifact.
- api
Version String - (Required String) The API Version of the schema version of the Flink Artifact Pool, for example,
fa/v2
. - id String
- The provider-assigned unique ID for this managed resource.
- kind String
- (Required String) The kind of the Flink Artifact Pool, for example,
FlinkArtifact
. - versions
List<Flink
Artifact Version> - List of versions for this Flink Artifact.
- api
Version string - (Required String) The API Version of the schema version of the Flink Artifact Pool, for example,
fa/v2
. - id string
- The provider-assigned unique ID for this managed resource.
- kind string
- (Required String) The kind of the Flink Artifact Pool, for example,
FlinkArtifact
. - versions
Flink
Artifact Version[] - List of versions for this Flink Artifact.
- api_
version str - (Required String) The API Version of the schema version of the Flink Artifact Pool, for example,
fa/v2
. - id str
- The provider-assigned unique ID for this managed resource.
- kind str
- (Required String) The kind of the Flink Artifact Pool, for example,
FlinkArtifact
. - versions
Sequence[Flink
Artifact Version] - List of versions for this Flink Artifact.
- api
Version String - (Required String) The API Version of the schema version of the Flink Artifact Pool, for example,
fa/v2
. - id String
- The provider-assigned unique ID for this managed resource.
- kind String
- (Required String) The kind of the Flink Artifact Pool, for example,
FlinkArtifact
. - versions List<Property Map>
- List of versions for this Flink Artifact.
Look up Existing FlinkArtifact Resource
Get an existing FlinkArtifact 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?: FlinkArtifactState, opts?: CustomResourceOptions): FlinkArtifact
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
api_version: Optional[str] = None,
artifact_file: Optional[str] = None,
class_: Optional[str] = None,
cloud: Optional[str] = None,
content_format: Optional[str] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
environment: Optional[FlinkArtifactEnvironmentArgs] = None,
kind: Optional[str] = None,
region: Optional[str] = None,
runtime_language: Optional[str] = None,
versions: Optional[Sequence[FlinkArtifactVersionArgs]] = None) -> FlinkArtifact
func GetFlinkArtifact(ctx *Context, name string, id IDInput, state *FlinkArtifactState, opts ...ResourceOption) (*FlinkArtifact, error)
public static FlinkArtifact Get(string name, Input<string> id, FlinkArtifactState? state, CustomResourceOptions? opts = null)
public static FlinkArtifact get(String name, Output<String> id, FlinkArtifactState 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.
- Api
Version string - (Required String) The API Version of the schema version of the Flink Artifact Pool, for example,
fa/v2
. - Artifact
File string - The artifact file for Flink Artifact.
- Class string
- Java class or alias for the Flink Artifact as provided by developer.
- Cloud string
- The cloud service provider that runs the Flink Artifact.
- Content
Format string - (Optional String) Archive format of the Flink Artifact.
- Description string
- (Optional String) Description of the Flink Artifact.
- Display
Name string - The display name of Flink Artifact.
- Environment
Pulumi.
Confluent Cloud. Inputs. Flink Artifact Environment - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- Kind string
- (Required String) The kind of the Flink Artifact Pool, for example,
FlinkArtifact
. - Region string
- The cloud service provider region that hosts the Flink Artifact.
- Runtime
Language string - (Optional String) Runtime language of the Flink Artifact. The default runtime language is Java.
- Versions
List<Pulumi.
Confluent Cloud. Inputs. Flink Artifact Version> - List of versions for this Flink Artifact.
- Api
Version string - (Required String) The API Version of the schema version of the Flink Artifact Pool, for example,
fa/v2
. - Artifact
File string - The artifact file for Flink Artifact.
- Class string
- Java class or alias for the Flink Artifact as provided by developer.
- Cloud string
- The cloud service provider that runs the Flink Artifact.
- Content
Format string - (Optional String) Archive format of the Flink Artifact.
- Description string
- (Optional String) Description of the Flink Artifact.
- Display
Name string - The display name of Flink Artifact.
- Environment
Flink
Artifact Environment Args - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- Kind string
- (Required String) The kind of the Flink Artifact Pool, for example,
FlinkArtifact
. - Region string
- The cloud service provider region that hosts the Flink Artifact.
- Runtime
Language string - (Optional String) Runtime language of the Flink Artifact. The default runtime language is Java.
- Versions
[]Flink
Artifact Version Args - List of versions for this Flink Artifact.
- api
Version String - (Required String) The API Version of the schema version of the Flink Artifact Pool, for example,
fa/v2
. - artifact
File String - The artifact file for Flink Artifact.
- class_ String
- Java class or alias for the Flink Artifact as provided by developer.
- cloud String
- The cloud service provider that runs the Flink Artifact.
- content
Format String - (Optional String) Archive format of the Flink Artifact.
- description String
- (Optional String) Description of the Flink Artifact.
- display
Name String - The display name of Flink Artifact.
- environment
Flink
Artifact Environment - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- kind String
- (Required String) The kind of the Flink Artifact Pool, for example,
FlinkArtifact
. - region String
- The cloud service provider region that hosts the Flink Artifact.
- runtime
Language String - (Optional String) Runtime language of the Flink Artifact. The default runtime language is Java.
- versions
List<Flink
Artifact Version> - List of versions for this Flink Artifact.
- api
Version string - (Required String) The API Version of the schema version of the Flink Artifact Pool, for example,
fa/v2
. - artifact
File string - The artifact file for Flink Artifact.
- class string
- Java class or alias for the Flink Artifact as provided by developer.
- cloud string
- The cloud service provider that runs the Flink Artifact.
- content
Format string - (Optional String) Archive format of the Flink Artifact.
- description string
- (Optional String) Description of the Flink Artifact.
- display
Name string - The display name of Flink Artifact.
- environment
Flink
Artifact Environment - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- kind string
- (Required String) The kind of the Flink Artifact Pool, for example,
FlinkArtifact
. - region string
- The cloud service provider region that hosts the Flink Artifact.
- runtime
Language string - (Optional String) Runtime language of the Flink Artifact. The default runtime language is Java.
- versions
Flink
Artifact Version[] - List of versions for this Flink Artifact.
- api_
version str - (Required String) The API Version of the schema version of the Flink Artifact Pool, for example,
fa/v2
. - artifact_
file str - The artifact file for Flink Artifact.
- class_ str
- Java class or alias for the Flink Artifact as provided by developer.
- cloud str
- The cloud service provider that runs the Flink Artifact.
- content_
format str - (Optional String) Archive format of the Flink Artifact.
- description str
- (Optional String) Description of the Flink Artifact.
- display_
name str - The display name of Flink Artifact.
- environment
Flink
Artifact Environment Args - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- kind str
- (Required String) The kind of the Flink Artifact Pool, for example,
FlinkArtifact
. - region str
- The cloud service provider region that hosts the Flink Artifact.
- runtime_
language str - (Optional String) Runtime language of the Flink Artifact. The default runtime language is Java.
- versions
Sequence[Flink
Artifact Version Args] - List of versions for this Flink Artifact.
- api
Version String - (Required String) The API Version of the schema version of the Flink Artifact Pool, for example,
fa/v2
. - artifact
File String - The artifact file for Flink Artifact.
- class String
- Java class or alias for the Flink Artifact as provided by developer.
- cloud String
- The cloud service provider that runs the Flink Artifact.
- content
Format String - (Optional String) Archive format of the Flink Artifact.
- description String
- (Optional String) Description of the Flink Artifact.
- display
Name String - The display name of Flink Artifact.
- environment Property Map
- Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- kind String
- (Required String) The kind of the Flink Artifact Pool, for example,
FlinkArtifact
. - region String
- The cloud service provider region that hosts the Flink Artifact.
- runtime
Language String - (Optional String) Runtime language of the Flink Artifact. The default runtime language is Java.
- versions List<Property Map>
- List of versions for this Flink Artifact.
Supporting Types
FlinkArtifactEnvironment, FlinkArtifactEnvironmentArgs
- Id string
- The ID of the Environment that the Flink Artifact Pool belongs to, for example,
env-abc123
.
- Id string
- The ID of the Environment that the Flink Artifact Pool belongs to, for example,
env-abc123
.
- id String
- The ID of the Environment that the Flink Artifact Pool belongs to, for example,
env-abc123
.
- id string
- The ID of the Environment that the Flink Artifact Pool belongs to, for example,
env-abc123
.
- id str
- The ID of the Environment that the Flink Artifact Pool belongs to, for example,
env-abc123
.
- id String
- The ID of the Environment that the Flink Artifact Pool belongs to, for example,
env-abc123
.
FlinkArtifactVersion, FlinkArtifactVersionArgs
- Version string
- The version of this Flink Artifact.
- Version string
- The version of this Flink Artifact.
- version String
- The version of this Flink Artifact.
- version string
- The version of this Flink Artifact.
- version str
- The version of this Flink Artifact.
- version String
- The version of this Flink Artifact.
Import
You can import a Flink Artifact by using cloud, region, Flink Artifact ID and artifact file, in the format <region>/<cloud>/<Flink Artifact ID>
. The following example shows how to import a Flink Artifact:
$ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>"
$ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"
$ pulumi import confluentcloud:index/flinkArtifact:FlinkArtifact main us-east-1/aws/fa-123
!> Warning: Do not forget to delete terminal command history afterwards for security purposes.
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Confluent Cloud pulumi/pulumi-confluentcloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
confluent
Terraform Provider.