Experimental
@aws-cdk/aws-bedrock-agentcore-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
AddApiGatewayTargetOptions Struct
Options for adding an API Gateway target to a gateway.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_agentcore_alpha from '@aws-cdk/aws-bedrock-agentcore-alpha';
import { aws_apigateway as apigateway } from 'aws-cdk-lib';
declare const credentialProviderConfig: bedrock_agentcore_alpha.ICredentialProviderConfig;
declare const restApi: apigateway.RestApi;
const addApiGatewayTargetOptions: bedrock_agentcore_alpha.AddApiGatewayTargetOptions = {
apiGatewayToolConfiguration: {
toolFilters: [{
filterPath: 'filterPath',
methods: [bedrock_agentcore_alpha.ApiGatewayHttpMethod.GET],
}],
// the properties below are optional
toolOverrides: [{
method: bedrock_agentcore_alpha.ApiGatewayHttpMethod.GET,
name: 'name',
path: 'path',
// the properties below are optional
description: 'description',
}],
},
restApi: restApi,
// the properties below are optional
credentialProviderConfigurations: [credentialProviderConfig],
description: 'description',
gatewayTargetName: 'gatewayTargetName',
metadataConfiguration: {
allowedQueryParameters: ['allowedQueryParameters'],
allowedRequestHeaders: ['allowedRequestHeaders'],
allowedResponseHeaders: ['allowedResponseHeaders'],
},
stage: 'stage',
};
python
# 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_apigateway as apigateway
# credential_provider_config: bedrock_agentcore_alpha.ICredentialProviderConfig
# rest_api: apigateway.RestApi
add_api_gateway_target_options = bedrock_agentcore_alpha.AddApiGatewayTargetOptions(
api_gateway_tool_configuration=bedrock_agentcore_alpha.ApiGatewayToolConfiguration(
tool_filters=[bedrock_agentcore_alpha.ApiGatewayToolFilter(
filter_path="filterPath",
methods=[bedrock_agentcore_alpha.ApiGatewayHttpMethod.GET]
)],
# the properties below are optional
tool_overrides=[bedrock_agentcore_alpha.ApiGatewayToolOverride(
method=bedrock_agentcore_alpha.ApiGatewayHttpMethod.GET,
name="name",
path="path",
# the properties below are optional
description="description"
)]
),
rest_api=rest_api,
# the properties below are optional
credential_provider_configurations=[credential_provider_config],
description="description",
gateway_target_name="gatewayTargetName",
metadata_configuration=bedrock_agentcore_alpha.MetadataConfiguration(
allowed_query_parameters=["allowedQueryParameters"],
allowed_request_headers=["allowedRequestHeaders"],
allowed_response_headers=["allowedResponseHeaders"]
),
stage="stage"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.bedrock.agentcore.alpha.*;
import software.amazon.awscdk.services.apigateway.*;
ICredentialProviderConfig credentialProviderConfig;
RestApi restApi;
AddApiGatewayTargetOptions addApiGatewayTargetOptions = AddApiGatewayTargetOptions.builder()
.apiGatewayToolConfiguration(ApiGatewayToolConfiguration.builder()
.toolFilters(List.of(ApiGatewayToolFilter.builder()
.filterPath("filterPath")
.methods(List.of(ApiGatewayHttpMethod.GET))
.build()))
// the properties below are optional
.toolOverrides(List.of(ApiGatewayToolOverride.builder()
.method(ApiGatewayHttpMethod.GET)
.name("name")
.path("path")
// the properties below are optional
.description("description")
.build()))
.build())
.restApi(restApi)
// the properties below are optional
.credentialProviderConfigurations(List.of(credentialProviderConfig))
.description("description")
.gatewayTargetName("gatewayTargetName")
.metadataConfiguration(MetadataConfiguration.builder()
.allowedQueryParameters(List.of("allowedQueryParameters"))
.allowedRequestHeaders(List.of("allowedRequestHeaders"))
.allowedResponseHeaders(List.of("allowedResponseHeaders"))
.build())
.stage("stage")
.build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Bedrock.Agentcore.Alpha
// 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.APIGateway;
ICredentialProviderConfig credentialProviderConfig;
RestApi restApi;
var addApiGatewayTargetOptions = new AddApiGatewayTargetOptions {
ApiGatewayToolConfiguration = new ApiGatewayToolConfiguration {
ToolFilters = new [] { new ApiGatewayToolFilter {
FilterPath = "filterPath",
Methods = new [] { ApiGatewayHttpMethod.GET }
} },
// the properties below are optional
ToolOverrides = new [] { new ApiGatewayToolOverride {
Method = ApiGatewayHttpMethod.GET,
Name = "name",
Path = "path",
// the properties below are optional
Description = "description"
} }
},
RestApi = restApi,
// the properties below are optional
CredentialProviderConfigurations = new [] { credentialProviderConfig },
Description = "description",
GatewayTargetName = "gatewayTargetName",
MetadataConfiguration = new MetadataConfiguration {
AllowedQueryParameters = new [] { "allowedQueryParameters" },
AllowedRequestHeaders = new [] { "allowedRequestHeaders" },
AllowedResponseHeaders = new [] { "allowedResponseHeaders" }
},
Stage = "stage"
};
go
// Install: go get github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awsbedrockagentcorealpha"
import "github.com/aws/aws-cdk-go/awscdk"
var credentialProviderConfig ICredentialProviderConfig
var restApi RestApi
addApiGatewayTargetOptions := &AddApiGatewayTargetOptions{
ApiGatewayToolConfiguration: &ApiGatewayToolConfiguration{
ToolFilters: []ApiGatewayToolFilter{
&ApiGatewayToolFilter{
FilterPath: jsii.String("filterPath"),
Methods: []ApiGatewayHttpMethod{
bedrock_agentcore_alpha.ApiGatewayHttpMethod_GET,
},
},
},
// the properties below are optional
ToolOverrides: []ApiGatewayToolOverride{
&ApiGatewayToolOverride{
Method: bedrock_agentcore_alpha.ApiGatewayHttpMethod_GET,
Name: jsii.String("name"),
Path: jsii.String("path"),
// the properties below are optional
Description: jsii.String("description"),
},
},
},
RestApi: restApi,
// the properties below are optional
CredentialProviderConfigurations: []ICredentialProviderConfig{
credentialProviderConfig,
},
Description: jsii.String("description"),
GatewayTargetName: jsii.String("gatewayTargetName"),
MetadataConfiguration: &MetadataConfiguration{
AllowedQueryParameters: []*string{
jsii.String("allowedQueryParameters"),
},
AllowedRequestHeaders: []*string{
jsii.String("allowedRequestHeaders"),
},
AllowedResponseHeaders: []*string{
jsii.String("allowedResponseHeaders"),
},
},
Stage: jsii.String("stage"),
}
Properties
apiGatewayToolConfigurationApiGatewayToolConfigurationapi_gateway_tool_configurationApiGatewayToolConfigurationapiGatewayToolConfigurationApiGatewayToolConfigurationApiGatewayToolConfigurationApiGatewayToolConfigurationApiGatewayToolConfigurationApiGatewayToolConfigurationrequired#Tool configuration defining which operations to expose.
credentialProviderConfigurationsoptionalICredentialProviderConfig[]credential_provider_configurationsoptionaltyping.List[ICredentialProviderConfig]credentialProviderConfigurationsoptionalList<ICredentialProviderConfig>CredentialProviderConfigurationsoptionalICredentialProviderConfig[]CredentialProviderConfigurationsoptional*[]ICredentialProviderConfig#Credential providers for authentication API Gateway targets support IAM and API key authentication.
Default: Empty array (service handles IAM automatically)
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#Optional description for the gateway target.
Default: No description
gatewayTargetNameoptionalstringgateway_target_nameoptionalstrgatewayTargetNameoptionalStringGatewayTargetNameoptionalstringGatewayTargetNameoptional*string#The name of the gateway target Valid characters are a-z, A-Z, 0-9, _ (underscore) and - (hyphen).
Default: auto generate
metadataConfigurationoptionalMetadataConfigurationmetadata_configurationoptionalMetadataConfigurationmetadataConfigurationoptionalMetadataConfigurationMetadataConfigurationoptionalMetadataConfigurationMetadataConfigurationoptionalMetadataConfiguration#Metadata configuration for passing headers and query parameters Allows you to pass additional context through headers and query parameters.
Default: No metadata configuration
The REST API to integrate with Must be in the same account and region as the gateway [disable-awslint:prefer-ref-interface].
The stage name of the REST API.
Default: Uses the deployment stage from the RestApi (restApi.deploymentStage.stageName)