CfnGatewayTargetProps Struct
Properties for defining a CfnGatewayTarget.
| Source | |
|---|---|
| Type last changed |
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
certificateConfigurations: [{
s3: {
uri: 'uri',
// the properties below are optional
bucketOwnerAccountId: 'bucketOwnerAccountId',
},
secretsManager: {
secretArn: 'secretArn',
},
}],
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',
},
},
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore
# parameter_values: Any
# schema_definition_property_: bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty
cfn_gateway_target_props = bedrockagentcore.CfnGatewayTargetProps(
target_configuration=bedrockagentcore.CfnGatewayTarget.TargetConfigurationProperty(
http=bedrockagentcore.CfnGatewayTarget.HttpTargetConfigurationProperty(
agentcore_runtime=bedrockagentcore.CfnGatewayTarget.RuntimeTargetConfigurationProperty(
arn="arn",
# the properties below are optional
qualifier="qualifier",
schema=bedrockagentcore.CfnGatewayTarget.HttpApiSchemaConfigurationProperty(
source=bedrockagentcore.CfnGatewayTarget.ApiSchemaConfigurationProperty(
inline_payload="inlinePayload",
s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
bucket_owner_account_id="bucketOwnerAccountId",
uri="uri"
)
)
)
),
connector=bedrockagentcore.CfnGatewayTarget.HttpConnectorTargetConfigurationProperty(
source=bedrockagentcore.CfnGatewayTarget.HttpConnectorSourceProperty(
connector_id="connectorId"
),
# the properties below are optional
parameters={
"parameters_key": "parameters"
}
),
passthrough=bedrockagentcore.CfnGatewayTarget.PassthroughTargetConfigurationProperty(
endpoint="endpoint",
protocol_type="protocolType",
# the properties below are optional
schema=bedrockagentcore.CfnGatewayTarget.HttpApiSchemaConfigurationProperty(
source=bedrockagentcore.CfnGatewayTarget.ApiSchemaConfigurationProperty(
inline_payload="inlinePayload",
s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
bucket_owner_account_id="bucketOwnerAccountId",
uri="uri"
)
)
),
stickiness_configuration=bedrockagentcore.CfnGatewayTarget.StickinessConfigurationProperty(
identifier="identifier",
# the properties below are optional
timeout=123
)
)
),
inference=bedrockagentcore.CfnGatewayTarget.InferenceTargetConfigurationProperty(
connector=bedrockagentcore.CfnGatewayTarget.InferenceConnectorTargetConfigurationProperty(
source=bedrockagentcore.CfnGatewayTarget.InferenceConnectorSourceProperty(
connector_id="connectorId"
)
),
provider=bedrockagentcore.CfnGatewayTarget.InferenceProviderTargetConfigurationProperty(
endpoint="endpoint",
# the properties below are optional
model_mapping=bedrockagentcore.CfnGatewayTarget.ModelMappingProperty(
provider_prefix=bedrockagentcore.CfnGatewayTarget.ProviderPrefixProperty(
separator="separator",
strip=False
)
),
operations=[bedrockagentcore.CfnGatewayTarget.InferenceOperationConfigurationProperty(
path="path",
# the properties below are optional
models=[bedrockagentcore.CfnGatewayTarget.ModelEntryProperty(
model="model"
)],
provider_path="providerPath"
)]
)
),
mcp=bedrockagentcore.CfnGatewayTarget.McpTargetConfigurationProperty(
api_gateway=bedrockagentcore.CfnGatewayTarget.ApiGatewayTargetConfigurationProperty(
api_gateway_tool_configuration=bedrockagentcore.CfnGatewayTarget.ApiGatewayToolConfigurationProperty(
tool_filters=[bedrockagentcore.CfnGatewayTarget.ApiGatewayToolFilterProperty(
filter_path="filterPath",
methods=["methods"]
)],
# the properties below are optional
tool_overrides=[bedrockagentcore.CfnGatewayTarget.ApiGatewayToolOverrideProperty(
method="method",
name="name",
path="path",
# the properties below are optional
description="description"
)]
),
rest_api_id="restApiId",
stage="stage"
),
connector=bedrockagentcore.CfnGatewayTarget.ConnectorTargetConfigurationProperty(
source=bedrockagentcore.CfnGatewayTarget.ConnectorSourceProperty(
connector_id="connectorId"
),
# the properties below are optional
configurations=[bedrockagentcore.CfnGatewayTarget.ConnectorConfigurationProperty(
name="name",
# the properties below are optional
description="description",
parameter_overrides=[bedrockagentcore.CfnGatewayTarget.ConnectorParameterOverrideProperty(
path="path",
# the properties below are optional
description="description",
visible=False
)],
parameter_values=parameter_values
)],
enabled=["enabled"]
),
lambda_=bedrockagentcore.CfnGatewayTarget.McpLambdaTargetConfigurationProperty(
lambda_arn="lambdaArn",
tool_schema=bedrockagentcore.CfnGatewayTarget.ToolSchemaProperty(
inline_payload=[bedrockagentcore.CfnGatewayTarget.ToolDefinitionProperty(
description="description",
input_schema=bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty(
type="type",
# the properties below are optional
description="description",
items=schema_definition_property_,
properties={
"properties_key": schema_definition_property_
},
required=["required"]
),
name="name",
# the properties below are optional
output_schema=bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty(
type="type",
# the properties below are optional
description="description",
items=schema_definition_property_,
properties={
"properties_key": schema_definition_property_
},
required=["required"]
)
)],
s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
bucket_owner_account_id="bucketOwnerAccountId",
uri="uri"
)
)
),
mcp_server=bedrockagentcore.CfnGatewayTarget.McpServerTargetConfigurationProperty(
endpoint="endpoint",
# the properties below are optional
listing_mode="listingMode",
mcp_tool_schema=bedrockagentcore.CfnGatewayTarget.McpToolSchemaConfigurationProperty(
inline_payload="inlinePayload",
s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
bucket_owner_account_id="bucketOwnerAccountId",
uri="uri"
)
),
resource_priority=123
),
open_api_schema=bedrockagentcore.CfnGatewayTarget.ApiSchemaConfigurationProperty(
inline_payload="inlinePayload",
s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
bucket_owner_account_id="bucketOwnerAccountId",
uri="uri"
)
),
smithy_model=bedrockagentcore.CfnGatewayTarget.ApiSchemaConfigurationProperty(
inline_payload="inlinePayload",
s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
bucket_owner_account_id="bucketOwnerAccountId",
uri="uri"
)
)
)
),
# the properties below are optional
certificate_configurations=[bedrockagentcore.CfnGatewayTarget.CertificateConfigurationProperty(
s3=bedrockagentcore.CfnGatewayTarget.S3CertificateConfigurationProperty(
uri="uri",
# the properties below are optional
bucket_owner_account_id="bucketOwnerAccountId"
),
secrets_manager=bedrockagentcore.CfnGatewayTarget.SecretsManagerCertificateConfigurationProperty(
secret_arn="secretArn"
)
)],
credential_provider_configurations=[bedrockagentcore.CfnGatewayTarget.CredentialProviderConfigurationProperty(
credential_provider_type="credentialProviderType",
# the properties below are optional
credential_provider=bedrockagentcore.CfnGatewayTarget.CredentialProviderProperty(
api_key_credential_provider=bedrockagentcore.CfnGatewayTarget.ApiKeyCredentialProviderProperty(
provider_arn="providerArn",
# the properties below are optional
credential_location="credentialLocation",
credential_parameter_name="credentialParameterName",
credential_prefix="credentialPrefix"
),
iam_credential_provider=bedrockagentcore.CfnGatewayTarget.IamCredentialProviderProperty(
service="service",
# the properties below are optional
region="region"
),
oauth_credential_provider=bedrockagentcore.CfnGatewayTarget.OAuthCredentialProviderProperty(
provider_arn="providerArn",
scopes=["scopes"],
# the properties below are optional
custom_parameters={
"custom_parameters_key": "customParameters"
},
default_return_url="defaultReturnUrl",
grant_type="grantType"
)
)
)],
description="description",
gateway_identifier="gatewayIdentifier",
metadata_configuration=bedrockagentcore.CfnGatewayTarget.MetadataConfigurationProperty(
allowed_query_parameters=["allowedQueryParameters"],
allowed_request_headers=["allowedRequestHeaders"],
allowed_response_headers=["allowedResponseHeaders"]
),
name="name",
private_endpoint=bedrockagentcore.CfnGatewayTarget.PrivateEndpointProperty(
managed_vpc_resource=bedrockagentcore.CfnGatewayTarget.ManagedVpcResourceProperty(
endpoint_ip_address_type="endpointIpAddressType",
subnet_ids=["subnetIds"],
vpc_identifier="vpcIdentifier",
# the properties below are optional
routing_domain="routingDomain",
security_group_ids=["securityGroupIds"],
tags={
"tags_key": "tags"
}
),
self_managed_lattice_resource=bedrockagentcore.CfnGatewayTarget.SelfManagedLatticeResourceProperty(
resource_configuration_identifier="resourceConfigurationIdentifier"
)
)
)
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.bedrockagentcore.*;
Object parameterValues;
SchemaDefinitionProperty schemaDefinitionProperty_;
CfnGatewayTargetProps cfnGatewayTargetProps = CfnGatewayTargetProps.builder()
.targetConfiguration(TargetConfigurationProperty.builder()
.http(HttpTargetConfigurationProperty.builder()
.agentcoreRuntime(RuntimeTargetConfigurationProperty.builder()
.arn("arn")
// the properties below are optional
.qualifier("qualifier")
.schema(HttpApiSchemaConfigurationProperty.builder()
.source(ApiSchemaConfigurationProperty.builder()
.inlinePayload("inlinePayload")
.s3(S3ConfigurationProperty.builder()
.bucketOwnerAccountId("bucketOwnerAccountId")
.uri("uri")
.build())
.build())
.build())
.build())
.connector(HttpConnectorTargetConfigurationProperty.builder()
.source(HttpConnectorSourceProperty.builder()
.connectorId("connectorId")
.build())
// the properties below are optional
.parameters(Map.of(
"parametersKey", "parameters"))
.build())
.passthrough(PassthroughTargetConfigurationProperty.builder()
.endpoint("endpoint")
.protocolType("protocolType")
// the properties below are optional
.schema(HttpApiSchemaConfigurationProperty.builder()
.source(ApiSchemaConfigurationProperty.builder()
.inlinePayload("inlinePayload")
.s3(S3ConfigurationProperty.builder()
.bucketOwnerAccountId("bucketOwnerAccountId")
.uri("uri")
.build())
.build())
.build())
.stickinessConfiguration(StickinessConfigurationProperty.builder()
.identifier("identifier")
// the properties below are optional
.timeout(123)
.build())
.build())
.build())
.inference(InferenceTargetConfigurationProperty.builder()
.connector(InferenceConnectorTargetConfigurationProperty.builder()
.source(InferenceConnectorSourceProperty.builder()
.connectorId("connectorId")
.build())
.build())
.provider(InferenceProviderTargetConfigurationProperty.builder()
.endpoint("endpoint")
// the properties below are optional
.modelMapping(ModelMappingProperty.builder()
.providerPrefix(ProviderPrefixProperty.builder()
.separator("separator")
.strip(false)
.build())
.build())
.operations(List.of(InferenceOperationConfigurationProperty.builder()
.path("path")
// the properties below are optional
.models(List.of(ModelEntryProperty.builder()
.model("model")
.build()))
.providerPath("providerPath")
.build()))
.build())
.build())
.mcp(McpTargetConfigurationProperty.builder()
.apiGateway(ApiGatewayTargetConfigurationProperty.builder()
.apiGatewayToolConfiguration(ApiGatewayToolConfigurationProperty.builder()
.toolFilters(List.of(ApiGatewayToolFilterProperty.builder()
.filterPath("filterPath")
.methods(List.of("methods"))
.build()))
// the properties below are optional
.toolOverrides(List.of(ApiGatewayToolOverrideProperty.builder()
.method("method")
.name("name")
.path("path")
// the properties below are optional
.description("description")
.build()))
.build())
.restApiId("restApiId")
.stage("stage")
.build())
.connector(ConnectorTargetConfigurationProperty.builder()
.source(ConnectorSourceProperty.builder()
.connectorId("connectorId")
.build())
// the properties below are optional
.configurations(List.of(ConnectorConfigurationProperty.builder()
.name("name")
// the properties below are optional
.description("description")
.parameterOverrides(List.of(ConnectorParameterOverrideProperty.builder()
.path("path")
// the properties below are optional
.description("description")
.visible(false)
.build()))
.parameterValues(parameterValues)
.build()))
.enabled(List.of("enabled"))
.build())
.lambda(McpLambdaTargetConfigurationProperty.builder()
.lambdaArn("lambdaArn")
.toolSchema(ToolSchemaProperty.builder()
.inlinePayload(List.of(ToolDefinitionProperty.builder()
.description("description")
.inputSchema(SchemaDefinitionProperty.builder()
.type("type")
// the properties below are optional
.description("description")
.items(schemaDefinitionProperty_)
.properties(Map.of(
"propertiesKey", schemaDefinitionProperty_))
.required(List.of("required"))
.build())
.name("name")
// the properties below are optional
.outputSchema(SchemaDefinitionProperty.builder()
.type("type")
// the properties below are optional
.description("description")
.items(schemaDefinitionProperty_)
.properties(Map.of(
"propertiesKey", schemaDefinitionProperty_))
.required(List.of("required"))
.build())
.build()))
.s3(S3ConfigurationProperty.builder()
.bucketOwnerAccountId("bucketOwnerAccountId")
.uri("uri")
.build())
.build())
.build())
.mcpServer(McpServerTargetConfigurationProperty.builder()
.endpoint("endpoint")
// the properties below are optional
.listingMode("listingMode")
.mcpToolSchema(McpToolSchemaConfigurationProperty.builder()
.inlinePayload("inlinePayload")
.s3(S3ConfigurationProperty.builder()
.bucketOwnerAccountId("bucketOwnerAccountId")
.uri("uri")
.build())
.build())
.resourcePriority(123)
.build())
.openApiSchema(ApiSchemaConfigurationProperty.builder()
.inlinePayload("inlinePayload")
.s3(S3ConfigurationProperty.builder()
.bucketOwnerAccountId("bucketOwnerAccountId")
.uri("uri")
.build())
.build())
.smithyModel(ApiSchemaConfigurationProperty.builder()
.inlinePayload("inlinePayload")
.s3(S3ConfigurationProperty.builder()
.bucketOwnerAccountId("bucketOwnerAccountId")
.uri("uri")
.build())
.build())
.build())
.build())
// the properties below are optional
.certificateConfigurations(List.of(CertificateConfigurationProperty.builder()
.s3(S3CertificateConfigurationProperty.builder()
.uri("uri")
// the properties below are optional
.bucketOwnerAccountId("bucketOwnerAccountId")
.build())
.secretsManager(SecretsManagerCertificateConfigurationProperty.builder()
.secretArn("secretArn")
.build())
.build()))
.credentialProviderConfigurations(List.of(CredentialProviderConfigurationProperty.builder()
.credentialProviderType("credentialProviderType")
// the properties below are optional
.credentialProvider(CredentialProviderProperty.builder()
.apiKeyCredentialProvider(ApiKeyCredentialProviderProperty.builder()
.providerArn("providerArn")
// the properties below are optional
.credentialLocation("credentialLocation")
.credentialParameterName("credentialParameterName")
.credentialPrefix("credentialPrefix")
.build())
.iamCredentialProvider(IamCredentialProviderProperty.builder()
.service("service")
// the properties below are optional
.region("region")
.build())
.oauthCredentialProvider(OAuthCredentialProviderProperty.builder()
.providerArn("providerArn")
.scopes(List.of("scopes"))
// the properties below are optional
.customParameters(Map.of(
"customParametersKey", "customParameters"))
.defaultReturnUrl("defaultReturnUrl")
.grantType("grantType")
.build())
.build())
.build()))
.description("description")
.gatewayIdentifier("gatewayIdentifier")
.metadataConfiguration(MetadataConfigurationProperty.builder()
.allowedQueryParameters(List.of("allowedQueryParameters"))
.allowedRequestHeaders(List.of("allowedRequestHeaders"))
.allowedResponseHeaders(List.of("allowedResponseHeaders"))
.build())
.name("name")
.privateEndpoint(PrivateEndpointProperty.builder()
.managedVpcResource(ManagedVpcResourceProperty.builder()
.endpointIpAddressType("endpointIpAddressType")
.subnetIds(List.of("subnetIds"))
.vpcIdentifier("vpcIdentifier")
// the properties below are optional
.routingDomain("routingDomain")
.securityGroupIds(List.of("securityGroupIds"))
.tags(Map.of(
"tagsKey", "tags"))
.build())
.selfManagedLatticeResource(SelfManagedLatticeResourceProperty.builder()
.resourceConfigurationIdentifier("resourceConfigurationIdentifier")
.build())
.build())
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.BedrockAgentCore;
var parameterValues;
SchemaDefinitionProperty schemaDefinitionProperty_;
var cfnGatewayTargetProps = new CfnGatewayTargetProps {
TargetConfiguration = new TargetConfigurationProperty {
Http = new HttpTargetConfigurationProperty {
AgentcoreRuntime = new RuntimeTargetConfigurationProperty {
Arn = "arn",
// the properties below are optional
Qualifier = "qualifier",
Schema = new HttpApiSchemaConfigurationProperty {
Source = new ApiSchemaConfigurationProperty {
InlinePayload = "inlinePayload",
S3 = new S3ConfigurationProperty {
BucketOwnerAccountId = "bucketOwnerAccountId",
Uri = "uri"
}
}
}
},
Connector = new HttpConnectorTargetConfigurationProperty {
Source = new HttpConnectorSourceProperty {
ConnectorId = "connectorId"
},
// the properties below are optional
Parameters = new Dictionary<string, string> {
{ "parametersKey", "parameters" }
}
},
Passthrough = new PassthroughTargetConfigurationProperty {
Endpoint = "endpoint",
ProtocolType = "protocolType",
// the properties below are optional
Schema = new HttpApiSchemaConfigurationProperty {
Source = new ApiSchemaConfigurationProperty {
InlinePayload = "inlinePayload",
S3 = new S3ConfigurationProperty {
BucketOwnerAccountId = "bucketOwnerAccountId",
Uri = "uri"
}
}
},
StickinessConfiguration = new StickinessConfigurationProperty {
Identifier = "identifier",
// the properties below are optional
Timeout = 123
}
}
},
Inference = new InferenceTargetConfigurationProperty {
Connector = new InferenceConnectorTargetConfigurationProperty {
Source = new InferenceConnectorSourceProperty {
ConnectorId = "connectorId"
}
},
Provider = new InferenceProviderTargetConfigurationProperty {
Endpoint = "endpoint",
// the properties below are optional
ModelMapping = new ModelMappingProperty {
ProviderPrefix = new ProviderPrefixProperty {
Separator = "separator",
Strip = false
}
},
Operations = new [] { new InferenceOperationConfigurationProperty {
Path = "path",
// the properties below are optional
Models = new [] { new ModelEntryProperty {
Model = "model"
} },
ProviderPath = "providerPath"
} }
}
},
Mcp = new McpTargetConfigurationProperty {
ApiGateway = new ApiGatewayTargetConfigurationProperty {
ApiGatewayToolConfiguration = new ApiGatewayToolConfigurationProperty {
ToolFilters = new [] { new ApiGatewayToolFilterProperty {
FilterPath = "filterPath",
Methods = new [] { "methods" }
} },
// the properties below are optional
ToolOverrides = new [] { new ApiGatewayToolOverrideProperty {
Method = "method",
Name = "name",
Path = "path",
// the properties below are optional
Description = "description"
} }
},
RestApiId = "restApiId",
Stage = "stage"
},
Connector = new ConnectorTargetConfigurationProperty {
Source = new ConnectorSourceProperty {
ConnectorId = "connectorId"
},
// the properties below are optional
Configurations = new [] { new ConnectorConfigurationProperty {
Name = "name",
// the properties below are optional
Description = "description",
ParameterOverrides = new [] { new ConnectorParameterOverrideProperty {
Path = "path",
// the properties below are optional
Description = "description",
Visible = false
} },
ParameterValues = parameterValues
} },
Enabled = new [] { "enabled" }
},
Lambda = new McpLambdaTargetConfigurationProperty {
LambdaArn = "lambdaArn",
ToolSchema = new ToolSchemaProperty {
InlinePayload = new [] { new ToolDefinitionProperty {
Description = "description",
InputSchema = new SchemaDefinitionProperty {
Type = "type",
// the properties below are optional
Description = "description",
Items = schemaDefinitionProperty_,
Properties = new Dictionary<string, object> {
{ "propertiesKey", schemaDefinitionProperty_ }
},
Required = new [] { "required" }
},
Name = "name",
// the properties below are optional
OutputSchema = new SchemaDefinitionProperty {
Type = "type",
// the properties below are optional
Description = "description",
Items = schemaDefinitionProperty_,
Properties = new Dictionary<string, object> {
{ "propertiesKey", schemaDefinitionProperty_ }
},
Required = new [] { "required" }
}
} },
S3 = new S3ConfigurationProperty {
BucketOwnerAccountId = "bucketOwnerAccountId",
Uri = "uri"
}
}
},
McpServer = new McpServerTargetConfigurationProperty {
Endpoint = "endpoint",
// the properties below are optional
ListingMode = "listingMode",
McpToolSchema = new McpToolSchemaConfigurationProperty {
InlinePayload = "inlinePayload",
S3 = new S3ConfigurationProperty {
BucketOwnerAccountId = "bucketOwnerAccountId",
Uri = "uri"
}
},
ResourcePriority = 123
},
OpenApiSchema = new ApiSchemaConfigurationProperty {
InlinePayload = "inlinePayload",
S3 = new S3ConfigurationProperty {
BucketOwnerAccountId = "bucketOwnerAccountId",
Uri = "uri"
}
},
SmithyModel = new ApiSchemaConfigurationProperty {
InlinePayload = "inlinePayload",
S3 = new S3ConfigurationProperty {
BucketOwnerAccountId = "bucketOwnerAccountId",
Uri = "uri"
}
}
}
},
// the properties below are optional
CertificateConfigurations = new [] { new CertificateConfigurationProperty {
S3 = new S3CertificateConfigurationProperty {
Uri = "uri",
// the properties below are optional
BucketOwnerAccountId = "bucketOwnerAccountId"
},
SecretsManager = new SecretsManagerCertificateConfigurationProperty {
SecretArn = "secretArn"
}
} },
CredentialProviderConfigurations = new [] { new CredentialProviderConfigurationProperty {
CredentialProviderType = "credentialProviderType",
// the properties below are optional
CredentialProvider = new CredentialProviderProperty {
ApiKeyCredentialProvider = new ApiKeyCredentialProviderProperty {
ProviderArn = "providerArn",
// the properties below are optional
CredentialLocation = "credentialLocation",
CredentialParameterName = "credentialParameterName",
CredentialPrefix = "credentialPrefix"
},
IamCredentialProvider = new IamCredentialProviderProperty {
Service = "service",
// the properties below are optional
Region = "region"
},
OauthCredentialProvider = new OAuthCredentialProviderProperty {
ProviderArn = "providerArn",
Scopes = new [] { "scopes" },
// the properties below are optional
CustomParameters = new Dictionary<string, string> {
{ "customParametersKey", "customParameters" }
},
DefaultReturnUrl = "defaultReturnUrl",
GrantType = "grantType"
}
}
} },
Description = "description",
GatewayIdentifier = "gatewayIdentifier",
MetadataConfiguration = new MetadataConfigurationProperty {
AllowedQueryParameters = new [] { "allowedQueryParameters" },
AllowedRequestHeaders = new [] { "allowedRequestHeaders" },
AllowedResponseHeaders = new [] { "allowedResponseHeaders" }
},
Name = "name",
PrivateEndpoint = new PrivateEndpointProperty {
ManagedVpcResource = new ManagedVpcResourceProperty {
EndpointIpAddressType = "endpointIpAddressType",
SubnetIds = new [] { "subnetIds" },
VpcIdentifier = "vpcIdentifier",
// the properties below are optional
RoutingDomain = "routingDomain",
SecurityGroupIds = new [] { "securityGroupIds" },
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
}
},
SelfManagedLatticeResource = new SelfManagedLatticeResourceProperty {
ResourceConfigurationIdentifier = "resourceConfigurationIdentifier"
}
}
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/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/awscdk"
var parameterValues interface{}
var schemaDefinitionProperty_ SchemaDefinitionProperty
cfnGatewayTargetProps := &CfnGatewayTargetProps{
TargetConfiguration: &TargetConfigurationProperty{
Http: &HttpTargetConfigurationProperty{
AgentcoreRuntime: &RuntimeTargetConfigurationProperty{
Arn: jsii.String("arn"),
// the properties below are optional
Qualifier: jsii.String("qualifier"),
Schema: &HttpApiSchemaConfigurationProperty{
Source: &ApiSchemaConfigurationProperty{
InlinePayload: jsii.String("inlinePayload"),
S3: &S3ConfigurationProperty{
BucketOwnerAccountId: jsii.String("bucketOwnerAccountId"),
Uri: jsii.String("uri"),
},
},
},
},
Connector: &HttpConnectorTargetConfigurationProperty{
Source: &HttpConnectorSourceProperty{
ConnectorId: jsii.String("connectorId"),
},
// the properties below are optional
Parameters: map[string]*string{
"parametersKey": jsii.String("parameters"),
},
},
Passthrough: &PassthroughTargetConfigurationProperty{
Endpoint: jsii.String("endpoint"),
ProtocolType: jsii.String("protocolType"),
// the properties below are optional
Schema: &HttpApiSchemaConfigurationProperty{
Source: &ApiSchemaConfigurationProperty{
InlinePayload: jsii.String("inlinePayload"),
S3: &S3ConfigurationProperty{
BucketOwnerAccountId: jsii.String("bucketOwnerAccountId"),
Uri: jsii.String("uri"),
},
},
},
StickinessConfiguration: &StickinessConfigurationProperty{
Identifier: jsii.String("identifier"),
// the properties below are optional
Timeout: jsii.Number(123),
},
},
},
Inference: &InferenceTargetConfigurationProperty{
Connector: &InferenceConnectorTargetConfigurationProperty{
Source: &InferenceConnectorSourceProperty{
ConnectorId: jsii.String("connectorId"),
},
},
Provider: &InferenceProviderTargetConfigurationProperty{
Endpoint: jsii.String("endpoint"),
// the properties below are optional
ModelMapping: &ModelMappingProperty{
ProviderPrefix: &ProviderPrefixProperty{
Separator: jsii.String("separator"),
Strip: jsii.Boolean(false),
},
},
Operations: []interface{}{
&InferenceOperationConfigurationProperty{
Path: jsii.String("path"),
// the properties below are optional
Models: []interface{}{
&ModelEntryProperty{
Model: jsii.String("model"),
},
},
ProviderPath: jsii.String("providerPath"),
},
},
},
},
Mcp: &McpTargetConfigurationProperty{
ApiGateway: &ApiGatewayTargetConfigurationProperty{
ApiGatewayToolConfiguration: &ApiGatewayToolConfigurationProperty{
ToolFilters: []interface{}{
&ApiGatewayToolFilterProperty{
FilterPath: jsii.String("filterPath"),
Methods: []*string{
jsii.String("methods"),
},
},
},
// the properties below are optional
ToolOverrides: []interface{}{
&ApiGatewayToolOverrideProperty{
Method: jsii.String("method"),
Name: jsii.String("name"),
Path: jsii.String("path"),
// the properties below are optional
Description: jsii.String("description"),
},
},
},
RestApiId: jsii.String("restApiId"),
Stage: jsii.String("stage"),
},
Connector: &ConnectorTargetConfigurationProperty{
Source: &ConnectorSourceProperty{
ConnectorId: jsii.String("connectorId"),
},
// the properties below are optional
Configurations: []interface{}{
&ConnectorConfigurationProperty{
Name: jsii.String("name"),
// the properties below are optional
Description: jsii.String("description"),
ParameterOverrides: []interface{}{
&ConnectorParameterOverrideProperty{
Path: jsii.String("path"),
// the properties below are optional
Description: jsii.String("description"),
Visible: jsii.Boolean(false),
},
},
ParameterValues: parameterValues,
},
},
Enabled: []*string{
jsii.String("enabled"),
},
},
Lambda: &McpLambdaTargetConfigurationProperty{
LambdaArn: jsii.String("lambdaArn"),
ToolSchema: &ToolSchemaProperty{
InlinePayload: []interface{}{
&ToolDefinitionProperty{
Description: jsii.String("description"),
InputSchema: &SchemaDefinitionProperty{
Type: jsii.String("type"),
// the properties below are optional
Description: jsii.String("description"),
Items: schemaDefinitionProperty_,
Properties: map[string]interface{}{
"propertiesKey": schemaDefinitionProperty_,
},
Required: []*string{
jsii.String("required"),
},
},
Name: jsii.String("name"),
// the properties below are optional
OutputSchema: &SchemaDefinitionProperty{
Type: jsii.String("type"),
// the properties below are optional
Description: jsii.String("description"),
Items: schemaDefinitionProperty_,
Properties: map[string]interface{}{
"propertiesKey": schemaDefinitionProperty_,
},
Required: []*string{
jsii.String("required"),
},
},
},
},
S3: &S3ConfigurationProperty{
BucketOwnerAccountId: jsii.String("bucketOwnerAccountId"),
Uri: jsii.String("uri"),
},
},
},
McpServer: &McpServerTargetConfigurationProperty{
Endpoint: jsii.String("endpoint"),
// the properties below are optional
ListingMode: jsii.String("listingMode"),
McpToolSchema: &McpToolSchemaConfigurationProperty{
InlinePayload: jsii.String("inlinePayload"),
S3: &S3ConfigurationProperty{
BucketOwnerAccountId: jsii.String("bucketOwnerAccountId"),
Uri: jsii.String("uri"),
},
},
ResourcePriority: jsii.Number(123),
},
OpenApiSchema: &ApiSchemaConfigurationProperty{
InlinePayload: jsii.String("inlinePayload"),
S3: &S3ConfigurationProperty{
BucketOwnerAccountId: jsii.String("bucketOwnerAccountId"),
Uri: jsii.String("uri"),
},
},
SmithyModel: &ApiSchemaConfigurationProperty{
InlinePayload: jsii.String("inlinePayload"),
S3: &S3ConfigurationProperty{
BucketOwnerAccountId: jsii.String("bucketOwnerAccountId"),
Uri: jsii.String("uri"),
},
},
},
},
// the properties below are optional
CertificateConfigurations: []interface{}{
&CertificateConfigurationProperty{
S3: &S3CertificateConfigurationProperty{
Uri: jsii.String("uri"),
// the properties below are optional
BucketOwnerAccountId: jsii.String("bucketOwnerAccountId"),
},
SecretsManager: &SecretsManagerCertificateConfigurationProperty{
SecretArn: jsii.String("secretArn"),
},
},
},
CredentialProviderConfigurations: []interface{}{
&CredentialProviderConfigurationProperty{
CredentialProviderType: jsii.String("credentialProviderType"),
// the properties below are optional
CredentialProvider: &CredentialProviderProperty{
ApiKeyCredentialProvider: &ApiKeyCredentialProviderProperty{
ProviderArn: jsii.String("providerArn"),
// the properties below are optional
CredentialLocation: jsii.String("credentialLocation"),
CredentialParameterName: jsii.String("credentialParameterName"),
CredentialPrefix: jsii.String("credentialPrefix"),
},
IamCredentialProvider: &IamCredentialProviderProperty{
Service: jsii.String("service"),
// the properties below are optional
Region: jsii.String("region"),
},
OauthCredentialProvider: &OAuthCredentialProviderProperty{
ProviderArn: jsii.String("providerArn"),
Scopes: []*string{
jsii.String("scopes"),
},
// the properties below are optional
CustomParameters: map[string]*string{
"customParametersKey": jsii.String("customParameters"),
},
DefaultReturnUrl: jsii.String("defaultReturnUrl"),
GrantType: jsii.String("grantType"),
},
},
},
},
Description: jsii.String("description"),
GatewayIdentifier: jsii.String("gatewayIdentifier"),
MetadataConfiguration: &MetadataConfigurationProperty{
AllowedQueryParameters: []*string{
jsii.String("allowedQueryParameters"),
},
AllowedRequestHeaders: []*string{
jsii.String("allowedRequestHeaders"),
},
AllowedResponseHeaders: []*string{
jsii.String("allowedResponseHeaders"),
},
},
Name: jsii.String("name"),
PrivateEndpoint: &PrivateEndpointProperty{
ManagedVpcResource: &ManagedVpcResourceProperty{
EndpointIpAddressType: jsii.String("endpointIpAddressType"),
SubnetIds: []*string{
jsii.String("subnetIds"),
},
VpcIdentifier: jsii.String("vpcIdentifier"),
// the properties below are optional
RoutingDomain: jsii.String("routingDomain"),
SecurityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
},
SelfManagedLatticeResource: &SelfManagedLatticeResourceProperty{
ResourceConfigurationIdentifier: jsii.String("resourceConfigurationIdentifier"),
},
},
}
Properties
certificateConfigurationsoptionalIResolvable | IResolvable | CfnGatewayTarget.certificate_configurationsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, CertificateConfigurationProperty]]]certificateConfigurationsoptionalIResolvableCertificateConfigurationsoptionalIResolvableCertificateConfigurationsoptionalinterface{} #credentialProviderConfigurationsoptionalIResolvable | IResolvable | CfnGatewayTarget.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.metadata_configurationoptionaltyping.Union[IResolvable, MetadataConfigurationProperty]metadataConfigurationoptionalIResolvableMetadataConfigurationoptionalIResolvableMetadataConfigurationoptionalinterface{} #The name for the gateway target.
privateEndpointoptionalIResolvable | CfnGatewayTarget.private_endpointoptionaltyping.Union[IResolvable, PrivateEndpointProperty]privateEndpointoptionalIResolvablePrivateEndpointoptionalIResolvablePrivateEndpointoptionalinterface{} #targetConfigurationIResolvable | CfnGatewayTarget.target_configurationtyping.Union[IResolvable, TargetConfigurationProperty]targetConfigurationIResolvableTargetConfigurationIResolvableTargetConfigurationinterface{} required #The target configuration for the Smithy model target.