We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 28, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 28, 2026 by Pulumi
Resource type definition for AWS::EventsV2::EventBus, an Amazon EventBridge custom event bus that receives events and delivers them to matching subscribers.
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,
encryption_configuration: Optional[EventBusEncryptionConfigurationArgs] = None,
name: Optional[str] = None,
storage_configuration: Optional[EventBusStorageConfigurationArgs] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native:eventsv2:EventBus
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_eventsv2_event_bus" "name" {
# resource properties
}Parameters
- name 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 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 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 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 String
- The unique name of the resource.
- args EventBusArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
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
- A description of the event bus. Control characters and Unicode line separators are not allowed.
- Encryption
Configuration Pulumi.Aws Native. Events V2. Inputs. Event Bus Encryption Configuration - Encryption configuration for the event bus. The service stores and returns the customer managed key as its key ARN. The key ARN is recommended so that drift detection stays accurate. A key ID is also accepted and is matched to the returned key ARN when CloudFormation checks for drift; a key alias is accepted but can be reported as a value difference, because an alias cannot be matched to the key ARN it points to.
- Name string
- The name of the event bus. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.
- Storage
Configuration Pulumi.Aws Native. Events V2. Inputs. Event Bus Storage Configuration - The event storage configuration for the event bus, which controls the number of days events are retained on the bus.
-
List<Pulumi.
Aws Native. Inputs. Tag> - The tags assigned to the event bus.
- Description string
- A description of the event bus. Control characters and Unicode line separators are not allowed.
- Encryption
Configuration EventBus Encryption Configuration Args - Encryption configuration for the event bus. The service stores and returns the customer managed key as its key ARN. The key ARN is recommended so that drift detection stays accurate. A key ID is also accepted and is matched to the returned key ARN when CloudFormation checks for drift; a key alias is accepted but can be reported as a value difference, because an alias cannot be matched to the key ARN it points to.
- Name string
- The name of the event bus. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.
- Storage
Configuration EventBus Storage Configuration Args - The event storage configuration for the event bus, which controls the number of days events are retained on the bus.
-
Tag
Args - The tags assigned to the event bus.
- description string
- A description of the event bus. Control characters and Unicode line separators are not allowed.
- encryption_
configuration object - Encryption configuration for the event bus. The service stores and returns the customer managed key as its key ARN. The key ARN is recommended so that drift detection stays accurate. A key ID is also accepted and is matched to the returned key ARN when CloudFormation checks for drift; a key alias is accepted but can be reported as a value difference, because an alias cannot be matched to the key ARN it points to.
- name string
- The name of the event bus. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.
- storage_
configuration object - The event storage configuration for the event bus, which controls the number of days events are retained on the bus.
- list(object)
- The tags assigned to the event bus.
- description String
- A description of the event bus. Control characters and Unicode line separators are not allowed.
- encryption
Configuration EventBus Encryption Configuration - Encryption configuration for the event bus. The service stores and returns the customer managed key as its key ARN. The key ARN is recommended so that drift detection stays accurate. A key ID is also accepted and is matched to the returned key ARN when CloudFormation checks for drift; a key alias is accepted but can be reported as a value difference, because an alias cannot be matched to the key ARN it points to.
- name String
- The name of the event bus. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.
- storage
Configuration EventBus Storage Configuration - The event storage configuration for the event bus, which controls the number of days events are retained on the bus.
- List<Tag>
- The tags assigned to the event bus.
- description string
- A description of the event bus. Control characters and Unicode line separators are not allowed.
- encryption
Configuration EventBus Encryption Configuration - Encryption configuration for the event bus. The service stores and returns the customer managed key as its key ARN. The key ARN is recommended so that drift detection stays accurate. A key ID is also accepted and is matched to the returned key ARN when CloudFormation checks for drift; a key alias is accepted but can be reported as a value difference, because an alias cannot be matched to the key ARN it points to.
- name string
- The name of the event bus. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.
- storage
Configuration EventBus Storage Configuration - The event storage configuration for the event bus, which controls the number of days events are retained on the bus.
- Tag[]
- The tags assigned to the event bus.
- description str
- A description of the event bus. Control characters and Unicode line separators are not allowed.
- encryption_
configuration EventBus Encryption Configuration Args - Encryption configuration for the event bus. The service stores and returns the customer managed key as its key ARN. The key ARN is recommended so that drift detection stays accurate. A key ID is also accepted and is matched to the returned key ARN when CloudFormation checks for drift; a key alias is accepted but can be reported as a value difference, because an alias cannot be matched to the key ARN it points to.
- name str
- The name of the event bus. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.
- storage_
configuration EventBus Storage Configuration Args - The event storage configuration for the event bus, which controls the number of days events are retained on the bus.
-
Sequence[Tag
Args] - The tags assigned to the event bus.
- description String
- A description of the event bus. Control characters and Unicode line separators are not allowed.
- encryption
Configuration Property Map - Encryption configuration for the event bus. The service stores and returns the customer managed key as its key ARN. The key ARN is recommended so that drift detection stays accurate. A key ID is also accepted and is matched to the returned key ARN when CloudFormation checks for drift; a key alias is accepted but can be reported as a value difference, because an alias cannot be matched to the key ARN it points to.
- name String
- The name of the event bus. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.
- storage
Configuration Property Map - The event storage configuration for the event bus, which controls the number of days events are retained on the bus.
- List<Property Map>
- The tags assigned to the event bus.
Outputs
All input properties are implicitly available as output properties. Additionally, the EventBus resource produces the following output properties:
- Creation
Time string - The time the event bus was created, as an ISO 8601 timestamp.
- Event
Bus stringArn - The Amazon Resource Name (ARN) of the event bus.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringTime - The time the event bus was last modified, as an ISO 8601 timestamp.
- State
Pulumi.
Aws Native. Events V2. Event Bus State - The lifecycle state of the event bus. The settled operational state is ACTIVE.
- Creation
Time string - The time the event bus was created, as an ISO 8601 timestamp.
- Event
Bus stringArn - The Amazon Resource Name (ARN) of the event bus.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringTime - The time the event bus was last modified, as an ISO 8601 timestamp.
- State
Event
Bus State Enum - The lifecycle state of the event bus. The settled operational state is ACTIVE.
- creation_
time string - The time the event bus was created, as an ISO 8601 timestamp.
- event_
bus_ stringarn - The Amazon Resource Name (ARN) of the event bus.
- id string
- The provider-assigned unique ID for this managed resource.
- last_
modified_ stringtime - The time the event bus was last modified, as an ISO 8601 timestamp.
- state "CREATING" | "ACTIVE" | "UPDATING" | "CREATE_FAILED" | "UPDATE_FAILED" | "DELETE_FAILED" | "DELETING"
- The lifecycle state of the event bus. The settled operational state is ACTIVE.
- creation
Time String - The time the event bus was created, as an ISO 8601 timestamp.
- event
Bus StringArn - The Amazon Resource Name (ARN) of the event bus.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringTime - The time the event bus was last modified, as an ISO 8601 timestamp.
- state
Event
Bus State - The lifecycle state of the event bus. The settled operational state is ACTIVE.
- creation
Time string - The time the event bus was created, as an ISO 8601 timestamp.
- event
Bus stringArn - The Amazon Resource Name (ARN) of the event bus.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Modified stringTime - The time the event bus was last modified, as an ISO 8601 timestamp.
- state
Event
Bus State - The lifecycle state of the event bus. The settled operational state is ACTIVE.
- creation_
time str - The time the event bus was created, as an ISO 8601 timestamp.
- event_
bus_ strarn - The Amazon Resource Name (ARN) of the event bus.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
modified_ strtime - The time the event bus was last modified, as an ISO 8601 timestamp.
- state
Event
Bus State - The lifecycle state of the event bus. The settled operational state is ACTIVE.
- creation
Time String - The time the event bus was created, as an ISO 8601 timestamp.
- event
Bus StringArn - The Amazon Resource Name (ARN) of the event bus.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringTime - The time the event bus was last modified, as an ISO 8601 timestamp.
- state "CREATING" | "ACTIVE" | "UPDATING" | "CREATE_FAILED" | "UPDATE_FAILED" | "DELETE_FAILED" | "DELETING"
- The lifecycle state of the event bus. The settled operational state is ACTIVE.
Supporting Types
EventBusEncryptionConfiguration, EventBusEncryptionConfigurationArgs
Encryption configuration for an event bus.- Kms
Key stringIdentifier - The identifier of the AWS KMS customer managed key that the event bus uses to encrypt events. You can specify the key ARN, key ID, alias name, or alias ARN. If you do not specify a key, EventBridge uses an AWS owned key.
- Kms
Key stringIdentifier - The identifier of the AWS KMS customer managed key that the event bus uses to encrypt events. You can specify the key ARN, key ID, alias name, or alias ARN. If you do not specify a key, EventBridge uses an AWS owned key.
- kms_
key_ stringidentifier - The identifier of the AWS KMS customer managed key that the event bus uses to encrypt events. You can specify the key ARN, key ID, alias name, or alias ARN. If you do not specify a key, EventBridge uses an AWS owned key.
- kms
Key StringIdentifier - The identifier of the AWS KMS customer managed key that the event bus uses to encrypt events. You can specify the key ARN, key ID, alias name, or alias ARN. If you do not specify a key, EventBridge uses an AWS owned key.
- kms
Key stringIdentifier - The identifier of the AWS KMS customer managed key that the event bus uses to encrypt events. You can specify the key ARN, key ID, alias name, or alias ARN. If you do not specify a key, EventBridge uses an AWS owned key.
- kms_
key_ stridentifier - The identifier of the AWS KMS customer managed key that the event bus uses to encrypt events. You can specify the key ARN, key ID, alias name, or alias ARN. If you do not specify a key, EventBridge uses an AWS owned key.
- kms
Key StringIdentifier - The identifier of the AWS KMS customer managed key that the event bus uses to encrypt events. You can specify the key ARN, key ID, alias name, or alias ARN. If you do not specify a key, EventBridge uses an AWS owned key.
EventBusState, EventBusStateArgs
- Creating
CREATING- Active
ACTIVE- Updating
UPDATING- Create
Failed CREATE_FAILED- Update
Failed UPDATE_FAILED- Delete
Failed DELETE_FAILED- Deleting
DELETING
- Event
Bus State Creating CREATING- Event
Bus State Active ACTIVE- Event
Bus State Updating UPDATING- Event
Bus State Create Failed CREATE_FAILED- Event
Bus State Update Failed UPDATE_FAILED- Event
Bus State Delete Failed DELETE_FAILED- Event
Bus State Deleting DELETING
- "CREATING"
CREATING- "ACTIVE"
ACTIVE- "UPDATING"
UPDATING- "CREATE_FAILED"
CREATE_FAILED- "UPDATE_FAILED"
UPDATE_FAILED- "DELETE_FAILED"
DELETE_FAILED- "DELETING"
DELETING
- Creating
CREATING- Active
ACTIVE- Updating
UPDATING- Create
Failed CREATE_FAILED- Update
Failed UPDATE_FAILED- Delete
Failed DELETE_FAILED- Deleting
DELETING
- Creating
CREATING- Active
ACTIVE- Updating
UPDATING- Create
Failed CREATE_FAILED- Update
Failed UPDATE_FAILED- Delete
Failed DELETE_FAILED- Deleting
DELETING
- CREATING
CREATING- ACTIVE
ACTIVE- UPDATING
UPDATING- CREATE_FAILED
CREATE_FAILED- UPDATE_FAILED
UPDATE_FAILED- DELETE_FAILED
DELETE_FAILED- DELETING
DELETING
- "CREATING"
CREATING- "ACTIVE"
ACTIVE- "UPDATING"
UPDATING- "CREATE_FAILED"
CREATE_FAILED- "UPDATE_FAILED"
UPDATE_FAILED- "DELETE_FAILED"
DELETE_FAILED- "DELETING"
DELETING
EventBusStorageConfiguration, EventBusStorageConfigurationArgs
Storage (retention) configuration for the event bus.- Retention
Period intIn Days - The number of days events are retained on the event bus for replay, 1-365.
- Retention
Period intIn Days - The number of days events are retained on the event bus for replay, 1-365.
- retention_
period_ numberin_ days - The number of days events are retained on the event bus for replay, 1-365.
- retention
Period IntegerIn Days - The number of days events are retained on the event bus for replay, 1-365.
- retention
Period numberIn Days - The number of days events are retained on the event bus for replay, 1-365.
- retention_
period_ intin_ days - The number of days events are retained on the event bus for replay, 1-365.
- retention
Period NumberIn Days - The number of days events are retained on the event bus for replay, 1-365.
Tag, TagArgs
A set of tags to apply to the resource.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 28, 2026 by Pulumi