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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_idString

The API ID for the GraphQL API for the DataSource.

Returns:

  • (String)


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 896

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

#descriptionString

A description of the DataSource.

Returns:

  • (String)


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 896

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_configTypes::DynamodbDataSourceConfig

Amazon DynamoDB settings.



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 896

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_configTypes::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.



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 896

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_configTypes::EventBridgeDataSourceConfig

Amazon EventBridge settings.



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 896

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_configTypes::HttpDataSourceConfig

HTTP endpoint settings.



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 896

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_configTypes::LambdaDataSourceConfig

Lambda settings.



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 896

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


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 896

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

#nameString

A user-supplied name for the DataSource.

Returns:

  • (String)


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 896

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_configTypes::OpenSearchServiceDataSourceConfig

Amazon OpenSearch Service settings.



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 896

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_configTypes::RelationalDatabaseDataSourceConfig

Relational database settings.



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 896

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


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 896

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

#typeString

The type of the DataSource.

Returns:

  • (String)


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 896

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