Network.AWS.SSM.PutParameter

Add a parameter to the system.

Creating a Request

putParameter

Arguments

:: Text

ppName

-> Text

ppValue

-> ParameterType

ppType

-> PutParameter

Creates a value of PutParameter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ppKeyId - The KMS Key ID that you want to use to encrypt a parameter when you choose the SecureString data type. If you don't specify a key ID, the system uses the default key associated with your AWS account.
• ppAllowedPattern - 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+$
• ppOverwrite - Overwrite an existing parameter. If not specified, will default to "false".
• ppDescription - Information about the parameter that you want to add to the system. Important: Do not enter personally identifiable information in this field.
• ppName - 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 example: DevDBServerMySQLdb-string13 For information about parameter name requirements and restrictions, see About Creating Systems Manager Parameters in the AWS Systems Manager User Guide .
• ppValue - The parameter value that you want to add to the system.
• ppType - The type of parameter that you want to add to the system.

data PutParameter

See: putParameter smart constructor.

Instances

Eq PutParameter

Methods

(==) :: PutParameter -> PutParameter -> Bool

(/=) :: PutParameter -> PutParameter -> Bool

Data PutParameter

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutParameter -> c PutParameter

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutParameter

toConstr :: PutParameter -> Constr

dataTypeOf :: PutParameter -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c PutParameter)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutParameter)

gmapT :: (forall b. Data b => b -> b) -> PutParameter -> PutParameter

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutParameter -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutParameter -> r

gmapQ :: (forall d. Data d => d -> u) -> PutParameter -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> PutParameter -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutParameter -> m PutParameter

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutParameter -> m PutParameter

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutParameter -> m PutParameter

Read PutParameter

Methods

readsPrec :: Int -> ReadS PutParameter

readList :: ReadS [PutParameter]

readPrec :: ReadPrec PutParameter

readListPrec :: ReadPrec [PutParameter]

Show PutParameter

Methods

showsPrec :: Int -> PutParameter -> ShowS

show :: PutParameter -> String

showList :: [PutParameter] -> ShowS

Generic PutParameter

Associated Types

type Rep PutParameter :: * -> *

Methods

from :: PutParameter -> Rep PutParameter x

to :: Rep PutParameter x -> PutParameter

Hashable PutParameter

Methods

hashWithSalt :: Int -> PutParameter -> Int

hash :: PutParameter -> Int

ToJSON PutParameter

Methods

toJSON :: PutParameter -> Value

toEncoding :: PutParameter -> Encoding

toJSONList :: [PutParameter] -> Value

toEncodingList :: [PutParameter] -> Encoding

NFData PutParameter

Methods

rnf :: PutParameter -> ()

AWSRequest PutParameter

Associated Types

type Rs PutParameter :: *

Methods

request :: PutParameter -> Request PutParameter

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * PutParameter -> ClientResponse -> m (Response PutParameter)

ToHeaders PutParameter

Methods

toHeaders :: PutParameter -> [Header]

ToPath PutParameter

Methods

toPath :: PutParameter -> ByteString

ToQuery PutParameter

Methods

toQuery :: PutParameter -> QueryString

type Rep PutParameter

type Rep PutParameter = D1 * (MetaData "PutParameter" "Network.AWS.SSM.PutParameter" "amazonka-ssm-1.6.0-FkXaKF9jjpY64HF15tLQlO" False) (C1 * (MetaCons "PutParameter'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ppKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ppAllowedPattern") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ppOverwrite") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ppDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ppName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ppValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_ppType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ParameterType))))))

type Rs PutParameter

type Rs PutParameter = PutParameterResponse

Request Lenses

ppKeyId :: Lens' PutParameter (Maybe Text)

The KMS Key ID that you want to use to encrypt a parameter when you choose the SecureString data type. If you don't specify a key ID, the system uses the default key associated with your AWS account.

ppAllowedPattern :: Lens' PutParameter (Maybe Text)

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+$

ppOverwrite :: Lens' PutParameter (Maybe Bool)

Overwrite an existing parameter. If not specified, will default to "false".

ppDescription :: Lens' PutParameter (Maybe Text)

Information about the parameter that you want to add to the system. Important: Do not enter personally identifiable information in this field.

ppName :: Lens' PutParameter Text

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 example: DevDBServerMySQLdb-string13 For information about parameter name requirements and restrictions, see About Creating Systems Manager Parameters in the AWS Systems Manager User Guide .

ppValue :: Lens' PutParameter Text

The parameter value that you want to add to the system.

ppType :: Lens' PutParameter ParameterType

The type of parameter that you want to add to the system.

Destructuring the Response

putParameterResponse

Arguments

:: Int

pprsResponseStatus

-> PutParameterResponse

Creates a value of PutParameterResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pprsVersion - 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 actions 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.
• pprsResponseStatus - -- | The response status code.

data PutParameterResponse

See: putParameterResponse smart constructor.

Instances

Eq PutParameterResponse

Methods

(==) :: PutParameterResponse -> PutParameterResponse -> Bool

(/=) :: PutParameterResponse -> PutParameterResponse -> Bool

Data PutParameterResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutParameterResponse -> c PutParameterResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutParameterResponse

toConstr :: PutParameterResponse -> Constr

dataTypeOf :: PutParameterResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c PutParameterResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutParameterResponse)

gmapT :: (forall b. Data b => b -> b) -> PutParameterResponse -> PutParameterResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutParameterResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutParameterResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> PutParameterResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> PutParameterResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutParameterResponse -> m PutParameterResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutParameterResponse -> m PutParameterResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutParameterResponse -> m PutParameterResponse

Read PutParameterResponse

Methods

readsPrec :: Int -> ReadS PutParameterResponse

readList :: ReadS [PutParameterResponse]

readPrec :: ReadPrec PutParameterResponse

readListPrec :: ReadPrec [PutParameterResponse]

Show PutParameterResponse

Methods

showsPrec :: Int -> PutParameterResponse -> ShowS

show :: PutParameterResponse -> String

showList :: [PutParameterResponse] -> ShowS

Generic PutParameterResponse

Associated Types

type Rep PutParameterResponse :: * -> *

Methods

from :: PutParameterResponse -> Rep PutParameterResponse x

to :: Rep PutParameterResponse x -> PutParameterResponse

NFData PutParameterResponse

Methods

rnf :: PutParameterResponse -> ()

type Rep PutParameterResponse

type Rep PutParameterResponse = D1 * (MetaData "PutParameterResponse" "Network.AWS.SSM.PutParameter" "amazonka-ssm-1.6.0-FkXaKF9jjpY64HF15tLQlO" False) (C1 * (MetaCons "PutParameterResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_pprsVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Integer))) (S1 * (MetaSel (Just Symbol "_pprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

pprsVersion :: Lens' PutParameterResponse (Maybe Integer)

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 actions 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.

pprsResponseStatus :: Lens' PutParameterResponse Int

• - | The response status code.