Class: Aws::AppSync::Types::CreateDataSourceRequest

Inherits:

Struct

• Object
• Struct
• Aws::AppSync::Types::CreateDataSourceRequest

Includes:

Structure

Defined in:

lib/aws-sdk-appsync/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #api_id ⇒ String

  The API ID for the GraphQL API for the ‘DataSource`.

• #description ⇒ String

  A description of the ‘DataSource`.

• #dynamodb_config ⇒ Types::DynamodbDataSourceConfig

  Amazon 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

  A user-supplied name for the ‘DataSource`.

• #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 ‘DataSource`.

Instance Attribute Details

#api_id ⇒ String

The API ID for the GraphQL API for the ‘DataSource`.

Returns:

• (String)

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

class CreateDataSourceRequest < Struct.new(
  :api_id,
  :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

A description of the ‘DataSource`.

Returns:

• (String)

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

class CreateDataSourceRequest < Struct.new(
  :api_id,
  :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

Amazon DynamoDB settings.

Returns:

• (Types::DynamodbDataSourceConfig)

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

class CreateDataSourceRequest < Struct.new(
  :api_id,
  :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.

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:

• (Types::ElasticsearchDataSourceConfig)

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

class CreateDataSourceRequest < Struct.new(
  :api_id,
  :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 1227

class CreateDataSourceRequest < Struct.new(
  :api_id,
  :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 1227

class CreateDataSourceRequest < Struct.new(
  :api_id,
  :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 1227

class CreateDataSourceRequest < Struct.new(
  :api_id,
  :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 1227

class CreateDataSourceRequest < Struct.new(
  :api_id,
  :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

A user-supplied name for the ‘DataSource`.

Returns:

• (String)

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

class CreateDataSourceRequest < Struct.new(
  :api_id,
  :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 1227

class CreateDataSourceRequest < Struct.new(
  :api_id,
  :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 1227

class CreateDataSourceRequest < Struct.new(
  :api_id,
  :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 1227

class CreateDataSourceRequest < Struct.new(
  :api_id,
  :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 ‘DataSource`.

Returns:

• (String)

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

class CreateDataSourceRequest < Struct.new(
  :api_id,
  :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