1. Packages
  2. AWS Classic
  3. API Docs
  4. schemas
  5. Discoverer

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

aws.schemas.Discoverer

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    Provides an EventBridge Schema Discoverer resource.

    Note: EventBridge was formerly known as CloudWatch Events. The functionality is identical.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const messenger = new aws.cloudwatch.EventBus("messenger", {name: "chat-messages"});
    const test = new aws.schemas.Discoverer("test", {
        sourceArn: messenger.arn,
        description: "Auto discover event schemas",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    messenger = aws.cloudwatch.EventBus("messenger", name="chat-messages")
    test = aws.schemas.Discoverer("test",
        source_arn=messenger.arn,
        description="Auto discover event schemas")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudwatch"
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/schemas"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		messenger, err := cloudwatch.NewEventBus(ctx, "messenger", &cloudwatch.EventBusArgs{
    			Name: pulumi.String("chat-messages"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = schemas.NewDiscoverer(ctx, "test", &schemas.DiscovererArgs{
    			SourceArn:   messenger.Arn,
    			Description: pulumi.String("Auto discover event schemas"),
    		})
    		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 messenger = new Aws.CloudWatch.EventBus("messenger", new()
        {
            Name = "chat-messages",
        });
    
        var test = new Aws.Schemas.Discoverer("test", new()
        {
            SourceArn = messenger.Arn,
            Description = "Auto discover event schemas",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.cloudwatch.EventBus;
    import com.pulumi.aws.cloudwatch.EventBusArgs;
    import com.pulumi.aws.schemas.Discoverer;
    import com.pulumi.aws.schemas.DiscovererArgs;
    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 messenger = new EventBus("messenger", EventBusArgs.builder()
                .name("chat-messages")
                .build());
    
            var test = new Discoverer("test", DiscovererArgs.builder()
                .sourceArn(messenger.arn())
                .description("Auto discover event schemas")
                .build());
    
        }
    }
    
    resources:
      messenger:
        type: aws:cloudwatch:EventBus
        properties:
          name: chat-messages
      test:
        type: aws:schemas:Discoverer
        properties:
          sourceArn: ${messenger.arn}
          description: Auto discover event schemas
    

    Create Discoverer Resource

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

    Constructor syntax

    new Discoverer(name: string, args: DiscovererArgs, opts?: CustomResourceOptions);
    @overload
    def Discoverer(resource_name: str,
                   args: DiscovererArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def Discoverer(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   source_arn: Optional[str] = None,
                   description: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None)
    func NewDiscoverer(ctx *Context, name string, args DiscovererArgs, opts ...ResourceOption) (*Discoverer, error)
    public Discoverer(string name, DiscovererArgs args, CustomResourceOptions? opts = null)
    public Discoverer(String name, DiscovererArgs args)
    public Discoverer(String name, DiscovererArgs args, CustomResourceOptions options)
    
    type: aws:schemas:Discoverer
    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 DiscovererArgs
    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 DiscovererArgs
    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 DiscovererArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DiscovererArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DiscovererArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var discovererResource = new Aws.Schemas.Discoverer("discovererResource", new()
    {
        SourceArn = "string",
        Description = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := schemas.NewDiscoverer(ctx, "discovererResource", &schemas.DiscovererArgs{
    	SourceArn:   pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var discovererResource = new Discoverer("discovererResource", DiscovererArgs.builder()
        .sourceArn("string")
        .description("string")
        .tags(Map.of("string", "string"))
        .build());
    
    discoverer_resource = aws.schemas.Discoverer("discovererResource",
        source_arn="string",
        description="string",
        tags={
            "string": "string",
        })
    
    const discovererResource = new aws.schemas.Discoverer("discovererResource", {
        sourceArn: "string",
        description: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:schemas:Discoverer
    properties:
        description: string
        sourceArn: string
        tags:
            string: string
    

    Discoverer Resource Properties

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

    Inputs

    The Discoverer resource accepts the following input properties:

    SourceArn string
    The ARN of the event bus to discover event schemas on.
    Description string
    The description of the discoverer. Maximum of 256 characters.
    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.
    SourceArn string
    The ARN of the event bus to discover event schemas on.
    Description string
    The description of the discoverer. Maximum of 256 characters.
    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.
    sourceArn String
    The ARN of the event bus to discover event schemas on.
    description String
    The description of the discoverer. Maximum of 256 characters.
    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.
    sourceArn string
    The ARN of the event bus to discover event schemas on.
    description string
    The description of the discoverer. Maximum of 256 characters.
    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.
    source_arn str
    The ARN of the event bus to discover event schemas on.
    description str
    The description of the discoverer. Maximum of 256 characters.
    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.
    sourceArn String
    The ARN of the event bus to discover event schemas on.
    description String
    The description of the discoverer. Maximum of 256 characters.
    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 Discoverer resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the discoverer.
    Id string
    The provider-assigned unique ID for this managed resource.
    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 discoverer.
    Id string
    The provider-assigned unique ID for this managed resource.
    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 discoverer.
    id String
    The provider-assigned unique ID for this managed resource.
    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 discoverer.
    id string
    The provider-assigned unique ID for this managed resource.
    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 discoverer.
    id str
    The provider-assigned unique ID for this managed resource.
    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 discoverer.
    id String
    The provider-assigned unique ID for this managed resource.
    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 Discoverer Resource

    Get an existing Discoverer 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?: DiscovererState, opts?: CustomResourceOptions): Discoverer
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            description: Optional[str] = None,
            source_arn: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> Discoverer
    func GetDiscoverer(ctx *Context, name string, id IDInput, state *DiscovererState, opts ...ResourceOption) (*Discoverer, error)
    public static Discoverer Get(string name, Input<string> id, DiscovererState? state, CustomResourceOptions? opts = null)
    public static Discoverer get(String name, Output<String> id, DiscovererState 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 discoverer.
    Description string
    The description of the discoverer. Maximum of 256 characters.
    SourceArn string
    The ARN of the event bus to discover event schemas on.
    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 discoverer.
    Description string
    The description of the discoverer. Maximum of 256 characters.
    SourceArn string
    The ARN of the event bus to discover event schemas on.
    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 discoverer.
    description String
    The description of the discoverer. Maximum of 256 characters.
    sourceArn String
    The ARN of the event bus to discover event schemas on.
    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 discoverer.
    description string
    The description of the discoverer. Maximum of 256 characters.
    sourceArn string
    The ARN of the event bus to discover event schemas on.
    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 discoverer.
    description str
    The description of the discoverer. Maximum of 256 characters.
    source_arn str
    The ARN of the event bus to discover event schemas on.
    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 discoverer.
    description String
    The description of the discoverer. Maximum of 256 characters.
    sourceArn String
    The ARN of the event bus to discover event schemas on.
    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 EventBridge discoverers using the id. For example:

    $ pulumi import aws:schemas/discoverer:Discoverer test 123
    

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi