Skip to content

Update Data Lake

securitylake_update_data_lake R Documentation

You can use UpdateDataLake to specify where to store your security data, how it should be encrypted at rest and for how long

Description

You can use update_data_lake to specify where to store your security data, how it should be encrypted at rest and for how long. You can add a Rollup Region to consolidate data from multiple Amazon Web Services Regions, replace default encryption (SSE-S3) with Customer Manged Key, or specify transition and expiration actions through storage Lifecycle management. The update_data_lake API works as an "upsert" operation that performs an insert if the specified item or record does not exist, or an update if it already exists. Security Lake securely stores your data at rest using Amazon Web Services encryption solutions. For more details, see Data protection in Amazon Security Lake.

For example, omitting the key encryptionConfiguration from a Region that is included in an update call that currently uses KMS will leave that Region's KMS key in place, but specifying encryptionConfiguration: {kmsKeyId: 'S3_MANAGED_KEY'} for that same Region will reset the key to S3-managed.

For more details about lifecycle management and how to update retention settings for one or more Regions after enabling Security Lake, see the Amazon Security Lake User Guide.

Usage

securitylake_update_data_lake(configurations, metaStoreManagerRoleArn)

Arguments

configurations

[required] Specifies the Region or Regions that will contribute data to the rollup region.

metaStoreManagerRoleArn

The Amazon Resource Name (ARN) used to create and update the Glue table. This table contains partitions generated by the ingestion and normalization of Amazon Web Services log sources and custom sources.

Value

A list with the following syntax:

list(
  dataLakes = list(
    list(
      createStatus = "INITIALIZED"|"PENDING"|"COMPLETED"|"FAILED",
      dataLakeArn = "string",
      encryptionConfiguration = list(
        kmsKeyId = "string"
      ),
      lifecycleConfiguration = list(
        expiration = list(
          days = 123
        ),
        transitions = list(
          list(
            days = 123,
            storageClass = "string"
          )
        )
      ),
      region = "string",
      replicationConfiguration = list(
        regions = list(
          "string"
        ),
        roleArn = "string"
      ),
      s3BucketArn = "string",
      updateStatus = list(
        exception = list(
          code = "string",
          reason = "string"
        ),
        requestId = "string",
        status = "INITIALIZED"|"PENDING"|"COMPLETED"|"FAILED"
      )
    )
  )
)

Request syntax

svc$update_data_lake(
  configurations = list(
    list(
      encryptionConfiguration = list(
        kmsKeyId = "string"
      ),
      lifecycleConfiguration = list(
        expiration = list(
          days = 123
        ),
        transitions = list(
          list(
            days = 123,
            storageClass = "string"
          )
        )
      ),
      region = "string",
      replicationConfiguration = list(
        regions = list(
          "string"
        ),
        roleArn = "string"
      )
    )
  ),
  metaStoreManagerRoleArn = "string"
)