Package software.amazon.awscdk.services.appsync

Interface CfnApi.OpenIDConnectConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApi.OpenIDConnectConfigProperty.Jsii$Proxy

Enclosing class:

CfnApi

@Stability(Stable)
public static interface CfnApi.OpenIDConnectConfigProperty
extends software.amazon.jsii.JsiiSerializable

Describes an OpenID Connect (OIDC) configuration.

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()
         .issuer("issuer")
         // the properties below are optional
         .authTtl(123)
         .clientId("clientId")
         .iatTtl(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-openidconnectconfig.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnApi.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.
String	getIssuer()	The issuer for the OIDC configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIssuer

@Stability(Stable)
@NotNull
String getIssuer()

The issuer for the OIDC configuration.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-openidconnectconfig.html#cfn-appsync-api-openidconnectconfig-issuer

getAuthTtl

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-openidconnectconfig.html#cfn-appsync-api-openidconnectconfig-authttl

getClientId

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-openidconnectconfig.html#cfn-appsync-api-openidconnectconfig-clientid

getIatTtl

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-openidconnectconfig.html#cfn-appsync-api-openidconnectconfig-iatttl

builder

@Stability(Stable)
static CfnApi.OpenIDConnectConfigProperty.Builder builder()

Returns:

a CfnApi.OpenIDConnectConfigProperty.Builder of CfnApi.OpenIDConnectConfigProperty