Skip to content
v2.277.0

Experimental

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

Runtime L2 construct ​

Bedrock Agent Core Runtime Enables running containerized agents with specific network configurations, security settings, and runtime artifacts.

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';
import * as cdk from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';

declare const agentRuntimeArtifact: bedrock_agentcore_alpha.AgentRuntimeArtifact;
declare const loggingDestination: bedrock_agentcore_alpha.LoggingDestination;
declare const logType: bedrock_agentcore_alpha.LogType;
declare const role: iam.Role;
declare const runtimeAuthorizerConfiguration: bedrock_agentcore_alpha.RuntimeAuthorizerConfiguration;
declare const runtimeNetworkConfiguration: bedrock_agentcore_alpha.RuntimeNetworkConfiguration;
const runtime = new bedrock_agentcore_alpha.Runtime(this, 'MyRuntime', {
  agentRuntimeArtifact: agentRuntimeArtifact,

  // the properties below are optional
  authorizerConfiguration: runtimeAuthorizerConfiguration,
  description: 'description',
  environmentVariables: {
    environmentVariablesKey: 'environmentVariables',
  },
  executionRole: role,
  lifecycleConfiguration: {
    idleRuntimeSessionTimeout: cdk.Duration.minutes(30),
    maxLifetime: cdk.Duration.minutes(30),
  },
  loggingConfigs: [{
    destination: loggingDestination,
    logType: logType,
  }],
  networkConfiguration: runtimeNetworkConfiguration,
  protocolConfiguration: bedrock_agentcore_alpha.ProtocolType.MCP,
  requestHeaderConfiguration: {
    allowlistedHeaders: ['allowlistedHeaders'],
  },
  runtimeName: 'runtimeName',
  tags: {
    tagsKey: 'tags',
  },
  tracingEnabled: false,
});
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
import aws_cdk as cdk
from aws_cdk import aws_iam as iam

# agent_runtime_artifact: bedrock_agentcore_alpha.AgentRuntimeArtifact
# logging_destination: bedrock_agentcore_alpha.LoggingDestination
# log_type: bedrock_agentcore_alpha.LogType
# role: iam.Role
# runtime_authorizer_configuration: bedrock_agentcore_alpha.RuntimeAuthorizerConfiguration
# runtime_network_configuration: bedrock_agentcore_alpha.RuntimeNetworkConfiguration

runtime = bedrock_agentcore_alpha.Runtime(self, "MyRuntime",
    agent_runtime_artifact=agent_runtime_artifact,

    # the properties below are optional
    authorizer_configuration=runtime_authorizer_configuration,
    description="description",
    environment_variables={
        "environment_variables_key": "environmentVariables"
    },
    execution_role=role,
    lifecycle_configuration=bedrock_agentcore_alpha.LifecycleConfiguration(
        idle_runtime_session_timeout=cdk.Duration.minutes(30),
        max_lifetime=cdk.Duration.minutes(30)
    ),
    logging_configs=[bedrock_agentcore_alpha.LoggingConfig(
        destination=logging_destination,
        log_type=log_type
    )],
    network_configuration=runtime_network_configuration,
    protocol_configuration=bedrock_agentcore_alpha.ProtocolType.MCP,
    request_header_configuration=bedrock_agentcore_alpha.RequestHeaderConfiguration(
        allowlisted_headers=["allowlistedHeaders"]
    ),
    runtime_name="runtimeName",
    tags={
        "tags_key": "tags"
    },
    tracing_enabled=False
)
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.*;
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.iam.*;

AgentRuntimeArtifact agentRuntimeArtifact;
LoggingDestination loggingDestination;
LogType logType;
Role role;
RuntimeAuthorizerConfiguration runtimeAuthorizerConfiguration;
RuntimeNetworkConfiguration runtimeNetworkConfiguration;

Runtime runtime = Runtime.Builder.create(this, "MyRuntime")
        .agentRuntimeArtifact(agentRuntimeArtifact)

        // the properties below are optional
        .authorizerConfiguration(runtimeAuthorizerConfiguration)
        .description("description")
        .environmentVariables(Map.of(
                "environmentVariablesKey", "environmentVariables"))
        .executionRole(role)
        .lifecycleConfiguration(LifecycleConfiguration.builder()
                .idleRuntimeSessionTimeout(Duration.minutes(30))
                .maxLifetime(Duration.minutes(30))
                .build())
        .loggingConfigs(List.of(LoggingConfig.builder()
                .destination(loggingDestination)
                .logType(logType)
                .build()))
        .networkConfiguration(runtimeNetworkConfiguration)
        .protocolConfiguration(ProtocolType.MCP)
        .requestHeaderConfiguration(RequestHeaderConfiguration.builder()
                .allowlistedHeaders(List.of("allowlistedHeaders"))
                .build())
        .runtimeName("runtimeName")
        .tags(Map.of(
                "tagsKey", "tags"))
        .tracingEnabled(false)
        .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;
