com.amazonaws.services.ecs.model.EnvironmentFile Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ecs Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ecs.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* 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.
*
*
* 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.
*
*
* You must use the following platforms for the Fargate launch type:
*
*
* -
*
* Linux platform version 1.4.0 or later.
*
*
* -
*
* Windows platform version 1.0.0 or later.
*
*
*
*
* Consider the following when using the Fargate launch type:
*
*
* -
*
* The file is handled like a native Docker env-file.
*
*
* -
*
* There is no support for shell escape handling.
*
*
* -
*
* The container entry point interperts the VARIABLE values.
*
*
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class EnvironmentFile implements Serializable, Cloneable, StructuredPojo {
/**
*
* The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
*
*/
private String value;
/**
*
* The file type to use. The only supported value is s3.
*
*/
private String type;
/**
*
* The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
*
*
* @param value
* The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
*/
public void setValue(String value) {
this.value = value;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
*
*
* @return The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
*/
public String getValue() {
return this.value;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
*
*
* @param value
* The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EnvironmentFile withValue(String value) {
setValue(value);
return this;
}
/**
*
* The file type to use. The only supported value is s3.
*
*
* @param type
* The file type to use. The only supported value is s3.
* @see EnvironmentFileType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* The file type to use. The only supported value is s3.
*
*
* @return The file type to use. The only supported value is s3.
* @see EnvironmentFileType
*/
public String getType() {
return this.type;
}
/**
*
* The file type to use. The only supported value is s3.
*
*
* @param type
* The file type to use. The only supported value is s3.
* @return Returns a reference to this object so that method calls can be chained together.
* @see EnvironmentFileType
*/
public EnvironmentFile withType(String type) {
setType(type);
return this;
}
/**
*
* The file type to use. The only supported value is s3.
*
*
* @param type
* The file type to use. The only supported value is s3.
* @return Returns a reference to this object so that method calls can be chained together.
* @see EnvironmentFileType
*/
public EnvironmentFile withType(EnvironmentFileType type) {
this.type = type.toString();
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getValue() != null)
sb.append("Value: ").append(getValue()).append(",");
if (getType() != null)
sb.append("Type: ").append(getType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof EnvironmentFile == false)
return false;
EnvironmentFile other = (EnvironmentFile) obj;
if (other.getValue() == null ^ this.getValue() == null)
return false;
if (other.getValue() != null && other.getValue().equals(this.getValue()) == false)
return false;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getValue() == null) ? 0 : getValue().hashCode());
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
return hashCode;
}
@Override
public EnvironmentFile clone() {
try {
return (EnvironmentFile) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.ecs.model.transform.EnvironmentFileMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}