{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# 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.Types.Target
-- 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)
module Amazonka.SSM.Types.Target where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude

-- | An array of search criteria that targets instances using a key-value
-- pair that you specify.
--
-- One or more targets must be specified for maintenance window Run
-- Command-type tasks. Depending on the task, targets are optional for
-- other maintenance window task types (Automation, Lambda, and Step
-- Functions). For more information about running tasks that don\'t specify
-- targets, see
-- <https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html Registering maintenance window tasks without targets>
-- in the /Amazon Web Services Systems Manager User Guide/.
--
-- Supported formats include the following.
--
-- -   @Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3 @
--
-- -   @Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2 @
--
-- -   @Key=tag-key,Values=my-tag-key-1,my-tag-key-2 @
--
-- -   __Run Command and Maintenance window targets only__:
--     @Key=resource-groups:Name,Values=resource-group-name @
--
-- -   __Maintenance window targets only__:
--     @Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2 @
--
-- -   __Automation targets only__:
--     @Key=ResourceGroup;Values=resource-group-name @
--
-- For example:
--
-- -   @Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE@
--
-- -   @Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3@
--
-- -   @Key=tag-key,Values=Name,Instance-Type,CostCenter@
--
-- -   __Run Command and Maintenance window targets only__:
--     @Key=resource-groups:Name,Values=ProductionResourceGroup@
--
--     This example demonstrates how to target all resources in the
--     resource group __ProductionResourceGroup__ in your maintenance
--     window.
--
-- -   __Maintenance window targets only__:
--     @Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC @
--
--     This example demonstrates how to target only Amazon Elastic Compute
--     Cloud (Amazon EC2) instances and VPCs in your maintenance window.
--
-- -   __Automation targets only__:
--     @Key=ResourceGroup,Values=MyResourceGroup@
--
-- -   __State Manager association targets only__:
--     @Key=InstanceIds,Values=* @
--
--     This example demonstrates how to target all managed instances in the
--     Amazon Web Services Region where the association was created.
--
-- For more information about how to send commands that target instances
-- using @Key,Value@ parameters, see
-- <https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-targeting Targeting multiple instances>
-- in the /Amazon Web Services Systems Manager User Guide/.
--
-- /See:/ 'newTarget' smart constructor.
data Target = Target'
  { -- | User-defined criteria that maps to @Key@. For example, if you specified
    -- @tag:ServerRole@, you could specify @value:WebServer@ to run a command
    -- on instances that include EC2 tags of @ServerRole,WebServer@.
    --
    -- Depending on the type of target, the maximum number of values for a key
    -- might be lower than the global maximum of 50.
    Target -> Maybe [Text]
values :: Prelude.Maybe [Prelude.Text],
    -- | User-defined criteria for sending commands that target instances that
    -- meet the criteria.
    Target -> Maybe Text
key :: Prelude.Maybe Prelude.Text
  }
  deriving (Target -> Target -> Bool
(Target -> Target -> Bool)
-> (Target -> Target -> Bool) -> Eq Target
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Target -> Target -> Bool
$c/= :: Target -> Target -> Bool
== :: Target -> Target -> Bool
$c== :: Target -> Target -> Bool
Prelude.Eq, ReadPrec [Target]
ReadPrec Target
Int -> ReadS Target
ReadS [Target]
(Int -> ReadS Target)
-> ReadS [Target]
-> ReadPrec Target
-> ReadPrec [Target]
-> Read Target
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [Target]
$creadListPrec :: ReadPrec [Target]
readPrec :: ReadPrec Target
$creadPrec :: ReadPrec Target
readList :: ReadS [Target]
$creadList :: ReadS [Target]
readsPrec :: Int -> ReadS Target
$creadsPrec :: Int -> ReadS Target
Prelude.Read, Int -> Target -> ShowS
[Target] -> ShowS
Target -> String
(Int -> Target -> ShowS)
-> (Target -> String) -> ([Target] -> ShowS) -> Show Target
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Target] -> ShowS
$cshowList :: [Target] -> ShowS
show :: Target -> String
$cshow :: Target -> String
showsPrec :: Int -> Target -> ShowS
$cshowsPrec :: Int -> Target -> ShowS
Prelude.Show, (forall x. Target -> Rep Target x)
-> (forall x. Rep Target x -> Target) -> Generic Target
forall x. Rep Target x -> Target
forall x. Target -> Rep Target x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Target x -> Target
$cfrom :: forall x. Target -> Rep Target x
Prelude.Generic)

