@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
219 lines (218 loc) • 7.79 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides an EventBridge Schema 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 test = new aws.schemas.Registry("test", {name: "my_own_registry"});
* const testSchema = new aws.schemas.Schema("test", {
* name: "my_schema",
* registryName: test.name,
* type: "OpenApi3",
* description: "The schema definition for my event",
* content: JSON.stringify({
* openapi: "3.0.0",
* info: {
* version: "1.0.0",
* title: "Event",
* },
* paths: {},
* components: {
* schemas: {
* Event: {
* type: "object",
* properties: {
* name: {
* type: "string",
* },
* },
* },
* },
* },
* }),
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import EventBridge schema using the `name` and `registry_name`. For example:
*
* ```sh
* $ pulumi import aws:schemas/schema:Schema test name/registry
* ```
*/
export declare class Schema extends pulumi.CustomResource {
/**
* Get an existing Schema 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?: SchemaState, opts?: pulumi.CustomResourceOptions): Schema;
/**
* Returns true if the given object is an instance of Schema. 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 Schema;
/**
* The Amazon Resource Name (ARN) of the discoverer.
*/
readonly arn: pulumi.Output<string>;
/**
* The schema specification. Must be a valid Open API 3.0 spec.
*/
readonly content: pulumi.Output<string>;
/**
* The description of the schema. Maximum of 256 characters.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The last modified date of the schema.
*/
readonly lastModified: pulumi.Output<string>;
/**
* The name of the schema. Maximum of 385 characters consisting of lower case letters, upper case letters, ., -, _, @.
*/
readonly name: pulumi.Output<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.
*/
readonly region: pulumi.Output<string>;
/**
* The name of the registry in which this schema belongs.
*/
readonly registryName: 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;
}>;
/**
* The type of the schema. Valid values: `OpenApi3` or `JSONSchemaDraft4`.
*/
readonly type: pulumi.Output<string>;
/**
* The version of the schema.
*/
readonly version: pulumi.Output<string>;
/**
* The created date of the version of the schema.
*/
readonly versionCreatedDate: pulumi.Output<string>;
/**
* Create a Schema 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: SchemaArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Schema resources.
*/
export interface SchemaState {
/**
* The Amazon Resource Name (ARN) of the discoverer.
*/
arn?: pulumi.Input<string>;
/**
* The schema specification. Must be a valid Open API 3.0 spec.
*/
content?: pulumi.Input<string>;
/**
* The description of the schema. Maximum of 256 characters.
*/
description?: pulumi.Input<string>;
/**
* The last modified date of the schema.
*/
lastModified?: pulumi.Input<string>;
/**
* The name of the schema. Maximum of 385 characters consisting of lower case letters, upper case letters, ., -, _, @.
*/
name?: 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 name of the registry in which this schema belongs.
*/
registryName?: 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 type of the schema. Valid values: `OpenApi3` or `JSONSchemaDraft4`.
*/
type?: pulumi.Input<string>;
/**
* The version of the schema.
*/
version?: pulumi.Input<string>;
/**
* The created date of the version of the schema.
*/
versionCreatedDate?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Schema resource.
*/
export interface SchemaArgs {
/**
* The schema specification. Must be a valid Open API 3.0 spec.
*/
content: pulumi.Input<string>;
/**
* The description of the schema. Maximum of 256 characters.
*/
description?: pulumi.Input<string>;
/**
* The name of the schema. Maximum of 385 characters consisting of lower case letters, upper case letters, ., -, _, @.
*/
name?: 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 name of the registry in which this schema belongs.
*/
registryName: 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>;
}>;
/**
* The type of the schema. Valid values: `OpenApi3` or `JSONSchemaDraft4`.
*/
type: pulumi.Input<string>;
}