Interface CustomCommandOptions
- All Superinterfaces:
AssetOptions
,AssetOptions
,FileCopyOptions
,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CustomCommandOptions.Jsii$Proxy
@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
date="2025-02-17T19:20:30.843Z")
@Stability(Stable)
public interface CustomCommandOptions
extends software.amazon.jsii.JsiiSerializable, AssetOptions
Options for creating
AssetCode
with a custom command, such as running a buildfile.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.*; import software.amazon.awscdk.services.iam.*; import software.amazon.awscdk.services.kms.*; import software.amazon.awscdk.services.lambda.*; Object commandOptions; DockerImage dockerImage; IGrantable grantable; Key key; ILocalBundling localBundling; CustomCommandOptions customCommandOptions = CustomCommandOptions.builder() .assetHash("assetHash") .assetHashType(AssetHashType.SOURCE) .bundling(BundlingOptions.builder() .image(dockerImage) // the properties below are optional .bundlingFileAccess(BundlingFileAccess.VOLUME_COPY) .command(List.of("command")) .entrypoint(List.of("entrypoint")) .environment(Map.of( "environmentKey", "environment")) .local(localBundling) .network("network") .outputType(BundlingOutput.ARCHIVED) .platform("platform") .securityOpt("securityOpt") .user("user") .volumes(List.of(DockerVolume.builder() .containerPath("containerPath") .hostPath("hostPath") // the properties below are optional .consistency(DockerVolumeConsistency.CONSISTENT) .build())) .volumesFrom(List.of("volumesFrom")) .workingDirectory("workingDirectory") .build()) .commandOptions(Map.of( "commandOptionsKey", commandOptions)) .deployTime(false) .exclude(List.of("exclude")) .followSymlinks(SymlinkFollowMode.NEVER) .ignoreMode(IgnoreMode.GLOB) .readers(List.of(grantable)) .sourceKMSKey(key) .build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCustomCommandOptions
static final class
An implementation forCustomCommandOptions
-
Method Summary
Modifier and TypeMethodDescriptionstatic CustomCommandOptions.Builder
builder()
options that are passed to the spawned process, which determine the characteristics of the spawned process.Methods inherited from interface software.amazon.awscdk.AssetOptions
getAssetHash, getAssetHashType, getBundling
Methods inherited from interface software.amazon.awscdk.services.s3.assets.AssetOptions
getDeployTime, getReaders, getSourceKMSKey
Methods inherited from interface software.amazon.awscdk.FileCopyOptions
getExclude, getFollowSymlinks, getIgnoreMode
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getCommandOptions
options that are passed to the spawned process, which determine the characteristics of the spawned process.Default: : see `child_process.SpawnSyncOptions` (https://nodejs.org/api/child_process.html#child_processspawnsynccommand-args-options).
-
builder
- Returns:
- a
CustomCommandOptions.Builder
ofCustomCommandOptions
-