Class: Aws::AppSync::Types::DataSource

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb

Overview

Describes a data source.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_source_arnString

The data source Amazon Resource Name (ARN).

Returns:

  • (String)


1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1760

class DataSource < Struct.new(
  :data_source_arn,
  :name,
  :description,
  :type,
  :service_role_arn,
  :dynamodb_config,
  :lambda_config,
  :elasticsearch_config,
  :open_search_service_config,
  :http_config,
  :relational_database_config,
  :event_bridge_config,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the data source.

Returns:

  • (String)


1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1760

class DataSource < Struct.new(
  :data_source_arn,
  :name,
  :description,
  :type,
  :service_role_arn,
  :dynamodb_config,
  :lambda_config,
  :elasticsearch_config,
  :open_search_service_config,
  :http_config,
  :relational_database_config,
  :event_bridge_config,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#dynamodb_configTypes::DynamodbDataSourceConfig

DynamoDB settings.



1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1760

class DataSource < Struct.new(
  :data_source_arn,
  :name,
  :description,
  :type,
  :service_role_arn,
  :dynamodb_config,
  :lambda_config,
  :elasticsearch_config,
  :open_search_service_config,
  :http_config,
  :relational_database_config,
  :event_bridge_config,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#elasticsearch_configTypes::ElasticsearchDataSourceConfig

Amazon OpenSearch Service settings.



1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1760

class DataSource < Struct.new(
  :data_source_arn,
  :name,
  :description,
  :type,
  :service_role_arn,
  :dynamodb_config,
  :lambda_config,
  :elasticsearch_config,
  :open_search_service_config,
  :http_config,
  :relational_database_config,
  :event_bridge_config,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#event_bridge_configTypes::EventBridgeDataSourceConfig

Amazon EventBridge settings.



1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1760

class DataSource < Struct.new(
  :data_source_arn,
  :name,
  :description,
  :type,
  :service_role_arn,
  :dynamodb_config,
  :lambda_config,
  :elasticsearch_config,
  :open_search_service_config,
  :http_config,
  :relational_database_config,
  :event_bridge_config,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#http_configTypes::HttpDataSourceConfig

HTTP endpoint settings.



1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1760

class DataSource < Struct.new(
  :data_source_arn,
  :name,
  :description,
  :type,
  :service_role_arn,
  :dynamodb_config,
  :lambda_config,
  :elasticsearch_config,
  :open_search_service_config,
  :http_config,
  :relational_database_config,
  :event_bridge_config,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#lambda_configTypes::LambdaDataSourceConfig

Lambda settings.



1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1760

class DataSource < Struct.new(
  :data_source_arn,
  :name,
  :description,
  :type,
  :service_role_arn,
  :dynamodb_config,
  :lambda_config,
  :elasticsearch_config,
  :open_search_service_config,
  :http_config,
  :relational_database_config,
  :event_bridge_config,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#metrics_configString

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:

  • (String)


1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1760

class DataSource < Struct.new(
  :data_source_arn,
  :name,
  :description,
  :type,
  :service_role_arn,
  :dynamodb_config,
  :lambda_config,
  :elasticsearch_config,
  :open_search_service_config,
  :http_config,
  :relational_database_config,
  :event_bridge_config,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the data source.

Returns:

  • (String)


1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1760

class DataSource < Struct.new(
  :data_source_arn,
  :name,
  :description,
  :type,
  :service_role_arn,
  :dynamodb_config,
  :lambda_config,
  :elasticsearch_config,
  :open_search_service_config,
  :http_config,
  :relational_database_config,
  :event_bridge_config,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#open_search_service_configTypes::OpenSearchServiceDataSourceConfig

Amazon OpenSearch Service settings.



1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1760

class DataSource < Struct.new(
  :data_source_arn,
  :name,
  :description,
  :type,
  :service_role_arn,
  :dynamodb_config,
  :lambda_config,
  :elasticsearch_config,
  :open_search_service_config,
  :http_config,
  :relational_database_config,
  :event_bridge_config,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#relational_database_configTypes::RelationalDatabaseDataSourceConfig

Relational database settings.



1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1760

class DataSource < Struct.new(
  :data_source_arn,
  :name,
  :description,
  :type,
  :service_role_arn,
  :dynamodb_config,
  :lambda_config,
  :elasticsearch_config,
  :open_search_service_config,
  :http_config,
  :relational_database_config,
  :event_bridge_config,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#service_role_arnString

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:

  • (String)


1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1760

class DataSource < Struct.new(
  :data_source_arn,
  :name,
  :description,
  :type,
  :service_role_arn,
  :dynamodb_config,
  :lambda_config,
  :elasticsearch_config,
  :open_search_service_config,
  :http_config,
  :relational_database_config,
  :event_bridge_config,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

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.

  • AMAZON_EVENTBRIDGE: The data source is an Amazon EventBridge configuration.

  • AMAZON_BEDROCK_RUNTIME: The data source is the Amazon Bedrock runtime.

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

  • (String)


1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1760

class DataSource < Struct.new(
  :data_source_arn,
  :name,
  :description,
  :type,
  :service_role_arn,
  :dynamodb_config,
  :lambda_config,
  :elasticsearch_config,
  :open_search_service_config,
  :http_config,
  :relational_database_config,
  :event_bridge_config,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end