Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. events
  5. EventBus

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.events.EventBus

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource type definition for AWS::Events::EventBus

    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,
             dead_letter_config: Optional[DeadLetterConfigPropertiesArgs] = None,
             description: Optional[str] = None,
             event_source_name: Optional[str] = None,
             kms_key_identifier: Optional[str] = None,
             name: Optional[str] = None,
             policy: Optional[Any] = 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:events:EventBus
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    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

    The EventBus resource accepts the following input properties:

    DeadLetterConfig Pulumi.AwsNative.Events.Inputs.DeadLetterConfigProperties
    Dead Letter Queue for the event bus.
    Description string
    The description of the event bus.
    EventSourceName string
    If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
    KmsKeyIdentifier string
    Kms Key Identifier used to encrypt events at rest in the event bus.
    Name string
    The name of 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.Inputs.Tag>
    Any tags assigned to the event bus.
    DeadLetterConfig DeadLetterConfigPropertiesArgs
    Dead Letter Queue for the event bus.
    Description string
    The description of the event bus.
    EventSourceName string
    If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
    KmsKeyIdentifier string
    Kms Key Identifier used to encrypt events at rest in the event bus.
    Name string
    The name of 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 TagArgs
    Any tags assigned to the event bus.
    deadLetterConfig DeadLetterConfigProperties
    Dead Letter Queue for the event bus.
    description String
    The description of the event bus.
    eventSourceName String
    If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
    kmsKeyIdentifier String
    Kms Key Identifier used to encrypt events at rest in the event bus.
    name String
    The name of 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.
    deadLetterConfig DeadLetterConfigProperties
    Dead Letter Queue for the event bus.
    description string
    The description of the event bus.
    eventSourceName string
    If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
    kmsKeyIdentifier string
    Kms Key Identifier used to encrypt events at rest in the event bus.
    name string
    The name of 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.
    dead_letter_config DeadLetterConfigPropertiesArgs
    Dead Letter Queue for the event bus.
    description str
    The description of the event bus.
    event_source_name str
    If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
    kms_key_identifier str
    Kms Key Identifier used to encrypt events at rest in the event bus.
    name str
    The name of 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[TagArgs]
    Any tags assigned to the event bus.
    deadLetterConfig Property Map
    Dead Letter Queue for the event bus.
    description String
    The description of the event bus.
    eventSourceName String
    If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
    kmsKeyIdentifier String
    Kms Key Identifier used to encrypt events at rest in the event bus.
    name String
    The name of 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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EventBus resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) for the event bus.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The Amazon Resource Name (ARN) for the event bus.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) for the event bus.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) for the event bus.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The Amazon Resource Name (ARN) for the event bus.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) for the event bus.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    DeadLetterConfigProperties, DeadLetterConfigPropertiesArgs

    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, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

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

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native