SecurityHub / Client / create_connector_v2

create_connector_v2

SecurityHub.Client.create_connector_v2(**kwargs)

Grants permission to create a connectorV2 based on input parameters.

See also: AWS API Documentation

Request Syntax

response = client.create_connector_v2(
    Name='string',
    Description='string',
    Provider={
        'JiraCloud': {
            'ProjectKey': 'string'
        },
        'ServiceNow': {
            'InstanceName': 'string',
            'SecretArn': 'string'
        },
        'Azure': {
            'AWSConfigConnectorArn': 'string',
            'ScopeConfiguration': {
                'ScopeType': 'TENANT'|'SUBSCRIPTION',
                'ScopeValues': [
                    'string',
                ]
            },
            'AzureRegions': [
                'string',
            ]
        }
    },
    KmsKeyArn='string',
    Tags={
        'string': 'string'
    },
    ClientToken='string'
)

Parameters:

• Name (string) –

  [REQUIRED]

  The unique name of the connectorV2.

• Description (string) – The description of the connectorV2.

• Provider (dict) –

  [REQUIRED]

  The third-party provider’s service configuration.

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: JiraCloud, ServiceNow, Azure.

  • JiraCloud (dict) –

    The configuration settings required to establish an integration with Jira Cloud.

    • ProjectKey (string) –

      The project key for a JiraCloud instance.

  • ServiceNow (dict) –

    The configuration settings required to establish an integration with ServiceNow ITSM.

    • InstanceName (string) – [REQUIRED]

      The instance name of ServiceNow ITSM.

    • SecretArn (string) – [REQUIRED]

      The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the ServiceNow credentials.

  • Azure (dict) –

    The configuration settings required to establish a CSPM integration with Microsoft Azure.

    • AWSConfigConnectorArn (string) – [REQUIRED]

      The ARN of the AWS Config connector used to establish the connection to Azure.

    • ScopeConfiguration (dict) – [REQUIRED]

      The scope configuration that defines which Azure resources are monitored.

      • ScopeType (string) – [REQUIRED]

        The type of scope. Valid values are tenant and subscription.

      • ScopeValues (list) –

        The list of scope values, such as subscription IDs, when the scope type is subscription.

        • (string) –

    • AzureRegions (list) – [REQUIRED]

      The list of Azure regions to monitor.

      • (string) –

• KmsKeyArn (string) – The Amazon Resource Name (ARN) of KMS key used to encrypt secrets for the connectorV2.

• Tags (dict) –

  The tags to add to the connectorV2 when you create.

  • (string) –

    • (string) –

• ClientToken (string) –

  A unique identifier used to ensure idempotency.

  This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'ConnectorArn': 'string',
    'ConnectorId': 'string',
    'AuthUrl': 'string',
    'ConnectorStatus': 'CONNECTED'|'DEGRADED'|'FAILED_TO_CONNECT'|'PENDING_AUTHORIZATION'|'PENDING_CONFIGURATION'|'UNKNOWN',
    'EnablementStatus': 'ENABLED'|'PENDING_ENABLEMENT'|'FAILED_TO_ENABLE'|'PENDING_UPDATE'|'FAILED_TO_UPDATE'|'PENDING_DELETION'|'FAILED_TO_DELETE'
}

Response Structure

• (dict) –

  • ConnectorArn (string) –

    The Amazon Resource Name (ARN) of the connectorV2.

  • ConnectorId (string) –

    The UUID of the connectorV2 to identify connectorV2 resource.

  • AuthUrl (string) –

    The Url provide to customers for OAuth auth code flow.

  • ConnectorStatus (string) –

    The current status of the connectorV2.

  • EnablementStatus (string) –

    The enablement status of the connector after creation.

Exceptions

• SecurityHub.Client.exceptions.AccessDeniedException

• SecurityHub.Client.exceptions.InternalServerException

• SecurityHub.Client.exceptions.ValidationException

• SecurityHub.Client.exceptions.ThrottlingException

• SecurityHub.Client.exceptions.ConflictException

• SecurityHub.Client.exceptions.ResourceNotFoundException

• SecurityHub.Client.exceptions.ServiceQuotaExceededException