aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
1,225 lines • 266 kB
TypeScript
import * as cdk from "../../core/lib";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
import { ApiKeyCredentialProviderReference, BrowserCustomReference, BrowserProfileReference, CodeInterpreterCustomReference, EvaluatorReference, GatewayReference, GatewayTargetReference, IApiKeyCredentialProviderRef, IBrowserCustomRef, IBrowserProfileRef, ICodeInterpreterCustomRef, IEvaluatorRef, IGatewayRef, IGatewayTargetRef, IMemoryRef, IOAuth2CredentialProviderRef, IOnlineEvaluationConfigRef, IPolicyEngineRef, IPolicyRef, IRuntimeEndpointRef, IRuntimeRef, IWorkloadIdentityRef, MemoryReference, OAuth2CredentialProviderReference, OnlineEvaluationConfigReference, PolicyEngineReference, PolicyReference, RuntimeEndpointReference, RuntimeReference, WorkloadIdentityReference } from "../../interfaces/generated/aws-bedrockagentcore-interfaces.generated";
/**
* Resource Type definition for AWS::BedrockAgentCore::ApiKeyCredentialProvider.
*
* @cloudformationResource AWS::BedrockAgentCore::ApiKeyCredentialProvider
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-apikeycredentialprovider.html
*/
export declare class CfnApiKeyCredentialProvider extends cdk.CfnResource implements cdk.IInspectable, IApiKeyCredentialProviderRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnApiKeyCredentialProvider from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnApiKeyCredentialProvider;
/**
* Checks whether the given object is a CfnApiKeyCredentialProvider
*/
static isCfnApiKeyCredentialProvider(x: any): x is CfnApiKeyCredentialProvider;
/**
* The API key to use for authentication.
*/
private _apiKey?;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* The name of the API key credential provider.
*/
private _name;
/**
* Tags to assign to the API key credential provider.
*/
private _tags?;
/**
* Create a new `AWS::BedrockAgentCore::ApiKeyCredentialProvider`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnApiKeyCredentialProviderProps);
get apiKeyCredentialProviderRef(): ApiKeyCredentialProviderReference;
/**
* The API key to use for authentication.
*/
get apiKey(): string | undefined;
/**
* The API key to use for authentication.
*/
set apiKey(value: string | undefined);
/**
* The name of the API key credential provider.
*/
get name(): string;
/**
* The name of the API key credential provider.
*/
set name(value: string);
/**
* Tags to assign to the API key credential provider.
*/
get tags(): Array<cdk.CfnTag> | undefined;
/**
* Tags to assign to the API key credential provider.
*/
set tags(value: Array<cdk.CfnTag> | undefined);
/**
* Contains information about the API key secret in AWS Secrets Manager
*
* @cloudformationAttribute ApiKeySecretArn
*/
get attrApiKeySecretArn(): cdk.IResolvable;
/**
* The timestamp when the credential provider was created
*
* @cloudformationAttribute CreatedTime
*/
get attrCreatedTime(): string;
/**
* The Amazon Resource Name (ARN) of the API key credential provider
*
* @cloudformationAttribute CredentialProviderArn
*/
get attrCredentialProviderArn(): string;
/**
* The timestamp when the credential provider was last updated
*
* @cloudformationAttribute LastUpdatedTime
*/
get attrLastUpdatedTime(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnApiKeyCredentialProvider {
/**
* Contains information about the API key secret in AWS Secrets Manager.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-apikeycredentialprovider-apikeysecretarn.html
*/
interface ApiKeySecretArnProperty {
/**
* The ARN of the secret in AWS Secrets Manager.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-apikeycredentialprovider-apikeysecretarn.html#cfn-bedrockagentcore-apikeycredentialprovider-apikeysecretarn-secretarn
*/
readonly secretArn: string;
}
}
/**
* Properties for defining a `CfnApiKeyCredentialProvider`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-apikeycredentialprovider.html
*/
export interface CfnApiKeyCredentialProviderProps {
/**
* The API key to use for authentication.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-apikeycredentialprovider.html#cfn-bedrockagentcore-apikeycredentialprovider-apikey
*/
readonly apiKey?: string;
/**
* The name of the API key credential provider.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-apikeycredentialprovider.html#cfn-bedrockagentcore-apikeycredentialprovider-name
*/
readonly name: string;
/**
* Tags to assign to the API key credential provider.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-apikeycredentialprovider.html#cfn-bedrockagentcore-apikeycredentialprovider-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* AgentCore Browser tool provides a fast, secure, cloud-based browser runtime to enable AI agents to interact with websites at scale.
*
* For more information about using the custom browser, see [Interact with web applications using Amazon Bedrock AgentCore Browser](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/browser-tool.html) .
*
* See the *Properties* section below for descriptions of both the required and optional properties.
*
* @cloudformationResource AWS::BedrockAgentCore::BrowserCustom
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html
*/
export declare class CfnBrowserCustom extends cdk.CfnResource implements cdk.IInspectable, IBrowserCustomRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnBrowserCustom from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnBrowserCustom;
/**
* Checks whether the given object is a CfnBrowserCustom
*/
static isCfnBrowserCustom(x: any): x is CfnBrowserCustom;
/**
* Creates a new IBrowserCustomRef from an ARN
*/
static fromBrowserCustomArn(scope: constructs.Construct, id: string, arn: string): IBrowserCustomRef;
/**
* Creates a new IBrowserCustomRef from a browserId
*/
static fromBrowserId(scope: constructs.Construct, id: string, browserId: string): IBrowserCustomRef;
static arnForBrowserCustom(resource: IBrowserCustomRef): string;
/**
* Browser signing configuration.
*/
private _browserSigning?;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* The custom browser.
*/
private _description?;
/**
* The Amazon Resource Name (ARN) of the execution role.
*/
private _executionRoleArn?;
/**
* The name of the custom browser.
*/
private _name;
/**
* The network configuration for a code interpreter.
*/
private _networkConfiguration;
/**
* THe custom browser configuration.
*/
private _recordingConfig?;
/**
* The tags for the custom browser.
*/
private _tags?;
/**
* Create a new `AWS::BedrockAgentCore::BrowserCustom`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnBrowserCustomProps);
get browserCustomRef(): BrowserCustomReference;
/**
* Browser signing configuration.
*/
get browserSigning(): CfnBrowserCustom.BrowserSigningProperty | cdk.IResolvable | undefined;
/**
* Browser signing configuration.
*/
set browserSigning(value: CfnBrowserCustom.BrowserSigningProperty | cdk.IResolvable | undefined);
/**
* The custom browser.
*/
get description(): string | undefined;
/**
* The custom browser.
*/
set description(value: string | undefined);
/**
* The Amazon Resource Name (ARN) of the execution role.
*/
get executionRoleArn(): string | undefined;
/**
* The Amazon Resource Name (ARN) of the execution role.
*/
set executionRoleArn(value: string | undefined);
/**
* The name of the custom browser.
*/
get name(): string;
/**
* The name of the custom browser.
*/
set name(value: string);
/**
* The network configuration for a code interpreter.
*/
get networkConfiguration(): CfnBrowserCustom.BrowserNetworkConfigurationProperty | cdk.IResolvable;
/**
* The network configuration for a code interpreter.
*/
set networkConfiguration(value: CfnBrowserCustom.BrowserNetworkConfigurationProperty | cdk.IResolvable);
/**
* THe custom browser configuration.
*/
get recordingConfig(): cdk.IResolvable | CfnBrowserCustom.RecordingConfigProperty | undefined;
/**
* THe custom browser configuration.
*/
set recordingConfig(value: cdk.IResolvable | CfnBrowserCustom.RecordingConfigProperty | undefined);
/**
* The tags for the custom browser.
*/
get tags(): Record<string, string> | undefined;
/**
* The tags for the custom browser.
*/
set tags(value: Record<string, string> | undefined);
/**
* The ARN for the custom browser.
*
* @cloudformationAttribute BrowserArn
*/
get attrBrowserArn(): string;
/**
* The ID for the custom browser.
*
* @cloudformationAttribute BrowserId
*/
get attrBrowserId(): string;
/**
* The time at which the custom browser was created.
*
* @cloudformationAttribute CreatedAt
*/
get attrCreatedAt(): string;
/**
* The reason for failure if the browser creation or operation failed.
*
* @cloudformationAttribute FailureReason
*/
get attrFailureReason(): string;
/**
* The time at which the custom browser was last updated.
*
* @cloudformationAttribute LastUpdatedAt
*/
get attrLastUpdatedAt(): string;
/**
* The status of the custom browser.
*
* @cloudformationAttribute Status
*/
get attrStatus(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnBrowserCustom {
/**
* The network configuration.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-browsernetworkconfiguration.html
*/
interface BrowserNetworkConfigurationProperty {
/**
* The network mode.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-browsernetworkconfiguration.html#cfn-bedrockagentcore-browsercustom-browsernetworkconfiguration-networkmode
*/
readonly networkMode: string;
/**
* Network mode configuration for VPC.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-browsernetworkconfiguration.html#cfn-bedrockagentcore-browsercustom-browsernetworkconfiguration-vpcconfig
*/
readonly vpcConfig?: cdk.IResolvable | CfnBrowserCustom.VpcConfigProperty;
}
/**
* Network mode configuration for VPC.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-vpcconfig.html
*/
interface VpcConfigProperty {
/**
* Security groups for VPC.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-vpcconfig.html#cfn-bedrockagentcore-browsercustom-vpcconfig-securitygroups
*/
readonly securityGroups: Array<string>;
/**
* Subnets for VPC.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-vpcconfig.html#cfn-bedrockagentcore-browsercustom-vpcconfig-subnets
*/
readonly subnets: Array<string>;
}
/**
* The recording configuration.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-recordingconfig.html
*/
interface RecordingConfigProperty {
/**
* The recording configuration for a browser.
*
* This structure defines how browser sessions are recorded.
*
* @default - false
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-recordingconfig.html#cfn-bedrockagentcore-browsercustom-recordingconfig-enabled
*/
readonly enabled?: boolean | cdk.IResolvable;
/**
* The S3 location.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-recordingconfig.html#cfn-bedrockagentcore-browsercustom-recordingconfig-s3location
*/
readonly s3Location?: cdk.IResolvable | CfnBrowserCustom.S3LocationProperty;
}
/**
* The S3 location.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-s3location.html
*/
interface S3LocationProperty {
/**
* The S3 location bucket name.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-s3location.html#cfn-bedrockagentcore-browsercustom-s3location-bucket
*/
readonly bucket: string;
/**
* The S3 location object prefix.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-s3location.html#cfn-bedrockagentcore-browsercustom-s3location-prefix
*/
readonly prefix: string;
}
/**
* Browser signing configuration.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-browsersigning.html
*/
interface BrowserSigningProperty {
/**
* @default - false
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-browsersigning.html#cfn-bedrockagentcore-browsercustom-browsersigning-enabled
*/
readonly enabled?: boolean | cdk.IResolvable;
}
}
/**
* Properties for defining a `CfnBrowserCustom`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html
*/
export interface CfnBrowserCustomProps {
/**
* Browser signing configuration.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#cfn-bedrockagentcore-browsercustom-browsersigning
*/
readonly browserSigning?: CfnBrowserCustom.BrowserSigningProperty | cdk.IResolvable;
/**
* The custom browser.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#cfn-bedrockagentcore-browsercustom-description
*/
readonly description?: string;
/**
* The Amazon Resource Name (ARN) of the execution role.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#cfn-bedrockagentcore-browsercustom-executionrolearn
*/
readonly executionRoleArn?: string;
/**
* The name of the custom browser.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#cfn-bedrockagentcore-browsercustom-name
*/
readonly name: string;
/**
* The network configuration for a code interpreter.
*
* This structure defines how the code interpreter connects to the network.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#cfn-bedrockagentcore-browsercustom-networkconfiguration
*/
readonly networkConfiguration: CfnBrowserCustom.BrowserNetworkConfigurationProperty | cdk.IResolvable;
/**
* THe custom browser configuration.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#cfn-bedrockagentcore-browsercustom-recordingconfig
*/
readonly recordingConfig?: cdk.IResolvable | CfnBrowserCustom.RecordingConfigProperty;
/**
* The tags for the custom browser.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#cfn-bedrockagentcore-browsercustom-tags
*/
readonly tags?: Record<string, string>;
}
/**
* Resource definition for AWS::BedrockAgentCore::BrowserProfile.
*
* @cloudformationResource AWS::BedrockAgentCore::BrowserProfile
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browserprofile.html
*/
export declare class CfnBrowserProfile extends cdk.CfnResource implements cdk.IInspectable, IBrowserProfileRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnBrowserProfile from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnBrowserProfile;
/**
* Checks whether the given object is a CfnBrowserProfile
*/
static isCfnBrowserProfile(x: any): x is CfnBrowserProfile;
static arnForBrowserProfile(resource: IBrowserProfileRef): string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* The description of the browser profile.
*/
private _description?;
/**
* The name of the browser profile.
*/
private _name;
/**
* A map of tag keys and values.
*/
private _tags?;
/**
* Create a new `AWS::BedrockAgentCore::BrowserProfile`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnBrowserProfileProps);
get browserProfileRef(): BrowserProfileReference;
/**
* The description of the browser profile.
*/
get description(): string | undefined;
/**
* The description of the browser profile.
*/
set description(value: string | undefined);
/**
* The name of the browser profile.
*/
get name(): string;
/**
* The name of the browser profile.
*/
set name(value: string);
/**
* A map of tag keys and values.
*/
get tags(): Record<string, string> | undefined;
/**
* A map of tag keys and values.
*/
set tags(value: Record<string, string> | undefined);
/**
* Timestamp when the browser profile was created.
*
* @cloudformationAttribute CreatedAt
*/
get attrCreatedAt(): string;
/**
* Timestamp when the browser profile was last saved.
*
* @cloudformationAttribute LastSavedAt
*/
get attrLastSavedAt(): string;
/**
* ID of the last saved browser.
*
* @cloudformationAttribute LastSavedBrowserId
*/
get attrLastSavedBrowserId(): string;
/**
* ID of the last saved browser session.
*
* @cloudformationAttribute LastSavedBrowserSessionId
*/
get attrLastSavedBrowserSessionId(): string;
/**
* Timestamp when the browser profile was last updated.
*
* @cloudformationAttribute LastUpdatedAt
*/
get attrLastUpdatedAt(): string;
/**
* The ARN of a BrowserProfile resource.
*
* @cloudformationAttribute ProfileArn
*/
get attrProfileArn(): string;
/**
* The id of the browser profile.
*
* @cloudformationAttribute ProfileId
*/
get attrProfileId(): string;
/**
* Status of browser profile
*
* @cloudformationAttribute Status
*/
get attrStatus(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
/**
* Properties for defining a `CfnBrowserProfile`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browserprofile.html
*/
export interface CfnBrowserProfileProps {
/**
* The description of the browser profile.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browserprofile.html#cfn-bedrockagentcore-browserprofile-description
*/
readonly description?: string;
/**
* The name of the browser profile.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browserprofile.html#cfn-bedrockagentcore-browserprofile-name
*/
readonly name: string;
/**
* A map of tag keys and values.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browserprofile.html#cfn-bedrockagentcore-browserprofile-tags
*/
readonly tags?: Record<string, string>;
}
/**
* The AgentCore Code Interpreter tool enables agents to securely execute code in isolated sandbox environments.
*
* It offers advanced configuration support and seamless integration with popular frameworks.
*
* For more information about using the custom code interpreter, see [Execute code and analyze data using Amazon Bedrock AgentCore Code Interpreter](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/code-interpreter-tool.html) .
*
* See the *Properties* section below for descriptions of both the required and optional properties.
*
* @cloudformationResource AWS::BedrockAgentCore::CodeInterpreterCustom
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-codeinterpretercustom.html
*/
export declare class CfnCodeInterpreterCustom extends cdk.CfnResource implements cdk.IInspectable, ICodeInterpreterCustomRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnCodeInterpreterCustom from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnCodeInterpreterCustom;
/**
* Checks whether the given object is a CfnCodeInterpreterCustom
*/
static isCfnCodeInterpreterCustom(x: any): x is CfnCodeInterpreterCustom;
/**
* Creates a new ICodeInterpreterCustomRef from an ARN
*/
static fromCodeInterpreterCustomArn(scope: constructs.Construct, id: string, arn: string): ICodeInterpreterCustomRef;
/**
* Creates a new ICodeInterpreterCustomRef from a codeInterpreterId
*/
static fromCodeInterpreterId(scope: constructs.Construct, id: string, codeInterpreterId: string): ICodeInterpreterCustomRef;
static arnForCodeInterpreterCustom(resource: ICodeInterpreterCustomRef): string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* The code interpreter description.
*/
private _description?;
/**
* The Amazon Resource Name (ARN) of the execution role.
*/
private _executionRoleArn?;
/**
* The name of the code interpreter.
*/
private _name;
/**
* The network configuration for a code interpreter.
*/
private _networkConfiguration;
/**
* The tags for the code interpreter.
*/
private _tags?;
/**
* Create a new `AWS::BedrockAgentCore::CodeInterpreterCustom`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnCodeInterpreterCustomProps);
get codeInterpreterCustomRef(): CodeInterpreterCustomReference;
/**
* The code interpreter description.
*/
get description(): string | undefined;
/**
* The code interpreter description.
*/
set description(value: string | undefined);
/**
* The Amazon Resource Name (ARN) of the execution role.
*/
get executionRoleArn(): string | undefined;
/**
* The Amazon Resource Name (ARN) of the execution role.
*/
set executionRoleArn(value: string | undefined);
/**
* The name of the code interpreter.
*/
get name(): string;
/**
* The name of the code interpreter.
*/
set name(value: string);
/**
* The network configuration for a code interpreter.
*/
get networkConfiguration(): CfnCodeInterpreterCustom.CodeInterpreterNetworkConfigurationProperty | cdk.IResolvable;
/**
* The network configuration for a code interpreter.
*/
set networkConfiguration(value: CfnCodeInterpreterCustom.CodeInterpreterNetworkConfigurationProperty | cdk.IResolvable);
/**
* The tags for the code interpreter.
*/
get tags(): Record<string, string> | undefined;
/**
* The tags for the code interpreter.
*/
set tags(value: Record<string, string> | undefined);
/**
* The code interpreter Amazon Resource Name (ARN).
*
* @cloudformationAttribute CodeInterpreterArn
*/
get attrCodeInterpreterArn(): string;
/**
* The ID of the code interpreter.
*
* @cloudformationAttribute CodeInterpreterId
*/
get attrCodeInterpreterId(): string;
/**
* The time at which the code interpreter was created.
*
* @cloudformationAttribute CreatedAt
*/
get attrCreatedAt(): string;
/**
* The reason for failure if the code interpreter creation or operation failed.
*
* @cloudformationAttribute FailureReason
*/
get attrFailureReason(): string;
/**
* The time at which the code interpreter was last updated.
*
* @cloudformationAttribute LastUpdatedAt
*/
get attrLastUpdatedAt(): string;
/**
* The status of the custom code interpreter.
*
* @cloudformationAttribute Status
*/
get attrStatus(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnCodeInterpreterCustom {
/**
* The network configuration.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration.html
*/
interface CodeInterpreterNetworkConfigurationProperty {
/**
* The network mode.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration.html#cfn-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration-networkmode
*/
readonly networkMode: string;
/**
* Network mode configuration for VPC.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration.html#cfn-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration-vpcconfig
*/
readonly vpcConfig?: cdk.IResolvable | CfnCodeInterpreterCustom.VpcConfigProperty;
}
/**
* Network mode configuration for VPC.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-codeinterpretercustom-vpcconfig.html
*/
interface VpcConfigProperty {
/**
* Security groups for VPC.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-codeinterpretercustom-vpcconfig.html#cfn-bedrockagentcore-codeinterpretercustom-vpcconfig-securitygroups
*/
readonly securityGroups: Array<string>;
/**
* Subnets for VPC.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-codeinterpretercustom-vpcconfig.html#cfn-bedrockagentcore-codeinterpretercustom-vpcconfig-subnets
*/
readonly subnets: Array<string>;
}
}
/**
* Properties for defining a `CfnCodeInterpreterCustom`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-codeinterpretercustom.html
*/
export interface CfnCodeInterpreterCustomProps {
/**
* The code interpreter description.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-codeinterpretercustom.html#cfn-bedrockagentcore-codeinterpretercustom-description
*/
readonly description?: string;
/**
* The Amazon Resource Name (ARN) of the execution role.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-codeinterpretercustom.html#cfn-bedrockagentcore-codeinterpretercustom-executionrolearn
*/
readonly executionRoleArn?: string;
/**
* The name of the code interpreter.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-codeinterpretercustom.html#cfn-bedrockagentcore-codeinterpretercustom-name
*/
readonly name: string;
/**
* The network configuration for a code interpreter.
*
* This structure defines how the code interpreter connects to the network.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-codeinterpretercustom.html#cfn-bedrockagentcore-codeinterpretercustom-networkconfiguration
*/
readonly networkConfiguration: CfnCodeInterpreterCustom.CodeInterpreterNetworkConfigurationProperty | cdk.IResolvable;
/**
* The tags for the code interpreter.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-codeinterpretercustom.html#cfn-bedrockagentcore-codeinterpretercustom-tags
*/
readonly tags?: Record<string, string>;
}
/**
* Resource Type definition for AWS::BedrockAgentCore::Evaluator - Creates a custom evaluator for agent quality assessment using LLM-as-a-Judge configurations.
*
* @cloudformationResource AWS::BedrockAgentCore::Evaluator
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-evaluator.html
*/
export declare class CfnEvaluator extends cdk.CfnResource implements cdk.IInspectable, IEvaluatorRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnEvaluator from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnEvaluator;
/**
* Checks whether the given object is a CfnEvaluator
*/
static isCfnEvaluator(x: any): x is CfnEvaluator;
static arnForEvaluator(resource: IEvaluatorRef): string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* The description of the evaluator.
*/
private _description?;
/**
* The configuration that defines how an evaluator assesses agent performance.
*/
private _evaluatorConfig;
/**
* The name of the evaluator.
*/
private _evaluatorName;
private _level;
/**
* A list of tags to assign to the evaluator.
*/
private _tags?;
/**
* Create a new `AWS::BedrockAgentCore::Evaluator`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnEvaluatorProps);
get evaluatorRef(): EvaluatorReference;
/**
* The description of the evaluator.
*/
get description(): string | undefined;
/**
* The description of the evaluator.
*/
set description(value: string | undefined);
/**
* The configuration that defines how an evaluator assesses agent performance.
*/
get evaluatorConfig(): CfnEvaluator.EvaluatorConfigProperty | cdk.IResolvable;
/**
* The configuration that defines how an evaluator assesses agent performance.
*/
set evaluatorConfig(value: CfnEvaluator.EvaluatorConfigProperty | cdk.IResolvable);
/**
* The name of the evaluator.
*/
get evaluatorName(): string;
/**
* The name of the evaluator.
*/
set evaluatorName(value: string);
get level(): string;
set level(value: string);
/**
* A list of tags to assign to the evaluator.
*/
get tags(): Array<cdk.CfnTag> | undefined;
/**
* A list of tags to assign to the evaluator.
*/
set tags(value: Array<cdk.CfnTag> | undefined);
/**
* The timestamp when the evaluator was created.
*
* @cloudformationAttribute CreatedAt
*/
get attrCreatedAt(): string;
/**
* The Amazon Resource Name (ARN) of the evaluator.
*
* @cloudformationAttribute EvaluatorArn
*/
get attrEvaluatorArn(): string;
/**
* The unique identifier of the evaluator.
*
* @cloudformationAttribute EvaluatorId
*/
get attrEvaluatorId(): string;
/**
* @cloudformationAttribute Status
*/
get attrStatus(): string;
/**
* The timestamp when the evaluator was last updated.
*
* @cloudformationAttribute UpdatedAt
*/
get attrUpdatedAt(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnEvaluator {
/**
* The configuration that defines how an evaluator assesses agent performance.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-evaluatorconfig.html
*/
interface EvaluatorConfigProperty {
/**
* The configuration for code-based evaluation using a Lambda function.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-evaluatorconfig.html#cfn-bedrockagentcore-evaluator-evaluatorconfig-codebased
*/
readonly codeBased?: CfnEvaluator.CodeBasedEvaluatorConfigProperty | cdk.IResolvable;
/**
* The configuration for LLM-as-a-Judge evaluation.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-evaluatorconfig.html#cfn-bedrockagentcore-evaluator-evaluatorconfig-llmasajudge
*/
readonly llmAsAJudge?: cdk.IResolvable | CfnEvaluator.LlmAsAJudgeEvaluatorConfigProperty;
}
/**
* The configuration for LLM-as-a-Judge evaluation.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig.html
*/
interface LlmAsAJudgeEvaluatorConfigProperty {
/**
* The evaluation instructions that guide the language model in assessing agent performance.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig.html#cfn-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig-instructions
*/
readonly instructions: string;
/**
* The model configuration that specifies which foundation model to use for evaluation.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig.html#cfn-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig-modelconfig
*/
readonly modelConfig: CfnEvaluator.EvaluatorModelConfigProperty | cdk.IResolvable;
/**
* The rating scale that defines how evaluators should score agent performance.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig.html#cfn-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig-ratingscale
*/
readonly ratingScale: cdk.IResolvable | CfnEvaluator.RatingScaleProperty;
}
/**
* The rating scale that defines how evaluators should score agent performance.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-ratingscale.html
*/
interface RatingScaleProperty {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-ratingscale.html#cfn-bedrockagentcore-evaluator-ratingscale-categorical
*/
readonly categorical?: Array<CfnEvaluator.CategoricalScaleDefinitionProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-ratingscale.html#cfn-bedrockagentcore-evaluator-ratingscale-numerical
*/
readonly numerical?: Array<cdk.IResolvable | CfnEvaluator.NumericalScaleDefinitionProperty> | cdk.IResolvable;
}
/**
* A numerical rating scale option.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-numericalscaledefinition.html
*/
interface NumericalScaleDefinitionProperty {
/**
* The description that explains what this numerical rating represents.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-numericalscaledefinition.html#cfn-bedrockagentcore-evaluator-numericalscaledefinition-definition
*/
readonly definition: string;
/**
* The label that describes this numerical rating option.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-numericalscaledefinition.html#cfn-bedrockagentcore-evaluator-numericalscaledefinition-label
*/
readonly label: string;
/**
* The numerical value for this rating scale option.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-numericalscaledefinition.html#cfn-bedrockagentcore-evaluator-numericalscaledefinition-value
*/
readonly value: number;
}
/**
* A categorical rating scale option.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-categoricalscaledefinition.html
*/
interface CategoricalScaleDefinitionProperty {
/**
* The description that explains what this categorical rating represents.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-categoricalscaledefinition.html#cfn-bedrockagentcore-evaluator-categoricalscaledefinition-definition
*/
readonly definition: string;
/**
* The label of this categorical rating option.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-categoricalscaledefinition.html#cfn-bedrockagentcore-evaluator-categoricalscaledefinition-label
*/
readonly label: string;
}
/**
* The model configuration that specifies which foundation model to use for evaluation.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-evaluatormodelconfig.html
*/
interface EvaluatorModelConfigProperty {
/**
* The configuration for using Amazon Bedrock models in evaluator assessments.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-evaluatormodelconfig.html#cfn-bedrockagentcore-evaluator-evaluatormodelconfig-bedrockevaluatormodelconfig
*/
readonly bedrockEvaluatorModelConfig: CfnEvaluator.BedrockEvaluatorModelConfigProperty | cdk.IResolvable;
}
/**
* The configuration for using Amazon Bedrock models in evaluator assessments.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-bedrockevaluatormodelconfig.html
*/
interface BedrockEvaluatorModelConfigProperty {
/**
* Additional model-specific request fields.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-bedrockevaluatormodelconfig.html#cfn-bedrockagentcore-evaluator-bedrockevaluatormodelconfig-additionalmodelrequestfields
*/
readonly additionalModelRequestFields?: any | cdk.IResolvable;
/**
* The inference configuration parameters that control model behavior during evaluation.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-bedrockevaluatormodelconfig.html#cfn-bedrockagentcore-evaluator-bedrockevaluatormodelconfig-inferenceconfig
*/
readonly inferenceConfig?: CfnEvaluator.InferenceConfigurationProperty | cdk.IResolvable;
/**
* The identifier of the Amazon Bedrock model to use for evaluation.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-bedrockevaluatormodelconfig.html#cfn-bedrockagentcore-evaluator-bedrockevaluatormodelconfig-modelid
*/
readonly modelId: string;
}
/**
* The inference configuration parameters that control model behavior during evaluation.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-inferenceconfiguration.html
*/
interface InferenceConfigurationProperty {
/**
* The maximum number of tokens to generate in the model response.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-inferenceconfiguration.html#cfn-bedrockagentcore-evaluator-inferenceconfiguration-maxtokens
*/
readonly maxTokens?: number;
/**
* The temperature value that controls randomness in the model's responses.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-inferenceconfiguration.html#cfn-bedrockagentcore-evaluator-inferenceconfiguration-temperature
*/
readonly temperature?: number;
/**
* The top-p sampling parameter that controls the diversity of the model's responses.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-inferenceconfiguration.html#cfn-bedrockagentcore-evaluator-inferenceconfiguration-topp
*/
readonly topP?: number;
}
/**
* The configuration for code-based evaluation using a Lambda function.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-codebasedevaluatorconfig.html
*/
interface CodeBasedEvaluatorConfigProperty {
/**
* The Lambda function configuration for code-based evaluation.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-codebasedevaluatorconfig.html#cfn-bedrockagentcore-evaluator-codebasedevaluatorconfig-lambdaconfig
*/
readonly lambdaConfig: cdk.IResolvable | CfnEvaluator.LambdaEvaluatorConfigProperty;
}
/**
* The Lambda function configuration for code-based evalu