Interface CfnHarnessProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnHarnessProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.133.0 (build 0f43e37)",
date="2026-06-08T20:22:39.859Z")
@Stability(Stable)
public interface CfnHarnessProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnHarness.
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.*;
Object awsIam;
Object inputSchema;
Object none;
CfnHarnessProps cfnHarnessProps = CfnHarnessProps.builder()
.executionRoleArn("executionRoleArn")
.harnessName("harnessName")
.model(HarnessModelConfigurationProperty.builder()
.bedrockModelConfig(HarnessBedrockModelConfigProperty.builder()
.modelId("modelId")
// the properties below are optional
.maxTokens(123)
.temperature(123)
.topP(123)
.build())
.geminiModelConfig(HarnessGeminiModelConfigProperty.builder()
.apiKeyArn("apiKeyArn")
.modelId("modelId")
// the properties below are optional
.maxTokens(123)
.temperature(123)
.topK(123)
.topP(123)
.build())
.openAiModelConfig(HarnessOpenAiModelConfigProperty.builder()
.apiKeyArn("apiKeyArn")
.modelId("modelId")
// the properties below are optional
.maxTokens(123)
.temperature(123)
.topP(123)
.build())
.build())
// the properties below are optional
.allowedTools(List.of("allowedTools"))
.authorizerConfiguration(AuthorizerConfigurationProperty.builder()
.customJwtAuthorizer(CustomJWTAuthorizerConfigurationProperty.builder()
.discoveryUrl("discoveryUrl")
// the properties below are optional
.allowedAudience(List.of("allowedAudience"))
.allowedClients(List.of("allowedClients"))
.allowedScopes(List.of("allowedScopes"))
.customClaims(List.of(CustomClaimValidationTypeProperty.builder()
.authorizingClaimMatchValue(AuthorizingClaimMatchValueTypeProperty.builder()
.claimMatchOperator("claimMatchOperator")
.claimMatchValue(ClaimMatchValueTypeProperty.builder()
.matchValueString("matchValueString")
.matchValueStringList(List.of("matchValueStringList"))
.build())
.build())
.inboundTokenClaimName("inboundTokenClaimName")
.inboundTokenClaimValueType("inboundTokenClaimValueType")
.build()))
.build())
.build())
.environment(HarnessEnvironmentProviderProperty.builder()
.agentCoreRuntimeEnvironment(HarnessAgentCoreRuntimeEnvironmentProperty.builder()
.agentRuntimeArn("agentRuntimeArn")
.agentRuntimeId("agentRuntimeId")
.agentRuntimeName("agentRuntimeName")
.filesystemConfigurations(List.of(FilesystemConfigurationProperty.builder()
.sessionStorage(SessionStorageConfigurationProperty.builder()
.mountPath("mountPath")
.build())
.build()))
.lifecycleConfiguration(LifecycleConfigurationProperty.builder()
.idleRuntimeSessionTimeout(123)
.maxLifetime(123)
.build())
.networkConfiguration(NetworkConfigurationProperty.builder()
.networkMode("networkMode")
// the properties below are optional
.networkModeConfig(VpcConfigProperty.builder()
.securityGroups(List.of("securityGroups"))
.subnets(List.of("subnets"))
.build())
.build())
.build())
.build())
.environmentArtifact(HarnessEnvironmentArtifactProperty.builder()
.containerConfiguration(ContainerConfigurationProperty.builder()
.containerUri("containerUri")
.build())
.build())
.environmentVariables(Map.of(
"environmentVariablesKey", "environmentVariables"))
.maxIterations(123)
.maxTokens(123)
.memory(HarnessMemoryConfigurationProperty.builder()
.agentCoreMemoryConfiguration(HarnessAgentCoreMemoryConfigurationProperty.builder()
.arn("arn")
// the properties below are optional
.actorId("actorId")
.messagesCount(123)
.retrievalConfig(Map.of(
"retrievalConfigKey", HarnessAgentCoreMemoryRetrievalConfigProperty.builder()
.relevanceScore(123)
.strategyId("strategyId")
.topK(123)
.build()))
.build())
.build())
.skills(List.of(HarnessSkillProperty.builder()
.path("path")
.build()))
.systemPrompt(List.of(HarnessSystemContentBlockProperty.builder()
.text("text")
.build()))
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.timeoutSeconds(123)
.tools(List.of(HarnessToolProperty.builder()
.type("type")
// the properties below are optional
.config(HarnessToolConfigurationProperty.builder()
.agentCoreBrowser(HarnessAgentCoreBrowserConfigProperty.builder()
.browserArn("browserArn")
.build())
.agentCoreCodeInterpreter(HarnessAgentCoreCodeInterpreterConfigProperty.builder()
.codeInterpreterArn("codeInterpreterArn")
.build())
.agentCoreGateway(HarnessAgentCoreGatewayConfigProperty.builder()
.gatewayArn("gatewayArn")
// the properties below are optional
.outboundAuth(HarnessGatewayOutboundAuthProperty.builder()
.awsIam(awsIam)
.none(none)
.oauth(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())
.inlineFunction(HarnessInlineFunctionConfigProperty.builder()
.description("description")
.inputSchema(inputSchema)
.build())
.remoteMcp(HarnessRemoteMcpConfigProperty.builder()
.url("url")
// the properties below are optional
.headers(Map.of(
"headersKey", "headers"))
.build())
.build())
.name("name")
.build()))
.truncation(HarnessTruncationConfigurationProperty.builder()
.strategy("strategy")
// the properties below are optional
.config(HarnessTruncationStrategyConfigurationProperty.builder()
.slidingWindow(HarnessSlidingWindowConfigurationProperty.builder()
.messagesCount(123)
.build())
.summarization(HarnessSummarizationConfigurationProperty.builder()
.preserveRecentMessages(123)
.summarizationSystemPrompt("summarizationSystemPrompt")
.summaryRatio(123)
.build())
.build())
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnHarnessPropsstatic final classAn implementation forCfnHarnessProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnHarnessProps.Builderbuilder()The tools that the agent is allowed to use.default ObjectReturns union: eitherIResolvableorCfnHarness.AuthorizerConfigurationPropertydefault ObjectReturns union: eitherIResolvableorCfnHarness.HarnessEnvironmentProviderPropertydefault ObjectReturns union: eitherIResolvableorCfnHarness.HarnessEnvironmentArtifactPropertydefault ObjectEnvironment variables to set in the harness runtime environment.The ARN of the IAM role that the harness assumes when running.The name of the harness.default NumberThe maximum number of iterations the agent loop can execute per invocation.default NumberThe maximum number of tokens the agent can generate per iteration.default ObjectReturns union: eitherIResolvableorCfnHarness.HarnessMemoryConfigurationPropertygetModel()Returns union: eitherIResolvableorCfnHarness.HarnessModelConfigurationPropertydefault ObjectThe skills available to the agent.default ObjectThe system prompt that defines the agent's behavior.getTags()Tags to apply to the harness resource.default NumberThe maximum duration in seconds for the agent loop execution per invocation.default ObjectgetTools()The tools available to the agent.default ObjectReturns union: eitherIResolvableorCfnHarness.HarnessTruncationConfigurationPropertyMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getExecutionRoleArn
The ARN of the IAM role that the harness assumes when running.- See Also:
-
getHarnessName
The name of the harness.- See Also:
-
getModel
Returns union: eitherIResolvableorCfnHarness.HarnessModelConfigurationProperty- See Also:
-
getAllowedTools
The tools that the agent is allowed to use.- See Also:
-
getAuthorizerConfiguration
Returns union: eitherIResolvableorCfnHarness.AuthorizerConfigurationProperty- See Also:
-
getEnvironment
Returns union: eitherIResolvableorCfnHarness.HarnessEnvironmentProviderProperty- See Also:
-
getEnvironmentArtifact
Returns union: eitherIResolvableorCfnHarness.HarnessEnvironmentArtifactProperty- See Also:
-
getEnvironmentVariables
Environment variables to set in the harness runtime environment.Returns union: either
IResolvableor Mapinvalid input: '<'String,String>- See Also:
-
getMaxIterations
The maximum number of iterations the agent loop can execute per invocation.- See Also:
-
getMaxTokens
The maximum number of tokens the agent can generate per iteration.- See Also:
-
getMemory
Returns union: eitherIResolvableorCfnHarness.HarnessMemoryConfigurationProperty- See Also:
-
getSkills
The skills available to the agent.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnHarness.HarnessSkillProperty>- See Also:
-
getSystemPrompt
The system prompt that defines the agent's behavior.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnHarness.HarnessSystemContentBlockProperty>- See Also:
-
getTags
Tags to apply to the harness resource.- See Also:
-
getTimeoutSeconds
The maximum duration in seconds for the agent loop execution per invocation.- See Also:
-
getTools
The tools available to the agent.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnHarness.HarnessToolProperty>- See Also:
-
getTruncation
Returns union: eitherIResolvableorCfnHarness.HarnessTruncationConfigurationProperty- See Also:
-
builder
- Returns:
- a
CfnHarnessProps.BuilderofCfnHarnessProps
-