GatewayTarget
bedrockagentcorecontrol.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | bedrockagentcorecontrol-controller/apis/v1alpha1#GatewayTarget |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | GatewayTarget |
| ListKind | GatewayTargetList |
| Plural | gatewaytargets |
| Singular | gatewaytarget |
The gateway target.
Spec
credentialProviderConfigurations:
credentialProvider:
apiKeyCredentialProvider:
credentialLocation: string
credentialParameterName: string
credentialPrefix: string
providerARN: string
oauthCredentialProvider:
customParameters: {}
defaultReturnURL: string
grantType: string
providerARN: string
scopes:
- string
credentialProviderType: string
description: string
gatewayIdentifier: string
gatewayIdentifierRef:
from:
name: string
namespace: string
metadataConfiguration:
allowedQueryParameters:
- string
allowedRequestHeaders:
- string
allowedResponseHeaders:
- string
name: string
targetConfiguration:
mcp:
apiGateway:
apiGatewayToolConfiguration:
toolFilters:
- filterPath: string
methods:
- string
toolOverrides:
- description: string
method: string
name: string
path: string
restAPIID: string
restAPIRef:
from:
name: string
namespace: string
stage: string
lambda:
lambdaARN: string
toolSchema:
inlinePayload:
- description: string
inputSchema: string
name: string
outputSchema: string
s3:
bucketOwnerAccountID: string
uri: string
mcpServer:
endpoint: string
openAPISchema:
inlinePayload: string
s3:
bucketOwnerAccountID: string
uri: string
smithyModel:
inlinePayload: string
s3:
bucketOwnerAccountID: string
uri: string
| Field | Description |
|---|---|
| credentialProviderConfigurations Optional | array The credential provider configurations for the target. These configurations specify how the gateway authenticates with the target endpoint. |
| credentialProviderConfigurations.[] Required | object The configuration for a credential provider. This structure defines how the |
| gateway authenticates with the target endpoint. | |
| credentialProviderConfigurations.[].credentialProvider.apiKeyCredentialProvider Optional | object An API key credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using an API key. |
| credentialProviderConfigurations.[].credentialProvider.apiKeyCredentialProvider.credentialLocation Optional | string |
| credentialProviderConfigurations.[].credentialProvider.apiKeyCredentialProvider.credentialParameterName Optional | string |
| credentialProviderConfigurations.[].credentialProvider.apiKeyCredentialProvider.credentialPrefix Optional | string |
| credentialProviderConfigurations.[].credentialProvider.apiKeyCredentialProvider.providerARN Optional | string |
| credentialProviderConfigurations.[].credentialProvider.oauthCredentialProvider Optional | object An OAuth credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using OAuth. |
| credentialProviderConfigurations.[].credentialProvider.oauthCredentialProvider.customParameters Optional | object |
| credentialProviderConfigurations.[].credentialProvider.oauthCredentialProvider.defaultReturnURL Optional | string |
| credentialProviderConfigurations.[].credentialProvider.oauthCredentialProvider.grantType Optional | string |
| credentialProviderConfigurations.[].credentialProvider.oauthCredentialProvider.providerARN Optional | string |
| credentialProviderConfigurations.[].credentialProvider.oauthCredentialProvider.scopes Optional | array |
| credentialProviderConfigurations.[].credentialProvider.oauthCredentialProvider.scopes.[] Required | string |
| description Optional | string The description of the gateway target. |
| gatewayIdentifier Optional | string The identifier of the gateway to create a target for. Regex Pattern: ^([0-9a-z][-]?){1,100}-[0-9a-z]{10}$ |
| gatewayIdentifierRef Optional | object AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef: from: name: my-api |
| gatewayIdentifierRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| gatewayIdentifierRef.from.name Optional | string |
| gatewayIdentifierRef.from.namespace Optional | string |
| metadataConfiguration Optional | object Optional configuration for HTTP header and query parameter propagation to and from the gateway target. |
| metadataConfiguration.allowedQueryParameters Optional | array |
| metadataConfiguration.allowedQueryParameters.[] Required | string |
| metadataConfiguration.allowedRequestHeaders.[] Required | string |
| metadataConfiguration.allowedResponseHeaders.[] Required | string |
| targetConfiguration Required | object The configuration settings for the target, including endpoint information and schema definitions. |
| targetConfiguration.mcp Optional | object The Model Context Protocol (MCP) configuration for a target. This structure defines how the gateway uses MCP to communicate with the target. |
| targetConfiguration.mcp.apiGateway Optional | object The configuration for an Amazon API Gateway target. |
| targetConfiguration.mcp.apiGateway.apiGatewayToolConfiguration Optional | object The configuration for defining REST API tool filters and overrides for the gateway target. |
| targetConfiguration.mcp.apiGateway.apiGatewayToolConfiguration.toolFilters Optional | array |
| targetConfiguration.mcp.apiGateway.apiGatewayToolConfiguration.toolFilters.[] Required | object Specifies which operations from an API Gateway REST API are exposed as tools. |
| Tool names and descriptions are derived from the operationId and description | |
| fields in the API’s exported OpenAPI specification. | |
| targetConfiguration.mcp.apiGateway.apiGatewayToolConfiguration.toolFilters.[].methods Optional | array |
| targetConfiguration.mcp.apiGateway.apiGatewayToolConfiguration.toolFilters.[].methods.[] Required | string |
| targetConfiguration.mcp.apiGateway.apiGatewayToolConfiguration.toolOverrides.[] Required | object Settings to override configurations for a tool. |
| targetConfiguration.mcp.apiGateway.apiGatewayToolConfiguration.toolOverrides.[].method Optional | string |
| targetConfiguration.mcp.apiGateway.apiGatewayToolConfiguration.toolOverrides.[].name Optional | string |
| targetConfiguration.mcp.apiGateway.apiGatewayToolConfiguration.toolOverrides.[].path Optional | string |
| targetConfiguration.mcp.apiGateway.restAPIID Optional | string |
| targetConfiguration.mcp.apiGateway.restAPIRef Optional | object Reference field for RestAPIID |
| targetConfiguration.mcp.apiGateway.restAPIRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| targetConfiguration.mcp.apiGateway.restAPIRef.from.name Optional | string |
| targetConfiguration.mcp.apiGateway.restAPIRef.from.namespace Optional | string |
| targetConfiguration.mcp.apiGateway.stage Optional | string |
| targetConfiguration.mcp.lambda Optional | object The Lambda configuration for a Model Context Protocol target. This structure defines how the gateway uses a Lambda function to communicate with the target. |
| targetConfiguration.mcp.lambda.lambdaARN Optional | string |
| targetConfiguration.mcp.lambda.toolSchema Optional | object A tool schema for a gateway target. This structure defines the schema for a tool that the target exposes through the Model Context Protocol. |
| targetConfiguration.mcp.lambda.toolSchema.inlinePayload Optional | array |
| targetConfiguration.mcp.lambda.toolSchema.inlinePayload.[] Required | object A tool definition for a gateway target. This structure defines a tool that |
| the target exposes through the Model Context Protocol. | |
| targetConfiguration.mcp.lambda.toolSchema.inlinePayload.[].inputSchema Optional | string |
| targetConfiguration.mcp.lambda.toolSchema.inlinePayload.[].name Optional | string |
| targetConfiguration.mcp.lambda.toolSchema.inlinePayload.[].outputSchema Optional | string |
| targetConfiguration.mcp.lambda.toolSchema.s3 Optional | object The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3. |
| targetConfiguration.mcp.lambda.toolSchema.s3.bucketOwnerAccountID Optional | string |
| targetConfiguration.mcp.lambda.toolSchema.s3.uri Optional | string |
| targetConfiguration.mcp.mcpServer Optional | object The target configuration for the MCP server. |
| targetConfiguration.mcp.mcpServer.endpoint Optional | string |
| targetConfiguration.mcp.openAPISchema Optional | object Configuration for API schema. |
| targetConfiguration.mcp.openAPISchema.inlinePayload Optional | string |
| targetConfiguration.mcp.openAPISchema.s3 Optional | object The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3. |
| targetConfiguration.mcp.openAPISchema.s3.bucketOwnerAccountID Optional | string |
| targetConfiguration.mcp.openAPISchema.s3.uri Optional | string |
| targetConfiguration.mcp.smithyModel Optional | object Configuration for API schema. |
| targetConfiguration.mcp.smithyModel.inlinePayload Optional | string |
| targetConfiguration.mcp.smithyModel.s3 Optional | object The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3. |
| targetConfiguration.mcp.smithyModel.s3.bucketOwnerAccountID Optional | string |
| targetConfiguration.mcp.smithyModel.s3.uri Optional | string |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
partition: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
createdAt: string
gatewayARN: string
lastSynchronizedAt: string
status: string
statusReasons:
- string
targetID: string
updatedAt: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.partition Optional | string Partition is the AWS partition in which the resource exists or will exist |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| conditions Optional | array All CRs managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
| controllers to indicate terminal states of the CR and its backend AWS | |
| service API resource | |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |
| createdAt Optional | string The timestamp when the target was created. |
| gatewayARN Optional | string The Amazon Resource Name (ARN) of the gateway. Regex Pattern: `^arn:aws( |
| lastSynchronizedAt Optional | string The last synchronization of the target. |
| status Optional | string The current status of the target. |
| statusReasons Optional | array The reasons for the current status of the target. |
| statusReasons.[] Required | string |
| updatedAt Optional | string The timestamp when the gateway target was last updated. |