class Amazonite::EventBridge::CreateArchiveRequest

Included Modules

Defined in:

eventbridge/create_archive_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(archive_name : String, event_source_arn : String, description : String | Nil = nil, event_pattern : String | Nil = nil, retention_days : Int32 | Nil = nil, kms_key_identifier : String | Nil = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[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 archive_name : String #

The name for the archive to create.


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

The name for the archive to create.


[View source]
def description : String | Nil #

A description for the archive.


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

A description for the archive.


[View source]
def event_pattern : String | Nil #

An event pattern to use to filter events sent to the archive.


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

An event pattern to use to filter events sent to the archive.


[View source]
def event_source_arn : String #

The ARN of the event bus that sends events to the archive.


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

The ARN of the event bus that sends events to the archive.


[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 this archive. 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 the archive.

For more information, see Identify and view keys in the Key Management Service Developer 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 this archive. 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 the archive.

For more information, see Identify and view keys in the Key Management Service Developer 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 retention_days : Int32 | Nil #

The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely


[View source]
def retention_days=(retention_days : Int32 | Nil) #

The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely


[View source]
def validate! : Nil #

[View source]