connectors

Creates, updates, deletes, gets or lists a connectors resource.

Overview

Name	connectors
Type	Resource
Id	aws.inspector2.connectors

Fields

The following fields are returned by SELECT queries:

list_connectors

Name	Datatype	Description
name	string	The name of the connector. (pattern: <code>[\p{L}\p{N}_-]+</code>)
auto_install_vm_scanner	boolean	Specifies whether the VM scanner is automatically installed on connected resources.
aws_config_connector_arn	string	The ARN of the Amazon Web Services Config connector associated with this connector. (pattern: <code>arn:([^:]+):config:([^:]+):([^:]+):connector/([^/]+)/([^/]+)/([^/:\s]+)</code>)
azure_regions	array	The Azure regions configured for the connector.
connector_arn	string	The Amazon Resource Name (ARN) of the connector. (pattern: <code>arn:aws(-[a-z]+)*:inspector2:[a-z0-9-]+:[0-9]{12}:connector/([a-f0-9-]+|aws-service-connector/.+/[a-f0-9-]+)</code>)
created_at	string (date-time)	The date and time when the connector was created.
description	string	A description of the connector. (pattern: <code>[^\p{C}]*</code>)
enablement_status	string	The enablement status of the connector, which indicates whether the connector is active and scanning resources. (ENABLED, PENDING_ENABLEMENT, FAILED_TO_ENABLE, PENDING_UPDATE, FAILED_TO_UPDATE, PENDING_DELETION, DELETED, FAILED_TO_DELETE)
enablement_status_reason	string	Additional information about the current enablement status of the connector.
health	object	The health of the connector, which indicates whether Amazon Inspector can reach and scan the connected resources.
provider	string	The cloud provider for the connector. (AZURE)
scope_configuration	object	The Azure scope configuration for the connector.
tags	object	The tags associated with the connector.
updated_at	string (date-time)	The date and time when the connector was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_connectors	select	region		Lists connectors in your account. Results are paginated. Use the nextToken parameter to retrieve the next page of results.
create_connector	insert	region, name, provider, providerDetail		Creates a connector that links an external cloud provider to Amazon Inspector for vulnerability scanning.
update_connector	update	region, connectorArn		Updates the description or provider-specific configuration details of an existing connector.
delete_connector	delete	region		Deletes a connector from your account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_connectors

Lists connectors in your account. Results are paginated. Use the nextToken parameter to retrieve the next page of results.

SELECT
name,
auto_install_vm_scanner,
aws_config_connector_arn,
azure_regions,
connector_arn,
created_at,
description,
enablement_status,
enablement_status_reason,
health,
provider,
scope_configuration,
tags,
updated_at
FROM aws.inspector2.connectors
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_connector

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

INSERT INTO aws.inspector2.connectors (
clientToken,
name,
provider,
description,
providerDetail,
tags,
region
)
SELECT 
'{{ clientToken }}',
'{{ name }}' /* required */,
'{{ provider }}' /* required */,
'{{ description }}',
'{{ providerDetail }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
connector_arn
;

Manifest

# Description fields are for documentation purposes
- name: connectors
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the connectors resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: name
    value: "{{ name }}"
  - name: provider
    value: "{{ provider }}"
    valid_values: ['AZURE']
  - name: description
    value: "{{ description }}"
  - name: providerDetail
    description: |
      The provider-specific configuration details for creating a connector.
    value:
      azure:
        awsConfigConnectorArn: "{{ awsConfigConnectorArn }}"
        scopeConfiguration:
          vmScanning:
            scopeType: "{{ scopeType }}"
            scopeValues:
              - "{{ scopeValues }}"
          containerImageScanning:
            scopeType: "{{ scopeType }}"
            scopeValues:
              - "{{ scopeValues }}"
          serverlessScanning:
            scopeType: "{{ scopeType }}"
            scopeValues:
              - "{{ scopeValues }}"
        azureRegions:
          - "{{ azureRegions }}"
        autoInstallVMScanner: {{ autoInstallVMScanner }}
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_connector

Updates the description or provider-specific configuration details of an existing connector.

UPDATE aws.inspector2.connectors
SET 
connectorArn = '{{ connectorArn }}',
description = '{{ description }}',
providerDetail = '{{ providerDetail }}'
WHERE 
region = '{{ region }}' --required
AND connectorArn = '{{ connectorArn }}' --required
RETURNING
connector_arn;

DELETE examples

delete_connector

Deletes a connector from your account.

DELETE FROM aws.inspector2.connectors
WHERE region = '{{ region }}' --required
;