DataSource (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.appsync.model.DataSource

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Describes a data source.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DataSource()

Constructors
Constructor and Description
`DataSource()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DataSource`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDataSourceArn()` The data source Amazon Resource Name (ARN).
`String`	`getDescription()` The description of the data source.
`DynamodbDataSourceConfig`	`getDynamodbConfig()` DynamoDB settings.
`ElasticsearchDataSourceConfig`	`getElasticsearchConfig()` Amazon OpenSearch Service settings.
`HttpDataSourceConfig`	`getHttpConfig()` HTTP endpoint settings.
`LambdaDataSourceConfig`	`getLambdaConfig()` Lambda settings.
`String`	`getName()` The name of the data source.
`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 data source.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDataSourceArn(String dataSourceArn)` The data source Amazon Resource Name (ARN).
`void`	`setDescription(String description)` The description of the data source.
`void`	`setDynamodbConfig(DynamodbDataSourceConfig dynamodbConfig)` DynamoDB settings.
`void`	`setElasticsearchConfig(ElasticsearchDataSourceConfig elasticsearchConfig)` Amazon OpenSearch Service settings.
`void`	`setHttpConfig(HttpDataSourceConfig httpConfig)` HTTP endpoint settings.
`void`	`setLambdaConfig(LambdaDataSourceConfig lambdaConfig)` Lambda settings.
`void`	`setName(String name)` The name of the data source.
`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 data source.
`String`	`toString()` Returns a string representation of this object.
`DataSource`	`withDataSourceArn(String dataSourceArn)` The data source Amazon Resource Name (ARN).
`DataSource`	`withDescription(String description)` The description of the data source.
`DataSource`	`withDynamodbConfig(DynamodbDataSourceConfig dynamodbConfig)` DynamoDB settings.
`DataSource`	`withElasticsearchConfig(ElasticsearchDataSourceConfig elasticsearchConfig)` Amazon OpenSearch Service settings.
`DataSource`	`withHttpConfig(HttpDataSourceConfig httpConfig)` HTTP endpoint settings.
`DataSource`	`withLambdaConfig(LambdaDataSourceConfig lambdaConfig)` Lambda settings.
`DataSource`	`withName(String name)` The name of the data source.
`DataSource`	`withOpenSearchServiceConfig(OpenSearchServiceDataSourceConfig openSearchServiceConfig)` Amazon OpenSearch Service settings.
`DataSource`	`withRelationalDatabaseConfig(RelationalDatabaseDataSourceConfig relationalDatabaseConfig)` Relational database settings.
`DataSource`	`withServiceRoleArn(String serviceRoleArn)` The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source.
`DataSource`	`withType(DataSourceType type)` The type of the data source.
`DataSource`	`withType(String type)` The type of the data source.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DataSource
```
public DataSource()
```
- Method Detail
  - setDataSourceArn
```
public void setDataSourceArn(String dataSourceArn)
```
    The data source Amazon Resource Name (ARN).
    
    Parameters:
    
    dataSourceArn - The data source Amazon Resource Name (ARN).
  - getDataSourceArn
```
public String getDataSourceArn()
```
    The data source Amazon Resource Name (ARN).
    
    Returns:
    
    The data source Amazon Resource Name (ARN).
  - withDataSourceArn
```
public DataSource withDataSourceArn(String dataSourceArn)
```
    The data source Amazon Resource Name (ARN).
    
    Parameters:
    
    dataSourceArn - The data source Amazon Resource Name (ARN).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the data source.
    
    Parameters:
    
    name - The name of the data source.
  - getName
```
public String getName()
```
    The name of the data source.
    
    Returns:
    
    The name of the data source.
  - withName
```
public DataSource withName(String name)
```
    The name of the data source.
    
    Parameters:
    
    name - The name of the data source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the data source.
    
    Parameters:
    
    description - The description of the data source.
  - getDescription
```
public String getDescription()
```
    The description of the data source.
    
    Returns:
    
    The description of the data source.
  - withDescription
```
public DataSource withDescription(String description)
```
    The description of the data source.
    
    Parameters:
    
    description - The description of the data source.
    
    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 data source.
    - AWS_LAMBDA: The data source is an Lambda function.
    - AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
    - AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.
    - AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
    - NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you're performing data transformation with resolvers or invoking a subscription from a mutation.
    - HTTP: The data source is an HTTP endpoint.
    - RELATIONAL_DATABASE: The data source is a relational database.
    Parameters:
    type - The type of the data source.
    
    AWS_LAMBDA: The data source is an Lambda function.
    
    AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
    
    AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.
    
    AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
    
    NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you're performing data transformation with resolvers or invoking a subscription from a mutation.
    
    HTTP: The data source is an HTTP endpoint.
    
    RELATIONAL_DATABASE: The data source is a relational database.
    See Also:
    
    DataSourceType
  - getType
```
public String getType()
```
    The type of the data source.
    - AWS_LAMBDA: The data source is an Lambda function.
    - AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
    - AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.
    - AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
    - NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you're performing data transformation with resolvers or invoking a subscription from a mutation.
    - HTTP: The data source is an HTTP endpoint.
    - RELATIONAL_DATABASE: The data source is a relational database.
    Returns:
    The type of the data source.
    
    AWS_LAMBDA: The data source is an Lambda function.
    
    AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
    
    AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.
    
    AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
    
    NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you're performing data transformation with resolvers or invoking a subscription from a mutation.
    
    HTTP: The data source is an HTTP endpoint.
    
    RELATIONAL_DATABASE: The data source is a relational database.
    See Also:
    
    DataSourceType
  - withType
```
public DataSource withType(String type)
```
    The type of the data source.
    - AWS_LAMBDA: The data source is an Lambda function.
    - AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
    - AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.
    - AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
    - NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you're performing data transformation with resolvers or invoking a subscription from a mutation.
    - HTTP: The data source is an HTTP endpoint.
    - RELATIONAL_DATABASE: The data source is a relational database.
    Parameters:
    type - The type of the data source.
    
    AWS_LAMBDA: The data source is an Lambda function.
    
    AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
    
    AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.
    
    AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
    
    NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you're performing data transformation with resolvers or invoking a subscription from a mutation.
    
    HTTP: The data source is an HTTP endpoint.
    
    RELATIONAL_DATABASE: The data source is a relational database.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DataSourceType
  - withType
```
public DataSource withType(DataSourceType type)
```
    The type of the data source.
    - AWS_LAMBDA: The data source is an Lambda function.
    - AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
    - AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.
    - AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
    - NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you're performing data transformation with resolvers or invoking a subscription from a mutation.
    - HTTP: The data source is an HTTP endpoint.
    - RELATIONAL_DATABASE: The data source is a relational database.
    Parameters:
    type - The type of the data source.
    
    AWS_LAMBDA: The data source is an Lambda function.
    
    AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
    
    AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.
    
    AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
    
    NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you're performing data transformation with resolvers or invoking a subscription from a mutation.
    
    HTTP: The data source is an HTTP endpoint.
    
    RELATIONAL_DATABASE: The data source is a relational database.
    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 DataSource 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)
