1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. events
  5. getEventBus

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

aws-native.events.getEventBus

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

Resource type definition for AWS::Events::EventBus

Using getEventBus

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEventBus(args: GetEventBusArgs, opts?: InvokeOptions): Promise<GetEventBusResult>
function getEventBusOutput(args: GetEventBusOutputArgs, opts?: InvokeOptions): Output<GetEventBusResult>
Copy
def get_event_bus(name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetEventBusResult
def get_event_bus_output(name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetEventBusResult]
Copy
func LookupEventBus(ctx *Context, args *LookupEventBusArgs, opts ...InvokeOption) (*LookupEventBusResult, error)
func LookupEventBusOutput(ctx *Context, args *LookupEventBusOutputArgs, opts ...InvokeOption) LookupEventBusResultOutput
Copy

> Note: This function is named LookupEventBus in the Go SDK.

public static class GetEventBus 
{
    public static Task<GetEventBusResult> InvokeAsync(GetEventBusArgs args, InvokeOptions? opts = null)
    public static Output<GetEventBusResult> Invoke(GetEventBusInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetEventBusResult> getEventBus(GetEventBusArgs args, InvokeOptions options)
public static Output<GetEventBusResult> getEventBus(GetEventBusArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:events:getEventBus
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
The name of the event bus.
Name This property is required. string
The name of the event bus.
name This property is required. String
The name of the event bus.
name This property is required. string
The name of the event bus.
name This property is required. str
The name of the event bus.
name This property is required. String
The name of the event bus.

getEventBus Result

The following output properties are available:

Arn string
The Amazon Resource Name (ARN) for the event bus.
DeadLetterConfig Pulumi.AwsNative.Events.Outputs.DeadLetterConfigProperties
Dead Letter Queue for the event bus.
Description string
The description of the event bus.
KmsKeyIdentifier string
Kms Key Identifier used to encrypt events at rest in the event bus.
Policy object

A JSON string that describes the permission policy statement for the event bus.

Search the CloudFormation User Guide for AWS::Events::EventBus for more information about the expected schema for this property.

Tags List<Pulumi.AwsNative.Outputs.Tag>
Any tags assigned to the event bus.
Arn string
The Amazon Resource Name (ARN) for the event bus.
DeadLetterConfig DeadLetterConfigProperties
Dead Letter Queue for the event bus.
Description string
The description of the event bus.
KmsKeyIdentifier string
Kms Key Identifier used to encrypt events at rest in the event bus.
Policy interface{}

A JSON string that describes the permission policy statement for the event bus.

Search the CloudFormation User Guide for AWS::Events::EventBus for more information about the expected schema for this property.

Tags Tag
Any tags assigned to the event bus.
arn String
The Amazon Resource Name (ARN) for the event bus.
deadLetterConfig DeadLetterConfigProperties
Dead Letter Queue for the event bus.
description String
The description of the event bus.
kmsKeyIdentifier String
Kms Key Identifier used to encrypt events at rest in the event bus.
policy Object

A JSON string that describes the permission policy statement for the event bus.

Search the CloudFormation User Guide for AWS::Events::EventBus for more information about the expected schema for this property.

tags List<Tag>
Any tags assigned to the event bus.
arn string
The Amazon Resource Name (ARN) for the event bus.
deadLetterConfig DeadLetterConfigProperties
Dead Letter Queue for the event bus.
description string
The description of the event bus.
kmsKeyIdentifier string
Kms Key Identifier used to encrypt events at rest in the event bus.
policy any

A JSON string that describes the permission policy statement for the event bus.

Search the CloudFormation User Guide for AWS::Events::EventBus for more information about the expected schema for this property.

tags Tag[]
Any tags assigned to the event bus.
arn str
The Amazon Resource Name (ARN) for the event bus.
dead_letter_config DeadLetterConfigProperties
Dead Letter Queue for the event bus.
description str
The description of the event bus.
kms_key_identifier str
Kms Key Identifier used to encrypt events at rest in the event bus.
policy Any

A JSON string that describes the permission policy statement for the event bus.

Search the CloudFormation User Guide for AWS::Events::EventBus for more information about the expected schema for this property.

tags Sequence[root_Tag]
Any tags assigned to the event bus.
arn String
The Amazon Resource Name (ARN) for the event bus.
deadLetterConfig Property Map
Dead Letter Queue for the event bus.
description String
The description of the event bus.
kmsKeyIdentifier String
Kms Key Identifier used to encrypt events at rest in the event bus.
policy Any

A JSON string that describes the permission policy statement for the event bus.

Search the CloudFormation User Guide for AWS::Events::EventBus for more information about the expected schema for this property.

tags List<Property Map>
Any tags assigned to the event bus.

Supporting Types

DeadLetterConfigProperties

Arn string
The ARN of the SQS queue specified as the target for the dead-letter queue.
Arn string
The ARN of the SQS queue specified as the target for the dead-letter queue.
arn String
The ARN of the SQS queue specified as the target for the dead-letter queue.
arn string
The ARN of the SQS queue specified as the target for the dead-letter queue.
arn str
The ARN of the SQS queue specified as the target for the dead-letter queue.
arn String
The ARN of the SQS queue specified as the target for the dead-letter queue.

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi