AssetEnvironmentFile Class
Environment file from a local directory.
Example
ts
// 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 interfaces_kms } from 'aws-cdk-lib/interfaces';
declare const dockerImage: cdk.DockerImage;
declare const grantable: iam.IGrantable;
declare const keyRef: interfaces_kms.IKeyRef;
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,
displayName: 'displayName',
exclude: ['exclude'],
followSymlinks: cdk.SymlinkFollowMode.NEVER,
ignoreMode: cdk.IgnoreMode.GLOB,
readers: [grantable],
sourceKMSKey: keyRef,
});
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_ecs as ecs
from aws_cdk import aws_iam as iam
from aws_cdk.interfaces import aws_kms as interfaces_kms
# docker_image: cdk.DockerImage
# grantable: iam.IGrantable
# key_ref: interfaces_kms.IKeyRef
# local_bundling: cdk.ILocalBundling
asset_environment_file = ecs.AssetEnvironmentFile("path",
asset_hash="assetHash",
asset_hash_type=cdk.AssetHashType.SOURCE,
bundling=cdk.BundlingOptions(
image=docker_image,
# the properties below are optional
bundling_file_access=cdk.BundlingFileAccess.VOLUME_COPY,
command=["command"],
entrypoint=["entrypoint"],
environment={
"environment_key": "environment"
},
local=local_bundling,
network="network",
output_type=cdk.BundlingOutput.ARCHIVED,
platform="platform",
security_opt="securityOpt",
user="user",
volumes=[cdk.DockerVolume(
container_path="containerPath",
host_path="hostPath",
# the properties below are optional
consistency=cdk.DockerVolumeConsistency.CONSISTENT
)],
volumes_from=["volumesFrom"],
working_directory="workingDirectory"
),
deploy_time=False,
display_name="displayName",
exclude=["exclude"],
follow_symlinks=cdk.SymlinkFollowMode.NEVER,
ignore_mode=cdk.IgnoreMode.GLOB,
readers=[grantable],
source_kms_key=key_ref
)
java
// 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.*;
import software.amazon.awscdk.interfaces.kms.*;
DockerImage dockerImage;
IGrantable grantable;
IKeyRef keyRef;
ILocalBundling localBundling;
AssetEnvironmentFile assetEnvironmentFile = AssetEnvironmentFile.Builder.create("path")
.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())
.deployTime(false)
.displayName("displayName")
.exclude(List.of("exclude"))
.followSymlinks(SymlinkFollowMode.NEVER)
.ignoreMode(IgnoreMode.GLOB)
.readers(List.of(grantable))
.sourceKMSKey(keyRef)
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.ECS;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.Interfaces.KMS;
DockerImage dockerImage;
IGrantable grantable;
IKeyRef keyRef;
ILocalBundling localBundling;
var assetEnvironmentFile = new AssetEnvironmentFile("path", new AssetOptions {
AssetHash = "assetHash",
AssetHashType = AssetHashType.SOURCE,
Bundling = new BundlingOptions {
Image = dockerImage,
// the properties below are optional
BundlingFileAccess = BundlingFileAccess.VOLUME_COPY,
Command = new [] { "command" },
Entrypoint = new [] { "entrypoint" },
Environment = new Dictionary<string, string> {
{ "environmentKey", "environment" }
},
Local = localBundling,
Network = "network",
OutputType = BundlingOutput.ARCHIVED,
Platform = "platform",
SecurityOpt = "securityOpt",
User = "user",
Volumes = new [] { new DockerVolume {
ContainerPath = "containerPath",
HostPath = "hostPath",
// the properties below are optional
Consistency = DockerVolumeConsistency.CONSISTENT
} },
VolumesFrom = new [] { "volumesFrom" },
WorkingDirectory = "workingDirectory"
},
DeployTime = false,
DisplayName = "displayName",
Exclude = new [] { "exclude" },
FollowSymlinks = SymlinkFollowMode.NEVER,
IgnoreMode = IgnoreMode.GLOB,
Readers = new [] { grantable },
SourceKMSKey = keyRef
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var dockerImage DockerImage
var grantable IGrantable
var keyRef IKeyRef
var localBundling ILocalBundling
assetEnvironmentFile := awscdk.Aws_ecs.NewAssetEnvironmentFile(jsii.String("path"), &AssetOptions{
AssetHash: jsii.String("assetHash"),
AssetHashType: cdk.AssetHashType_SOURCE,
Bundling: &BundlingOptions{
Image: dockerImage,
// the properties below are optional
BundlingFileAccess: cdk.BundlingFileAccess_VOLUME_COPY,
Command: []*string{
jsii.String("command"),
},
Entrypoint: []*string{
jsii.String("entrypoint"),
},
Environment: map[string]*string{
"environmentKey": jsii.String("environment"),
},
Local: localBundling,
Network: jsii.String("network"),
OutputType: cdk.BundlingOutput_ARCHIVED,
Platform: jsii.String("platform"),
SecurityOpt: jsii.String("securityOpt"),
User: jsii.String("user"),
Volumes: []DockerVolume{
&DockerVolume{
ContainerPath: jsii.String("containerPath"),
HostPath: jsii.String("hostPath"),
// the properties below are optional
Consistency: cdk.DockerVolumeConsistency_CONSISTENT,
},
},
VolumesFrom: []*string{
jsii.String("volumesFrom"),
},
WorkingDirectory: jsii.String("workingDirectory"),
},
DeployTime: jsii.Boolean(false),
DisplayName: jsii.String("displayName"),
Exclude: []*string{
jsii.String("exclude"),
},
FollowSymlinks: cdk.SymlinkFollowMode_NEVER,
IgnoreMode: cdk.IgnoreMode_GLOB,
Readers: []IGrantable{
grantable,
},
SourceKMSKey: keyRef,
})
Initializer
ts
new AssetEnvironmentFile(path: string, options?: AssetOptions)
python
AssetEnvironmentFile(path: str, options: typing.Optional[AssetOptions] = None)
java
new AssetEnvironmentFile(String path, AssetOptions options)
csharp
new AssetEnvironmentFile(string path, AssetOptions? options = null)
go
NewAssetEnvironmentFile(Path *string, Options AssetOptions)
Properties
The path to the asset file or directory.
Methods
bind(scope: Construct): EnvironmentFileConfigdef bind(self, scope: Construct) -> EnvironmentFileConfigpublic EnvironmentFileConfig bind(Construct scope)public EnvironmentFileConfig Bind(Construct scope)func Bind(Scope Construct) EnvironmentFileConfig#Called when the container is initialized to allow this object to bind to the stack.
fromAsset(path: string, options?: AssetOptions): AssetEnvironmentFile // chainable@staticmethod def from_asset(path: str, options: typing.Optional[AssetOptions] = None) -> AssetEnvironmentFilepublic static AssetEnvironmentFile fromAsset(String path, AssetOptions options)public static AssetEnvironmentFile FromAsset(string path, AssetOptions? options = null)func FromAsset(Path *string, Options AssetOptions) AssetEnvironmentFilestatic#Loads the environment file from a local disk path.
1 parameter
Parameters
pathpathpathpathPath— Local disk path.
fromBucket(bucket: IBucket, key: string, objectVersion?: string): S3EnvironmentFile@staticmethod def from_bucket(bucket: IBucket, key: str, object_version: typing.Optional[str] = None) -> S3EnvironmentFilepublic static S3EnvironmentFile fromBucket(IBucket bucket, String key, String objectVersion)public static S3EnvironmentFile FromBucket(IBucket bucket, string key, string? objectVersion = null)func FromBucket(Bucket IBucket, Key *string, ObjectVersion *string) S3EnvironmentFilestatic#Loads the environment file from an S3 bucket.
3 parameters · returns
Parameters
bucketbucketbucketbucketBucket— The S3 bucket.keykeykeykeyKey— The object key.objectVersionobject_versionobjectVersionobjectVersionObjectVersion— Optional S3 object version.
Returns: S3EnvironmentFile associated with the specified S3 object.