Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. cloudwatch
  5. EventBus
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.cloudwatch.EventBus

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

Provides an EventBridge event bus 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"});
Copy
import pulumi
import pulumi_aws as aws

messenger = aws.cloudwatch.EventBus("messenger", name="chat-messages")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudwatch.NewEventBus(ctx, "messenger", &cloudwatch.EventBusArgs{
			Name: pulumi.String("chat-messages"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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",
    });

});
Copy
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 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());

    }
}
Copy
resources:
  messenger:
    type: aws:cloudwatch:EventBus
    properties:
      name: chat-messages
Copy
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const examplepartner = aws.cloudwatch.getEventSource({
    namePrefix: "aws.partner/examplepartner.com",
});
const examplepartnerEventBus = new aws.cloudwatch.EventBus("examplepartner", {
    name: examplepartner.then(examplepartner => examplepartner.name),
    description: "Event bus for example partner events",
    eventSourceName: examplepartner.then(examplepartner => examplepartner.name),
});
Copy
import pulumi
import pulumi_aws as aws

examplepartner = aws.cloudwatch.get_event_source(name_prefix="aws.partner/examplepartner.com")
examplepartner_event_bus = aws.cloudwatch.EventBus("examplepartner",
    name=examplepartner.name,
    description="Event bus for example partner events",
    event_source_name=examplepartner.name)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		examplepartner, err := cloudwatch.GetEventSource(ctx, &cloudwatch.GetEventSourceArgs{
			NamePrefix: pulumi.StringRef("aws.partner/examplepartner.com"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = cloudwatch.NewEventBus(ctx, "examplepartner", &cloudwatch.EventBusArgs{
			Name:            pulumi.String(examplepartner.Name),
			Description:     pulumi.String("Event bus for example partner events"),
			EventSourceName: pulumi.String(examplepartner.Name),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var examplepartner = Aws.CloudWatch.GetEventSource.Invoke(new()
    {
        NamePrefix = "aws.partner/examplepartner.com",
    });

    var examplepartnerEventBus = new Aws.CloudWatch.EventBus("examplepartner", new()
    {
        Name = examplepartner.Apply(getEventSourceResult => getEventSourceResult.Name),
        Description = "Event bus for example partner events",
        EventSourceName = examplepartner.Apply(getEventSourceResult => getEventSourceResult.Name),
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudwatch.CloudwatchFunctions;
import com.pulumi.aws.cloudwatch.inputs.GetEventSourceArgs;
import com.pulumi.aws.cloudwatch.EventBus;
import com.pulumi.aws.cloudwatch.EventBusArgs;
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) {
        final var examplepartner = CloudwatchFunctions.getEventSource(GetEventSourceArgs.builder()
            .namePrefix("aws.partner/examplepartner.com")
            .build());

        var examplepartnerEventBus = new EventBus("examplepartnerEventBus", EventBusArgs.builder()
            .name(examplepartner.name())
            .description("Event bus for example partner events")
            .eventSourceName(examplepartner.name())
            .build());

    }
}
Copy
resources:
  examplepartnerEventBus:
    type: aws:cloudwatch:EventBus
    name: examplepartner
    properties:
      name: ${examplepartner.name}
      description: Event bus for example partner events
      eventSourceName: ${examplepartner.name}
variables:
  examplepartner:
    fn::invoke:
      function: aws:cloudwatch:getEventSource
      arguments:
        namePrefix: aws.partner/examplepartner.com
Copy

Create EventBus Resource

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

Constructor syntax

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

@overload
def EventBus(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             description: Optional[str] = None,
             event_source_name: Optional[str] = None,
             kms_key_identifier: Optional[str] = None,
             name: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None)
func NewEventBus(ctx *Context, name string, args *EventBusArgs, opts ...ResourceOption) (*EventBus, error)
public EventBus(string name, EventBusArgs? args = null, CustomResourceOptions? opts = null)
public EventBus(String name, EventBusArgs args)
public EventBus(String name, EventBusArgs args, CustomResourceOptions options)

type: aws:cloudwatch:EventBus
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args EventBusArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args EventBusArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args EventBusArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args EventBusArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. EventBusArgs
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 eventBusResource = new Aws.CloudWatch.EventBus("eventBusResource", new()
{
    Description = "string",
    EventSourceName = "string",
    KmsKeyIdentifier = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := cloudwatch.NewEventBus(ctx, "eventBusResource", &cloudwatch.EventBusArgs{
	Description:      pulumi.String("string"),
	EventSourceName:  pulumi.String("string"),
	KmsKeyIdentifier: pulumi.String("string"),
	Name:             pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var eventBusResource = new EventBus("eventBusResource", EventBusArgs.builder()
    .description("string")
    .eventSourceName("string")
    .kmsKeyIdentifier("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
event_bus_resource = aws.cloudwatch.EventBus("eventBusResource",
    description="string",
    event_source_name="string",
    kms_key_identifier="string",
    name="string",
    tags={
        "string": "string",
    })
Copy
const eventBusResource = new aws.cloudwatch.EventBus("eventBusResource", {
    description: "string",
    eventSourceName: "string",
    kmsKeyIdentifier: "string",
    name: "string",
    tags: {
        string: "string",
    },
});
Copy
type: aws:cloudwatch:EventBus
properties:
    description: string
    eventSourceName: string
    kmsKeyIdentifier: string
    name: string
    tags:
        string: string
Copy

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

Description string
Event bus description.
EventSourceName Changes to this property will trigger replacement. string
Partner event source that the new event bus will be matched with. Must match name.
KmsKeyIdentifier string
Identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
Name Changes to this property will trigger replacement. string

Name of the new event bus. The names of custom event buses can't contain the / character. To create a partner event bus, ensure that the name matches the event_source_name.

The following arguments are optional:

Tags Dictionary<string, string>
Map of tags assigned 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.
Description string
Event bus description.
EventSourceName Changes to this property will trigger replacement. string
Partner event source that the new event bus will be matched with. Must match name.
KmsKeyIdentifier string
Identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
Name Changes to this property will trigger replacement. string

Name of the new event bus. The names of custom event buses can't contain the / character. To create a partner event bus, ensure that the name matches the event_source_name.

The following arguments are optional:

Tags map[string]string
Map of tags assigned 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.
description String
Event bus description.
eventSourceName Changes to this property will trigger replacement. String
Partner event source that the new event bus will be matched with. Must match name.
kmsKeyIdentifier String
Identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
name Changes to this property will trigger replacement. String

Name of the new event bus. The names of custom event buses can't contain the / character. To create a partner event bus, ensure that the name matches the event_source_name.

The following arguments are optional:

tags Map<String,String>
Map of tags assigned 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.
description string
Event bus description.
eventSourceName Changes to this property will trigger replacement. string
Partner event source that the new event bus will be matched with. Must match name.
kmsKeyIdentifier string
Identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
name Changes to this property will trigger replacement. string

Name of the new event bus. The names of custom event buses can't contain the / character. To create a partner event bus, ensure that the name matches the event_source_name.

The following arguments are optional:

tags {[key: string]: string}
Map of tags assigned 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.
description str
Event bus description.
event_source_name Changes to this property will trigger replacement. str
Partner event source that the new event bus will be matched with. Must match name.
kms_key_identifier str
Identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
name Changes to this property will trigger replacement. str

Name of the new event bus. The names of custom event buses can't contain the / character. To create a partner event bus, ensure that the name matches the event_source_name.

The following arguments are optional:

tags Mapping[str, str]
Map of tags assigned 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.
description String
Event bus description.
eventSourceName Changes to this property will trigger replacement. String
Partner event source that the new event bus will be matched with. Must match name.
kmsKeyIdentifier String
Identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
name Changes to this property will trigger replacement. String

Name of the new event bus. The names of custom event buses can't contain the / character. To create a partner event bus, ensure that the name matches the event_source_name.

The following arguments are optional:

tags Map<String>
Map of tags assigned 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 EventBus resource produces the following output properties:

Arn string
ARN of the event bus.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll Dictionary<string, string>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
ARN of the event bus.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll map[string]string
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
ARN of the event bus.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
ARN of the event bus.
id string
The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
ARN of the event bus.
id str
The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
ARN of the event bus.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String>
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 EventBus Resource

Get an existing EventBus 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?: EventBusState, opts?: CustomResourceOptions): EventBus
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        event_source_name: Optional[str] = None,
        kms_key_identifier: Optional[str] = None,
        name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> EventBus
func GetEventBus(ctx *Context, name string, id IDInput, state *EventBusState, opts ...ResourceOption) (*EventBus, error)
public static EventBus Get(string name, Input<string> id, EventBusState? state, CustomResourceOptions? opts = null)
public static EventBus get(String name, Output<String> id, EventBusState state, CustomResourceOptions options)
resources:  _:    type: aws:cloudwatch:EventBus    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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
ARN of the event bus.
Description string
Event bus description.
EventSourceName Changes to this property will trigger replacement. string
Partner event source that the new event bus will be matched with. Must match name.
KmsKeyIdentifier string
Identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
Name Changes to this property will trigger replacement. string

Name of the new event bus. The names of custom event buses can't contain the / character. To create a partner event bus, ensure that the name matches the event_source_name.

The following arguments are optional:

Tags Dictionary<string, string>
Map of tags assigned 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>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
ARN of the event bus.
Description string
Event bus description.
EventSourceName Changes to this property will trigger replacement. string
Partner event source that the new event bus will be matched with. Must match name.
KmsKeyIdentifier string
Identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
Name Changes to this property will trigger replacement. string

Name of the new event bus. The names of custom event buses can't contain the / character. To create a partner event bus, ensure that the name matches the event_source_name.

The following arguments are optional:

Tags map[string]string
Map of tags assigned 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
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
ARN of the event bus.
description String
Event bus description.
eventSourceName Changes to this property will trigger replacement. String
Partner event source that the new event bus will be matched with. Must match name.
kmsKeyIdentifier String
Identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
name Changes to this property will trigger replacement. String

Name of the new event bus. The names of custom event buses can't contain the / character. To create a partner event bus, ensure that the name matches the event_source_name.

The following arguments are optional:

tags Map<String,String>
Map of tags assigned 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>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
ARN of the event bus.
description string
Event bus description.
eventSourceName Changes to this property will trigger replacement. string
Partner event source that the new event bus will be matched with. Must match name.
kmsKeyIdentifier string
Identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
name Changes to this property will trigger replacement. string

Name of the new event bus. The names of custom event buses can't contain the / character. To create a partner event bus, ensure that the name matches the event_source_name.

The following arguments are optional:

tags {[key: string]: string}
Map of tags assigned 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}
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
ARN of the event bus.
description str
Event bus description.
event_source_name Changes to this property will trigger replacement. str
Partner event source that the new event bus will be matched with. Must match name.
kms_key_identifier str
Identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
name Changes to this property will trigger replacement. str

Name of the new event bus. The names of custom event buses can't contain the / character. To create a partner event bus, ensure that the name matches the event_source_name.

The following arguments are optional:

tags Mapping[str, str]
Map of tags assigned 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]
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
ARN of the event bus.
description String
Event bus description.
eventSourceName Changes to this property will trigger replacement. String
Partner event source that the new event bus will be matched with. Must match name.
kmsKeyIdentifier String
Identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
name Changes to this property will trigger replacement. String

Name of the new event bus. The names of custom event buses can't contain the / character. To create a partner event bus, ensure that the name matches the event_source_name.

The following arguments are optional:

tags Map<String>
Map of tags assigned 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>
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 event buses using the name of the event bus (which can also be a partner event source name). For example:

$ pulumi import aws:cloudwatch/eventBus:EventBus messenger chat-messages
Copy

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 v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws