Skip to content

create_connector async

create_connector(
    *,
    config_overrides: Optional[AsyncSecurityHubClientConfig] = None,
    name: Optional[NonEmptyString] = None,
    description: Optional[NonEmptyString] = None,
    provider: Optional[CspmProviderConfiguration] = None,
    tags: Optional[TagMap] = None,
    client_token: Optional[ClientToken] = None,
) -> CreateConnectorResponse

Creates a connector to a third-party cloud provider 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.

Parameters:

  • name (Optional[NonEmptyString], default: None ) –

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

  • description (Optional[NonEmptyString], default: None ) –

    The description of the connector.

  • provider (Optional[CspmProviderConfiguration], default: None ) –

    The configuration for the cloud provider to connect to. Currently supports Azure.

  • tags (Optional[TagMap], default: None ) –

    The tags to add to the connector resource.

  • client_token (Optional[ClientToken], default: None ) –

    A unique identifier used to ensure idempotency of the request.

Raises:

Examples:

To create a CSPM connector This operation creates a CSPM connector to connect Security Hub to an Azure environment.

>>> await client.create_connector(name='MyAzureConnector', description='Connector for Azure tenant monitoring', provider={'Azure': {'AWSConfigConnectorArn': 'arn:aws:config:us-east-1:123456789012:connector/azure-connector-1234', 'ScopeConfiguration': {'ScopeType': 'TENANT'}, 'AzureRegions': ['eastus', 'westus2']}})
Source code in docs_src/capo_securityhub/_services/async_security_hub.py
async def create_connector(
    self,
    *,
    config_overrides: Optional[AsyncSecurityHubClientConfig] = None,
    name: Optional["capo_securityhub.types.non_empty_string.NonEmptyString"] = None,
    description: Optional[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ] = None,
    provider: Optional[
        "capo_securityhub.types.cspm_provider_configuration.CspmProviderConfiguration"
    ] = None,
    tags: Optional["capo_securityhub.types.tag_map.TagMap"] = None,
    client_token: Optional[
        "capo_securityhub.types.client_token.ClientToken"
    ] = None,
) -> "capo_securityhub.types.create_connector_response.CreateConnectorResponse":
    """<p>Creates a connector to a third-party cloud provider 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.</p>

    Args:
        name: <p>The name of the connector. Must be unique within the account.</p>
        description: <p>The description of the connector.</p>
        provider: <p>The configuration for the cloud provider to connect to. Currently supports Azure.</p>
        tags: <p>The tags to add to the connector resource.</p>
        client_token: <p>A unique identifier used to ensure idempotency of the request.</p>

    Raises:
        capo_securityhub.errors.access_denied_exception.AccessDeniedException: <p>You don't have permission to perform the action specified in the request.</p>
        capo_securityhub.errors.conflict_exception.ConflictException: <p>The request causes conflict with the current state of the service resource.</p>
        capo_securityhub.errors.internal_server_exception.InternalServerException: <p> The request has failed due to an internal failure of the service. </p>
        capo_securityhub.errors.invalid_access_exception.InvalidAccessException: <p>The account doesn't have permission to perform this action.</p>
        capo_securityhub.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request was rejected because we can't find the specified resource.</p>
        capo_securityhub.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request was rejected because it would exceed the service quota limit.</p>
        capo_securityhub.errors.throttling_exception.ThrottlingException: <p> The limit on the number of requests per second was exceeded. </p>
        capo_securityhub.errors.validation_exception.ValidationException: <p>The request has failed validation because it's missing required fields or has invalid inputs.</p>
        capo_securityhub.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To create a CSPM connector
        This operation creates a CSPM connector to connect Security Hub to an Azure environment.

        >>> await client.create_connector(name='MyAzureConnector', description='Connector for Azure tenant monitoring', provider={'Azure': {'AWSConfigConnectorArn': 'arn:aws:config:us-east-1:123456789012:connector/azure-connector-1234', 'ScopeConfiguration': {'ScopeType': 'TENANT'}, 'AzureRegions': ['eastus', 'westus2']}})
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_securityhub.types.create_connector_request.CreateConnectorRequest]",
    ) -> AsyncOperationResponse[
        "capo_securityhub.types.create_connector_response.CreateConnectorResponse"
    ]:
        import capo_securityhub._operations.security_hub_api_service.create_connector

        (
            output,
            http_response,
        ) = await capo_securityhub._operations.security_hub_api_service.create_connector.async_create_connector(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateConnector")
    )
    input_: capo_securityhub.types.create_connector_request.CreateConnectorRequest = {}
    if name is not None:
        input_["name"] = name
    if description is not None:
        input_["description"] = description
    if provider is not None:
        input_["provider"] = provider
    if tags is not None:
        input_["tags"] = tags
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output