Class GraphqlApiAttributes

Attributes for GraphQL imports.

Inheritance

object

GraphqlApiAttributes

Implements

IGraphqlApiAttributes

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 GraphqlApiAttributes : IGraphqlApiAttributes

Syntax (vb)

Public Class GraphqlApiAttributes Implements 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

Constructors

GraphqlApiAttributes()

Attributes for GraphQL imports.

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.

Constructors

GraphqlApiAttributes()

Attributes for GraphQL imports.

public GraphqlApiAttributes()

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
            });

Properties

GraphQLEndpointArn

The GraphQl endpoint arn for the GraphQL API.

public string? GraphQLEndpointArn { get; set; }

Property Value

string

Remarks

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

GraphqlApiArn

the arn for the GraphQL Api.

public string? GraphqlApiArn { get; set; }

Property Value

string

Remarks

Default: - autogenerated arn

GraphqlApiId

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

public string GraphqlApiId { get; set; }

Property Value

string

Remarks

ExampleMetadata: infused

Modes

The Authorization Types for this GraphQL Api.

public AuthorizationType[]? Modes { get; set; }

Property Value

AuthorizationType[]

Remarks

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

Visibility

The GraphQl API visibility.

public Visibility? Visibility { get; set; }

Property Value

Visibility?

Remarks

Default: - GLOBAL

Implements

IGraphqlApiAttributes