Class: AWSCDK::AppSync::CfnAPI::OpenIDConnectConfigProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_sync/cfn_api.rb

Overview

Describes an OpenID Connect (OIDC) configuration.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(issuer:, auth_ttl: nil, client_id: nil, iat_ttl: nil) ⇒ OpenIDConnectConfigProperty

Returns a new instance of OpenIDConnectConfigProperty.

Parameters:

  • issuer (String) —

    The issuer for the OIDC configuration.

  • auth_ttl (Numeric, nil) (defaults to: nil) —

    The number of milliseconds that a token is valid after being authenticated.

  • client_id (String, nil) (defaults to: nil) —

    The client identifier of the relying party at the OpenID identity provider.

  • iat_ttl (Numeric, nil) (defaults to: nil) —

    The number of milliseconds that a token is valid after it's issued to a user.



969
970
971
972
973
974
975
976
977
978
 
# File 'app_sync/cfn_api.rb', line 969

def initialize(issuer:, auth_ttl: nil, client_id: nil, iat_ttl: nil)
  @issuer = issuer
  Jsii::Type.check_type(@issuer, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "issuer")
  @auth_ttl = auth_ttl
  Jsii::Type.check_type(@auth_ttl, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "authTtl") unless @auth_ttl.nil?
  @client_id = client_id
  Jsii::Type.check_type(@client_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientId") unless @client_id.nil?
  @iat_ttl = iat_ttl
  Jsii::Type.check_type(@iat_ttl, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "iatTtl") unless @iat_ttl.nil?
end

Instance Attribute Details

#auth_ttl ⇒ Numeric? (readonly)

The number of milliseconds that a token is valid after being authenticated.

Returns:

  • (Numeric, nil)

See Also:



991
992
993
 
# File 'app_sync/cfn_api.rb', line 991

def auth_ttl
  @auth_ttl
end

#client_id ⇒ String? (readonly)

The client identifier of the relying party at the OpenID identity provider.

This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AWS AppSync can validate against multiple client identifiers at a time.

Returns:

  • (String, nil)

See Also:



998
999
1000
 
# File 'app_sync/cfn_api.rb', line 998

def client_id
  @client_id
end

#iat_ttl ⇒ Numeric? (readonly)

The number of milliseconds that a token is valid after it's issued to a user.

Returns:

  • (Numeric, nil)

See Also:



1003
1004
1005
 
# File 'app_sync/cfn_api.rb', line 1003

def iat_ttl
  @iat_ttl
end

#issuer ⇒ String (readonly)

The issuer for the OIDC configuration.

The issuer returned by discovery must exactly match the value of iss in the ID token.

Returns:

  • (String)

See Also:



986
987
988
 
# File 'app_sync/cfn_api.rb', line 986

def issuer
  @issuer
end

Class Method Details

.jsii_properties ⇒ Object 



1005
1006
1007
1008
1009
1010
1011
1012
 
# File 'app_sync/cfn_api.rb', line 1005

def self.jsii_properties
  {
    :issuer => "issuer",
    :auth_ttl => "authTtl",
    :client_id => "clientId",
    :iat_ttl => "iatTtl",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
 
# File 'app_sync/cfn_api.rb', line 1014

def to_jsii
  result = {}
  result.merge!({
    "issuer" => @issuer,
    "authTtl" => @auth_ttl,
    "clientId" => @client_id,
    "iatTtl" => @iat_ttl,
  })
  result.compact
end