CfnDataLakePropsMixin

class aws_cdk.mixins_preview.aws_securitylake.mixins.CfnDataLakePropsMixin(props, *, strategy=None)

Bases: Mixin

Initializes an Amazon Security Lake instance with the provided (or default) configuration.

You can enable Security Lake in AWS Regions with customized settings before enabling log collection in Regions. To specify particular Regions, configure these Regions using the configurations parameter. If you have already enabled Security Lake in a Region when you call this command, the command will update the Region if you provide new configuration parameters. If you have not already enabled Security Lake in the Region when you call this API, it will set up the data lake in the Region with the specified configurations.

When you enable Security Lake , it starts ingesting security data after the CreateAwsLogSource call. This includes ingesting security data from sources, storing data, and making data accessible to subscribers. Security Lake also enables all the existing settings and resources that it stores or maintains for your AWS account in the current Region, including security log and event data. For more information, see the Amazon Security Lake User Guide . .. epigraph:

If you use this template to create multiple data lakes in different AWS Regions , and more than one of your data lakes include an `AWS::SecurityLake::AwsLogSource <https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-resource-securitylake-awslogsource.html>`_ resource, then you must deploy these data lakes sequentially. This is required because data lakes operate globally, and ``AwsLogSource`` resources must be deployed one at a time.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securitylake-datalake.html
CloudformationResource:: AWS::SecurityLake::DataLake
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_securitylake import mixins as securitylake_mixins

