@aws-cdk/aws-bedrock-agentcore-alpha.RuntimeBase

Experimental

@aws-cdk/aws-bedrock-agentcore-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

RuntimeBase L2 construct

Base class for Agent Runtime.

Construct›Resource›RuntimeBase

implements

• IBedrockAgentRuntime,
• IResource,
• IConnectable,
• IGrantable,
• 4 more

  • IEnvironmentAware,
  • IRuntimeRef,
  • IConstruct,
  • IDependable

superclass of

• Runtime

Source

lib/runtime/runtime-base.ts

Initializer

new RuntimeBase(scope: Construct, id: string, props?: ResourceProps)

RuntimeBase(scope: Construct, id: str, props: typing.Optional[ResourceProps] = None)

new RuntimeBase(Construct scope, String id, ResourceProps props)

new RuntimeBase(Construct scope, string id, ResourceProps? props = null)

NewRuntimeBase(Scope Construct, Id *string, Props ResourceProps)

Construct Props

account?optionalstringaccount?optionalstraccount?optionalStringAccount?optionalstringAccount?optional*string#

The AWS account ID this resource belongs to.

Default: the resource is in the same account as the stack it belongs to

environmentFromArn?optionalstringenvironment_from_arn?optionalstrenvironmentFromArn?optionalStringEnvironmentFromArn?optionalstringEnvironmentFromArn?optional*string#

ARN to deduce region and account from.

Default: take environment from account, region parameters, or use Stack environment.

The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources.

Cannot be supplied together with either account or region.

physicalName?optionalstringphysical_name?optionalstrphysicalName?optionalStringPhysicalName?optionalstringPhysicalName?optional*string#

The value passed in by users to the physical name prop of the resource.

Default: The physical name will be allocated by CloudFormation at deployment time

notes

• undefined implies that a physical name will be allocated by CloudFormation during deployment.
• a concrete value implies a specific physical name
• PhysicalName.GENERATE_IF_NEEDED is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.

region?optionalstringregion?optionalstrregion?optionalStringRegion?optionalstringRegion?optional*string#

The AWS region this resource belongs to.

Default: the resource is in the same region as the stack it belongs to

Properties

agentRuntimeArnstringagent_runtime_arnstragentRuntimeArnStringAgentRuntimeArnstringAgentRuntimeArn*string#

The ARN of the agent runtime resource - Format `arn:${Partition}:bedrock-agentcore:${Region}:${Account}:runtime/${RuntimeId}`.

agentRuntimeIdstringagent_runtime_idstragentRuntimeIdStringAgentRuntimeIdstringAgentRuntimeId*string#

The ID of the agent runtime.

agentRuntimeNamestringagent_runtime_namestragentRuntimeNameStringAgentRuntimeNamestringAgentRuntimeName*string#

The name of the agent runtime.

agentRuntimeVersion?may be undefinedstringagent_runtime_version?may be undefinedstragentRuntimeVersion?may be undefinedStringAgentRuntimeVersion?may be undefinedstringAgentRuntimeVersion?may be undefined*string#

The version of the agent runtime.

agentStatus?may be undefinedstringagent_status?may be undefinedstragentStatus?may be undefinedStringAgentStatus?may be undefinedstringAgentStatus?may be undefined*string#

The current status of the agent runtime.

connectionsConnectionsconnectionsConnectionsconnectionsConnectionsConnectionsConnectionsConnectionsConnections#

An accessor for the Connections object that will fail if this Runtime does not have a VPC configured.

createdAt?may be undefinedstringcreated_at?may be undefinedstrcreatedAt?may be undefinedStringCreatedAt?may be undefinedstringCreatedAt?may be undefined*string#

The time at which the runtime was created.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

grantPrincipalIPrincipalgrant_principalIPrincipalgrantPrincipalIPrincipalGrantPrincipalIPrincipalGrantPrincipalIPrincipal#

The principal to grant permissions to.

lastUpdatedAt?may be undefinedstringlast_updated_at?may be undefinedstrlastUpdatedAt?may be undefinedStringLastUpdatedAt?may be undefinedstringLastUpdatedAt?may be undefined*string#

The time at which the runtime was last updated.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

roleIRoleroleIRoleroleIRoleRoleIRoleRoleIRole#

The IAM role that provides permissions for the agent runtime.

runtimeRefRuntimeReferenceruntime_refRuntimeReferenceruntimeRefRuntimeReferenceRuntimeRefRuntimeReferenceRuntimeRefRuntimeReference#

A reference to a Runtime resource.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this resource is defined.

Methods

addToRolePolicy(statement: PolicyStatement): IBedrockAgentRuntimedef add_to_role_policy(self, statement: PolicyStatement) -> IBedrockAgentRuntimepublic IBedrockAgentRuntime addToRolePolicy(PolicyStatement statement)public IBedrockAgentRuntime AddToRolePolicy(PolicyStatement statement)func AddToRolePolicy(Statement PolicyStatement) IBedrockAgentRuntime#

Adds a policy statement to the runtime's execution role.

1 parameter · returns

Parameters

• statementstatementstatementstatementStatement — The IAM policy statement to add.

Returns: The runtime instance for chaining

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Override the cross-stack reference strength for this resource.

notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

• strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

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).

grant(actions: string[], resources: string[]): Grantdef grant(self, actions: typing.List[str], resources: typing.List[str]) -> Grantpublic Grant grant(List<String> actions, List<String> resources)public Grant Grant(string[] actions, string[] resources)func Grant(Actions *[]*string, Resources *[]*string) Grant#

Grant the runtime specific actions on AWS resources.

[disable-awslint:no-grants]

2 parameters · returns

