Databricks SDK for JavaScript
    Preparing search index...

    Interface AmazonBedrockConfig

    interface AmazonBedrockConfig {
        awsAccessKeyId?: string;
        awsAccessKeyIdPlaintext?: string;
        awsRegion?: string;
        awsSecretAccessKey?: string;
        awsSecretAccessKeyPlaintext?: string;
        bedrockProvider?: string;
        instanceProfileArn?: string;
    }
    Index

    Properties

    awsAccessKeyId? awsAccessKeyIdPlaintext? awsRegion? awsSecretAccessKey? awsSecretAccessKeyPlaintext? bedrockProvider? instanceProfileArn?

    Properties

    awsAccessKeyId?: string

    The secret key reference for an AWS access key ID with permissions to interact with Bedrock services. If you prefer to paste your API key directly, see aws_access_key_id_plaintext. You must provide an API key using one of the following fields: aws_access_key_id or aws_access_key_id_plaintext.

    awsAccessKeyIdPlaintext?: string

    An AWS access key ID with permissions to interact with Bedrock services provided as a plaintext string. If you prefer to reference your key using Databricks Secrets, see aws_access_key_id. You must provide an API key using one of the following fields: aws_access_key_id or aws_access_key_id_plaintext.

    awsRegion?: string

    The AWS region to use. Bedrock has to be enabled there.

    awsSecretAccessKey?: string

    The secret key reference for an AWS secret access key paired with the access key ID, with permissions to interact with Bedrock services. If you prefer to paste your API key directly, see aws_secret_access_key_plaintext. You must provide an API key using one of the following fields: aws_secret_access_key or aws_secret_access_key_plaintext.

    awsSecretAccessKeyPlaintext?: string

    An AWS secret access key paired with the access key ID, with permissions to interact with Bedrock services provided as a plaintext string. If you prefer to reference your key using Databricks Secrets, see aws_secret_access_key. You must provide an API key using one of the following fields: aws_secret_access_key or aws_secret_access_key_plaintext.

    bedrockProvider?: string

    The underlying provider in Amazon Bedrock. Supported values (case insensitive) include: Anthropic, Cohere, AI21Labs, Amazon.

    instanceProfileArn?: string

    ARN of the instance profile that the external model will use to access AWS resources. You must authenticate using an instance profile or access keys. If you prefer to authenticate using access keys, see aws_access_key_id, aws_access_key_id_plaintext, aws_secret_access_key and aws_secret_access_key_plaintext.

    Settings

    Member Visibility

    On This Page

    Properties