Skip to content

Update Subscriber

securitylake_update_subscriber R Documentation

Updates an existing subscription for the given Amazon Security Lake account ID

Description

Updates an existing subscription for the given Amazon Security Lake account ID. You can update a subscriber by changing the sources that the subscriber consumes data from.

Usage

securitylake_update_subscriber(sources, subscriberDescription,
  subscriberId, subscriberIdentity, subscriberName)

Arguments

sources

The supported Amazon Web Services services from which logs and events are collected. For the list of supported Amazon Web Services services, see the Amazon Security Lake User Guide.
subscriberDescription

The description of the Security Lake account subscriber.
subscriberId

[required] A value created by Security Lake that uniquely identifies your subscription.
subscriberIdentity

The Amazon Web Services identity used to access your data.
subscriberName

The name of the Security Lake account subscriber.

Value

A list with the following syntax:

list(
  subscriber = list(
    accessTypes = list(
      "LAKEFORMATION"|"S3"
    ),
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    resourceShareArn = "string",
    resourceShareName = "string",
    roleArn = "string",
    s3BucketArn = "string",
    sources = list(
      list(
        awsLogSource = list(
          sourceName = "ROUTE53"|"VPC_FLOW"|"SH_FINDINGS"|"CLOUD_TRAIL_MGMT"|"LAMBDA_EXECUTION"|"S3_DATA"|"EKS_AUDIT"|"WAF",
          sourceVersion = "string"
        ),
        customLogSource = list(
          attributes = list(
            crawlerArn = "string",
            databaseArn = "string",
            tableArn = "string"
          ),
          provider = list(
            location = "string",
            roleArn = "string"
          ),
          sourceName = "string",
          sourceVersion = "string"
        )
      )
    ),
    subscriberArn = "string",
    subscriberDescription = "string",
    subscriberEndpoint = "string",
    subscriberId = "string",
    subscriberIdentity = list(
      externalId = "string",
      principal = "string"
    ),
    subscriberName = "string",
    subscriberStatus = "ACTIVE"|"DEACTIVATED"|"PENDING"|"READY",
    updatedAt = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$update_subscriber(
  sources = list(
    list(
      awsLogSource = list(
        sourceName = "ROUTE53"|"VPC_FLOW"|"SH_FINDINGS"|"CLOUD_TRAIL_MGMT"|"LAMBDA_EXECUTION"|"S3_DATA"|"EKS_AUDIT"|"WAF",
        sourceVersion = "string"
      ),
      customLogSource = list(
        attributes = list(
          crawlerArn = "string",
          databaseArn = "string",
          tableArn = "string"
        ),
        provider = list(
          location = "string",
          roleArn = "string"
        ),
        sourceName = "string",
        sourceVersion = "string"
      )
    )
  ),
  subscriberDescription = "string",
  subscriberId = "string",
  subscriberIdentity = list(
    externalId = "string",
    principal = "string"
  ),
  subscriberName = "string"
)