Package software.amazon.awscdk.services.appsync

Class CfnDataSource

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.appsync.CfnDataSource

All Implemented Interfaces:

IInspectable, IDataSourceRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:45.417Z")
@Stability(Stable)
public class CfnDataSource
extends CfnResource
implements IInspectable, 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 .

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appsync.*;
 CfnDataSource cfnDataSource = CfnDataSource.Builder.create(this, "MyCfnDataSource")
         .apiId("apiId")
         .name("name")
         .type("type")
         // the properties below are optional
         .description("description")
         .dynamoDbConfig(DynamoDBConfigProperty.builder()
                 .awsRegion("awsRegion")
                 .tableName("tableName")
                 // the properties below are optional
                 .deltaSyncConfig(DeltaSyncConfigProperty.builder()
                         .baseTableTtl("baseTableTtl")
                         .deltaSyncTableName("deltaSyncTableName")
                         .deltaSyncTableTtl("deltaSyncTableTtl")
                         .build())
                 .useCallerCredentials(false)
                 .versioned(false)
                 .build())
         .elasticsearchConfig(ElasticsearchConfigProperty.builder()
                 .awsRegion("awsRegion")
                 .endpoint("endpoint")
                 .build())
         .eventBridgeConfig(EventBridgeConfigProperty.builder()
                 .eventBusArn("eventBusArn")
                 .build())
         .httpConfig(HttpConfigProperty.builder()
                 .endpoint("endpoint")
                 // the properties below are optional
                 .authorizationConfig(AuthorizationConfigProperty.builder()
                         .authorizationType("authorizationType")
                         // the properties below are optional
                         .awsIamConfig(AwsIamConfigProperty.builder()
                                 .signingRegion("signingRegion")
                                 .signingServiceName("signingServiceName")
                                 .build())
                         .build())
                 .build())
         .lambdaConfig(LambdaConfigProperty.builder()
                 .lambdaFunctionArn("lambdaFunctionArn")
                 .build())
         .metricsConfig("metricsConfig")
         .openSearchServiceConfig(OpenSearchServiceConfigProperty.builder()
                 .awsRegion("awsRegion")
                 .endpoint("endpoint")
                 .build())
         .relationalDatabaseConfig(RelationalDatabaseConfigProperty.builder()
                 .relationalDatabaseSourceType("relationalDatabaseSourceType")
                 // the properties below are optional
                 .rdsHttpEndpointConfig(RdsHttpEndpointConfigProperty.builder()
                         .awsRegion("awsRegion")
                         .awsSecretStoreArn("awsSecretStoreArn")
                         .dbClusterIdentifier("dbClusterIdentifier")
                         // the properties below are optional
                         .databaseName("databaseName")
                         .schema("schema")
                         .build())
                 .build())
         .serviceRoleArn("serviceRoleArn")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnDataSource.AuthorizationConfigProperty	The AuthorizationConfig property type specifies the authorization type and configuration for an AWS AppSync http data source.
static interface	CfnDataSource.AwsIamConfigProperty	Use the AwsIamConfig property type to specify AwsIamConfig for a AWS AppSync authorizaton.
static final class	CfnDataSource.Builder	A fluent builder for CfnDataSource.
static interface	CfnDataSource.DeltaSyncConfigProperty	Describes a Delta Sync configuration.
static interface	CfnDataSource.DynamoDBConfigProperty	The DynamoDBConfig property type specifies the AwsRegion and TableName for an Amazon DynamoDB table in your account for an AWS AppSync data source.
static interface	CfnDataSource.ElasticsearchConfigProperty	Example:
static interface	CfnDataSource.EventBridgeConfigProperty	The data source.
static interface	CfnDataSource.HttpConfigProperty	Use the HttpConfig property type to specify HttpConfig for an AWS AppSync data source.
static interface	CfnDataSource.LambdaConfigProperty	The LambdaConfig property type specifies the Lambda function ARN for an AWS AppSync data source.
static interface	CfnDataSource.OpenSearchServiceConfigProperty	The OpenSearchServiceConfig property type specifies the AwsRegion and Endpoints for an Amazon OpenSearch Service domain in your account for an AWS AppSync data source.
static interface	CfnDataSource.RdsHttpEndpointConfigProperty	Use the RdsHttpEndpointConfig property type to specify the RdsHttpEndpoint for an AWS AppSync relational database.
static interface	CfnDataSource.RelationalDatabaseConfigProperty	Use the RelationalDatabaseConfig property type to specify RelationalDatabaseConfig for an AWS AppSync data source.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.appsync.IDataSourceRef

