OpenIdConnectProvider

class aws_cdk.aws_eks.OpenIdConnectProvider(scope, id, *, url)

Bases: aws_cdk.aws_iam.OpenIdConnectProvider

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

Resource

AWS::CloudFormation::CustomResource

Defines an OpenID Connect provider.

Parameters

  • scope (Construct) – The definition scope.

  • id (str) – Construct ID.

  • url (str) – 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

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters

policy (RemovalPolicy) –

Return type

None

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

ResourceEnvironment

node

The construct tree node associated with this construct.

Return type

ConstructNode

open_id_connect_provider_arn

The Amazon Resource Name (ARN) of the IAM OpenID Connect provider.

Return type

str

open_id_connect_provider_issuer

The issuer for OIDC Provider.

Return type

str

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod from_open_id_connect_provider_arn(scope, id, open_id_connect_provider_arn)

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.

Return type

IOpenIdConnectProvider

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters

construct (IConstruct) –

Return type

bool