{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.SSM.PutParameter
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Add a parameter to the system.
module Amazonka.SSM.PutParameter
  ( -- * Creating a Request
    PutParameter (..),
    newPutParameter,

    -- * Request Lenses
    putParameter_allowedPattern,
    putParameter_dataType,
    putParameter_description,
    putParameter_keyId,
    putParameter_overwrite,
    putParameter_policies,
    putParameter_tags,
    putParameter_tier,
    putParameter_type,
    putParameter_name,
    putParameter_value,

    -- * Destructuring the Response
    PutParameterResponse (..),
    newPutParameterResponse,

    -- * Response Lenses
    putParameterResponse_tier,
    putParameterResponse_httpStatus,
    putParameterResponse_version,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
import Amazonka.SSM.Types

-- | /See:/ 'newPutParameter' smart constructor.
data PutParameter = PutParameter'
  { -- | A regular expression used to validate the parameter value. For example,
    -- for String types with values restricted to numbers, you can specify the
    -- following: AllowedPattern=^\\d+$
    PutParameter -> Maybe Text
allowedPattern :: Prelude.Maybe Prelude.Text,
    -- | The data type for a @String@ parameter. Supported data types include
    -- plain text and Amazon Machine Image (AMI) IDs.
    --
    -- __The following data type values are supported.__
    --
    -- -   @text@
    --
    -- -   @aws:ec2:image@
    --
    -- -   @aws:ssm:integration@
    --
    -- When you create a @String@ parameter and specify @aws:ec2:image@, Amazon
    -- Web Services Systems Manager validates the parameter value is in the
    -- required format, such as @ami-12345abcdeEXAMPLE@, and that the specified
    -- AMI is available in your Amazon Web Services account. For more
    -- information, see
    -- <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html Native parameter support for Amazon Machine Image (AMI) IDs>
    -- in the /Amazon Web Services Systems Manager User Guide/.
    PutParameter -> Maybe Text
dataType :: Prelude.Maybe Prelude.Text,
    -- | Information about the parameter that you want to add to the system.
    -- Optional but recommended.
    --
    -- Don\'t enter personally identifiable information in this field.
    PutParameter -> Maybe Text
description :: Prelude.Maybe Prelude.Text,
    -- | The Key Management Service (KMS) ID that you want to use to encrypt a
    -- parameter. Either the default KMS key automatically assigned to your
    -- Amazon Web Services account or a custom key. Required for parameters
    -- that use the @SecureString@ data type.
    --
    -- If you don\'t specify a key ID, the system uses the default key
    -- associated with your Amazon Web Services account.
    --
    -- -   To use your default KMS key, choose the @SecureString@ data type,
    --     and do /not/ specify the @Key ID@ when you create the parameter. The
    --     system automatically populates @Key ID@ with your default KMS key.
    --
    -- -   To use a custom KMS key, choose the @SecureString@ data type with
    --     the @Key ID@ parameter.
    PutParameter -> Maybe Text
keyId :: Prelude.Maybe Prelude.Text,
    -- | Overwrite an existing parameter. The default value is @false@.
    PutParameter -> Maybe Bool
overwrite :: Prelude.Maybe Prelude.Bool,
    -- | One or more policies to apply to a parameter. This operation takes a
    -- JSON array. Parameter Store, a capability of Amazon Web Services Systems
    -- Manager supports the following policy types:
    --
    -- Expiration: This policy deletes the parameter after it expires. When you
    -- create the policy, you specify the expiration date. You can update the
    -- expiration date and time by updating the policy. Updating the
    -- /parameter/ doesn\'t affect the expiration date and time. When the
    -- expiration time is reached, Parameter Store deletes the parameter.
    --
    -- ExpirationNotification: This policy initiates an event in Amazon
    -- CloudWatch Events that notifies you about the expiration. By using this
    -- policy, you can receive notification before or after the expiration time
    -- is reached, in units of days or hours.
    --
    -- NoChangeNotification: This policy initiates a CloudWatch Events event if
    -- a parameter hasn\'t been modified for a specified period of time. This
    -- policy type is useful when, for example, a secret needs to be changed
    -- within a period of time, but it hasn\'t been changed.
    --
    -- All existing policies are preserved until you send new policies or an
    -- empty policy. For more information about parameter policies, see
    -- <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html Assigning parameter policies>.
    PutParameter -> Maybe Text
policies :: Prelude.Maybe Prelude.Text,
    -- | Optional metadata that you assign to a resource. Tags enable you to
    -- categorize a resource in different ways, such as by purpose, owner, or
    -- environment. For example, you might want to tag a Systems Manager
    -- parameter to identify the type of resource to which it applies, the
    -- environment, or the type of configuration data referenced by the
    -- parameter. In this case, you could specify the following key-value
    -- pairs:
    --
    -- -   @Key=Resource,Value=S3bucket@
    --
    -- -   @Key=OS,Value=Windows@
    --
    -- -   @Key=ParameterType,Value=LicenseKey@
    --
    -- To add tags to an existing Systems Manager parameter, use the
    -- AddTagsToResource operation.
    PutParameter -> Maybe [Tag]
tags :: Prelude.Maybe [Tag],
    -- | The parameter tier to assign to a parameter.
    --
    -- Parameter Store offers a standard tier and an advanced tier for
    -- parameters. Standard parameters have a content size limit of 4 KB and
    -- can\'t be configured to use parameter policies. You can create a maximum
    -- of 10,000 standard parameters for each Region in an Amazon Web Services
    -- account. Standard parameters are offered at no additional cost.
    --
    -- Advanced parameters have a content size limit of 8 KB and can be
    -- configured to use parameter policies. You can create a maximum of
    -- 100,000 advanced parameters for each Region in an Amazon Web Services
    -- account. Advanced parameters incur a charge. For more information, see
    -- <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html Standard and advanced parameter tiers>
    -- in the /Amazon Web Services Systems Manager User Guide/.
    --
    -- You can change a standard parameter to an advanced parameter any time.
    -- But you can\'t revert an advanced parameter to a standard parameter.
    -- Reverting an advanced parameter to a standard parameter would result in
    -- data loss because the system would truncate the size of the parameter
    -- from 8 KB to 4 KB. Reverting would also remove any policies attached to
    -- the parameter. Lastly, advanced parameters use a different form of
    -- encryption than standard parameters.
    --
    -- If you no longer need an advanced parameter, or if you no longer want to
    -- incur charges for an advanced parameter, you must delete it and recreate
    -- it as a new standard parameter.
    --
    -- __Using the Default Tier Configuration__
    --
    -- In @PutParameter@ requests, you can specify the tier to create the
    -- parameter in. Whenever you specify a tier in the request, Parameter
    -- Store creates or updates the parameter according to that request.
    -- However, if you don\'t specify a tier in a request, Parameter Store
    -- assigns the tier based on the current Parameter Store default tier
    -- configuration.
    --
    -- The default tier when you begin using Parameter Store is the
    -- standard-parameter tier. If you use the advanced-parameter tier, you can
    -- specify one of the following as the default:
    --
    -- -   __Advanced__: With this option, Parameter Store evaluates all
    --     requests as advanced parameters.
    --
    -- -   __Intelligent-Tiering__: With this option, Parameter Store evaluates
    --     each request to determine if the parameter is standard or advanced.
    --
    --     If the request doesn\'t include any options that require an advanced
    --     parameter, the parameter is created in the standard-parameter tier.
    --     If one or more options requiring an advanced parameter are included
    --     in the request, Parameter Store create a parameter in the
    --     advanced-parameter tier.
    --
    --     This approach helps control your parameter-related costs by always
    --     creating standard parameters unless an advanced parameter is
    --     necessary.
    --
    -- Options that require an advanced parameter include the following:
    --
    -- -   The content size of the parameter is more than 4 KB.
    --
    -- -   The parameter uses a parameter policy.
    --
    -- -   More than 10,000 parameters already exist in your Amazon Web
    --     Services account in the current Amazon Web Services Region.
    --
    -- For more information about configuring the default tier option, see
    -- <https://docs.aws.amazon.com/systems-manager/latest/userguide/ps-default-tier.html Specifying a default parameter tier>
    -- in the /Amazon Web Services Systems Manager User Guide/.
    PutParameter -> Maybe ParameterTier
tier :: Prelude.Maybe ParameterTier,
    -- | The type of parameter that you want to add to the system.
    --
    -- @SecureString@ isn\'t currently supported for CloudFormation templates.
    --
    -- Items in a @StringList@ must be separated by a comma (,). You can\'t use
    -- other punctuation or special character to escape items in the list. If
    -- you have a parameter value that requires a comma, then use the @String@
    -- data type.
    --
    -- Specifying a parameter type isn\'t required when updating a parameter.
    -- You must specify a parameter type when creating a parameter.
    PutParameter -> Maybe ParameterType
type' :: Prelude.Maybe ParameterType,
    -- | The fully qualified name of the parameter that you want to add to the
    -- system. The fully qualified name includes the complete hierarchy of the
    -- parameter path and name. For parameters in a hierarchy, you must include
    -- a leading forward slash character (\/) when you create or reference a
    -- parameter. For example: @\/Dev\/DBServer\/MySQL\/db-string13@
    --
    -- Naming Constraints:
    --
    -- -   Parameter names are case sensitive.
    --
    -- -   A parameter name must be unique within an Amazon Web Services Region
    --
    -- -   A parameter name can\'t be prefixed with \"@aws@\" or \"@ssm@\"
    --     (case-insensitive).
    --
    -- -   Parameter names can include only the following symbols and letters:
    --     @a-zA-Z0-9_.-@
    --
    --     In addition, the slash character ( \/ ) is used to delineate
    --     hierarchies in parameter names. For example:
    --     @\/Dev\/Production\/East\/Project-ABC\/MyParameter@
    --
    -- -   A parameter name can\'t include spaces.
    --
    -- -   Parameter hierarchies are limited to a maximum depth of fifteen
    --     levels.
    --
    -- For additional information about valid values for parameter names, see
    -- <https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html Creating Systems Manager parameters>
    -- in the /Amazon Web Services Systems Manager User Guide/.
    --
    -- The maximum length constraint of 2048 characters listed below includes
    -- 1037 characters reserved for internal use by Systems Manager. The
    -- maximum length for a parameter name that you create is 1011 characters.
    -- This includes the characters in the ARN that precede the name you
    -- specify, such as @arn:aws:ssm:us-east-2:111122223333:parameter\/@.
    PutParameter -> Text
name :: Prelude.Text,
    -- | The parameter value that you want to add to the system. Standard
    -- parameters have a value limit of 4 KB. Advanced parameters have a value
    -- limit of 8 KB.
    --
    -- Parameters can\'t be referenced or nested in the values of other
    -- parameters. You can\'t include @{{}}@ or @{{ssm:@/@parameter-name@/@}}@
    -- in a parameter value.
    PutParameter -> Sensitive Text
value :: Data.Sensitive Prelude.Text
  }
  deriving (PutParameter -> PutParameter -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PutParameter -> PutParameter -> Bool
$c/= :: PutParameter -> PutParameter -> Bool
== :: PutParameter -> PutParameter -> Bool
$c== :: PutParameter -> PutParameter -> Bool
Prelude.Eq, Int -> PutParameter -> ShowS
[PutParameter] -> ShowS
PutParameter -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [PutParameter] -> ShowS
$cshowList :: [PutParameter] -> ShowS
show :: PutParameter -> String
$cshow :: PutParameter -> String
showsPrec :: Int -> PutParameter -> ShowS
$cshowsPrec :: Int -> PutParameter -> ShowS
Prelude.Show, forall x. Rep PutParameter x -> PutParameter
forall x. PutParameter -> Rep PutParameter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep PutParameter x -> PutParameter
$cfrom :: forall x. PutParameter -> Rep PutParameter x
Prelude.Generic)

-- |
-- Create a value of 'PutParameter' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'allowedPattern', 'putParameter_allowedPattern' - A regular expression used to validate the parameter value. For example,
-- for String types with values restricted to numbers, you can specify the
-- following: AllowedPattern=^\\d+$
--
-- 'dataType', 'putParameter_dataType' - The data type for a @String@ parameter. Supported data types include
-- plain text and Amazon Machine Image (AMI) IDs.
--
-- __The following data type values are supported.__
--
-- -   @text@
--
-- -   @aws:ec2:image@
--
-- -   @aws:ssm:integration@
--
-- When you create a @String@ parameter and specify @aws:ec2:image@, Amazon
-- Web Services Systems Manager validates the parameter value is in the
-- required format, such as @ami-12345abcdeEXAMPLE@, and that the specified
-- AMI is available in your Amazon Web Services account. For more
-- information, see
-- <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html Native parameter support for Amazon Machine Image (AMI) IDs>
-- in the /Amazon Web Services Systems Manager User Guide/.
--
-- 'description', 'putParameter_description' - Information about the parameter that you want to add to the system.
-- Optional but recommended.
--
-- Don\'t enter personally identifiable information in this field.
--
-- 'keyId', 'putParameter_keyId' - The Key Management Service (KMS) ID that you want to use to encrypt a
-- parameter. Either the default KMS key automatically assigned to your
-- Amazon Web Services account or a custom key. Required for parameters
-- that use the @SecureString@ data type.
--
-- If you don\'t specify a key ID, the system uses the default key
-- associated with your Amazon Web Services account.
--
-- -   To use your default KMS key, choose the @SecureString@ data type,
--     and do /not/ specify the @Key ID@ when you create the parameter. The
--     system automatically populates @Key ID@ with your default KMS key.
--
-- -   To use a custom KMS key, choose the @SecureString@ data type with
--     the @Key ID@ parameter.
--
-- 'overwrite', 'putParameter_overwrite' - Overwrite an existing parameter. The default value is @false@.
--
-- 'policies', 'putParameter_policies' - One or more policies to apply to a parameter. This operation takes a
-- JSON array. Parameter Store, a capability of Amazon Web Services Systems
-- Manager supports the following policy types:
--
-- Expiration: This policy deletes the parameter after it expires. When you
-- create the policy, you specify the expiration date. You can update the
-- expiration date and time by updating the policy. Updating the
-- /parameter/ doesn\'t affect the expiration date and time. When the
-- expiration time is reached, Parameter Store deletes the parameter.
--
-- ExpirationNotification: This policy initiates an event in Amazon
-- CloudWatch Events that notifies you about the expiration. By using this
-- policy, you can receive notification before or after the expiration time
-- is reached, in units of days or hours.
--
-- NoChangeNotification: This policy initiates a CloudWatch Events event if
-- a parameter hasn\'t been modified for a specified period of time. This
-- policy type is useful when, for example, a secret needs to be changed
-- within a period of time, but it hasn\'t been changed.
--
-- All existing policies are preserved until you send new policies or an
-- empty policy. For more information about parameter policies, see
-- <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html Assigning parameter policies>.
--
-- 'tags', 'putParameter_tags' - Optional metadata that you assign to a resource. Tags enable you to
-- categorize a resource in different ways, such as by purpose, owner, or
-- environment. For example, you might want to tag a Systems Manager
-- parameter to identify the type of resource to which it applies, the
-- environment, or the type of configuration data referenced by the
-- parameter. In this case, you could specify the following key-value
-- pairs:
--
-- -   @Key=Resource,Value=S3bucket@
--
-- -   @Key=OS,Value=Windows@
--
-- -   @Key=ParameterType,Value=LicenseKey@
--
-- To add tags to an existing Systems Manager parameter, use the
-- AddTagsToResource operation.
--
-- 'tier', 'putParameter_tier' - The parameter tier to assign to a parameter.
--
-- Parameter Store offers a standard tier and an advanced tier for
-- parameters. Standard parameters have a content size limit of 4 KB and
-- can\'t be configured to use parameter policies. You can create a maximum
-- of 10,000 standard parameters for each Region in an Amazon Web Services
-- account. Standard parameters are offered at no additional cost.
--
-- Advanced parameters have a content size limit of 8 KB and can be
-- configured to use parameter policies. You can create a maximum of
-- 100,000 advanced parameters for each Region in an Amazon Web Services
-- account. Advanced parameters incur a charge. For more information, see
-- <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html Standard and advanced parameter tiers>
-- in the /Amazon Web Services Systems Manager User Guide/.
--
-- You can change a standard parameter to an advanced parameter any time.
-- But you can\'t revert an advanced parameter to a standard parameter.
-- Reverting an advanced parameter to a standard parameter would result in
-- data loss because the system would truncate the size of the parameter
-- from 8 KB to 4 KB. Reverting would also remove any policies attached to
-- the parameter. Lastly, advanced parameters use a different form of
-- encryption than standard parameters.
--
-- If you no longer need an advanced parameter, or if you no longer want to
-- incur charges for an advanced parameter, you must delete it and recreate
-- it as a new standard parameter.
--
-- __Using the Default Tier Configuration__
--
-- In @PutParameter@ requests, you can specify the tier to create the
-- parameter in. Whenever you specify a tier in the request, Parameter
-- Store creates or updates the parameter according to that request.
-- However, if you don\'t specify a tier in a request, Parameter Store
-- assigns the tier based on the current Parameter Store default tier
-- configuration.
--
-- The default tier when you begin using Parameter Store is the
-- standard-parameter tier. If you use the advanced-parameter tier, you can
-- specify one of the following as the default:
--
-- -   __Advanced__: With this option, Parameter Store evaluates all
--     requests as advanced parameters.
--
-- -   __Intelligent-Tiering__: With this option, Parameter Store evaluates
--     each request to determine if the parameter is standard or advanced.
--
--     If the request doesn\'t include any options that require an advanced
--     parameter, the parameter is created in the standard-parameter tier.
--     If one or more options requiring an advanced parameter are included
--     in the request, Parameter Store create a parameter in the
--     advanced-parameter tier.
--
--     This approach helps control your parameter-related costs by always
--     creating standard parameters unless an advanced parameter is
--     necessary.
--
-- Options that require an advanced parameter include the following:
--
-- -   The content size of the parameter is more than 4 KB.
--
-- -   The parameter uses a parameter policy.
--
-- -   More than 10,000 parameters already exist in your Amazon Web
--     Services account in the current Amazon Web Services Region.
--
-- For more information about configuring the default tier option, see
-- <https://docs.aws.amazon.com/systems-manager/latest/userguide/ps-default-tier.html Specifying a default parameter tier>
-- in the /Amazon Web Services Systems Manager User Guide/.
--
-- 'type'', 'putParameter_type' - The type of parameter that you want to add to the system.
--
-- @SecureString@ isn\'t currently supported for CloudFormation templates.
--
-- Items in a @StringList@ must be separated by a comma (,). You can\'t use
-- other punctuation or special character to escape items in the list. If
-- you have a parameter value that requires a comma, then use the @String@
-- data type.
--
-- Specifying a parameter type isn\'t required when updating a parameter.
-- You must specify a parameter type when creating a parameter.
--
-- 'name', 'putParameter_name' - The fully qualified name of the parameter that you want to add to the
-- system. The fully qualified name includes the complete hierarchy of the
-- parameter path and name. For parameters in a hierarchy, you must include
-- a leading forward slash character (\/) when you create or reference a
-- parameter. For example: @\/Dev\/DBServer\/MySQL\/db-string13@
--
-- Naming Constraints:
--
-- -   Parameter names are case sensitive.
--
-- -   A parameter name must be unique within an Amazon Web Services Region
--
-- -   A parameter name can\'t be prefixed with \"@aws@\" or \"@ssm@\"
--     (case-insensitive).
--
-- -   Parameter names can include only the following symbols and letters:
--     @a-zA-Z0-9_.-@
--
--     In addition, the slash character ( \/ ) is used to delineate
--     hierarchies in parameter names. For example:
--     @\/Dev\/Production\/East\/Project-ABC\/MyParameter@
--
-- -   A parameter name can\'t include spaces.
--
-- -   Parameter hierarchies are limited to a maximum depth of fifteen
--     levels.
--
-- For additional information about valid values for parameter names, see
-- <https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html Creating Systems Manager parameters>
-- in the /Amazon Web Services Systems Manager User Guide/.
--
-- The maximum length constraint of 2048 characters listed below includes
-- 1037 characters reserved for internal use by Systems Manager. The
-- maximum length for a parameter name that you create is 1011 characters.
-- This includes the characters in the ARN that precede the name you
-- specify, such as @arn:aws:ssm:us-east-2:111122223333:parameter\/@.
--
-- 'value', 'putParameter_value' - The parameter value that you want to add to the system. Standard
-- parameters have a value limit of 4 KB. Advanced parameters have a value
-- limit of 8 KB.
--
-- Parameters can\'t be referenced or nested in the values of other
-- parameters. You can\'t include @{{}}@ or @{{ssm:@/@parameter-name@/@}}@
-- in a parameter value.
newPutParameter ::
  -- | 'name'
  Prelude.Text ->
  -- | 'value'
  Prelude.Text ->
  PutParameter
newPutParameter :: Text -> Text -> PutParameter
newPutParameter Text
pName_ Text
pValue_ =
  PutParameter'
    { $sel:allowedPattern:PutParameter' :: Maybe Text
allowedPattern = forall a. Maybe a
Prelude.Nothing,
      $sel:dataType:PutParameter' :: Maybe Text
dataType = forall a. Maybe a
Prelude.Nothing,
      $sel:description:PutParameter' :: Maybe Text
description = forall a. Maybe a
Prelude.Nothing,
      $sel:keyId:PutParameter' :: Maybe Text
keyId = forall a. Maybe a
Prelude.Nothing,
      $sel:overwrite:PutParameter' :: Maybe Bool
overwrite = forall a. Maybe a
Prelude.Nothing,
      $sel:policies:PutParameter' :: Maybe Text
policies = forall a. Maybe a
Prelude.Nothing,
      $sel:tags:PutParameter' :: Maybe [Tag]
tags = forall a. Maybe a
Prelude.Nothing,
      $sel:tier:PutParameter' :: Maybe ParameterTier
tier = forall a. Maybe a
Prelude.Nothing,
      $sel:type':PutParameter' :: Maybe ParameterType
type' = forall a. Maybe a
Prelude.Nothing,
      $sel:name:PutParameter' :: Text
name = Text
pName_,
      $sel:value:PutParameter' :: Sensitive Text
value = forall a. Iso' (Sensitive a) a
Data._Sensitive forall t b. AReview t b -> b -> t
Lens.# Text
pValue_
    }

-- | A regular expression used to validate the parameter value. For example,
-- for String types with values restricted to numbers, you can specify the
-- following: AllowedPattern=^\\d+$
putParameter_allowedPattern :: Lens.Lens' PutParameter (Prelude.Maybe Prelude.Text)
putParameter_allowedPattern :: Lens' PutParameter (Maybe Text)
putParameter_allowedPattern = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutParameter' {Maybe Text
allowedPattern :: Maybe Text
$sel:allowedPattern:PutParameter' :: PutParameter -> Maybe Text
allowedPattern} -> Maybe Text
allowedPattern) (\s :: PutParameter
s@PutParameter' {} Maybe Text
a -> PutParameter
s {$sel:allowedPattern:PutParameter' :: Maybe Text
allowedPattern = Maybe Text
a} :: PutParameter)

