Class: Aws::AppSync::Types::CreateDataSourceRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::AppSync::Types::CreateDataSourceRequest
- Defined in:
- gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb
Overview
When making an API call, you may pass CreateDataSourceRequest data as a hash:
{
api_id: "String", # required
name: "ResourceName", # required
description: "String",
type: "AWS_LAMBDA", # required, accepts AWS_LAMBDA, AMAZON_DYNAMODB, AMAZON_ELASTICSEARCH, NONE, HTTP, RELATIONAL_DATABASE, AMAZON_OPENSEARCH_SERVICE
service_role_arn: "String",
dynamodb_config: {
table_name: "String", # required
aws_region: "String", # required
use_caller_credentials: false,
delta_sync_config: {
base_table_ttl: 1,
delta_sync_table_name: "String",
delta_sync_table_ttl: 1,
},
versioned: false,
},
lambda_config: {
lambda_function_arn: "String", # required
},
elasticsearch_config: {
endpoint: "String", # required
aws_region: "String", # required
},
open_search_service_config: {
endpoint: "String", # required
aws_region: "String", # required
},
http_config: {
endpoint: "String",
authorization_config: {
authorization_type: "AWS_IAM", # required, accepts AWS_IAM
aws_iam_config: {
signing_region: "String",
signing_service_name: "String",
},
},
},
relational_database_config: {
relational_database_source_type: "RDS_HTTP_ENDPOINT", # accepts RDS_HTTP_ENDPOINT
rds_http_endpoint_config: {
aws_region: "String",
db_cluster_identifier: "String",
database_name: "String",
schema: "String",
aws_secret_store_arn: "String",
},
},
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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.
-
#http_config ⇒ Types::HttpDataSourceConfig
HTTP endpoint settings.
-
#lambda_config ⇒ Types::LambdaDataSourceConfig
Lambda settings.
-
#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
.
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 786 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) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
A description of the DataSource
.
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 786 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) SENSITIVE = [] include Aws::Structure end |
#dynamodb_config ⇒ Types::DynamodbDataSourceConfig
Amazon DynamoDB settings.
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 786 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) 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.
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 786 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) SENSITIVE = [] include Aws::Structure end |
#http_config ⇒ Types::HttpDataSourceConfig
HTTP endpoint settings.
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 786 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) SENSITIVE = [] include Aws::Structure end |
#lambda_config ⇒ Types::LambdaDataSourceConfig
Lambda settings.
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 786 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) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
A user-supplied name for the DataSource
.
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 786 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) SENSITIVE = [] include Aws::Structure end |
#open_search_service_config ⇒ Types::OpenSearchServiceDataSourceConfig
Amazon OpenSearch Service settings.
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 786 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) SENSITIVE = [] include Aws::Structure end |
#relational_database_config ⇒ Types::RelationalDatabaseDataSourceConfig
Relational database settings.
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 786 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) 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.
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 786 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) SENSITIVE = [] include Aws::Structure end |
#type ⇒ String
The type of the DataSource
.
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 786 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) SENSITIVE = [] include Aws::Structure end |