interface InitFileAssetOptions

Language	Type name
.NET	`Amazon.CDK.AWS.EC2.InitFileAssetOptions`
Java	`software.amazon.awscdk.services.ec2.InitFileAssetOptions`
Python	`aws_cdk.aws_ec2.InitFileAssetOptions`
TypeScript (source)	`@aws-cdk/aws-ec2` » `InitFileAssetOptions`

Additional options for creating an InitFile from an asset.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as assets from '@aws-cdk/assets';
import * as ec2 from '@aws-cdk/aws-ec2';
import * as iam from '@aws-cdk/aws-iam';
import * as cdk from '@aws-cdk/core';

declare const dockerImage: cdk.DockerImage;
declare const grantable: iam.IGrantable;
declare const initServiceRestartHandle: ec2.InitServiceRestartHandle;
declare const localBundling: cdk.ILocalBundling;
const initFileAssetOptions: ec2.InitFileAssetOptions = {
  assetHash: 'assetHash',
  assetHashType: cdk.AssetHashType.SOURCE,
  base64Encoded: false,
  bundling: {
    image: dockerImage,

    // the properties below are optional
    command: ['command'],
    entrypoint: ['entrypoint'],
    environment: {
      environmentKey: 'environment',
    },
    local: localBundling,
    outputType: cdk.BundlingOutput.ARCHIVED,
    securityOpt: 'securityOpt',
    user: 'user',
    volumes: [{
      containerPath: 'containerPath',
      hostPath: 'hostPath',

      // the properties below are optional
      consistency: cdk.DockerVolumeConsistency.CONSISTENT,
    }],
    workingDirectory: 'workingDirectory',
  },
  exclude: ['exclude'],
  follow: assets.FollowMode.NEVER,
  followSymlinks: cdk.SymlinkFollowMode.NEVER,
  group: 'group',
  ignoreMode: cdk.IgnoreMode.GLOB,
  mode: 'mode',
  owner: 'owner',
  readers: [grantable],
  serviceRestartHandles: [initServiceRestartHandle],
  sourceHash: 'sourceHash',
};

Properties

Name	Type	Description
assetHash?	`string`	Specify a custom hash for this asset.
assetHashType?	`AssetHashType`	Specifies the type of hash to calculate for this asset.
base64Encoded?	`boolean`	True if the inlined content (from a string or file) should be treated as base64 encoded.
bundling?	`BundlingOptions`	Bundle the asset by executing a command in a Docker container or a custom bundling provider.
exclude?	`string[]`	Glob patterns to exclude from the copy.
follow?⚠️	`FollowMode`	A strategy for how to handle symlinks.
followSymlinks?	`SymlinkFollowMode`	A strategy for how to handle symlinks.
group?	`string`	The name of the owning group for this file.
ignoreMode?	`IgnoreMode`	The ignore behavior to use for exclude patterns.
mode?	`string`	A six-digit octal value representing the mode for this file.
owner?	`string`	The name of the owning user for this file.
readers?	`IGrantable[]`	A list of principals that should be able to read this asset from S3.
serviceRestartHandles?	`InitServiceRestartHandle[]`	Restart the given service after this file has been written.
sourceHash?⚠️	`string`	Custom hash to use when identifying the specific version of the asset.

assetHash?

Type: string (optional, default: based on assetHashType)

Specify a custom hash for this asset.

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.

assetHashType?

Type: AssetHashType (optional, default: the default is AssetHashType.SOURCE, but if assetHash is explicitly specified this value defaults to AssetHashType.CUSTOM.)

Specifies the type of hash to calculate for this asset.

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

base64Encoded?

Type: boolean (optional, default: false)

True if the inlined content (from a string or file) should be treated as base64 encoded.

Only applicable for inlined string and file content.

bundling?

Type: BundlingOptions (optional, 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)

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

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.

exclude?

Type: string[] (optional, default: nothing is excluded)

Glob patterns to exclude from the copy.

follow?⚠️

⚠️ Deprecated: use followSymlinks instead

Type: FollowMode (optional, default: Never)

A strategy for how to handle symlinks.

followSymlinks?

Type: SymlinkFollowMode (optional, default: SymlinkFollowMode.NEVER)

A strategy for how to handle symlinks.

group?

Type: string (optional, default: 'root')

The name of the owning group for this file.

Not supported for Windows systems.

ignoreMode?

Type: IgnoreMode (optional, default: IgnoreMode.GLOB)

The ignore behavior to use for exclude patterns.

mode?

Type: string (optional, default: '000644')

A six-digit octal value representing the mode for this file.

Use the first three digits for symlinks and the last three digits for setting permissions. To create a symlink, specify 120xxx, where xxx defines the permissions of the target file. To specify permissions for a file, use the last three digits, such as 000644.

Not supported for Windows systems.

owner?

Type: string (optional, default: 'root')

The name of the owning user for this file.

Not supported for Windows systems.

readers?

Type: IGrantable[] (optional, default: No principals that can read file asset.)

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

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

serviceRestartHandles?

Type: InitServiceRestartHandle[] (optional, default: Do not restart any service)

Restart the given service after this file has been written.

sourceHash?⚠️

⚠️ Deprecated: see assetHash and assetHashType

Type: string (optional, default: automatically calculate source hash based on the contents of the source file or directory.)

Custom hash to use when identifying the specific version of the asset.

For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash.

NOTE: the source 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 source hash, you will need to make sure it is updated every time the source changes, or otherwise it is possible that some deployments will not be invalidated.