com.amazonaws.services.appsync.model

Class CreateDataSourceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.appsync.model.CreateDataSourceRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateDataSourceRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateDataSourceRequest()

Method Summary

Modifier and Type	Method and Description
CreateDataSourceRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getApiId() The API ID for the GraphQL API for the DataSource.
String	getDescription() A description of the DataSource.
DynamodbDataSourceConfig	getDynamodbConfig() Amazon DynamoDB settings.
ElasticsearchDataSourceConfig	getElasticsearchConfig() Amazon OpenSearch Service settings.
EventBridgeDataSourceConfig	getEventBridgeConfig() Amazon EventBridge settings.
HttpDataSourceConfig	getHttpConfig() HTTP endpoint settings.
LambdaDataSourceConfig	getLambdaConfig() Lambda settings.
String	getMetricsConfig() Enables or disables enhanced data source metrics for specified data sources.
String	getName() A user-supplied name for the DataSource.
OpenSearchServiceDataSourceConfig	getOpenSearchServiceConfig() Amazon OpenSearch Service settings.
RelationalDatabaseDataSourceConfig	getRelationalDatabaseConfig() Relational database settings.
String	getServiceRoleArn() The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source.
String	getType() The type of the DataSource.
int	hashCode()
void	setApiId(String apiId) The API ID for the GraphQL API for the DataSource.
void	setDescription(String description) A description of the DataSource.
void	setDynamodbConfig(DynamodbDataSourceConfig dynamodbConfig) Amazon DynamoDB settings.
void	setElasticsearchConfig(ElasticsearchDataSourceConfig elasticsearchConfig) Amazon OpenSearch Service settings.
void	setEventBridgeConfig(EventBridgeDataSourceConfig eventBridgeConfig) Amazon EventBridge settings.
void	setHttpConfig(HttpDataSourceConfig httpConfig) HTTP endpoint settings.
void	setLambdaConfig(LambdaDataSourceConfig lambdaConfig) Lambda settings.
void	setMetricsConfig(String metricsConfig) Enables or disables enhanced data source metrics for specified data sources.
void	setName(String name) A user-supplied name for the DataSource.
void	setOpenSearchServiceConfig(OpenSearchServiceDataSourceConfig openSearchServiceConfig) Amazon OpenSearch Service settings.
void	setRelationalDatabaseConfig(RelationalDatabaseDataSourceConfig relationalDatabaseConfig) Relational database settings.
void	setServiceRoleArn(String serviceRoleArn) The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source.
void	setType(String type) The type of the DataSource.
String	toString() Returns a string representation of this object.
CreateDataSourceRequest	withApiId(String apiId) The API ID for the GraphQL API for the DataSource.
CreateDataSourceRequest	withDescription(String description) A description of the DataSource.
CreateDataSourceRequest	withDynamodbConfig(DynamodbDataSourceConfig dynamodbConfig) Amazon DynamoDB settings.
CreateDataSourceRequest	withElasticsearchConfig(ElasticsearchDataSourceConfig elasticsearchConfig) Amazon OpenSearch Service settings.
CreateDataSourceRequest	withEventBridgeConfig(EventBridgeDataSourceConfig eventBridgeConfig) Amazon EventBridge settings.
CreateDataSourceRequest	withHttpConfig(HttpDataSourceConfig httpConfig) HTTP endpoint settings.
CreateDataSourceRequest	withLambdaConfig(LambdaDataSourceConfig lambdaConfig) Lambda settings.
CreateDataSourceRequest	withMetricsConfig(DataSourceLevelMetricsConfig metricsConfig) Enables or disables enhanced data source metrics for specified data sources.
CreateDataSourceRequest	withMetricsConfig(String metricsConfig) Enables or disables enhanced data source metrics for specified data sources.
CreateDataSourceRequest	withName(String name) A user-supplied name for the DataSource.
CreateDataSourceRequest	withOpenSearchServiceConfig(OpenSearchServiceDataSourceConfig openSearchServiceConfig) Amazon OpenSearch Service settings.
CreateDataSourceRequest	withRelationalDatabaseConfig(RelationalDatabaseDataSourceConfig relationalDatabaseConfig) Relational database settings.
CreateDataSourceRequest	withServiceRoleArn(String serviceRoleArn) The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source.
CreateDataSourceRequest	withType(DataSourceType type) The type of the DataSource.
CreateDataSourceRequest	withType(String type) The type of the DataSource.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateDataSourceRequest

public CreateDataSourceRequest()

Method Detail

setApiId

public void setApiId(String apiId)

The API ID for the GraphQL API for the DataSource.

Parameters:

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

getApiId

public String getApiId()

The API ID for the GraphQL API for the DataSource.

Returns:

The API ID for the GraphQL API for the DataSource.

withApiId

