schemas

package
v6.18.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 19, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Discoverer 

type Discoverer struct {
	pulumi.CustomResourceState

	// The Amazon Resource Name (ARN) of the discoverer.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The description of the discoverer. Maximum of 256 characters.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The ARN of the event bus to discover event schemas on.
	SourceArn pulumi.StringOutput `pulumi:"sourceArn"`
	// 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.StringMapOutput `pulumi:"tags"`
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	//
	// Deprecated: Please use `tags` instead.
	TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
}

Provides an EventBridge Schema Discoverer resource.

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

## Example Usage

```go 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", nil)
		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
	})
}

```

## Import

Using `pulumi import`, import EventBridge discoverers using the `id`. For example:

```sh 

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

```

func GetDiscoverer 

func GetDiscoverer(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DiscovererState, opts ...pulumi.ResourceOption) (*Discoverer, error)

GetDiscoverer gets an existing Discoverer resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewDiscoverer 

func NewDiscoverer(ctx *pulumi.Context,
	name string, args *DiscovererArgs, opts ...pulumi.ResourceOption) (*Discoverer, error)

NewDiscoverer registers a new resource with the given unique name, arguments, and options.

func (*Discoverer) ElementType 

func (*Discoverer) ElementType() reflect.Type

func (*Discoverer) ToDiscovererOutput 

func (i *Discoverer) ToDiscovererOutput() DiscovererOutput

func (*Discoverer) ToDiscovererOutputWithContext 

func (i *Discoverer) ToDiscovererOutputWithContext(ctx context.Context) DiscovererOutput

type DiscovererArgs 

type DiscovererArgs struct {
	// The description of the discoverer. Maximum of 256 characters.
	Description pulumi.StringPtrInput
	// The ARN of the event bus to discover event schemas on.
	SourceArn pulumi.StringInput
	// 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.StringMapInput
}

The set of arguments for constructing a Discoverer resource.

func (DiscovererArgs) ElementType 

func (DiscovererArgs) ElementType() reflect.Type

type DiscovererArray 

type DiscovererArray []DiscovererInput

func (DiscovererArray) ElementType 

func (DiscovererArray) ElementType() reflect.Type

func (DiscovererArray) ToDiscovererArrayOutput 

func (i DiscovererArray) ToDiscovererArrayOutput() DiscovererArrayOutput

func (DiscovererArray) ToDiscovererArrayOutputWithContext 

func (i DiscovererArray) ToDiscovererArrayOutputWithContext(ctx context.Context) DiscovererArrayOutput

type DiscovererArrayInput 

type DiscovererArrayInput interface {
	pulumi.Input

	ToDiscovererArrayOutput() DiscovererArrayOutput
	ToDiscovererArrayOutputWithContext(context.Context) DiscovererArrayOutput
}

DiscovererArrayInput is an input type that accepts DiscovererArray and DiscovererArrayOutput values. You can construct a concrete instance of `DiscovererArrayInput` via: 

DiscovererArray{ DiscovererArgs{...} }

type DiscovererArrayOutput 

type DiscovererArrayOutput struct{ *pulumi.OutputState }

func (DiscovererArrayOutput) ElementType 

func (DiscovererArrayOutput) ElementType() reflect.Type

func (DiscovererArrayOutput) Index 

func (o DiscovererArrayOutput) Index(i pulumi.IntInput) DiscovererOutput

func (DiscovererArrayOutput) ToDiscovererArrayOutput 

func (o DiscovererArrayOutput) ToDiscovererArrayOutput() DiscovererArrayOutput

func (DiscovererArrayOutput) ToDiscovererArrayOutputWithContext 

func (o DiscovererArrayOutput) ToDiscovererArrayOutputWithContext(ctx context.Context) DiscovererArrayOutput

type DiscovererInput 

type DiscovererInput interface {
	pulumi.Input

	ToDiscovererOutput() DiscovererOutput
	ToDiscovererOutputWithContext(ctx context.Context) DiscovererOutput
}

type DiscovererMap 

type DiscovererMap map[string]DiscovererInput

func (DiscovererMap) ElementType 

func (DiscovererMap) ElementType() reflect.Type

func (DiscovererMap) ToDiscovererMapOutput 

func (i DiscovererMap) ToDiscovererMapOutput() DiscovererMapOutput

