Class: AWSCDK::IAM::OpenIdConnectProviderProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
iam/open_id_connect_provider_props.rb

Overview

Initialization properties for OpenIdConnectProvider.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(url:, client_ids: nil, removal_policy: nil, thumbprints: nil) ⇒ OpenIdConnectProviderProps

Returns a new instance of OpenIdConnectProviderProps.

Parameters:

  • url (String) —

    The URL of the identity provider.

  • client_ids (Array<String>, nil) (defaults to: nil) —

    A list of client IDs (also known as audiences).

  • removal_policy (AWSCDK::RemovalPolicy, nil) (defaults to: nil) —

    The removal policy to apply to the OpenID Connect Provider.

  • thumbprints (Array<String>, nil) (defaults to: nil) —

    A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates.



11
12
13
14
15
16
17
18
19
20
 
# File 'iam/open_id_connect_provider_props.rb', line 11

def initialize(url:, client_ids: nil, removal_policy: nil, thumbprints: nil)
  @url = url
  Jsii::Type.check_type(@url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "url")
  @client_ids = client_ids
  Jsii::Type.check_type(@client_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "clientIds") unless @client_ids.nil?
  @removal_policy = removal_policy
  Jsii::Type.check_type(@removal_policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "removalPolicy") unless @removal_policy.nil?
  @thumbprints = thumbprints
  Jsii::Type.check_type(@thumbprints, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "thumbprints") unless @thumbprints.nil?
end

Instance Attribute Details

#client_ids ⇒ Array<String>? (readonly)

Note:

Default: - no clients are allowed

A list of client IDs (also known as audiences).

When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. (This is the value that's sent as the client_id parameter on OAuth requests.)

You can register multiple client IDs with the same provider. For example, you might have multiple applications that use the same OIDC provider. You cannot register more than 100 client IDs with a single IAM OIDC provider.

Client IDs are up to 255 characters long.

Returns:

  • (Array<String>, nil) 


51
52
53
 
# File 'iam/open_id_connect_provider_props.rb', line 51

def client_ids
  @client_ids
end

#removal_policy ⇒ AWSCDK::RemovalPolicy? (readonly)

Note:

Default: - RemovalPolicy.DESTROY

The removal policy to apply to the OpenID Connect Provider.

Returns:



56
57
58
 
# File 'iam/open_id_connect_provider_props.rb', line 56

def removal_policy
  @removal_policy
end

#thumbprints ⇒ Array<String>? (readonly)

Note:

Default: - If no thumbprints are specified (an empty array or undefined), the thumbprint of the root certificate authority will be obtained from the provider's server as described in https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc_verify-thumbprint.html

A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates.

Typically this list includes only one entry. However, IAM lets you have up to five thumbprints for an OIDC provider. This lets you maintain multiple thumbprints if the identity provider is rotating certificates.

The server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string.

You must provide at least one thumbprint when creating an IAM OIDC provider. For example, assume that the OIDC provider is server.example.com and the provider stores its keys at https://keys.server.example.com/openid-connect. In that case, the thumbprint string would be the hex-encoded SHA-1 hash value of the certificate used by https://keys.server.example.com.

Returns:

  • (Array<String>, nil) 


76
77
78
 
# File 'iam/open_id_connect_provider_props.rb', line 76

def thumbprints
  @thumbprints
end

#url ⇒ String (readonly)

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 cannot register the same provider multiple times in a single AWS account. If you try to submit a URL that has already been used for an OpenID Connect provider in the AWS account, you will get an error.

Returns:

  • (String) 


35
36
37
 
# File 'iam/open_id_connect_provider_props.rb', line 35

def url
  @url
end

Class Method Details

.jsii_properties ⇒ Object 



78
79
80
81
82
83
84
85
 
# File 'iam/open_id_connect_provider_props.rb', line 78

def self.jsii_properties
  {
    :url => "url",
    :client_ids => "clientIds",
    :removal_policy => "removalPolicy",
    :thumbprints => "thumbprints",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



87
88
89
90
91
92
93
94
95
96
 
# File 'iam/open_id_connect_provider_props.rb', line 87

def to_jsii
  result = {}
  result.merge!({
    "url" => @url,
    "clientIds" => @client_ids,
    "removalPolicy" => @removal_policy,
    "thumbprints" => @thumbprints,
  })
  result.compact
end