Class CfnDataSource

The AWS::AppSync::DataSource resource creates data sources for resolvers in AWS AppSync to connect to, such as Amazon DynamoDB , AWS Lambda , and Amazon OpenSearch Service .

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnDataSource

Implements

IInspectable

IDataSourceRef

IConstruct

IDependable

IEnvironmentAware

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 CfnDataSource : CfnResource, IInspectable, IDataSourceRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnDataSource Inherits CfnResource Implements IInspectable, IDataSourceRef, IConstruct, IDependable, IEnvironmentAware

Remarks

Resolvers use these data sources to fetch data when clients make GraphQL calls.

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

CloudformationResource: AWS::AppSync::DataSource

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 cfnDataSource = new CfnDataSource(this, "MyCfnDataSource", new CfnDataSourceProps {
                 ApiId = "apiId",
                 Name = "name",
                 Type = "type",

                 // the properties below are optional
                 Description = "description",
                 DynamoDbConfig = new DynamoDBConfigProperty {
                     AwsRegion = "awsRegion",
                     TableName = "tableName",

                     // the properties below are optional
                     DeltaSyncConfig = new DeltaSyncConfigProperty {
                         BaseTableTtl = "baseTableTtl",
                         DeltaSyncTableName = "deltaSyncTableName",
                         DeltaSyncTableTtl = "deltaSyncTableTtl"
                     },
                     UseCallerCredentials = false,
                     Versioned = false
                 },
                 ElasticsearchConfig = new ElasticsearchConfigProperty {
                     AwsRegion = "awsRegion",
                     Endpoint = "endpoint"
                 },
                 EventBridgeConfig = new EventBridgeConfigProperty {
                     EventBusArn = "eventBusArn"
                 },
                 HttpConfig = new HttpConfigProperty {
                     Endpoint = "endpoint",

                     // the properties below are optional
                     AuthorizationConfig = new AuthorizationConfigProperty {
                         AuthorizationType = "authorizationType",

                         // the properties below are optional
                         AwsIamConfig = new AwsIamConfigProperty {
                             SigningRegion = "signingRegion",
                             SigningServiceName = "signingServiceName"
                         }
                     }
                 },
                 LambdaConfig = new LambdaConfigProperty {
                     LambdaFunctionArn = "lambdaFunctionArn"
                 },
                 MetricsConfig = "metricsConfig",
                 OpenSearchServiceConfig = new OpenSearchServiceConfigProperty {
                     AwsRegion = "awsRegion",
                     Endpoint = "endpoint"
                 },
                 RelationalDatabaseConfig = new RelationalDatabaseConfigProperty {
                     RelationalDatabaseSourceType = "relationalDatabaseSourceType",

                     // the properties below are optional
                     RdsHttpEndpointConfig = new RdsHttpEndpointConfigProperty {
                         AwsRegion = "awsRegion",
                         AwsSecretStoreArn = "awsSecretStoreArn",
                         DbClusterIdentifier = "dbClusterIdentifier",

                         // the properties below are optional
                         DatabaseName = "databaseName",
                         Schema = "schema"
                     }
                 },
                 ServiceRoleArn = "serviceRoleArn"
             });

Synopsis

Constructors

CfnDataSource(Construct, string, ICfnDataSourceProps)

Create a new AWS::AppSync::DataSource.

Properties

ApiId	Unique AWS AppSync GraphQL API identifier where this data source will be created.
AttrDataSourceArn	The Amazon Resource Name (ARN) of the API key, such as arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/datasources/datasourcename .
AttrName	Friendly name for you to identify your AWS AppSync data source after creation.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::AppSync::DataSource resource creates data sources for resolvers in AWS AppSync to connect to, such as Amazon DynamoDB , AWS Lambda , and Amazon OpenSearch Service .
DataSourceRef	A reference to a DataSource resource.
Description	The description of the data source.
DynamoDbConfig	AWS Region and TableName for an Amazon DynamoDB table in your account.
ElasticsearchConfig	The AWS::AppSync::DataSource resource creates data sources for resolvers in AWS AppSync to connect to, such as Amazon DynamoDB , AWS Lambda , and Amazon OpenSearch Service .
EventBridgeConfig	An EventBridge configuration that contains a valid ARN of an event bus.
HttpConfig	Endpoints for an HTTP data source.
LambdaConfig	An ARN of a Lambda function in valid ARN format.
MetricsConfig	Enables or disables enhanced data source metrics for specified data sources.
Name	Friendly name for you to identify your AppSync data source after creation.
OpenSearchServiceConfig	AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.
RelationalDatabaseConfig	Relational Database configuration of the relational database data source.
ServiceRoleArn	The AWS Identity and Access Management service role ARN for the data source.
Type	The type of the data source.

