AWS CLI Command Reference

[ aws . securitylake ]

create-subscriber

Description

Creates a subscription permission for accounts that are already enabled in Security Lake.

See also: AWS API Documentation

Synopsis

  create-subscriber
[--access-types <value>]
--account-id <value>
--external-id <value>
--source-types <value>
[--subscriber-description <value>]
--subscriber-name <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

--access-types (list)

The Amazon S3 or Lake Formation access type.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  LAKEFORMATION
  S3

--account-id (string)

The third party Amazon Web Services account ID used to access your data.

--external-id (string)

The external ID of the subscriber. External ID allows the user that is assuming the role to assert the circumstances in which they are operating. It also provides a way for the account owner to permit the role to be assumed only under specific circumstances.

--source-types (list)

The supported Amazon Web Services services from which logs and events are collected. Amazon Security Lake supports logs and events collection for natively-supported Amazon Web Services services.

(tagged union structure)

The supported source types from which logs and events are collected in Amazon Security Lake.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: awsSourceType, customSourceType.

awsSourceType -> (string)

Amazon Security Lake supports logs and events collection for natively-supported Amazon Web Services services. For more information, see the Amazon Security Lake User Guide.

customSourceType -> (string)

Amazon Security Lake supports custom source types. For the detailed list, see the Amazon Security Lake User Guide.

Shorthand Syntax:

awsSourceType=string,customSourceType=string ...

JSON Syntax:

[
  {
    "awsSourceType": "ROUTE53"|"VPC_FLOW"|"CLOUD_TRAIL"|"SH_FINDINGS",
    "customSourceType": "string"
  }
  ...
]

--subscriber-description (string)

The subscriber descriptions for the subscriber account in Amazon Security Lake.

--subscriber-name (string)

The name of your Amazon Security Lake subscriber account.

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

roleArn -> (string)

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

s3BucketArn -> (string)

The Amazon Resource Name (ARN) for the Amazon S3 bucket.

snsArn -> (string)

The Amazon Resource Name (ARN) for the Amazon Simple Notification Service.

subscriptionId -> (string)

The subscriptionId that was created by the CreateSubscriber API call.

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