Class CodeAssetOptions

(experimental) Options for configuring an S3 code asset from local files for agent runtime artifact.

Inheritance
object
CodeAssetOptions
Inherited Members
Namespace: Amazon.CDK.AWS.Bedrock.Agentcore.Alpha
Assembly: Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.dll
Syntax (csharp)
public class CodeAssetOptions : ICodeAssetOptions, IAssetOptions, IAssetOptions, IFileCopyOptions
Syntax (vb)
Public Class CodeAssetOptions Implements ICodeAssetOptions, IAssetOptions, IAssetOptions, IFileCopyOptions
Remarks

Stability: Experimental

ExampleMetadata: fixture=default infused

Examples
var agentRuntimeArtifact = AgentRuntimeArtifact.FromCodeAsset(new CodeAssetOptions {
                 Path = path.Join(__dirname, "path/to/agent/code"),
                 Runtime = AgentCoreRuntime.PYTHON_3_12,
                 Entrypoint = new [] { "opentelemetry-instrument", "main.py" }
             });

             var runtimeInstance = new Runtime(this, "MyAgentRuntime", new RuntimeProps {
                 RuntimeName = "myAgent",
                 AgentRuntimeArtifact = agentRuntimeArtifact
             });

Synopsis

Constructors

CodeAssetOptions()

(experimental) Options for configuring an S3 code asset from local files for agent runtime artifact.

Properties

AssetHash

Specify a custom hash for this asset.
AssetHashType

Specifies the type of hash to calculate for this asset.
Bundling

Bundle the asset by executing a command in a Docker container or a custom bundling provider.
DeployTime

Whether or not the asset needs to exist beyond deployment time;
DisplayName

A display name for this asset.
Entrypoint

(experimental) The entry point for the code execution, specifying the function or method that should be invoked when the code runs.
Exclude

File paths matching the patterns will be excluded.
FollowSymlinks

A strategy for how to handle symlinks.
IgnoreMode

The ignore behavior to use for exclude patterns.
Path

(experimental) The file path to the code asset.
Readers

A list of principals that should be able to read this asset from S3.
Runtime

(experimental) The runtime environment for executing the code.
SourceKMSKey

The ARN of the KMS key used to encrypt the handler code.

Constructors

CodeAssetOptions()

(experimental) Options for configuring an S3 code asset from local files for agent runtime artifact.

public CodeAssetOptions()
Remarks

Stability: Experimental

ExampleMetadata: fixture=default infused

Examples
var agentRuntimeArtifact = AgentRuntimeArtifact.FromCodeAsset(new CodeAssetOptions {
                 Path = path.Join(__dirname, "path/to/agent/code"),
                 Runtime = AgentCoreRuntime.PYTHON_3_12,
                 Entrypoint = new [] { "opentelemetry-instrument", "main.py" }
             });

             var runtimeInstance = new Runtime(this, "MyAgentRuntime", new RuntimeProps {
                 RuntimeName = "myAgent",
                 AgentRuntimeArtifact = agentRuntimeArtifact
             });

Properties

AssetHash

Specify a custom hash for this asset.

public string? AssetHash { get; set; }
Property Value

string

Remarks

If assetHashType is set it must be set to AssetHashType.CUSTOM. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash.

NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated.

Default: - based on assetHashType

AssetHashType

Specifies the type of hash to calculate for this asset.

public AssetHashType? AssetHashType { get; set; }
Property Value

AssetHashType?

Remarks

If assetHash is configured, this option must be undefined or AssetHashType.CUSTOM.

Default: - the default is AssetHashType.SOURCE, but if assetHash is explicitly specified this value defaults to AssetHashType.CUSTOM.

Bundling

Bundle the asset by executing a command in a Docker container or a custom bundling provider.

public IBundlingOptions? Bundling { get; set; }
Property Value

IBundlingOptions

Remarks

The asset path will be mounted at /asset-input. The Docker container is responsible for putting content at /asset-output. The content at /asset-output will be zipped and used as the final asset.

Default: - uploaded as-is to S3 if the asset is a regular file or a .zip file, archived into a .zip file and uploaded to S3 otherwise

DeployTime

Whether or not the asset needs to exist beyond deployment time;

public bool? DeployTime { get; set; }
Property Value

bool?

Remarks

i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds.

For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets.

Default: false

DisplayName

A display name for this asset.

public string? DisplayName { get; set; }
Property Value

string

Remarks

If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used.

The default is the construct path of the Asset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as lambda.Code.fromAsset()), this will look like MyFunction/Code.

We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like /MyBetaStack/MyFunction/Code when you are actually deploying to production.

Default: - Stack-relative construct path

Entrypoint

(experimental) The entry point for the code execution, specifying the function or method that should be invoked when the code runs.

public string[] Entrypoint { get; set; }
Property Value

string[]

Remarks

Stability: Experimental

Exclude

File paths matching the patterns will be excluded.

public string[]? Exclude { get; set; }
Property Value

string[]

Remarks

See ignoreMode to set the matching behavior. Has no effect on Assets bundled using the bundling property.

Default: - nothing is excluded

A strategy for how to handle symlinks.

public SymlinkFollowMode? FollowSymlinks { get; set; }
Property Value

SymlinkFollowMode?

Default: SymlinkFollowMode.NEVER

IgnoreMode

The ignore behavior to use for exclude patterns.

public IgnoreMode? IgnoreMode { get; set; }
Property Value

IgnoreMode?

Remarks

Default: IgnoreMode.GLOB

Path

(experimental) The file path to the code asset.

public string Path { get; set; }
Property Value

string

Remarks

Stability: Experimental

Readers

A list of principals that should be able to read this asset from S3.

public IGrantable[]? Readers { get; set; }
Property Value

IGrantable[]

Remarks

You can use asset.grantRead(principal) to grant read permissions later.

Default: - No principals that can read file asset.

Runtime

(experimental) The runtime environment for executing the code.

public AgentCoreRuntime Runtime { get; set; }
Property Value

AgentCoreRuntime

Remarks

Stability: Experimental

SourceKMSKey

The ARN of the KMS key used to encrypt the handler code.

public IKeyRef? SourceKMSKey { get; set; }
Property Value

IKeyRef

Remarks

Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.

Implements