Interface IGraphqlApiAttributes

Attributes for GraphQL imports.

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IGraphqlApiAttributes

Syntax (vb)

Public Interface IGraphqlApiAttributes

Remarks

ExampleMetadata: infused

Examples

var sourceApi = new GraphqlApi(this, "FirstSourceAPI", new GraphqlApiProps {
                Name = "FirstSourceAPI",
                Definition = Definition.FromFile(Join(__dirname, "appsync.merged-api-1.graphql"))
            });

            var importedMergedApi = GraphqlApi.FromGraphqlApiAttributes(this, "ImportedMergedApi", new GraphqlApiAttributes {
                GraphqlApiId = "MyApiId",
                GraphqlApiArn = "MyApiArn"
            });

            var importedExecutionRole = Role.FromRoleArn(this, "ExecutionRole", "arn:aws:iam::ACCOUNT:role/MyExistingRole");
            new SourceApiAssociation(this, "SourceApiAssociation2", new SourceApiAssociationProps {
                SourceApi = sourceApi,
                MergedApi = importedMergedApi,
                MergeType = MergeType.MANUAL_MERGE,
                MergedApiExecutionRole = importedExecutionRole
            });

Synopsis

Properties

GraphQLEndpointArn	The GraphQl endpoint arn for the GraphQL API.
GraphqlApiArn	the arn for the GraphQL Api.
GraphqlApiId	an unique AWS AppSync GraphQL API identifier i.e. 'lxz775lwdrgcndgz3nurvac7oa'.
Modes	The Authorization Types for this GraphQL Api.
Visibility	The GraphQl API visibility.

Properties

GraphQLEndpointArn

The GraphQl endpoint arn for the GraphQL API.

string? GraphQLEndpointArn { get; }

Property Value

string

Remarks

Default: - none, required to construct event rules from imported APIs

GraphqlApiArn

the arn for the GraphQL Api.

string? GraphqlApiArn { get; }

Property Value

string

Remarks

Default: - autogenerated arn

GraphqlApiId

an unique AWS AppSync GraphQL API identifier i.e. 'lxz775lwdrgcndgz3nurvac7oa'.

string GraphqlApiId { get; }

Property Value

string

Remarks

ExampleMetadata: infused

Modes

The Authorization Types for this GraphQL Api.

AuthorizationType[]? Modes { get; }

Property Value

AuthorizationType[]

Remarks

Default: - none, required to construct event rules from imported APIs

Visibility

The GraphQl API visibility.

Visibility? Visibility { get; }

Property Value

Visibility?

Remarks

Default: - GLOBAL