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

Amazonka.EKS.UpdateAddon

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an Amazon EKS add-on.

Synopsis

data UpdateAddon = UpdateAddon' {
- addonVersion :: Maybe Text
- clientRequestToken :: Maybe Text
- configurationValues :: Maybe Text
- resolveConflicts :: Maybe ResolveConflicts
- serviceAccountRoleArn :: Maybe Text
- clusterName :: Text
- addonName :: Text
}
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.

Constructors

UpdateAddon'

Fields

addonVersion :: Maybe Text
The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions .
clientRequestToken :: Maybe Text
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
configurationValues :: Maybe Text
The set of configuration values for the add-on that's created. The values that you provide are validated against the schema in DescribeAddonConfiguration.
resolveConflicts :: Maybe 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.
serviceAccountRoleArn :: Maybe Text
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.
clusterName :: Text
The name of the cluster.
addonName :: Text
The name of the add-on. The name must match one of the names returned by ListAddons .

Instances

Instances details

ToJSON UpdateAddon Source #
Instance details Defined in Amazonka.EKS.UpdateAddon Methods toJSON :: UpdateAddon -> Value # toEncoding :: UpdateAddon -> Encoding # toJSONList :: [UpdateAddon] -> Value # toEncodingList :: [UpdateAddon] -> Encoding #
ToHeaders UpdateAddon Source #
Instance details Defined in Amazonka.EKS.UpdateAddon Methods toHeaders :: UpdateAddon -> [Header] #
ToPath UpdateAddon Source #
Instance details Defined in Amazonka.EKS.UpdateAddon Methods toPath :: UpdateAddon -> ByteString #
ToQuery UpdateAddon Source #
Instance details Defined in Amazonka.EKS.UpdateAddon Methods toQuery :: UpdateAddon -> QueryString #
AWSRequest UpdateAddon Source #
Instance details Defined in Amazonka.EKS.UpdateAddon Associated Types type AWSResponse UpdateAddon # Methods request :: (Service -> Service) -> UpdateAddon -> Request UpdateAddon # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateAddon -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateAddon))) #
Generic UpdateAddon Source #
Instance details Defined in Amazonka.EKS.UpdateAddon Associated Types type Rep UpdateAddon :: Type -> Type # Methods from :: UpdateAddon -> Rep UpdateAddon x # to :: Rep UpdateAddon x -> UpdateAddon #
Read UpdateAddon Source #
Instance details Defined in Amazonka.EKS.UpdateAddon Methods readsPrec :: Int -> ReadS UpdateAddon # readList :: ReadS [UpdateAddon] # readPrec :: ReadPrec UpdateAddon # readListPrec :: ReadPrec [UpdateAddon] #
Show UpdateAddon Source #
Instance details Defined in Amazonka.EKS.UpdateAddon Methods showsPrec :: Int -> UpdateAddon -> ShowS # show :: UpdateAddon -> String # showList :: [UpdateAddon] -> ShowS #
NFData UpdateAddon Source #
Instance details Defined in Amazonka.EKS.UpdateAddon Methods rnf :: UpdateAddon -> () #
Eq UpdateAddon Source #
Instance details Defined in Amazonka.EKS.UpdateAddon Methods (==) :: UpdateAddon -> UpdateAddon -> Bool # (/=) :: UpdateAddon -> UpdateAddon -> Bool #
Hashable UpdateAddon Source #
Instance details Defined in Amazonka.EKS.UpdateAddon Methods hashWithSalt :: Int -> UpdateAddon -> Int # hash :: UpdateAddon -> Int #
type AWSResponse UpdateAddon Source #
Instance details Defined in Amazonka.EKS.UpdateAddon type AWSResponse UpdateAddon = UpdateAddonResponse
type Rep UpdateAddon Source #
Instance details Defined in Amazonka.EKS.UpdateAddon type Rep UpdateAddon = D1 ('MetaData "UpdateAddon" "Amazonka.EKS.UpdateAddon" "amazonka-eks-2.0-7cAibD4zEbE2zPO6gnUh5m" 'False) (C1 ('MetaCons "UpdateAddon'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "addonVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "configurationValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "resolveConflicts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResolveConflicts)) :: S1 ('MetaSel ('Just "serviceAccountRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "clusterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "addonName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateAddon Source #

Arguments

:: Text	`UpdateAddon`
-> Text	`UpdateAddon`
-> UpdateAddon

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.

Constructors

UpdateAddonResponse'
Fields update :: Maybe Update httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateAddonResponse Source #
Instance details Defined in Amazonka.EKS.UpdateAddon Associated Types type Rep UpdateAddonResponse :: Type -> Type # Methods from :: UpdateAddonResponse -> Rep UpdateAddonResponse x # to :: Rep UpdateAddonResponse x -> UpdateAddonResponse #
Read UpdateAddonResponse Source #
Instance details Defined in Amazonka.EKS.UpdateAddon Methods readsPrec :: Int -> ReadS UpdateAddonResponse # readList :: ReadS [UpdateAddonResponse] # readPrec :: ReadPrec UpdateAddonResponse # readListPrec :: ReadPrec [UpdateAddonResponse] #
Show UpdateAddonResponse Source #
Instance details Defined in Amazonka.EKS.UpdateAddon Methods showsPrec :: Int -> UpdateAddonResponse -> ShowS # show :: UpdateAddonResponse -> String # showList :: [UpdateAddonResponse] -> ShowS #
NFData UpdateAddonResponse Source #
Instance details Defined in Amazonka.EKS.UpdateAddon Methods rnf :: UpdateAddonResponse -> () #
Eq UpdateAddonResponse Source #
Instance details Defined in Amazonka.EKS.UpdateAddon Methods (==) :: UpdateAddonResponse -> UpdateAddonResponse -> Bool # (/=) :: UpdateAddonResponse -> UpdateAddonResponse -> Bool #
type Rep UpdateAddonResponse Source #
Instance details Defined in Amazonka.EKS.UpdateAddon type Rep UpdateAddonResponse = D1 ('MetaData "UpdateAddonResponse" "Amazonka.EKS.UpdateAddon" "amazonka-eks-2.0-7cAibD4zEbE2zPO6gnUh5m" 'False) (C1 ('MetaCons "UpdateAddonResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "update") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Update)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateAddonResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateAddonResponse'`
-> UpdateAddonResponse

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.