AWS CLI Command Reference

[ aws . securitylake ]

create-datalake

Description

Initializes an Amazon Security Lake instance with the provided (or default) configuration. You can enable Security Lake in Regions with customized settings in advance before enabling log collection in Regions. You can either use the enableAll parameter to specify all Regions or you can specify the Regions you want to enable Security Lake using the Regions parameter and configure these Regions using the configurations parameter. When the CreateDataLake API is called multiple times, if that Region is already enabled, it will update the Region if configuration for that Region is provided. If that Region is a new Region, it will be set up with the customized configurations if it is specified.

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 account in the current Region, including security log and event data. For more information, see the Amazon Security Lake User Guide.

See also: AWS API Documentation

Synopsis

  create-datalake
[--configurations <value>]
[--enable-all | --no-enable-all]
[--meta-store-manager-role-arn <value>]
[--regions <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--configurations (map)

Enable Security Lake with the specified configurations settings to begin ingesting security data.

key -> (string)

value -> (structure)

Provides details of lake configuration object in Amazon Security Lake.

encryptionKey -> (string)

The type of encryption key used by Security Lake to encrypt the lake configuration object.

replicationDestinationRegions -> (list)

Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. Amazon S3 buckets that are configured for object replication can be owned by the same Amazon Web Services 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 Amazon Web Services Regions or within the same Region as the source bucket.

Set up one or more rollup Regions by providing the Region or Regions that should contribute to the central rollup Region.

(string)

replicationRoleArn -> (string)

Replication settings for the Amazon S3 buckets. This parameter uses the IAM role created by you that is managed by Security Lake, to ensure the replication setting is correct.

retentionSettings -> (list)

Retention settings for the destination Amazon S3 buckets.

(structure)

Retention settings for the destination Amazon S3 buckets in Security Lake.

retentionPeriod -> (integer)

The retention period specifies a fixed period of time during which the Security Lake object remains locked. You can specify the retention period for one or more source in days.

storageClass -> (string)

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

tagsMap -> (map)

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.

key -> (string)

value -> (string)

Shorthand Syntax:

  KeyName1=encryptionKey=string,replicationDestinationRegions=string,string,replicationRoleArn=string,retentionSettings=[{retentionPeriod=integer,storageClass=string},{retentionPeriod=integer,storageClass=string}],tagsMap={KeyName1=string,KeyName2=string},KeyName2=encryptionKey=string,replicationDestinationRegions=string,string,replicationRoleArn=string,retentionSettings=[{retentionPeriod=integer,storageClass=string},{retentionPeriod=integer,storageClass=string}],tagsMap={KeyName1=string,KeyName2=string}

Where valid key names are:
  us-east-1
  us-west-2
  eu-central-1
  us-east-2
  eu-west-1
  ap-northeast-1
  ap-southeast-2

JSON Syntax:

{"us-east-1"|"us-west-2"|"eu-central-1"|"us-east-2"|"eu-west-1"|"ap-northeast-1"|"ap-southeast-2": {
      "encryptionKey": "string",
      "replicationDestinationRegions": ["us-east-1"|"us-west-2"|"eu-central-1"|"us-east-2"|"eu-west-1"|"ap-northeast-1"|"ap-southeast-2", ...],
      "replicationRoleArn": "string",
      "retentionSettings": [
        {
          "retentionPeriod": integer,
          "storageClass": "STANDARD_IA"|"ONEZONE_IA"|"INTELLIGENT_TIERING"|"GLACIER_IR"|"GLACIER"|"DEEP_ARCHIVE"|"EXPIRE"
        }
        ...
      ],
      "tagsMap": {"string": "string"
        ...}
    }
  ...}

--enable-all | --no-enable-all (boolean)

Enable Security Lake in all Regions to begin ingesting security data.

--meta-store-manager-role-arn (string)

The Role ARN used to create and update the Glue table with partitions generated by ingestion and normalization of Amazon Web Services log sources and custom sources.

--regions (list)

Enable Security Lake in the specified Regions to begin ingesting security data. 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 Region codes in the Amazon Web Services General Reference.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  us-east-1
  us-west-2
  eu-central-1
  us-east-2
  eu-west-1
  ap-northeast-1
  ap-southeast-2

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json

  • text

  • table

  • yaml

  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on

  • off

  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64

  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

None

© Copyright 2018, Amazon Web Services. Created using Sphinx.