cfn_data_lake_props_mixin = securitylake_mixins.CfnDataLakePropsMixin(securitylake_mixins.CfnDataLakeMixinProps(
    encryption_configuration=securitylake_mixins.CfnDataLakePropsMixin.EncryptionConfigurationProperty(
        kms_key_id="kmsKeyId"
    ),
    lifecycle_configuration=securitylake_mixins.CfnDataLakePropsMixin.LifecycleConfigurationProperty(
        expiration=securitylake_mixins.CfnDataLakePropsMixin.ExpirationProperty(
            days=123
        ),
        transitions=[securitylake_mixins.CfnDataLakePropsMixin.TransitionsProperty(
            days=123,
            storage_class="storageClass"
        )]
    ),
    meta_store_manager_role_arn="metaStoreManagerRoleArn",
    replication_configuration=securitylake_mixins.CfnDataLakePropsMixin.ReplicationConfigurationProperty(
        regions=["regions"],
        role_arn="roleArn"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::SecurityLake::DataLake.

Parameters:

props (Union[CfnDataLakeMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['encryptionConfiguration', 'lifecycleConfiguration', 'metaStoreManagerRoleArn', 'replicationConfiguration', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

EncryptionConfigurationProperty

class CfnDataLakePropsMixin.EncryptionConfigurationProperty(*, kms_key_id=None)

Bases: object

Provides encryption details of the Amazon Security Lake object.

The AWS shared responsibility model applies to data protection in Amazon Security Lake . As described in this model, AWS is responsible for protecting the global infrastructure that runs all of the AWS Cloud. You are responsible for maintaining control over your content that is hosted on this infrastructure. For more details, see Data protection in the Amazon Security Lake User Guide.

Parameters:: kms_key_id (Optional[str]) – The ID of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake object.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-encryptionconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_securitylake import mixins as securitylake_mixins

encryption_configuration_property = securitylake_mixins.CfnDataLakePropsMixin.EncryptionConfigurationProperty(
    kms_key_id="kmsKeyId"
)

Attributes

kms_key_id

The ID of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake object.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-encryptionconfiguration.html#cfn-securitylake-datalake-encryptionconfiguration-kmskeyid

ExpirationProperty

class CfnDataLakePropsMixin.ExpirationProperty(*, days=None)

Bases: object

Provides data expiration details of the Amazon Security Lake object.

You can specify your preferred Amazon S3 storage class and the time period for S3 objects to stay in that storage class before they expire. For more information about Amazon S3 Lifecycle configurations, see Managing your storage lifecycle in the Amazon Simple Storage Service User Guide .

Parameters:: days (Union[int, float, None]) – The number of days before data expires in the Amazon Security Lake object.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-expiration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_securitylake import mixins as securitylake_mixins

expiration_property = securitylake_mixins.CfnDataLakePropsMixin.ExpirationProperty(
    days=123
)

Attributes

days

The number of days before data expires in the Amazon Security Lake object.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-expiration.html#cfn-securitylake-datalake-expiration-days

LifecycleConfigurationProperty

class CfnDataLakePropsMixin.LifecycleConfigurationProperty(*, expiration=None, transitions=None)

Bases: object

Provides lifecycle details of Amazon Security Lake object.

To manage your data so that it is stored cost effectively, you can configure retention settings for the data. You can specify your preferred Amazon S3 storage class and the time period for Amazon S3 objects to stay in that storage class before they transition to a different storage class or expire. For more information about Amazon S3 Lifecycle configurations, see Managing your storage lifecycle in the Amazon Simple Storage Service User Guide .

In Security Lake , you specify retention settings at the Region level. For example, you might choose to transition all S3 objects in a specific AWS Region to the S3 Standard-IA storage class 30 days after they’re written to the data lake. The default Amazon S3 storage class is S3 Standard. .. epigraph:

Security Lake doesn't support Amazon S3 Object Lock. When the data lake buckets are created, S3 Object Lock is disabled by default. Enabling S3 Object Lock with default retention mode interrupts the delivery of normalized log data to the data lake.

Parameters:

expiration (Union[IResolvable, ExpirationProperty, Dict[str, Any], None]) – Provides data expiration details of the Amazon Security Lake object.
transitions (Union[IResolvable, Sequence[Union[IResolvable, TransitionsProperty, Dict[str, Any]]], None]) – Provides data storage transition details of Amazon Security Lake object. By configuring these settings, you can specify your preferred Amazon S3 storage class and the time period for S3 objects to stay in that storage class before they transition to a different storage class.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-lifecycleconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_securitylake import mixins as securitylake_mixins

lifecycle_configuration_property = securitylake_mixins.CfnDataLakePropsMixin.LifecycleConfigurationProperty(
    expiration=securitylake_mixins.CfnDataLakePropsMixin.ExpirationProperty(
        days=123
    ),
    transitions=[securitylake_mixins.CfnDataLakePropsMixin.TransitionsProperty(
        days=123,
        storage_class="storageClass"
    )]
)

Attributes

expiration

Provides data expiration details of the Amazon Security Lake object.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-lifecycleconfiguration.html#cfn-securitylake-datalake-lifecycleconfiguration-expiration

transitions

Provides data storage transition details of Amazon Security Lake object.

By configuring these settings, you can specify your preferred Amazon S3 storage class and the time period for S3 objects to stay in that storage class before they transition to a different storage class.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-lifecycleconfiguration.html#cfn-securitylake-datalake-lifecycleconfiguration-transitions

ReplicationConfigurationProperty

class CfnDataLakePropsMixin.ReplicationConfigurationProperty(*, regions=None, role_arn=None)

Bases: object

Provides replication configuration details for objects stored in the Amazon Security Lake data lake.

Parameters:

regions (Optional[Sequence[str]]) – Specifies one or more centralized rollup Regions. The AWS Region specified in the region parameter of the CreateDataLake or UpdateDataLake operations contributes data to the rollup Region or Regions specified in this parameter. Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. S3 buckets that are configured for object replication can be owned by the same AWS account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different Regions or within the same Region as the source bucket.
role_arn (Optional[str]) – Replication settings for the Amazon S3 buckets. This parameter uses the AWS Identity and Access Management (IAM) role you created that is managed by Security Lake , to ensure the replication setting is correct.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-replicationconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_securitylake import mixins as securitylake_mixins

replication_configuration_property = securitylake_mixins.CfnDataLakePropsMixin.ReplicationConfigurationProperty(
    regions=["regions"],
    role_arn="roleArn"
)

Attributes

regions

Specifies one or more centralized rollup Regions.

The AWS Region specified in the region parameter of the CreateDataLake or UpdateDataLake operations contributes data to the rollup Region or Regions specified in this parameter.

Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. S3 buckets that are configured for object replication can be owned by the same AWS account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different Regions or within the same Region as the source bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-replicationconfiguration.html#cfn-securitylake-datalake-replicationconfiguration-regions

role_arn

Replication settings for the Amazon S3 buckets.

This parameter uses the AWS Identity and Access Management (IAM) role you created that is managed by Security Lake , to ensure the replication setting is correct.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-replicationconfiguration.html#cfn-securitylake-datalake-replicationconfiguration-rolearn

TransitionsProperty

class CfnDataLakePropsMixin.TransitionsProperty(*, days=None, storage_class=None)

Bases: object

Provides transition lifecycle details of the Amazon Security Lake object.

For more information about Amazon S3 Lifecycle configurations, see Managing your storage lifecycle in the Amazon Simple Storage Service User Guide .

Parameters:

days (Union[int, float, None]) – The number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object.
storage_class (Optional[str]) – The list of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads. The default storage class is S3 Standard . For information about other storage classes, see Setting the storage class of an object in the Amazon S3 User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-transitions.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_securitylake import mixins as securitylake_mixins

transitions_property = securitylake_mixins.CfnDataLakePropsMixin.TransitionsProperty(
    days=123,
    storage_class="storageClass"
)

Attributes

days

The number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-transitions.html#cfn-securitylake-datalake-transitions-days

storage_class

The list of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.

The default storage class is S3 Standard . For information about other storage classes, see Setting the storage class of an object in the Amazon S3 User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-transitions.html#cfn-securitylake-datalake-transitions-storageclass