DataLake class

Resource for managing an AWS Security Lake Data Lake.

> NOTE: The underlying aws.securitylake.DataLake must be configured before creating other Security Lake resources. Use a dependsOn statement.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.securitylake.DataLake("example", {
    configuration: {
        lifecycleConfiguration: {
            expiration: {
                days: 300,
            },
            transitions: [
                {
                    days: 31,
                    storageClass: "STANDARD_IA",
                },
                {
                    days: 80,
                    storageClass: "ONEZONE_IA",
                },
            ],
        },
        encryptionConfigurations: [{
            kmsKeyId: "S3_MANAGED_KEY",
        }],
        region: "eu-west-1",
    },
    metaStoreManagerRoleArn: metaStoreManager.arn,
});
import pulumi
import pulumi_aws as aws

example = aws.securitylake.DataLake("example",
    configuration={
        "lifecycle_configuration": {
            "expiration": {
                "days": 300,
            },
            "transitions": [
                {
                    "days": 31,
                    "storage_class": "STANDARD_IA",
                },
                {
                    "days": 80,
                    "storage_class": "ONEZONE_IA",
                },
            ],
        },
        "encryption_configurations": [{
            "kms_key_id": "S3_MANAGED_KEY",
        }],
        "region": "eu-west-1",
    },
    meta_store_manager_role_arn=meta_store_manager["arn"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.SecurityLake.DataLake("example", new()
    {
        Configuration = new Aws.SecurityLake.Inputs.DataLakeConfigurationArgs
        {
            LifecycleConfiguration = new Aws.SecurityLake.Inputs.DataLakeConfigurationLifecycleConfigurationArgs
            {
                Expiration = new Aws.SecurityLake.Inputs.DataLakeConfigurationLifecycleConfigurationExpirationArgs
                {
                    Days = 300,
                },
                Transitions = new[]
                {
                    new Aws.SecurityLake.Inputs.DataLakeConfigurationLifecycleConfigurationTransitionArgs
                    {
                        Days = 31,
                        StorageClass = "STANDARD_IA",
                    },
                    new Aws.SecurityLake.Inputs.DataLakeConfigurationLifecycleConfigurationTransitionArgs
                    {
                        Days = 80,
                        StorageClass = "ONEZONE_IA",
                    },
                },
            },
            EncryptionConfigurations = new[]
            {
                new Aws.SecurityLake.Inputs.DataLakeConfigurationEncryptionConfigurationArgs
                {
                    KmsKeyId = "S3_MANAGED_KEY",
                },
            },
            Region = "eu-west-1",
        },
        MetaStoreManagerRoleArn = metaStoreManager.Arn,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/securitylake"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := securitylake.NewDataLake(ctx, "example", &securitylake.DataLakeArgs{
			Configuration: &securitylake.DataLakeConfigurationArgs{
				LifecycleConfiguration: &securitylake.DataLakeConfigurationLifecycleConfigurationArgs{
					Expiration: &securitylake.DataLakeConfigurationLifecycleConfigurationExpirationArgs{
						Days: pulumi.Int(300),
					},
					Transitions: securitylake.DataLakeConfigurationLifecycleConfigurationTransitionArray{
						&securitylake.DataLakeConfigurationLifecycleConfigurationTransitionArgs{
							Days:         pulumi.Int(31),
							StorageClass: pulumi.String("STANDARD_IA"),
						},
						&securitylake.DataLakeConfigurationLifecycleConfigurationTransitionArgs{
							Days:         pulumi.Int(80),
							StorageClass: pulumi.String("ONEZONE_IA"),
						},
					},
				},
				EncryptionConfigurations: securitylake.DataLakeConfigurationEncryptionConfigurationArray{
					&securitylake.DataLakeConfigurationEncryptionConfigurationArgs{
						KmsKeyId: pulumi.String("S3_MANAGED_KEY"),
					},
				},
				Region: pulumi.String("eu-west-1"),
			},
			MetaStoreManagerRoleArn: pulumi.Any(metaStoreManager.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_securitylake_datalake" "example" {
  configuration = {
    lifecycle_configuration = {
      expiration = {
        days = 300
      }
      transitions = [{
        "days"         = 31
        "storageClass" = "STANDARD_IA"
        }, {
        "days"         = 80
        "storageClass" = "ONEZONE_IA"
      }]
    }
    encryption_configurations = [{
      "kmsKeyId" = "S3_MANAGED_KEY"
    }]
    region = "eu-west-1"
  }
  meta_store_manager_role_arn = metaStoreManager.arn
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.securitylake.DataLake;
import com.pulumi.aws.securitylake.DataLakeArgs;
import com.pulumi.aws.securitylake.inputs.DataLakeConfigurationArgs;
import com.pulumi.aws.securitylake.inputs.DataLakeConfigurationLifecycleConfigurationArgs;
import com.pulumi.aws.securitylake.inputs.DataLakeConfigurationLifecycleConfigurationExpirationArgs;
import com.pulumi.aws.securitylake.inputs.DataLakeConfigurationLifecycleConfigurationTransitionArgs;
import com.pulumi.aws.securitylake.inputs.DataLakeConfigurationEncryptionConfigurationArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new DataLake("example", DataLakeArgs.builder()
            .configuration(DataLakeConfigurationArgs.builder()
                .lifecycleConfiguration(DataLakeConfigurationLifecycleConfigurationArgs.builder()
                    .expiration(DataLakeConfigurationLifecycleConfigurationExpirationArgs.builder()
                        .days(300)
                        .build())
                    .transitions(
                        DataLakeConfigurationLifecycleConfigurationTransitionArgs.builder()
                            .days(31)
                            .storageClass("STANDARD_IA")
                            .build(),
                        DataLakeConfigurationLifecycleConfigurationTransitionArgs.builder()
                            .days(80)
                            .storageClass("ONEZONE_IA")
                            .build())
                    .build())
                .encryptionConfigurations(DataLakeConfigurationEncryptionConfigurationArgs.builder()
                    .kmsKeyId("S3_MANAGED_KEY")
                    .build())
                .region("eu-west-1")
                .build())
            .metaStoreManagerRoleArn(metaStoreManager.arn())
            .build());

    }
}
resources:
  example:
    type: aws:securitylake:DataLake
    properties:
      configuration:
        lifecycleConfiguration:
          expiration:
            days: 300
          transitions:
            - days: 31
              storageClass: STANDARD_IA
            - days: 80
              storageClass: ONEZONE_IA
        encryptionConfigurations:
          - kmsKeyId: S3_MANAGED_KEY
        region: eu-west-1
      metaStoreManagerRoleArn: ${metaStoreManager.arn}

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.securitylake.DataLake("example", {
    configuration: {
        encryptionConfigurations: [{
            kmsKeyId: "S3_MANAGED_KEY",
        }],
        region: "eu-west-1",
    },
    metaStoreManagerRoleArn: metaStoreManager.arn,
});
import pulumi
import pulumi_aws as aws

example = aws.securitylake.DataLake("example",
    configuration={
        "encryption_configurations": [{
            "kms_key_id": "S3_MANAGED_KEY",
        }],
        "region": "eu-west-1",
    },
    meta_store_manager_role_arn=meta_store_manager["arn"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.SecurityLake.DataLake("example", new()
    {
        Configuration = new Aws.SecurityLake.Inputs.DataLakeConfigurationArgs
        {
            EncryptionConfigurations = new[]
            {
                new Aws.SecurityLake.Inputs.DataLakeConfigurationEncryptionConfigurationArgs
                {
                    KmsKeyId = "S3_MANAGED_KEY",
                },
            },
            Region = "eu-west-1",
        },
        MetaStoreManagerRoleArn = metaStoreManager.Arn,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/securitylake"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := securitylake.NewDataLake(ctx, "example", &securitylake.DataLakeArgs{
			Configuration: &securitylake.DataLakeConfigurationArgs{
				EncryptionConfigurations: securitylake.DataLakeConfigurationEncryptionConfigurationArray{
					&securitylake.DataLakeConfigurationEncryptionConfigurationArgs{
						KmsKeyId: pulumi.String("S3_MANAGED_KEY"),
					},
				},
				Region: pulumi.String("eu-west-1"),
			},
			MetaStoreManagerRoleArn: pulumi.Any(metaStoreManager.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_securitylake_datalake" "example" {
  configuration = {
    encryption_configurations = [{
      "kmsKeyId" = "S3_MANAGED_KEY"
    }]
    region = "eu-west-1"
  }
  meta_store_manager_role_arn = metaStoreManager.arn
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.securitylake.DataLake;
import com.pulumi.aws.securitylake.DataLakeArgs;
import com.pulumi.aws.securitylake.inputs.DataLakeConfigurationArgs;
import com.pulumi.aws.securitylake.inputs.DataLakeConfigurationEncryptionConfigurationArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new DataLake("example", DataLakeArgs.builder()
            .configuration(DataLakeConfigurationArgs.builder()
                .encryptionConfigurations(DataLakeConfigurationEncryptionConfigurationArgs.builder()
                    .kmsKeyId("S3_MANAGED_KEY")
                    .build())
                .region("eu-west-1")
                .build())
            .metaStoreManagerRoleArn(metaStoreManager.arn())
            .build());

    }
}
resources:
  example:
    type: aws:securitylake:DataLake
    properties:
      configuration:
        encryptionConfigurations:
          - kmsKeyId: S3_MANAGED_KEY
        region: eu-west-1
      metaStoreManagerRoleArn: ${metaStoreManager.arn}

Import

Identity Schema

Required

  • arn (String) ARN of the Security Lake data lake.

Using pulumi import, import Security Hub standards subscriptions using the standards subscription ARN. For example:

$ pulumi import aws:securitylake/dataLake:DataLake example arn:aws:securitylake:eu-west-1:123456789012:data-lake/default

Constructors

DataLake(String name, {DataLakeArgs? args, CustomResourceOptions? options})
Creates a new DataLake. name The Pulumi resource name. args Arguments used to configure this DataLake. The set of arguments for DataLake. options Resource options controlling this resource's behavior.
DataLake.reference(String urn)
Creates a typed reference to an existing DataLake resource.

Properties

arn ↔ Output<String>
ARN of the Data Lake.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
configuration ↔ Output<DataLakeConfiguration>
Specify the Region or Regions that will contribute data to the rollup region.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
metaStoreManagerRoleArn ↔ Output<String>
ARN used to create and update the AWS Glue table. This table contains partitions generated by the ingestion and normalization of AWS log sources and custom sources.
latefinal
region ↔ Output<String>
The AWS Regions where Security Lake is automatically enabled.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
s3BucketArn ↔ Output<String>
The ARN for the Amazon Security Lake Amazon S3 bucket.
latefinal
tags ↔ Output<Map<String, String>?>
Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
timeouts ↔ Output<DataLakeTimeouts?>
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {DataLakeState? state, CustomResourceOptions? options}) → DataLake
Gets an existing DataLake resource's state with the given name and id.