func (DiscovererMap) ToDiscovererMapOutputWithContext 

func (i DiscovererMap) ToDiscovererMapOutputWithContext(ctx context.Context) DiscovererMapOutput

type DiscovererMapInput 

type DiscovererMapInput interface {
	pulumi.Input

	ToDiscovererMapOutput() DiscovererMapOutput
	ToDiscovererMapOutputWithContext(context.Context) DiscovererMapOutput
}

DiscovererMapInput is an input type that accepts DiscovererMap and DiscovererMapOutput values. You can construct a concrete instance of `DiscovererMapInput` via: 

DiscovererMap{ "key": DiscovererArgs{...} }

type DiscovererMapOutput 

type DiscovererMapOutput struct{ *pulumi.OutputState }

func (DiscovererMapOutput) ElementType 

func (DiscovererMapOutput) ElementType() reflect.Type

func (DiscovererMapOutput) MapIndex 

func (o DiscovererMapOutput) MapIndex(k pulumi.StringInput) DiscovererOutput

func (DiscovererMapOutput) ToDiscovererMapOutput 

func (o DiscovererMapOutput) ToDiscovererMapOutput() DiscovererMapOutput

func (DiscovererMapOutput) ToDiscovererMapOutputWithContext 

func (o DiscovererMapOutput) ToDiscovererMapOutputWithContext(ctx context.Context) DiscovererMapOutput

type DiscovererOutput 

type DiscovererOutput struct{ *pulumi.OutputState }

func (DiscovererOutput) Arn 

func (o DiscovererOutput) Arn() pulumi.StringOutput

The Amazon Resource Name (ARN) of the discoverer.

func (DiscovererOutput) Description 

func (o DiscovererOutput) Description() pulumi.StringPtrOutput

The description of the discoverer. Maximum of 256 characters.

func (DiscovererOutput) ElementType 

func (DiscovererOutput) ElementType() reflect.Type

func (DiscovererOutput) SourceArn 

func (o DiscovererOutput) SourceArn() pulumi.StringOutput

The ARN of the event bus to discover event schemas on.

func (DiscovererOutput) Tags 

func (o DiscovererOutput) Tags() pulumi.StringMapOutput

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.

func (DiscovererOutput) TagsAll deprecated 

func (o DiscovererOutput) TagsAll() pulumi.StringMapOutput

A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

Deprecated: Please use `tags` instead.

func (DiscovererOutput) ToDiscovererOutput 

func (o DiscovererOutput) ToDiscovererOutput() DiscovererOutput

func (DiscovererOutput) ToDiscovererOutputWithContext 

func (o DiscovererOutput) ToDiscovererOutputWithContext(ctx context.Context) DiscovererOutput

type DiscovererState 

type DiscovererState struct {
	// The Amazon Resource Name (ARN) of the discoverer.
	Arn pulumi.StringPtrInput
	// The description of the discoverer. Maximum of 256 characters.
	Description pulumi.StringPtrInput
	// The ARN of the event bus to discover event schemas on.
	SourceArn pulumi.StringPtrInput
	// 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.StringMapInput
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	//
	// Deprecated: Please use `tags` instead.
	TagsAll pulumi.StringMapInput
}

func (DiscovererState) ElementType 

func (DiscovererState) ElementType() reflect.Type

type Registry 

type Registry struct {
	pulumi.CustomResourceState

	// The Amazon Resource Name (ARN) of the discoverer.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The description of the discoverer. Maximum of 256 characters.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The name of the custom event schema registry. Maximum of 64 characters consisting of lower case letters, upper case letters, 0-9, ., -, _.
	Name pulumi.StringOutput `pulumi:"name"`
	// 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.StringMapOutput `pulumi:"tags"`
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	//
	// Deprecated: Please use `tags` instead.
	TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
}

Provides an EventBridge Custom Schema Registry resource.

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

## Example Usage

```go package main

import ( 

"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 {
		_, err := schemas.NewRegistry(ctx, "test", &schemas.RegistryArgs{
			Description: pulumi.String("A custom schema registry"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Using `pulumi import`, import EventBridge schema registries using the `name`. For example:

```sh 

$ pulumi import aws:schemas/registry:Registry test my_own_registry

