libZSservicesZSamazonka-batchZSamazonka-batch
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Batch.Types.Secret

Description

 
Synopsis

Documentation

data Secret Source #

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.

See: newSecret smart constructor.

Constructors

Secret' 

Fields

  • name :: Text

    The name of the secret.

  • valueFrom :: Text

    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.

Instances

Instances details
Eq Secret Source # 
Instance details

Defined in Amazonka.Batch.Types.Secret

Methods

(==) :: Secret -> Secret -> Bool #

(/=) :: Secret -> Secret -> Bool #

Read Secret Source # 
Instance details

Defined in Amazonka.Batch.Types.Secret

Show Secret Source # 
Instance details

Defined in Amazonka.Batch.Types.Secret

Generic Secret Source # 
Instance details

Defined in Amazonka.Batch.Types.Secret

Associated Types

type Rep Secret :: Type -> Type #

Methods

from :: Secret -> Rep Secret x #

to :: Rep Secret x -> Secret #

NFData Secret Source # 
Instance details

Defined in Amazonka.Batch.Types.Secret

Methods

rnf :: Secret -> () #

Hashable Secret Source # 
Instance details

Defined in Amazonka.Batch.Types.Secret

Methods

hashWithSalt :: Int -> Secret -> Int #

hash :: Secret -> Int #

ToJSON Secret Source # 
Instance details

Defined in Amazonka.Batch.Types.Secret

FromJSON Secret Source # 
Instance details

Defined in Amazonka.Batch.Types.Secret

type Rep Secret Source # 
Instance details

Defined in Amazonka.Batch.Types.Secret

type Rep Secret = D1 ('MetaData "Secret" "Amazonka.Batch.Types.Secret" "libZSservicesZSamazonka-batchZSamazonka-batch" 'False) (C1 ('MetaCons "Secret'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "valueFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newSecret Source #

Create a value of Secret with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:name:Secret', secret_name - The name of the secret.

$sel:valueFrom:Secret', secret_valueFrom - 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.

secret_name :: Lens' Secret Text Source #

The name of the secret.

secret_valueFrom :: Lens' Secret Text Source #

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.