Interface CfnDataSourceProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDataSourceProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-12-17T21:37:26.429Z")
@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()) .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:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDataSourceProps
static final class
An implementation forCfnDataSourceProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnDataSourceProps.Builder
builder()
getApiId()
Unique AWS AppSync GraphQL API identifier where this data source will be created.default String
The description of the data source.default Object
AWS Region and TableName for an Amazon DynamoDB table in your account.default Object
Deprecated.this property has been deprecateddefault Object
An EventBridge configuration that contains a valid ARN of an event bus.default Object
Endpoints for an HTTP data source.default Object
An ARN of a Lambda function in valid ARN format.default String
Enables or disables enhanced data source metrics for specified data sources.getName()
Friendly name for you to identify your AppSync data source after creation.default Object
AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.default Object
Relational Database configuration of the relational database data source.default String
The AWS Identity and Access Management service role ARN for the data source.getType()
The type of the data source.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getApiId
Unique AWS AppSync GraphQL API identifier where this data source will be created.- See Also:
-
getName
Friendly name for you to identify your AppSync data source after creation.- See Also:
-
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.
- AMAZON_BEDROCK_RUNTIME : The data source is the Amazon Bedrock runtime.
- 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.
- See Also:
-
getDescription
The description of the data source.- See Also:
-
getDynamoDbConfig
AWS Region and TableName for an Amazon DynamoDB table in your account.- See Also:
-
getElasticsearchConfig
Deprecated.this property has been deprecated- See Also:
-
getEventBridgeConfig
An EventBridge configuration that contains a valid ARN of an event bus.- See Also:
-
getHttpConfig
Endpoints for an HTTP data source.- See Also:
-
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.
- See Also:
-
getMetricsConfig
Enables or disables enhanced data source metrics for specified data sources.Note that
MetricsConfig
won't be used unless thedataSourceLevelMetricsBehavior
value is set toPER_DATA_SOURCE_METRICS
. If thedataSourceLevelMetricsBehavior
is set toFULL_REQUEST_DATA_SOURCE_METRICS
instead,MetricsConfig
will be ignored. However, you can still set its value.MetricsConfig
can beENABLED
orDISABLED
.- See Also:
-
getOpenSearchServiceConfig
AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.- See Also:
-
getRelationalDatabaseConfig
Relational Database configuration of the relational database data source.- See Also:
-
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 asAWS_LAMBDA
,AMAZON_DYNAMODB
,AMAZON_ELASTICSEARCH
,AMAZON_EVENTBRIDGE
, orAMAZON_OPENSEARCH_SERVICE
.- See Also:
-
builder
- Returns:
- a
CfnDataSourceProps.Builder
ofCfnDataSourceProps
-