Interface ICfnGraphQLApiProps

Properties for defining a CfnGraphQLApi.

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.AWS.AppSync.dll

Syntax (csharp)

public interface ICfnGraphQLApiProps

Syntax (vb)

Public Interface ICfnGraphQLApiProps

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.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;

CfnGraphQLApiProps cfnGraphQLApiProps = new CfnGraphQLApiProps {
    AuthenticationType = "authenticationType",
    Name = "name",

    // the properties below are optional
    AdditionalAuthenticationProviders = new [] { new AdditionalAuthenticationProviderProperty {
        AuthenticationType = "authenticationType",

        // the properties below are optional
        LambdaAuthorizerConfig = new LambdaAuthorizerConfigProperty {
            AuthorizerResultTtlInSeconds = 123,
            AuthorizerUri = "authorizerUri",
            IdentityValidationExpression = "identityValidationExpression"
        },
        OpenIdConnectConfig = new OpenIDConnectConfigProperty {
            AuthTtl = 123,
            ClientId = "clientId",
            IatTtl = 123,
            Issuer = "issuer"
        },
        UserPoolConfig = new CognitoUserPoolConfigProperty {
            AppIdClientRegex = "appIdClientRegex",
            AwsRegion = "awsRegion",
            UserPoolId = "userPoolId"
        }
    } },
    LambdaAuthorizerConfig = new LambdaAuthorizerConfigProperty {
        AuthorizerResultTtlInSeconds = 123,
        AuthorizerUri = "authorizerUri",
        IdentityValidationExpression = "identityValidationExpression"
    },
    LogConfig = new LogConfigProperty {
        CloudWatchLogsRoleArn = "cloudWatchLogsRoleArn",
        ExcludeVerboseContent = false,
        FieldLogLevel = "fieldLogLevel"
    },
    OpenIdConnectConfig = new OpenIDConnectConfigProperty {
        AuthTtl = 123,
        ClientId = "clientId",
        IatTtl = 123,
        Issuer = "issuer"
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    UserPoolConfig = new UserPoolConfigProperty {
        AppIdClientRegex = "appIdClientRegex",
        AwsRegion = "awsRegion",
        DefaultAction = "defaultAction",
        UserPoolId = "userPoolId"
    },
    XrayEnabled = false
};

Synopsis

Properties

AdditionalAuthenticationProviders	A list of additional authentication providers for the `GraphqlApi` API.
AuthenticationType	Security configuration for your GraphQL API.
LambdaAuthorizerConfig	A `LambdaAuthorizerConfig` holds configuration on how to authorize AWS AppSync API access when using the `AWS_LAMBDA` authorizer mode.
LogConfig	The Amazon CloudWatch Logs configuration.
Name	The API name.
OpenIdConnectConfig	The OpenID Connect configuration.
Tags	An arbitrary set of tags (key-value pairs) for this GraphQL API.
UserPoolConfig	Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
XrayEnabled	A flag indicating whether to use AWS X-Ray tracing for this `GraphqlApi` .

Properties

AdditionalAuthenticationProviders

A list of additional authentication providers for the GraphqlApi API.

virtual object AdditionalAuthenticationProviders { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-additionalauthenticationproviders

AuthenticationType

Security configuration for your GraphQL API.

string AuthenticationType { get; }

Property Value

System.String

Remarks

For allowed values (such as API_KEY , AWS_IAM , AMAZON_COGNITO_USER_POOLS , OPENID_CONNECT , or AWS_LAMBDA ), see Security in the AWS AppSync Developer Guide .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-authenticationtype

LambdaAuthorizerConfig

A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.

virtual object LambdaAuthorizerConfig { get; }

Property Value

System.Object

Remarks

Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-lambdaauthorizerconfig

LogConfig

The Amazon CloudWatch Logs configuration.

virtual object LogConfig { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-logconfig

Name

The API name.

string Name { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-name

OpenIdConnectConfig

The OpenID Connect configuration.

virtual object OpenIdConnectConfig { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-openidconnectconfig

UserPoolConfig

Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.

virtual object UserPoolConfig { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-userpoolconfig

XrayEnabled

A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi .

virtual object XrayEnabled { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-xrayenabled