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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Associate an identity provider configuration to a cluster.

If you want to authenticate identities using an identity provider, you can create an identity provider configuration and associate it to your cluster. After configuring authentication to your cluster you can create Kubernetes roles and clusterroles to assign permissions to the roles, and then bind the roles to the identities using Kubernetes rolebindings and clusterrolebindings. For more information see Using RBAC Authorization in the Kubernetes documentation.

Synopsis

Creating a Request

data AssociateIdentityProviderConfig Source #

See: newAssociateIdentityProviderConfig smart constructor.

Constructors

AssociateIdentityProviderConfig'

Fields

clientRequestToken :: Maybe Text
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
tags :: Maybe (HashMap Text Text)
The metadata to apply to the configuration 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 associate the configuration to.
oidc :: OidcIdentityProviderConfigRequest
An object representing an OpenID Connect (OIDC) identity provider configuration.

Instances

Instances details

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

newAssociateIdentityProviderConfig Source #

Arguments

:: Text	`AssociateIdentityProviderConfig`
-> OidcIdentityProviderConfigRequest	`AssociateIdentityProviderConfig`
-> AssociateIdentityProviderConfig

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

AssociateIdentityProviderConfig, associateIdentityProviderConfig_clientRequestToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

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

AssociateIdentityProviderConfig, associateIdentityProviderConfig_clusterName - The name of the cluster to associate the configuration to.

AssociateIdentityProviderConfig, associateIdentityProviderConfig_oidc - An object representing an OpenID Connect (OIDC) identity provider configuration.

Request Lenses

associateIdentityProviderConfig_clientRequestToken :: Lens' AssociateIdentityProviderConfig (Maybe Text) Source #

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

associateIdentityProviderConfig_tags :: Lens' AssociateIdentityProviderConfig (Maybe (HashMap Text Text)) Source #

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

associateIdentityProviderConfig_clusterName :: Lens' AssociateIdentityProviderConfig Text Source #

The name of the cluster to associate the configuration to.

associateIdentityProviderConfig_oidc :: Lens' AssociateIdentityProviderConfig OidcIdentityProviderConfigRequest Source #

An object representing an OpenID Connect (OIDC) identity provider configuration.

Destructuring the Response

data AssociateIdentityProviderConfigResponse Source #

See: newAssociateIdentityProviderConfigResponse smart constructor.

Constructors

AssociateIdentityProviderConfigResponse'
Fields tags :: Maybe (HashMap Text Text) The tags for the resource. update :: Maybe Update httpStatus :: Int The response's http status code.

Instances

Instances details

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

newAssociateIdentityProviderConfigResponse Source #

Arguments

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

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

AssociateIdentityProviderConfig, associateIdentityProviderConfigResponse_tags - The tags for the resource.

$sel:update:AssociateIdentityProviderConfigResponse', associateIdentityProviderConfigResponse_update - Undocumented member.

$sel:httpStatus:AssociateIdentityProviderConfigResponse', associateIdentityProviderConfigResponse_httpStatus - The response's http status code.

Response Lenses

associateIdentityProviderConfigResponse_tags :: Lens' AssociateIdentityProviderConfigResponse (Maybe (HashMap Text Text)) Source #

The tags for the resource.

associateIdentityProviderConfigResponse_update :: Lens' AssociateIdentityProviderConfigResponse (Maybe Update) Source #

Undocumented member.

associateIdentityProviderConfigResponse_httpStatus :: Lens' AssociateIdentityProviderConfigResponse Int Source #

The response's http status code.