Class CfnGraphQLApiProps

Properties for defining a CfnGraphQLApi.

Inheritance

System.Object

CfnGraphQLApiProps

Implements

ICfnGraphQLApiProps

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.AWS.AppSync.dll

Syntax (csharp)

public class CfnGraphQLApiProps : Object, ICfnGraphQLApiProps

Syntax (vb)

Public Class CfnGraphQLApiProps
    Inherits Object
    Implements 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;

var 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"
        }
    } },
    ApiType = "apiType",
    LambdaAuthorizerConfig = new LambdaAuthorizerConfigProperty {
        AuthorizerResultTtlInSeconds = 123,
        AuthorizerUri = "authorizerUri",
        IdentityValidationExpression = "identityValidationExpression"
    },
    LogConfig = new LogConfigProperty {
        CloudWatchLogsRoleArn = "cloudWatchLogsRoleArn",
        ExcludeVerboseContent = false,
        FieldLogLevel = "fieldLogLevel"
    },
    MergedApiExecutionRoleArn = "mergedApiExecutionRoleArn",
    OpenIdConnectConfig = new OpenIDConnectConfigProperty {
        AuthTtl = 123,
        ClientId = "clientId",
        IatTtl = 123,
        Issuer = "issuer"
    },
    OwnerContact = "ownerContact",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    UserPoolConfig = new UserPoolConfigProperty {
        AppIdClientRegex = "appIdClientRegex",
        AwsRegion = "awsRegion",
        DefaultAction = "defaultAction",
        UserPoolId = "userPoolId"
    },
    Visibility = "visibility",
    XrayEnabled = false
};

Synopsis

Constructors

CfnGraphQLApiProps()

Properties

AdditionalAuthenticationProviders	A list of additional authentication providers for the GraphqlApi API.
ApiType	The value that indicates whether the GraphQL API is a standard API ( GRAPHQL ) or merged API ( MERGED ).
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.
MergedApiExecutionRoleArn	The AWS Identity and Access Management service role ARN for a merged API.
Name	The API name.
OpenIdConnectConfig	The OpenID Connect configuration.
OwnerContact	The owner contact information for an API resource.
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.
Visibility	Sets the scope of the GraphQL API to public ( GLOBAL ) or private ( PRIVATE ).
XrayEnabled	A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi .

Constructors

CfnGraphQLApiProps()

public CfnGraphQLApiProps()

Properties

AdditionalAuthenticationProviders

A list of additional authentication providers for the GraphqlApi API.

public object AdditionalAuthenticationProviders { get; set; }

Property Value

System.Object

Remarks

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

ApiType

The value that indicates whether the GraphQL API is a standard API ( GRAPHQL ) or merged API ( MERGED ).

public string ApiType { get; set; }

Property Value

System.String

Remarks

The following values are valid:

GRAPHQL | MERGED

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

AuthenticationType

Security configuration for your GraphQL API.

public string AuthenticationType { get; set; }

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.

public object LambdaAuthorizerConfig { get; set; }

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.

public object LogConfig { get; set; }

Property Value

System.Object

Remarks

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

MergedApiExecutionRoleArn

The AWS Identity and Access Management service role ARN for a merged API.

public string MergedApiExecutionRoleArn { get; set; }

Property Value

System.String

Remarks

The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.

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

Name

The API name.

public string Name { get; set; }

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.

public object OpenIdConnectConfig { get; set; }

Property Value

System.Object

Remarks

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

OwnerContact

The owner contact information for an API resource.

public string OwnerContact { get; set; }

Property Value

System.String

Remarks

This field accepts any string input with a length of 0 - 256 characters.

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

Tags

An arbitrary set of tags (key-value pairs) for this GraphQL API.

public ICfnTag[] Tags { get; set; }

Property Value

ICfnTag[]

Remarks

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

UserPoolConfig

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

public object UserPoolConfig { get; set; }

Property Value

System.Object

Remarks

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

Visibility

Sets the scope of the GraphQL API to public ( GLOBAL ) or private ( PRIVATE ).

public string Visibility { get; set; }

Property Value

System.String

Remarks

By default, the scope is set to Global if no value is provided.

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

XrayEnabled

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

public object XrayEnabled { get; set; }

Property Value

System.Object

Remarks

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

Implements

ICfnGraphQLApiProps