Databricks SDK for JavaScript
    Preparing search index...

    Interface ModelProviderServiceConfig_AmazonBedrockProviderDirectConfig

    Direct form of Amazon Bedrock provider config.

    Authentication is one of two mutually exclusive modes, exactly one of which must be supplied on Create:

    • Access keys: set aws_access_key, leave service_credential unset.
    • UC service credential: set service_credential.name to the AIP-122 resource-name form credentials/{name}, leave aws_access_key unset. The credential value lives in UC and is referenced by name, not held on this message. Setting more than one mode is rejected.
    interface ModelProviderServiceConfig_AmazonBedrockProviderDirectConfig {
        authMode?:
            | {
                $case: "serviceCredential";
                serviceCredential: ModelProviderServiceConfig_ServiceCredential;
            }
            | {
                $case: "awsAccessKey";
                awsAccessKey: ModelProviderServiceConfig_AwsAccessKey;
            };
        awsAccessKeyId?: string;
        awsSecretAccessKey?: ModelProviderServiceConfig_ProviderSecret;
        region?: string;
    }
    Index

    Properties

    authMode? awsAccessKeyId? awsSecretAccessKey? region?

    Properties

    authMode?:
        | {
            $case: "serviceCredential";
            serviceCredential: ModelProviderServiceConfig_ServiceCredential;
        }
        | {
            $case: "awsAccessKey";
            awsAccessKey: ModelProviderServiceConfig_AwsAccessKey;
        }

    Authentication mode. Exactly one variant may be set. (-- aws_access_key is the canonical home for the access-key pair. The top-level aws_access_key_id / aws_secret_access_key fields are the pre-AIGOV-188 flat form, kept for one migration cycle: on read the handler populates BOTH the flat fields and this arm so old and new clients both work, and on write it accepts either shape. The flat fields are removed once all readers/writers have migrated to the oneof. --)

    Type Declaration

    • {
          $case: "serviceCredential";
          serviceCredential: ModelProviderServiceConfig_ServiceCredential;
      }
      • $case: "serviceCredential"
      • serviceCredential: ModelProviderServiceConfig_ServiceCredential

        Reference to a UC service credential authorizing Bedrock requests. On Create the caller supplies service_credential.name in the AIP-122 resource-name form credentials/{name}. Required on Create when using UC-service-credential auth; mutually exclusive with aws_access_key. The credential is referenced by name; its value is not carried here. On read the resolved id and is_deleted are also populated. Only supported on AWS-hosted workspaces; Create requests from other clouds are rejected with INVALID_PARAMETER_VALUE.

    • { $case: "awsAccessKey"; awsAccessKey: ModelProviderServiceConfig_AwsAccessKey }
      • $case: "awsAccessKey"
      • awsAccessKey: ModelProviderServiceConfig_AwsAccessKey

        AWS access-key-pair auth. Mutually exclusive with service_credential. Supersedes the flat aws_access_key_id / aws_secret_access_key fields.

    awsAccessKeyId?: string

    Deprecated flat AWS access key ID. Superseded by aws_access_key.access_key_id. Kept for one migration cycle; the handler mirrors it to/from aws_access_key. Treated as username-equivalent (not a secret value): round-trips on reads and is scrubbed from audit logs.

    awsSecretAccessKey?: ModelProviderServiceConfig_ProviderSecret

    Deprecated flat AWS secret access key. Superseded by aws_access_key.secret_access_key. Kept for one migration cycle; the handler mirrors it to/from aws_access_key. Supplied as inline plaintext via ProviderSecret.plaintext.

    region?: string

    AWS region where the Bedrock endpoint is hosted (e.g., us-east-1). Required on Create.

    Settings

    Member Visibility

    On This Page

    Properties