libZSservicesZSamazonka-eksZSamazonka-eks
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.EKS.AssociateIdentityProviderConfig

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, both of which you define.

  • clusterName :: Text

    The name of the cluster to associate the configuration to.

  • oidc :: OidcIdentityProviderConfigRequest

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

Instances

Instances details
Eq AssociateIdentityProviderConfig Source # 
Instance details

Defined in Amazonka.EKS.AssociateIdentityProviderConfig

Methods

(==) :: AssociateIdentityProviderConfig -> AssociateIdentityProviderConfig -> Bool #

(/=) :: AssociateIdentityProviderConfig -> AssociateIdentityProviderConfig -> Bool #

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 #

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 #

NFData AssociateIdentityProviderConfig Source # 
Instance details

Defined in Amazonka.EKS.AssociateIdentityProviderConfig

Methods

rnf :: AssociateIdentityProviderConfig -> () #

Hashable AssociateIdentityProviderConfig Source # 
Instance details

Defined in Amazonka.EKS.AssociateIdentityProviderConfig

Methods

hashWithSalt :: Int -> AssociateIdentityProviderConfig -> Int #

hash :: AssociateIdentityProviderConfig -> Int #

ToJSON AssociateIdentityProviderConfig Source # 
Instance details

Defined in Amazonka.EKS.AssociateIdentityProviderConfig

Methods

toJSON :: AssociateIdentityProviderConfig -> Value #

toEncoding :: AssociateIdentityProviderConfig -> Encoding #

toJSONList :: [AssociateIdentityProviderConfig] -> Value #

toEncodingList :: [AssociateIdentityProviderConfig] -> Encoding #

AWSRequest AssociateIdentityProviderConfig Source # 
Instance details

Defined in Amazonka.EKS.AssociateIdentityProviderConfig

Associated Types

type AWSResponse AssociateIdentityProviderConfig #

Methods

request :: AssociateIdentityProviderConfig -> Request AssociateIdentityProviderConfig #

response :: MonadResource m => Logger -> Service -> Proxy AssociateIdentityProviderConfig -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AssociateIdentityProviderConfig))) #

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 #

type Rep AssociateIdentityProviderConfig Source # 
Instance details

Defined in Amazonka.EKS.AssociateIdentityProviderConfig

type Rep AssociateIdentityProviderConfig = D1 ('MetaData "AssociateIdentityProviderConfig" "Amazonka.EKS.AssociateIdentityProviderConfig" "libZSservicesZSamazonka-eksZSamazonka-eks" '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))))
type AWSResponse AssociateIdentityProviderConfig Source # 
Instance details

Defined in Amazonka.EKS.AssociateIdentityProviderConfig

type AWSResponse AssociateIdentityProviderConfig = AssociateIdentityProviderConfigResponse

newAssociateIdentityProviderConfig Source #

Arguments

:: Text

$sel:clusterName:AssociateIdentityProviderConfig'

-> OidcIdentityProviderConfigRequest

$sel:oidc: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:

$sel:clientRequestToken:AssociateIdentityProviderConfig', associateIdentityProviderConfig_clientRequestToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

$sel:tags: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, both of which you define.

$sel:clusterName:AssociateIdentityProviderConfig', associateIdentityProviderConfig_clusterName - The name of the cluster to associate the configuration to.

$sel:oidc:AssociateIdentityProviderConfig', associateIdentityProviderConfig_oidc - An object that represents 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, both of which you define.

associateIdentityProviderConfig_clusterName :: Lens' AssociateIdentityProviderConfig Text Source #

The name of the cluster to associate the configuration to.

associateIdentityProviderConfig_oidc :: Lens' AssociateIdentityProviderConfig OidcIdentityProviderConfigRequest Source #

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

Destructuring the Response

data AssociateIdentityProviderConfigResponse Source #

See: newAssociateIdentityProviderConfigResponse smart constructor.

Constructors

AssociateIdentityProviderConfigResponse' 

Fields

Instances

Instances details
Eq AssociateIdentityProviderConfigResponse Source # 
Instance details

Defined in Amazonka.EKS.AssociateIdentityProviderConfig

Methods

(==) :: AssociateIdentityProviderConfigResponse -> AssociateIdentityProviderConfigResponse -> Bool #

(/=) :: AssociateIdentityProviderConfigResponse -> AssociateIdentityProviderConfigResponse -> Bool #

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 #

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 #

NFData AssociateIdentityProviderConfigResponse Source # 
Instance details

Defined in Amazonka.EKS.AssociateIdentityProviderConfig

Methods

rnf :: AssociateIdentityProviderConfigResponse -> () #

type Rep AssociateIdentityProviderConfigResponse Source # 
Instance details

Defined in Amazonka.EKS.AssociateIdentityProviderConfig

type Rep AssociateIdentityProviderConfigResponse = D1 ('MetaData "AssociateIdentityProviderConfigResponse" "Amazonka.EKS.AssociateIdentityProviderConfig" "libZSservicesZSamazonka-eksZSamazonka-eks" 'False) (C1 ('MetaCons "AssociateIdentityProviderConfigResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "update") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Update)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: 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:

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

$sel:tags:AssociateIdentityProviderConfig', associateIdentityProviderConfigResponse_tags - The tags for the resource.

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

Response Lenses

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

Undocumented member.

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

The tags for the resource.

associateIdentityProviderConfigResponse_httpStatus :: Lens' AssociateIdentityProviderConfigResponse Int Source #

The response's http status code.