software.amazon.awscdk.services.appsync

Interface CfnGraphQLApi.OpenIDConnectConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGraphQLApi.OpenIDConnectConfigProperty.Jsii$Proxy

Enclosing class:

CfnGraphQLApi

@Stability(value=Stable)
public static interface CfnGraphQLApi.OpenIDConnectConfigProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appsync.*;
 OpenIDConnectConfigProperty openIDConnectConfigProperty = OpenIDConnectConfigProperty.builder()
         .authTtl(123)
         .clientId("clientId")
         .iatTtl(123)
         .issuer("issuer")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnGraphQLApi.OpenIDConnectConfigProperty.Builder A builder for CfnGraphQLApi.OpenIDConnectConfigProperty
static class	CfnGraphQLApi.OpenIDConnectConfigProperty.Jsii$Proxy An implementation for CfnGraphQLApi.OpenIDConnectConfigProperty

Method Summary

Modifier and Type	Method and Description
static CfnGraphQLApi.OpenIDConnectConfigProperty.Builder	builder()
default Number	getAuthTtl() The number of milliseconds that a token is valid after being authenticated.
default String	getClientId() The client identifier of the Relying party at the OpenID identity provider.
default Number	getIatTtl() The number of milliseconds that a token is valid after it's issued to a user.
default String	getIssuer() The issuer for the OIDC configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAuthTtl

@Stability(value=Stable)
 @Nullable
default Number getAuthTtl()

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

getClientId

@Stability(value=Stable)
 @Nullable
default String getClientId()

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.

getIatTtl

@Stability(value=Stable)
 @Nullable
default Number getIatTtl()

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

getIssuer

@Stability(value=Stable)
 @Nullable
default String getIssuer()

The issuer for the OIDC configuration.

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

builder

@Stability(value=Stable)
static CfnGraphQLApi.OpenIDConnectConfigProperty.Builder builder()

Returns:

a CfnGraphQLApi.OpenIDConnectConfigProperty.Builder of CfnGraphQLApi.OpenIDConnectConfigProperty