Methods

ArnForDataSource(IDataSourceRef)	The AWS::AppSync::DataSource resource creates data sources for resolvers in AWS AppSync to connect to, such as Amazon DynamoDB , AWS Lambda , and Amazon OpenSearch Service .
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnDataSource(object)	Checks whether the given object is a CfnDataSource.
RenderProperties(IDictionary<string, object>)	The AWS::AppSync::DataSource resource creates data sources for resolvers in AWS AppSync to connect to, such as Amazon DynamoDB , AWS Lambda , and Amazon OpenSearch Service .

Constructors

CfnDataSource(Construct, string, ICfnDataSourceProps)

Create a new AWS::AppSync::DataSource.

public CfnDataSource(Construct scope, string id, ICfnDataSourceProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

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

props ICfnDataSourceProps

Resource properties.

Remarks

Resolvers use these data sources to fetch data when clients make GraphQL calls.

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

CloudformationResource: AWS::AppSync::DataSource

ExampleMetadata: fixture=_generated

Properties

ApiId

Unique AWS AppSync GraphQL API identifier where this data source will be created.

public virtual string ApiId { get; set; }

Property Value

string

Remarks

Resolvers use these data sources to fetch data when clients make GraphQL calls.

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

CloudformationResource: AWS::AppSync::DataSource

ExampleMetadata: fixture=_generated

AttrDataSourceArn

The Amazon Resource Name (ARN) of the API key, such as arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/datasources/datasourcename .

public virtual string AttrDataSourceArn { get; }

Property Value

string

Remarks

CloudformationAttribute: DataSourceArn

AttrName

Friendly name for you to identify your AWS AppSync data source after creation.

public virtual string AttrName { get; }

Property Value

string

Remarks

CloudformationAttribute: Name

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

Resolvers use these data sources to fetch data when clients make GraphQL calls.

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

CloudformationResource: AWS::AppSync::DataSource

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::AppSync::DataSource resource creates data sources for resolvers in AWS AppSync to connect to, such as Amazon DynamoDB , AWS Lambda , and Amazon OpenSearch Service .

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

Resolvers use these data sources to fetch data when clients make GraphQL calls.

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

CloudformationResource: AWS::AppSync::DataSource

ExampleMetadata: fixture=_generated

DataSourceRef

A reference to a DataSource resource.

public virtual IDataSourceReference DataSourceRef { get; }

Property Value

IDataSourceReference

Remarks

Resolvers use these data sources to fetch data when clients make GraphQL calls.

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

CloudformationResource: AWS::AppSync::DataSource

ExampleMetadata: fixture=_generated

Description

The description of the data source.

public virtual string? Description { get; set; }

Property Value

string

Remarks

Resolvers use these data sources to fetch data when clients make GraphQL calls.

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

CloudformationResource: AWS::AppSync::DataSource

ExampleMetadata: fixture=_generated

DynamoDbConfig

AWS Region and TableName for an Amazon DynamoDB table in your account.

public virtual object? DynamoDbConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDataSource.IDynamoDBConfigProperty

ElasticsearchConfig

The AWS::AppSync::DataSource resource creates data sources for resolvers in AWS AppSync to connect to, such as Amazon DynamoDB , AWS Lambda , and Amazon OpenSearch Service .

[Obsolete("this property has been deprecated")]
public virtual object? ElasticsearchConfig { get; set; }

Property Value

object

Remarks

Stability: Deprecated

Type union: either IResolvable or CfnDataSource.IElasticsearchConfigProperty

EventBridgeConfig

An EventBridge configuration that contains a valid ARN of an event bus.

public virtual object? EventBridgeConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDataSource.IEventBridgeConfigProperty

HttpConfig

Endpoints for an HTTP data source.

public virtual object? HttpConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDataSource.IHttpConfigProperty

LambdaConfig

An ARN of a Lambda function in valid ARN format.

public virtual object? LambdaConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDataSource.ILambdaConfigProperty

MetricsConfig

Enables or disables enhanced data source metrics for specified data sources.

public virtual string? MetricsConfig { get; set; }

Property Value

string

Remarks

Resolvers use these data sources to fetch data when clients make GraphQL calls.

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

CloudformationResource: AWS::AppSync::DataSource

ExampleMetadata: fixture=_generated

Name

Friendly name for you to identify your AppSync data source after creation.

public virtual string Name { get; set; }

Property Value

string

Remarks

Resolvers use these data sources to fetch data when clients make GraphQL calls.

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

CloudformationResource: AWS::AppSync::DataSource

ExampleMetadata: fixture=_generated

OpenSearchServiceConfig

AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.

public virtual object? OpenSearchServiceConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDataSource.IOpenSearchServiceConfigProperty

RelationalDatabaseConfig

Relational Database configuration of the relational database data source.

public virtual object? RelationalDatabaseConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDataSource.IRelationalDatabaseConfigProperty

ServiceRoleArn

The AWS Identity and Access Management service role ARN for the data source.

public virtual string? ServiceRoleArn { get; set; }

Property Value

string

Remarks

Resolvers use these data sources to fetch data when clients make GraphQL calls.

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

CloudformationResource: AWS::AppSync::DataSource

ExampleMetadata: fixture=_generated

Type

The type of the data source.

public virtual string Type { get; set; }

Property Value

string

Remarks

Resolvers use these data sources to fetch data when clients make GraphQL calls.

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

CloudformationResource: AWS::AppSync::DataSource

ExampleMetadata: fixture=_generated

Methods

ArnForDataSource(IDataSourceRef)

The AWS::AppSync::DataSource resource creates data sources for resolvers in AWS AppSync to connect to, such as Amazon DynamoDB , AWS Lambda , and Amazon OpenSearch Service .

public static string ArnForDataSource(IDataSourceRef resource)

Parameters

resource IDataSourceRef

Returns

string

Remarks

Resolvers use these data sources to fetch data when clients make GraphQL calls.

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

CloudformationResource: AWS::AppSync::DataSource

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 cfnDataSource = new CfnDataSource(this, "MyCfnDataSource", new CfnDataSourceProps {
                 ApiId = "apiId",
                 Name = "name",
                 Type = "type",

                 // the properties below are optional
                 Description = "description",
                 DynamoDbConfig = new DynamoDBConfigProperty {
                     AwsRegion = "awsRegion",
                     TableName = "tableName",

                     // the properties below are optional
                     DeltaSyncConfig = new DeltaSyncConfigProperty {
                         BaseTableTtl = "baseTableTtl",
                         DeltaSyncTableName = "deltaSyncTableName",
                         DeltaSyncTableTtl = "deltaSyncTableTtl"
                     },
                     UseCallerCredentials = false,
                     Versioned = false
                 },
                 ElasticsearchConfig = new ElasticsearchConfigProperty {
                     AwsRegion = "awsRegion",
                     Endpoint = "endpoint"
                 },
                 EventBridgeConfig = new EventBridgeConfigProperty {
                     EventBusArn = "eventBusArn"
                 },
                 HttpConfig = new HttpConfigProperty {
                     Endpoint = "endpoint",

                     // the properties below are optional
                     AuthorizationConfig = new AuthorizationConfigProperty {
                         AuthorizationType = "authorizationType",

                         // the properties below are optional
                         AwsIamConfig = new AwsIamConfigProperty {
                             SigningRegion = "signingRegion",
                             SigningServiceName = "signingServiceName"
                         }
                     }
                 },
                 LambdaConfig = new LambdaConfigProperty {
                     LambdaFunctionArn = "lambdaFunctionArn"
                 },
                 MetricsConfig = "metricsConfig",
                 OpenSearchServiceConfig = new OpenSearchServiceConfigProperty {
                     AwsRegion = "awsRegion",
                     Endpoint = "endpoint"
                 },
                 RelationalDatabaseConfig = new RelationalDatabaseConfigProperty {
                     RelationalDatabaseSourceType = "relationalDatabaseSourceType",

                     // the properties below are optional
                     RdsHttpEndpointConfig = new RdsHttpEndpointConfigProperty {
                         AwsRegion = "awsRegion",
                         AwsSecretStoreArn = "awsSecretStoreArn",
                         DbClusterIdentifier = "dbClusterIdentifier",

                         // the properties below are optional
                         DatabaseName = "databaseName",
                         Schema = "schema"
                     }
                 },
                 ServiceRoleArn = "serviceRoleArn"
             });

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

Resolvers use these data sources to fetch data when clients make GraphQL calls.

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

CloudformationResource: AWS::AppSync::DataSource

ExampleMetadata: fixture=_generated

IsCfnDataSource(object)

Checks whether the given object is a CfnDataSource.

public static bool IsCfnDataSource(object x)

Parameters

x object

Returns

bool

Remarks

Resolvers use these data sources to fetch data when clients make GraphQL calls.

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

CloudformationResource: AWS::AppSync::DataSource

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::AppSync::DataSource resource creates data sources for resolvers in AWS AppSync to connect to, such as Amazon DynamoDB , AWS Lambda , and Amazon OpenSearch Service .

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

Resolvers use these data sources to fetch data when clients make GraphQL calls.

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

CloudformationResource: AWS::AppSync::DataSource

ExampleMetadata: fixture=_generated

Implements

IInspectable

IDataSourceRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware