com.amazonaws.services.batch.model.Secret Maven / Gradle / Ivy
Show all versions of aws-java-sdk-batch 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.batch.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* An object that represents the secret to expose to your container. Secrets can be exposed to a container in the
* following ways:
*
*
* -
*
* To inject sensitive data into your containers as environment variables, use the secrets container
* definition parameter.
*
*
* -
*
* To reference sensitive information in the log configuration of a container, use the secretOptions
* container definition parameter.
*
*
*
*
* For more information, see Specifying sensitive
* data in the Batch User Guide.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Secret implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the secret.
*
*/
private String name;
/**
*
* The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of the
* Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter
* Store.
*
*
*
* If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're
* launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter
* exists in a different Region, then the full ARN must be specified.
*
*
*/
private String valueFrom;
/**
*
* The name of the secret.
*
*
* @param name
* The name of the secret.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the secret.
*
*
* @return The name of the secret.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the secret.
*
*
* @param name
* The name of the secret.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Secret withName(String name) {
setName(name);
return this;
}
/**
*
* The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of the
* Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter
* Store.
*
*
*
* If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're
* launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter
* exists in a different Region, then the full ARN must be specified.
*
*
*
* @param valueFrom
* The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN)
* of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager
* Parameter Store.
*
* If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job
* you're launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If
* the parameter exists in a different Region, then the full ARN must be specified.
*
*/
public void setValueFrom(String valueFrom) {
this.valueFrom = valueFrom;
}
/**
*
* The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of the
* Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter
* Store.
*
*
*
* If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're
* launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter
* exists in a different Region, then the full ARN must be specified.
*
*
*
* @return The secret to expose to the container. The supported values are either the full Amazon Resource Name
* (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems
* Manager Parameter Store.
*
* If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job
* you're launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter.
* If the parameter exists in a different Region, then the full ARN must be specified.
*
*/
public String getValueFrom() {
return this.valueFrom;
}
/**
*
* The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of the
* Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter
* Store.
*
*
*
* If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're
* launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter
* exists in a different Region, then the full ARN must be specified.
*
*
*
* @param valueFrom
* The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN)
* of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager
* Parameter Store.
*
* If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job
* you're launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If
* the parameter exists in a different Region, then the full ARN must be specified.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Secret withValueFrom(String valueFrom) {
setValueFrom(valueFrom);
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 (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getValueFrom() != null)
sb.append("ValueFrom: ").append(getValueFrom());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Secret == false)
return false;
Secret other = (Secret) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getValueFrom() == null ^ this.getValueFrom() == null)
return false;
if (other.getValueFrom() != null && other.getValueFrom().equals(this.getValueFrom()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getValueFrom() == null) ? 0 : getValueFrom().hashCode());
return hashCode;
}
@Override
public Secret clone() {
try {
return (Secret) 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.batch.model.transform.SecretMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}