Class: AWSCDK::IAM::OpenIdConnectProvider

Inherits:
Resource
  • Object
show all
Includes:
IOpenIdConnectProvider
Defined in:
iam/open_id_connect_provider.rb

Overview

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 is useful when creating a mobile app or web application that requires access to AWS resources, but you don't want to create custom sign-in code or manage your own user identities.

⚠️ IMPORTANT NOTICE FOR CONTRIBUTORS ⚠️

DO NOT ADD NEW FEATURES TO THIS CONSTRUCT

This construct uses a custom resource with Lambda functions and is maintained for backward compatibility only. We cannot deprecate it due to its usage in existing services like EKS (see https://github.com/aws/aws-cdk/pull/28634#discussion_r1842962697).

For new functionality, developers should use OidcProviderNative instead, which utilizes the native CloudFormation resource AWS::IAM::OIDCProvider and provides the same functionality with less complexity.

If you are considering adding features to this construct, please:

  1. Consider implementing the feature in OidcProviderNative instead
  2. Discuss with the CDK team before proceeding
  3. Ensure any changes maintain strict backward compatibility

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ OpenIdConnectProvider

Defines an OpenID Connect provider.

Parameters:



40
41
42
43
44
45
46
 
# File 'iam/open_id_connect_provider.rb', line 40

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::IAM::OpenIdConnectProviderProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLk9wZW5JZENvbm5lY3RQcm92aWRlclByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_open_id_connect_provider_arn(scope, id, open_id_connect_provider_arn) ⇒ AWSCDK::IAM::IOpenIdConnectProvider

Imports an Open ID connect provider from an ARN.

Parameters:

  • scope (Constructs::Construct) —

    The definition scope.

  • id (String) —

    ID of the construct.

  • open_id_connect_provider_arn (String) —

    the ARN to import.

Returns:



74
75
76
77
78
79
 
# File 'iam/open_id_connect_provider.rb', line 74

def self.from_open_id_connect_provider_arn(scope, id, open_id_connect_provider_arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(open_id_connect_provider_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "openIdConnectProviderArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iam.OpenIdConnectProvider", "fromOpenIdConnectProviderArn", [scope, id, open_id_connect_provider_arn])
end

.jsii_overridable_methods ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'iam/open_id_connect_provider.rb', line 48

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :oidc_provider_ref => { kind: :property, name: "oidcProviderRef", is_optional: false },
    :open_id_connect_provider_arn => { kind: :property, name: "openIdConnectProviderArn", is_optional: false },
    :open_id_connect_provider_issuer => { kind: :property, name: "openIdConnectProviderIssuer", is_optional: false },
    :open_id_connect_providerthumbprints => { kind: :property, name: "openIdConnectProviderthumbprints", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


127
128
129
 
# File 'iam/open_id_connect_provider.rb', line 127

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_iam.OpenIdConnectProvider", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



192
193
194
195
 
# File 'iam/open_id_connect_provider.rb', line 192

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

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:



209
210
211
212
 
# File 'iam/open_id_connect_provider.rb', line 209

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



99
100
101
 
# File 'iam/open_id_connect_provider.rb', line 99

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


215
216
217
 
# File 'iam/open_id_connect_provider.rb', line 215

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


229
230
231
232
233
234
 
# File 'iam/open_id_connect_provider.rb', line 229

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


244
245
246
247
 
# File 'iam/open_id_connect_provider.rb', line 244

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


84
85
86
 
# File 'iam/open_id_connect_provider.rb', line 84

def node()
  jsii_get_property("node")
end

#oidc_provider_ref ⇒ AWSCDK::Interfaces::AWSIAM::OIDCProviderReference

A reference to a OIDCProvider resource.

Returns:



134
135
136
 
# File 'iam/open_id_connect_provider.rb', line 134

def oidc_provider_ref()
  jsii_get_property("oidcProviderRef")
end

#open_id_connect_provider_arn ⇒ String

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

Returns:

  • (String) 


141
142
143
 
# File 'iam/open_id_connect_provider.rb', line 141

def open_id_connect_provider_arn()
  jsii_get_property("openIdConnectProviderArn")
end

#open_id_connect_provider_issuer ⇒ String

The issuer for OIDC Provider.

Returns:

  • (String) 


148
149
150
 
# File 'iam/open_id_connect_provider.rb', line 148

def open_id_connect_provider_issuer()
  jsii_get_property("openIdConnectProviderIssuer")
end

#open_id_connect_providerthumbprints ⇒ String

The thumbprints configured for this provider.

Returns:

  • (String) 


155
156
157
 
# File 'iam/open_id_connect_provider.rb', line 155

def open_id_connect_providerthumbprints()
  jsii_get_property("openIdConnectProviderthumbprints")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


113
114
115
 
# File 'iam/open_id_connect_provider.rb', line 113

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



120
121
122
 
# File 'iam/open_id_connect_provider.rb', line 120

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


162
163
164
 
# File 'iam/open_id_connect_provider.rb', line 162

def to_string()
  jsii_call_method("toString", [])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


175
176
177
178
179
180
 
# File 'iam/open_id_connect_provider.rb', line 175

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end