using Amazon.CDK;
using Amazon.CDK.AWS.IAM;

AgentRuntimeArtifact agentRuntimeArtifact;
LoggingDestination loggingDestination;
LogType logType;
Role role;
RuntimeAuthorizerConfiguration runtimeAuthorizerConfiguration;
RuntimeNetworkConfiguration runtimeNetworkConfiguration;

var runtime = new Runtime(this, "MyRuntime", new RuntimeProps {
    AgentRuntimeArtifact = agentRuntimeArtifact,

    // the properties below are optional
    AuthorizerConfiguration = runtimeAuthorizerConfiguration,
    Description = "description",
    EnvironmentVariables = new Dictionary<string, string> {
        { "environmentVariablesKey", "environmentVariables" }
    },
    ExecutionRole = role,
    LifecycleConfiguration = new LifecycleConfiguration {
        IdleRuntimeSessionTimeout = Duration.Minutes(30),
        MaxLifetime = Duration.Minutes(30)
    },
    LoggingConfigs = new [] { new LoggingConfig {
        Destination = loggingDestination,
        LogType = logType
    } },
    NetworkConfiguration = runtimeNetworkConfiguration,
    ProtocolConfiguration = ProtocolType.MCP,
    RequestHeaderConfiguration = new RequestHeaderConfiguration {
        AllowlistedHeaders = new [] { "allowlistedHeaders" }
    },
    RuntimeName = "runtimeName",
    Tags = new Dictionary<string, string> {
        { "tagsKey", "tags" }
    },
    TracingEnabled = false
});
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 "github.com/aws/aws-cdk-go/awsbedrockagentcorealpha"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var agentRuntimeArtifact AgentRuntimeArtifact
var loggingDestination LoggingDestination
var logType LogType
var role Role
var runtimeAuthorizerConfiguration RuntimeAuthorizerConfiguration
var runtimeNetworkConfiguration RuntimeNetworkConfiguration

runtime := bedrock_agentcore_alpha.NewRuntime(this, jsii.String("MyRuntime"), &RuntimeProps{
	AgentRuntimeArtifact: agentRuntimeArtifact,

	// the properties below are optional
	AuthorizerConfiguration: runtimeAuthorizerConfiguration,
	Description: jsii.String("description"),
	EnvironmentVariables: map[string]*string{
		"environmentVariablesKey": jsii.String("environmentVariables"),
	},
	ExecutionRole: role,
	LifecycleConfiguration: &LifecycleConfiguration{
		IdleRuntimeSessionTimeout: cdk.Duration_Minutes(jsii.Number(30)),
		MaxLifetime: cdk.Duration_*Minutes(jsii.Number(30)),
	},
	LoggingConfigs: []LoggingConfig{
		&LoggingConfig{
			Destination: loggingDestination,
			LogType: logType,
		},
	},
	NetworkConfiguration: runtimeNetworkConfiguration,
	ProtocolConfiguration: bedrock_agentcore_alpha.ProtocolType_MCP,
	RequestHeaderConfiguration: &RequestHeaderConfiguration{
		AllowlistedHeaders: []*string{
			jsii.String("allowlistedHeaders"),
		},
	},
	RuntimeName: jsii.String("runtimeName"),
	Tags: map[string]*string{
		"tagsKey": jsii.String("tags"),
	},
	TracingEnabled: jsii.Boolean(false),
})

Initializer ​

ts
new Runtime(scope: Construct, id: string, props: RuntimeProps)
python
Runtime(scope: Construct, id: str, props: RuntimeProps)
java
new Runtime(Construct scope, String id, RuntimeProps props)
csharp
new Runtime(Construct scope, string id, RuntimeProps props)
go
NewRuntime(Scope Construct, Id *string, Props RuntimeProps)

Construct Props ​

agentRuntimeArtifactAgentRuntimeArtifactagent_runtime_artifactAgentRuntimeArtifactagentRuntimeArtifactAgentRuntimeArtifactAgentRuntimeArtifactAgentRuntimeArtifactAgentRuntimeArtifactAgentRuntimeArtifactrequired#
The artifact configuration for the agent runtime Contains the container configuration with ECR URI.
authorizerConfigurationoptionalRuntimeAuthorizerConfigurationauthorizer_configurationoptionalRuntimeAuthorizerConfigurationauthorizerConfigurationoptionalRuntimeAuthorizerConfigurationAuthorizerConfigurationoptionalRuntimeAuthorizerConfigurationAuthorizerConfigurationoptionalRuntimeAuthorizerConfiguration#
Authorizer configuration for the agent runtime Use RuntimeAuthorizerConfiguration static methods to create the configuration.

Default: RuntimeAuthorizerConfiguration.iam() (IAM authentication)

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
Optional description for the agent runtime.

Default: No description Length Minimum: 1 , Maximum: 1200

environmentVariablesoptional{ [key: string]: string }environment_variablesoptionaltyping.Mapping[str, str]environmentVariablesoptionalMap<String, String>EnvironmentVariablesoptionalIDictionary<string, string>EnvironmentVariablesoptional*map[string]*string#
Environment variables for the agent runtime - Maximum 50 environment variables - Key: Must be 1-100 characters, start with letter or underscore, contain only letters, numbers, and underscores - Value: Must be 0-2048 characters (per CloudFormation specification).

Default: No environment variables

executionRoleoptionalIRoleexecution_roleoptionalIRoleexecutionRoleoptionalIRoleExecutionRoleoptionalIRoleExecutionRoleoptionalIRole#
The IAM role that provides permissions for the agent runtime If not provided, a role will be created automatically.

Default: A new role will be created

lifecycleConfigurationoptionalLifecycleConfigurationlifecycle_configurationoptionalLifecycleConfigurationlifecycleConfigurationoptionalLifecycleConfigurationLifecycleConfigurationoptionalLifecycleConfigurationLifecycleConfigurationoptionalLifecycleConfiguration#
The life cycle configuration for the AgentCore Runtime.

Default: No lifecycle configuration

loggingConfigsoptionalLoggingConfig[]logging_configsoptionaltyping.List[LoggingConfig]loggingConfigsoptionalList<LoggingConfig>LoggingConfigsoptionalLoggingConfig[]LoggingConfigsoptional*[]LoggingConfig#
Logging configuration for the runtime.

Default: No logging configured

Allows sending APPLICATION_LOGS and USAGE_LOGS to CloudWatch Logs, S3, or Kinesis Data Firehose.

networkConfigurationoptionalRuntimeNetworkConfigurationnetwork_configurationoptionalRuntimeNetworkConfigurationnetworkConfigurationoptionalRuntimeNetworkConfigurationNetworkConfigurationoptionalRuntimeNetworkConfigurationNetworkConfigurationoptionalRuntimeNetworkConfiguration#
Network configuration for the agent runtime.

Default: RuntimeNetworkConfiguration.usingPublicNetwork()

protocolConfigurationoptionalProtocolTypeprotocol_configurationoptionalProtocolTypeprotocolConfigurationoptionalProtocolTypeProtocolConfigurationoptionalProtocolTypeProtocolConfigurationoptionalProtocolType= ProtocolType.HTTP#
Protocol configuration for the agent runtime.
requestHeaderConfigurationoptionalRequestHeaderConfigurationrequest_header_configurationoptionalRequestHeaderConfigurationrequestHeaderConfigurationoptionalRequestHeaderConfigurationRequestHeaderConfigurationoptionalRequestHeaderConfigurationRequestHeaderConfigurationoptionalRequestHeaderConfiguration#
Configuration for HTTP request headers that will be passed through to the runtime.

Default: No request headers configured

runtimeNameoptionalstringruntime_nameoptionalstrruntimeNameoptionalStringRuntimeNameoptionalstringRuntimeNameoptional*string#
The name of the agent runtime 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 A list of key:value pairs of tags to apply to this Runtime resource.

Default: {} - no tags

tracingEnabledoptionalbooleantracing_enabledoptionalbooltracingEnabledoptionalBooleanTracingEnabledoptionalboolTracingEnabledoptional*bool= false#
Whether to enable X-Ray tracing for this runtime.

When enabled, traces will be delivered to AWS X-Ray.

Properties ​

