Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CodeBuild.Types.EnvironmentVariable

Description

Documentation

data EnvironmentVariable Source #

Information about an environment variable for a build project or a build.

See: newEnvironmentVariable smart constructor.

Constructors

EnvironmentVariable'

Fields

type' :: Maybe EnvironmentVariableType
The type of environment variable. Valid values include:
- PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. To learn how to specify a parameter store environment variable, see env/parameter-store in the CodeBuild User Guide.
- PLAINTEXT: An environment variable in plain text format. This is the default value.
- SECRETS_MANAGER: An environment variable stored in Secrets Manager. To learn how to specify a secrets manager environment variable, see env/secrets-manager in the CodeBuild User Guide.
name :: Text
The name or key of the environment variable.
value :: Text
The value of the environment variable.
We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially Amazon Web Services secret key IDs and secret access keys. PLAINTEXT environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.

Instances

Instances details

Eq EnvironmentVariable Source #
Instance details Defined in Amazonka.CodeBuild.Types.EnvironmentVariable Methods (==) :: EnvironmentVariable -> EnvironmentVariable -> Bool # (/=) :: EnvironmentVariable -> EnvironmentVariable -> Bool #
Read EnvironmentVariable Source #
Instance details Defined in Amazonka.CodeBuild.Types.EnvironmentVariable Methods readsPrec :: Int -> ReadS EnvironmentVariable # readList :: ReadS [EnvironmentVariable] # readPrec :: ReadPrec EnvironmentVariable # readListPrec :: ReadPrec [EnvironmentVariable] #
Show EnvironmentVariable Source #
Instance details Defined in Amazonka.CodeBuild.Types.EnvironmentVariable Methods showsPrec :: Int -> EnvironmentVariable -> ShowS # show :: EnvironmentVariable -> String # showList :: [EnvironmentVariable] -> ShowS #
Generic EnvironmentVariable Source #
Instance details Defined in Amazonka.CodeBuild.Types.EnvironmentVariable Associated Types type Rep EnvironmentVariable :: Type -> Type # Methods from :: EnvironmentVariable -> Rep EnvironmentVariable x # to :: Rep EnvironmentVariable x -> EnvironmentVariable #
NFData EnvironmentVariable Source #
Instance details Defined in Amazonka.CodeBuild.Types.EnvironmentVariable Methods rnf :: EnvironmentVariable -> () #
Hashable EnvironmentVariable Source #
Instance details Defined in Amazonka.CodeBuild.Types.EnvironmentVariable Methods hashWithSalt :: Int -> EnvironmentVariable -> Int # hash :: EnvironmentVariable -> Int #
ToJSON EnvironmentVariable Source #
Instance details Defined in Amazonka.CodeBuild.Types.EnvironmentVariable Methods toJSON :: EnvironmentVariable -> Value # toEncoding :: EnvironmentVariable -> Encoding # toJSONList :: [EnvironmentVariable] -> Value # toEncodingList :: [EnvironmentVariable] -> Encoding #
FromJSON EnvironmentVariable Source #
Instance details Defined in Amazonka.CodeBuild.Types.EnvironmentVariable Methods parseJSON :: Value -> Parser EnvironmentVariable # parseJSONList :: Value -> Parser [EnvironmentVariable] #
type Rep EnvironmentVariable Source #
Instance details Defined in Amazonka.CodeBuild.Types.EnvironmentVariable type Rep EnvironmentVariable = D1 ('MetaData "EnvironmentVariable" "Amazonka.CodeBuild.Types.EnvironmentVariable" "libZSservicesZSamazonka-codebuildZSamazonka-codebuild" 'False) (C1 ('MetaCons "EnvironmentVariable'" 'PrefixI 'True) (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EnvironmentVariableType)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newEnvironmentVariable Source #

Arguments

:: Text	`$sel:name:EnvironmentVariable'`
-> Text	`$sel:value:EnvironmentVariable'`
-> EnvironmentVariable

Create a value of EnvironmentVariable 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:type':EnvironmentVariable', environmentVariable_type - The type of environment variable. Valid values include:

PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. To learn how to specify a parameter store environment variable, see env/parameter-store in the CodeBuild User Guide.
PLAINTEXT: An environment variable in plain text format. This is the default value.
SECRETS_MANAGER: An environment variable stored in Secrets Manager. To learn how to specify a secrets manager environment variable, see env/secrets-manager in the CodeBuild User Guide.

$sel:name:EnvironmentVariable', environmentVariable_name - The name or key of the environment variable.

$sel:value:EnvironmentVariable', environmentVariable_value - The value of the environment variable.

We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially Amazon Web Services secret key IDs and secret access keys. PLAINTEXT environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.

environmentVariable_type :: Lens' EnvironmentVariable (Maybe EnvironmentVariableType) Source #

The type of environment variable. Valid values include:

PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. To learn how to specify a parameter store environment variable, see env/parameter-store in the CodeBuild User Guide.
PLAINTEXT: An environment variable in plain text format. This is the default value.
SECRETS_MANAGER: An environment variable stored in Secrets Manager. To learn how to specify a secrets manager environment variable, see env/secrets-manager in the CodeBuild User Guide.

environmentVariable_name :: Lens' EnvironmentVariable Text Source #

The name or key of the environment variable.

environmentVariable_value :: Lens' EnvironmentVariable Text Source #

The value of the environment variable.

We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially Amazon Web Services secret key IDs and secret access keys. PLAINTEXT environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.