Class: Aws::Batch::Types::Secret

Inherits:

Struct

Object
Struct
Aws::Batch::Types::Secret

show all

Defined in:: gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb

Overview

Note:

When making an API call, you may pass Secret data as a hash:

{
  name: "String", # required
  value_from: "String", # required
}

An object representing 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.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#name ⇒ String
The name of the secret.
#value_from ⇒ String
The secret to expose to the container.

Instance Attribute Details

#name ⇒ `String`

The name of the secret.

Returns:

(String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 5719

class Secret < Struct.new(
  :name,
  :value_from)
  SENSITIVE = []
  include Aws::Structure
end

#value_from ⇒ `String`

The secret to expose to the container. The supported values are either the full 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 ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.