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

Inherits:

Struct

• Object
• Struct
• Aws::AppSync::Types::DataSource

Includes:

Structure

Defined in:

lib/aws-sdk-appsync/types.rb

Overview

Describes a data source.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #data_source_arn ⇒ String

  The data source Amazon Resource Name (ARN).

• #description ⇒ String

  The description of the data source.

• #dynamodb_config ⇒ Types::DynamodbDataSourceConfig

  DynamoDB settings.

• #elasticsearch_config ⇒ Types::ElasticsearchDataSourceConfig

  Amazon OpenSearch Service settings.

• #event_bridge_config ⇒ Types::EventBridgeDataSourceConfig

  Amazon EventBridge settings.

• #http_config ⇒ Types::HttpDataSourceConfig

  HTTP endpoint settings.

• #lambda_config ⇒ Types::LambdaDataSourceConfig

  Lambda settings.

• #metrics_config ⇒ String

  Enables or disables enhanced data source metrics for specified data sources.

• #name ⇒ String

  The name of the data source.

• #open_search_service_config ⇒ Types::OpenSearchServiceDataSourceConfig

  Amazon OpenSearch Service settings.

• #relational_database_config ⇒ Types::RelationalDatabaseDataSourceConfig

  Relational database settings.

• #service_role_arn ⇒ String

  The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source.

• #type ⇒ String

  The type of the data source.

Instance Attribute Details

#data_source_arn ⇒ String

The data source Amazon Resource Name (ARN).

Returns:

• (String)

# File 'lib/aws-sdk-appsync/types.rb', line 1757

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

#description ⇒ String

The description of the data source.

Returns:

• (String)

# File 'lib/aws-sdk-appsync/types.rb', line 1757

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_config ⇒ Types::DynamodbDataSourceConfig

DynamoDB settings.

Returns:

• (Types::DynamodbDataSourceConfig)

# File 'lib/aws-sdk-appsync/types.rb', line 1757

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_config ⇒ Types::ElasticsearchDataSourceConfig

Amazon OpenSearch Service settings.

Returns:

• (Types::ElasticsearchDataSourceConfig)

# File 'lib/aws-sdk-appsync/types.rb', line 1757

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_config ⇒ Types::EventBridgeDataSourceConfig

Amazon EventBridge settings.

Returns:

• (Types::EventBridgeDataSourceConfig)

# File 'lib/aws-sdk-appsync/types.rb', line 1757

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_config ⇒ Types::HttpDataSourceConfig

HTTP endpoint settings.

Returns:

• (Types::HttpDataSourceConfig)

# File 'lib/aws-sdk-appsync/types.rb', line 1757

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_config ⇒ Types::LambdaDataSourceConfig

Lambda settings.

Returns:

• (Types::LambdaDataSourceConfig)

# File 'lib/aws-sdk-appsync/types.rb', line 1757

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_config ⇒ String

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)

# File 'lib/aws-sdk-appsync/types.rb', line 1757

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

#name ⇒ String

The name of the data source.

Returns:

• (String)

# File 'lib/aws-sdk-appsync/types.rb', line 1757

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_config ⇒ Types::OpenSearchServiceDataSourceConfig

Amazon OpenSearch Service settings.

Returns:

• (Types::OpenSearchServiceDataSourceConfig)

# File 'lib/aws-sdk-appsync/types.rb', line 1757

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_config ⇒ Types::RelationalDatabaseDataSourceConfig

Relational database settings.

Returns:

• (Types::RelationalDatabaseDataSourceConfig)

# File 'lib/aws-sdk-appsync/types.rb', line 1757

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_arn ⇒ String

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)

# File 'lib/aws-sdk-appsync/types.rb', line 1757

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

#type ⇒ String

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.

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

# File 'lib/aws-sdk-appsync/types.rb', line 1757

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