Skip to content
v2.274.0

CfnAssetProps Struct ​

Properties for defining a CfnAsset.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_devopsagent as devopsagent } from 'aws-cdk-lib';

declare const metadata: any;
const cfnAssetProps: devopsagent.CfnAssetProps = {
  agentSpaceId: 'agentSpaceId',
  assetType: 'assetType',

  // the properties below are optional
  files: [{
    path: 'path',

    // the properties below are optional
    contentBytes: 'contentBytes',
    contentText: 'contentText',
    metadata: metadata,
  }],
  metadata: metadata,
  zip: 'zip',
};

Properties ​

agentSpaceIdstringagent_space_idstragentSpaceIdStringAgentSpaceIdstringAgentSpaceId*stringrequired#
The unique identifier of the parent Agent Space.

The asset is created as a child of this agent space.

assetTypestringasset_typestrassetTypeStringAssetTypestringAssetType*stringrequired#
The type of asset.

The Asset API treats this as an open string; call ListAssetTypes for the current authoritative set of supported types. As of launch, customer-creatable types include skill, agents_md, and attachment.

filesoptionalIResolvable | IResolvable | CfnAsset.AssetFileProperty[]filesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AssetFileProperty]]]filesoptionalIResolvableFilesoptionalIResolvableFilesoptionalinterface{}#
Inline file list.

Mutually exclusive with Zip; enforced by the handler at Create/Update time. Write-only: not repopulated by Read.

metadataoptionalanymetadataoptionalAnymetadataoptionalObjectMetadataoptionalobjectMetadataoptionalinterface{}#
Asset metadata document.

Required and optional keys depend on AssetType. Values may be strings, numbers, booleans, or lists of any of those - validated server-side; see the public Asset API docs for the per-type metadata schema.

zipoptionalstringzipoptionalstrzipoptionalStringZipoptionalstringZipoptional*string#
Base64-encoded zip bundle containing all files for the asset.

Mutually exclusive with Files; enforced by the handler at Create/Update time. Write-only: not repopulated by Read. Server treats a zip as 'replace all files' (max 6 MiB).