-- | The data type for a @String@ parameter. Supported data types include
-- plain text and Amazon Machine Image (AMI) IDs.
--
-- __The following data type values are supported.__
--
-- -   @text@
--
-- -   @aws:ec2:image@
--
-- -   @aws:ssm:integration@
--
-- When you create a @String@ parameter and specify @aws:ec2:image@, Amazon
-- Web Services Systems Manager validates the parameter value is in the
-- required format, such as @ami-12345abcdeEXAMPLE@, and that the specified
-- AMI is available in your Amazon Web Services account. For more
-- information, see
-- <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html Native parameter support for Amazon Machine Image (AMI) IDs>
-- in the /Amazon Web Services Systems Manager User Guide/.
putParameter_dataType :: Lens.Lens' PutParameter (Prelude.Maybe Prelude.Text)
putParameter_dataType :: Lens' PutParameter (Maybe Text)
putParameter_dataType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutParameter' {Maybe Text
dataType :: Maybe Text
$sel:dataType:PutParameter' :: PutParameter -> Maybe Text
dataType} -> Maybe Text
dataType) (\s :: PutParameter
s@PutParameter' {} Maybe Text
a -> PutParameter
s {$sel:dataType:PutParameter' :: Maybe Text
dataType = Maybe Text
a} :: PutParameter)

