Class: AWSCDK::AppSync::CfnGraphQLAPI::OpenIDConnectConfigProperty

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

Overview

The OpenIDConnectConfig property type specifies the optional authorization configuration for using an OpenID Connect compliant service with your GraphQL endpoint for an AWS AppSync GraphQL API.

OpenIDConnectConfig is a property of the AWS::AppSync::GraphQLApi property type.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of OpenIDConnectConfigProperty.

Parameters:

  • 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.

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

    The issuer for the OIDC configuration.



1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
 
# File 'app_sync/cfn_graph_qlapi.rb', line 1131

def initialize(auth_ttl: nil, client_id: nil, iat_ttl: nil, issuer: nil)
  @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?
  @issuer = issuer
  Jsii::Type.check_type(@issuer, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "issuer") unless @issuer.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:



1146
1147
1148
 
# File 'app_sync/cfn_graph_qlapi.rb', line 1146

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:



1153
1154
1155
 
# File 'app_sync/cfn_graph_qlapi.rb', line 1153

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:



1158
1159
1160
 
# File 'app_sync/cfn_graph_qlapi.rb', line 1158

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, nil)

See Also:



1165
1166
1167
 
# File 'app_sync/cfn_graph_qlapi.rb', line 1165

def issuer
  @issuer
end

Class Method Details

.jsii_properties ⇒ Object 



1167
1168
1169
1170
1171
1172
1173
1174
 
# File 'app_sync/cfn_graph_qlapi.rb', line 1167

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

Instance Method Details

#to_jsii ⇒ Object 



1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
 
# File 'app_sync/cfn_graph_qlapi.rb', line 1176

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