software.amazon.awscdk.services.ecs

Class EnvironmentFile

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ecs.EnvironmentFile

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

AssetEnvironmentFile, S3EnvironmentFile

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:01:06.772Z")
 @Stability(value=Experimental)
public abstract class EnvironmentFile
extends software.amazon.jsii.JsiiObject

(experimental) Constructs for types of environment files.

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EnvironmentFile()
protected	EnvironmentFile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	EnvironmentFile(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
abstract EnvironmentFileConfig	bind(software.constructs.Construct scope) (experimental) Called when the container is initialized to allow this object to bind to the stack.
static AssetEnvironmentFile	fromAsset(String path) (experimental) Loads the environment file from a local disk path.
static AssetEnvironmentFile	fromAsset(String path, AssetOptions options) (experimental) Loads the environment file from a local disk path.
static S3EnvironmentFile	fromBucket(IBucket bucket, String key) (experimental) Loads the environment file from an S3 bucket.
static S3EnvironmentFile	fromBucket(IBucket bucket, String key, String objectVersion) (experimental) Loads the environment file from an S3 bucket.

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

EnvironmentFile

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

EnvironmentFile

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

EnvironmentFile

@Stability(value=Experimental)
protected EnvironmentFile()

Method Detail

fromAsset

@Stability(value=Experimental)
 @NotNull
public static AssetEnvironmentFile fromAsset(@NotNull
                                                                                      String path,
                                                                                      @Nullable
                                                                                      AssetOptions options)

(experimental) Loads the environment file from a local disk path.

Parameters:

path - Local disk path. This parameter is required.

options -

fromAsset

@Stability(value=Experimental)
 @NotNull
public static AssetEnvironmentFile fromAsset(@NotNull
                                                                                      String path)

(experimental) Loads the environment file from a local disk path.

Parameters:

path - Local disk path. This parameter is required.

fromBucket

@Stability(value=Experimental)
 @NotNull
public static S3EnvironmentFile fromBucket(@NotNull
                                                                                    IBucket bucket,
                                                                                    @NotNull
                                                                                    String key,
                                                                                    @Nullable
                                                                                    String objectVersion)

(experimental) Loads the environment file from an S3 bucket.

Parameters:

bucket - The S3 bucket. This parameter is required.

key - The object key. This parameter is required.

objectVersion - Optional S3 object version.

Returns:

`S3EnvironmentFile` associated with the specified S3 object.

fromBucket

@Stability(value=Experimental)
 @NotNull
public static S3EnvironmentFile fromBucket(@NotNull
                                                                                    IBucket bucket,
                                                                                    @NotNull
                                                                                    String key)

(experimental) Loads the environment file from an S3 bucket.

Parameters:

bucket - The S3 bucket. This parameter is required.

key - The object key. This parameter is required.

Returns:

`S3EnvironmentFile` associated with the specified S3 object.

bind

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

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

Parameters:

scope - The binding scope. This parameter is required.