Package software.amazon.awscdk.services.appsync

Interface CfnDataSourceProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDataSourceProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:49.418Z") @Stability(Stable) public interface CfnDataSourceProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnDataSource.

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.*;
 CfnDataSourceProps cfnDataSourceProps = CfnDataSourceProps.builder()
         .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();

  • Method Details

    • getApiId

      @Stability(Stable) @NotNull String getApiId()
      Unique AWS AppSync GraphQL API identifier where this data source will be created.

    • getName

      @Stability(Stable) @NotNull String getName()
      Friendly name for you to identify your AppSync data source after creation.

    • getType

      @Stability(Stable) @NotNull 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.

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      The description of the data source.

    • getDynamoDbConfig

      @Stability(Stable) @Nullable default Object getDynamoDbConfig()
      AWS Region and TableName for an Amazon DynamoDB table in your account.

    • getElasticsearchConfig

      @Stability(Stable) @Nullable default 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.

    • getEventBridgeConfig

      @Stability(Stable) @Nullable default Object getEventBridgeConfig()
      An EventBridge configuration that contains a valid ARN of an event bus.

    • getHttpConfig

      @Stability(Stable) @Nullable default Object getHttpConfig()
      Endpoints for an HTTP data source.

    • getLambdaConfig

      @Stability(Stable) @Nullable default 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.

    • getOpenSearchServiceConfig

      @Stability(Stable) @Nullable default Object getOpenSearchServiceConfig()
      AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.

    • getRelationalDatabaseConfig

      @Stability(Stable) @Nullable default Object getRelationalDatabaseConfig()
      Relational Database configuration of the relational database data source.

    • getServiceRoleArn

      @Stability(Stable) @Nullable default 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 .

    • builder

      @Stability(Stable) static CfnDataSourceProps.Builder builder()
      Returns:
      a CfnDataSourceProps.Builder of CfnDataSourceProps