AWS CDK Reference

Appearance

v2.275.0

FileAsset Struct ​

A file asset.

Source
node_modules/@aws-cdk/cloud-assembly-schema/lib/assets/file-asset.d.ts
Type last changed
v2.187.0 · 31 Mar 2025

Example ​

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

declare const assumeRoleAdditionalOptions: any;
const fileAsset: cloud_assembly_schema.FileAsset = {
  destinations: {
    destinationsKey: {
      bucketName: 'bucketName',
      objectKey: 'objectKey',

      // the properties below are optional
      assumeRoleAdditionalOptions: {
        assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,
      },
      assumeRoleArn: 'assumeRoleArn',
      assumeRoleExternalId: 'assumeRoleExternalId',
      region: 'region',
    },
  },
  source: {
    executable: ['executable'],
    packaging: cloud_assembly_schema.FileAssetPackaging.FILE,
    path: 'path',
  },

  // the properties below are optional
  displayName: 'displayName',
};

Properties ​

destinations{ [key: string]: FileDestination }destinationstyping.Mapping[str, FileDestination]destinationsMap<String, FileDestination>DestinationsIDictionary<string, FileDestination>Destinations*map[string]FileDestinationrequired#
Destinations for this file asset.
displayNameoptionalstringdisplay_nameoptionalstrdisplayNameoptionalStringDisplayNameoptionalstringDisplayNameoptional*string#
A display name for this asset.

Default: The identifier will be used as the display name

sourceFileSourcesourceFileSourcesourceFileSourceSourceFileSourceSourceFileSourcerequired#
Source description for file assets.