Class CfnApi

The AWS::AppSync::Api resource creates an AWS AppSync API that you can use for an AWS AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnApi

Implements

IInspectable

IApiRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnApi : CfnResource, IInspectable, IApiRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnApi Inherits CfnResource Implements IInspectable, IApiRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html

CloudformationResource: AWS::AppSync::Api

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 cfnApi = new CfnApi(this, "MyCfnApi", new CfnApiProps {
                 Name = "name",

                 // the properties below are optional
                 EventConfig = new EventConfigProperty {
                     AuthProviders = new [] { new AuthProviderProperty {
                         AuthType = "authType",

                         // the properties below are optional
                         CognitoConfig = new CognitoConfigProperty {
                             AwsRegion = "awsRegion",
                             UserPoolId = "userPoolId",

                             // the properties below are optional
                             AppIdClientRegex = "appIdClientRegex"
                         },
                         LambdaAuthorizerConfig = new LambdaAuthorizerConfigProperty {
                             AuthorizerUri = "authorizerUri",

                             // the properties below are optional
                             AuthorizerResultTtlInSeconds = 123,
                             IdentityValidationExpression = "identityValidationExpression"
                         },
                         OpenIdConnectConfig = new OpenIDConnectConfigProperty {
                             Issuer = "issuer",

                             // the properties below are optional
                             AuthTtl = 123,
                             ClientId = "clientId",
                             IatTtl = 123
                         }
                     } },
                     ConnectionAuthModes = new [] { new AuthModeProperty {
                         AuthType = "authType"
                     } },
                     DefaultPublishAuthModes = new [] { new AuthModeProperty {
                         AuthType = "authType"
                     } },
                     DefaultSubscribeAuthModes = new [] { new AuthModeProperty {
                         AuthType = "authType"
                     } },

                     // the properties below are optional
                     LogConfig = new EventLogConfigProperty {
                         CloudWatchLogsRoleArn = "cloudWatchLogsRoleArn",
                         LogLevel = "logLevel"
                     }
                 },
                 OwnerContact = "ownerContact",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnApi(Construct, string, ICfnApiProps)

Create a new AWS::AppSync::Api.

Properties

ApiRef	A reference to a Api resource.
AttrApiArn	The Amazon Resource Name (ARN) of the AWS AppSync Api.
AttrApiId	The unique identifier for the AWS AppSync Api generated by the service.
AttrDns	A map of DNS names for the AppSync API.
AttrDnsHttp	The domain name of the Api's HTTP endpoint.
AttrDnsRealtime	The domain name of the Api's real-time endpoint.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	The AWS::AppSync::Api resource creates an AWS AppSync API that you can use for an AWS AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.
EventConfig	Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.
Name	The name of the Api .
OwnerContact	The owner contact information for an API resource.
Tags	A set of tags (key-value pairs) for this API.

Methods

ArnForApi(IApiRef)	The AWS::AppSync::Api resource creates an AWS AppSync API that you can use for an AWS AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnApi(object)	Checks whether the given object is a CfnApi.
RenderProperties(IDictionary<string, object>)	The AWS::AppSync::Api resource creates an AWS AppSync API that you can use for an AWS AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.

Constructors

CfnApi(Construct, string, ICfnApiProps)

Create a new AWS::AppSync::Api.

public CfnApi(Construct scope, string id, ICfnApiProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnApiProps

Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html

CloudformationResource: AWS::AppSync::Api

ExampleMetadata: fixture=_generated

Properties

ApiRef

A reference to a Api resource.

public virtual IApiReference ApiRef { get; }

Property Value

IApiReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html

CloudformationResource: AWS::AppSync::Api

ExampleMetadata: fixture=_generated

AttrApiArn

The Amazon Resource Name (ARN) of the AWS AppSync Api.

public virtual string AttrApiArn { get; }

Property Value

string

Remarks

CloudformationAttribute: ApiArn

AttrApiId

The unique identifier for the AWS AppSync Api generated by the service.

public virtual string AttrApiId { get; }

Property Value

string

Remarks

CloudformationAttribute: ApiId

AttrDns

A map of DNS names for the AppSync API.

public virtual IResolvable AttrDns { get; }

Property Value

IResolvable

Remarks

CloudformationAttribute: Dns

AttrDnsHttp

The domain name of the Api's HTTP endpoint.

public virtual string AttrDnsHttp { get; }

Property Value

string

Remarks

CloudformationAttribute: Dns.Http

AttrDnsRealtime

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

public virtual string AttrDnsRealtime { get; }

Property Value

string

Remarks

CloudformationAttribute: Dns.Realtime

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html

CloudformationResource: AWS::AppSync::Api

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html

CloudformationResource: AWS::AppSync::Api

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::AppSync::Api resource creates an AWS AppSync API that you can use for an AWS AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html

CloudformationResource: AWS::AppSync::Api

ExampleMetadata: fixture=_generated

EventConfig

Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.

public virtual object? EventConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnApi.IEventConfigProperty

Name

The name of the Api .

public virtual string Name { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html

CloudformationResource: AWS::AppSync::Api

ExampleMetadata: fixture=_generated

OwnerContact

The owner contact information for an API resource.

public virtual string? OwnerContact { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html

CloudformationResource: AWS::AppSync::Api

ExampleMetadata: fixture=_generated

Tags

A set of tags (key-value pairs) for this API.

public virtual ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html

CloudformationResource: AWS::AppSync::Api

ExampleMetadata: fixture=_generated

Methods

ArnForApi(IApiRef)

The AWS::AppSync::Api resource creates an AWS AppSync API that you can use for an AWS AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.

public static string ArnForApi(IApiRef resource)

Parameters

resource IApiRef

Returns

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html

CloudformationResource: AWS::AppSync::Api

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 cfnApi = new CfnApi(this, "MyCfnApi", new CfnApiProps {
                 Name = "name",

                 // the properties below are optional
                 EventConfig = new EventConfigProperty {
                     AuthProviders = new [] { new AuthProviderProperty {
                         AuthType = "authType",

                         // the properties below are optional
                         CognitoConfig = new CognitoConfigProperty {
                             AwsRegion = "awsRegion",
                             UserPoolId = "userPoolId",

                             // the properties below are optional
                             AppIdClientRegex = "appIdClientRegex"
                         },
                         LambdaAuthorizerConfig = new LambdaAuthorizerConfigProperty {
                             AuthorizerUri = "authorizerUri",

                             // the properties below are optional
                             AuthorizerResultTtlInSeconds = 123,
                             IdentityValidationExpression = "identityValidationExpression"
                         },
                         OpenIdConnectConfig = new OpenIDConnectConfigProperty {
                             Issuer = "issuer",

                             // the properties below are optional
                             AuthTtl = 123,
                             ClientId = "clientId",
                             IatTtl = 123
                         }
                     } },
                     ConnectionAuthModes = new [] { new AuthModeProperty {
                         AuthType = "authType"
                     } },
                     DefaultPublishAuthModes = new [] { new AuthModeProperty {
                         AuthType = "authType"
                     } },
                     DefaultSubscribeAuthModes = new [] { new AuthModeProperty {
                         AuthType = "authType"
                     } },

                     // the properties below are optional
                     LogConfig = new EventLogConfigProperty {
                         CloudWatchLogsRoleArn = "cloudWatchLogsRoleArn",
                         LogLevel = "logLevel"
                     }
                 },
                 OwnerContact = "ownerContact",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html

CloudformationResource: AWS::AppSync::Api

ExampleMetadata: fixture=_generated

IsCfnApi(object)

Checks whether the given object is a CfnApi.

public static bool IsCfnApi(object x)

Parameters

x object

Returns

bool

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html

CloudformationResource: AWS::AppSync::Api

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::AppSync::Api resource creates an AWS AppSync API that you can use for an AWS AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html

CloudformationResource: AWS::AppSync::Api

ExampleMetadata: fixture=_generated

Implements

IInspectable

IApiRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2