class Amazonite::EventBridge::CreateEventBusRequest

Included Modules

Defined in:

eventbridge/create_event_bus_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(name : String, event_source_name : String | Nil = nil, description : String | Nil = nil, kms_key_identifier : String | Nil = nil, dead_letter_config : DeadLetterConfig | Nil = nil, log_config : LogConfig | Nil = nil, tags : Array(Tag) | Nil = nil) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def dead_letter_config : DeadLetterConfig | Nil #

[View source]
def dead_letter_config=(dead_letter_config : DeadLetterConfig | Nil) #

[View source]
def description : String | Nil #

The event bus description.


[View source]
def description=(description : String | Nil) #

The event bus description.


[View source]
def event_source_name : String | Nil #

If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.


[View source]
def event_source_name=(event_source_name : String | Nil) #

If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def kms_key_identifier : String | Nil #

The identifier of the 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.

If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt events on the event bus.

For more information, see Identify and view keys in the Key Management Service Developer Guide.

Schema discovery is not supported for event buses encrypted using a customer managed key. EventBridge returns an error if:

  • You call [CreateDiscoverer](https://docs.aws.amazon.com/eventbridge/latest/schema-reference/v1-discoverers.html#CreateDiscoverer) on an event bus set to use a customer managed key for encryption.

  • You call [UpdatedEventBus](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UpdatedEventBus.html) to set a customer managed key on an event bus with schema discovery enabled.

To enable schema discovery on an event bus, choose to use an Amazon Web Services owned key. For more information, see Encrypting events in the Amazon EventBridge User Guide.

If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.

For more information, see Encrypting archives in the Amazon EventBridge User Guide.


[View source]
def kms_key_identifier=(kms_key_identifier : String | Nil) #

The identifier of the 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.

If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt events on the event bus.

For more information, see Identify and view keys in the Key Management Service Developer Guide.

Schema discovery is not supported for event buses encrypted using a customer managed key. EventBridge returns an error if:

  • You call [CreateDiscoverer](https://docs.aws.amazon.com/eventbridge/latest/schema-reference/v1-discoverers.html#CreateDiscoverer) on an event bus set to use a customer managed key for encryption.

  • You call [UpdatedEventBus](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UpdatedEventBus.html) to set a customer managed key on an event bus with schema discovery enabled.

To enable schema discovery on an event bus, choose to use an Amazon Web Services owned key. For more information, see Encrypting events in the Amazon EventBridge User Guide.

If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.

For more information, see Encrypting archives in the Amazon EventBridge User Guide.


[View source]
def log_config : LogConfig | Nil #

The logging configuration settings for the event bus.

For more information, see Configuring logs for event buses in the EventBridge User Guide.


[View source]
def log_config=(log_config : LogConfig | Nil) #

The logging configuration settings for the event bus.

For more information, see Configuring logs for event buses in the EventBridge User Guide.


[View source]
def name : String #

The name of the new event bus.

Custom event bus names can't contain the / character, but you can use the / character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to.

You can't use the name default for a custom event bus, as this name is already used for your account's default event bus.


[View source]
def name=(name : String) #

The name of the new event bus.

Custom event bus names can't contain the / character, but you can use the / character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to.

You can't use the name default for a custom event bus, as this name is already used for your account's default event bus.


[View source]
def tags : Array(Tag) | Nil #

Tags to associate with the event bus.


[View source]
def tags=(tags : Array(Tag) | Nil) #

Tags to associate with the event bus.


[View source]
def validate! : Nil #

[View source]