-- | Information about the parameter that you want to add to the system.
-- Optional but recommended.
--
-- Don\'t enter personally identifiable information in this field.
putParameter_description :: Lens.Lens' PutParameter (Prelude.Maybe Prelude.Text)
putParameter_description :: Lens' PutParameter (Maybe Text)
putParameter_description = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutParameter' {Maybe Text
description :: Maybe Text
$sel:description:PutParameter' :: PutParameter -> Maybe Text
description} -> Maybe Text
description) (\s :: PutParameter
s@PutParameter' {} Maybe Text
a -> PutParameter
s {$sel:description:PutParameter' :: Maybe Text
description = Maybe Text
a} :: PutParameter)

-- | The Key Management Service (KMS) ID that you want to use to encrypt a
-- parameter. Either the default KMS key automatically assigned to your
-- Amazon Web Services account or a custom key. Required for parameters
-- that use the @SecureString@ data type.
--
-- If you don\'t specify a key ID, the system uses the default key
-- associated with your Amazon Web Services account.
--
-- -   To use your default KMS key, choose the @SecureString@ data type,
--     and do /not/ specify the @Key ID@ when you create the parameter. The
--     system automatically populates @Key ID@ with your default KMS key.
--
-- -   To use a custom KMS key, choose the @SecureString@ data type with
--     the @Key ID@ parameter.
putParameter_keyId :: Lens.Lens' PutParameter (Prelude.Maybe Prelude.Text)
putParameter_keyId :: Lens' PutParameter (Maybe Text)
putParameter_keyId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutParameter' {Maybe Text
keyId :: Maybe Text
$sel:keyId:PutParameter' :: PutParameter -> Maybe Text
keyId} -> Maybe Text
keyId) (\s :: PutParameter
s@PutParameter' {} Maybe Text
a -> PutParameter
s {$sel:keyId:PutParameter' :: Maybe Text
keyId = Maybe Text
a} :: PutParameter)

