GatewayTargetLambdaProps

class aws_cdk.aws_bedrock_agentcore_alpha.GatewayTargetLambdaProps(*, description=None, gateway_target_name=None, gateway, lambda_function, tool_schema, credential_provider_configurations=None)

Bases: GatewayTargetCommonProps

(experimental) Properties for creating a Lambda-based Gateway Target Convenience interface for the most common use case.

Parameters:

  • description (Optional[str]) – (experimental) Optional description for the gateway target The description can have up to 200 characters. Default: - No description

  • gateway_target_name (Optional[str]) – (experimental) The name of the gateway target The name must be unique within the gateway Pattern: ^([0-9a-zA-Z][-]?){1,100}$. Default: - auto generate

  • gateway (IGateway) – (experimental) The gateway this target belongs to.

  • lambda_function (IFunction) – (experimental) The Lambda function to associate with this target.

  • tool_schema (ToolSchema) – (experimental) The tool schema defining the available tools.

  • credential_provider_configurations (Optional[Sequence[ICredentialProviderConfig]]) – (experimental) Credential providers for authentication Lambda targets only support IAM role authentication. Default: - [GatewayCredentialProvider.fromIamRole()]

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_bedrock_agentcore_alpha as bedrock_agentcore_alpha
from aws_cdk import aws_lambda as lambda_

# credential_provider_config: bedrock_agentcore_alpha.ICredentialProviderConfig
# function_: lambda.Function
# gateway: bedrock_agentcore_alpha.Gateway
# tool_schema: bedrock_agentcore_alpha.ToolSchema

gateway_target_lambda_props = bedrock_agentcore_alpha.GatewayTargetLambdaProps(
    gateway=gateway,
    lambda_function=function_,
    tool_schema=tool_schema,

    # the properties below are optional
    credential_provider_configurations=[credential_provider_config],
    description="description",
    gateway_target_name="gatewayTargetName"
)

Attributes

credential_provider_configurations

(experimental) Credential providers for authentication Lambda targets only support IAM role authentication.

Default:

  • [GatewayCredentialProvider.fromIamRole()]

Stability:

experimental

description

(experimental) Optional description for the gateway target The description can have up to 200 characters.

Default:

  • No description

Stability:

experimental

gateway

(experimental) The gateway this target belongs to.

Stability:

experimental

gateway_target_name

^([0-9a-zA-Z][-]?){1,100}$.

Default:

  • auto generate

Stability:

experimental

Type:

(experimental) The name of the gateway target The name must be unique within the gateway Pattern

lambda_function

(experimental) The Lambda function to associate with this target.

Stability:

experimental

tool_schema

(experimental) The tool schema defining the available tools.

Stability:

experimental