Class: AWSCDK::EKSv2::OpenIdConnectProviderProps

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

Overview

Initialization properties for OpenIdConnectProvider.

Direct Known Subclasses

OidcProviderNativeProps

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of OpenIdConnectProviderProps.

Parameters:

  • url (String) —

    The URL of the identity provider.

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

    The removal policy to apply to the OpenID Connect Provider.



9
10
11
12
13
14
 
# File 'ek_sv2/open_id_connect_provider_props.rb', line 9

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

Instance Attribute Details

#removal_policy ⇒ AWSCDK::RemovalPolicy? (readonly)

Note:

Default: - RemovalPolicy.DESTROY

The removal policy to apply to the OpenID Connect Provider.

Returns:



33
34
35
 
# File 'ek_sv2/open_id_connect_provider_props.rb', line 33

def removal_policy
  @removal_policy
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 can find your OIDC Issuer URL by: aws eks describe-cluster --name %cluster_name% --query "cluster.identity.oidc.issuer" --output text

Returns:

  • (String) 


28
29
30
 
# File 'ek_sv2/open_id_connect_provider_props.rb', line 28

def url
  @url
end

Class Method Details

.jsii_properties ⇒ Object 



35
36
37
38
39
40
 
# File 'ek_sv2/open_id_connect_provider_props.rb', line 35

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

Instance Method Details

#to_jsii ⇒ Object 



42
43
44
45
46
47
48
49
 
# File 'ek_sv2/open_id_connect_provider_props.rb', line 42

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