Class EventApi

An AppSync Event API.

Inheritance
System.Object
Resource
ApiBase
EventApiBase
EventApi
Implements
Constructs.IConstruct
Constructs.IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class EventApi : EventApiBase, IEventApi, IApi, IResource
Syntax (vb)
Public Class EventApi
    Inherits EventApiBase
    Implements IEventApi, IApi, IResource
Remarks

Resource: AWS::AppSync::Api

ExampleMetadata: infused

Examples
using Amazon.CDK.AWS.Logs;


var apiKeyProvider = new AppSyncAuthProvider {
    AuthorizationType = AppSyncAuthorizationType.API_KEY
};

var api = new EventApi(this, "api", new EventApiProps {
    ApiName = "Api",
    OwnerContact = "OwnerContact",
    AuthorizationConfig = new EventApiAuthConfig {
        AuthProviders = new [] { apiKeyProvider },
        ConnectionAuthModeTypes = new [] { AppSyncAuthorizationType.API_KEY },
        DefaultPublishAuthModeTypes = new [] { AppSyncAuthorizationType.API_KEY },
        DefaultSubscribeAuthModeTypes = new [] { AppSyncAuthorizationType.API_KEY }
    },
    LogConfig = new AppSyncLogConfig {
        FieldLogLevel = AppSyncFieldLogLevel.INFO,
        Retention = RetentionDays.ONE_WEEK
    }
});

api.AddChannelNamespace("default");

Synopsis

Constructors

EventApi(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
EventApi(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
EventApi(Construct, String, IEventApiProps)

Properties

ApiArn

the ARN of the API.
ApiId

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

The configured API keys, if present.
AppSyncDomainName

The AppSyncDomainName of the associated custom domain.
AuthProviderTypes

The Authorization Types for this Event Api.
ConnectionModeTypes

The connection auth modes for this Event Api.
CustomHttpEndpoint

The HTTP Endpoint of the associated custom domain.
CustomRealtimeEndpoint

The Realtime Endpoint of the associated custom domain.
DefaultPublishModeTypes

The default publish auth modes for this Event Api.
DefaultSubscribeModeTypes

The default subscribe auth modes for this Event Api.
HttpDns

the domain name of the Api's HTTP endpoint.
LogGroup

the CloudWatch Log Group for this API.
RealtimeDns

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

Methods

FromEventApiAttributes(Construct, String, IEventApiAttributes)

Import a Event API through this function.

Constructors

EventApi(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected EventApi(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

EventApi(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected EventApi(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

EventApi(Construct, String, IEventApiProps)

public EventApi(Construct scope, string id, IEventApiProps props)
Parameters
scope Constructs.Construct
id System.String
props IEventApiProps

Properties

ApiArn

the ARN of the API.

public override string ApiArn { get; }
Property Value

System.String

Overrides

ApiId

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

public override string ApiId { get; }
Property Value

System.String

Overrides

ApiKeys

The configured API keys, if present.

public virtual IDictionary<string, CfnApiKey> ApiKeys { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, CfnApiKey>

Remarks

The key of this object is an apiKey name (apiKeyConfig.name) if specified, Default otherwise.

Default: - no api key

Attribute: ApiKeys

AppSyncDomainName

The AppSyncDomainName of the associated custom domain.

public virtual string AppSyncDomainName { get; }
Property Value

System.String

AuthProviderTypes

The Authorization Types for this Event Api.

public override AppSyncAuthorizationType[] AuthProviderTypes { get; }
Property Value

AppSyncAuthorizationType[]

Overrides

ConnectionModeTypes

The connection auth modes for this Event Api.

public virtual AppSyncAuthorizationType[] ConnectionModeTypes { get; }
Property Value

AppSyncAuthorizationType[]

CustomHttpEndpoint

The HTTP Endpoint of the associated custom domain.

public virtual string CustomHttpEndpoint { get; }
Property Value

System.String

CustomRealtimeEndpoint

The Realtime Endpoint of the associated custom domain.

public virtual string CustomRealtimeEndpoint { get; }
Property Value

System.String

DefaultPublishModeTypes

The default publish auth modes for this Event Api.

public virtual AppSyncAuthorizationType[] DefaultPublishModeTypes { get; }
Property Value

AppSyncAuthorizationType[]

DefaultSubscribeModeTypes

The default subscribe auth modes for this Event Api.

public virtual AppSyncAuthorizationType[] DefaultSubscribeModeTypes { get; }
Property Value

AppSyncAuthorizationType[]

HttpDns

the domain name of the Api's HTTP endpoint.

public override string HttpDns { get; }
Property Value

System.String

Overrides

LogGroup

the CloudWatch Log Group for this API.

public virtual ILogGroup LogGroup { get; }
Property Value

ILogGroup

RealtimeDns

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

public override string RealtimeDns { get; }
Property Value

System.String

Overrides

Methods

FromEventApiAttributes(Construct, String, IEventApiAttributes)

Import a Event API through this function.

public static IEventApi FromEventApiAttributes(Construct scope, string id, IEventApiAttributes attrs)
Parameters
scope Constructs.Construct

scope.

id System.String

id.

attrs IEventApiAttributes

Event API Attributes of an API.

Returns

IEventApi

Implements

Constructs.IConstruct
Constructs.IDependable