Inspector2 / Client / create_connector

create_connector

Inspector2.Client.create_connector(**kwargs)

Creates a connector that links an external cloud provider to Amazon Inspector for vulnerability scanning.

See also: AWS API Documentation

Request Syntax

response = client.create_connector(
    clientToken='string',
    name='string',
    provider='AZURE',
    description='string',
    providerDetail={
        'azure': {
            'awsConfigConnectorArn': 'string',
            'scopeConfiguration': {
                'vmScanning': {
                    'scopeType': 'TENANT'|'SUBSCRIPTION',
                    'scopeValues': [
                        'string',
                    ]
                },
                'containerImageScanning': {
                    'scopeType': 'TENANT'|'SUBSCRIPTION',
                    'scopeValues': [
                        'string',
                    ]
                },
                'serverlessScanning': {
                    'scopeType': 'TENANT'|'SUBSCRIPTION',
                    'scopeValues': [
                        'string',
                    ]
                }
            },
            'azureRegions': [
                'string',
            ],
            'autoInstallVMScanner': True|False
        }
    },
    tags={
        'string': 'string'
    }
)
Parameters:

  • clientToken (string) –

    A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.

    This field is autopopulated if not provided.

  • name (string) –

    [REQUIRED]

    The name of the connector.

  • provider (string) –

    [REQUIRED]

    The cloud provider for the connector.

  • description (string) – A description of the connector.

  • providerDetail (dict) –

    [REQUIRED]

    The provider-specific configuration details for the connector.

    Note

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

    • azure (dict) –

      The Azure-specific details for creating a connector.

      • awsConfigConnectorArn (string) – [REQUIRED]

        The ARN of the Amazon Web Services Config connector to associate with this connector.

      • scopeConfiguration (dict) – [REQUIRED]

        The scope configuration that defines which Azure resources to scan.

        • vmScanning (dict) –

          The scope configuration input for VM scanning.

          • scopeType (string) – [REQUIRED]

            The type of scope. Valid values are TENANT, which scans all resources in the Azure tenant, and SUBSCRIPTION, which scans only the resources in the specified Azure subscriptions.

          • scopeValues (list) –

            The list of scope values. For subscription-level scope, these are Azure subscription IDs.

            • (string) –

        • containerImageScanning (dict) –

          The scope configuration input for container image scanning.

          • scopeType (string) – [REQUIRED]

            The type of scope. Valid values are TENANT, which scans all resources in the Azure tenant, and SUBSCRIPTION, which scans only the resources in the specified Azure subscriptions.

          • scopeValues (list) –

            The list of scope values. For subscription-level scope, these are Azure subscription IDs.

            • (string) –

        • serverlessScanning (dict) –

          The scope configuration input for serverless scanning.

          • scopeType (string) – [REQUIRED]

            The type of scope. Valid values are TENANT, which scans all resources in the Azure tenant, and SUBSCRIPTION, which scans only the resources in the specified Azure subscriptions.

          • scopeValues (list) –

            The list of scope values. For subscription-level scope, these are Azure subscription IDs.

            • (string) –

      • azureRegions (list) – [REQUIRED]

        The Azure regions to scan.

        • (string) –

      • autoInstallVMScanner (boolean) –

        Specifies whether to automatically install the VM scanner on connected Azure resources. Defaults to true.

  • tags (dict) –

    The tags to apply to the connector.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'connectorArn': 'string'
}

Response Structure

  • (dict) –

    • connectorArn (string) –

      The Amazon Resource Name (ARN) of the created connector.

Exceptions