amazonka-securitylake-2.0: Amazon Security Lake SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SecurityLake.CreateDatalake

Description

Initializes an Amazon Security Lake instance with the provided (or default) configuration. You can enable Security Lake in Amazon Web Services Regions with customized settings before enabling log collection in Regions. You can either use the enableAll parameter to specify all Regions or specify the Regions where you want to enable Security Lake. To specify particular Regions, use the Regions parameter and then 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 Amazon Web Services account in the current Region, including security log and event data. For more information, see the Amazon Security Lake User Guide.

Synopsis

Creating a Request

data CreateDatalake Source #

See: newCreateDatalake smart constructor.

Constructors

CreateDatalake' 

Fields

Instances

Instances details
ToJSON CreateDatalake Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateDatalake

ToHeaders CreateDatalake Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateDatalake

ToPath CreateDatalake Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateDatalake

ToQuery CreateDatalake Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateDatalake

AWSRequest CreateDatalake Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateDatalake

Associated Types

type AWSResponse CreateDatalake #

Generic CreateDatalake Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateDatalake

Associated Types

type Rep CreateDatalake :: Type -> Type #

Read CreateDatalake Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateDatalake

Show CreateDatalake Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateDatalake

NFData CreateDatalake Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateDatalake

Methods

rnf :: CreateDatalake -> () #

Eq CreateDatalake Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateDatalake

Hashable CreateDatalake Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateDatalake

type AWSResponse CreateDatalake Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateDatalake

type Rep CreateDatalake Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateDatalake

type Rep CreateDatalake = D1 ('MetaData "CreateDatalake" "Amazonka.SecurityLake.CreateDatalake" "amazonka-securitylake-2.0-4WRm07ESU278sNrKhxoCOb" 'False) (C1 ('MetaCons "CreateDatalake'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "configurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Region LakeConfigurationRequest))) :*: S1 ('MetaSel ('Just "enableAll") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "metaStoreManagerRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "regions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Region])))))

newCreateDatalake :: CreateDatalake Source #

Create a value of CreateDatalake with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:configurations:CreateDatalake', createDatalake_configurations - Specify the Region or Regions that will contribute data to the rollup region.

$sel:enableAll:CreateDatalake', createDatalake_enableAll - Enable Security Lake in all Regions.

$sel:metaStoreManagerRoleArn:CreateDatalake', createDatalake_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.

$sel:regions:CreateDatalake', createDatalake_regions - Enable Security Lake in the specified Regions. To enable Security Lake in specific Amazon Web Services Regions, such as us-east-1 or ap-northeast-3, provide the Region codes. For a list of Region codes, see Amazon Security Lake endpoints in the Amazon Web Services General Reference.

Request Lenses

createDatalake_configurations :: Lens' CreateDatalake (Maybe (HashMap Region LakeConfigurationRequest)) Source #

Specify the Region or Regions that will contribute data to the rollup region.

createDatalake_enableAll :: Lens' CreateDatalake (Maybe Bool) Source #

Enable Security Lake in all Regions.

createDatalake_metaStoreManagerRoleArn :: Lens' CreateDatalake (Maybe Text) Source #

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.

createDatalake_regions :: Lens' CreateDatalake (Maybe [Region]) Source #

Enable Security Lake in the specified Regions. To enable Security Lake in specific Amazon Web Services Regions, such as us-east-1 or ap-northeast-3, provide the Region codes. For a list of Region codes, see Amazon Security Lake endpoints in the Amazon Web Services General Reference.

Destructuring the Response

data CreateDatalakeResponse Source #

See: newCreateDatalakeResponse smart constructor.

Constructors

CreateDatalakeResponse' 

Fields

Instances

Instances details
Generic CreateDatalakeResponse Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateDatalake

Associated Types

type Rep CreateDatalakeResponse :: Type -> Type #

Read CreateDatalakeResponse Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateDatalake

Show CreateDatalakeResponse Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateDatalake

NFData CreateDatalakeResponse Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateDatalake

Methods

rnf :: CreateDatalakeResponse -> () #

Eq CreateDatalakeResponse Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateDatalake

type Rep CreateDatalakeResponse Source # 
Instance details

Defined in Amazonka.SecurityLake.CreateDatalake

type Rep CreateDatalakeResponse = D1 ('MetaData "CreateDatalakeResponse" "Amazonka.SecurityLake.CreateDatalake" "amazonka-securitylake-2.0-4WRm07ESU278sNrKhxoCOb" 'False) (C1 ('MetaCons "CreateDatalakeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDatalakeResponse Source #

Create a value of CreateDatalakeResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateDatalakeResponse', createDatalakeResponse_httpStatus - The response's http status code.

Response Lenses