Class EventApiAttributes

Attributes for Event API imports.

Inheritance

object

EventApiAttributes

Implements

IEventApiAttributes

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 EventApiAttributes : IEventApiAttributes

Syntax (vb)

Public Class EventApiAttributes Implements IEventApiAttributes

Remarks

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 eventApiAttributes = new EventApiAttributes {
                ApiId = "apiId",
                HttpDns = "httpDns",
                RealtimeDns = "realtimeDns",

                // the properties below are optional
                ApiArn = "apiArn",
                ApiName = "apiName",
                AuthProviderTypes = new [] { AppSyncAuthorizationType.API_KEY }
            };

Synopsis

Constructors

EventApiAttributes()

Attributes for Event API imports.

Properties

ApiArn	the ARN of the Event API.
ApiId	an unique AWS AppSync Event API identifier i.e. 'lxz775lwdrgcndgz3nurvac7oa'.
ApiName	the name of the Event API.
AuthProviderTypes	The Authorization Types for this Event Api.
HttpDns	the domain name of the Api's HTTP endpoint.
RealtimeDns	the domain name of the Api's real-time endpoint.

Constructors

EventApiAttributes()

Attributes for Event API imports.

public EventApiAttributes()

Remarks

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 eventApiAttributes = new EventApiAttributes {
                ApiId = "apiId",
                HttpDns = "httpDns",
                RealtimeDns = "realtimeDns",

                // the properties below are optional
                ApiArn = "apiArn",
                ApiName = "apiName",
                AuthProviderTypes = new [] { AppSyncAuthorizationType.API_KEY }
            };

Properties

ApiArn

the ARN of the Event API.

public string? ApiArn { get; set; }

Property Value

string

Remarks

Default: - constructed arn

ApiId

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

public string ApiId { get; set; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

ApiName

the name of the Event API.

public string? ApiName { get; set; }

Property Value

string

Remarks

Default: - not needed to import API

AuthProviderTypes

The Authorization Types for this Event Api.

public AppSyncAuthorizationType[]? AuthProviderTypes { get; set; }

Property Value

AppSyncAuthorizationType[]

Remarks

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

HttpDns

the domain name of the Api's HTTP endpoint.

public string HttpDns { get; set; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

RealtimeDns

the domain name of the Api's real-time endpoint.

public string RealtimeDns { get; set; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

Implements

IEventApiAttributes