Class: AWSCDK::IAM::OidcProviderNative

Inherits:
Resource
  • Object
show all
Includes:
IOidcProvider
Defined in:
iam/oidc_provider_native.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.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ OidcProviderNative

Defines a Native OpenID Connect provider.

Parameters:



22
23
24
25
26
27
28
 
# File 'iam/oidc_provider_native.rb', line 22

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::IAM::OidcProviderNativeProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLk9pZGNQcm92aWRlck5hdGl2ZVByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_oidc_provider_arn(scope, id, oidc_provider_arn) ⇒ AWSCDK::IAM::IOidcProvider

Imports an Open ID connect provider from an ARN.

Parameters:

  • scope (Constructs::Construct) —

    The definition scope.

  • id (String) —

    ID of the construct.

  • oidc_provider_arn (String) —

    the ARN to import.

Returns:



58
59
60
61
62
63
 
# File 'iam/oidc_provider_native.rb', line 58

def self.from_oidc_provider_arn(scope, id, oidc_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(oidc_provider_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "oidcProviderArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iam.OidcProviderNative", "fromOidcProviderArn", [scope, id, oidc_provider_arn])
end

.jsii_overridable_methods ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'iam/oidc_provider_native.rb', line 30

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_arn => { kind: :property, name: "oidcProviderArn", is_optional: false },
    :oidc_provider_issuer => { kind: :property, name: "oidcProviderIssuer", is_optional: false },
    :oidc_provider_ref => { kind: :property, name: "oidcProviderRef", is_optional: false },
    :oidc_provider_thumbprints => { kind: :property, name: "oidcProviderThumbprints", 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 },
    :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) 


111
112
113
 
# File 'iam/oidc_provider_native.rb', line 111

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_iam.OidcProviderNative", "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:



194
195
196
197
 
# File 'iam/oidc_provider_native.rb', line 194

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:



211
212
213
214
 
# File 'iam/oidc_provider_native.rb', line 211

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:



83
84
85
 
# File 'iam/oidc_provider_native.rb', line 83

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


217
218
219
 
# File 'iam/oidc_provider_native.rb', line 217

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) 


231
232
233
234
235
236
 
# File 'iam/oidc_provider_native.rb', line 231

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) 


246
247
248
249
 
# File 'iam/oidc_provider_native.rb', line 246

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) 


68
69
70
 
# File 'iam/oidc_provider_native.rb', line 68

def node()
  jsii_get_property("node")
end

#oidc_provider_arn ⇒ String

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

Returns:

  • (String) 


118
119
120
 
# File 'iam/oidc_provider_native.rb', line 118

def oidc_provider_arn()
  jsii_get_property("oidcProviderArn")
end

#oidc_provider_issuer ⇒ String

The issuer for the Native OIDC Provider.

Returns:

  • (String) 


125
126
127
 
# File 'iam/oidc_provider_native.rb', line 125

def oidc_provider_issuer()
  jsii_get_property("oidcProviderIssuer")
end

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

A reference to a OIDCProvider resource.

Returns:



132
133
134
 
# File 'iam/oidc_provider_native.rb', line 132

def oidc_provider_ref()
  jsii_get_property("oidcProviderRef")
end

#oidc_provider_thumbprints ⇒ String

The thumbprints configured for this provider.

Returns:

  • (String) 


139
140
141
 
# File 'iam/oidc_provider_native.rb', line 139

def oidc_provider_thumbprints()
  jsii_get_property("oidcProviderThumbprints")
end

#open_id_connect_provider_arn ⇒ String

Alias for oidcProviderArn to maintain backwards compatibility for constructs which accept iam.IOpenIdConnectProvider.

Use oidc_provider_arn instead. This property exists for backward compatibility with existing constructs as migrating between the 2 constructs (OpenIdConnectProvider and OidcProviderNative) is not reasonably feasible as it requires a manual step (cdk import) since the resource type is changing between OpenIdConnectProvider and OidcProviderNative.

Returns:

  • (String) 


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

def open_id_connect_provider_arn()
  jsii_get_property("openIdConnectProviderArn")
end

#open_id_connect_provider_issuer ⇒ String

Alias for oidcProviderIssuer to maintain backwards compatibility for constructs which accept `iam.IOpenIdConnectProvider.

Use oidc_provider_issuer instead. This property exists for backward compatibility with existing constructs as migrating between the 2 constructs (OpenIdConnectProvider and OidcProviderNative) is not reasonably feasible as it requires a manual step (cdk import) since the resource type is changing between OpenIdConnectProvider and OidcProviderNative.

Returns:

  • (String) 


157
158
159
 
# File 'iam/oidc_provider_native.rb', line 157

def open_id_connect_provider_issuer()
  jsii_get_property("openIdConnectProviderIssuer")
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) 


97
98
99
 
# File 'iam/oidc_provider_native.rb', line 97

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



104
105
106
 
# File 'iam/oidc_provider_native.rb', line 104

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


164
165
166
 
# File 'iam/oidc_provider_native.rb', line 164

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) 


177
178
179
180
181
182
 
# File 'iam/oidc_provider_native.rb', line 177

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