-- | Overwrite an existing parameter. The default value is @false@.
putParameter_overwrite :: Lens.Lens' PutParameter (Prelude.Maybe Prelude.Bool)
putParameter_overwrite :: Lens' PutParameter (Maybe Bool)
putParameter_overwrite = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutParameter' {Maybe Bool
overwrite :: Maybe Bool
$sel:overwrite:PutParameter' :: PutParameter -> Maybe Bool
overwrite} -> Maybe Bool
overwrite) (\s :: PutParameter
s@PutParameter' {} Maybe Bool
a -> PutParameter
s {$sel:overwrite:PutParameter' :: Maybe Bool
overwrite = Maybe Bool
a} :: PutParameter)

-- | One or more policies to apply to a parameter. This operation takes a
-- JSON array. Parameter Store, a capability of Amazon Web Services Systems
-- Manager supports the following policy types:
--
-- Expiration: This policy deletes the parameter after it expires. When you
-- create the policy, you specify the expiration date. You can update the
-- expiration date and time by updating the policy. Updating the
-- /parameter/ doesn\'t affect the expiration date and time. When the
-- expiration time is reached, Parameter Store deletes the parameter.
--
-- ExpirationNotification: This policy initiates an event in Amazon
-- CloudWatch Events that notifies you about the expiration. By using this
-- policy, you can receive notification before or after the expiration time
-- is reached, in units of days or hours.
--
-- NoChangeNotification: This policy initiates a CloudWatch Events event if
-- a parameter hasn\'t been modified for a specified period of time. This
-- policy type is useful when, for example, a secret needs to be changed
-- within a period of time, but it hasn\'t been changed.
--
-- All existing policies are preserved until you send new policies or an
-- empty policy. For more information about parameter policies, see
-- <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html Assigning parameter policies>.
putParameter_policies :: Lens.Lens' PutParameter (Prelude.Maybe Prelude.Text)
putParameter_policies :: Lens' PutParameter (Maybe Text)
putParameter_policies = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutParameter' {Maybe Text
policies :: Maybe Text
$sel:policies:PutParameter' :: PutParameter -> Maybe Text
policies} -> Maybe Text
policies) (\s :: PutParameter
s@PutParameter' {} Maybe Text
a -> PutParameter
s {$sel:policies:PutParameter' :: Maybe Text
policies = Maybe Text
a} :: PutParameter)