```

func GetRegistry 

func GetRegistry(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *RegistryState, opts ...pulumi.ResourceOption) (*Registry, error)

GetRegistry gets an existing Registry resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewRegistry 

func NewRegistry(ctx *pulumi.Context,
	name string, args *RegistryArgs, opts ...pulumi.ResourceOption) (*Registry, error)

NewRegistry registers a new resource with the given unique name, arguments, and options.

func (*Registry) ElementType 

func (*Registry) ElementType() reflect.Type

func (*Registry) ToRegistryOutput 

func (i *Registry) ToRegistryOutput() RegistryOutput

func (*Registry) ToRegistryOutputWithContext 

func (i *Registry) ToRegistryOutputWithContext(ctx context.Context) RegistryOutput

type RegistryArgs 

type RegistryArgs struct {
	// The description of the discoverer. Maximum of 256 characters.
	Description pulumi.StringPtrInput
	// The name of the custom event schema registry. Maximum of 64 characters consisting of lower case letters, upper case letters, 0-9, ., -, _.
	Name pulumi.StringPtrInput
	// 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.StringMapInput
}

The set of arguments for constructing a Registry resource.

func (RegistryArgs) ElementType 

func (RegistryArgs) ElementType() reflect.Type

type RegistryArray 

type RegistryArray []RegistryInput

func (RegistryArray) ElementType 

func (RegistryArray) ElementType() reflect.Type

func (RegistryArray) ToRegistryArrayOutput 

func (i RegistryArray) ToRegistryArrayOutput() RegistryArrayOutput

func (RegistryArray) ToRegistryArrayOutputWithContext 

func (i RegistryArray) ToRegistryArrayOutputWithContext(ctx context.Context) RegistryArrayOutput

type RegistryArrayInput 

type RegistryArrayInput interface {
	pulumi.Input

	ToRegistryArrayOutput() RegistryArrayOutput
	ToRegistryArrayOutputWithContext(context.Context) RegistryArrayOutput
}

RegistryArrayInput is an input type that accepts RegistryArray and RegistryArrayOutput values. You can construct a concrete instance of `RegistryArrayInput` via: 

RegistryArray{ RegistryArgs{...} }

type RegistryArrayOutput 

type RegistryArrayOutput struct{ *pulumi.OutputState }

func (RegistryArrayOutput) ElementType 

func (RegistryArrayOutput) ElementType() reflect.Type

func (RegistryArrayOutput) Index 

func (o RegistryArrayOutput) Index(i pulumi.IntInput) RegistryOutput

func (RegistryArrayOutput) ToRegistryArrayOutput 

func (o RegistryArrayOutput) ToRegistryArrayOutput() RegistryArrayOutput

func (RegistryArrayOutput) ToRegistryArrayOutputWithContext 

func (o RegistryArrayOutput) ToRegistryArrayOutputWithContext(ctx context.Context) RegistryArrayOutput

type RegistryInput 

type RegistryInput interface {
	pulumi.Input

	ToRegistryOutput() RegistryOutput
	ToRegistryOutputWithContext(ctx context.Context) RegistryOutput
}

type RegistryMap 

type RegistryMap map[string]RegistryInput

func (RegistryMap) ElementType 

func (RegistryMap) ElementType() reflect.Type

func (RegistryMap) ToRegistryMapOutput 

func (i RegistryMap) ToRegistryMapOutput() RegistryMapOutput

func (RegistryMap) ToRegistryMapOutputWithContext 

func (i RegistryMap) ToRegistryMapOutputWithContext(ctx context.Context) RegistryMapOutput

type RegistryMapInput 

type RegistryMapInput interface {
	pulumi.Input

	ToRegistryMapOutput() RegistryMapOutput
	ToRegistryMapOutputWithContext(context.Context) RegistryMapOutput
}

RegistryMapInput is an input type that accepts RegistryMap and RegistryMapOutput values. You can construct a concrete instance of `RegistryMapInput` via: 

RegistryMap{ "key": RegistryArgs{...} }

type RegistryMapOutput 

type RegistryMapOutput struct{ *pulumi.OutputState }

func (RegistryMapOutput) ElementType 

func (RegistryMapOutput) ElementType() reflect.Type

func (RegistryMapOutput) MapIndex 

func (o RegistryMapOutput) MapIndex(k pulumi.StringInput) RegistryOutput

func (RegistryMapOutput) ToRegistryMapOutput 

func (o RegistryMapOutput) ToRegistryMapOutput() RegistryMapOutput

func (RegistryMapOutput) ToRegistryMapOutputWithContext 

func (o RegistryMapOutput) ToRegistryMapOutputWithContext(ctx context.Context) RegistryMapOutput

type RegistryOutput 

type RegistryOutput struct{ *pulumi.OutputState }

func (RegistryOutput) Arn 

func (o RegistryOutput) Arn() pulumi.StringOutput

The Amazon Resource Name (ARN) of the discoverer.

func (RegistryOutput) Description 

func (o RegistryOutput) Description() pulumi.StringPtrOutput

The description of the discoverer. Maximum of 256 characters.

func (RegistryOutput) ElementType 

func (RegistryOutput) ElementType() reflect.Type

func (RegistryOutput) Name 

func (o RegistryOutput) Name() pulumi.StringOutput

The name of the custom event schema registry. Maximum of 64 characters consisting of lower case letters, upper case letters, 0-9, ., -, _.

func (RegistryOutput) Tags 

func (o RegistryOutput) Tags() pulumi.StringMapOutput

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.

func (RegistryOutput) TagsAll deprecated 

func (o RegistryOutput) TagsAll() pulumi.StringMapOutput

A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

Deprecated: Please use `tags` instead.

func (RegistryOutput) ToRegistryOutput 

func (o RegistryOutput) ToRegistryOutput() RegistryOutput

func (RegistryOutput) ToRegistryOutputWithContext 

func (o RegistryOutput) ToRegistryOutputWithContext(ctx context.Context) RegistryOutput

type RegistryPolicy 

type RegistryPolicy struct {
	pulumi.CustomResourceState

	// Resource Policy for EventBridge Schema Registry
	Policy pulumi.StringOutput `pulumi:"policy"`
	// Name of EventBridge Schema Registry
	RegistryName pulumi.StringOutput `pulumi:"registryName"`
}

Resource for managing an AWS EventBridge Schemas Registry Policy.

## Example Usage ### Basic Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
"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 {
		examplePolicyDocument, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
			Statements: []iam.GetPolicyDocumentStatement{
				{
					Sid:    pulumi.StringRef("example"),
					Effect: pulumi.StringRef("Allow"),
					Principals: []iam.GetPolicyDocumentStatementPrincipal{
						{
							Type: "AWS",
							Identifiers: []string{
								"109876543210",
							},
						},
					},
					Actions: []string{
						"schemas:*",
					},
					Resources: []string{
						"arn:aws:schemas:us-east-1:012345678901:registry/example",
						"arn:aws:schemas:us-east-1:012345678901:schema/example*",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = schemas.NewRegistryPolicy(ctx, "exampleRegistryPolicy", &schemas.RegistryPolicyArgs{
			RegistryName: pulumi.String("example"),
			Policy:       *pulumi.String(examplePolicyDocument.Json),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Using `pulumi import`, import EventBridge Schema Registry Policy using the `registry_name`. For example:

```sh 

