AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . securitylake ]

create-data-lake

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. 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 and after you create subscribers using the CreateSubscriber API. 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 .

See also: AWS API Documentation

Synopsis

  create-data-lake
--configurations <value>
--meta-store-manager-role-arn <value>
[--tags <value>]
[--cli-input-json <value>]
[--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>]

Options

--configurations (list)

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

(structure)

Provides details of Amazon Security Lake object.

encryptionConfiguration -> (structure)

Provides encryption details of Amazon Security Lake object.

kmsKeyId -> (string)

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

lifecycleConfiguration -> (structure)

Provides lifecycle details of Amazon Security Lake object.

expiration -> (structure)

Provides data expiration details of Amazon Security Lake object.

days -> (integer)

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

transitions -> (list)

Provides data storage transition details of Amazon Security Lake object.

(structure)

Provide transition lifecycle details of Amazon Security Lake object.

days -> (integer)

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

storageClass -> (string)

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

region -> (string)

The Amazon Web Services Regions where Security Lake is automatically enabled.

replicationConfiguration -> (structure)

Provides replication details of Amazon Security Lake object.

regions -> (list)

Specifies one or more centralized rollup Regions. The Amazon Web Services Region specified in the region parameter of the ` CreateDataLake https://docs.aws.amazon.com/security-lake/latest/APIReference/API_CreateDataLake.html`__ or ` UpdateDataLake https://docs.aws.amazon.com/security-lake/latest/APIReference/API_UpdateDataLake.html`__ 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 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 Regions or within the same Region as the source bucket.

(string)

roleArn -> (string)

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

JSON Syntax:

[
  {
    "encryptionConfiguration": {
      "kmsKeyId": "string"
    },
    "lifecycleConfiguration": {
      "expiration": {
        "days": integer
      },
      "transitions": [
        {
          "days": integer,
          "storageClass": "string"
        }
        ...
      ]
    },
    "region": "string",
    "replicationConfiguration": {
      "regions": ["string", ...],
      "roleArn": "string"
    }
  }
  ...
]

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

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.

--tags (list)

An array of objects, one for each tag to associate with the data lake configuration. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.

(structure)

A tag is a label that you can define and associate with Amazon Web Services resources, including certain types of Amazon Security Lake resources. Tags can help you identify, categorize, and manage resources in different ways, such as by owner, environment, or other criteria. You can associate tags with the following types of Security Lake resources: subscribers, and the data lake configuration for your Amazon Web Services account in individual Amazon Web Services Regions.

A resource can have up to 50 tags. Each tag consists of a required tag key and an associated tag value . A tag key is a general label that acts as a category for a more specific tag value. Each tag key must be unique and it can have only one tag value. A tag value acts as a descriptor for a tag key. Tag keys and values are case sensitive. They can contain letters, numbers, spaces, or the following symbols: _ . : / = + @ -

For more information, see Tagging Amazon Security Lake resources in the Amazon Security Lake User Guide .

key -> (string)

The name of the tag. This is a general label that acts as a category for a more specific tag value (value ).

value -> (string)

The value that’s associated with the specified tag key (key ). This value acts as a descriptor for the tag key. A tag value cannot be null, but it can be an empty string.

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--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.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

Example 1: To configure your data lake in multiple Regions

The following create-data-lake example enables Amazon Security Lake in multiple AWS Regions and configures your data lake.

aws securitylake create-data-lake \
    --configurations '[{"encryptionConfiguration": {"kmsKeyId":"S3_MANAGED_KEY"},"region":"us-east-1","lifecycleConfiguration": {"expiration":{"days":365},"transitions":[{"days":60,"storageClass":"ONEZONE_IA"}]}}, {"encryptionConfiguration": {"kmsKeyId":"S3_MANAGED_KEY"},"region":"us-east-2","lifecycleConfiguration": {"expiration":{"days":365},"transitions":[{"days":60,"storageClass":"ONEZONE_IA"}]}}]' \
    --meta-store-manager-role-arn "arn:aws:iam:us-east-1:123456789012:role/service-role/AmazonSecurityLakeMetaStoreManager"

Output:

{
    "dataLakes": [
        {
            "createStatus": "COMPLETED",
            "dataLakeArn": "arn:aws:securitylake:us-east-1:522481757177:data-lake/default",
            "encryptionConfiguration": {
                "kmsKeyId": "S3_MANAGED_KEY"
            },
            "lifecycleConfiguration": {
                "expiration": {
                    "days": 365
                },
                "transitions": [
                    {
                        "days": 60,
                        "storageClass": "ONEZONE_IA"
                    }
                ]
            },
            "region": "us-east-1",
            "replicationConfiguration": {
                "regions": [
                    "ap-northeast-3"
                ],
                "roleArn": "arn:aws:securitylake:ap-northeast-3:522481757177:data-lake/default"
            },
            "s3BucketArn": "arn:aws:s3:::aws-security-data-lake-us-east-1-gnevt6s8z7bzby8oi3uiaysbr8v2ml",
            "updateStatus": {
                "exception": {},
                "requestId": "f20a6450-d24a-4f87-a6be-1d4c075a59c2",
                "status": "INITIALIZED"
            }
        },
        {
            "createStatus": "COMPLETED",
            "dataLakeArn": "arn:aws:securitylake:us-east-2:522481757177:data-lake/default",
            "encryptionConfiguration": {
                "kmsKeyId": "S3_MANAGED_KEY"
            },
            "lifecycleConfiguration": {
                "expiration": {
                    "days": 365
                },
                "transitions": [
                    {
                        "days": 60,
                        "storageClass": "ONEZONE_IA"
                    }
                ]
            },
            "region": "us-east-2",
            "replicationConfiguration": {
                "regions": [
                    "ap-northeast-3"
                ],
                "roleArn": "arn:aws:securitylake:ap-northeast-3:522481757177:data-lake/default"
            },
            "s3BucketArn": "arn:aws:s3:::aws-security-data-lake-us-east-2-cehuifzl5rwmhm6m62h7zhvtseogr9",
            "updateStatus": {
                "exception": {},
                "requestId": "f20a6450-d24a-4f87-a6be-1d4c075a59c2",
                "status": "INITIALIZED"
            }
        }
    ]
}

