Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Add a parameter to the system.
Synopsis
- putParameter :: Text -> Text -> ParameterType -> PutParameter
- data PutParameter
- ppKeyId :: Lens' PutParameter (Maybe Text)
- ppAllowedPattern :: Lens' PutParameter (Maybe Text)
- ppOverwrite :: Lens' PutParameter (Maybe Bool)
- ppDescription :: Lens' PutParameter (Maybe Text)
- ppName :: Lens' PutParameter Text
- ppValue :: Lens' PutParameter Text
- ppType :: Lens' PutParameter ParameterType
- putParameterResponse :: Int -> PutParameterResponse
- data PutParameterResponse
- pprsVersion :: Lens' PutParameterResponse (Maybe Integer)
- pprsResponseStatus :: Lens' PutParameterResponse Int
Creating a Request
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 Source #
See: putParameter
smart constructor.
Instances
Request Lenses
ppKeyId :: Lens' PutParameter (Maybe Text) Source #
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) Source #
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) Source #
Overwrite an existing parameter. If not specified, will default to "false".
ppDescription :: Lens' PutParameter (Maybe Text) Source #
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 Source #
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 .
ppType :: Lens' PutParameter ParameterType Source #
The type of parameter that you want to add to the system.
Destructuring the Response
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 Source #
See: putParameterResponse
smart constructor.
Instances
Response Lenses
pprsVersion :: Lens' PutParameterResponse (Maybe Integer) Source #
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 Source #
- - | The response status code.