CloudWatchObservabilityAdminService / Client / create_connector

create_connector

CloudWatchObservabilityAdminService.Client.create_connector(**kwargs)

Creates a connector to a third-party cloud provider. With a connector, you can discover resources in the provider and collect their telemetry. Currently, Microsoft Azure is the only supported provider.

See also: AWS API Documentation

Request Syntax

response = client.create_connector(
    ConnectorConfiguration={
        'Azure': {
            'TenantIdentifier': 'string',
            'ClientIdentifier': 'string'
        }
    },
    RoleArn='string',
    Name='string',
    Tags={
        'string': 'string'
    },
    ClientToken='string'
)
Parameters:
  • ConnectorConfiguration (dict) –

    [REQUIRED]

    The configuration for connecting to the third-party cloud provider.

    Note

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

    • Azure (dict) –

      The configuration of a connector to Microsoft Azure.

      • TenantIdentifier (string) – [REQUIRED]

        The ID of the Microsoft Entra ID tenant.

      • ClientIdentifier (string) – [REQUIRED]

        The application (client) ID of the Azure app registration. The app registration must have a federated identity credential that trusts the Amazon Web Services OpenID Connect (OIDC) issuer for your account.

  • RoleArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that CloudWatch assumes to get credentials for the third-party cloud provider. The role must trust the Amazon CloudWatch Observability Admin service principal, observabilityadmin.amazonaws.com. The role must also allow sts:GetWebIdentityToken for the provider’s token exchange audience.

  • Name (string) –

    [REQUIRED]

    The name of the connector. The name must be unique in the account and Region (case-sensitive). If another connector already uses the name, the request fails with a ConflictException.

    The name can contain letters, digits, hyphens (-), underscores (_) and periods (.), and must start with a letter.

  • Tags (dict) –

    The tags that you want to apply to the connector.

    • (string) –

      • (string) –

  • ClientToken (string) – A unique, case-sensitive identifier that you provide to ensure the operation completes no more than one time. If you use an Amazon Web Services SDK, the SDK generates this value and reuses it on retries. If this token matches a previous request with the same parameters, the service returns the connector from the first request without an error. If you use the same token with different parameters, including different tags, the service returns a ValidationException. This operation is idempotent when you use the same token and parameters.

Return type:

dict

Returns:

Response Syntax

{
    'Connector': {
        'Arn': 'string',
        'Provider': 'AZURE',
        'ConnectorConfiguration': {
            'Azure': {
                'TenantIdentifier': 'string',
                'ClientIdentifier': 'string'
            }
        },
        'RoleArn': 'string',
        'Name': 'string',
        'CreatedTimeStamp': 123
    }
}

Response Structure

  • (dict) –

    • Connector (dict) –

      The connector that this request created.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the connector.

      • Provider (string) –

        The cloud provider that the connector connects to.

      • ConnectorConfiguration (dict) –

        The configuration for connecting to the third-party cloud provider.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: Azure. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        • Azure (dict) –

          The configuration of a connector to Microsoft Azure.

          • TenantIdentifier (string) –

            The ID of the Microsoft Entra ID tenant.

          • ClientIdentifier (string) –

            The application (client) ID of the Azure app registration. The app registration must have a federated identity credential that trusts the Amazon Web Services OpenID Connect (OIDC) issuer for your account.

      • RoleArn (string) –

        The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that CloudWatch assumes to obtain credentials for the third-party cloud provider.

      • Name (string) –

        The name of the connector.

      • CreatedTimeStamp (integer) –

        The time when the connector was created, in milliseconds since the Unix epoch.

Exceptions