Class: Aws::EventBridge::Types::CreateArchiveRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-eventbridge/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#archive_name ⇒ String

The name for the archive to create.

Returns:

  • (String) 


806
807
808
809
810
811
812
813
814
815
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 806

class CreateArchiveRequest < Struct.new(
  :archive_name,
  :event_source_arn,
  :description,
  :event_pattern,
  :retention_days,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description for the archive.

Returns:

  • (String) 


806
807
808
809
810
811
812
813
814
815
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 806

class CreateArchiveRequest < Struct.new(
  :archive_name,
  :event_source_arn,
  :description,
  :event_pattern,
  :retention_days,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#event_pattern ⇒ String

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

Returns:

  • (String) 


806
807
808
809
810
811
812
813
814
815
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 806

class CreateArchiveRequest < Struct.new(
  :archive_name,
  :event_source_arn,
  :description,
  :event_pattern,
  :retention_days,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#event_source_arn ⇒ String

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

Returns:

  • (String) 


806
807
808
809
810
811
812
813
814
815
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 806

class CreateArchiveRequest < Struct.new(
  :archive_name,
  :event_source_arn,
  :description,
  :event_pattern,
  :retention_days,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_identifier ⇒ String

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][2] in the *Amazon

EventBridge User Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html [2]: docs.aws.amazon.com/eventbridge/latest/userguide/encryption-archives.html

Returns:

  • (String) 


806
807
808
809
810
811
812
813
814
815
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 806

class CreateArchiveRequest < Struct.new(
  :archive_name,
  :event_source_arn,
  :description,
  :event_pattern,
  :retention_days,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#retention_days ⇒ Integer

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

Returns:

  • (Integer) 


806
807
808
809
810
811
812
813
814
815
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 806

class CreateArchiveRequest < Struct.new(
  :archive_name,
  :event_source_arn,
  :description,
  :event_pattern,
  :retention_days,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end