Skip to content
v2.278.0

RuntimeEndpointProps Struct ​

Properties for creating a Bedrock Agent Core Runtime Endpoint resource.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_agentcore_alpha from '@aws-cdk/aws-bedrock-agentcore-alpha';
const runtimeEndpointProps: bedrock_agentcore_alpha.RuntimeEndpointProps = {
  agentRuntimeId: 'agentRuntimeId',

  // the properties below are optional
  agentRuntimeVersion: 'agentRuntimeVersion',
  description: 'description',
  endpointName: 'endpointName',
  tags: {
    tagsKey: 'tags',
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_bedrock_agentcore_alpha as bedrock_agentcore_alpha

runtime_endpoint_props = bedrock_agentcore_alpha.RuntimeEndpointProps(
    agent_runtime_id="agentRuntimeId",

    # the properties below are optional
    agent_runtime_version="agentRuntimeVersion",
    description="description",
    endpoint_name="endpointName",
    tags={
        "tags_key": "tags"
    }
)
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.bedrock.agentcore.alpha.*;

RuntimeEndpointProps runtimeEndpointProps = RuntimeEndpointProps.builder()
        .agentRuntimeId("agentRuntimeId")

        // the properties below are optional
        .agentRuntimeVersion("agentRuntimeVersion")
        .description("description")
        .endpointName("endpointName")
        .tags(Map.of(
                "tagsKey", "tags"))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Bedrock.Agentcore.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Bedrock.Agentcore.Alpha;

var runtimeEndpointProps = new RuntimeEndpointProps {
    AgentRuntimeId = "agentRuntimeId",

    // the properties below are optional
    AgentRuntimeVersion = "agentRuntimeVersion",
    Description = "description",
    EndpointName = "endpointName",
    Tags = new Dictionary<string, string> {
        { "tagsKey", "tags" }
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import bedrock_agentcore_alpha "github.com/aws/aws-cdk-go/awsbedrockagentcorealpha"

runtimeEndpointProps := &RuntimeEndpointProps{
	AgentRuntimeId: jsii.String("agentRuntimeId"),

	// the properties below are optional
	AgentRuntimeVersion: jsii.String("agentRuntimeVersion"),
	Description: jsii.String("description"),
	EndpointName: jsii.String("endpointName"),
	Tags: map[string]*string{
		"tagsKey": jsii.String("tags"),
	},
}

Properties ​

agentRuntimeIdstringagent_runtime_idstragentRuntimeIdStringAgentRuntimeIdstringAgentRuntimeId*string required #
The ID of the agent runtime to associate with this endpoint This is the unique identifier of the runtime resource Pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,99}-[a-zA-Z0-9]{10}$.
agentRuntimeVersionoptionalstringagent_runtime_versionoptionalstragentRuntimeVersionoptionalStringAgentRuntimeVersionoptionalstringAgentRuntimeVersionoptional*string = "1" #
The version of the agent runtime to use for this endpoint If not specified, the endpoint will point to version "1" of the runtime.

Pattern: ^([1-9][0-9]{0,4})$

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string #
Optional description for the agent runtime endpoint Length Minimum: 1 , Maximum: 256.

Default: No description

endpointNameoptionalstringendpoint_nameoptionalstrendpointNameoptionalStringEndpointNameoptionalstringEndpointNameoptional*string #
The name of the agent runtime endpoint Valid characters are a-z, A-Z, 0-9, _ (underscore) Must start with a letter and can be up to 48 characters long Pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,47}$.

Default: auto generate

tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string #
Tags for the agent runtime endpoint A list of key:value pairs of tags to apply to this RuntimeEndpoint resource Pattern: ^[a-zA-Z0-9\s._:/=+@-]*$.

Default: {} - no tags