connector_v2s

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

Overview

Name	connector_v2s
Type	Resource
Id	aws.securityhub.connector_v2s

Fields

The following fields are returned by SELECT queries:

get_connector_v2

Name	Datatype	Description
connector_arn	string	The Amazon Resource Name (ARN) of the connectorV2. (pattern: <code>.\S.</code>)
connector_id	string	The UUID of the connectorV2 to identify connectorV2 resource. (pattern: <code>.\S.</code>)
created_at	string (date-time)	ISO 8601 UTC timestamp for the time create the connectorV2.
description	string	The description of the connectorV2. (pattern: <code>.\S.</code>)
enablement_status	string	The enablement status of the connector. (ENABLED, PENDING_ENABLEMENT, FAILED_TO_ENABLE, PENDING_UPDATE, FAILED_TO_UPDATE, PENDING_DELETION, FAILED_TO_DELETE)
enablement_status_reason	string	The reason for the current enablement status. Provides additional context when the connector is in a failed state. (pattern: <code>.\S.</code>)
health	object	The current health status for connectorV2
kms_key_arn	string	The Amazon Resource Name (ARN) of KMS key used for the connectorV2. (pattern: <code>.\S.</code>)
last_updated_at	string (date-time)	ISO 8601 UTC timestamp for the time update the connectorV2 connectorStatus.
name	string	The name of the connectorV2. (pattern: <code>.\S.</code>)
provider_detail	object	The third-party provider detail for a service configuration.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_connector_v2	select	connector_id, region		Grants permission to retrieve details for a connectorV2 based on connector id.
register_connector_v2	insert	region, AuthCode, AuthState		Grants permission to complete the authorization based on input parameters.
create_connector_v2	insert	region, Provider		Grants permission to create a connectorV2 based on input parameters.
update_connector_v2	update	connector_id, region		Grants permission to update a connectorV2 based on its id and input parameters.
delete_connector_v2	delete	connector_id, region		Grants permission to delete a connectorV2.

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
connector_id	string	The UUID of the connectorV2 to identify connectorV2 resource.
region	string	AWS region (default: us-east-1)

SELECT examples

get_connector_v2

Grants permission to retrieve details for a connectorV2 based on connector id.

SELECT
connector_arn,
connector_id,
created_at,
description,
enablement_status,
enablement_status_reason,
health,
kms_key_arn,
last_updated_at,
name,
provider_detail
FROM aws.securityhub.connector_v2s
WHERE connector_id = '{{ connector_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

register_connector_v2

Grants permission to complete the authorization based on input parameters.

INSERT INTO aws.securityhub.connector_v2s (
AuthCode,
AuthState,
region
)
SELECT 
'{{ AuthCode }}' /* required */,
'{{ AuthState }}' /* required */,
'{{ region }}'
RETURNING
connector_arn,
connector_id
;

create_connector_v2

Grants permission to create a connectorV2 based on input parameters.

INSERT INTO aws.securityhub.connector_v2s (
Name,
Description,
Provider,
KmsKeyArn,
Tags,
ClientToken,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ Provider }}' /* required */,
'{{ KmsKeyArn }}',
'{{ Tags }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
auth_url,
connector_arn,
connector_id,
connector_status,
enablement_status
;

Manifest

# Description fields are for documentation purposes
- name: connector_v2s
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the connector_v2s resource.
  - name: AuthCode
    value: "{{ AuthCode }}"
  - name: AuthState
    value: "{{ AuthState }}"
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
  - name: Provider
    description: |
      The initial configuration settings required to establish an integration between Security Hub and third-party provider.
    value:
      JiraCloud:
        ProjectKey: "{{ ProjectKey }}"
      ServiceNow:
        InstanceName: "{{ InstanceName }}"
        SecretArn: "{{ SecretArn }}"
      Azure:
        AWSConfigConnectorArn: "{{ AWSConfigConnectorArn }}"
        ScopeConfiguration:
          ScopeType: "{{ ScopeType }}"
          ScopeValues:
            - "{{ ScopeValues }}"
        AzureRegions:
          - "{{ AzureRegions }}"
  - name: KmsKeyArn
    value: "{{ KmsKeyArn }}"
  - name: Tags
    value: "{{ Tags }}"
  - name: ClientToken
    value: "{{ ClientToken }}"

UPDATE examples

update_connector_v2

Grants permission to update a connectorV2 based on its id and input parameters.

UPDATE aws.securityhub.connector_v2s
SET 
Description = '{{ Description }}',
Provider = '{{ Provider }}'
WHERE 
connector_id = '{{ connector_id }}' --required
AND region = '{{ region }}' --required
RETURNING
connector_status,
enablement_status;

DELETE examples

delete_connector_v2

Grants permission to delete a connectorV2.

DELETE FROM aws.securityhub.connector_v2s
WHERE connector_id = '{{ connector_id }}' --required
AND region = '{{ region }}' --required
;