Create Subscriber

securitylake_create_subscriber

R Documentation

Creates a subscription permission for accounts that are already enabled in Amazon Security Lake

Description

Creates a subscription permission for accounts that are already enabled in Amazon Security Lake. You can create a subscriber with access to data in the current Amazon Web Services Region.

Usage

securitylake_create_subscriber(accessTypes, sources,
  subscriberDescription, subscriberIdentity, subscriberName, tags)

Arguments

accessTypes

The Amazon S3 or Lake Formation access type.

sources

[required] The supported Amazon Web Services from which logs and events are collected. Security Lake supports log and event collection for natively supported Amazon Web Services.

subscriberDescription

The description for your subscriber account in Security Lake.

subscriberIdentity

[required] The Amazon Web Services identity used to access your data.

subscriberName

[required] The name of your Security Lake subscriber account.

tags

An array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.

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$create_subscriber(
  accessTypes = list(
    "LAKEFORMATION"|"S3"
  ),
  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",
  subscriberIdentity = list(
    externalId = "string",
    principal = "string"
  ),
  subscriberName = "string",
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  )
)