agentRuntimeArnstringagent_runtime_arnstragentRuntimeArnStringAgentRuntimeArnstringAgentRuntimeArn*string#
The ARN of the agent runtime.
agentRuntimeArtifactAgentRuntimeArtifactagent_runtime_artifactAgentRuntimeArtifactagentRuntimeArtifactAgentRuntimeArtifactAgentRuntimeArtifactAgentRuntimeArtifactAgentRuntimeArtifactAgentRuntimeArtifact#
The artifact configuration for the agent runtime.
agentRuntimeIdstringagent_runtime_idstragentRuntimeIdStringAgentRuntimeIdstringAgentRuntimeId*string#
The unique identifier of the agent runtime.
agentRuntimeNamestringagent_runtime_namestragentRuntimeNameStringAgentRuntimeNamestringAgentRuntimeName*string#
The name of the agent runtime.
agentRuntimeVersionmay be undefinedstringagent_runtime_versionmay be undefinedstragentRuntimeVersionmay be undefinedStringAgentRuntimeVersionmay be undefinedstringAgentRuntimeVersionmay be undefined*string#
The version of the agent runtime.
agentStatusmay be undefinedstringagent_statusmay be undefinedstragentStatusmay be undefinedStringAgentStatusmay be undefinedstringAgentStatusmay be undefined*string#
The status of the agent runtime.
connectionsConnectionsconnectionsConnectionsconnectionsConnectionsConnectionsConnectionsConnectionsConnections#
An accessor for the Connections object that will fail if this Runtime does not have a VPC configured.
createdAtmay be undefinedstringcreated_atmay be undefinedstrcreatedAtmay be undefinedStringCreatedAtmay be undefinedstringCreatedAtmay be undefined*string#
The timestamp when the agent runtime was created.
descriptionmay be undefinedstringdescriptionmay be undefinedstrdescriptionmay be undefinedStringDescriptionmay be undefinedstringDescriptionmay be undefined*string#
Optional description for the agent runtime.
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.
lastUpdatedAtmay be undefinedstringlast_updated_atmay be undefinedstrlastUpdatedAtmay be undefinedStringLastUpdatedAtmay be undefinedstringLastUpdatedAtmay be undefined*string#
The timestamp when the agent runtime was last updated.
nodeNodenodeNodenodeNodeNodeNodeNodeNode#
The tree node.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#
Uniquely identifies this class.
roleIRoleroleIRoleroleIRoleRoleIRoleRoleIRole#
The IAM role that provides permissions for the agent runtime.
A reference to a Runtime resource.
stackStackstackStackstackStackStackStackStackStack#
The stack in which this resource is defined.

Methods ​

addEndpoint(endpointName: string, options?: AddEndpointOptions): RuntimeEndpointdef add_endpoint(self, endpoint_name: str, options: typing.Optional[AddEndpointOptions] = None) -> RuntimeEndpointpublic RuntimeEndpoint addEndpoint(String endpointName, AddEndpointOptions options)public RuntimeEndpoint AddEndpoint(string endpointName, AddEndpointOptions? options = null)func AddEndpoint(EndpointName *string, Options AddEndpointOptions) RuntimeEndpoint#
Add an endpoint to this runtime This is a convenience method that creates a RuntimeEndpoint associated with this runtime.
2 parameters · returns

Parameters

  • endpointNameendpoint_nameendpointNameendpointNameEndpointName — The name of the endpoint.
  • optionsoptionsoptionsoptionsOptions — Optional configuration for the endpoint.

Returns: The created RuntimeEndpoint

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

fromAgentRuntimeAttributes(scope: Construct, id: string, attrs: AgentRuntimeAttributes): IBedrockAgentRuntime@staticmethod def from_agent_runtime_attributes(scope: Construct, id: str, attrs: AgentRuntimeAttributes) -> IBedrockAgentRuntimepublic static IBedrockAgentRuntime fromAgentRuntimeAttributes(Construct scope, String id, AgentRuntimeAttributes attrs)public static IBedrockAgentRuntime FromAgentRuntimeAttributes(Construct scope, string id, AgentRuntimeAttributes attrs)func FromAgentRuntimeAttributes(Scope Construct, Id *string, Attrs AgentRuntimeAttributes) IBedrockAgentRuntimestatic#
Import an existing Agent Runtime using attributes This allows you to reference an Agent Runtime that was created outside of CDK.
3 parameters · returns

Parameters

  • scopescopescopescopeScope — The construct scope.
  • ididididId — The construct id.
  • attrsattrsattrsattrsAttrs — The attributes of the existing Agent Runtime.

Returns: An IBedrockAgentRuntime instance representing the imported runtime

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.