Interface IBundlingOptions
Bundling options.
Namespace: Amazon.CDK
Assembly: Amazon.CDK.dll
Syntax (csharp)
public interface IBundlingOptions
Syntax (vb)
Public Interface IBundlingOptions
Remarks
ExampleMetadata: lit=test/integ.assets.bundling.lit.ts infused
Examples
var asset = new Asset(this, "BundledAsset", new AssetProps {
Path = Join(__dirname, "markdown-asset"), // /asset-input and working directory in the container
Bundling = new BundlingOptions {
Image = DockerImage.FromBuild(Join(__dirname, "alpine-markdown")), // Build an image
Command = new [] { "sh", "-c", @"
markdown index.md > /asset-output/index.html
" }
}
});
Synopsis
Properties
Command | The command to run in the Docker container. |
Entrypoint | The entrypoint to run in the Docker container. |
Environment | The environment variables to pass to the Docker container. |
Image | The Docker image where the command will run. |
Local | Local bundling provider. |
OutputType | The type of output that this bundling operation is producing. |
SecurityOpt | Security configuration when running the docker container. |
User | The user to use when running the Docker container. |
Volumes | Additional Docker volumes to mount. |
WorkingDirectory | Working directory inside the Docker container. |
Properties
Command
The command to run in the Docker container.
virtual string[] Command { get; }
Property Value
System.String[]
Remarks
Example value: ['npm', 'install']
Default: - run the command defined in the image
Entrypoint
The entrypoint to run in the Docker container.
virtual string[] Entrypoint { get; }
Property Value
System.String[]
Remarks
Example value: ['/bin/sh', '-c']
Default: - run the entrypoint defined in the image
See: https://docs.docker.com/engine/reference/builder/#entrypoint
Environment
The environment variables to pass to the Docker container.
virtual IDictionary<string, string> Environment { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Default: - no environment variables.
Image
Local
Local bundling provider.
virtual ILocalBundling Local { get; }
Property Value
Remarks
The provider implements a method tryBundle()
which should return true
if local bundling was performed. If false
is returned, docker bundling
will be done.
Default: - bundling will only be performed in a Docker container
OutputType
The type of output that this bundling operation is producing.
virtual Nullable<BundlingOutput> OutputType { get; }
Property Value
System.Nullable<BundlingOutput>
Remarks
Default: BundlingOutput.AUTO_DISCOVER
SecurityOpt
Security configuration when running the docker container.
virtual string SecurityOpt { get; }
Property Value
System.String
Remarks
Default: - no security options
User
The user to use when running the Docker container.
virtual string User { get; }
Property Value
System.String
Remarks
user | user:group | uid | uid:gid | user:gid | uid:group
Default: - uid:gid of the current user or 1000:1000 on Windows
Volumes
Additional Docker volumes to mount.
virtual IDockerVolume[] Volumes { get; }
Property Value
Remarks
Default: - no additional volumes are mounted
WorkingDirectory
Working directory inside the Docker container.
virtual string WorkingDirectory { get; }
Property Value
System.String
Remarks
Default: /asset-input