@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
137 lines (136 loc) • 5.32 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides an EventBridge Schema Discoverer resource.
*
* > **Note:** EventBridge was formerly known as CloudWatch Events. The functionality is identical.
*
* ## Example Usage
*
* ```typescript
* 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
*
* Using `pulumi import`, import EventBridge discoverers using the `id`. For example:
*
* ```sh
* $ pulumi import aws:schemas/discoverer:Discoverer test 123
* ```
*/
export declare class Discoverer extends pulumi.CustomResource {
/**
* Get an existing Discoverer resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DiscovererState, opts?: pulumi.CustomResourceOptions): Discoverer;
/**
* Returns true if the given object is an instance of Discoverer. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Discoverer;
/**
* The Amazon Resource Name (ARN) of the discoverer.
*/
readonly arn: pulumi.Output<string>;
/**
* The description of the discoverer. Maximum of 256 characters.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* The ARN of the event bus to discover event schemas on.
*/
readonly sourceArn: pulumi.Output<string>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a Discoverer resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: DiscovererArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Discoverer resources.
*/
export interface DiscovererState {
/**
* The Amazon Resource Name (ARN) of the discoverer.
*/
arn?: pulumi.Input<string>;
/**
* The description of the discoverer. Maximum of 256 characters.
*/
description?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* The ARN of the event bus to discover event schemas on.
*/
sourceArn?: pulumi.Input<string>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a Discoverer resource.
*/
export interface DiscovererArgs {
/**
* The description of the discoverer. Maximum of 256 characters.
*/
description?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* The ARN of the event bus to discover event schemas on.
*/
sourceArn: pulumi.Input<string>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}