Interface IBaseDataSourceProps

Base properties for an AppSync datasource.

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IBaseDataSourceProps

Syntax (vb)

Public Interface IBaseDataSourceProps

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;
            using Amazon.CDK.Interfaces.AppSync;

            IGraphQLApiRef graphQLApiRef;

            var baseDataSourceProps = new BaseDataSourceProps {
                Api = graphQLApiRef,

                // the properties below are optional
                Description = "description",
                MetricsConfig = DataSourceMetricsConfig.ENABLED,
                Name = "name"
            };

Synopsis

Properties

Api	The API to attach this data source to.
Description	the description of the data source.
MetricsConfig	Whether to enable enhanced metrics of the data source Value will be ignored, if enhancedMetricsConfig.dataSourceLevelMetricsBehavior on AppSync GraphqlApi construct is set to FULL_REQUEST_DATA_SOURCE_METRICS.
Name	The name of the data source.

Properties

Api

The API to attach this data source to.

IGraphQLApiRef Api { get; }

Property Value

IGraphQLApiRef

Remarks

ExampleMetadata: fixture=_generated

Description

the description of the data source.

string? Description { get; }

Property Value

string

Remarks

Default: - None

MetricsConfig

Whether to enable enhanced metrics of the data source Value will be ignored, if enhancedMetricsConfig.dataSourceLevelMetricsBehavior on AppSync GraphqlApi construct is set to FULL_REQUEST_DATA_SOURCE_METRICS.

DataSourceMetricsConfig? MetricsConfig { get; }

Property Value

DataSourceMetricsConfig?

Remarks

Default: - no metrics configuration

Name

The name of the data source.

string? Name { get; }

Property Value

string

Remarks

Default: - id of data source