CfnDataSource

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.appsync.CfnDataSource

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:51.442Z")
public class CfnDataSource
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppSync::DataSource`.

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())
         .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();

Nested Class Summary

Nested Classes
Modifier and Type	Class and 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 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` The `ElasticsearchConfig` 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.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 interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

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

Method Summary

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

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnDataSource
```
protected CfnDataSource(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnDataSource
```
protected CfnDataSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnDataSource
```
public CfnDataSource(Construct scope,
                     java.lang.String id,
                     CfnDataSourceProps props)
```
    Create a new `AWS::AppSync::DataSource`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrDataSourceArn
```
public java.lang.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
```
public java.lang.String getAttrName()
```
    Friendly name for you to identify your AWS AppSync data source after creation.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getApiId
```
public java.lang.String getApiId()
```
    Unique AWS AppSync GraphQL API identifier where this data source will be created.
  - setApiId
```
public void setApiId(java.lang.String value)
```
    Unique AWS AppSync GraphQL API identifier where this data source will be created.
  - getName
```
public java.lang.String getName()
```
    Friendly name for you to identify your AppSync data source after creation.
  - setName
```
public void setName(java.lang.String value)
```
    Friendly name for you to identify your AppSync data source after creation.
  - getType
```
public java.lang.String getType()
```
    The type of the data source.
    - AWS_LAMBDA : The data source is an AWS Lambda function.
    - AMAZON_DYNAMODB : The data source is an Amazon DynamoDB table.
    - AMAZON_ELASTICSEARCH : The data source is an Amazon OpenSearch Service domain.
    - AMAZON_EVENTBRIDGE : The data source is an Amazon EventBridge event bus.
    - AMAZON_OPENSEARCH_SERVICE : The data source is an Amazon OpenSearch Service domain.
    - NONE : There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.
    - HTTP : The data source is an HTTP endpoint.
    - RELATIONAL_DATABASE : The data source is a relational database.
  - setType
```
public void setType(java.lang.String value)
```
    The type of the data source.
    - AWS_LAMBDA : The data source is an AWS Lambda function.
    - AMAZON_DYNAMODB : The data source is an Amazon DynamoDB table.
    - AMAZON_ELASTICSEARCH : The data source is an Amazon OpenSearch Service domain.
    - AMAZON_EVENTBRIDGE : The data source is an Amazon EventBridge event bus.
    - AMAZON_OPENSEARCH_SERVICE : The data source is an Amazon OpenSearch Service domain.
    - NONE : There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.
    - HTTP : The data source is an HTTP endpoint.
    - RELATIONAL_DATABASE : The data source is a relational database.
  - getDescription
```
public java.lang.String getDescription()
```
    The description of the data source.
  - setDescription
```
public void setDescription(java.lang.String value)
```
    The description of the data source.
  - getDynamoDbConfig
```
public java.lang.Object getDynamoDbConfig()
```
    AWS Region and TableName for an Amazon DynamoDB table in your account.
  - setDynamoDbConfig
```
public void setDynamoDbConfig(IResolvable value)
```
    AWS Region and TableName for an Amazon DynamoDB table in your account.
  - setDynamoDbConfig
```
public void setDynamoDbConfig(CfnDataSource.DynamoDBConfigProperty value)
```
    AWS Region and TableName for an Amazon DynamoDB table in your account.
  - getElasticsearchConfig
```
public java.lang.Object getElasticsearchConfig()
```
    AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.
    As of September 2021, Amazon Elasticsearch Service is Amazon OpenSearch Service . This property is deprecated. For new data sources, use OpenSearchServiceConfig to specify an OpenSearch Service data source.
  - setElasticsearchConfig
```
public void setElasticsearchConfig(IResolvable value)
```
    AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.
    As of September 2021, Amazon Elasticsearch Service is Amazon OpenSearch Service . This property is deprecated. For new data sources, use OpenSearchServiceConfig to specify an OpenSearch Service data source.
  - setElasticsearchConfig
```
public void setElasticsearchConfig(CfnDataSource.ElasticsearchConfigProperty value)
```
    AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.
    As of September 2021, Amazon Elasticsearch Service is Amazon OpenSearch Service . This property is deprecated. For new data sources, use OpenSearchServiceConfig to specify an OpenSearch Service data source.
  - getEventBridgeConfig
```
public java.lang.Object getEventBridgeConfig()
```
    An EventBridge configuration that contains a valid ARN of an event bus.
  - setEventBridgeConfig
```
public void setEventBridgeConfig(IResolvable value)
```
    An EventBridge configuration that contains a valid ARN of an event bus.
  - setEventBridgeConfig
```
public void setEventBridgeConfig(CfnDataSource.EventBridgeConfigProperty value)
```
    An EventBridge configuration that contains a valid ARN of an event bus.
  - getHttpConfig
```
public java.lang.Object getHttpConfig()
```
    Endpoints for an HTTP data source.
  - setHttpConfig
```
public void setHttpConfig(IResolvable value)
```
    Endpoints for an HTTP data source.
  - setHttpConfig
```
public void setHttpConfig(CfnDataSource.HttpConfigProperty value)
```
    Endpoints for an HTTP data source.
  - getLambdaConfig
```
public java.lang.Object getLambdaConfig()
```
    An ARN of a Lambda function in valid ARN format.
    This can be the ARN of a Lambda function that exists in the current account or in another account.
  - setLambdaConfig
```
public void setLambdaConfig(IResolvable value)
```
    An ARN of a Lambda function in valid ARN format.
    This can be the ARN of a Lambda function that exists in the current account or in another account.
  - setLambdaConfig
```
public void setLambdaConfig(CfnDataSource.LambdaConfigProperty value)
```
    An ARN of a Lambda function in valid ARN format.
    This can be the ARN of a Lambda function that exists in the current account or in another account.
  - getOpenSearchServiceConfig
```
public java.lang.Object getOpenSearchServiceConfig()
```
    AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.
  - setOpenSearchServiceConfig
```
public void setOpenSearchServiceConfig(IResolvable value)
```
    AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.
  - setOpenSearchServiceConfig
```
public void setOpenSearchServiceConfig(CfnDataSource.OpenSearchServiceConfigProperty value)
```
    AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.
  - getRelationalDatabaseConfig
```
public java.lang.Object getRelationalDatabaseConfig()
```
    Relational Database configuration of the relational database data source.
  - setRelationalDatabaseConfig
```
public void setRelationalDatabaseConfig(IResolvable value)
```
    Relational Database configuration of the relational database data source.
  - setRelationalDatabaseConfig
```
public void setRelationalDatabaseConfig(CfnDataSource.RelationalDatabaseConfigProperty value)
```
    Relational Database configuration of the relational database data source.
  - getServiceRoleArn
```
public java.lang.String getServiceRoleArn()
```
    The AWS Identity and Access Management service role ARN for the data source.
    The system assumes this role when accessing the data source.
    Required if Type is specified as AWS_LAMBDA , AMAZON_DYNAMODB , AMAZON_ELASTICSEARCH , AMAZON_EVENTBRIDGE , or AMAZON_OPENSEARCH_SERVICE .
  - setServiceRoleArn
```
public void setServiceRoleArn(java.lang.String value)
```
    The AWS Identity and Access Management service role ARN for the data source.
    The system assumes this role when accessing the data source.
    Required if Type is specified as AWS_LAMBDA , AMAZON_DYNAMODB , AMAZON_ELASTICSEARCH , AMAZON_EVENTBRIDGE , or AMAZON_OPENSEARCH_SERVICE .

Class CfnDataSource

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnDataSource

CfnDataSource

CfnDataSource

Method Detail

inspect

renderProperties

getAttrDataSourceArn

getAttrName

getCfnProperties

getApiId

setApiId

getName

setName

getType

setType

getDescription

setDescription

getDynamoDbConfig

setDynamoDbConfig

setDynamoDbConfig

getElasticsearchConfig

setElasticsearchConfig

setElasticsearchConfig

getEventBridgeConfig

setEventBridgeConfig

setEventBridgeConfig

getHttpConfig

setHttpConfig

setHttpConfig

getLambdaConfig

setLambdaConfig

setLambdaConfig

getOpenSearchServiceConfig

setOpenSearchServiceConfig

setOpenSearchServiceConfig

getRelationalDatabaseConfig

setRelationalDatabaseConfig

setRelationalDatabaseConfig

getServiceRoleArn

setServiceRoleArn