Show / Hide Table of Contents

Class CfnApi.OpenIDConnectConfigProperty

Describes an OpenID Connect (OIDC) configuration.

Inheritance
object
CfnApi.OpenIDConnectConfigProperty
Implements
CfnApi.IOpenIDConnectConfigProperty
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnApi.OpenIDConnectConfigProperty : CfnApi.IOpenIDConnectConfigProperty
Syntax (vb)
Public Class CfnApi.OpenIDConnectConfigProperty Implements CfnApi.IOpenIDConnectConfigProperty
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// 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 {
                 Issuer = "issuer",

                 // the properties below are optional
                 AuthTtl = 123,
                 ClientId = "clientId",
                 IatTtl = 123
             };

Synopsis

Constructors

OpenIDConnectConfigProperty()

Describes an OpenID Connect (OIDC) configuration.

Properties

AuthTtl

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

ClientId

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

IatTtl

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

Issuer

The issuer for the OIDC configuration.

Constructors

OpenIDConnectConfigProperty()

Describes an OpenID Connect (OIDC) configuration.

public OpenIDConnectConfigProperty()
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// 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 {
                 Issuer = "issuer",

                 // the properties below are optional
                 AuthTtl = 123,
                 ClientId = "clientId",
                 IatTtl = 123
             };

Properties

AuthTtl

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

public double? AuthTtl { get; set; }
Property Value

double?

Remarks

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

ClientId

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

public string? ClientId { get; set; }
Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-openidconnectconfig.html#cfn-appsync-api-openidconnectconfig-clientid

IatTtl

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

public double? IatTtl { get; set; }
Property Value

double?

Remarks

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

Issuer

The issuer for the OIDC configuration.

public string Issuer { get; set; }
Property Value

string

Remarks

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

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

Implements

CfnApi.IOpenIDConnectConfigProperty
Back to top Generated by DocFX