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

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

Overview

Note:

When making an API call, you may pass CreateArchiveRequest data as a hash:

{
  archive_name: "ArchiveName", # required
  event_source_arn: "Arn", # required
  description: "ArchiveDescription",
  event_pattern: "EventPattern",
  retention_days: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#archive_nameString

The name for the archive to create.

Returns:

  • (String)


849
850
851
852
853
854
855
856
857
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 849

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

#descriptionString

A description for the archive.

Returns:

  • (String)


849
850
851
852
853
854
855
856
857
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 849

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

#event_patternString

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

Returns:

  • (String)


849
850
851
852
853
854
855
856
857
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 849

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

#event_source_arnString

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

Returns:

  • (String)


849
850
851
852
853
854
855
856
857
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 849

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

#retention_daysInteger

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

Returns:

  • (Integer)


849
850
851
852
853
854
855
856
857
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 849

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