Interface CreateDataSourceRequest.Builder

All Superinterfaces:

AppSyncRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateDataSourceRequest.Builder,CreateDataSourceRequest>, SdkBuilder<CreateDataSourceRequest.Builder,CreateDataSourceRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateDataSourceRequest

public static interface CreateDataSourceRequest.Builder
extends AppSyncRequest.Builder, SdkPojo, CopyableBuilder<CreateDataSourceRequest.Builder,CreateDataSourceRequest>

Method Summary

Modifier and Type	Method	Description
CreateDataSourceRequest.Builder	apiId(String apiId)	The API ID for the GraphQL API for the DataSource.
CreateDataSourceRequest.Builder	description(String description)	A description of the DataSource.
default CreateDataSourceRequest.Builder	dynamodbConfig(Consumer<DynamodbDataSourceConfig.Builder> dynamodbConfig)	Amazon DynamoDB settings.
CreateDataSourceRequest.Builder	dynamodbConfig(DynamodbDataSourceConfig dynamodbConfig)	Amazon DynamoDB settings.
default CreateDataSourceRequest.Builder	elasticsearchConfig(Consumer<ElasticsearchDataSourceConfig.Builder> elasticsearchConfig)	Amazon OpenSearch Service settings.
CreateDataSourceRequest.Builder	elasticsearchConfig(ElasticsearchDataSourceConfig elasticsearchConfig)	Amazon OpenSearch Service settings.
default CreateDataSourceRequest.Builder	eventBridgeConfig(Consumer<EventBridgeDataSourceConfig.Builder> eventBridgeConfig)	Amazon EventBridge settings.
CreateDataSourceRequest.Builder	eventBridgeConfig(EventBridgeDataSourceConfig eventBridgeConfig)	Amazon EventBridge settings.
default CreateDataSourceRequest.Builder	httpConfig(Consumer<HttpDataSourceConfig.Builder> httpConfig)	HTTP endpoint settings.
CreateDataSourceRequest.Builder	httpConfig(HttpDataSourceConfig httpConfig)	HTTP endpoint settings.
default CreateDataSourceRequest.Builder	lambdaConfig(Consumer<LambdaDataSourceConfig.Builder> lambdaConfig)	Lambda settings.
CreateDataSourceRequest.Builder	lambdaConfig(LambdaDataSourceConfig lambdaConfig)	Lambda settings.
CreateDataSourceRequest.Builder	metricsConfig(String metricsConfig)	Enables or disables enhanced data source metrics for specified data sources.
CreateDataSourceRequest.Builder	metricsConfig(DataSourceLevelMetricsConfig metricsConfig)	Enables or disables enhanced data source metrics for specified data sources.
CreateDataSourceRequest.Builder	name(String name)	A user-supplied name for the DataSource.
default CreateDataSourceRequest.Builder	openSearchServiceConfig(Consumer<OpenSearchServiceDataSourceConfig.Builder> openSearchServiceConfig)	Amazon OpenSearch Service settings.
CreateDataSourceRequest.Builder	openSearchServiceConfig(OpenSearchServiceDataSourceConfig openSearchServiceConfig)	Amazon OpenSearch Service settings.
CreateDataSourceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateDataSourceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateDataSourceRequest.Builder	relationalDatabaseConfig(Consumer<RelationalDatabaseDataSourceConfig.Builder> relationalDatabaseConfig)	Relational database settings.
CreateDataSourceRequest.Builder	relationalDatabaseConfig(RelationalDatabaseDataSourceConfig relationalDatabaseConfig)	Relational database settings.
CreateDataSourceRequest.Builder	serviceRoleArn(String serviceRoleArn)	The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source.
CreateDataSourceRequest.Builder	type(String type)	The type of the DataSource.
CreateDataSourceRequest.Builder	type(DataSourceType type)	The type of the DataSource.

Methods inherited from interface software.amazon.awssdk.services.appsync.model.AppSyncRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

apiId

CreateDataSourceRequest.Builder apiId(String apiId)

The API ID for the GraphQL API for the DataSource.

Parameters:

apiId - The API ID for the GraphQL API for the DataSource.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

CreateDataSourceRequest.Builder name(String name)

A user-supplied name for the DataSource.

Parameters:

name - A user-supplied name for the DataSource.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

CreateDataSourceRequest.Builder description(String description)

A description of the DataSource.

Parameters:

description - A description of the DataSource.

Returns:

Returns a reference to this object so that method calls can be chained together.

type

CreateDataSourceRequest.Builder type(String type)

The type of the DataSource.

Parameters:

type - The type of the DataSource.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• DataSourceType
• DataSourceType

type

CreateDataSourceRequest.Builder type(DataSourceType type)

The type of the DataSource.

Parameters:

type - The type of the DataSource.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• DataSourceType
• DataSourceType

serviceRoleArn