-- | Optional metadata that you assign to a resource. Tags enable you to
-- categorize a resource in different ways, such as by purpose, owner, or
-- environment. For example, you might want to tag a Systems Manager
-- parameter to identify the type of resource to which it applies, the
-- environment, or the type of configuration data referenced by the
-- parameter. In this case, you could specify the following key-value
-- pairs:
--
-- -   @Key=Resource,Value=S3bucket@
--
-- -   @Key=OS,Value=Windows@
--
-- -   @Key=ParameterType,Value=LicenseKey@
--
-- To add tags to an existing Systems Manager parameter, use the
-- AddTagsToResource operation.
putParameter_tags :: Lens.Lens' PutParameter (Prelude.Maybe [Tag])
putParameter_tags :: Lens' PutParameter (Maybe [Tag])
putParameter_tags = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutParameter' {Maybe [Tag]
tags :: Maybe [Tag]
$sel:tags:PutParameter' :: PutParameter -> Maybe [Tag]
tags} -> Maybe [Tag]
tags) (\s :: PutParameter
s@PutParameter' {} Maybe [Tag]
a -> PutParameter
s {$sel:tags:PutParameter' :: Maybe [Tag]
tags = Maybe [Tag]
a} :: PutParameter) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The parameter tier to assign to a parameter.
--
-- Parameter Store offers a standard tier and an advanced tier for
-- parameters. Standard parameters have a content size limit of 4 KB and
-- can\'t be configured to use parameter policies. You can create a maximum
-- of 10,000 standard parameters for each Region in an Amazon Web Services
-- account. Standard parameters are offered at no additional cost.
--
-- Advanced parameters have a content size limit of 8 KB and can be
-- configured to use parameter policies. You can create a maximum of
-- 100,000 advanced parameters for each Region in an Amazon Web Services
-- account. Advanced parameters incur a charge. For more information, see
-- <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html Standard and advanced parameter tiers>
-- in the /Amazon Web Services Systems Manager User Guide/.
--
-- You can change a standard parameter to an advanced parameter any time.
-- But you can\'t revert an advanced parameter to a standard parameter.
-- Reverting an advanced parameter to a standard parameter would result in
-- data loss because the system would truncate the size of the parameter
-- from 8 KB to 4 KB. Reverting would also remove any policies attached to
-- the parameter. Lastly, advanced parameters use a different form of
-- encryption than standard parameters.
--
-- If you no longer need an advanced parameter, or if you no longer want to
-- incur charges for an advanced parameter, you must delete it and recreate
-- it as a new standard parameter.
--
-- __Using the Default Tier Configuration__
--
-- In @PutParameter@ requests, you can specify the tier to create the
-- parameter in. Whenever you specify a tier in the request, Parameter
-- Store creates or updates the parameter according to that request.
-- However, if you don\'t specify a tier in a request, Parameter Store
-- assigns the tier based on the current Parameter Store default tier
-- configuration.
--
-- The default tier when you begin using Parameter Store is the
-- standard-parameter tier. If you use the advanced-parameter tier, you can
-- specify one of the following as the default:
--
-- -   __Advanced__: With this option, Parameter Store evaluates all
--     requests as advanced parameters.
--
-- -   __Intelligent-Tiering__: With this option, Parameter Store evaluates
--     each request to determine if the parameter is standard or advanced.
--
--     If the request doesn\'t include any options that require an advanced
--     parameter, the parameter is created in the standard-parameter tier.
--     If one or more options requiring an advanced parameter are included
--     in the request, Parameter Store create a parameter in the
--     advanced-parameter tier.
--
--     This approach helps control your parameter-related costs by always
--     creating standard parameters unless an advanced parameter is
--     necessary.
--
-- Options that require an advanced parameter include the following:
--
-- -   The content size of the parameter is more than 4 KB.
--
-- -   The parameter uses a parameter policy.
--
-- -   More than 10,000 parameters already exist in your Amazon Web
--     Services account in the current Amazon Web Services Region.
--
-- For more information about configuring the default tier option, see
-- <https://docs.aws.amazon.com/systems-manager/latest/userguide/ps-default-tier.html Specifying a default parameter tier>
-- in the /Amazon Web Services Systems Manager User Guide/.
putParameter_tier :: Lens.Lens' PutParameter (Prelude.Maybe ParameterTier)
putParameter_tier :: Lens' PutParameter (Maybe ParameterTier)
putParameter_tier = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutParameter' {Maybe ParameterTier
tier :: Maybe ParameterTier
$sel:tier:PutParameter' :: PutParameter -> Maybe ParameterTier
tier} -> Maybe ParameterTier
tier) (\s :: PutParameter
s@PutParameter' {} Maybe ParameterTier
a -> PutParameter
s {$sel:tier:PutParameter' :: Maybe ParameterTier
tier = Maybe ParameterTier
a} :: PutParameter)

