Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. mskconnect
  5. WorkerConfiguration
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.mskconnect.WorkerConfiguration

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Provides an Amazon MSK Connect Worker Configuration Resource.

    Example Usage

    Basic configuration

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.mskconnect.WorkerConfiguration("example", {
    name: "example",
    propertiesFileContent: `key.converter=org.apache.kafka.connect.storage.StringConverter
value.converter=org.apache.kafka.connect.storage.StringConverter
`,
});

    import pulumi
import pulumi_aws as aws

example = aws.mskconnect.WorkerConfiguration("example",
    name="example",
    properties_file_content="""key.converter=org.apache.kafka.connect.storage.StringConverter
value.converter=org.apache.kafka.connect.storage.StringConverter
""")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/mskconnect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mskconnect.NewWorkerConfiguration(ctx, "example", &mskconnect.WorkerConfigurationArgs{
			Name:                  pulumi.String("example"),
			PropertiesFileContent: pulumi.String("key.converter=org.apache.kafka.connect.storage.StringConverter\nvalue.converter=org.apache.kafka.connect.storage.StringConverter\n"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.MskConnect.WorkerConfiguration("example", new()
    {
        Name = "example",
        PropertiesFileContent = @"key.converter=org.apache.kafka.connect.storage.StringConverter
value.converter=org.apache.kafka.connect.storage.StringConverter
",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.mskconnect.WorkerConfiguration;
import com.pulumi.aws.mskconnect.WorkerConfigurationArgs;
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 example = new WorkerConfiguration("example", WorkerConfigurationArgs.builder()
            .name("example")
            .propertiesFileContent("""
key.converter=org.apache.kafka.connect.storage.StringConverter
value.converter=org.apache.kafka.connect.storage.StringConverter
            """)
            .build());

    }
}

    resources:
  example:
    type: aws:mskconnect:WorkerConfiguration
    properties:
      name: example
      propertiesFileContent: |
        key.converter=org.apache.kafka.connect.storage.StringConverter
        value.converter=org.apache.kafka.connect.storage.StringConverter

    Create WorkerConfiguration Resource

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

    Constructor syntax

    new WorkerConfiguration(name: string, args: WorkerConfigurationArgs, opts?: CustomResourceOptions);
    @overload
def WorkerConfiguration(resource_name: str,
                        args: WorkerConfigurationArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def WorkerConfiguration(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        properties_file_content: Optional[str] = None,
                        description: Optional[str] = None,
                        name: Optional[str] = None,
                        tags: Optional[Mapping[str, str]] = None)
    func NewWorkerConfiguration(ctx *Context, name string, args WorkerConfigurationArgs, opts ...ResourceOption) (*WorkerConfiguration, error)
    public WorkerConfiguration(string name, WorkerConfigurationArgs args, CustomResourceOptions? opts = null)
    public WorkerConfiguration(String name, WorkerConfigurationArgs args)
public WorkerConfiguration(String name, WorkerConfigurationArgs args, CustomResourceOptions options)

    type: aws:mskconnect:WorkerConfiguration
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 WorkerConfigurationArgs
    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 WorkerConfigurationArgs
    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 WorkerConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkerConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkerConfigurationArgs
    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 workerConfigurationResource = new Aws.MskConnect.WorkerConfiguration("workerConfigurationResource", new()
{
    PropertiesFileContent = "string",
    Description = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := mskconnect.NewWorkerConfiguration(ctx, "workerConfigurationResource", &mskconnect.WorkerConfigurationArgs{
	PropertiesFileContent: pulumi.String("string"),
	Description:           pulumi.String("string"),
	Name:                  pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var workerConfigurationResource = new WorkerConfiguration("workerConfigurationResource", WorkerConfigurationArgs.builder()
    .propertiesFileContent("string")
    .description("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    worker_configuration_resource = aws.mskconnect.WorkerConfiguration("workerConfigurationResource",
    properties_file_content="string",
    description="string",
    name="string",
    tags={
        "string": "string",
    })

    const workerConfigurationResource = new aws.mskconnect.WorkerConfiguration("workerConfigurationResource", {
    propertiesFileContent: "string",
    description: "string",
    name: "string",
    tags: {
        string: "string",
    },
});

    type: aws:mskconnect:WorkerConfiguration
properties:
    description: string
    name: string
    propertiesFileContent: string
    tags:
        string: string

    WorkerConfiguration 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 WorkerConfiguration resource accepts the following input properties:

    PropertiesFileContent string

    Contents of connect-distributed.properties file. The value can be either base64 encoded or in raw format.

    The following arguments are optional:

    Description string
    A summary description of the worker configuration.
    Name string
    The name of the worker configuration.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    PropertiesFileContent string

    Contents of connect-distributed.properties file. The value can be either base64 encoded or in raw format.

    The following arguments are optional:

    Description string
    A summary description of the worker configuration.
    Name string
    The name of the worker configuration.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    propertiesFileContent String

    Contents of connect-distributed.properties file. The value can be either base64 encoded or in raw format.

    The following arguments are optional:

    description String
    A summary description of the worker configuration.
    name String
    The name of the worker configuration.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    propertiesFileContent string

    Contents of connect-distributed.properties file. The value can be either base64 encoded or in raw format.

    The following arguments are optional:

    description string
    A summary description of the worker configuration.
    name string
    The name of the worker configuration.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    properties_file_content str

    Contents of connect-distributed.properties file. The value can be either base64 encoded or in raw format.

    The following arguments are optional:

    description str
    A summary description of the worker configuration.
    name str
    The name of the worker configuration.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    propertiesFileContent String

    Contents of connect-distributed.properties file. The value can be either base64 encoded or in raw format.

    The following arguments are optional:

    description String
    A summary description of the worker configuration.
    name String
    The name of the worker configuration.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    the Amazon Resource Name (ARN) of the worker configuration.
    Id string
    The provider-assigned unique ID for this managed resource.
    LatestRevision int
    an ID of the latest successfully created revision of the worker configuration.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    the Amazon Resource Name (ARN) of the worker configuration.
    Id string
    The provider-assigned unique ID for this managed resource.
    LatestRevision int
    an ID of the latest successfully created revision of the worker configuration.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    the Amazon Resource Name (ARN) of the worker configuration.
    id String
    The provider-assigned unique ID for this managed resource.
    latestRevision Integer
    an ID of the latest successfully created revision of the worker configuration.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    the Amazon Resource Name (ARN) of the worker configuration.
    id string
    The provider-assigned unique ID for this managed resource.
    latestRevision number
    an ID of the latest successfully created revision of the worker configuration.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    the Amazon Resource Name (ARN) of the worker configuration.
    id str
    The provider-assigned unique ID for this managed resource.
    latest_revision int
    an ID of the latest successfully created revision of the worker configuration.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    the Amazon Resource Name (ARN) of the worker configuration.
    id String
    The provider-assigned unique ID for this managed resource.
    latestRevision Number
    an ID of the latest successfully created revision of the worker configuration.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing WorkerConfiguration Resource

    Get an existing WorkerConfiguration 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?: WorkerConfigurationState, opts?: CustomResourceOptions): WorkerConfiguration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        latest_revision: Optional[int] = None,
        name: Optional[str] = None,
        properties_file_content: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> WorkerConfiguration
    func GetWorkerConfiguration(ctx *Context, name string, id IDInput, state *WorkerConfigurationState, opts ...ResourceOption) (*WorkerConfiguration, error)
    public static WorkerConfiguration Get(string name, Input<string> id, WorkerConfigurationState? state, CustomResourceOptions? opts = null)
    public static WorkerConfiguration get(String name, Output<String> id, WorkerConfigurationState 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:
    Arn string
    the Amazon Resource Name (ARN) of the worker configuration.
    Description string
    A summary description of the worker configuration.
    LatestRevision int
    an ID of the latest successfully created revision of the worker configuration.
    Name string
    The name of the worker configuration.
    PropertiesFileContent string

    Contents of connect-distributed.properties file. The value can be either base64 encoded or in raw format.

    The following arguments are optional:

    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    the Amazon Resource Name (ARN) of the worker configuration.
    Description string
    A summary description of the worker configuration.
    LatestRevision int
    an ID of the latest successfully created revision of the worker configuration.
    Name string
    The name of the worker configuration.
    PropertiesFileContent string

    Contents of connect-distributed.properties file. The value can be either base64 encoded or in raw format.

    The following arguments are optional:

    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    the Amazon Resource Name (ARN) of the worker configuration.
    description String
    A summary description of the worker configuration.
    latestRevision Integer
    an ID of the latest successfully created revision of the worker configuration.
    name String
    The name of the worker configuration.
    propertiesFileContent String

    Contents of connect-distributed.properties file. The value can be either base64 encoded or in raw format.

    The following arguments are optional:

    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    the Amazon Resource Name (ARN) of the worker configuration.
    description string
    A summary description of the worker configuration.
    latestRevision number
    an ID of the latest successfully created revision of the worker configuration.
    name string
    The name of the worker configuration.
    propertiesFileContent string

    Contents of connect-distributed.properties file. The value can be either base64 encoded or in raw format.

    The following arguments are optional:

    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    the Amazon Resource Name (ARN) of the worker configuration.
    description str
    A summary description of the worker configuration.
    latest_revision int
    an ID of the latest successfully created revision of the worker configuration.
    name str
    The name of the worker configuration.
    properties_file_content str

    Contents of connect-distributed.properties file. The value can be either base64 encoded or in raw format.

    The following arguments are optional:

    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    the Amazon Resource Name (ARN) of the worker configuration.
    description String
    A summary description of the worker configuration.
    latestRevision Number
    an ID of the latest successfully created revision of the worker configuration.
    name String
    The name of the worker configuration.
    propertiesFileContent String

    Contents of connect-distributed.properties file. The value can be either base64 encoded or in raw format.

    The following arguments are optional:

    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Import

    Using pulumi import, import MSK Connect Worker Configuration using the plugin’s arn. For example:

    $ pulumi import aws:mskconnect/workerConfiguration:WorkerConfiguration example 'arn:aws:kafkaconnect:eu-central-1:123456789012:worker-configuration/example/8848493b-7fcc-478c-a646-4a52634e3378-4'

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

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws