OpenIdConnectProvider¶
-
class
aws_cdk.aws_eks.
OpenIdConnectProvider
(scope, id, *, url)¶ Bases:
aws_cdk.aws_iam.OpenIdConnectProvider
(experimental) IAM OIDC identity providers are entities in IAM that describe an external identity provider (IdP) service that supports the OpenID Connect (OIDC) standard, such as Google or Salesforce.
You use an IAM OIDC identity provider when you want to establish trust between an OIDC-compatible IdP and your AWS account.
This implementation has default values for thumbprints and clientIds props that will be compatible with the eks cluster
- See
https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html
- Stability
experimental
- Resource
AWS::CloudFormation::CustomResource
(experimental) Defines an OpenID Connect provider.
- Parameters
scope (
Construct
) – The definition scope.id (
str
) – Construct ID.url (
str
) – (experimental) The URL of the identity provider. The URL must begin with https:// and should correspond to the iss claim in the provider’s OpenID Connect ID tokens. Per the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a hostname, like https://server.example.org or https://example.com. You can find your OIDC Issuer URL by: aws eks describe-cluster –name %cluster_name% –query “cluster.identity.oidc.issuer” –output text
- Stability
experimental
Methods
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
Attributes
-
env
¶ The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
- Return type
-
node
¶ The construct tree node associated with this construct.
- Return type
-
open_id_connect_provider_arn
¶ (experimental) The Amazon Resource Name (ARN) of the IAM OpenID Connect provider.
- Stability
experimental
- Return type
str
-
open_id_connect_provider_issuer
¶ (experimental) The issuer for OIDC Provider.
- Stability
experimental
- Return type
str
Static Methods
-
classmethod
from_open_id_connect_provider_arn
(scope, id, open_id_connect_provider_arn)¶ (experimental) Imports an Open ID connect provider from an ARN.
- Parameters
scope (
Construct
) – The definition scope.id (
str
) – ID of the construct.open_id_connect_provider_arn (
str
) – the ARN to import.
- Stability
experimental
- Return type
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool