AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . securityhub ]

create-connector

Description

Creates a connector to a third-party cloud provider in Security Hub CSPM. A connector establishes a connection between Security Hub CSPM and a third-party cloud provider, enabling Security Hub CSPM to ingest security findings and resource data from the connected environment.

See also: AWS API Documentation

Synopsis

  create-connector
--name <value>
[--description <value>]
--provider <value>
[--tags <value>]
[--client-token <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>]
[--v2-debug]

Options

--name (string)

The name of the connector. Must be unique within the account.

--description (string)

The description of the connector.

--provider (tagged union structure)

The configuration for the cloud provider to connect to. Currently supports Azure.

Note

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

Azure -> (structure)

The Azure provider configuration.

AWSConfigConnectorArn -> (string)

The ARN of the multi-cloud configuration connector used to establish the connection to Azure.

ScopeConfiguration -> (structure)

The scope configuration that defines which Azure resources are monitored.

ScopeType -> (string)

The type of scope. Valid values are tenant and subscription .

ScopeValues -> (list)

The list of scope values, such as subscription IDs, when the scope type is subscription .

(string)

AzureRegions -> (list)

The list of Azure regions to monitor.

(string)

JSON Syntax:

{
  "Azure": {
    "AWSConfigConnectorArn": "string",
    "ScopeConfiguration": {
      "ScopeType": "TENANT"|"SUBSCRIPTION",
      "ScopeValues": ["string", ...]
    },
    "AzureRegions": ["string", ...]
  }
}

--tags (map)

The tags to add to the connector resource.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--client-token (string)

A unique identifier used to ensure idempotency of the request.

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

ConnectorArn -> (string)

The Amazon Resource Name (ARN) of the connector.

ConnectorId -> (string)

The unique identifier of the connector.

ConnectorStatus -> (string)

The connectivity status of the connector.

EnablementStatus -> (string)

The enablement status of the connector.