-- | The type of parameter that you want to add to the system.
--
-- @SecureString@ isn\'t currently supported for CloudFormation templates.
--
-- Items in a @StringList@ must be separated by a comma (,). You can\'t use
-- other punctuation or special character to escape items in the list. If
-- you have a parameter value that requires a comma, then use the @String@
-- data type.
--
-- Specifying a parameter type isn\'t required when updating a parameter.
-- You must specify a parameter type when creating a parameter.
putParameter_type :: Lens.Lens' PutParameter (Prelude.Maybe ParameterType)
putParameter_type :: Lens' PutParameter (Maybe ParameterType)
putParameter_type = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutParameter' {Maybe ParameterType
type' :: Maybe ParameterType
$sel:type':PutParameter' :: PutParameter -> Maybe ParameterType
type'} -> Maybe ParameterType
type') (\s :: PutParameter
s@PutParameter' {} Maybe ParameterType
a -> PutParameter
s {$sel:type':PutParameter' :: Maybe ParameterType
type' = Maybe ParameterType
a} :: PutParameter)

-- | The fully qualified name of the parameter that you want to add to the
-- system. The fully qualified name includes the complete hierarchy of the
-- parameter path and name. For parameters in a hierarchy, you must include
-- a leading forward slash character (\/) when you create or reference a
-- parameter. For example: @\/Dev\/DBServer\/MySQL\/db-string13@
--
-- Naming Constraints:
--
-- -   Parameter names are case sensitive.
--
-- -   A parameter name must be unique within an Amazon Web Services Region
--
-- -   A parameter name can\'t be prefixed with \"@aws@\" or \"@ssm@\"
--     (case-insensitive).
--
-- -   Parameter names can include only the following symbols and letters:
--     @a-zA-Z0-9_.-@
--
--     In addition, the slash character ( \/ ) is used to delineate
--     hierarchies in parameter names. For example:
--     @\/Dev\/Production\/East\/Project-ABC\/MyParameter@
--
-- -   A parameter name can\'t include spaces.
--
-- -   Parameter hierarchies are limited to a maximum depth of fifteen
--     levels.
--
-- For additional information about valid values for parameter names, see
-- <https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html Creating Systems Manager parameters>
-- in the /Amazon Web Services Systems Manager User Guide/.
--
-- The maximum length constraint of 2048 characters listed below includes
-- 1037 characters reserved for internal use by Systems Manager. The
-- maximum length for a parameter name that you create is 1011 characters.
-- This includes the characters in the ARN that precede the name you
-- specify, such as @arn:aws:ssm:us-east-2:111122223333:parameter\/@.
putParameter_name :: Lens.Lens' PutParameter Prelude.Text
putParameter_name :: Lens' PutParameter Text
putParameter_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutParameter' {Text
name :: Text
$sel:name:PutParameter' :: PutParameter -> Text
name} -> Text
name) (\s :: PutParameter
s@PutParameter' {} Text
a -> PutParameter
s {$sel:name:PutParameter' :: Text
name = Text
a} :: PutParameter)

-- | The parameter value that you want to add to the system. Standard
-- parameters have a value limit of 4 KB. Advanced parameters have a value
-- limit of 8 KB.
--
-- Parameters can\'t be referenced or nested in the values of other
-- parameters. You can\'t include @{{}}@ or @{{ssm:@/@parameter-name@/@}}@
-- in a parameter value.
putParameter_value :: Lens.Lens' PutParameter Prelude.Text
putParameter_value :: Lens' PutParameter Text
putParameter_value = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutParameter' {Sensitive Text
value :: Sensitive Text
$sel:value:PutParameter' :: PutParameter -> Sensitive Text
value} -> Sensitive Text
value) (\s :: PutParameter
s@PutParameter' {} Sensitive Text
a -> PutParameter
s {$sel:value:PutParameter' :: Sensitive Text
value = Sensitive Text
a} :: PutParameter) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a. Iso' (Sensitive a) a
Data._Sensitive