IDataSourceRef.Jsii$Default, IDataSourceRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDataSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDataSource(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDataSource(software.constructs.Construct scope, String id, CfnDataSourceProps props)	Create a new AWS::AppSync::DataSource.

Method Summary

Modifier and Type	Method	Description
String	getApiId()	Unique AWS AppSync GraphQL API identifier where this data source will be created.
String	getAttrDataSourceArn()	The Amazon Resource Name (ARN) of the API key, such as arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/datasources/datasourcename .
String	getAttrName()	Friendly name for you to identify your AWS AppSync data source after creation.
protected Map<String,Object>	getCfnProperties()
DataSourceReference	getDataSourceRef()	A reference to a DataSource resource.
String	getDescription()	The description of the data source.
Object	getDynamoDbConfig()	AWS Region and TableName for an Amazon DynamoDB table in your account.
Object	getElasticsearchConfig()	Deprecated. this property has been deprecated
Object	getEventBridgeConfig()	An EventBridge configuration that contains a valid ARN of an event bus.
Object	getHttpConfig()	Endpoints for an HTTP data source.
Object	getLambdaConfig()	An ARN of a Lambda function in valid ARN format.
String	getMetricsConfig()	Enables or disables enhanced data source metrics for specified data sources.
String	getName()	Friendly name for you to identify your AppSync data source after creation.
Object	getOpenSearchServiceConfig()	AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.
Object	getRelationalDatabaseConfig()	Relational Database configuration of the relational database data source.
String	getServiceRoleArn()	The AWS Identity and Access Management service role ARN for the data source.
String	getType()	The type of the data source.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApiId(String value)	Unique AWS AppSync GraphQL API identifier where this data source will be created.
void	setDescription(String value)	The description of the data source.
void	setDynamoDbConfig(IResolvable value)	AWS Region and TableName for an Amazon DynamoDB table in your account.
void	setDynamoDbConfig(CfnDataSource.DynamoDBConfigProperty value)	AWS Region and TableName for an Amazon DynamoDB table in your account.
void	setElasticsearchConfig(IResolvable value)	Deprecated. this property has been deprecated
void	setElasticsearchConfig(CfnDataSource.ElasticsearchConfigProperty value)	Deprecated. this property has been deprecated
void	setEventBridgeConfig(IResolvable value)	An EventBridge configuration that contains a valid ARN of an event bus.
void	setEventBridgeConfig(CfnDataSource.EventBridgeConfigProperty value)	An EventBridge configuration that contains a valid ARN of an event bus.
void	setHttpConfig(IResolvable value)	Endpoints for an HTTP data source.
void	setHttpConfig(CfnDataSource.HttpConfigProperty value)	Endpoints for an HTTP data source.
void	setLambdaConfig(IResolvable value)	An ARN of a Lambda function in valid ARN format.
void	setLambdaConfig(CfnDataSource.LambdaConfigProperty value)	An ARN of a Lambda function in valid ARN format.
void	setMetricsConfig(String value)	Enables or disables enhanced data source metrics for specified data sources.
void	setName(String value)	Friendly name for you to identify your AppSync data source after creation.
void	setOpenSearchServiceConfig(IResolvable value)	AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.
void	setOpenSearchServiceConfig(CfnDataSource.OpenSearchServiceConfigProperty value)	AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.
void	setRelationalDatabaseConfig(IResolvable value)	Relational Database configuration of the relational database data source.
void	setRelationalDatabaseConfig(CfnDataSource.RelationalDatabaseConfigProperty value)	Relational Database configuration of the relational database data source.
void	setServiceRoleArn(String value)	The AWS Identity and Access Management service role ARN for the data source.
void	setType(String value)	The type of the data source.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnDataSource

protected CfnDataSource(software.amazon.jsii.JsiiObjectRef objRef)

CfnDataSource

protected CfnDataSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDataSource

@Stability(Stable)
public CfnDataSource(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnDataSourceProps props)

Create a new AWS::AppSync::DataSource.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDataSourceArn

@Stability(Stable)
@NotNull
public String getAttrDataSourceArn()

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

getAttrName

@Stability(Stable)
@NotNull
public String getAttrName()

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

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDataSourceRef

@Stability(Stable)
@NotNull
public DataSourceReference getDataSourceRef()

A reference to a DataSource resource.

Specified by:

getDataSourceRef in interface IDataSourceRef

getApiId

@Stability(Stable)
@NotNull
public String getApiId()

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

setApiId

@Stability(Stable)
public void setApiId(@NotNull
 String value)

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

getName

@Stability(Stable)
@NotNull
public String getName()

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

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

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

getType

@Stability(Stable)
@NotNull
public String getType()

The type of the data source.

setType

@Stability(Stable)
public void setType(@NotNull
 String value)

The type of the data source.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

The description of the data source.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The description of the data source.

getDynamoDbConfig

@Stability(Stable)
@Nullable
public Object getDynamoDbConfig()

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

Returns union: either IResolvable or CfnDataSource.DynamoDBConfigProperty

setDynamoDbConfig

@Stability(Stable)
public void setDynamoDbConfig(@Nullable
 IResolvable value)

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

setDynamoDbConfig

@Stability(Stable)
public void setDynamoDbConfig(@Nullable
 CfnDataSource.DynamoDBConfigProperty value)

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

getElasticsearchConfig

@Stability(Deprecated)
@Deprecated
@Nullable
public Object getElasticsearchConfig()

Deprecated.

this property has been deprecated

Returns union: either IResolvable or CfnDataSource.ElasticsearchConfigProperty

setElasticsearchConfig

@Stability(Deprecated)
@Deprecated
public void setElasticsearchConfig(@Nullable
 IResolvable value)

Deprecated.

this property has been deprecated

setElasticsearchConfig

@Stability(Deprecated)
@Deprecated
public void setElasticsearchConfig(@Nullable
 CfnDataSource.ElasticsearchConfigProperty value)

Deprecated.

this property has been deprecated

getEventBridgeConfig

@Stability(Stable)
@Nullable
public Object getEventBridgeConfig()

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

Returns union: either IResolvable or CfnDataSource.EventBridgeConfigProperty

setEventBridgeConfig

@Stability(Stable)
public void setEventBridgeConfig(@Nullable
 IResolvable value)

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

setEventBridgeConfig

@Stability(Stable)
public void setEventBridgeConfig(@Nullable
 CfnDataSource.EventBridgeConfigProperty value)

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

getHttpConfig

@Stability(Stable)
@Nullable
public Object getHttpConfig()

Endpoints for an HTTP data source.

Returns union: either IResolvable or CfnDataSource.HttpConfigProperty

setHttpConfig

@Stability(Stable)
public void setHttpConfig(@Nullable
 IResolvable value)

Endpoints for an HTTP data source.

setHttpConfig

@Stability(Stable)
public void setHttpConfig(@Nullable
 CfnDataSource.HttpConfigProperty value)

Endpoints for an HTTP data source.

getLambdaConfig

@Stability(Stable)
@Nullable
public Object getLambdaConfig()

An ARN of a Lambda function in valid ARN format.

Returns union: either IResolvable or CfnDataSource.LambdaConfigProperty

setLambdaConfig

@Stability(Stable)
public void setLambdaConfig(@Nullable
 IResolvable value)

An ARN of a Lambda function in valid ARN format.

setLambdaConfig

@Stability(Stable)
public void setLambdaConfig(@Nullable
 CfnDataSource.LambdaConfigProperty value)

An ARN of a Lambda function in valid ARN format.

getMetricsConfig

@Stability(Stable)
@Nullable
public String getMetricsConfig()

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

setMetricsConfig

@Stability(Stable)
public void setMetricsConfig(@Nullable
 String value)

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

getOpenSearchServiceConfig

@Stability(Stable)
@Nullable
public Object getOpenSearchServiceConfig()

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

Returns union: either IResolvable or CfnDataSource.OpenSearchServiceConfigProperty

setOpenSearchServiceConfig

@Stability(Stable)
public void setOpenSearchServiceConfig(@Nullable
 IResolvable value)

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

setOpenSearchServiceConfig

@Stability(Stable)
public void setOpenSearchServiceConfig(@Nullable
 CfnDataSource.OpenSearchServiceConfigProperty value)

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

getRelationalDatabaseConfig

@Stability(Stable)
@Nullable
public Object getRelationalDatabaseConfig()

Relational Database configuration of the relational database data source.

Returns union: either IResolvable or CfnDataSource.RelationalDatabaseConfigProperty

setRelationalDatabaseConfig

@Stability(Stable)
public void setRelationalDatabaseConfig(@Nullable
 IResolvable value)

Relational Database configuration of the relational database data source.

setRelationalDatabaseConfig

@Stability(Stable)
public void setRelationalDatabaseConfig(@Nullable
 CfnDataSource.RelationalDatabaseConfigProperty value)

Relational Database configuration of the relational database data source.

getServiceRoleArn

@Stability(Stable)
@Nullable
public String getServiceRoleArn()

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

setServiceRoleArn

@Stability(Stable)
public void setServiceRoleArn(@Nullable
 String value)

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