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>

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • toBuilder

      public CreateDataSourceRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateDataSourceRequest.Builder,CreateDataSourceRequest>
      Specified by:
      toBuilder in class AppSyncRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.