Skip to content

Create Archive

cloudwatchevents_create_archive R Documentation

Creates an archive of events with the specified settings

Description

Creates an archive of events with the specified settings. When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect. If you do not specify a pattern to filter events sent to the archive, all events are sent to the archive except replayed events. Replayed events are not sent to an archive.

Usage

cloudwatchevents_create_archive(ArchiveName, EventSourceArn,
  Description, EventPattern, RetentionDays)

Arguments

ArchiveName

[required] The name for the archive to create.

EventSourceArn

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

Description

A description for the archive.

EventPattern

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

RetentionDays

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

Value

A list with the following syntax: 

list(
  ArchiveArn = "string",
  State = "ENABLED"|"DISABLED"|"CREATING"|"UPDATING"|"CREATE_FAILED"|"UPDATE_FAILED",
  StateReason = "string",
  CreationTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$create_archive(
  ArchiveName = "string",
  EventSourceArn = "string",
  Description = "string",
  EventPattern = "string",
  RetentionDays = 123
)