Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Updates an Amazon EKS add-on.
Synopsis
- data UpdateAddon = UpdateAddon' {}
- newUpdateAddon :: Text -> Text -> UpdateAddon
- updateAddon_addonVersion :: Lens' UpdateAddon (Maybe Text)
- updateAddon_clientRequestToken :: Lens' UpdateAddon (Maybe Text)
- updateAddon_configurationValues :: Lens' UpdateAddon (Maybe Text)
- updateAddon_resolveConflicts :: Lens' UpdateAddon (Maybe ResolveConflicts)
- updateAddon_serviceAccountRoleArn :: Lens' UpdateAddon (Maybe Text)
- updateAddon_clusterName :: Lens' UpdateAddon Text
- updateAddon_addonName :: Lens' UpdateAddon Text
- data UpdateAddonResponse = UpdateAddonResponse' {
- update :: Maybe Update
- httpStatus :: Int
- newUpdateAddonResponse :: Int -> UpdateAddonResponse
- updateAddonResponse_update :: Lens' UpdateAddonResponse (Maybe Update)
- updateAddonResponse_httpStatus :: Lens' UpdateAddonResponse Int
Creating a Request
data UpdateAddon Source #
See: newUpdateAddon
smart constructor.
UpdateAddon' | |
|
Instances
Create a value of UpdateAddon
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:
UpdateAddon
, updateAddon_addonVersion
- The version of the add-on. The version must match one of the versions
returned by
DescribeAddonVersions
.
UpdateAddon
, updateAddon_clientRequestToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
UpdateAddon
, updateAddon_configurationValues
- The set of configuration values for the add-on that's created. The
values that you provide are validated against the schema in
DescribeAddonConfiguration.
$sel:resolveConflicts:UpdateAddon'
, updateAddon_resolveConflicts
- How to resolve field value conflicts for an Amazon EKS add-on if you've
changed a value from the Amazon EKS default value. Conflicts are handled
based on the option you choose:
- None – Amazon EKS doesn't change the value. The update might fail.
- Overwrite – Amazon EKS overwrites the changed value back to the Amazon EKS default value.
- Preserve – Amazon EKS preserves the value. If you choose this option, we recommend that you test any field and value changes on a non-production cluster before updating the add-on on your production cluster.
UpdateAddon
, updateAddon_serviceAccountRoleArn
- The Amazon Resource Name (ARN) of an existing IAM role to bind to the
add-on's service account. The role must be assigned the IAM permissions
required by the add-on. If you don't specify an existing IAM role, then
the add-on uses the permissions assigned to the node IAM role. For more
information, see
Amazon EKS node IAM role
in the Amazon EKS User Guide.
To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the Amazon EKS User Guide.
UpdateAddon
, updateAddon_clusterName
- The name of the cluster.
UpdateAddon
, updateAddon_addonName
- The name of the add-on. The name must match one of the names returned by
ListAddons
.
Request Lenses
updateAddon_addonVersion :: Lens' UpdateAddon (Maybe Text) Source #
The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions .
updateAddon_clientRequestToken :: Lens' UpdateAddon (Maybe Text) Source #
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
updateAddon_configurationValues :: Lens' UpdateAddon (Maybe Text) Source #
The set of configuration values for the add-on that's created. The values that you provide are validated against the schema in DescribeAddonConfiguration.
updateAddon_resolveConflicts :: Lens' UpdateAddon (Maybe ResolveConflicts) Source #
How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Conflicts are handled based on the option you choose:
- None – Amazon EKS doesn't change the value. The update might fail.
- Overwrite – Amazon EKS overwrites the changed value back to the Amazon EKS default value.
- Preserve – Amazon EKS preserves the value. If you choose this option, we recommend that you test any field and value changes on a non-production cluster before updating the add-on on your production cluster.
updateAddon_serviceAccountRoleArn :: Lens' UpdateAddon (Maybe Text) Source #
The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.
To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the Amazon EKS User Guide.
updateAddon_clusterName :: Lens' UpdateAddon Text Source #
The name of the cluster.
updateAddon_addonName :: Lens' UpdateAddon Text Source #
The name of the add-on. The name must match one of the names returned by ListAddons .
Destructuring the Response
data UpdateAddonResponse Source #
See: newUpdateAddonResponse
smart constructor.
UpdateAddonResponse' | |
|
Instances
newUpdateAddonResponse Source #
Create a value of UpdateAddonResponse
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:update:UpdateAddonResponse'
, updateAddonResponse_update
- Undocumented member.
$sel:httpStatus:UpdateAddonResponse'
, updateAddonResponse_httpStatus
- The response's http status code.
Response Lenses
updateAddonResponse_update :: Lens' UpdateAddonResponse (Maybe Update) Source #
Undocumented member.
updateAddonResponse_httpStatus :: Lens' UpdateAddonResponse Int Source #
The response's http status code.