instance Core.AWSRequest PutParameter where
  type AWSResponse PutParameter = PutParameterResponse
  request :: (Service -> Service) -> PutParameter -> Request PutParameter
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy PutParameter
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse PutParameter)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe ParameterTier -> Int -> Integer -> PutParameterResponse
PutParameterResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"Tier")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String a
Data..:> Key
"Version")
      )

instance Prelude.Hashable PutParameter where
  hashWithSalt :: Int -> PutParameter -> Int
hashWithSalt Int
_salt PutParameter' {Maybe Bool
Maybe [Tag]
Maybe Text
Maybe ParameterTier
Maybe ParameterType
Text
Sensitive Text
value :: Sensitive Text
name :: Text
type' :: Maybe ParameterType
tier :: Maybe ParameterTier
tags :: Maybe [Tag]
policies :: Maybe Text
overwrite :: Maybe Bool
keyId :: Maybe Text
description :: Maybe Text
dataType :: Maybe Text
allowedPattern :: Maybe Text
$sel:value:PutParameter' :: PutParameter -> Sensitive Text
$sel:name:PutParameter' :: PutParameter -> Text
$sel:type':PutParameter' :: PutParameter -> Maybe ParameterType
$sel:tier:PutParameter' :: PutParameter -> Maybe ParameterTier
$sel:tags:PutParameter' :: PutParameter -> Maybe [Tag]
$sel:policies:PutParameter' :: PutParameter -> Maybe Text
$sel:overwrite:PutParameter' :: PutParameter -> Maybe Bool
$sel:keyId:PutParameter' :: PutParameter -> Maybe Text
$sel:description:PutParameter' :: PutParameter -> Maybe Text
$sel:dataType:PutParameter' :: PutParameter -> Maybe Text
$sel:allowedPattern:PutParameter' :: PutParameter -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
allowedPattern
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
dataType
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
description
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
keyId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
overwrite
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
policies
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Tag]
tags
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ParameterTier
tier
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ParameterType
type'
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Sensitive Text
value

instance Prelude.NFData PutParameter where
  rnf :: PutParameter -> ()
rnf PutParameter' {Maybe Bool
Maybe [Tag]
Maybe Text
Maybe ParameterTier
Maybe ParameterType
Text
Sensitive Text
value :: Sensitive Text
name :: Text
type' :: Maybe ParameterType
tier :: Maybe ParameterTier
tags :: Maybe [Tag]
policies :: Maybe Text
overwrite :: Maybe Bool
keyId :: Maybe Text
description :: Maybe Text
dataType :: Maybe Text
allowedPattern :: Maybe Text
$sel:value:PutParameter' :: PutParameter -> Sensitive Text
$sel:name:PutParameter' :: PutParameter -> Text
$sel:type':PutParameter' :: PutParameter -> Maybe ParameterType
$sel:tier:PutParameter' :: PutParameter -> Maybe ParameterTier
$sel:tags:PutParameter' :: PutParameter -> Maybe [Tag]
$sel:policies:PutParameter' :: PutParameter -> Maybe Text
$sel:overwrite:PutParameter' :: PutParameter -> Maybe Bool
$sel:keyId:PutParameter' :: PutParameter -> Maybe Text
$sel:description:PutParameter' :: PutParameter -> Maybe Text
$sel:dataType:PutParameter' :: PutParameter -> Maybe Text
$sel:allowedPattern:PutParameter' :: PutParameter -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
allowedPattern
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
dataType
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
description
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
keyId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
overwrite
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
policies
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Tag]
tags
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ParameterTier
tier
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ParameterType
type'
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
name
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Sensitive Text
value

instance Data.ToHeaders PutParameter where
  toHeaders :: PutParameter -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# (ByteString
"AmazonSSM.PutParameter" :: Prelude.ByteString),
            HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON PutParameter where
  toJSON :: PutParameter -> Value