CreateDataSourceRequest.Builder serviceRoleArn(String 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

CreateDataSourceRequest.Builder dynamodbConfig(DynamodbDataSourceConfig dynamodbConfig)

Amazon DynamoDB settings.

Parameters:

dynamodbConfig - Amazon DynamoDB settings.

Returns:

Returns a reference to this object so that method calls can be chained together.

dynamodbConfig

default CreateDataSourceRequest.Builder dynamodbConfig(Consumer<DynamodbDataSourceConfig.Builder> dynamodbConfig)

Amazon DynamoDB settings.

This is a convenience method that creates an instance of the DynamodbDataSourceConfig.Builder avoiding the need to create one manually via DynamodbDataSourceConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dynamodbConfig(DynamodbDataSourceConfig).

Parameters:

dynamodbConfig - a consumer that will call methods on DynamodbDataSourceConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• dynamodbConfig(DynamodbDataSourceConfig)

lambdaConfig

CreateDataSourceRequest.Builder lambdaConfig(LambdaDataSourceConfig lambdaConfig)

Lambda settings.

Parameters:

lambdaConfig - Lambda settings.

Returns:

Returns a reference to this object so that method calls can be chained together.

lambdaConfig

default CreateDataSourceRequest.Builder lambdaConfig(Consumer<LambdaDataSourceConfig.Builder> lambdaConfig)

Lambda settings.

This is a convenience method that creates an instance of the LambdaDataSourceConfig.Builder avoiding the need to create one manually via LambdaDataSourceConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lambdaConfig(LambdaDataSourceConfig).

Parameters:

lambdaConfig - a consumer that will call methods on LambdaDataSourceConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• lambdaConfig(LambdaDataSourceConfig)

elasticsearchConfig

CreateDataSourceRequest.Builder elasticsearchConfig(ElasticsearchDataSourceConfig elasticsearchConfig)

Amazon OpenSearch Service settings.

As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. For new data sources, use CreateDataSourceRequest$openSearchServiceConfig to create an OpenSearch data source.

Parameters:

elasticsearchConfig - Amazon OpenSearch Service settings.

As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. For new data sources, use CreateDataSourceRequest$openSearchServiceConfig to create an OpenSearch data source.

Returns:

Returns a reference to this object so that method calls can be chained together.

elasticsearchConfig

default CreateDataSourceRequest.Builder elasticsearchConfig(Consumer<ElasticsearchDataSourceConfig.Builder> elasticsearchConfig)

Amazon OpenSearch Service settings.

As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. For new data sources, use CreateDataSourceRequest$openSearchServiceConfig to create an OpenSearch data source.

This is a convenience method that creates an instance of the ElasticsearchDataSourceConfig.Builder avoiding the need to create one manually via ElasticsearchDataSourceConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to elasticsearchConfig(ElasticsearchDataSourceConfig).

Parameters:

elasticsearchConfig - a consumer that will call methods on ElasticsearchDataSourceConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• elasticsearchConfig(ElasticsearchDataSourceConfig)

openSearchServiceConfig

CreateDataSourceRequest.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 CreateDataSourceRequest.Builder openSearchServiceConfig(Consumer<OpenSearchServiceDataSourceConfig.Builder> openSearchServiceConfig)

Amazon OpenSearch Service settings.

This is a convenience method that creates an instance of the OpenSearchServiceDataSourceConfig.Builder avoiding the need to create one manually via OpenSearchServiceDataSourceConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to openSearchServiceConfig(OpenSearchServiceDataSourceConfig).

Parameters:

openSearchServiceConfig - a consumer that will call methods on OpenSearchServiceDataSourceConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• openSearchServiceConfig(OpenSearchServiceDataSourceConfig)

httpConfig

CreateDataSourceRequest.Builder httpConfig(HttpDataSourceConfig 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

default CreateDataSourceRequest.Builder httpConfig(Consumer<HttpDataSourceConfig.Builder> httpConfig)

HTTP endpoint settings.

This is a convenience method that creates an instance of the HttpDataSourceConfig.Builder avoiding the need to create one manually via HttpDataSourceConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to httpConfig(HttpDataSourceConfig).

Parameters:

httpConfig - a consumer that will call methods on HttpDataSourceConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• httpConfig(HttpDataSourceConfig)

relationalDatabaseConfig

CreateDataSourceRequest.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 CreateDataSourceRequest.Builder relationalDatabaseConfig(Consumer<RelationalDatabaseDataSourceConfig.Builder> relationalDatabaseConfig)

Relational database settings.

This is a convenience method that creates an instance of the RelationalDatabaseDataSourceConfig.Builder avoiding the need to create one manually via RelationalDatabaseDataSourceConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to relationalDatabaseConfig(RelationalDatabaseDataSourceConfig).

Parameters:

relationalDatabaseConfig - a consumer that will call methods on RelationalDatabaseDataSourceConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• relationalDatabaseConfig(RelationalDatabaseDataSourceConfig)

eventBridgeConfig

CreateDataSourceRequest.Builder eventBridgeConfig(EventBridgeDataSourceConfig 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 CreateDataSourceRequest.Builder eventBridgeConfig(Consumer<EventBridgeDataSourceConfig.Builder> eventBridgeConfig)

Amazon EventBridge settings.

This is a convenience method that creates an instance of the EventBridgeDataSourceConfig.Builder avoiding the need to create one manually via EventBridgeDataSourceConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to eventBridgeConfig(EventBridgeDataSourceConfig).

Parameters:

eventBridgeConfig - a consumer that will call methods on EventBridgeDataSourceConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• eventBridgeConfig(EventBridgeDataSourceConfig)

metricsConfig

CreateDataSourceRequest.Builder metricsConfig(String metricsConfig)

Enables or disables enhanced data source metrics for specified data sources. Note that metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However, you can still set its value.

metricsConfig can be ENABLED or DISABLED.

Parameters:

metricsConfig - Enables or disables enhanced data source metrics for specified data sources. Note that metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However, you can still set its value.

metricsConfig can be ENABLED or DISABLED.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• DataSourceLevelMetricsConfig
• DataSourceLevelMetricsConfig

metricsConfig

CreateDataSourceRequest.Builder metricsConfig(DataSourceLevelMetricsConfig metricsConfig)

Enables or disables enhanced data source metrics for specified data sources. Note that metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However, you can still set its value.

metricsConfig can be ENABLED or DISABLED.

Parameters:

metricsConfig - Enables or disables enhanced data source metrics for specified data sources. Note that metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However, you can still set its value.

metricsConfig can be ENABLED or DISABLED.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• DataSourceLevelMetricsConfig
• DataSourceLevelMetricsConfig

overrideConfiguration

CreateDataSourceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateDataSourceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.