Skip to content
v2.278.0

OpenIDConnectConfigProperty Struct ​

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 ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';
const openIDConnectConfigProperty: appsync.CfnGraphQLApi.OpenIDConnectConfigProperty = {
  authTtl: 123,
  clientId: 'clientId',
  iatTtl: 123,
  issuer: 'issuer',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appsync as appsync

open_id_connect_config_property = appsync.CfnGraphQLApi.OpenIDConnectConfigProperty(
    auth_ttl=123,
    client_id="clientId",
    iat_ttl=123,
    issuer="issuer"
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppSync;

var openIDConnectConfigProperty = new OpenIDConnectConfigProperty {
    AuthTtl = 123,
    ClientId = "clientId",
    IatTtl = 123,
    Issuer = "issuer"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

openIDConnectConfigProperty := &OpenIDConnectConfigProperty{
	AuthTtl: jsii.Number(123),
	ClientId: jsii.String("clientId"),
	IatTtl: jsii.Number(123),
	Issuer: jsii.String("issuer"),
}

Properties ​

authTtloptionalnumberauth_ttloptionalint | floatauthTtloptionalNumberAuthTtloptionaldoubleAuthTtloptional*float64 #
The number of milliseconds that a token is valid after being authenticated.
clientIdoptionalstringclient_idoptionalstrclientIdoptionalStringClientIdoptionalstringClientIdoptional*string #
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.

iatTtloptionalnumberiat_ttloptionalint | floatiatTtloptionalNumberIatTtloptionaldoubleIatTtloptional*float64 #
The number of milliseconds that a token is valid after it's issued to a user.
issueroptionalstringissueroptionalstrissueroptionalStringIssueroptionalstringIssueroptional*string #
The issuer for the OIDC configuration.

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