Class EcsEnvironmentFile
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EcsEnvironmentFile.Builder,
EcsEnvironmentFile>
A list of files containing the environment variables to pass to a container. You can specify up to ten environment
files. The file must have a .env
file extension. Each line in an environment file should contain an
environment variable in VARIABLE=VALUE
format. Lines beginning with #
are treated as
comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file.
If there are environment variables specified using the environment
parameter in a container definition,
they take precedence over the variables contained within an environment file. If multiple environment files are
specified that contain the same variable, they're processed from the top down. We recommend that you use unique
variable names. For more information, see Specifying environment
variables in the Amazon Elastic Container Service Developer Guide.
This parameter is only supported for tasks hosted on Fargate using the following platform versions:
-
Linux platform version
1.4.0
or later. -
Windows platform version
1.0.0
or later.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic EcsEnvironmentFile.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends EcsEnvironmentFile.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final EcsEnvironmentFileType
type()
The file type to use.final String
The file type to use.final String
value()
The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
type
The file type to use. The only supported value is
s3
.If the service returns an enum value that is not available in the current SDK version,
type
will returnEcsEnvironmentFileType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The file type to use. The only supported value is
s3
. - See Also:
-
typeAsString
The file type to use. The only supported value is
s3
.If the service returns an enum value that is not available in the current SDK version,
type
will returnEcsEnvironmentFileType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The file type to use. The only supported value is
s3
. - See Also:
-
value
The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
- Returns:
- The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<EcsEnvironmentFile.Builder,
EcsEnvironmentFile> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-