aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
1,123 lines (1,122 loc) • 126 kB
TypeScript
import * as cdk from "../../core/lib";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
import { BrowserCustomReference, CodeInterpreterCustomReference, GatewayReference, GatewayTargetReference, IBrowserCustomRef, ICodeInterpreterCustomRef, IGatewayRef, IGatewayTargetRef, IMemoryRef, IRuntimeEndpointRef, IRuntimeRef, IWorkloadIdentityRef, MemoryReference, RuntimeEndpointReference, RuntimeReference, WorkloadIdentityReference } from "../../interfaces/generated/aws-bedrockagentcore-interfaces.generated";
/**
* 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;
/**
* The ARN for the custom browser.
*
* @cloudformationAttribute BrowserArn
*/
readonly attrBrowserArn: string;
/**
* The ID for the custom browser.
*
* @cloudformationAttribute BrowserId
*/
readonly attrBrowserId: string;
/**
* The time at which the custom browser was created.
*
* @cloudformationAttribute CreatedAt
*/
readonly attrCreatedAt: string;
/**
* The reason for failure if the browser creation or operation failed.
*
* @cloudformationAttribute FailureReason
*/
readonly attrFailureReason: string;
/**
* The time at which the custom browser was last updated.
*
* @cloudformationAttribute LastUpdatedAt
*/
readonly attrLastUpdatedAt: string;
/**
* The status of the custom browser.
*
* @cloudformationAttribute Status
*/
readonly attrStatus: string;
/**
* Browser signing configuration.
*/
browserSigning?: CfnBrowserCustom.BrowserSigningProperty | cdk.IResolvable;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* The custom browser.
*/
description?: string;
/**
* The Amazon Resource Name (ARN) of the execution role.
*/
executionRoleArn?: string;
/**
* The name of the custom browser.
*/
name: string;
/**
* The network configuration for a code interpreter.
*/
networkConfiguration: CfnBrowserCustom.BrowserNetworkConfigurationProperty | cdk.IResolvable;
/**
* THe custom browser configuration.
*/
recordingConfig?: cdk.IResolvable | CfnBrowserCustom.RecordingConfigProperty;
/**
* The tags for the custom browser.
*/
tags?: Record<string, string>;
/**
* 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;
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>;
}
/**
* 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;
/**
* The code interpreter Amazon Resource Name (ARN).
*
* @cloudformationAttribute CodeInterpreterArn
*/
readonly attrCodeInterpreterArn: string;
/**
* The ID of the code interpreter.
*
* @cloudformationAttribute CodeInterpreterId
*/
readonly attrCodeInterpreterId: string;
/**
* The time at which the code interpreter was created.
*
* @cloudformationAttribute CreatedAt
*/
readonly attrCreatedAt: string;
/**
* The reason for failure if the code interpreter creation or operation failed.
*
* @cloudformationAttribute FailureReason
*/
readonly attrFailureReason: string;
/**
* The time at which the code interpreter was last updated.
*
* @cloudformationAttribute LastUpdatedAt
*/
readonly attrLastUpdatedAt: string;
/**
* The status of the custom code interpreter.
*
* @cloudformationAttribute Status
*/
readonly attrStatus: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* The code interpreter description.
*/
description?: string;
/**
* The Amazon Resource Name (ARN) of the execution role.
*/
executionRoleArn?: string;
/**
* The name of the code interpreter.
*/
name: string;
/**
* The network configuration for a code interpreter.
*/
networkConfiguration: CfnCodeInterpreterCustom.CodeInterpreterNetworkConfigurationProperty | cdk.IResolvable;
/**
* The tags for the code interpreter.
*/
tags?: Record<string, string>;
/**
* 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;
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>;
}
/**
* Amazon Bedrock AgentCore Gateway provides a unified connectivity layer between agents and the tools and resources they need to interact with.
*
* For more information about creating a gateway, see [Set up an Amazon Bedrock AgentCore gateway](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/gateway-building.html) .
*
* See the *Properties* section below for descriptions of both the required and optional properties.
*
* @cloudformationResource AWS::BedrockAgentCore::Gateway
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html
*/
export declare class CfnGateway extends cdk.CfnResource implements cdk.IInspectable, IGatewayRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnGateway 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): CfnGateway;
/**
* Checks whether the given object is a CfnGateway
*/
static isCfnGateway(x: any): x is CfnGateway;
static arnForGateway(resource: IGatewayRef): string;
/**
* The date and time at which the gateway was created.
*
* @cloudformationAttribute CreatedAt
*/
readonly attrCreatedAt: string;
/**
* The ARN for the gateway.
*
* @cloudformationAttribute GatewayArn
*/
readonly attrGatewayArn: string;
/**
* @cloudformationAttribute GatewayIdentifier
*/
readonly attrGatewayIdentifier: string;
/**
* The gateway URL for the gateway.
*
* @cloudformationAttribute GatewayUrl
*/
readonly attrGatewayUrl: string;
/**
* The status for the gateway.
*
* @cloudformationAttribute Status
*/
readonly attrStatus: string;
/**
* The status reasons for the gateway.
*
* @cloudformationAttribute StatusReasons
*/
readonly attrStatusReasons: Array<string>;
/**
* @cloudformationAttribute UpdatedAt
*/
readonly attrUpdatedAt: string;
/**
* @cloudformationAttribute WorkloadIdentityDetails
*/
readonly attrWorkloadIdentityDetails: cdk.IResolvable;
authorizerConfiguration?: CfnGateway.AuthorizerConfigurationProperty | cdk.IResolvable;
/**
* The authorizer type for the gateway.
*/
authorizerType: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* The description for the gateway.
*/
description?: string;
/**
* The exception level for the gateway.
*/
exceptionLevel?: string;
interceptorConfigurations?: Array<CfnGateway.GatewayInterceptorConfigurationProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* The KMS key ARN for the gateway.
*/
kmsKeyArn?: string;
/**
* The name for the gateway.
*/
name: string;
/**
* The protocol configuration for the gateway target.
*/
protocolConfiguration?: CfnGateway.GatewayProtocolConfigurationProperty | cdk.IResolvable;
/**
* The protocol type for the gateway target.
*/
protocolType: string;
roleArn: string;
/**
* The tags for the gateway.
*/
tags?: Record<string, string>;
/**
* Create a new `AWS::BedrockAgentCore::Gateway`.
*
* @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: CfnGatewayProps);
get gatewayRef(): GatewayReference;
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 CfnGateway {
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-authorizerconfiguration.html
*/
interface AuthorizerConfigurationProperty {
/**
* The authorizer configuration for the gateway.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-authorizerconfiguration.html#cfn-bedrockagentcore-gateway-authorizerconfiguration-customjwtauthorizer
*/
readonly customJwtAuthorizer: CfnGateway.CustomJWTAuthorizerConfigurationProperty | cdk.IResolvable;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration.html
*/
interface CustomJWTAuthorizerConfigurationProperty {
/**
* The allowed audience authorized for the gateway target.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-allowedaudience
*/
readonly allowedAudience?: Array<string>;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-allowedclients
*/
readonly allowedClients?: Array<string>;
/**
* The discovery URL for the authorizer configuration.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-discoveryurl
*/
readonly discoveryUrl: string;
}
/**
* The protocol configuration.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-gatewayprotocolconfiguration.html
*/
interface GatewayProtocolConfigurationProperty {
/**
* The gateway protocol configuration for MCP.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-gatewayprotocolconfiguration.html#cfn-bedrockagentcore-gateway-gatewayprotocolconfiguration-mcp
*/
readonly mcp: cdk.IResolvable | CfnGateway.MCPGatewayConfigurationProperty;
}
/**
* The gateway configuration for MCP.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-mcpgatewayconfiguration.html
*/
interface MCPGatewayConfigurationProperty {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-mcpgatewayconfiguration.html#cfn-bedrockagentcore-gateway-mcpgatewayconfiguration-instructions
*/
readonly instructions?: string;
/**
* The MCP gateway configuration search type.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-mcpgatewayconfiguration.html#cfn-bedrockagentcore-gateway-mcpgatewayconfiguration-searchtype
*/
readonly searchType?: string;
/**
* The supported versions for the MCP configuration for the gateway target.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-mcpgatewayconfiguration.html#cfn-bedrockagentcore-gateway-mcpgatewayconfiguration-supportedversions
*/
readonly supportedVersions?: Array<string>;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-gatewayinterceptorconfiguration.html
*/
interface GatewayInterceptorConfigurationProperty {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-gatewayinterceptorconfiguration.html#cfn-bedrockagentcore-gateway-gatewayinterceptorconfiguration-inputconfiguration
*/
readonly inputConfiguration?: CfnGateway.InterceptorInputConfigurationProperty | cdk.IResolvable;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-gatewayinterceptorconfiguration.html#cfn-bedrockagentcore-gateway-gatewayinterceptorconfiguration-interceptionpoints
*/
readonly interceptionPoints: Array<string>;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-gatewayinterceptorconfiguration.html#cfn-bedrockagentcore-gateway-gatewayinterceptorconfiguration-interceptor
*/
readonly interceptor: CfnGateway.InterceptorConfigurationProperty | cdk.IResolvable;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-interceptorconfiguration.html
*/
interface InterceptorConfigurationProperty {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-interceptorconfiguration.html#cfn-bedrockagentcore-gateway-interceptorconfiguration-lambda
*/
readonly lambda: cdk.IResolvable | CfnGateway.LambdaInterceptorConfigurationProperty;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-lambdainterceptorconfiguration.html
*/
interface LambdaInterceptorConfigurationProperty {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-lambdainterceptorconfiguration.html#cfn-bedrockagentcore-gateway-lambdainterceptorconfiguration-arn
*/
readonly arn: string;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-interceptorinputconfiguration.html
*/
interface InterceptorInputConfigurationProperty {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-interceptorinputconfiguration.html#cfn-bedrockagentcore-gateway-interceptorinputconfiguration-passrequestheaders
*/
readonly passRequestHeaders: boolean | cdk.IResolvable;
}
/**
* The workload identity details for the gateway.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-workloadidentitydetails.html
*/
interface WorkloadIdentityDetailsProperty {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-workloadidentitydetails.html#cfn-bedrockagentcore-gateway-workloadidentitydetails-workloadidentityarn
*/
readonly workloadIdentityArn: string;
}
}
/**
* Properties for defining a `CfnGateway`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html
*/
export interface CfnGatewayProps {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-authorizerconfiguration
*/
readonly authorizerConfiguration?: CfnGateway.AuthorizerConfigurationProperty | cdk.IResolvable;
/**
* The authorizer type for the gateway.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-authorizertype
*/
readonly authorizerType: string;
/**
* The description for the gateway.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-description
*/
readonly description?: string;
/**
* The exception level for the gateway.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-exceptionlevel
*/
readonly exceptionLevel?: string;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-interceptorconfigurations
*/
readonly interceptorConfigurations?: Array<CfnGateway.GatewayInterceptorConfigurationProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* The KMS key ARN for the gateway.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-kmskeyarn
*/
readonly kmsKeyArn?: string;
/**
* The name for the gateway.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-name
*/
readonly name: string;
/**
* The protocol configuration for the gateway target.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-protocolconfiguration
*/
readonly protocolConfiguration?: CfnGateway.GatewayProtocolConfigurationProperty | cdk.IResolvable;
/**
* The protocol type for the gateway target.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-protocoltype
*/
readonly protocolType: string;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-rolearn
*/
readonly roleArn: string;
/**
* The tags for the gateway.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-tags
*/
readonly tags?: Record<string, string>;
}
/**
* After creating a gateway, you can add targets, which define the tools that your gateway will host.
*
* For more information about adding gateway targets, see [Add targets to an existing gateway](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/gateway-building-adding-targets.html) .
*
* See the *Properties* section below for descriptions of both the required and optional properties.
*
* @cloudformationResource AWS::BedrockAgentCore::GatewayTarget
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html
*/
export declare class CfnGatewayTarget extends cdk.CfnResource implements cdk.IInspectable, IGatewayTargetRef {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnGatewayTarget 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): CfnGatewayTarget;
/**
* Checks whether the given object is a CfnGatewayTarget
*/
static isCfnGatewayTarget(x: any): x is CfnGatewayTarget;
/**
* The date and time at which the gateway target was created.
*
* @cloudformationAttribute CreatedAt
*/
readonly attrCreatedAt: string;
/**
* @cloudformationAttribute GatewayArn
*/
readonly attrGatewayArn: string;
/**
* @cloudformationAttribute LastSynchronizedAt
*/
readonly attrLastSynchronizedAt: string;
/**
* The status for the gateway target.
*
* @cloudformationAttribute Status
*/
readonly attrStatus: string;
/**
* The status reasons for the gateway target.
*
* @cloudformationAttribute StatusReasons
*/
readonly attrStatusReasons: Array<string>;
/**
* The target ID for the gateway target.
*
* @cloudformationAttribute TargetId
*/
readonly attrTargetId: string;
/**
* The time at which the resource was updated.
*
* @cloudformationAttribute UpdatedAt
*/
readonly attrUpdatedAt: string;
/**
* The OAuth credential provider configuration.
*/
credentialProviderConfigurations: Array<CfnGatewayTarget.CredentialProviderConfigurationProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* The description for the gateway target.
*/
description?: string;
/**
* The gateway ID for the gateway target.
*/
gatewayIdentifier?: string;
/**
* The name for the gateway target.
*/
name: string;
/**
* The target configuration for the Smithy model target.
*/
targetConfiguration: cdk.IResolvable | CfnGatewayTarget.TargetConfigurationProperty;
/**
* Create a new `AWS::BedrockAgentCore::GatewayTarget`.
*
* @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: CfnGatewayTargetProps);
get gatewayTargetRef(): GatewayTargetReference;
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 CfnGatewayTarget {
/**
* The credential provider configuration for the gateway target.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialproviderconfiguration.html
*/
interface CredentialProviderConfigurationProperty {
/**
* The credential provider for the gateway target.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialproviderconfiguration.html#cfn-bedrockagentcore-gatewaytarget-credentialproviderconfiguration-credentialprovider
*/
readonly credentialProvider?: CfnGatewayTarget.CredentialProviderProperty | cdk.IResolvable;
/**
* The credential provider type for the gateway target.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialproviderconfiguration.html#cfn-bedrockagentcore-gatewaytarget-credentialproviderconfiguration-credentialprovidertype
*/
readonly credentialProviderType: string;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialprovider.html
*/
interface CredentialProviderProperty {
/**
* The API key credential provider.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialprovider.html#cfn-bedrockagentcore-gatewaytarget-credentialprovider-apikeycredentialprovider
*/
readonly apiKeyCredentialProvider?: CfnGatewayTarget.ApiKeyCredentialProviderProperty | cdk.IResolvable;
/**
* The OAuth credential provider for the gateway target.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialprovider.html#cfn-bedrockagentcore-gatewaytarget-credentialprovider-oauthcredentialprovider
*/
readonly oauthCredentialProvider?: cdk.IResolvable | CfnGatewayTarget.OAuthCredentialProviderProperty;
}
/**
* The OAuth credential provider for the gateway target.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html
*/
interface OAuthCredentialProviderProperty {
/**
* The OAuth credential provider.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-customparameters
*/
readonly customParameters?: cdk.IResolvable | Record<string, string>;
/**
* The provider ARN for the gateway target.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-providerarn
*/
readonly providerArn: string;
/**
* The OAuth credential provider scopes.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-scopes
*/
readonly scopes: Array<string>;
}
/**
* The API key credential provider for the gateway target.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html
*/
interface ApiKeyCredentialProviderProperty {
/**
* The credential location for the gateway target.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentiallocation
*/
readonly credentialLocation?: string;
/**
* The credential parameter name for the provider for the gateway target.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentialparametername
*/
readonly credentialParameterName?: string;
/**
* The API key credential provider for the gateway target.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentialprefix
*/
readonly credentialPrefix?: string;
/**
* The provider ARN for the gateway target.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-providerarn
*/
readonly providerArn: string;
}
/**
* The target configuration.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-targetconfiguration.html
*/
interface TargetConfigurationProperty {
/**
* The target configuration definition for MCP.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-targetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-targetconfiguration-mcp
*/
readonly mcp: cdk.IResolvable | CfnGatewayTarget.McpTargetConfigurationProperty;
}
/**
* The MCP target configuration for the gateway target.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html
*/
interface McpTargetConfigurationProperty {
/**
* The Lambda MCP configuration for the gateway target.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-lambda
*/
readonly lambda?: cdk.IResolvable | CfnGatewayTarget.McpLambdaTargetConfigurationProperty;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-mcpserver
*/
readonly mcpServer?: cdk.IResolvable | CfnGatewayTarget.McpServerTargetConfigurationProperty;
/**
* The OpenApi schema for the gateway target MCP configuration.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-openapischema
*/
readonly openApiSchema?: CfnGatewayTarget.ApiSchemaConfigurationProperty | cdk.IResolvable;
/**
* The target configuration for the Smithy model target.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-smithymodel
*/
readonly smithyModel?: CfnGatewayTarget.ApiSchemaConfigurationProperty | cdk.IResolvable;
}
/**
* The API schema configuration for the gateway target.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apischemaconfiguration.html
*/
interface ApiSchemaConfigurationProperty {
/**
* The inline payload for the gateway.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apischemaconfiguration.html#cfn-bedrockagentcore-gatewaytarget-apischemaconfiguration-inlinepayload
*/
readonly inlinePayload?: string;
/**
* The API schema configuration.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apischemaconfiguration.html#cfn-bedrockagentcore-gatewaytarget-apischemaconfiguration-s3
*/
readonly s3?: cdk.IResolvable | CfnGatewayTarget.S3ConfigurationProperty;
}
/**
* The S3 configuration for the gateway target.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-s3configuration.html
*/
interface S3ConfigurationProperty {
/**
* The S3 configuration bucket owner account ID for the gateway target.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-s3configuration.html#cfn-bedrockagentcore-gatewaytarget-s3configuration-bucketowneraccountid
*/
readonly bucketOwnerAccountId?: string;
/**
* The configuration URI for the gateway target.
*