We recommend new projects start with resources from the AWS provider.
aws-native.eks.IdentityProviderConfig
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
An object representing an Amazon EKS IdentityProviderConfig.
Create IdentityProviderConfig Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new IdentityProviderConfig(name: string, args: IdentityProviderConfigArgs, opts?: CustomResourceOptions);
@overload
def IdentityProviderConfig(resource_name: str,
args: IdentityProviderConfigArgs,
opts: Optional[ResourceOptions] = None)
@overload
def IdentityProviderConfig(resource_name: str,
opts: Optional[ResourceOptions] = None,
cluster_name: Optional[str] = None,
type: Optional[IdentityProviderConfigType] = None,
identity_provider_config_name: Optional[str] = None,
oidc: Optional[IdentityProviderConfigOidcIdentityProviderConfigArgs] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewIdentityProviderConfig(ctx *Context, name string, args IdentityProviderConfigArgs, opts ...ResourceOption) (*IdentityProviderConfig, error)
public IdentityProviderConfig(string name, IdentityProviderConfigArgs args, CustomResourceOptions? opts = null)
public IdentityProviderConfig(String name, IdentityProviderConfigArgs args)
public IdentityProviderConfig(String name, IdentityProviderConfigArgs args, CustomResourceOptions options)
type: aws-native:eks:IdentityProviderConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args IdentityProviderConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args IdentityProviderConfigArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args IdentityProviderConfigArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IdentityProviderConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IdentityProviderConfigArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
IdentityProviderConfig Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The IdentityProviderConfig resource accepts the following input properties:
- Cluster
Name string - The name of the identity provider configuration.
- Type
Pulumi.
Aws Native. Eks. Identity Provider Config Type - The type of the identity provider configuration.
- Identity
Provider stringConfig Name - The name of the OIDC provider configuration.
- Oidc
Pulumi.
Aws Native. Eks. Inputs. Identity Provider Config Oidc Identity Provider Config - An object representing an OpenID Connect (OIDC) identity provider configuration.
- List<Pulumi.
Aws Native. Inputs. Tag> - An array of key-value pairs to apply to this resource.
- Cluster
Name string - The name of the identity provider configuration.
- Type
Identity
Provider Config Type - The type of the identity provider configuration.
- Identity
Provider stringConfig Name - The name of the OIDC provider configuration.
- Oidc
Identity
Provider Config Oidc Identity Provider Config Args - An object representing an OpenID Connect (OIDC) identity provider configuration.
- Tag
Args - An array of key-value pairs to apply to this resource.
- cluster
Name String - The name of the identity provider configuration.
- type
Identity
Provider Config Type - The type of the identity provider configuration.
- identity
Provider StringConfig Name - The name of the OIDC provider configuration.
- oidc
Identity
Provider Config Oidc Identity Provider Config - An object representing an OpenID Connect (OIDC) identity provider configuration.
- List<Tag>
- An array of key-value pairs to apply to this resource.
- cluster
Name string - The name of the identity provider configuration.
- type
Identity
Provider Config Type - The type of the identity provider configuration.
- identity
Provider stringConfig Name - The name of the OIDC provider configuration.
- oidc
Identity
Provider Config Oidc Identity Provider Config - An object representing an OpenID Connect (OIDC) identity provider configuration.
- Tag[]
- An array of key-value pairs to apply to this resource.
- cluster_
name str - The name of the identity provider configuration.
- type
Identity
Provider Config Type - The type of the identity provider configuration.
- identity_
provider_ strconfig_ name - The name of the OIDC provider configuration.
- oidc
Identity
Provider Config Oidc Identity Provider Config Args - An object representing an OpenID Connect (OIDC) identity provider configuration.
- Sequence[Tag
Args] - An array of key-value pairs to apply to this resource.
- cluster
Name String - The name of the identity provider configuration.
- type "oidc"
- The type of the identity provider configuration.
- identity
Provider StringConfig Name - The name of the OIDC provider configuration.
- oidc Property Map
- An object representing an OpenID Connect (OIDC) identity provider configuration.
- List<Property Map>
- An array of key-value pairs to apply to this resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the IdentityProviderConfig resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Identity
Provider stringConfig Arn - The ARN of the configuration.
- Id string
- The provider-assigned unique ID for this managed resource.
- Identity
Provider stringConfig Arn - The ARN of the configuration.
- id String
- The provider-assigned unique ID for this managed resource.
- identity
Provider StringConfig Arn - The ARN of the configuration.
- id string
- The provider-assigned unique ID for this managed resource.
- identity
Provider stringConfig Arn - The ARN of the configuration.
- id str
- The provider-assigned unique ID for this managed resource.
- identity_
provider_ strconfig_ arn - The ARN of the configuration.
- id String
- The provider-assigned unique ID for this managed resource.
- identity
Provider StringConfig Arn - The ARN of the configuration.
Supporting Types
IdentityProviderConfigOidcIdentityProviderConfig, IdentityProviderConfigOidcIdentityProviderConfigArgs
- Client
Id string - This is also known as audience. The ID for the client application that makes authentication requests to the OpenID identity provider.
- Issuer
Url string - The URL of the OpenID identity provider that allows the API server to discover public signing keys for verifying tokens.
- Groups
Claim string - The JWT claim that the provider uses to return your groups.
- Groups
Prefix string - The prefix that is prepended to group claims to prevent clashes with existing names (such as system: groups).
- Required
Claims List<Pulumi.Aws Native. Eks. Inputs. Identity Provider Config Required Claim> - The key-value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value.
- Username
Claim string - The JSON Web Token (JWT) claim to use as the username. The default is sub, which is expected to be a unique identifier of the end user. You can choose other claims, such as email or name, depending on the OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.
- Username
Prefix string - The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and username is a value other than email, the prefix defaults to issuerurl#. You can use the value - to disable all prefixing.
- Client
Id string - This is also known as audience. The ID for the client application that makes authentication requests to the OpenID identity provider.
- Issuer
Url string - The URL of the OpenID identity provider that allows the API server to discover public signing keys for verifying tokens.
- Groups
Claim string - The JWT claim that the provider uses to return your groups.
- Groups
Prefix string - The prefix that is prepended to group claims to prevent clashes with existing names (such as system: groups).
- Required
Claims []IdentityProvider Config Required Claim - The key-value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value.
- Username
Claim string - The JSON Web Token (JWT) claim to use as the username. The default is sub, which is expected to be a unique identifier of the end user. You can choose other claims, such as email or name, depending on the OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.
- Username
Prefix string - The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and username is a value other than email, the prefix defaults to issuerurl#. You can use the value - to disable all prefixing.
- client
Id String - This is also known as audience. The ID for the client application that makes authentication requests to the OpenID identity provider.
- issuer
Url String - The URL of the OpenID identity provider that allows the API server to discover public signing keys for verifying tokens.
- groups
Claim String - The JWT claim that the provider uses to return your groups.
- groups
Prefix String - The prefix that is prepended to group claims to prevent clashes with existing names (such as system: groups).
- required
Claims List<IdentityProvider Config Required Claim> - The key-value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value.
- username
Claim String - The JSON Web Token (JWT) claim to use as the username. The default is sub, which is expected to be a unique identifier of the end user. You can choose other claims, such as email or name, depending on the OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.
- username
Prefix String - The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and username is a value other than email, the prefix defaults to issuerurl#. You can use the value - to disable all prefixing.
- client
Id string - This is also known as audience. The ID for the client application that makes authentication requests to the OpenID identity provider.
- issuer
Url string - The URL of the OpenID identity provider that allows the API server to discover public signing keys for verifying tokens.
- groups
Claim string - The JWT claim that the provider uses to return your groups.
- groups
Prefix string - The prefix that is prepended to group claims to prevent clashes with existing names (such as system: groups).
- required
Claims IdentityProvider Config Required Claim[] - The key-value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value.
- username
Claim string - The JSON Web Token (JWT) claim to use as the username. The default is sub, which is expected to be a unique identifier of the end user. You can choose other claims, such as email or name, depending on the OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.
- username
Prefix string - The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and username is a value other than email, the prefix defaults to issuerurl#. You can use the value - to disable all prefixing.
- client_
id str - This is also known as audience. The ID for the client application that makes authentication requests to the OpenID identity provider.
- issuer_
url str - The URL of the OpenID identity provider that allows the API server to discover public signing keys for verifying tokens.
- groups_
claim str - The JWT claim that the provider uses to return your groups.
- groups_
prefix str - The prefix that is prepended to group claims to prevent clashes with existing names (such as system: groups).
- required_
claims Sequence[IdentityProvider Config Required Claim] - The key-value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value.
- username_
claim str - The JSON Web Token (JWT) claim to use as the username. The default is sub, which is expected to be a unique identifier of the end user. You can choose other claims, such as email or name, depending on the OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.
- username_
prefix str - The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and username is a value other than email, the prefix defaults to issuerurl#. You can use the value - to disable all prefixing.
- client
Id String - This is also known as audience. The ID for the client application that makes authentication requests to the OpenID identity provider.
- issuer
Url String - The URL of the OpenID identity provider that allows the API server to discover public signing keys for verifying tokens.
- groups
Claim String - The JWT claim that the provider uses to return your groups.
- groups
Prefix String - The prefix that is prepended to group claims to prevent clashes with existing names (such as system: groups).
- required
Claims List<Property Map> - The key-value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value.
- username
Claim String - The JSON Web Token (JWT) claim to use as the username. The default is sub, which is expected to be a unique identifier of the end user. You can choose other claims, such as email or name, depending on the OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.
- username
Prefix String - The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and username is a value other than email, the prefix defaults to issuerurl#. You can use the value - to disable all prefixing.
IdentityProviderConfigRequiredClaim, IdentityProviderConfigRequiredClaimArgs
IdentityProviderConfigType, IdentityProviderConfigTypeArgs
- Oidc
- oidc
- Identity
Provider Config Type Oidc - oidc
- Oidc
- oidc
- Oidc
- oidc
- OIDC
- oidc
- "oidc"
- oidc
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.