```
    DynamoDB settings.
    
    Parameters:
    
    dynamodbConfig - DynamoDB settings.
  - getDynamodbConfig
```
public DynamodbDataSourceConfig getDynamodbConfig()
```
    DynamoDB settings.
    
    Returns:
    
    DynamoDB settings.
  - withDynamodbConfig
```
public DataSource withDynamodbConfig(DynamodbDataSourceConfig dynamodbConfig)
```
    DynamoDB settings.
    
    Parameters:
    
    dynamodbConfig - 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 DataSource 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.
    
    Parameters:
    
    elasticsearchConfig - Amazon OpenSearch Service settings.
  - getElasticsearchConfig
```
public ElasticsearchDataSourceConfig getElasticsearchConfig()
```
    Amazon OpenSearch Service settings.
    
    Returns:
    
    Amazon OpenSearch Service settings.
  - withElasticsearchConfig
```
public DataSource withElasticsearchConfig(ElasticsearchDataSourceConfig elasticsearchConfig)
```
    Amazon OpenSearch Service settings.
    
    Parameters:
    
    elasticsearchConfig - Amazon OpenSearch Service settings.
    
    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 DataSource 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 DataSource 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 DataSource 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.
  - 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 DataSource clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class DataSource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DataSource

Method Detail

setDataSourceArn

getDataSourceArn

withDataSourceArn

setName

getName

withName

setDescription

getDescription

withDescription

setType

getType

withType

withType

setServiceRoleArn

getServiceRoleArn

withServiceRoleArn

setDynamodbConfig

getDynamodbConfig

withDynamodbConfig

setLambdaConfig

getLambdaConfig

withLambdaConfig

setElasticsearchConfig

getElasticsearchConfig

withElasticsearchConfig

setOpenSearchServiceConfig

getOpenSearchServiceConfig

withOpenSearchServiceConfig

setHttpConfig

getHttpConfig

withHttpConfig

setRelationalDatabaseConfig

getRelationalDatabaseConfig

withRelationalDatabaseConfig

toString

equals

hashCode

clone

marshall