Package software.amazon.awssdk.services.appsync.model

Class CreateDataSourceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.appsync.model.AppSyncRequest

software.amazon.awssdk.services.appsync.model.CreateDataSourceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDataSourceRequest.Builder,CreateDataSourceRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateDataSourceRequest
extends AppSyncRequest
implements ToCopyableBuilder<CreateDataSourceRequest.Builder,CreateDataSourceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateDataSourceRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	apiId()	The API ID for the GraphQL API for the DataSource.
static CreateDataSourceRequest.Builder	builder()
String	description()	A description of the DataSource.
DynamodbDataSourceConfig	dynamodbConfig()	Amazon DynamoDB settings.
ElasticsearchDataSourceConfig	elasticsearchConfig()	Amazon OpenSearch Service settings.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
EventBridgeDataSourceConfig	eventBridgeConfig()	Amazon EventBridge settings.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
HttpDataSourceConfig	httpConfig()	HTTP endpoint settings.
LambdaDataSourceConfig	lambdaConfig()	Lambda settings.
DataSourceLevelMetricsConfig	metricsConfig()	Enables or disables enhanced data source metrics for specified data sources.
String	metricsConfigAsString()	Enables or disables enhanced data source metrics for specified data sources.
String	name()	A user-supplied name for the DataSource.
OpenSearchServiceDataSourceConfig	openSearchServiceConfig()	Amazon OpenSearch Service settings.
RelationalDatabaseDataSourceConfig	relationalDatabaseConfig()	Relational database settings.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDataSourceRequest.Builder>	serializableBuilderClass()
String	serviceRoleArn()	The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source.
CreateDataSourceRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
DataSourceType	type()	The type of the DataSource.
String	typeAsString()	The type of the DataSource.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

apiId

public final String apiId()

The API ID for the GraphQL API for the DataSource.

Returns:

The API ID for the GraphQL API for the DataSource.

name

public final String name()

A user-supplied name for the DataSource.

Returns:

A user-supplied name for the DataSource.

description

public final String description()

A description of the DataSource.

Returns:

A description of the DataSource.

type

public final DataSourceType type()

The type of the DataSource.

If the service returns an enum value that is not available in the current SDK version, type will return DataSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of the DataSource.

See Also:

DataSourceType

typeAsString

public final String typeAsString()

The type of the DataSource.

If the service returns an enum value that is not available in the current SDK version, type will return DataSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of the DataSource.

See Also:

DataSourceType

serviceRoleArn

public final 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.

Returns:

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.

dynamodbConfig

public final DynamodbDataSourceConfig dynamodbConfig()

Amazon DynamoDB settings.

Returns:

Amazon DynamoDB settings.

lambdaConfig

public final LambdaDataSourceConfig lambdaConfig()

Lambda settings.

Returns:

Lambda settings.

elasticsearchConfig

public final 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.

Returns:

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.

openSearchServiceConfig

public final OpenSearchServiceDataSourceConfig openSearchServiceConfig()

Amazon OpenSearch Service settings.

Returns:

Amazon OpenSearch Service settings.

httpConfig

public final HttpDataSourceConfig httpConfig()

HTTP endpoint settings.

Returns:

HTTP endpoint settings.

relationalDatabaseConfig

public final RelationalDatabaseDataSourceConfig relationalDatabaseConfig()

Relational database settings.

Returns:

Relational database settings.

eventBridgeConfig

public final EventBridgeDataSourceConfig eventBridgeConfig()

Amazon EventBridge settings.

Returns:

Amazon EventBridge settings.

metricsConfig

public final 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.

If the service returns an enum value that is not available in the current SDK version, metricsConfig will return DataSourceLevelMetricsConfig.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricsConfigAsString().

Returns:

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.

See Also:

DataSourceLevelMetricsConfig

metricsConfigAsString

public final String metricsConfigAsString()

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.

If the service returns an enum value that is not available in the current SDK version, metricsConfig will return DataSourceLevelMetricsConfig.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricsConfigAsString().

Returns:

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.

See Also:

DataSourceLevelMetricsConfig

toBuilder

public CreateDataSourceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDataSourceRequest.Builder,CreateDataSourceRequest>

Specified by:

toBuilder in class AppSyncRequest

builder

public static CreateDataSourceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateDataSourceRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo