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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an Amazon EKS add-on.

Amazon EKS add-ons help to automate the provisioning and lifecycle management of common operational software for Amazon EKS clusters. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide.

Synopsis

data CreateAddon = CreateAddon' {
- addonVersion :: Maybe Text
- clientRequestToken :: Maybe Text
- configurationValues :: Maybe Text
- resolveConflicts :: Maybe ResolveConflicts
- serviceAccountRoleArn :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- clusterName :: Text
- addonName :: Text
}
newCreateAddon :: Text -> Text -> CreateAddon
createAddon_addonVersion :: Lens' CreateAddon (Maybe Text)
createAddon_clientRequestToken :: Lens' CreateAddon (Maybe Text)
createAddon_configurationValues :: Lens' CreateAddon (Maybe Text)
createAddon_resolveConflicts :: Lens' CreateAddon (Maybe ResolveConflicts)
createAddon_serviceAccountRoleArn :: Lens' CreateAddon (Maybe Text)
createAddon_tags :: Lens' CreateAddon (Maybe (HashMap Text Text))
createAddon_clusterName :: Lens' CreateAddon Text
createAddon_addonName :: Lens' CreateAddon Text
data CreateAddonResponse = CreateAddonResponse' {
- addon :: Maybe Addon
- httpStatus :: Int
}
newCreateAddonResponse :: Int -> CreateAddonResponse
createAddonResponse_addon :: Lens' CreateAddonResponse (Maybe Addon)
createAddonResponse_httpStatus :: Lens' CreateAddonResponse Int

Creating a Request

data CreateAddon Source #

See: newCreateAddon smart constructor.

Constructors

CreateAddon'

Fields

addonVersion :: Maybe Text
The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions .
clientRequestToken :: Maybe Text
A 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. Conflicts are handled based on the value you choose:
- None – If the self-managed version of the add-on is installed on your cluster, Amazon EKS doesn't change the value. Creation of the add-on might fail.
- Overwrite – If the self-managed version of the add-on is installed on your cluster and the Amazon EKS default value is different than the existing value, Amazon EKS changes the value to the Amazon EKS default value.
- Preserve – Not supported. You can set this value when updating an add-on though. For more information, see UpdateAddon.
If you don't currently have the self-managed version of the add-on installed on your cluster, the Amazon EKS add-on is installed. Amazon EKS sets all values to default values, regardless of the option that you specify.
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.
tags :: Maybe (HashMap Text Text)
The metadata to apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both.
clusterName :: Text
The name of the cluster to create the add-on for.
addonName :: Text
The name of the add-on. The name must match one of the names that DescribeAddonVersions returns.

Instances

Instances details

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

newCreateAddon Source #

Arguments

:: Text	`CreateAddon`
-> Text	`CreateAddon`
-> CreateAddon

Create a value of CreateAddon 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:

CreateAddon, createAddon_addonVersion - The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions .

CreateAddon, createAddon_clientRequestToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

CreateAddon, createAddon_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:CreateAddon', createAddon_resolveConflicts - How to resolve field value conflicts for an Amazon EKS add-on. Conflicts are handled based on the value you choose:

None – If the self-managed version of the add-on is installed on your cluster, Amazon EKS doesn't change the value. Creation of the add-on might fail.
Overwrite – If the self-managed version of the add-on is installed on your cluster and the Amazon EKS default value is different than the existing value, Amazon EKS changes the value to the Amazon EKS default value.
Preserve – Not supported. You can set this value when updating an add-on though. For more information, see UpdateAddon.

If you don't currently have the self-managed version of the add-on installed on your cluster, the Amazon EKS add-on is installed. Amazon EKS sets all values to default values, regardless of the option that you specify.

CreateAddon, createAddon_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.

CreateAddon, createAddon_tags - The metadata to apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both.

CreateAddon, createAddon_clusterName - The name of the cluster to create the add-on for.

CreateAddon, createAddon_addonName - The name of the add-on. The name must match one of the names that DescribeAddonVersions returns.

Request Lenses

createAddon_addonVersion :: Lens' CreateAddon (Maybe Text) Source #

The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions .

createAddon_clientRequestToken :: Lens' CreateAddon (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

createAddon_configurationValues :: Lens' CreateAddon (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 .

createAddon_resolveConflicts :: Lens' CreateAddon (Maybe ResolveConflicts) Source #

How to resolve field value conflicts for an Amazon EKS add-on. Conflicts are handled based on the value you choose:

None – If the self-managed version of the add-on is installed on your cluster, Amazon EKS doesn't change the value. Creation of the add-on might fail.
Overwrite – If the self-managed version of the add-on is installed on your cluster and the Amazon EKS default value is different than the existing value, Amazon EKS changes the value to the Amazon EKS default value.
Preserve – Not supported. You can set this value when updating an add-on though. For more information, see UpdateAddon.

If you don't currently have the self-managed version of the add-on installed on your cluster, the Amazon EKS add-on is installed. Amazon EKS sets all values to default values, regardless of the option that you specify.

createAddon_serviceAccountRoleArn :: Lens' CreateAddon (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.

createAddon_tags :: Lens' CreateAddon (Maybe (HashMap Text Text)) Source #

The metadata to apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both.

createAddon_clusterName :: Lens' CreateAddon Text Source #

The name of the cluster to create the add-on for.

createAddon_addonName :: Lens' CreateAddon Text Source #

The name of the add-on. The name must match one of the names that DescribeAddonVersions returns.

Destructuring the Response

data CreateAddonResponse Source #

See: newCreateAddonResponse smart constructor.

Constructors

CreateAddonResponse'
Fields addon :: Maybe Addon httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateAddonResponse Source #

Arguments

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

Create a value of CreateAddonResponse 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:addon:CreateAddonResponse', createAddonResponse_addon - Undocumented member.

$sel:httpStatus:CreateAddonResponse', createAddonResponse_httpStatus - The response's http status code.

Response Lenses

createAddonResponse_addon :: Lens' CreateAddonResponse (Maybe Addon) Source #

Undocumented member.

createAddonResponse_httpStatus :: Lens' CreateAddonResponse Int Source #

The response's http status code.