public CreateDataSourceRequest withApiId(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.

setName

public void setName(String name)

A user-supplied name for the DataSource.

Parameters:

name - A user-supplied name for the DataSource.

getName

public String getName()

A user-supplied name for the DataSource.

Returns:

A user-supplied name for the DataSource.

withName

public CreateDataSourceRequest withName(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.

setDescription

public void setDescription(String description)

A description of the DataSource.

Parameters:

description - A description of the DataSource.

getDescription

public String getDescription()

A description of the DataSource.

Returns:

A description of the DataSource.

withDescription

public CreateDataSourceRequest withDescription(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.

setType

public void setType(String type)

The type of the DataSource.

Parameters:

type - The type of the DataSource.

See Also:

DataSourceType

getType

public String getType()

The type of the DataSource.

Returns:

The type of the DataSource.

See Also:

DataSourceType

withType

public CreateDataSourceRequest withType(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

withType

public CreateDataSourceRequest withType(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

setServiceRoleArn

public void setServiceRoleArn(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.

getServiceRoleArn

public String getServiceRoleArn()

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.

withServiceRoleArn

public CreateDataSourceRequest withServiceRoleArn(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.

setDynamodbConfig

public void setDynamodbConfig(DynamodbDataSourceConfig dynamodbConfig)

Amazon DynamoDB settings.

Parameters:

dynamodbConfig - Amazon DynamoDB settings.

getDynamodbConfig

public DynamodbDataSourceConfig getDynamodbConfig()

Amazon DynamoDB settings.

Returns:

Amazon DynamoDB settings.

withDynamodbConfig

public CreateDataSourceRequest withDynamodbConfig(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.

setLambdaConfig

public void setLambdaConfig(LambdaDataSourceConfig lambdaConfig)

Lambda settings.

Parameters:

lambdaConfig - Lambda settings.

getLambdaConfig

public LambdaDataSourceConfig getLambdaConfig()

Lambda settings.

Returns:

Lambda settings.

withLambdaConfig

public CreateDataSourceRequest withLambdaConfig(LambdaDataSourceConfig lambdaConfig)

Lambda settings.

Parameters:

lambdaConfig - Lambda settings.

Returns:

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

setElasticsearchConfig

public void setElasticsearchConfig(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.

getElasticsearchConfig

public ElasticsearchDataSourceConfig getElasticsearchConfig()

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.

withElasticsearchConfig

public CreateDataSourceRequest withElasticsearchConfig(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.

setOpenSearchServiceConfig

public void setOpenSearchServiceConfig(OpenSearchServiceDataSourceConfig openSearchServiceConfig)

Amazon OpenSearch Service settings.

Parameters:

openSearchServiceConfig - Amazon OpenSearch Service settings.

getOpenSearchServiceConfig

public OpenSearchServiceDataSourceConfig getOpenSearchServiceConfig()

Amazon OpenSearch Service settings.

Returns:

Amazon OpenSearch Service settings.

withOpenSearchServiceConfig

public CreateDataSourceRequest withOpenSearchServiceConfig(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.

setHttpConfig

public void setHttpConfig(HttpDataSourceConfig httpConfig)

HTTP endpoint settings.

Parameters:

httpConfig - HTTP endpoint settings.

getHttpConfig

public HttpDataSourceConfig getHttpConfig()

HTTP endpoint settings.

Returns:

HTTP endpoint settings.

withHttpConfig

public CreateDataSourceRequest withHttpConfig(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.

setRelationalDatabaseConfig

public void setRelationalDatabaseConfig(RelationalDatabaseDataSourceConfig relationalDatabaseConfig)

Relational database settings.

Parameters:

relationalDatabaseConfig - Relational database settings.

getRelationalDatabaseConfig

public RelationalDatabaseDataSourceConfig getRelationalDatabaseConfig()

Relational database settings.

Returns:

Relational database settings.

withRelationalDatabaseConfig

public CreateDataSourceRequest withRelationalDatabaseConfig(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.

setEventBridgeConfig

public void setEventBridgeConfig(EventBridgeDataSourceConfig eventBridgeConfig)

Amazon EventBridge settings.

Parameters:

eventBridgeConfig - Amazon EventBridge settings.

getEventBridgeConfig

public EventBridgeDataSourceConfig getEventBridgeConfig()

Amazon EventBridge settings.

Returns:

Amazon EventBridge settings.

withEventBridgeConfig

public CreateDataSourceRequest withEventBridgeConfig(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.

setMetricsConfig

public void setMetricsConfig(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.

See Also:

DataSourceLevelMetricsConfig

getMetricsConfig

public String getMetricsConfig()

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:

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

withMetricsConfig

public CreateDataSourceRequest withMetricsConfig(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

withMetricsConfig

public CreateDataSourceRequest withMetricsConfig(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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateDataSourceRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()