Create Ingestion Destination

appfabric_create_ingestion_destination

R Documentation

Creates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered

Description

Creates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.

Usage

appfabric_create_ingestion_destination(appBundleIdentifier,
  ingestionIdentifier, processingConfiguration, destinationConfiguration,
  clientToken, tags)

Arguments

appBundleIdentifier

[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

ingestionIdentifier

[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.

processingConfiguration

[required] Contains information about how ingested data is processed.

destinationConfiguration

[required] Contains information about the destination of ingested data.

clientToken

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

tags

A map of the key-value pairs of the tag or tags to assign to the resource.

Value

A list with the following syntax:

list(
  ingestionDestination = list(
    arn = "string",
    ingestionArn = "string",
    processingConfiguration = list(
      auditLog = list(
        schema = "ocsf"|"raw",
        format = "json"|"parquet"
      )
    ),
    destinationConfiguration = list(
      auditLog = list(
        destination = list(
          s3Bucket = list(
            bucketName = "string",
            prefix = "string"
          ),
          firehoseStream = list(
            streamName = "string"
          )
        )
      )
    ),
    status = "Active"|"Failed",
    statusReason = "string",
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    updatedAt = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$create_ingestion_destination(
  appBundleIdentifier = "string",
  ingestionIdentifier = "string",
  processingConfiguration = list(
    auditLog = list(
      schema = "ocsf"|"raw",
      format = "json"|"parquet"
    )
  ),
  destinationConfiguration = list(
    auditLog = list(
      destination = list(
        s3Bucket = list(
          bucketName = "string",
          prefix = "string"
        ),
        firehoseStream = list(
          streamName = "string"
        )
      )
    )
  ),
  clientToken = "string",
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  )
)