Interface CfnGatewayTargetProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnGatewayTargetProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
date="2025-12-05T10:47:14.940Z")
@Stability(Stable)
public interface CfnGatewayTargetProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnGatewayTarget.
Example:
// 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.*;
SchemaDefinitionProperty schemaDefinitionProperty_;
CfnGatewayTargetProps cfnGatewayTargetProps = CfnGatewayTargetProps.builder()
.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())
.oauthCredentialProvider(OAuthCredentialProviderProperty.builder()
.providerArn("providerArn")
.scopes(List.of("scopes"))
// the properties below are optional
.customParameters(Map.of(
"customParametersKey", "customParameters"))
.build())
.build())
.build()))
.name("name")
.targetConfiguration(TargetConfigurationProperty.builder()
.mcp(McpTargetConfigurationProperty.builder()
.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")
.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
.description("description")
.gatewayIdentifier("gatewayIdentifier")
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnGatewayTargetPropsstatic final classAn implementation forCfnGatewayTargetProps -
Method Summary
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getCredentialProviderConfigurations
The OAuth credential provider configuration.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnGatewayTarget.CredentialProviderConfigurationProperty>- See Also:
-
getName
The name for the gateway target.- See Also:
-
getTargetConfiguration
The target configuration for the Smithy model target.Returns union: either
IResolvableorCfnGatewayTarget.TargetConfigurationProperty- See Also:
-
getDescription
The description for the gateway target.- See Also:
-
getGatewayIdentifier
The gateway ID for the gateway target.- See Also:
-
builder
- Returns:
- a
CfnGatewayTargetProps.BuilderofCfnGatewayTargetProps
-