Parameters

• actionsactionsactionsactionsActions — The actions to grant.
• resourcesresourcesresourcesresourcesResources — The resource ARNs to grant access to.

Returns: The Grant object for chaining

grantInvoke(grantee: IGrantable): Grantdef grant_invoke(self, grantee: IGrantable) -> Grantpublic Grant grantInvoke(IGrantable grantee)public Grant GrantInvoke(IGrantable grantee)func GrantInvoke(Grantee IGrantable) Grant#

Permits an IAM principal to invoke this runtime both directly and on behalf of users Grants both bedrock-agentcore:InvokeAgentRuntime and bedrock-agentcore:InvokeAgentRuntimeForUser permissions.

[disable-awslint:no-grants]

1 parameter

Parameters

• granteegranteegranteegranteeGrantee — The principal to grant access to.

grantInvokeRuntime(grantee: IGrantable): Grantdef grant_invoke_runtime(self, grantee: IGrantable) -> Grantpublic Grant grantInvokeRuntime(IGrantable grantee)public Grant GrantInvokeRuntime(IGrantable grantee)func GrantInvokeRuntime(Grantee IGrantable) Grant#

Permits an IAM principal to invoke this runtime Grants the bedrock-agentcore:InvokeAgentRuntime permission.

[disable-awslint:no-grants]

1 parameter

Parameters

• granteegranteegranteegranteeGrantee — The principal to grant access to.

grantInvokeRuntimeForUser(grantee: IGrantable): Grantdef grant_invoke_runtime_for_user(self, grantee: IGrantable) -> Grantpublic Grant grantInvokeRuntimeForUser(IGrantable grantee)public Grant GrantInvokeRuntimeForUser(IGrantable grantee)func GrantInvokeRuntimeForUser(Grantee IGrantable) Grant#

Permits an IAM principal to invoke this runtime on behalf of a user Grants the bedrock-agentcore:InvokeAgentRuntimeForUser permission Required when using the X-Amzn-Bedrock-AgentCore-Runtime-User-Id header.

[disable-awslint:no-grants]

1 parameter

Parameters

• granteegranteegranteegranteeGrantee — The principal to grant access to.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

• xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#

Returns true if the construct was created by CDK, and false otherwise.

isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#

Check whether the given construct is a Resource.

metric(metricName: string, dimensions: { [key: string]: string }, props?: MetricOptions): Metricdef metric(self, metric_name: str, dimensions: typing.Mapping[str, str], props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metric(String metricName, Map<String, String> dimensions, MetricOptions props)public Metric Metric(string metricName, IDictionary<string, string> dimensions, MetricOptions? props = null)func Metric(MetricName *string, Dimensions *map[string]*string, Props MetricOptions) Metric#

Return the given named metric for this agent runtime.

By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the statistic and period properties.

metricInvocations(props?: MetricOptions): Metricdef metric_invocations(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricInvocations(MetricOptions props)public Metric MetricInvocations(MetricOptions? props = null)func MetricInvocations(Props MetricOptions) Metric#

Return a metric containing the total number of invocations for this agent runtime.

metricInvocationsAggregated(props?: MetricOptions): Metricdef metric_invocations_aggregated(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricInvocationsAggregated(MetricOptions props)public Metric MetricInvocationsAggregated(MetricOptions? props = null)func MetricInvocationsAggregated(Props MetricOptions) Metric#

Return a metric containing the total number of invocations across all resources.

metricLatency(props?: MetricOptions): Metricdef metric_latency(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricLatency(MetricOptions props)public Metric MetricLatency(MetricOptions? props = null)func MetricLatency(Props MetricOptions) Metric#

Return a metric measuring the latency of requests for this agent runtime.

The latency metric represents the total time elapsed between receiving the request and sending the final response token, representing complete end-to-end processing time.

metricSessionCount(props?: MetricOptions): Metricdef metric_session_count(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricSessionCount(MetricOptions props)public Metric MetricSessionCount(MetricOptions? props = null)func MetricSessionCount(Props MetricOptions) Metric#

Return a metric containing the number of agent sessions for this agent runtime.

metricSessionsAggregated(props?: MetricOptions): Metricdef metric_sessions_aggregated(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricSessionsAggregated(MetricOptions props)public Metric MetricSessionsAggregated(MetricOptions? props = null)func MetricSessionsAggregated(Props MetricOptions) Metric#

Return a metric containing the total number of sessions across all resources.

metricSystemErrors(props?: MetricOptions): Metricdef metric_system_errors(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricSystemErrors(MetricOptions props)public Metric MetricSystemErrors(MetricOptions? props = null)func MetricSystemErrors(Props MetricOptions) Metric#

Return a metric containing the number of system errors for this agent runtime.

metricThrottles(props?: MetricOptions): Metricdef metric_throttles(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricThrottles(MetricOptions props)public Metric MetricThrottles(MetricOptions? props = null)func MetricThrottles(Props MetricOptions) Metric#

Return a metric containing the number of throttled requests for this agent runtime.

metricTotalErrors(props?: MetricOptions): Metricdef metric_total_errors(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricTotalErrors(MetricOptions props)public Metric MetricTotalErrors(MetricOptions? props = null)func MetricTotalErrors(Props MetricOptions) Metric#

Return a metric containing the total number of errors (system + user) for this agent runtime.

metricUserErrors(props?: MetricOptions): Metricdef metric_user_errors(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricUserErrors(MetricOptions props)public Metric MetricUserErrors(MetricOptions? props = null)func MetricUserErrors(Props MetricOptions) Metric#

Return a metric containing the number of user errors for this agent runtime.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

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.