class RuntimeEndpointBase
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.RuntimeEndpointBase |
 Go | github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#RuntimeEndpointBase |
 Java | software.amazon.awscdk.services.bedrock.agentcore.alpha.RuntimeEndpointBase |
 Python | aws_cdk.aws_bedrock_agentcore_alpha.RuntimeEndpointBase |
 TypeScript (source) | @aws-cdk/aws-bedrock-agentcore-alpha » RuntimeEndpointBase |
Implements
IConstruct, IDependable, IResource, IRuntime
Extends
Resource
Implemented by
Runtime
Base class for Runtime Endpoint.
Initializer
new RuntimeEndpointBase(scope: Construct, id: string)
Parameters
- scope
Construct - id
string
Properties
| Name | Type | Description |
|---|---|---|
| agent | string | The ARN of the parent agent runtime. |
| agent | string | The ARN of the runtime endpoint resource. |
| endpoint | string | The name of the runtime endpoint. |
| env | Resource | The environment this resource belongs to. |
| node | Node | The tree node. |
| stack | Stack | The stack in which this resource is defined. |
| created | string | When the endpoint was created. |
| description? | string | The description of the runtime endpoint. |
| live | string | The live version of the agent runtime that is currently serving requests. |
| status? | string | The current status of the runtime endpoint. |
| target | string | The target version the endpoint is transitioning to (during updates). |
agentRuntimeArn
Type:
string
The ARN of the parent agent runtime.
agentRuntimeEndpointArn
Type:
string
The ARN of the runtime endpoint resource.
endpointName
Type:
string
The name of the runtime endpoint.
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
node
Type:
Node
The tree node.
stack
Type:
Stack
The stack in which this resource is defined.
createdAt?
Type:
string
(optional)
When the endpoint was created.
description?
Type:
string
(optional)
The description of the runtime endpoint.
liveVersion?
Type:
string
(optional)
The live version of the agent runtime that is currently serving requests.
status?
Type:
string
(optional)
The current status of the runtime endpoint.
targetVersion?
Type:
string
(optional)
The target version the endpoint is transitioning to (during updates).
Methods
| Name | Description |
|---|---|
| apply | Apply the given removal policy to this resource. |
| to | Returns a string representation of this construct. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
RemovalPolicy
Apply the given removal policy to this resource.
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).
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.