For more information, see Getting started with Amazon Security Lake in the Amazon Security Lake User Guide.

Example 2: To configure your data lake in a single Region

The following create-data-lake example enables Amazon Security Lake in a single AWS Region and configures your data lake.

aws securitylake create-data-lake \
    --configurations '[{"encryptionConfiguration": {"kmsKeyId":"1234abcd-12ab-34cd-56ef-1234567890ab"},"region":"us-east-2","lifecycleConfiguration": {"expiration":{"days":500},"transitions":[{"days":30,"storageClass":"GLACIER"}]}}]' \
    --meta-store-manager-role-arn "arn:aws:iam:us-east-1:123456789012:role/service-role/AmazonSecurityLakeMetaStoreManager"

Output:

{
    "dataLakes": [
        {
            "createStatus": "COMPLETED",
            "dataLakeArn": "arn:aws:securitylake:us-east-2:522481757177:data-lake/default",
            "encryptionConfiguration": {
                "kmsKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
            },
            "lifecycleConfiguration": {
                "expiration": {
                    "days": 500
                },
                "transitions": [
                    {
                        "days": 30,
                        "storageClass": "GLACIER"
                    }
                ]
            },
            "region": "us-east-2",
            "replicationConfiguration": {
                "regions": [
                    "ap-northeast-3"
                ],
                "roleArn": "arn:aws:securitylake:ap-northeast-3:522481757177:data-lake/default"
            },
            "s3BucketArn": "arn:aws:s3:::aws-security-data-lake-us-east-2-cehuifzl5rwmhm6m62h7zhvtseogr9",
            "updateStatus": {
                "exception": {},
                "requestId": "77702a53-dcbf-493e-b8ef-518e362f3003",
                "status": "INITIALIZED"
            }
        }
    ]
}

For more information, see Getting started with Amazon Security Lake in the Amazon Security Lake User Guide.

Output

dataLakes -> (list)

The created Security Lake configuration object.

(structure)

Provides details of Amazon Security Lake object.

createStatus -> (string)

Retrieves the status of the CreateDatalake API call for an account in Amazon Security Lake.

dataLakeArn -> (string)

The Amazon Resource Name (ARN) created by you to provide to the subscriber. For more information about ARNs and how to use them in policies, see the Amazon Security Lake User Guide .

encryptionConfiguration -> (structure)

Provides encryption details of Amazon Security Lake object.

kmsKeyId -> (string)

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

lifecycleConfiguration -> (structure)

Provides lifecycle details of Amazon Security Lake object.

expiration -> (structure)

Provides data expiration details of Amazon Security Lake object.

days -> (integer)

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

transitions -> (list)

Provides data storage transition details of Amazon Security Lake object.

(structure)

Provide transition lifecycle details of Amazon Security Lake object.

days -> (integer)

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

storageClass -> (string)

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

region -> (string)

The Amazon Web Services Regions where Security Lake is enabled.

replicationConfiguration -> (structure)

Provides replication details of Amazon Security Lake object.

regions -> (list)

Specifies one or more centralized rollup Regions. The Amazon Web Services Region specified in the region parameter of the ` CreateDataLake https://docs.aws.amazon.com/security-lake/latest/APIReference/API_CreateDataLake.html`__ or ` UpdateDataLake https://docs.aws.amazon.com/security-lake/latest/APIReference/API_UpdateDataLake.html`__ 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 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 Regions or within the same Region as the source bucket.

(string)

roleArn -> (string)

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

s3BucketArn -> (string)

The ARN for the Amazon Security Lake Amazon S3 bucket.

updateStatus -> (structure)

The status of the last UpdateDataLake or DeleteDataLake API request.

exception -> (structure)

The details of the last UpdateDataLake or DeleteDataLake API request which failed.

code -> (string)

The reason code for the exception of the last UpdateDataLake or DeleteDataLake API request.

reason -> (string)

The reason for the exception of the last UpdateDataLake or DeleteDataLake API request.

requestId -> (string)

The unique ID for the last UpdateDataLake or DeleteDataLake API request.

status -> (string)

The status of the last UpdateDataLake or DeleteDataLake API request that was requested.