Secret (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ecs.model.Secret

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Secret
extends Object
implements Serializable, Cloneable, StructuredPojo
```
An object representing the secret to expose to your container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Secret()

Constructors
Constructor and Description
`Secret()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Secret`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getName()` The value to set as the environment variable on the container.
`String`	`getValueFrom()` The secret to expose to the container.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setName(String name)` The value to set as the environment variable on the container.
`void`	`setValueFrom(String valueFrom)` The secret to expose to the container.
`String`	`toString()` Returns a string representation of this object.
`Secret`	`withName(String name)` The value to set as the environment variable on the container.
`Secret`	`withValueFrom(String valueFrom)` The secret to expose to the container.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Secret
```
public Secret()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The value to set as the environment variable on the container.
    
    Parameters:
    
    name - The value to set as the environment variable on the container.
  - getName
```
public String getName()
```
    The value to set as the environment variable on the container.
    
    Returns:
    
    The value to set as the environment variable on the container.
  - withName
```
public Secret withName(String name)
```
    The value to set as the environment variable on the container.
    
    Parameters:
    
    name - The value to set as the environment variable on the container.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setValueFrom
```
public void setValueFrom(String valueFrom)
```
    The secret to expose to the container. If your task is using the EC2 launch type, then supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store. If your task is using the Fargate launch type, then the only supported value is the full ARN of the parameter in the AWS Systems Manager Parameter Store.
    
    If the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
    
    Parameters:
    
    valueFrom - The secret to expose to the container. If your task is using the EC2 launch type, then supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store. If your task is using the Fargate launch type, then the only supported value is the full ARN of the parameter in the AWS Systems Manager Parameter Store.
    
    If the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
  - getValueFrom
```
public String getValueFrom()
```
    The secret to expose to the container. If your task is using the EC2 launch type, then supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store. If your task is using the Fargate launch type, then the only supported value is the full ARN of the parameter in the AWS Systems Manager Parameter Store.
    
    If the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
    
    Returns:
    
    The secret to expose to the container. If your task is using the EC2 launch type, then supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store. If your task is using the Fargate launch type, then the only supported value is the full ARN of the parameter in the AWS Systems Manager Parameter Store.
    
    If the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
  - withValueFrom
```
public Secret withValueFrom(String valueFrom)
```
    The secret to expose to the container. If your task is using the EC2 launch type, then supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store. If your task is using the Fargate launch type, then the only supported value is the full ARN of the parameter in the AWS Systems Manager Parameter Store.
    
    If the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
    
    Parameters:
    
    valueFrom - The secret to expose to the container. If your task is using the EC2 launch type, then supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store. If your task is using the Fargate launch type, then the only supported value is the full ARN of the parameter in the AWS Systems Manager Parameter Store.
    
    If the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String 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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Secret clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Secret

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Secret

Method Detail

setName

getName

withName

setValueFrom

getValueFrom

withValueFrom

toString

equals

hashCode

clone

marshall