software.amazon.awscdk.services.ecs

Class AssetEnvironmentFile

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ecs.EnvironmentFile

software.amazon.awscdk.services.ecs.AssetEnvironmentFile

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.571Z")
 @Stability(value=Stable)
public class 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 software.amazon.awscdk.*;
 import software.amazon.awscdk.services.ecs.*;
 import software.amazon.awscdk.services.iam.*;
 DockerImage dockerImage;
 IGrantable grantable;
 ILocalBundling localBundling;
 AssetEnvironmentFile assetEnvironmentFile = AssetEnvironmentFile.Builder.create("path")
         .assetHash("assetHash")
         .assetHashType(AssetHashType.SOURCE)
         .bundling(BundlingOptions.builder()
                 .image(dockerImage)
                 // the properties below are optional
                 .command(List.of("command"))
                 .entrypoint(List.of("entrypoint"))
                 .environment(Map.of(
                         "environmentKey", "environment"))
                 .local(localBundling)
                 .network("network")
                 .outputType(BundlingOutput.ARCHIVED)
                 .securityOpt("securityOpt")
                 .user("user")
                 .volumes(List.of(DockerVolume.builder()
                         .containerPath("containerPath")
                         .hostPath("hostPath")
                         // the properties below are optional
                         .consistency(DockerVolumeConsistency.CONSISTENT)
                         .build()))
                 .workingDirectory("workingDirectory")
                 .build())
         .exclude(List.of("exclude"))
         .followSymlinks(SymlinkFollowMode.NEVER)
         .ignoreMode(IgnoreMode.GLOB)
         .readers(List.of(grantable))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AssetEnvironmentFile.Builder A fluent builder for AssetEnvironmentFile.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AssetEnvironmentFile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AssetEnvironmentFile(software.amazon.jsii.JsiiObjectRef objRef)
	AssetEnvironmentFile(String path)
	AssetEnvironmentFile(String path, AssetOptions options)

Method Summary

Modifier and Type	Method and Description
EnvironmentFileConfig	bind(software.constructs.Construct scope) Called when the container is initialized to allow this object to bind to the stack.
String	getPath() The path to the asset file or directory.

Methods inherited from class software.amazon.awscdk.services.ecs.EnvironmentFile

fromAsset, fromAsset, fromBucket, fromBucket

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

AssetEnvironmentFile

protected AssetEnvironmentFile(software.amazon.jsii.JsiiObjectRef objRef)

AssetEnvironmentFile

protected AssetEnvironmentFile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

AssetEnvironmentFile

@Stability(value=Stable)
public AssetEnvironmentFile(@NotNull
                                                     String path,
                                                     @Nullable
                                                     AssetOptions options)

Parameters:

path - The path to the asset file or directory. This parameter is required.

options -

AssetEnvironmentFile

@Stability(value=Stable)
public AssetEnvironmentFile(@NotNull
                                                     String path)

Parameters:

path - The path to the asset file or directory. This parameter is required.

Method Detail

bind

@Stability(value=Stable)
 @NotNull
public EnvironmentFileConfig bind(@NotNull
                                                                     software.constructs.Construct scope)

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

Specified by:

bind in class EnvironmentFile

Parameters:

scope - This parameter is required.

getPath

@Stability(value=Stable)
 @NotNull
public String getPath()

The path to the asset file or directory.