class AssetEnvironmentFile

Language	Type name
.NET	Amazon.CDK.AWS.ECS.AssetEnvironmentFile
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsecs#AssetEnvironmentFile
Java	software.amazon.awscdk.services.ecs.AssetEnvironmentFile
Python	aws_cdk.aws_ecs.AssetEnvironmentFile
TypeScript (source)	aws-cdk-lib » aws_ecs » AssetEnvironmentFile

Extends EnvironmentFile

Environment file from a local directory.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_ecs as ecs } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_kms as kms } from 'aws-cdk-lib';

declare const dockerImage: cdk.DockerImage;
declare const grantable: iam.IGrantable;
declare const key: kms.Key;
declare const localBundling: cdk.ILocalBundling;
const assetEnvironmentFile = new ecs.AssetEnvironmentFile('path', /* all optional props */ {
  assetHash: 'assetHash',
  assetHashType: cdk.AssetHashType.SOURCE,
  bundling: {
    image: dockerImage,

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

      // the properties below are optional
      consistency: cdk.DockerVolumeConsistency.CONSISTENT,
    }],
    volumesFrom: ['volumesFrom'],
    workingDirectory: 'workingDirectory',
  },
  deployTime: false,
  exclude: ['exclude'],
  followSymlinks: cdk.SymlinkFollowMode.NEVER,
  ignoreMode: cdk.IgnoreMode.GLOB,
  readers: [grantable],
  sourceKMSKey: key,
});

Initializer

new AssetEnvironmentFile(path: string, options?: AssetOptions)

Parameters

• path string — The path to the asset file or directory.
• options AssetOptions

Properties

Name	Type	Description
path	string	The path to the asset file or directory.

---

path

Type: string

The path to the asset file or directory.

Methods

Name	Description
bind(scope)	Called when the container is initialized to allow this object to bind to the stack.

---

bind(scope)

public bind(scope: Construct): EnvironmentFileConfig

Parameters

• scope Construct

Returns

• EnvironmentFileConfig

Called when the container is initialized to allow this object to bind to the stack.