CfnGatewayTargetProps Struct
Properties for defining a CfnGatewayTarget.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrockagentcore as bedrockagentcore } from 'aws-cdk-lib';
declare const parameterValues: any;
declare const schemaDefinitionProperty_: bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty;
const cfnGatewayTargetProps: bedrockagentcore.CfnGatewayTargetProps = {
targetConfiguration: {
http: {
agentcoreRuntime: {
arn: 'arn',
// the properties below are optional
qualifier: 'qualifier',
schema: {
source: {
inlinePayload: 'inlinePayload',
s3: {
bucketOwnerAccountId: 'bucketOwnerAccountId',
uri: 'uri',
},
},
},
},
connector: {
source: {
connectorId: 'connectorId',
},
// the properties below are optional
parameters: {
parametersKey: 'parameters',
},
},
passthrough: {
endpoint: 'endpoint',
protocolType: 'protocolType',
// the properties below are optional
schema: {
source: {
inlinePayload: 'inlinePayload',
s3: {
bucketOwnerAccountId: 'bucketOwnerAccountId',
uri: 'uri',
},
},
},
stickinessConfiguration: {
identifier: 'identifier',
// the properties below are optional
timeout: 123,
},
},
},
inference: {
connector: {
source: {
connectorId: 'connectorId',
},
},
provider: {
endpoint: 'endpoint',
// the properties below are optional
modelMapping: {
providerPrefix: {
separator: 'separator',
strip: false,
},
},
operations: [{
path: 'path',
// the properties below are optional
models: [{
model: 'model',
}],
providerPath: 'providerPath',
}],
},
},
mcp: {
apiGateway: {
apiGatewayToolConfiguration: {
toolFilters: [{
filterPath: 'filterPath',
methods: ['methods'],
}],
// the properties below are optional
toolOverrides: [{
method: 'method',
name: 'name',
path: 'path',
// the properties below are optional
description: 'description',
}],
},
restApiId: 'restApiId',
stage: 'stage',
},
connector: {
source: {
connectorId: 'connectorId',
},
// the properties below are optional
configurations: [{
name: 'name',
// the properties below are optional
description: 'description',
parameterOverrides: [{
path: 'path',
// the properties below are optional
description: 'description',
visible: false,
}],
parameterValues: parameterValues,
}],
enabled: ['enabled'],
},
lambda: {
lambdaArn: 'lambdaArn',
toolSchema: {
inlinePayload: [{
description: 'description',
inputSchema: {
type: 'type',
// the properties below are optional
description: 'description',
items: schemaDefinitionProperty_,
properties: {
propertiesKey: schemaDefinitionProperty_,
},
required: ['required'],
},
name: 'name',
// the properties below are optional
outputSchema: {
type: 'type',
// the properties below are optional
description: 'description',
items: schemaDefinitionProperty_,
properties: {
propertiesKey: schemaDefinitionProperty_,
},
required: ['required'],
},
}],
s3: {
bucketOwnerAccountId: 'bucketOwnerAccountId',
uri: 'uri',
},
},
},
mcpServer: {
endpoint: 'endpoint',
// the properties below are optional
listingMode: 'listingMode',
mcpToolSchema: {
inlinePayload: 'inlinePayload',
s3: {
bucketOwnerAccountId: 'bucketOwnerAccountId',
uri: 'uri',
},
},
resourcePriority: 123,
},
openApiSchema: {
inlinePayload: 'inlinePayload',
s3: {
bucketOwnerAccountId: 'bucketOwnerAccountId',
uri: 'uri',
},
},
smithyModel: {
inlinePayload: 'inlinePayload',
s3: {
bucketOwnerAccountId: 'bucketOwnerAccountId',
uri: 'uri',
},
},
},
},
// the properties below are optional
credentialProviderConfigurations: [{
credentialProviderType: 'credentialProviderType',
// the properties below are optional
credentialProvider: {
apiKeyCredentialProvider: {
providerArn: 'providerArn',
// the properties below are optional
credentialLocation: 'credentialLocation',
credentialParameterName: 'credentialParameterName',
credentialPrefix: 'credentialPrefix',
},
iamCredentialProvider: {
service: 'service',
// the properties below are optional
region: 'region',
},
oauthCredentialProvider: {
providerArn: 'providerArn',
scopes: ['scopes'],
// the properties below are optional
customParameters: {
customParametersKey: 'customParameters',
},
defaultReturnUrl: 'defaultReturnUrl',
grantType: 'grantType',
},
},
}],
description: 'description',
gatewayIdentifier: 'gatewayIdentifier',
metadataConfiguration: {
allowedQueryParameters: ['allowedQueryParameters'],
allowedRequestHeaders: ['allowedRequestHeaders'],
allowedResponseHeaders: ['allowedResponseHeaders'],
},
name: 'name',
privateEndpoint: {
managedVpcResource: {
endpointIpAddressType: 'endpointIpAddressType',
subnetIds: ['subnetIds'],
vpcIdentifier: 'vpcIdentifier',
// the properties below are optional
routingDomain: 'routingDomain',
securityGroupIds: ['securityGroupIds'],
tags: {
tagsKey: 'tags',
},
},
selfManagedLatticeResource: {
resourceConfigurationIdentifier: 'resourceConfigurationIdentifier',
},
},
};
Properties
credentialProviderConfigurationsoptionalIResolvable | IResolvable | CfnGatewayTarget.CredentialProviderConfigurationProperty[]credential_provider_configurationsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, CredentialProviderConfigurationProperty]]]credentialProviderConfigurationsoptionalIResolvableCredentialProviderConfigurationsoptionalIResolvableCredentialProviderConfigurationsoptionalinterface{}#The OAuth credential provider configuration.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#The description for the gateway target.
gatewayIdentifieroptionalstringgateway_identifieroptionalstrgatewayIdentifieroptionalStringGatewayIdentifieroptionalstringGatewayIdentifieroptional*string#The gateway ID for the gateway target.
metadataConfigurationoptionalIResolvable | CfnGatewayTarget.MetadataConfigurationPropertymetadata_configurationoptionaltyping.Union[IResolvable, MetadataConfigurationProperty]metadataConfigurationoptionalIResolvableMetadataConfigurationoptionalIResolvableMetadataConfigurationoptionalinterface{}#The name for the gateway target.
privateEndpointoptionalIResolvable | CfnGatewayTarget.PrivateEndpointPropertyprivate_endpointoptionaltyping.Union[IResolvable, PrivateEndpointProperty]privateEndpointoptionalIResolvablePrivateEndpointoptionalIResolvablePrivateEndpointoptionalinterface{}#targetConfigurationIResolvable | CfnGatewayTarget.TargetConfigurationPropertytarget_configurationtyping.Union[IResolvable, TargetConfigurationProperty]targetConfigurationIResolvableTargetConfigurationIResolvableTargetConfigurationinterface{}required#The target configuration for the Smithy model target.