CfnHarness
- class aws_cdk.aws_bedrockagentcore.CfnHarness(scope, id, *, execution_role_arn, harness_name, model, allowed_tools=None, authorizer_configuration=None, environment=None, environment_artifact=None, environment_variables=None, max_iterations=None, max_tokens=None, memory=None, skills=None, system_prompt=None, tags=None, timeout_seconds=None, tools=None, truncation=None)
Bases:
CfnResourceResource Type definition for AWS::BedrockAgentCore::Harness - a managed agentic loop service that provides a turnkey solution for running stateful, tool-equipped AI agents.
- See:
- CloudformationResource:
AWS::BedrockAgentCore::Harness
- ExampleMetadata:
fixture=_generated
Example:
from aws_cdk import CfnTag # 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 # aws_iam: Any # disabled: Any # input_schema: Any # none: Any cfn_harness = bedrockagentcore.CfnHarness(self, "MyCfnHarness", execution_role_arn="executionRoleArn", harness_name="harnessName", model=bedrockagentcore.CfnHarness.HarnessModelConfigurationProperty( bedrock_model_config=bedrockagentcore.CfnHarness.HarnessBedrockModelConfigProperty( model_id="modelId", # the properties below are optional api_format="apiFormat", max_tokens=123, temperature=123, top_p=123 ), gemini_model_config=bedrockagentcore.CfnHarness.HarnessGeminiModelConfigProperty( api_key_arn="apiKeyArn", model_id="modelId", # the properties below are optional max_tokens=123, temperature=123, top_k=123, top_p=123 ), lite_llm_model_config=bedrockagentcore.CfnHarness.HarnessLiteLlmModelConfigProperty( model_id="modelId", # the properties below are optional api_base="apiBase", api_key_arn="apiKeyArn", max_tokens=123, temperature=123, top_p=123 ), open_ai_model_config=bedrockagentcore.CfnHarness.HarnessOpenAiModelConfigProperty( api_key_arn="apiKeyArn", model_id="modelId", # the properties below are optional api_format="apiFormat", max_tokens=123, temperature=123, top_p=123 ) ), # the properties below are optional allowed_tools=["allowedTools"], authorizer_configuration=bedrockagentcore.CfnHarness.AuthorizerConfigurationProperty( custom_jwt_authorizer=bedrockagentcore.CfnHarness.CustomJWTAuthorizerConfigurationProperty( discovery_url="discoveryUrl", # the properties below are optional allowed_audience=["allowedAudience"], allowed_clients=["allowedClients"], allowed_scopes=["allowedScopes"], custom_claims=[bedrockagentcore.CfnHarness.CustomClaimValidationTypeProperty( authorizing_claim_match_value=bedrockagentcore.CfnHarness.AuthorizingClaimMatchValueTypeProperty( claim_match_operator="claimMatchOperator", claim_match_value=bedrockagentcore.CfnHarness.ClaimMatchValueTypeProperty( match_value_string="matchValueString", match_value_string_list=["matchValueStringList"] ) ), inbound_token_claim_name="inboundTokenClaimName", inbound_token_claim_value_type="inboundTokenClaimValueType" )], private_endpoint=bedrockagentcore.CfnHarness.PrivateEndpointProperty( managed_vpc_resource=bedrockagentcore.CfnHarness.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.CfnHarness.SelfManagedLatticeResourceProperty( resource_configuration_identifier="resourceConfigurationIdentifier" ) ), private_endpoint_overrides=[bedrockagentcore.CfnHarness.PrivateEndpointOverrideProperty( domain="domain", private_endpoint=bedrockagentcore.CfnHarness.PrivateEndpointProperty( managed_vpc_resource=bedrockagentcore.CfnHarness.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.CfnHarness.SelfManagedLatticeResourceProperty( resource_configuration_identifier="resourceConfigurationIdentifier" ) ) )] ) ), environment=bedrockagentcore.CfnHarness.HarnessEnvironmentProviderProperty( agent_core_runtime_environment=bedrockagentcore.CfnHarness.HarnessAgentCoreRuntimeEnvironmentProperty( agent_runtime_arn="agentRuntimeArn", agent_runtime_id="agentRuntimeId", agent_runtime_name="agentRuntimeName", filesystem_configurations=[bedrockagentcore.CfnHarness.FilesystemConfigurationProperty( efs_access_point=bedrockagentcore.CfnHarness.EfsAccessPointConfigurationProperty( access_point_arn="accessPointArn", mount_path="mountPath" ), s3_files_access_point=bedrockagentcore.CfnHarness.S3FilesAccessPointConfigurationProperty( access_point_arn="accessPointArn", mount_path="mountPath" ), session_storage=bedrockagentcore.CfnHarness.SessionStorageConfigurationProperty( mount_path="mountPath" ) )], lifecycle_configuration=bedrockagentcore.CfnHarness.LifecycleConfigurationProperty( idle_runtime_session_timeout=123, max_lifetime=123 ), network_configuration=bedrockagentcore.CfnHarness.NetworkConfigurationProperty( network_mode="networkMode", # the properties below are optional network_mode_config=bedrockagentcore.CfnHarness.VpcConfigProperty( security_groups=["securityGroups"], subnets=["subnets"] ) ) ) ), environment_artifact=bedrockagentcore.CfnHarness.HarnessEnvironmentArtifactProperty( container_configuration=bedrockagentcore.CfnHarness.ContainerConfigurationProperty( container_uri="containerUri" ) ), environment_variables={ "environment_variables_key": "environmentVariables" }, max_iterations=123, max_tokens=123, memory=bedrockagentcore.CfnHarness.HarnessMemoryConfigurationProperty( agent_core_memory_configuration=bedrockagentcore.CfnHarness.HarnessAgentCoreMemoryConfigurationProperty( arn="arn", # the properties below are optional actor_id="actorId", messages_count=123, retrieval_config={ "retrieval_config_key": bedrockagentcore.CfnHarness.HarnessAgentCoreMemoryRetrievalConfigProperty( relevance_score="relevanceScore", strategy_id="strategyId", top_k="topK" ) } ), disabled=disabled, managed_memory_configuration=bedrockagentcore.CfnHarness.HarnessManagedMemoryConfigurationProperty( arn="arn", encryption_key_arn="encryptionKeyArn", event_expiry_duration=123, strategies=["strategies"] ) ), skills=[bedrockagentcore.CfnHarness.HarnessSkillProperty( aws_skills=bedrockagentcore.CfnHarness.HarnessSkillAwsSkillsSourceProperty( paths=["paths"] ), git=bedrockagentcore.CfnHarness.HarnessSkillGitSourceProperty( url="url", # the properties below are optional auth=bedrockagentcore.CfnHarness.HarnessSkillGitAuthProperty( credential_arn="credentialArn", # the properties below are optional username="username" ), path="path" ), path="path", s3=bedrockagentcore.CfnHarness.HarnessSkillS3SourceProperty( uri="uri" ) )], system_prompt=[bedrockagentcore.CfnHarness.HarnessSystemContentBlockProperty( text="text" )], tags=[CfnTag( key="key", value="value" )], timeout_seconds=123, tools=[bedrockagentcore.CfnHarness.HarnessToolProperty( type="type", # the properties below are optional config=bedrockagentcore.CfnHarness.HarnessToolConfigurationProperty( agent_core_browser=bedrockagentcore.CfnHarness.HarnessAgentCoreBrowserConfigProperty( browser_arn="browserArn" ), agent_core_code_interpreter=bedrockagentcore.CfnHarness.HarnessAgentCoreCodeInterpreterConfigProperty( code_interpreter_arn="codeInterpreterArn" ), agent_core_gateway=bedrockagentcore.CfnHarness.HarnessAgentCoreGatewayConfigProperty( gateway_arn="gatewayArn", # the properties below are optional outbound_auth=bedrockagentcore.CfnHarness.HarnessGatewayOutboundAuthProperty( aws_iam=aws_iam, none=none, oauth=bedrockagentcore.CfnHarness.OAuthCredentialProviderProperty( provider_arn="providerArn", scopes=["scopes"], # the properties below are optional custom_parameters={ "custom_parameters_key": "customParameters" }, default_return_url="defaultReturnUrl", grant_type="grantType" ) ) ), inline_function=bedrockagentcore.CfnHarness.HarnessInlineFunctionConfigProperty( description="description", input_schema=input_schema ), remote_mcp=bedrockagentcore.CfnHarness.HarnessRemoteMcpConfigProperty( url="url", # the properties below are optional headers={ "headers_key": "headers" } ) ), name="name" )], truncation=bedrockagentcore.CfnHarness.HarnessTruncationConfigurationProperty( strategy="strategy", # the properties below are optional config=bedrockagentcore.CfnHarness.HarnessTruncationStrategyConfigurationProperty( sliding_window=bedrockagentcore.CfnHarness.HarnessSlidingWindowConfigurationProperty( messages_count=123 ), summarization=bedrockagentcore.CfnHarness.HarnessSummarizationConfigurationProperty( preserve_recent_messages=123, summarization_system_prompt="summarizationSystemPrompt", summary_ratio=123 ) ) ) )
Create a new
AWS::BedrockAgentCore::Harness.- Parameters:
scope (
Construct) – Scope in which this resource is defined.id (
str) – Construct identifier for this resource (unique in its scope).execution_role_arn (
str) – The ARN of the IAM role that the harness assumes when running.harness_name (
str) – The name of the harness.model (
Union[IResolvable,HarnessModelConfigurationProperty,Dict[str,Any]])allowed_tools (
Optional[Sequence[str]]) – The tools that the agent is allowed to use.authorizer_configuration (
Union[IResolvable,AuthorizerConfigurationProperty,Dict[str,Any],None])environment (
Union[IResolvable,HarnessEnvironmentProviderProperty,Dict[str,Any],None])environment_artifact (
Union[IResolvable,HarnessEnvironmentArtifactProperty,Dict[str,Any],None])environment_variables (
Union[IResolvable,Mapping[str,str],None]) – Environment variables to set in the harness runtime environment.max_iterations (
Union[int,float,None]) – The maximum number of iterations the agent loop can execute per invocation.max_tokens (
Union[int,float,None]) – The maximum number of tokens the agent can generate per iteration.memory (
Union[IResolvable,HarnessMemoryConfigurationProperty,Dict[str,Any],None])skills (
Union[IResolvable,Sequence[Union[IResolvable,HarnessSkillProperty,Dict[str,Any]]],None]) – The skills available to the agent.system_prompt (
Union[IResolvable,Sequence[Union[IResolvable,HarnessSystemContentBlockProperty,Dict[str,Any]]],None]) – The system prompt that defines the agent’s behavior.tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – Tags to apply to the harness resource.timeout_seconds (
Union[int,float,None]) – The maximum duration in seconds for the agent loop execution per invocation.tools (
Union[IResolvable,Sequence[Union[IResolvable,HarnessToolProperty,Dict[str,Any]]],None]) – The tools available to the agent.truncation (
Union[IResolvable,HarnessTruncationConfigurationProperty,Dict[str,Any],None])
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined).- Parameters:
path (
str) – The path of the value to delete.- Return type:
None
- add_dependency(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource)- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource)- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str)value (
Any)
- See:
- Return type:
None
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “Properties.” (i.e.Properties.TopicName).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.in the property name, prefix with a\. In most programming languages you will need to write this as"\\."because the\itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
valueargument toaddOverridewill not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value).- Parameters:
property_path (
str) – The path of the property.value (
Any) – The value.
- Return type:
None
- apply_cross_stack_reference_strength(strength)
Sets the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack’s context.
- Parameters:
strength (
ReferenceStrength) –The reference strength to use for this resource.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional[RemovalPolicy])apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- cfn_property_name(cdk_property_name)
- Parameters:
cdk_property_name (
str)- Return type:
Optional[str]
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str) – The name of the attribute.type_hint (
Optional[ResolutionTypeHint])
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str)- See:
- Return type:
Any
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List[Union[CfnResource,Stack]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List[CfnResource]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource)- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource) – The dependency to replace.new_target (
CfnResource) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str- Returns:
a string representation of this resource
- with_(*mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple
with()calls if subsequent mixins should apply to added constructs.- Parameters:
mixins (
IMixin)- Return type:
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::BedrockAgentCore::Harness'
- allowed_tools
The tools that the agent is allowed to use.
- attr_arn
The Amazon Resource Name (ARN) of the harness.
- CloudformationAttribute:
Arn
- attr_created_at
The timestamp when the harness was created.
- CloudformationAttribute:
CreatedAt
- attr_environment_agent_core_runtime_environment_agent_runtime_arn
The ARN of the underlying AgentCore Runtime.
- CloudformationAttribute:
Environment.AgentCoreRuntimeEnvironment.AgentRuntimeArn
- attr_environment_agent_core_runtime_environment_agent_runtime_id
The ID of the underlying AgentCore Runtime.
- CloudformationAttribute:
Environment.AgentCoreRuntimeEnvironment.AgentRuntimeId
- attr_environment_agent_core_runtime_environment_agent_runtime_name
The name of the underlying AgentCore Runtime.
- CloudformationAttribute:
Environment.AgentCoreRuntimeEnvironment.AgentRuntimeName
- attr_harness_id
The unique identifier of the harness.
- CloudformationAttribute:
HarnessId
- attr_memory_managed_memory_configuration_arn
The ARN of the managed memory resource.
Read-only, populated by the service.
- CloudformationAttribute:
Memory.ManagedMemoryConfiguration.Arn
- attr_status
Status
- Type:
cloudformationAttribute
- attr_updated_at
The timestamp when the harness was last updated.
- CloudformationAttribute:
UpdatedAt
- attr_version
The version of the harness.
Incremented on every successful update.
- CloudformationAttribute:
Version
- authorizer_configuration
- cdk_tag_manager
Tag Manager which manages the tags for this resource.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- env
- environment
- environment_artifact
- environment_variables
Environment variables to set in the harness runtime environment.
- execution_role_arn
The ARN of the IAM role that the harness assumes when running.
- harness_name
The name of the harness.
- harness_ref
A reference to a Harness resource.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- max_iterations
The maximum number of iterations the agent loop can execute per invocation.
- max_tokens
The maximum number of tokens the agent can generate per iteration.
- memory
- model
- node
The tree node.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref }).
- skills
The skills available to the agent.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- system_prompt
The system prompt that defines the agent’s behavior.
- tags
Tags to apply to the harness resource.
- timeout_seconds
The maximum duration in seconds for the agent loop execution per invocation.
- tools
The tools available to the agent.
- truncation
Static Methods
- classmethod arn_for_harness(resource)
- Parameters:
resource (
IHarnessRef)- Return type:
str
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any)- Return type:
bool- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_harness(x)
Checks whether the given object is a CfnHarness.
- Parameters:
x (
Any)- Return type:
bool
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any)- Return type:
bool
- classmethod is_construct(x)
Checks if
xis a construct.Use this method instead of
instanceofto properly detectConstructinstances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructslibrary on disk are seen as independent, completely different libraries. As a consequence, the classConstructin each copy of theconstructslibrary is seen as a different class, and an instance of one class will not test asinstanceofthe other class.npm installwill not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructslibrary can be accidentally installed, andinstanceofwill behave unpredictably. It is safest to avoid usinginstanceof, and using this type-testing method instead.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsConstruct.
ClaimMatchValueTypeProperty
- class CfnHarness.ClaimMatchValueTypeProperty(*, match_value_string=None, match_value_string_list=None)
Bases:
object- Parameters:
match_value_string (
Optional[str])match_value_string_list (
Optional[Sequence[str]])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 claim_match_value_type_property = bedrockagentcore.CfnHarness.ClaimMatchValueTypeProperty( match_value_string="matchValueString", match_value_string_list=["matchValueStringList"] )
Attributes
- match_value_string
-
- Type:
see
ContainerConfigurationProperty
- class CfnHarness.ContainerConfigurationProperty(*, container_uri)
Bases:
object- Parameters:
container_uri (
str) – The ECR URI of the container.- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 container_configuration_property = bedrockagentcore.CfnHarness.ContainerConfigurationProperty( container_uri="containerUri" )
Attributes
- container_uri
The ECR URI of the container.
CustomClaimValidationTypeProperty
- class CfnHarness.CustomClaimValidationTypeProperty(*, authorizing_claim_match_value, inbound_token_claim_name, inbound_token_claim_value_type)
Bases:
object- Parameters:
authorizing_claim_match_value (
Union[IResolvable,AuthorizingClaimMatchValueTypeProperty,Dict[str,Any]])inbound_token_claim_name (
str)inbound_token_claim_value_type (
str)
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 custom_claim_validation_type_property = bedrockagentcore.CfnHarness.CustomClaimValidationTypeProperty( authorizing_claim_match_value=bedrockagentcore.CfnHarness.AuthorizingClaimMatchValueTypeProperty( claim_match_operator="claimMatchOperator", claim_match_value=bedrockagentcore.CfnHarness.ClaimMatchValueTypeProperty( match_value_string="matchValueString", match_value_string_list=["matchValueStringList"] ) ), inbound_token_claim_name="inboundTokenClaimName", inbound_token_claim_value_type="inboundTokenClaimValueType" )
Attributes
- authorizing_claim_match_value
-
- Type:
see
- inbound_token_claim_name
-
- Type:
see
EfsAccessPointConfigurationProperty
- class CfnHarness.EfsAccessPointConfigurationProperty(*, access_point_arn, mount_path)
Bases:
objectConfiguration for an Amazon EFS access point to mount into the AgentCore Runtime.
- Parameters:
access_point_arn (
str)mount_path (
str)
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 efs_access_point_configuration_property = bedrockagentcore.CfnHarness.EfsAccessPointConfigurationProperty( access_point_arn="accessPointArn", mount_path="mountPath" )
Attributes
- access_point_arn
-
- Type:
see
FilesystemConfigurationProperty
- class CfnHarness.FilesystemConfigurationProperty(*, efs_access_point=None, s3_files_access_point=None, session_storage=None)
Bases:
object- Parameters:
efs_access_point (
Union[IResolvable,EfsAccessPointConfigurationProperty,Dict[str,Any],None]) – Configuration for an Amazon EFS access point to mount into the AgentCore Runtime.s3_files_access_point (
Union[IResolvable,S3FilesAccessPointConfigurationProperty,Dict[str,Any],None]) – Configuration for an Amazon S3 Files access point to mount into the AgentCore Runtime.session_storage (
Union[IResolvable,SessionStorageConfigurationProperty,Dict[str,Any],None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 filesystem_configuration_property = bedrockagentcore.CfnHarness.FilesystemConfigurationProperty( efs_access_point=bedrockagentcore.CfnHarness.EfsAccessPointConfigurationProperty( access_point_arn="accessPointArn", mount_path="mountPath" ), s3_files_access_point=bedrockagentcore.CfnHarness.S3FilesAccessPointConfigurationProperty( access_point_arn="accessPointArn", mount_path="mountPath" ), session_storage=bedrockagentcore.CfnHarness.SessionStorageConfigurationProperty( mount_path="mountPath" ) )
Attributes
- efs_access_point
Configuration for an Amazon EFS access point to mount into the AgentCore Runtime.
- s3_files_access_point
Configuration for an Amazon S3 Files access point to mount into the AgentCore Runtime.
HarnessAgentCoreBrowserConfigProperty
- class CfnHarness.HarnessAgentCoreBrowserConfigProperty(*, browser_arn=None)
Bases:
object- Parameters:
browser_arn (
Optional[str])- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 harness_agent_core_browser_config_property = bedrockagentcore.CfnHarness.HarnessAgentCoreBrowserConfigProperty( browser_arn="browserArn" )
Attributes
HarnessAgentCoreCodeInterpreterConfigProperty
- class CfnHarness.HarnessAgentCoreCodeInterpreterConfigProperty(*, code_interpreter_arn=None)
Bases:
object- Parameters:
code_interpreter_arn (
Optional[str])- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 harness_agent_core_code_interpreter_config_property = bedrockagentcore.CfnHarness.HarnessAgentCoreCodeInterpreterConfigProperty( code_interpreter_arn="codeInterpreterArn" )
Attributes
HarnessAgentCoreGatewayConfigProperty
- class CfnHarness.HarnessAgentCoreGatewayConfigProperty(*, gateway_arn, outbound_auth=None)
Bases:
object- Parameters:
gateway_arn (
str)outbound_auth (
Union[IResolvable,HarnessGatewayOutboundAuthProperty,Dict[str,Any],None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 # aws_iam: Any # none: Any harness_agent_core_gateway_config_property = bedrockagentcore.CfnHarness.HarnessAgentCoreGatewayConfigProperty( gateway_arn="gatewayArn", # the properties below are optional outbound_auth=bedrockagentcore.CfnHarness.HarnessGatewayOutboundAuthProperty( aws_iam=aws_iam, none=none, oauth=bedrockagentcore.CfnHarness.OAuthCredentialProviderProperty( provider_arn="providerArn", scopes=["scopes"], # the properties below are optional custom_parameters={ "custom_parameters_key": "customParameters" }, default_return_url="defaultReturnUrl", grant_type="grantType" ) ) )
Attributes
- gateway_arn
-
- Type:
see
HarnessAgentCoreMemoryConfigurationProperty
- class CfnHarness.HarnessAgentCoreMemoryConfigurationProperty(*, arn, actor_id=None, messages_count=None, retrieval_config=None)
Bases:
object- Parameters:
arn (
str)actor_id (
Optional[str])messages_count (
Union[int,float,None])retrieval_config (
Union[IResolvable,Mapping[str,Union[IResolvable,HarnessAgentCoreMemoryRetrievalConfigProperty,Dict[str,Any]]],None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 harness_agent_core_memory_configuration_property = bedrockagentcore.CfnHarness.HarnessAgentCoreMemoryConfigurationProperty( arn="arn", # the properties below are optional actor_id="actorId", messages_count=123, retrieval_config={ "retrieval_config_key": bedrockagentcore.CfnHarness.HarnessAgentCoreMemoryRetrievalConfigProperty( relevance_score="relevanceScore", strategy_id="strategyId", top_k="topK" ) } )
Attributes
- actor_id
-
- Type:
see
- arn
-
- Type:
see
- messages_count
-
- Type:
see
HarnessAgentCoreMemoryRetrievalConfigProperty
- class CfnHarness.HarnessAgentCoreMemoryRetrievalConfigProperty(*, relevance_score=None, strategy_id=None, top_k=None)
Bases:
object- Parameters:
relevance_score (
Union[str,int,float,IResolvable,None])strategy_id (
Optional[str])top_k (
Union[str,int,float,IResolvable,None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 harness_agent_core_memory_retrieval_config_property = bedrockagentcore.CfnHarness.HarnessAgentCoreMemoryRetrievalConfigProperty( relevance_score="relevanceScore", strategy_id="strategyId", top_k="topK" )
Attributes
- relevance_score
-
- Type:
see
- strategy_id
-
- Type:
see
HarnessAgentCoreRuntimeEnvironmentProperty
- class CfnHarness.HarnessAgentCoreRuntimeEnvironmentProperty(*, agent_runtime_arn=None, agent_runtime_id=None, agent_runtime_name=None, filesystem_configurations=None, lifecycle_configuration=None, network_configuration=None)
Bases:
object- Parameters:
agent_runtime_arn (
Optional[str]) – The ARN of the underlying AgentCore Runtime.agent_runtime_id (
Optional[str]) – The ID of the underlying AgentCore Runtime.agent_runtime_name (
Optional[str]) – The name of the underlying AgentCore Runtime.filesystem_configurations (
Union[IResolvable,Sequence[Union[IResolvable,FilesystemConfigurationProperty,Dict[str,Any]]],None])lifecycle_configuration (
Union[IResolvable,LifecycleConfigurationProperty,Dict[str,Any],None])network_configuration (
Union[IResolvable,NetworkConfigurationProperty,Dict[str,Any],None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 harness_agent_core_runtime_environment_property = bedrockagentcore.CfnHarness.HarnessAgentCoreRuntimeEnvironmentProperty( agent_runtime_arn="agentRuntimeArn", agent_runtime_id="agentRuntimeId", agent_runtime_name="agentRuntimeName", filesystem_configurations=[bedrockagentcore.CfnHarness.FilesystemConfigurationProperty( efs_access_point=bedrockagentcore.CfnHarness.EfsAccessPointConfigurationProperty( access_point_arn="accessPointArn", mount_path="mountPath" ), s3_files_access_point=bedrockagentcore.CfnHarness.S3FilesAccessPointConfigurationProperty( access_point_arn="accessPointArn", mount_path="mountPath" ), session_storage=bedrockagentcore.CfnHarness.SessionStorageConfigurationProperty( mount_path="mountPath" ) )], lifecycle_configuration=bedrockagentcore.CfnHarness.LifecycleConfigurationProperty( idle_runtime_session_timeout=123, max_lifetime=123 ), network_configuration=bedrockagentcore.CfnHarness.NetworkConfigurationProperty( network_mode="networkMode", # the properties below are optional network_mode_config=bedrockagentcore.CfnHarness.VpcConfigProperty( security_groups=["securityGroups"], subnets=["subnets"] ) ) )
Attributes
- agent_runtime_arn
The ARN of the underlying AgentCore Runtime.
- agent_runtime_id
The ID of the underlying AgentCore Runtime.
- agent_runtime_name
The name of the underlying AgentCore Runtime.
- filesystem_configurations
-
- Type:
see
- lifecycle_configuration
-
- Type:
see
HarnessBedrockModelConfigProperty
- class CfnHarness.HarnessBedrockModelConfigProperty(*, model_id, api_format=None, max_tokens=None, temperature=None, top_p=None)
Bases:
object- Parameters:
model_id (
str)api_format (
Optional[str])max_tokens (
Union[int,float,None])temperature (
Union[int,float,None])top_p (
Union[int,float,None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 harness_bedrock_model_config_property = bedrockagentcore.CfnHarness.HarnessBedrockModelConfigProperty( model_id="modelId", # the properties below are optional api_format="apiFormat", max_tokens=123, temperature=123, top_p=123 )
Attributes
- api_format
-
- Type:
see
- max_tokens
-
- Type:
see
- model_id
-
- Type:
see
- temperature
-
- Type:
see
HarnessEnvironmentArtifactProperty
- class CfnHarness.HarnessEnvironmentArtifactProperty(*, container_configuration=None)
Bases:
object- Parameters:
container_configuration (
Union[IResolvable,ContainerConfigurationProperty,Dict[str,Any],None])- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 harness_environment_artifact_property = bedrockagentcore.CfnHarness.HarnessEnvironmentArtifactProperty( container_configuration=bedrockagentcore.CfnHarness.ContainerConfigurationProperty( container_uri="containerUri" ) )
Attributes
HarnessEnvironmentProviderProperty
- class CfnHarness.HarnessEnvironmentProviderProperty(*, agent_core_runtime_environment=None)
Bases:
object- Parameters:
agent_core_runtime_environment (
Union[IResolvable,HarnessAgentCoreRuntimeEnvironmentProperty,Dict[str,Any],None])- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 harness_environment_provider_property = bedrockagentcore.CfnHarness.HarnessEnvironmentProviderProperty( agent_core_runtime_environment=bedrockagentcore.CfnHarness.HarnessAgentCoreRuntimeEnvironmentProperty( agent_runtime_arn="agentRuntimeArn", agent_runtime_id="agentRuntimeId", agent_runtime_name="agentRuntimeName", filesystem_configurations=[bedrockagentcore.CfnHarness.FilesystemConfigurationProperty( efs_access_point=bedrockagentcore.CfnHarness.EfsAccessPointConfigurationProperty( access_point_arn="accessPointArn", mount_path="mountPath" ), s3_files_access_point=bedrockagentcore.CfnHarness.S3FilesAccessPointConfigurationProperty( access_point_arn="accessPointArn", mount_path="mountPath" ), session_storage=bedrockagentcore.CfnHarness.SessionStorageConfigurationProperty( mount_path="mountPath" ) )], lifecycle_configuration=bedrockagentcore.CfnHarness.LifecycleConfigurationProperty( idle_runtime_session_timeout=123, max_lifetime=123 ), network_configuration=bedrockagentcore.CfnHarness.NetworkConfigurationProperty( network_mode="networkMode", # the properties below are optional network_mode_config=bedrockagentcore.CfnHarness.VpcConfigProperty( security_groups=["securityGroups"], subnets=["subnets"] ) ) ) )
Attributes
HarnessGatewayOutboundAuthProperty
- class CfnHarness.HarnessGatewayOutboundAuthProperty(*, aws_iam=None, none=None, oauth=None)
Bases:
object- Parameters:
aws_iam (
Any)none (
Any)oauth (
Union[IResolvable,OAuthCredentialProviderProperty,Dict[str,Any],None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 # aws_iam: Any # none: Any harness_gateway_outbound_auth_property = bedrockagentcore.CfnHarness.HarnessGatewayOutboundAuthProperty( aws_iam=aws_iam, none=none, oauth=bedrockagentcore.CfnHarness.OAuthCredentialProviderProperty( provider_arn="providerArn", scopes=["scopes"], # the properties below are optional custom_parameters={ "custom_parameters_key": "customParameters" }, default_return_url="defaultReturnUrl", grant_type="grantType" ) )
Attributes
- aws_iam
-
- Type:
see
- none
-
- Type:
see
HarnessGeminiModelConfigProperty
- class CfnHarness.HarnessGeminiModelConfigProperty(*, api_key_arn, model_id, max_tokens=None, temperature=None, top_k=None, top_p=None)
Bases:
object- Parameters:
api_key_arn (
str)model_id (
str)max_tokens (
Union[int,float,None])temperature (
Union[int,float,None])top_k (
Union[int,float,None])top_p (
Union[int,float,None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 harness_gemini_model_config_property = bedrockagentcore.CfnHarness.HarnessGeminiModelConfigProperty( api_key_arn="apiKeyArn", model_id="modelId", # the properties below are optional max_tokens=123, temperature=123, top_k=123, top_p=123 )
Attributes
- api_key_arn
-
- Type:
see
- max_tokens
-
- Type:
see
- model_id
-
- Type:
see
- temperature
-
- Type:
see
- top_k
-
- Type:
see
HarnessInlineFunctionConfigProperty
- class CfnHarness.HarnessInlineFunctionConfigProperty(*, description, input_schema)
Bases:
object- Parameters:
description (
str)input_schema (
Any) – JSON Schema describing the tool’s input parameters.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 # input_schema: Any harness_inline_function_config_property = bedrockagentcore.CfnHarness.HarnessInlineFunctionConfigProperty( description="description", input_schema=input_schema )
Attributes
- description
-
- Type:
see
- input_schema
JSON Schema describing the tool’s input parameters.
HarnessLiteLlmModelConfigProperty
- class CfnHarness.HarnessLiteLlmModelConfigProperty(*, model_id, api_base=None, api_key_arn=None, max_tokens=None, temperature=None, top_p=None)
Bases:
object- Parameters:
model_id (
str)api_base (
Optional[str])api_key_arn (
Optional[str])max_tokens (
Union[int,float,None])temperature (
Union[int,float,None])top_p (
Union[int,float,None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 harness_lite_llm_model_config_property = bedrockagentcore.CfnHarness.HarnessLiteLlmModelConfigProperty( model_id="modelId", # the properties below are optional api_base="apiBase", api_key_arn="apiKeyArn", max_tokens=123, temperature=123, top_p=123 )
Attributes
- api_base
-
- Type:
see
- api_key_arn
-
- Type:
see
- max_tokens
-
- Type:
see
- model_id
-
- Type:
see
- temperature
-
- Type:
see
HarnessManagedMemoryConfigurationProperty
- class CfnHarness.HarnessManagedMemoryConfigurationProperty(*, arn=None, encryption_key_arn=None, event_expiry_duration=None, strategies=None)
Bases:
objectConfiguration for managed memory.
The harness creates and manages a memory resource in the customer’s account.
- Parameters:
arn (
Optional[str]) – The ARN of the managed memory resource. Read-only, populated by the service.encryption_key_arn (
Optional[str]) – Customer-managed KMS key ARN. Defaults to AWS-owned key. Not updatable after creation.event_expiry_duration (
Union[int,float,None]) – Event retention in days. Defaults to 30.strategies (
Optional[Sequence[str]]) – Strategy types to enable. Defaults to [SEMANTIC, SUMMARIZATION].
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 harness_managed_memory_configuration_property = bedrockagentcore.CfnHarness.HarnessManagedMemoryConfigurationProperty( arn="arn", encryption_key_arn="encryptionKeyArn", event_expiry_duration=123, strategies=["strategies"] )
Attributes
- arn
The ARN of the managed memory resource.
Read-only, populated by the service.
- encryption_key_arn
Customer-managed KMS key ARN.
Defaults to AWS-owned key. Not updatable after creation.
- event_expiry_duration
Event retention in days.
Defaults to 30.
- strategies
Strategy types to enable.
Defaults to [SEMANTIC, SUMMARIZATION].
HarnessMemoryConfigurationProperty
- class CfnHarness.HarnessMemoryConfigurationProperty(*, agent_core_memory_configuration=None, disabled=None, managed_memory_configuration=None)
Bases:
object- Parameters:
agent_core_memory_configuration (
Union[IResolvable,HarnessAgentCoreMemoryConfigurationProperty,Dict[str,Any],None])disabled (
Any) – Explicitly opt out of memory.managed_memory_configuration (
Union[IResolvable,HarnessManagedMemoryConfigurationProperty,Dict[str,Any],None]) – Configuration for managed memory. The harness creates and manages a memory resource in the customer’s account.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 # disabled: Any harness_memory_configuration_property = bedrockagentcore.CfnHarness.HarnessMemoryConfigurationProperty( agent_core_memory_configuration=bedrockagentcore.CfnHarness.HarnessAgentCoreMemoryConfigurationProperty( arn="arn", # the properties below are optional actor_id="actorId", messages_count=123, retrieval_config={ "retrieval_config_key": bedrockagentcore.CfnHarness.HarnessAgentCoreMemoryRetrievalConfigProperty( relevance_score="relevanceScore", strategy_id="strategyId", top_k="topK" ) } ), disabled=disabled, managed_memory_configuration=bedrockagentcore.CfnHarness.HarnessManagedMemoryConfigurationProperty( arn="arn", encryption_key_arn="encryptionKeyArn", event_expiry_duration=123, strategies=["strategies"] ) )
Attributes
- agent_core_memory_configuration
-
- Type:
see
- disabled
Explicitly opt out of memory.
- managed_memory_configuration
Configuration for managed memory.
The harness creates and manages a memory resource in the customer’s account.
HarnessModelConfigurationProperty
- class CfnHarness.HarnessModelConfigurationProperty(*, bedrock_model_config=None, gemini_model_config=None, lite_llm_model_config=None, open_ai_model_config=None)
Bases:
object- Parameters:
bedrock_model_config (
Union[IResolvable,HarnessBedrockModelConfigProperty,Dict[str,Any],None])gemini_model_config (
Union[IResolvable,HarnessGeminiModelConfigProperty,Dict[str,Any],None])lite_llm_model_config (
Union[IResolvable,HarnessLiteLlmModelConfigProperty,Dict[str,Any],None])open_ai_model_config (
Union[IResolvable,HarnessOpenAiModelConfigProperty,Dict[str,Any],None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 harness_model_configuration_property = bedrockagentcore.CfnHarness.HarnessModelConfigurationProperty( bedrock_model_config=bedrockagentcore.CfnHarness.HarnessBedrockModelConfigProperty( model_id="modelId", # the properties below are optional api_format="apiFormat", max_tokens=123, temperature=123, top_p=123 ), gemini_model_config=bedrockagentcore.CfnHarness.HarnessGeminiModelConfigProperty( api_key_arn="apiKeyArn", model_id="modelId", # the properties below are optional max_tokens=123, temperature=123, top_k=123, top_p=123 ), lite_llm_model_config=bedrockagentcore.CfnHarness.HarnessLiteLlmModelConfigProperty( model_id="modelId", # the properties below are optional api_base="apiBase", api_key_arn="apiKeyArn", max_tokens=123, temperature=123, top_p=123 ), open_ai_model_config=bedrockagentcore.CfnHarness.HarnessOpenAiModelConfigProperty( api_key_arn="apiKeyArn", model_id="modelId", # the properties below are optional api_format="apiFormat", max_tokens=123, temperature=123, top_p=123 ) )
Attributes
- bedrock_model_config
-
- Type:
see
- gemini_model_config
-
- Type:
see
- lite_llm_model_config
-
- Type:
see
HarnessOpenAiModelConfigProperty
- class CfnHarness.HarnessOpenAiModelConfigProperty(*, api_key_arn, model_id, api_format=None, max_tokens=None, temperature=None, top_p=None)
Bases:
object- Parameters:
api_key_arn (
str)model_id (
str)api_format (
Optional[str])max_tokens (
Union[int,float,None])temperature (
Union[int,float,None])top_p (
Union[int,float,None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 harness_open_ai_model_config_property = bedrockagentcore.CfnHarness.HarnessOpenAiModelConfigProperty( api_key_arn="apiKeyArn", model_id="modelId", # the properties below are optional api_format="apiFormat", max_tokens=123, temperature=123, top_p=123 )
Attributes
- api_format
-
- Type:
see
- api_key_arn
-
- Type:
see
- max_tokens
-
- Type:
see
- model_id
-
- Type:
see
- temperature
-
- Type:
see
HarnessRemoteMcpConfigProperty
- class CfnHarness.HarnessRemoteMcpConfigProperty(*, url, headers=None)
Bases:
object- Parameters:
url (
str)headers (
Union[IResolvable,Mapping[str,str],None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 harness_remote_mcp_config_property = bedrockagentcore.CfnHarness.HarnessRemoteMcpConfigProperty( url="url", # the properties below are optional headers={ "headers_key": "headers" } )
Attributes
- headers
-
- Type:
see
HarnessSkillAwsSkillsSourceProperty
- class CfnHarness.HarnessSkillAwsSkillsSourceProperty(*, paths=None)
Bases:
objectAWS Skills baked into the Harness’s underlying Runtime.
- Parameters:
paths (
Optional[Sequence[str]]) – Optionally filter allowed skills with glob syntax, e.g., [‘core-skills/*’].- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 harness_skill_aws_skills_source_property = bedrockagentcore.CfnHarness.HarnessSkillAwsSkillsSourceProperty( paths=["paths"] )
Attributes
HarnessSkillGitAuthProperty
- class CfnHarness.HarnessSkillGitAuthProperty(*, credential_arn, username=None)
Bases:
objectAuthentication configuration for accessing a private git repository.
- Parameters:
credential_arn (
str) – The ARN of the credential in AgentCore Identity containing the password or personal access token.username (
Optional[str]) – Username for authentication. Defaults to ‘oauth2’ if not specified.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 harness_skill_git_auth_property = bedrockagentcore.CfnHarness.HarnessSkillGitAuthProperty( credential_arn="credentialArn", # the properties below are optional username="username" )
Attributes
- credential_arn
The ARN of the credential in AgentCore Identity containing the password or personal access token.
- username
Username for authentication.
Defaults to ‘oauth2’ if not specified.
HarnessSkillGitSourceProperty
- class CfnHarness.HarnessSkillGitSourceProperty(*, url, auth=None, path=None)
Bases:
objectA git repository containing the skill, cloned over HTTPS.
- Parameters:
url (
str) – The HTTPS URL of the git repository.auth (
Union[IResolvable,HarnessSkillGitAuthProperty,Dict[str,Any],None]) – Authentication configuration for accessing a private git repository.path (
Optional[str]) – Subdirectory within the repository containing the skill.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 harness_skill_git_source_property = bedrockagentcore.CfnHarness.HarnessSkillGitSourceProperty( url="url", # the properties below are optional auth=bedrockagentcore.CfnHarness.HarnessSkillGitAuthProperty( credential_arn="credentialArn", # the properties below are optional username="username" ), path="path" )
Attributes
- auth
Authentication configuration for accessing a private git repository.
- path
Subdirectory within the repository containing the skill.
- url
The HTTPS URL of the git repository.
HarnessSkillProperty
- class CfnHarness.HarnessSkillProperty(*, aws_skills=None, git=None, path=None, s3=None)
Bases:
object- Parameters:
aws_skills (
Union[IResolvable,HarnessSkillAwsSkillsSourceProperty,Dict[str,Any],None]) – AWS Skills baked into the Harness’s underlying Runtime.git (
Union[IResolvable,HarnessSkillGitSourceProperty,Dict[str,Any],None]) – A git repository containing the skill, cloned over HTTPS.path (
Optional[str]) – The filesystem path to the skill definition.s3 (
Union[IResolvable,HarnessSkillS3SourceProperty,Dict[str,Any],None]) – An S3 source containing the skill.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 harness_skill_property = bedrockagentcore.CfnHarness.HarnessSkillProperty( aws_skills=bedrockagentcore.CfnHarness.HarnessSkillAwsSkillsSourceProperty( paths=["paths"] ), git=bedrockagentcore.CfnHarness.HarnessSkillGitSourceProperty( url="url", # the properties below are optional auth=bedrockagentcore.CfnHarness.HarnessSkillGitAuthProperty( credential_arn="credentialArn", # the properties below are optional username="username" ), path="path" ), path="path", s3=bedrockagentcore.CfnHarness.HarnessSkillS3SourceProperty( uri="uri" ) )
Attributes
- aws_skills
AWS Skills baked into the Harness’s underlying Runtime.
- git
A git repository containing the skill, cloned over HTTPS.
- path
The filesystem path to the skill definition.
- s3
An S3 source containing the skill.
HarnessSkillS3SourceProperty
- class CfnHarness.HarnessSkillS3SourceProperty(*, uri)
Bases:
objectAn S3 source containing the skill.
- Parameters:
uri (
str) – The S3 URI pointing to the skill directory (e.g., s3://bucket/skills/my-skill/).- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 harness_skill_s3_source_property = bedrockagentcore.CfnHarness.HarnessSkillS3SourceProperty( uri="uri" )
Attributes
- uri
//bucket/skills/my-skill/).
- See:
- Type:
The S3 URI pointing to the skill directory (e.g., s3
HarnessSlidingWindowConfigurationProperty
- class CfnHarness.HarnessSlidingWindowConfigurationProperty(*, messages_count=None)
Bases:
object- Parameters:
messages_count (
Union[int,float,None])- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 harness_sliding_window_configuration_property = bedrockagentcore.CfnHarness.HarnessSlidingWindowConfigurationProperty( messages_count=123 )
Attributes
HarnessSummarizationConfigurationProperty
- class CfnHarness.HarnessSummarizationConfigurationProperty(*, preserve_recent_messages=None, summarization_system_prompt=None, summary_ratio=None)
Bases:
object- Parameters:
preserve_recent_messages (
Union[int,float,None])summarization_system_prompt (
Optional[str])summary_ratio (
Union[int,float,None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 harness_summarization_configuration_property = bedrockagentcore.CfnHarness.HarnessSummarizationConfigurationProperty( preserve_recent_messages=123, summarization_system_prompt="summarizationSystemPrompt", summary_ratio=123 )
Attributes
- preserve_recent_messages
-
- Type:
see
- summarization_system_prompt
-
- Type:
see
HarnessSystemContentBlockProperty
- class CfnHarness.HarnessSystemContentBlockProperty(*, text)
Bases:
object- Parameters:
text (
str) – The text content of the system prompt block.- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 harness_system_content_block_property = bedrockagentcore.CfnHarness.HarnessSystemContentBlockProperty( text="text" )
Attributes
- text
The text content of the system prompt block.
HarnessToolConfigurationProperty
- class CfnHarness.HarnessToolConfigurationProperty(*, agent_core_browser=None, agent_core_code_interpreter=None, agent_core_gateway=None, inline_function=None, remote_mcp=None)
Bases:
object- Parameters:
agent_core_browser (
Union[IResolvable,HarnessAgentCoreBrowserConfigProperty,Dict[str,Any],None])agent_core_code_interpreter (
Union[IResolvable,HarnessAgentCoreCodeInterpreterConfigProperty,Dict[str,Any],None])agent_core_gateway (
Union[IResolvable,HarnessAgentCoreGatewayConfigProperty,Dict[str,Any],None])inline_function (
Union[IResolvable,HarnessInlineFunctionConfigProperty,Dict[str,Any],None])remote_mcp (
Union[IResolvable,HarnessRemoteMcpConfigProperty,Dict[str,Any],None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 # aws_iam: Any # input_schema: Any # none: Any harness_tool_configuration_property = bedrockagentcore.CfnHarness.HarnessToolConfigurationProperty( agent_core_browser=bedrockagentcore.CfnHarness.HarnessAgentCoreBrowserConfigProperty( browser_arn="browserArn" ), agent_core_code_interpreter=bedrockagentcore.CfnHarness.HarnessAgentCoreCodeInterpreterConfigProperty( code_interpreter_arn="codeInterpreterArn" ), agent_core_gateway=bedrockagentcore.CfnHarness.HarnessAgentCoreGatewayConfigProperty( gateway_arn="gatewayArn", # the properties below are optional outbound_auth=bedrockagentcore.CfnHarness.HarnessGatewayOutboundAuthProperty( aws_iam=aws_iam, none=none, oauth=bedrockagentcore.CfnHarness.OAuthCredentialProviderProperty( provider_arn="providerArn", scopes=["scopes"], # the properties below are optional custom_parameters={ "custom_parameters_key": "customParameters" }, default_return_url="defaultReturnUrl", grant_type="grantType" ) ) ), inline_function=bedrockagentcore.CfnHarness.HarnessInlineFunctionConfigProperty( description="description", input_schema=input_schema ), remote_mcp=bedrockagentcore.CfnHarness.HarnessRemoteMcpConfigProperty( url="url", # the properties below are optional headers={ "headers_key": "headers" } ) )
Attributes
- agent_core_browser
-
- Type:
see
- agent_core_code_interpreter
-
- Type:
see
- agent_core_gateway
-
- Type:
see
- inline_function
-
- Type:
see
HarnessToolProperty
- class CfnHarness.HarnessToolProperty(*, type, config=None, name=None)
Bases:
object- Parameters:
type (
str)config (
Union[IResolvable,HarnessToolConfigurationProperty,Dict[str,Any],None])name (
Optional[str])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 # aws_iam: Any # input_schema: Any # none: Any harness_tool_property = bedrockagentcore.CfnHarness.HarnessToolProperty( type="type", # the properties below are optional config=bedrockagentcore.CfnHarness.HarnessToolConfigurationProperty( agent_core_browser=bedrockagentcore.CfnHarness.HarnessAgentCoreBrowserConfigProperty( browser_arn="browserArn" ), agent_core_code_interpreter=bedrockagentcore.CfnHarness.HarnessAgentCoreCodeInterpreterConfigProperty( code_interpreter_arn="codeInterpreterArn" ), agent_core_gateway=bedrockagentcore.CfnHarness.HarnessAgentCoreGatewayConfigProperty( gateway_arn="gatewayArn", # the properties below are optional outbound_auth=bedrockagentcore.CfnHarness.HarnessGatewayOutboundAuthProperty( aws_iam=aws_iam, none=none, oauth=bedrockagentcore.CfnHarness.OAuthCredentialProviderProperty( provider_arn="providerArn", scopes=["scopes"], # the properties below are optional custom_parameters={ "custom_parameters_key": "customParameters" }, default_return_url="defaultReturnUrl", grant_type="grantType" ) ) ), inline_function=bedrockagentcore.CfnHarness.HarnessInlineFunctionConfigProperty( description="description", input_schema=input_schema ), remote_mcp=bedrockagentcore.CfnHarness.HarnessRemoteMcpConfigProperty( url="url", # the properties below are optional headers={ "headers_key": "headers" } ) ), name="name" )
Attributes
- config
-
- Type:
see
- name
-
- Type:
see
HarnessTruncationConfigurationProperty
- class CfnHarness.HarnessTruncationConfigurationProperty(*, strategy, config=None)
Bases:
object- Parameters:
strategy (
str)config (
Union[IResolvable,HarnessTruncationStrategyConfigurationProperty,Dict[str,Any],None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 harness_truncation_configuration_property = bedrockagentcore.CfnHarness.HarnessTruncationConfigurationProperty( strategy="strategy", # the properties below are optional config=bedrockagentcore.CfnHarness.HarnessTruncationStrategyConfigurationProperty( sliding_window=bedrockagentcore.CfnHarness.HarnessSlidingWindowConfigurationProperty( messages_count=123 ), summarization=bedrockagentcore.CfnHarness.HarnessSummarizationConfigurationProperty( preserve_recent_messages=123, summarization_system_prompt="summarizationSystemPrompt", summary_ratio=123 ) ) )
Attributes
- config
-
- Type:
see
HarnessTruncationStrategyConfigurationProperty
- class CfnHarness.HarnessTruncationStrategyConfigurationProperty(*, sliding_window=None, summarization=None)
Bases:
object- Parameters:
sliding_window (
Union[IResolvable,HarnessSlidingWindowConfigurationProperty,Dict[str,Any],None])summarization (
Union[IResolvable,HarnessSummarizationConfigurationProperty,Dict[str,Any],None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 harness_truncation_strategy_configuration_property = bedrockagentcore.CfnHarness.HarnessTruncationStrategyConfigurationProperty( sliding_window=bedrockagentcore.CfnHarness.HarnessSlidingWindowConfigurationProperty( messages_count=123 ), summarization=bedrockagentcore.CfnHarness.HarnessSummarizationConfigurationProperty( preserve_recent_messages=123, summarization_system_prompt="summarizationSystemPrompt", summary_ratio=123 ) )
Attributes
- sliding_window
-
- Type:
see
LifecycleConfigurationProperty
- class CfnHarness.LifecycleConfigurationProperty(*, idle_runtime_session_timeout=None, max_lifetime=None)
Bases:
object- Parameters:
idle_runtime_session_timeout (
Union[int,float,None])max_lifetime (
Union[int,float,None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 lifecycle_configuration_property = bedrockagentcore.CfnHarness.LifecycleConfigurationProperty( idle_runtime_session_timeout=123, max_lifetime=123 )
Attributes
- idle_runtime_session_timeout
-
- Type:
see
ManagedVpcResourceProperty
- class CfnHarness.ManagedVpcResourceProperty(*, endpoint_ip_address_type, subnet_ids, vpc_identifier, routing_domain=None, security_group_ids=None, tags=None)
Bases:
objectConfiguration for a service-managed VPC endpoint.
- Parameters:
endpoint_ip_address_type (
str)subnet_ids (
Sequence[str])vpc_identifier (
str)routing_domain (
Optional[str])security_group_ids (
Optional[Sequence[str]])tags (
Optional[Mapping[str,str]])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 managed_vpc_resource_property = bedrockagentcore.CfnHarness.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" } )
Attributes
- endpoint_ip_address_type
-
- Type:
see
- routing_domain
-
- Type:
see
- security_group_ids
-
- Type:
see
- subnet_ids
-
- Type:
see
- tags
-
- Type:
see
NetworkConfigurationProperty
- class CfnHarness.NetworkConfigurationProperty(*, network_mode, network_mode_config=None)
Bases:
object- Parameters:
network_mode (
str)network_mode_config (
Union[IResolvable,VpcConfigProperty,Dict[str,Any],None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 network_configuration_property = bedrockagentcore.CfnHarness.NetworkConfigurationProperty( network_mode="networkMode", # the properties below are optional network_mode_config=bedrockagentcore.CfnHarness.VpcConfigProperty( security_groups=["securityGroups"], subnets=["subnets"] ) )
Attributes
- network_mode
-
- Type:
see
OAuthCredentialProviderProperty
- class CfnHarness.OAuthCredentialProviderProperty(*, provider_arn, scopes, custom_parameters=None, default_return_url=None, grant_type=None)
Bases:
object- Parameters:
provider_arn (
str)scopes (
Sequence[str])custom_parameters (
Union[IResolvable,Mapping[str,str],None])default_return_url (
Optional[str])grant_type (
Optional[str])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 o_auth_credential_provider_property = bedrockagentcore.CfnHarness.OAuthCredentialProviderProperty( provider_arn="providerArn", scopes=["scopes"], # the properties below are optional custom_parameters={ "custom_parameters_key": "customParameters" }, default_return_url="defaultReturnUrl", grant_type="grantType" )
Attributes
- custom_parameters
-
- Type:
see
- default_return_url
-
- Type:
see
- grant_type
-
- Type:
see
- provider_arn
-
- Type:
see
PrivateEndpointOverrideProperty
- class CfnHarness.PrivateEndpointOverrideProperty(*, domain, private_endpoint)
Bases:
objectMaps a domain to a private endpoint for resolving that domain over a private network.
- Parameters:
domain (
str)private_endpoint (
Union[IResolvable,PrivateEndpointProperty,Dict[str,Any]]) – Private endpoint configuration for connecting to the OpenID Connect discovery endpoint over a private network.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 private_endpoint_override_property = bedrockagentcore.CfnHarness.PrivateEndpointOverrideProperty( domain="domain", private_endpoint=bedrockagentcore.CfnHarness.PrivateEndpointProperty( managed_vpc_resource=bedrockagentcore.CfnHarness.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.CfnHarness.SelfManagedLatticeResourceProperty( resource_configuration_identifier="resourceConfigurationIdentifier" ) ) )
Attributes
- domain
-
- Type:
see
- private_endpoint
Private endpoint configuration for connecting to the OpenID Connect discovery endpoint over a private network.
PrivateEndpointProperty
- class CfnHarness.PrivateEndpointProperty(*, managed_vpc_resource=None, self_managed_lattice_resource=None)
Bases:
objectPrivate endpoint configuration for connecting to the OpenID Connect discovery endpoint over a private network.
- Parameters:
managed_vpc_resource (
Union[IResolvable,ManagedVpcResourceProperty,Dict[str,Any],None]) – Configuration for a service-managed VPC endpoint.self_managed_lattice_resource (
Union[IResolvable,SelfManagedLatticeResourceProperty,Dict[str,Any],None]) – Configuration for connecting to a private resource using a self-managed VPC Lattice resource configuration.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 private_endpoint_property = bedrockagentcore.CfnHarness.PrivateEndpointProperty( managed_vpc_resource=bedrockagentcore.CfnHarness.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.CfnHarness.SelfManagedLatticeResourceProperty( resource_configuration_identifier="resourceConfigurationIdentifier" ) )
Attributes
- managed_vpc_resource
Configuration for a service-managed VPC endpoint.
- self_managed_lattice_resource
Configuration for connecting to a private resource using a self-managed VPC Lattice resource configuration.
S3FilesAccessPointConfigurationProperty
- class CfnHarness.S3FilesAccessPointConfigurationProperty(*, access_point_arn, mount_path)
Bases:
objectConfiguration for an Amazon S3 Files access point to mount into the AgentCore Runtime.
- Parameters:
access_point_arn (
str)mount_path (
str)
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 s3_files_access_point_configuration_property = bedrockagentcore.CfnHarness.S3FilesAccessPointConfigurationProperty( access_point_arn="accessPointArn", mount_path="mountPath" )
Attributes
- access_point_arn
-
- Type:
see
SelfManagedLatticeResourceProperty
- class CfnHarness.SelfManagedLatticeResourceProperty(*, resource_configuration_identifier)
Bases:
objectConfiguration for connecting to a private resource using a self-managed VPC Lattice resource configuration.
- Parameters:
resource_configuration_identifier (
str)- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 self_managed_lattice_resource_property = bedrockagentcore.CfnHarness.SelfManagedLatticeResourceProperty( resource_configuration_identifier="resourceConfigurationIdentifier" )
Attributes
SessionStorageConfigurationProperty
- class CfnHarness.SessionStorageConfigurationProperty(*, mount_path)
Bases:
object- Parameters:
mount_path (
str)- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 session_storage_configuration_property = bedrockagentcore.CfnHarness.SessionStorageConfigurationProperty( mount_path="mountPath" )
Attributes
VpcConfigProperty
- class CfnHarness.VpcConfigProperty(*, security_groups, subnets)
Bases:
object- Parameters:
security_groups (
Sequence[str])subnets (
Sequence[str])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# 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 vpc_config_property = bedrockagentcore.CfnHarness.VpcConfigProperty( security_groups=["securityGroups"], subnets=["subnets"] )
Attributes
- security_groups
-
- Type:
see