$ pulumi import aws:schemas/registryPolicy:RegistryPolicy example example

```

func GetRegistryPolicy 

func GetRegistryPolicy(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *RegistryPolicyState, opts ...pulumi.ResourceOption) (*RegistryPolicy, error)

GetRegistryPolicy gets an existing RegistryPolicy resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewRegistryPolicy 

func NewRegistryPolicy(ctx *pulumi.Context,
	name string, args *RegistryPolicyArgs, opts ...pulumi.ResourceOption) (*RegistryPolicy, error)

NewRegistryPolicy registers a new resource with the given unique name, arguments, and options.

func (*RegistryPolicy) ElementType 

func (*RegistryPolicy) ElementType() reflect.Type

func (*RegistryPolicy) ToRegistryPolicyOutput 

func (i *RegistryPolicy) ToRegistryPolicyOutput() RegistryPolicyOutput

func (*RegistryPolicy) ToRegistryPolicyOutputWithContext 

func (i *RegistryPolicy) ToRegistryPolicyOutputWithContext(ctx context.Context) RegistryPolicyOutput

type RegistryPolicyArgs 

type RegistryPolicyArgs struct {
	// Resource Policy for EventBridge Schema Registry
	Policy pulumi.StringInput
	// Name of EventBridge Schema Registry
	RegistryName pulumi.StringInput
}

The set of arguments for constructing a RegistryPolicy resource.

func (RegistryPolicyArgs) ElementType 

func (RegistryPolicyArgs) ElementType() reflect.Type

type RegistryPolicyArray 

type RegistryPolicyArray []RegistryPolicyInput

func (RegistryPolicyArray) ElementType 

func (RegistryPolicyArray) ElementType() reflect.Type

func (RegistryPolicyArray) ToRegistryPolicyArrayOutput 

func (i RegistryPolicyArray) ToRegistryPolicyArrayOutput() RegistryPolicyArrayOutput

func (RegistryPolicyArray) ToRegistryPolicyArrayOutputWithContext 

func (i RegistryPolicyArray) ToRegistryPolicyArrayOutputWithContext(ctx context.Context) RegistryPolicyArrayOutput

type RegistryPolicyArrayInput 

type RegistryPolicyArrayInput interface {
	pulumi.Input

	ToRegistryPolicyArrayOutput() RegistryPolicyArrayOutput
	ToRegistryPolicyArrayOutputWithContext(context.Context) RegistryPolicyArrayOutput
}

RegistryPolicyArrayInput is an input type that accepts RegistryPolicyArray and RegistryPolicyArrayOutput values. You can construct a concrete instance of `RegistryPolicyArrayInput` via: 

RegistryPolicyArray{ RegistryPolicyArgs{...} }

type RegistryPolicyArrayOutput 

type RegistryPolicyArrayOutput struct{ *pulumi.OutputState }

func (RegistryPolicyArrayOutput) ElementType 

func (RegistryPolicyArrayOutput) ElementType() reflect.Type

func (RegistryPolicyArrayOutput) Index 

func (o RegistryPolicyArrayOutput) Index(i pulumi.IntInput) RegistryPolicyOutput

func (RegistryPolicyArrayOutput) ToRegistryPolicyArrayOutput 

func (o RegistryPolicyArrayOutput) ToRegistryPolicyArrayOutput() RegistryPolicyArrayOutput

func (RegistryPolicyArrayOutput) ToRegistryPolicyArrayOutputWithContext 

func (o RegistryPolicyArrayOutput) ToRegistryPolicyArrayOutputWithContext(ctx context.Context) RegistryPolicyArrayOutput

type RegistryPolicyInput 

type RegistryPolicyInput interface {
	pulumi.Input

	ToRegistryPolicyOutput() RegistryPolicyOutput
	ToRegistryPolicyOutputWithContext(ctx context.Context) RegistryPolicyOutput
}

type RegistryPolicyMap 

type RegistryPolicyMap map[string]RegistryPolicyInput

func (RegistryPolicyMap) ElementType 

func (RegistryPolicyMap) ElementType() reflect.Type

func (RegistryPolicyMap) ToRegistryPolicyMapOutput 

func (i RegistryPolicyMap) ToRegistryPolicyMapOutput() RegistryPolicyMapOutput

func (RegistryPolicyMap) ToRegistryPolicyMapOutputWithContext 

func (i RegistryPolicyMap) ToRegistryPolicyMapOutputWithContext(ctx context.Context) RegistryPolicyMapOutput

type RegistryPolicyMapInput 

type RegistryPolicyMapInput interface {
	pulumi.Input

	ToRegistryPolicyMapOutput() RegistryPolicyMapOutput
	ToRegistryPolicyMapOutputWithContext(context.Context) RegistryPolicyMapOutput
}

RegistryPolicyMapInput is an input type that accepts RegistryPolicyMap and RegistryPolicyMapOutput values. You can construct a concrete instance of `RegistryPolicyMapInput` via: 

RegistryPolicyMap{ "key": RegistryPolicyArgs{...} }

type RegistryPolicyMapOutput 

type RegistryPolicyMapOutput struct{ *pulumi.OutputState }

func (RegistryPolicyMapOutput) ElementType 

func (RegistryPolicyMapOutput) ElementType() reflect.Type

func (RegistryPolicyMapOutput) MapIndex 

func (o RegistryPolicyMapOutput) MapIndex(k pulumi.StringInput) RegistryPolicyOutput

func (RegistryPolicyMapOutput) ToRegistryPolicyMapOutput 

func (o RegistryPolicyMapOutput) ToRegistryPolicyMapOutput() RegistryPolicyMapOutput

func (RegistryPolicyMapOutput) ToRegistryPolicyMapOutputWithContext 

func (o RegistryPolicyMapOutput) ToRegistryPolicyMapOutputWithContext(ctx context.Context) RegistryPolicyMapOutput

type RegistryPolicyOutput 

type RegistryPolicyOutput struct{ *pulumi.OutputState }

func (RegistryPolicyOutput) ElementType 

func (RegistryPolicyOutput) ElementType() reflect.Type

func (RegistryPolicyOutput) Policy 

func (o RegistryPolicyOutput) Policy() pulumi.StringOutput

Resource Policy for EventBridge Schema Registry

func (RegistryPolicyOutput) RegistryName 

func (o RegistryPolicyOutput) RegistryName() pulumi.StringOutput

Name of EventBridge Schema Registry

func (RegistryPolicyOutput) ToRegistryPolicyOutput 

func (o RegistryPolicyOutput) ToRegistryPolicyOutput() RegistryPolicyOutput

func (RegistryPolicyOutput) ToRegistryPolicyOutputWithContext 

func (o RegistryPolicyOutput) ToRegistryPolicyOutputWithContext(ctx context.Context) RegistryPolicyOutput

type RegistryPolicyState 

type RegistryPolicyState struct {
	// Resource Policy for EventBridge Schema Registry
	Policy pulumi.StringPtrInput
	// Name of EventBridge Schema Registry
	RegistryName pulumi.StringPtrInput
}

func (RegistryPolicyState) ElementType 

func (RegistryPolicyState) ElementType() reflect.Type

type RegistryState 

type RegistryState struct {
	// The Amazon Resource Name (ARN) of the discoverer.
	Arn pulumi.StringPtrInput
	// The description of the discoverer. Maximum of 256 characters.
	Description pulumi.StringPtrInput
	// The name of the custom event schema registry. Maximum of 64 characters consisting of lower case letters, upper case letters, 0-9, ., -, _.
	Name pulumi.StringPtrInput
	// 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.StringMapInput
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	//
	// Deprecated: Please use `tags` instead.
	TagsAll pulumi.StringMapInput
}

func (RegistryState) ElementType 

func (RegistryState) ElementType() reflect.Type

type Schema 

type Schema struct {
	pulumi.CustomResourceState

	// The Amazon Resource Name (ARN) of the discoverer.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The schema specification. Must be a valid Open API 3.0 spec.
	Content pulumi.StringOutput `pulumi:"content"`
	// The description of the schema. Maximum of 256 characters.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The last modified date of the schema.
	LastModified pulumi.StringOutput `pulumi:"lastModified"`
	// The name of the schema. Maximum of 385 characters consisting of lower case letters, upper case letters, ., -, _, @.
	Name pulumi.StringOutput `pulumi:"name"`
	// The name of the registry in which this schema belongs.
	RegistryName pulumi.StringOutput `pulumi:"registryName"`
	// 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.StringMapOutput `pulumi:"tags"`
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	//
	// Deprecated: Please use `tags` instead.
	TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
	// The type of the schema. Valid values: `OpenApi3` or `JSONSchemaDraft4`.
	Type pulumi.StringOutput `pulumi:"type"`
	// The version of the schema.
	Version pulumi.StringOutput `pulumi:"version"`
	// The created date of the version of the schema.
	VersionCreatedDate pulumi.StringOutput `pulumi:"versionCreatedDate"`
}

Provides an EventBridge Schema resource.

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

## Example Usage

```go package main

