Class CreateDataSourceRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateDataSourceRequest.Builder,
CreateDataSourceRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
apiId()
The API ID for the GraphQL API for theDataSource
.builder()
final String
A description of theDataSource
.final DynamodbDataSourceConfig
Amazon DynamoDB settings.Amazon OpenSearch Service settings.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.Amazon EventBridge settings.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final HttpDataSourceConfig
HTTP endpoint settings.final LambdaDataSourceConfig
Lambda settings.Enables or disables enhanced data source metrics for specified data sources.final String
Enables or disables enhanced data source metrics for specified data sources.final String
name()
A user-supplied name for theDataSource
.Amazon OpenSearch Service settings.Relational database settings.static Class
<? extends CreateDataSourceRequest.Builder> final String
The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final DataSourceType
type()
The type of theDataSource
.final String
The type of theDataSource
.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
apiId
The API ID for the GraphQL API for the
DataSource
.- Returns:
- The API ID for the GraphQL API for the
DataSource
.
-
name
A user-supplied name for the
DataSource
.- Returns:
- A user-supplied name for the
DataSource
.
-
description
A description of the
DataSource
.- Returns:
- A description of the
DataSource
.
-
type
The type of the
DataSource
.If the service returns an enum value that is not available in the current SDK version,
type
will returnDataSourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the
DataSource
. - See Also:
-
typeAsString
The type of the
DataSource
.If the service returns an enum value that is not available in the current SDK version,
type
will returnDataSourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the
DataSource
. - 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.
- 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
Amazon DynamoDB settings.
- Returns:
- Amazon DynamoDB settings.
-
lambdaConfig
Lambda settings.
- Returns:
- Lambda settings.
-
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
Amazon OpenSearch Service settings.
- Returns:
- Amazon OpenSearch Service settings.
-
httpConfig
HTTP endpoint settings.
- Returns:
- HTTP endpoint settings.
-
relationalDatabaseConfig
Relational database settings.
- Returns:
- Relational database settings.
-
eventBridgeConfig
Amazon EventBridge settings.
- Returns:
- Amazon EventBridge settings.
-
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
.If the service returns an enum value that is not available in the current SDK version,
metricsConfig
will returnDataSourceLevelMetricsConfig.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetricsConfigAsString()
.- Returns:
- 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:
-
metricsConfigAsString
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
.If the service returns an enum value that is not available in the current SDK version,
metricsConfig
will returnDataSourceLevelMetricsConfig.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetricsConfigAsString()
.- Returns:
- 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:
-
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 interfaceToCopyableBuilder<CreateDataSourceRequest.Builder,
CreateDataSourceRequest> - Specified by:
toBuilder
in classAppSyncRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-