toJSON PutParameter' {Maybe Bool
Maybe [Tag]
Maybe Text
Maybe ParameterTier
Maybe ParameterType
Text
Sensitive Text
value :: Sensitive Text
name :: Text
type' :: Maybe ParameterType
tier :: Maybe ParameterTier
tags :: Maybe [Tag]
policies :: Maybe Text
overwrite :: Maybe Bool
keyId :: Maybe Text
description :: Maybe Text
dataType :: Maybe Text
allowedPattern :: Maybe Text
$sel:value:PutParameter' :: PutParameter -> Sensitive Text
$sel:name:PutParameter' :: PutParameter -> Text
$sel:type':PutParameter' :: PutParameter -> Maybe ParameterType
$sel:tier:PutParameter' :: PutParameter -> Maybe ParameterTier
$sel:tags:PutParameter' :: PutParameter -> Maybe [Tag]
$sel:policies:PutParameter' :: PutParameter -> Maybe Text
$sel:overwrite:PutParameter' :: PutParameter -> Maybe Bool
$sel:keyId:PutParameter' :: PutParameter -> Maybe Text
$sel:description:PutParameter' :: PutParameter -> Maybe Text
$sel:dataType:PutParameter' :: PutParameter -> Maybe Text
$sel:allowedPattern:PutParameter' :: PutParameter -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"AllowedPattern" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
allowedPattern,
            (Key
"DataType" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
dataType,
            (Key
"Description" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
description,
            (Key
"KeyId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
keyId,
            (Key
"Overwrite" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
overwrite,
            (Key
"Policies" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
policies,
            (Key
"Tags" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [Tag]
tags,
            (Key
"Tier" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe ParameterTier
tier,
            (Key
"Type" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe ParameterType
type',
            forall a. a -> Maybe a
Prelude.Just (Key
"Name" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
name),
            forall a. a -> Maybe a
Prelude.Just (Key
"Value" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Sensitive Text
value)
          ]
      )

instance Data.ToPath PutParameter where
  toPath :: PutParameter -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Data.ToQuery PutParameter where
  toQuery :: PutParameter -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

-- | /See:/ 'newPutParameterResponse' smart constructor.
data PutParameterResponse = PutParameterResponse'
  { -- | The tier assigned to the parameter.
    PutParameterResponse -> Maybe ParameterTier
tier :: Prelude.Maybe ParameterTier,
    -- | The response's http status code.
    PutParameterResponse -> Int
httpStatus :: Prelude.Int,
    -- | The new version number of a parameter. If you edit a parameter value,
    -- Parameter Store automatically creates a new version and assigns this new
    -- version a unique ID. You can reference a parameter version ID in API
    -- operations or in Systems Manager documents (SSM documents). By default,
    -- if you don\'t specify a specific version, the system returns the latest
    -- parameter value when a parameter is called.
    PutParameterResponse -> Integer
version :: Prelude.Integer
  }
  deriving (PutParameterResponse -> PutParameterResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PutParameterResponse -> PutParameterResponse -> Bool
$c/= :: PutParameterResponse -> PutParameterResponse -> Bool
== :: PutParameterResponse -> PutParameterResponse -> Bool
$c== :: PutParameterResponse -> PutParameterResponse -> Bool
Prelude.Eq, ReadPrec [PutParameterResponse]
ReadPrec PutParameterResponse
Int -> ReadS PutParameterResponse
ReadS [PutParameterResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [PutParameterResponse]
$creadListPrec :: ReadPrec [PutParameterResponse]
readPrec :: ReadPrec PutParameterResponse
$creadPrec :: ReadPrec PutParameterResponse
readList :: ReadS [PutParameterResponse]
$creadList :: ReadS [PutParameterResponse]
readsPrec :: Int -> ReadS PutParameterResponse
$creadsPrec :: Int -> ReadS PutParameterResponse
Prelude.Read, Int -> PutParameterResponse -> ShowS
[PutParameterResponse] -> ShowS
PutParameterResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [PutParameterResponse] -> ShowS
$cshowList :: [PutParameterResponse] -> ShowS
show :: PutParameterResponse -> String
$cshow :: PutParameterResponse -> String
showsPrec :: Int -> PutParameterResponse -> ShowS
$cshowsPrec :: Int -> PutParameterResponse -> ShowS
Prelude.Show, forall x. Rep PutParameterResponse x -> PutParameterResponse
forall x. PutParameterResponse -> Rep PutParameterResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep PutParameterResponse x -> PutParameterResponse
$cfrom :: forall x. PutParameterResponse -> Rep PutParameterResponse x
Prelude.Generic)

-- |
-- Create a value of 'PutParameterResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'tier', 'putParameterResponse_tier' - The tier assigned to the parameter.
--
-- 'httpStatus', 'putParameterResponse_httpStatus' - The response's http status code.
--
-- 'version', 'putParameterResponse_version' - The new version number of a parameter. If you edit a parameter value,
-- Parameter Store automatically creates a new version and assigns this new
-- version a unique ID. You can reference a parameter version ID in API
-- operations or in Systems Manager documents (SSM documents). By default,
-- if you don\'t specify a specific version, the system returns the latest
-- parameter value when a parameter is called.
newPutParameterResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  -- | 'version'
  Prelude.Integer ->
  PutParameterResponse
newPutParameterResponse :: Int -> Integer -> PutParameterResponse
newPutParameterResponse Int
pHttpStatus_ Integer
pVersion_ =
  PutParameterResponse'
    { $sel:tier:PutParameterResponse' :: Maybe ParameterTier
tier = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:PutParameterResponse' :: Int
httpStatus = Int
pHttpStatus_,
      $sel:version:PutParameterResponse' :: Integer
version = Integer
pVersion_
    }

-- | The tier assigned to the parameter.
putParameterResponse_tier :: Lens.Lens' PutParameterResponse (Prelude.Maybe ParameterTier)
putParameterResponse_tier :: Lens' PutParameterResponse (Maybe ParameterTier)
putParameterResponse_tier = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutParameterResponse' {Maybe ParameterTier
tier :: Maybe ParameterTier
$sel:tier:PutParameterResponse' :: PutParameterResponse -> Maybe ParameterTier
tier} -> Maybe ParameterTier
tier) (\s :: PutParameterResponse
s@PutParameterResponse' {} Maybe ParameterTier
a -> PutParameterResponse
s {$sel:tier:PutParameterResponse' :: Maybe ParameterTier
tier = Maybe ParameterTier
a} :: PutParameterResponse)

-- | The response's http status code.
putParameterResponse_httpStatus :: Lens.Lens' PutParameterResponse Prelude.Int
putParameterResponse_httpStatus :: Lens' PutParameterResponse Int
putParameterResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutParameterResponse' {Int
httpStatus :: Int
$sel:httpStatus:PutParameterResponse' :: PutParameterResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: PutParameterResponse
s@PutParameterResponse' {} Int
a -> PutParameterResponse
s {$sel:httpStatus:PutParameterResponse' :: Int
httpStatus = Int
a} :: PutParameterResponse)

-- | The new version number of a parameter. If you edit a parameter value,
-- Parameter Store automatically creates a new version and assigns this new
-- version a unique ID. You can reference a parameter version ID in API
-- operations or in Systems Manager documents (SSM documents). By default,
-- if you don\'t specify a specific version, the system returns the latest
-- parameter value when a parameter is called.
putParameterResponse_version :: Lens.Lens' PutParameterResponse Prelude.Integer
putParameterResponse_version :: Lens' PutParameterResponse Integer
putParameterResponse_version = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutParameterResponse' {Integer
version :: Integer
$sel:version:PutParameterResponse' :: PutParameterResponse -> Integer
version} -> Integer
version) (\s :: PutParameterResponse
s@PutParameterResponse' {} Integer
a -> PutParameterResponse
s {$sel:version:PutParameterResponse' :: Integer
version = Integer
a} :: PutParameterResponse)

instance Prelude.NFData PutParameterResponse where
  rnf :: PutParameterResponse -> ()
rnf PutParameterResponse' {Int
Integer
Maybe ParameterTier
version :: Integer
httpStatus :: Int
tier :: Maybe ParameterTier
$sel:version:PutParameterResponse' :: PutParameterResponse -> Integer
$sel:httpStatus:PutParameterResponse' :: PutParameterResponse -> Int
$sel:tier:PutParameterResponse' :: PutParameterResponse -> Maybe ParameterTier
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe ParameterTier
tier
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Integer
version