AddApiGatewayTargetOptions Struct
Options for adding an API Gateway target to a gateway.
Example
ts
const gateway = new agentcore.Gateway(this, "MyGateway", {
gatewayName: "my-gateway",
});
const api = new apigateway.RestApi(this, 'MyApi', {
restApiName: 'my-api',
});
// Uses IAM authorization for outbound auth by default
const apiGatewayTarget = gateway.addApiGatewayTarget("MyApiGatewayTarget", {
restApi: api,
apiGatewayToolConfiguration: {
toolFilters: [
{
filterPath: "/pets/*",
methods: [agentcore.ApiGatewayHttpMethod.GET],
},
],
},
});
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)