SecurityHub / Client / create_connector

create_connector

SecurityHub.Client.create_connector(**kwargs)

Creates a cloud service provider management (CSPM) connector 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

Request Syntax

response = client.create_connector(
    Name='string',
    Description='string',
    Provider={
        'Azure': {
            'AWSConfigConnectorArn': 'string',
            'ScopeConfiguration': {
                'ScopeType': 'TENANT'|'SUBSCRIPTION',
                'ScopeValues': [
                    'string',
                ]
            },
            'AzureRegions': [
                'string',
            ]
        }
    },
    Tags={
        'string': 'string'
    },
    ClientToken='string'
)
Parameters:

  • Name (string) –

    [REQUIRED]

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

  • Description (string) – The description of the connector.

  • Provider (dict) –

    [REQUIRED]

    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 (dict) –

      The Azure provider configuration.

      • AWSConfigConnectorArn (string) – [REQUIRED]

        The ARN of the AWS Config connector used to establish the connection to Azure.

      • ScopeConfiguration (dict) – [REQUIRED]

        The scope configuration that defines which Azure resources are monitored.

        • ScopeType (string) – [REQUIRED]

          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) – [REQUIRED]

        The list of Azure regions to monitor.

        • (string) –

  • Tags (dict) –

    The tags to add to the connector resource.

    • (string) –

      • (string) –

  • ClientToken (string) –

    A unique identifier used to ensure idempotency of the request.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'ConnectorArn': 'string',
    'ConnectorId': 'string',
    'ConnectorStatus': 'CONNECTED'|'DEGRADED'|'FAILED_TO_CONNECT'|'UNKNOWN',
    'EnablementStatus': 'ENABLED'|'PENDING_ENABLEMENT'|'PENDING_UPDATE'|'PENDING_DELETION'
}

Response Structure

  • (dict) –

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

Exceptions