-- |
-- Create a value of 'Target' 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:
--
-- 'values', 'target_values' - User-defined criteria that maps to @Key@. For example, if you specified
-- @tag:ServerRole@, you could specify @value:WebServer@ to run a command
-- on instances that include EC2 tags of @ServerRole,WebServer@.
--
-- Depending on the type of target, the maximum number of values for a key
-- might be lower than the global maximum of 50.
--
-- 'key', 'target_key' - User-defined criteria for sending commands that target instances that
-- meet the criteria.
newTarget ::
  Target
newTarget :: Target
newTarget =
  Target' :: Maybe [Text] -> Maybe Text -> Target
Target'
    { $sel:values:Target' :: Maybe [Text]
values = Maybe [Text]
forall a. Maybe a
Prelude.Nothing,
      $sel:key:Target' :: Maybe Text
key = Maybe Text
forall a. Maybe a
Prelude.Nothing
    }

-- | User-defined criteria that maps to @Key@. For example, if you specified
-- @tag:ServerRole@, you could specify @value:WebServer@ to run a command
-- on instances that include EC2 tags of @ServerRole,WebServer@.
--
-- Depending on the type of target, the maximum number of values for a key
-- might be lower than the global maximum of 50.
target_values :: Lens.Lens' Target (Prelude.Maybe [Prelude.Text])
target_values :: (Maybe [Text] -> f (Maybe [Text])) -> Target -> f Target
target_values = (Target -> Maybe [Text])
-> (Target -> Maybe [Text] -> Target)
-> Lens Target Target (Maybe [Text]) (Maybe [Text])
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Target' {Maybe [Text]
values :: Maybe [Text]
$sel:values:Target' :: Target -> Maybe [Text]
values} -> Maybe [Text]
values) (\s :: Target
s@Target' {} Maybe [Text]
a -> Target
s {$sel:values:Target' :: Maybe [Text]
values = Maybe [Text]
a} :: Target) ((Maybe [Text] -> f (Maybe [Text])) -> Target -> f Target)
-> ((Maybe [Text] -> f (Maybe [Text]))
    -> Maybe [Text] -> f (Maybe [Text]))
-> (Maybe [Text] -> f (Maybe [Text]))
-> Target
-> f Target
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. AnIso [Text] [Text] [Text] [Text]
-> Iso (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text])
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 AnIso [Text] [Text] [Text] [Text]
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | User-defined criteria for sending commands that target instances that
-- meet the criteria.
target_key :: Lens.Lens' Target (Prelude.Maybe Prelude.Text)
target_key :: (Maybe Text -> f (Maybe Text)) -> Target -> f Target
target_key = (Target -> Maybe Text)
-> (Target -> Maybe Text -> Target)
-> Lens Target Target (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Target' {Maybe Text
key :: Maybe Text
$sel:key:Target' :: Target -> Maybe Text
key} -> Maybe Text
key) (\s :: Target
s@Target' {} Maybe Text
a -> Target
s {$sel:key:Target' :: Maybe Text
key = Maybe Text
a} :: Target)

instance Core.FromJSON Target where
  parseJSON :: Value -> Parser Target
parseJSON =
    String -> (Object -> Parser Target) -> Value -> Parser Target
forall a. String -> (Object -> Parser a) -> Value -> Parser a
Core.withObject
      String
"Target"
      ( \Object
x ->
          Maybe [Text] -> Maybe Text -> Target
Target'
            (Maybe [Text] -> Maybe Text -> Target)
-> Parser (Maybe [Text]) -> Parser (Maybe Text -> Target)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Parser (Maybe (Maybe [Text]))
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"Values" Parser (Maybe (Maybe [Text]))
-> Maybe [Text] -> Parser (Maybe [Text])
forall a. Parser (Maybe a) -> a -> Parser a
Core..!= Maybe [Text]
forall a. Monoid a => a
Prelude.mempty)
            Parser (Maybe Text -> Target)
-> Parser (Maybe Text) -> Parser Target
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe Text)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"Key")
      )

instance Prelude.Hashable Target

instance Prelude.NFData Target

instance Core.ToJSON Target where
  toJSON :: Target -> Value
toJSON Target' {Maybe [Text]
Maybe Text
key :: Maybe Text
values :: Maybe [Text]
$sel:key:Target' :: Target -> Maybe Text
$sel:values:Target' :: Target -> Maybe [Text]
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"Values" Text -> [Text] -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) ([Text] -> Pair) -> Maybe [Text] -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [Text]
values,
            (Text
"Key" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
key
          ]
      )