| 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.CloudFront.UpdateKeyGroup
Description
Updates a key group.
When you update a key group, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a key group:
- Get the current key group with
GetKeyGrouporGetKeyGroupConfig. - Locally modify the fields in the key group that you want to update. For example, add or remove public key IDs.
- Call
UpdateKeyGroupwith the entire key group object, including the fields that you modified and those that you didn’t.
Synopsis
- data UpdateKeyGroup = UpdateKeyGroup' {
- ifMatch :: Maybe Text
- keyGroupConfig :: KeyGroupConfig
- id :: Text
- newUpdateKeyGroup :: KeyGroupConfig -> Text -> UpdateKeyGroup
- updateKeyGroup_ifMatch :: Lens' UpdateKeyGroup (Maybe Text)
- updateKeyGroup_keyGroupConfig :: Lens' UpdateKeyGroup KeyGroupConfig
- updateKeyGroup_id :: Lens' UpdateKeyGroup Text
- data UpdateKeyGroupResponse = UpdateKeyGroupResponse' {}
- newUpdateKeyGroupResponse :: Int -> UpdateKeyGroupResponse
- updateKeyGroupResponse_eTag :: Lens' UpdateKeyGroupResponse (Maybe Text)
- updateKeyGroupResponse_keyGroup :: Lens' UpdateKeyGroupResponse (Maybe KeyGroup)
- updateKeyGroupResponse_httpStatus :: Lens' UpdateKeyGroupResponse Int
Creating a Request
data UpdateKeyGroup Source #
See: newUpdateKeyGroup smart constructor.
Constructors
| UpdateKeyGroup' | |
Fields
| |
Instances
Arguments
| :: KeyGroupConfig | |
| -> Text | |
| -> UpdateKeyGroup |
Create a value of UpdateKeyGroup 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:ifMatch:UpdateKeyGroup', updateKeyGroup_ifMatch - The version of the key group that you are updating. The version is the
key group’s ETag value.
$sel:keyGroupConfig:UpdateKeyGroup', updateKeyGroup_keyGroupConfig - The key group configuration.
$sel:id:UpdateKeyGroup', updateKeyGroup_id - The identifier of the key group that you are updating.
Request Lenses
updateKeyGroup_ifMatch :: Lens' UpdateKeyGroup (Maybe Text) Source #
The version of the key group that you are updating. The version is the
key group’s ETag value.
updateKeyGroup_keyGroupConfig :: Lens' UpdateKeyGroup KeyGroupConfig Source #
The key group configuration.
updateKeyGroup_id :: Lens' UpdateKeyGroup Text Source #
The identifier of the key group that you are updating.
Destructuring the Response
data UpdateKeyGroupResponse Source #
See: newUpdateKeyGroupResponse smart constructor.
Constructors
| UpdateKeyGroupResponse' | |
Instances
newUpdateKeyGroupResponse Source #
Create a value of UpdateKeyGroupResponse 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:eTag:UpdateKeyGroupResponse', updateKeyGroupResponse_eTag - The identifier for this version of the key group.
$sel:keyGroup:UpdateKeyGroupResponse', updateKeyGroupResponse_keyGroup - The key group that was just updated.
$sel:httpStatus:UpdateKeyGroupResponse', updateKeyGroupResponse_httpStatus - The response's http status code.
Response Lenses
updateKeyGroupResponse_eTag :: Lens' UpdateKeyGroupResponse (Maybe Text) Source #
The identifier for this version of the key group.
updateKeyGroupResponse_keyGroup :: Lens' UpdateKeyGroupResponse (Maybe KeyGroup) Source #
The key group that was just updated.
updateKeyGroupResponse_httpStatus :: Lens' UpdateKeyGroupResponse Int Source #
The response's http status code.