Class GatewayTargetLambdaProps

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

Inheritance
object
GatewayTargetLambdaProps
Inherited Members
Namespace: Amazon.CDK.AWS.Bedrock.Agentcore.Alpha
Assembly: Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.dll
Syntax (csharp)
public class GatewayTargetLambdaProps : IGatewayTargetLambdaProps, IGatewayTargetCommonProps
Syntax (vb)
Public Class GatewayTargetLambdaProps Implements IGatewayTargetLambdaProps, IGatewayTargetCommonProps
Remarks

Stability: Deprecated

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Bedrock.Agentcore.Alpha;
             using Amazon.CDK.AWS.Lambda;

             ICredentialProviderConfig credentialProviderConfig;
             Function function_;
             Gateway gateway;
             ToolSchema toolSchema;

             var gatewayTargetLambdaProps = new GatewayTargetLambdaProps {
                 Gateway = gateway,
                 LambdaFunction = function_,
                 ToolSchema = toolSchema,

                 // the properties below are optional
                 CredentialProviderConfigurations = new [] { credentialProviderConfig },
                 Description = "description",
                 GatewayTargetName = "gatewayTargetName"
             };

Synopsis

Constructors

GatewayTargetLambdaProps()

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

Properties

CredentialProviderConfigurations

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

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

(deprecated) The gateway this target belongs to.
GatewayTargetName

(deprecated) The name of the gateway target The name must be unique within the gateway Pattern: ^([0-9a-zA-Z][-]?){1,100}$.
LambdaFunction

(deprecated) The Lambda function to associate with this target.
ToolSchema

(deprecated) The tool schema defining the available tools.

Constructors

GatewayTargetLambdaProps()

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

public GatewayTargetLambdaProps()
Remarks

Stability: Deprecated

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Bedrock.Agentcore.Alpha;
             using Amazon.CDK.AWS.Lambda;

             ICredentialProviderConfig credentialProviderConfig;
             Function function_;
             Gateway gateway;
             ToolSchema toolSchema;

             var gatewayTargetLambdaProps = new GatewayTargetLambdaProps {
                 Gateway = gateway,
                 LambdaFunction = function_,
                 ToolSchema = toolSchema,

                 // the properties below are optional
                 CredentialProviderConfigurations = new [] { credentialProviderConfig },
                 Description = "description",
                 GatewayTargetName = "gatewayTargetName"
             };

Properties

CredentialProviderConfigurations

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

[Obsolete]
public ICredentialProviderConfig[]? CredentialProviderConfigurations { get; set; }
Property Value

ICredentialProviderConfig[]

Remarks

Default: - [GatewayCredentialProvider.fromIamRole()]

Stability: Deprecated

Description

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

[Obsolete]
public string? Description { get; set; }
Property Value

string

Remarks

Default: - No description

Stability: Deprecated

Gateway

(deprecated) The gateway this target belongs to.

[Obsolete]
public IGateway Gateway { get; set; }
Property Value

IGateway

Remarks

Stability: Deprecated

GatewayTargetName

(deprecated) The name of the gateway target The name must be unique within the gateway Pattern: ^([0-9a-zA-Z][-]?){1,100}$.

[Obsolete]
public string? GatewayTargetName { get; set; }
Property Value

string

Remarks

Default: - auto generate

Stability: Deprecated

LambdaFunction

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

[Obsolete]
public IFunction LambdaFunction { get; set; }
Property Value

IFunction

Remarks

Stability: Deprecated

ToolSchema

(deprecated) The tool schema defining the available tools.

[Obsolete]
public ToolSchema ToolSchema { get; set; }
Property Value

ToolSchema

Remarks

Stability: Deprecated

Implements