BedrockAgentSettings Class

Amazon Bedrock Agent service settings.

The settings are first loaded from environment variables with the prefix '>>BEDROCK_AGENT_<<'. If the environment variables are not found, the settings can be loaded from a .env file with the encoding 'utf-8'. If the settings are not found in the .env file, the settings are ignored; however, validation will fail alerting that the settings are missing.

Optional settings for prefix '>>BEDROCK_<<' are: * agent_resource_role_arn: str - The Amazon Bedrock agent resource role ARN.

       [https://docs.aws.amazon.com/bedrock/latest/userguide/getting-started.html](https://docs.aws.amazon.com/bedrock/latest/userguide/getting-started.html)
       (Env var BEDROCK_AGENT_AGENT_RESOURCE_ROLE_ARN)

  * foundation_model: str - The Amazon Bedrock foundation model ID to use.

       This is required when creating a new agent.
       (Env var BEDROCK_AGENT_FOUNDATION_MODEL)

Note: This class is marked as 'experimental' and may change in the future.

Constructor

BedrockAgentSettings(_case_sensitive: bool | None = None, _nested_model_default_partial_update: bool | None = None, _env_prefix: str | None = None, _env_file: DotenvType | None = PosixPath('.'), _env_file_encoding: str | None = None, _env_ignore_empty: bool | None = None, _env_nested_delimiter: str | None = None, _env_parse_none_str: str | None = None, _env_parse_enums: bool | None = None, _cli_prog_name: str | None = None, _cli_parse_args: bool | list[str] | tuple[str, ...] | None = None, _cli_settings_source: CliSettingsSource[Any] | None = None, _cli_parse_none_str: str | None = None, _cli_hide_none_type: bool | None = None, _cli_avoid_json: bool | None = None, _cli_enforce_required: bool | None = None, _cli_use_class_docs_for_groups: bool | None = None, _cli_exit_on_error: bool | None = None, _cli_prefix: str | None = None, _cli_implicit_flags: bool | None = None, _secrets_dir: PathType | None = None, *, env_file_path: str | None = None, env_file_encoding: str = 'utf-8', agent_resource_role_arn: str, foundation_model: str | None = None)

Parameters

Name	Description
_case_sensitive	Default value: None
_nested_model_default_partial_update	Default value: None
_env_prefix	Default value: None
_env_file	Default value: .
_env_file_encoding	Default value: None
_env_ignore_empty	Default value: None
_env_nested_delimiter	Default value: None
_env_parse_none_str	Default value: None
_env_parse_enums	Default value: None
_cli_prog_name	Default value: None
_cli_parse_args	Default value: None
_cli_settings_source	Default value: None
_cli_parse_none_str	Default value: None
_cli_hide_none_type	Default value: None
_cli_avoid_json	Default value: None
_cli_enforce_required	Default value: None
_cli_use_class_docs_for_groups	Default value: None
_cli_exit_on_error	Default value: None
_cli_prefix	Default value: None
_cli_implicit_flags	Default value: None
_secrets_dir	Default value: None

Keyword-Only Parameters

Name	Description
env_file_path Required
env_file_encoding	Default value: utf-8
agent_resource_role_arn Required
foundation_model Required

Attributes

agent_resource_role_arn

agent_resource_role_arn: str

env_prefix

env_prefix: ClassVar[str] = 'BEDROCK_AGENT_'

foundation_model

foundation_model: str | None

is_experimental

is_experimental = True

stage_status

stage_status = 'experimental'

Share via