import ( 

"encoding/json"

"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 {
		testRegistry, err := schemas.NewRegistry(ctx, "testRegistry", nil)
		if err != nil {
			return err
		}
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"openapi": "3.0.0",
			"info": map[string]interface{}{
				"version": "1.0.0",
				"title":   "Event",
			},
			"paths": nil,
			"components": map[string]interface{}{
				"schemas": map[string]interface{}{
					"Event": map[string]interface{}{
						"type": "object",
						"properties": map[string]interface{}{
							"name": map[string]interface{}{
								"type": "string",
							},
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = schemas.NewSchema(ctx, "testSchema", &schemas.SchemaArgs{
			RegistryName: testRegistry.Name,
			Type:         pulumi.String("OpenApi3"),
			Description:  pulumi.String("The schema definition for my event"),
			Content:      pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## 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

```

func GetSchema 

func GetSchema(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *SchemaState, opts ...pulumi.ResourceOption) (*Schema, error)

GetSchema gets an existing Schema resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSchema 

func NewSchema(ctx *pulumi.Context,
	name string, args *SchemaArgs, opts ...pulumi.ResourceOption) (*Schema, error)

NewSchema registers a new resource with the given unique name, arguments, and options.

func (*Schema) ElementType 

func (*Schema) ElementType() reflect.Type

func (*Schema) ToSchemaOutput 

func (i *Schema) ToSchemaOutput() SchemaOutput

func (*Schema) ToSchemaOutputWithContext 

func (i *Schema) ToSchemaOutputWithContext(ctx context.Context) SchemaOutput

type SchemaArgs 

type SchemaArgs struct {
	// The schema specification. Must be a valid Open API 3.0 spec.
	Content pulumi.StringInput
	// The description of the schema. Maximum of 256 characters.
	Description pulumi.StringPtrInput
	// The name of the schema. Maximum of 385 characters consisting of lower case letters, upper case letters, ., -, _, @.
	Name pulumi.StringPtrInput
	// The name of the registry in which this schema belongs.
	RegistryName pulumi.StringInput
	// 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.StringMapInput
	// The type of the schema. Valid values: `OpenApi3` or `JSONSchemaDraft4`.
	Type pulumi.StringInput
}

The set of arguments for constructing a Schema resource.

func (SchemaArgs) ElementType 

func (SchemaArgs) ElementType() reflect.Type

type SchemaArray 

type SchemaArray []SchemaInput

func (SchemaArray) ElementType 

func (SchemaArray) ElementType() reflect.Type

func (SchemaArray) ToSchemaArrayOutput 

func (i SchemaArray) ToSchemaArrayOutput() SchemaArrayOutput

func (SchemaArray) ToSchemaArrayOutputWithContext 

func (i SchemaArray) ToSchemaArrayOutputWithContext(ctx context.Context) SchemaArrayOutput

type SchemaArrayInput 

type SchemaArrayInput interface {
	pulumi.Input

	ToSchemaArrayOutput() SchemaArrayOutput
	ToSchemaArrayOutputWithContext(context.Context) SchemaArrayOutput
}

SchemaArrayInput is an input type that accepts SchemaArray and SchemaArrayOutput values. You can construct a concrete instance of `SchemaArrayInput` via: 

SchemaArray{ SchemaArgs{...} }

type SchemaArrayOutput 

type SchemaArrayOutput struct{ *pulumi.OutputState }

func (SchemaArrayOutput) ElementType 

func (SchemaArrayOutput) ElementType() reflect.Type

func (SchemaArrayOutput) Index 

func (o SchemaArrayOutput) Index(i pulumi.IntInput) SchemaOutput

func (SchemaArrayOutput) ToSchemaArrayOutput 

func (o SchemaArrayOutput) ToSchemaArrayOutput() SchemaArrayOutput

func (SchemaArrayOutput) ToSchemaArrayOutputWithContext 

func (o SchemaArrayOutput) ToSchemaArrayOutputWithContext(ctx context.Context) SchemaArrayOutput

type SchemaInput 

type SchemaInput interface {
	pulumi.Input

	ToSchemaOutput() SchemaOutput
	ToSchemaOutputWithContext(ctx context.Context) SchemaOutput
}

type SchemaMap 

type SchemaMap map[string]SchemaInput

func (SchemaMap) ElementType 

func (SchemaMap) ElementType() reflect.Type

func (SchemaMap) ToSchemaMapOutput 

func (i SchemaMap) ToSchemaMapOutput() SchemaMapOutput

func (SchemaMap) ToSchemaMapOutputWithContext 

func (i SchemaMap) ToSchemaMapOutputWithContext(ctx context.Context) SchemaMapOutput

type SchemaMapInput 

type SchemaMapInput interface {
	pulumi.Input

	ToSchemaMapOutput() SchemaMapOutput
	ToSchemaMapOutputWithContext(context.Context) SchemaMapOutput
}

SchemaMapInput is an input type that accepts SchemaMap and SchemaMapOutput values. You can construct a concrete instance of `SchemaMapInput` via: 

SchemaMap{ "key": SchemaArgs{...} }

type SchemaMapOutput 

type SchemaMapOutput struct{ *pulumi.OutputState }

func (SchemaMapOutput) ElementType 

func (SchemaMapOutput) ElementType() reflect.Type

func (SchemaMapOutput) MapIndex 

func (o SchemaMapOutput) MapIndex(k pulumi.StringInput) SchemaOutput

func (SchemaMapOutput) ToSchemaMapOutput 

func (o SchemaMapOutput) ToSchemaMapOutput() SchemaMapOutput

func (SchemaMapOutput) ToSchemaMapOutputWithContext 

func (o SchemaMapOutput) ToSchemaMapOutputWithContext(ctx context.Context) SchemaMapOutput

type SchemaOutput 

type SchemaOutput struct{ *pulumi.OutputState }

func (SchemaOutput) Arn 

func (o SchemaOutput) Arn() pulumi.StringOutput

The Amazon Resource Name (ARN) of the discoverer.

func (SchemaOutput) Content 

func (o SchemaOutput) Content() pulumi.StringOutput

The schema specification. Must be a valid Open API 3.0 spec.

func (SchemaOutput) Description 

func (o SchemaOutput) Description() pulumi.StringPtrOutput

The description of the schema. Maximum of 256 characters.

func (SchemaOutput) ElementType 

func (SchemaOutput) ElementType() reflect.Type

func (SchemaOutput) LastModified 

func (o SchemaOutput) LastModified() pulumi.StringOutput

The last modified date of the schema.

func (SchemaOutput) Name 

func (o SchemaOutput) Name() pulumi.StringOutput

The name of the schema. Maximum of 385 characters consisting of lower case letters, upper case letters, ., -, _, @.

func (SchemaOutput) RegistryName 

func (o SchemaOutput) RegistryName() pulumi.StringOutput

The name of the registry in which this schema belongs.

func (SchemaOutput) Tags 

func (o SchemaOutput) Tags() pulumi.StringMapOutput

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.

func (SchemaOutput) TagsAll deprecated 

func (o SchemaOutput) TagsAll() pulumi.StringMapOutput

A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

Deprecated: Please use `tags` instead.

func (SchemaOutput) ToSchemaOutput 

func (o SchemaOutput) ToSchemaOutput() SchemaOutput

func (SchemaOutput) ToSchemaOutputWithContext 

func (o SchemaOutput) ToSchemaOutputWithContext(ctx context.Context) SchemaOutput

func (SchemaOutput) Type 

func (o SchemaOutput) Type() pulumi.StringOutput

The type of the schema. Valid values: `OpenApi3` or `JSONSchemaDraft4`.

func (SchemaOutput) Version 

func (o SchemaOutput) Version() pulumi.StringOutput

The version of the schema.

func (SchemaOutput) VersionCreatedDate 

func (o SchemaOutput) VersionCreatedDate() pulumi.StringOutput

The created date of the version of the schema.

type SchemaState 

type SchemaState struct {
	// The Amazon Resource Name (ARN) of the discoverer.
	Arn pulumi.StringPtrInput
	// The schema specification. Must be a valid Open API 3.0 spec.
	Content pulumi.StringPtrInput
	// The description of the schema. Maximum of 256 characters.
	Description pulumi.StringPtrInput
	// The last modified date of the schema.
	LastModified pulumi.StringPtrInput
	// The name of the schema. Maximum of 385 characters consisting of lower case letters, upper case letters, ., -, _, @.
	Name pulumi.StringPtrInput
	// The name of the registry in which this schema belongs.
	RegistryName pulumi.StringPtrInput
	// 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.StringMapInput
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	//
	// Deprecated: Please use `tags` instead.
	TagsAll pulumi.StringMapInput
	// The type of the schema. Valid values: `OpenApi3` or `JSONSchemaDraft4`.
	Type pulumi.StringPtrInput
	// The version of the schema.
	Version pulumi.StringPtrInput
	// The created date of the version of the schema.
	VersionCreatedDate pulumi.StringPtrInput
}

func (SchemaState) ElementType 

func (SchemaState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.