Interface DataSource.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DataSource.Builder,
,DataSource> SdkBuilder<DataSource.Builder,
,DataSource> SdkPojo
- Enclosing class:
DataSource
-
Method Summary
Modifier and TypeMethodDescriptiondataSourceArn
(String dataSourceArn) The data source Amazon Resource Name (ARN).description
(String description) The description of the data source.default DataSource.Builder
dynamodbConfig
(Consumer<DynamodbDataSourceConfig.Builder> dynamodbConfig) DynamoDB settings.dynamodbConfig
(DynamodbDataSourceConfig dynamodbConfig) DynamoDB settings.default DataSource.Builder
elasticsearchConfig
(Consumer<ElasticsearchDataSourceConfig.Builder> elasticsearchConfig) Amazon OpenSearch Service settings.elasticsearchConfig
(ElasticsearchDataSourceConfig elasticsearchConfig) Amazon OpenSearch Service settings.default DataSource.Builder
eventBridgeConfig
(Consumer<EventBridgeDataSourceConfig.Builder> eventBridgeConfig) Amazon EventBridge settings.eventBridgeConfig
(EventBridgeDataSourceConfig eventBridgeConfig) Amazon EventBridge settings.default DataSource.Builder
httpConfig
(Consumer<HttpDataSourceConfig.Builder> httpConfig) HTTP endpoint settings.httpConfig
(HttpDataSourceConfig httpConfig) HTTP endpoint settings.default DataSource.Builder
lambdaConfig
(Consumer<LambdaDataSourceConfig.Builder> lambdaConfig) Lambda settings.lambdaConfig
(LambdaDataSourceConfig lambdaConfig) Lambda settings.metricsConfig
(String metricsConfig) Enables or disables enhanced data source metrics for specified data sources.metricsConfig
(DataSourceLevelMetricsConfig metricsConfig) Enables or disables enhanced data source metrics for specified data sources.The name of the data source.default DataSource.Builder
openSearchServiceConfig
(Consumer<OpenSearchServiceDataSourceConfig.Builder> openSearchServiceConfig) Amazon OpenSearch Service settings.openSearchServiceConfig
(OpenSearchServiceDataSourceConfig openSearchServiceConfig) Amazon OpenSearch Service settings.default DataSource.Builder
relationalDatabaseConfig
(Consumer<RelationalDatabaseDataSourceConfig.Builder> relationalDatabaseConfig) Relational database settings.relationalDatabaseConfig
(RelationalDatabaseDataSourceConfig relationalDatabaseConfig) Relational database settings.serviceRoleArn
(String serviceRoleArn) The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source.The type of the data source.type
(DataSourceType type) The type of the data source.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
dataSourceArn
The data source Amazon Resource Name (ARN).
- Parameters:
dataSourceArn
- The data source Amazon Resource Name (ARN).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
The name of the data source.
- Parameters:
name
- The name of the data source.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
The description of the data source.
- Parameters:
description
- The description of the data source.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
type
The type of the data source.
-
AWS_LAMBDA: The data source is an Lambda function.
-
AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
-
AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.
-
AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
-
AMAZON_EVENTBRIDGE: The data source is an Amazon EventBridge configuration.
-
NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you're performing data transformation with resolvers or invoking a subscription from a mutation.
-
HTTP: The data source is an HTTP endpoint.
-
RELATIONAL_DATABASE: The data source is a relational database.
- Parameters:
type
- The type of the data source.-
AWS_LAMBDA: The data source is an Lambda function.
-
AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
-
AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.
-
AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
-
AMAZON_EVENTBRIDGE: The data source is an Amazon EventBridge configuration.
-
NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you're performing data transformation with resolvers or invoking a subscription from a mutation.
-
HTTP: The data source is an HTTP endpoint.
-
RELATIONAL_DATABASE: The data source is a relational database.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
type
The type of the data source.
-
AWS_LAMBDA: The data source is an Lambda function.
-
AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
-
AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.
-
AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
-
AMAZON_EVENTBRIDGE: The data source is an Amazon EventBridge configuration.
-
NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you're performing data transformation with resolvers or invoking a subscription from a mutation.
-
HTTP: The data source is an HTTP endpoint.
-
RELATIONAL_DATABASE: The data source is a relational database.
- Parameters:
type
- The type of the data source.-
AWS_LAMBDA: The data source is an Lambda function.
-
AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
-
AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.
-
AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
-
AMAZON_EVENTBRIDGE: The data source is an Amazon EventBridge configuration.
-
NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you're performing data transformation with resolvers or invoking a subscription from a mutation.
-
HTTP: The data source is an HTTP endpoint.
-
RELATIONAL_DATABASE: The data source is a relational database.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
serviceRoleArn
The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source. The system assumes this role when accessing the data source.
- Parameters:
serviceRoleArn
- The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source. The system assumes this role when accessing the data source.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dynamodbConfig
DynamoDB settings.
- Parameters:
dynamodbConfig
- DynamoDB settings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dynamodbConfig
default DataSource.Builder dynamodbConfig(Consumer<DynamodbDataSourceConfig.Builder> dynamodbConfig) DynamoDB settings.
This is a convenience method that creates an instance of theDynamodbDataSourceConfig.Builder
avoiding the need to create one manually viaDynamodbDataSourceConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todynamodbConfig(DynamodbDataSourceConfig)
.- Parameters:
dynamodbConfig
- a consumer that will call methods onDynamodbDataSourceConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
lambdaConfig
Lambda settings.
- Parameters:
lambdaConfig
- Lambda settings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lambdaConfig
Lambda settings.
This is a convenience method that creates an instance of theLambdaDataSourceConfig.Builder
avoiding the need to create one manually viaLambdaDataSourceConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolambdaConfig(LambdaDataSourceConfig)
.- Parameters:
lambdaConfig
- a consumer that will call methods onLambdaDataSourceConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
elasticsearchConfig
Amazon OpenSearch Service settings.
- Parameters:
elasticsearchConfig
- Amazon OpenSearch Service settings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
elasticsearchConfig
default DataSource.Builder elasticsearchConfig(Consumer<ElasticsearchDataSourceConfig.Builder> elasticsearchConfig) Amazon OpenSearch Service settings.
This is a convenience method that creates an instance of theElasticsearchDataSourceConfig.Builder
avoiding the need to create one manually viaElasticsearchDataSourceConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toelasticsearchConfig(ElasticsearchDataSourceConfig)
.- Parameters:
elasticsearchConfig
- a consumer that will call methods onElasticsearchDataSourceConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
openSearchServiceConfig
DataSource.Builder openSearchServiceConfig(OpenSearchServiceDataSourceConfig openSearchServiceConfig) Amazon OpenSearch Service settings.
- Parameters:
openSearchServiceConfig
- Amazon OpenSearch Service settings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
openSearchServiceConfig
default DataSource.Builder openSearchServiceConfig(Consumer<OpenSearchServiceDataSourceConfig.Builder> openSearchServiceConfig) Amazon OpenSearch Service settings.
This is a convenience method that creates an instance of theOpenSearchServiceDataSourceConfig.Builder
avoiding the need to create one manually viaOpenSearchServiceDataSourceConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toopenSearchServiceConfig(OpenSearchServiceDataSourceConfig)
.- Parameters:
openSearchServiceConfig
- a consumer that will call methods onOpenSearchServiceDataSourceConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
httpConfig
HTTP endpoint settings.
- Parameters:
httpConfig
- HTTP endpoint settings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
httpConfig
HTTP endpoint settings.
This is a convenience method that creates an instance of theHttpDataSourceConfig.Builder
avoiding the need to create one manually viaHttpDataSourceConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tohttpConfig(HttpDataSourceConfig)
.- Parameters:
httpConfig
- a consumer that will call methods onHttpDataSourceConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
relationalDatabaseConfig
DataSource.Builder relationalDatabaseConfig(RelationalDatabaseDataSourceConfig relationalDatabaseConfig) Relational database settings.
- Parameters:
relationalDatabaseConfig
- Relational database settings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
relationalDatabaseConfig
default DataSource.Builder relationalDatabaseConfig(Consumer<RelationalDatabaseDataSourceConfig.Builder> relationalDatabaseConfig) Relational database settings.
This is a convenience method that creates an instance of theRelationalDatabaseDataSourceConfig.Builder
avoiding the need to create one manually viaRelationalDatabaseDataSourceConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torelationalDatabaseConfig(RelationalDatabaseDataSourceConfig)
.- Parameters:
relationalDatabaseConfig
- a consumer that will call methods onRelationalDatabaseDataSourceConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
eventBridgeConfig
Amazon EventBridge settings.
- Parameters:
eventBridgeConfig
- Amazon EventBridge settings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
eventBridgeConfig
default DataSource.Builder eventBridgeConfig(Consumer<EventBridgeDataSourceConfig.Builder> eventBridgeConfig) Amazon EventBridge settings.
This is a convenience method that creates an instance of theEventBridgeDataSourceConfig.Builder
avoiding the need to create one manually viaEventBridgeDataSourceConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toeventBridgeConfig(EventBridgeDataSourceConfig)
.- Parameters:
eventBridgeConfig
- a consumer that will call methods onEventBridgeDataSourceConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
metricsConfig
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
.- Parameters:
metricsConfig
- Enables or disables enhanced data source metrics for specified data sources. Note thatmetricsConfig
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
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
metricsConfig
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
.- Parameters:
metricsConfig
- Enables or disables enhanced data source metrics for specified data sources. Note thatmetricsConfig
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
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-