Class CfnDataLake
- All Implemented Interfaces:
IInspectable
,ITaggableV2
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
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 .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.securitylake.*; CfnDataLake cfnDataLake = CfnDataLake.Builder.create(this, "MyCfnDataLake") .encryptionConfiguration(EncryptionConfigurationProperty.builder() .kmsKeyId("kmsKeyId") .build()) .lifecycleConfiguration(LifecycleConfigurationProperty.builder() .expiration(ExpirationProperty.builder() .days(123) .build()) .transitions(List.of(TransitionsProperty.builder() .days(123) .storageClass("storageClass") .build())) .build()) .metaStoreManagerRoleArn("metaStoreManagerRoleArn") .replicationConfiguration(ReplicationConfigurationProperty.builder() .regions(List.of("regions")) .roleArn("roleArn") .build()) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnDataLake
.static interface
Provides encryption details of the Amazon Security Lake object.static interface
Provides data expiration details of the Amazon Security Lake object.static interface
Provides lifecycle details of Amazon Security Lake object.static interface
Provides replication configuration details for objects stored in the Amazon Security Lake data lake.static interface
Provides transition lifecycle details of the Amazon Security Lake object.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2
ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnDataLake
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnDataLake
(software.amazon.jsii.JsiiObjectRef objRef) CfnDataLake
(software.constructs.Construct scope, String id) CfnDataLake
(software.constructs.Construct scope, String id, CfnDataLakeProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the data lake.The Amazon Resource Name (ARN) of the Amazon S3 bucket.Tag Manager which manages the tags for this resource.Provides encryption details of the Amazon Security Lake object.You can customize Security Lake to store data in your preferred AWS Regions for your preferred amount of time.The Amazon Resource Name (ARN) used to create and update the AWS Glue table.Provides replication details of Amazon Security Lake object.getTags()
An array of objects, one for each tag to associate with the data lake configuration.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
Provides encryption details of the Amazon Security Lake object.void
Provides encryption details of the Amazon Security Lake object.void
You can customize Security Lake to store data in your preferred AWS Regions for your preferred amount of time.void
You can customize Security Lake to store data in your preferred AWS Regions for your preferred amount of time.void
setMetaStoreManagerRoleArn
(String value) The Amazon Resource Name (ARN) used to create and update the AWS Glue table.void
Provides replication details of Amazon Security Lake object.void
Provides replication details of Amazon Security Lake object.void
An array of objects, one for each tag to associate with the data lake configuration.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnDataLake
protected CfnDataLake(software.amazon.jsii.JsiiObjectRef objRef) -
CfnDataLake
protected CfnDataLake(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnDataLake
@Stability(Stable) public CfnDataLake(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnDataLakeProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties.
-
CfnDataLake
@Stability(Stable) public CfnDataLake(@NotNull software.constructs.Construct scope, @NotNull String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the data lake. -
getAttrS3BucketArn
The Amazon Resource Name (ARN) of the Amazon S3 bucket. -
getCdkTagManager
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManager
in interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getEncryptionConfiguration
Provides encryption details of the Amazon Security Lake object. -
setEncryptionConfiguration
Provides encryption details of the Amazon Security Lake object. -
setEncryptionConfiguration
@Stability(Stable) public void setEncryptionConfiguration(@Nullable CfnDataLake.EncryptionConfigurationProperty value) Provides encryption details of the Amazon Security Lake object. -
getLifecycleConfiguration
You can customize Security Lake to store data in your preferred AWS Regions for your preferred amount of time. -
setLifecycleConfiguration
You can customize Security Lake to store data in your preferred AWS Regions for your preferred amount of time. -
setLifecycleConfiguration
@Stability(Stable) public void setLifecycleConfiguration(@Nullable CfnDataLake.LifecycleConfigurationProperty value) You can customize Security Lake to store data in your preferred AWS Regions for your preferred amount of time. -
getMetaStoreManagerRoleArn
The Amazon Resource Name (ARN) used to create and update the AWS Glue table. -
setMetaStoreManagerRoleArn
The Amazon Resource Name (ARN) used to create and update the AWS Glue table. -
getReplicationConfiguration
Provides replication details of Amazon Security Lake object. -
setReplicationConfiguration
Provides replication details of Amazon Security Lake object. -
setReplicationConfiguration
@Stability(Stable) public void setReplicationConfiguration(@Nullable CfnDataLake.ReplicationConfigurationProperty value) Provides replication details of Amazon Security Lake object. -
getTags
An array of objects, one for each tag to associate with the data lake configuration. -
setTags
An array of objects, one for each tag to associate with the data lake configuration.
-