Skip to content

Retrieves details for a CSPM connector based on the connector ID

Description

Retrieves details for a CSPM connector based on the connector ID.

Usage

securityhub_get_connector(ConnectorId)

Arguments

  • ConnectorId

    [required] The unique identifier of the connector to retrieve.

Value

A list with the following syntax:

list(
  ConnectorArn = "string",
  ConnectorId = "string",
  Name = "string",
  Description = "string",
  CreatedAt = as.POSIXct(
    "2015-01-01"
  ),
  LastUpdatedAt = as.POSIXct(
    "2015-01-01"
  ),
  Health = list(
    ConnectorStatus = "CONNECTED"|"DEGRADED"|"FAILED_TO_CONNECT"|"UNKNOWN",
    Message = "string",
    LastCheckedAt = as.POSIXct(
      "2015-01-01"
    ),
    Issues = list(
      list(
        Code = "AUTHENTICATION_FAILURE"|"STREAM_AUTHORIZATION_FAILURE"|"DISCOVERY_FAILURE"|"STREAM_LIMIT_EXCEEDED"|"STREAM_DISCONNECTED"|"RECORDING_FAILURE"|"NO_HEALTH_DATA",
        Message = "string"
      )
    )
  ),
  ProviderDetail = list(
    Azure = list(
      AWSConfigConnectorArn = "string",
      ScopeConfiguration = list(
        ScopeType = "TENANT"|"SUBSCRIPTION",
        ScopeValues = list(
          "string"
        )
      ),
      AzureRegions = list(
        "string"
      )
    )
  ),
  CreatedBy = "string",
  EnablementStatus = "ENABLED"|"PENDING_ENABLEMENT"|"PENDING_UPDATE"|"PENDING_DELETION"
)

Request syntax

svc$get_connector(
  ConnectorId = "string"
)