You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

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
  service_role_arn: "String",
  dynamodb_config: {
    table_name: "String", # required
    aws_region: "String", # required
    use_caller_credentials: false,
  },
  lambda_config: {
    lambda_function_arn: "String", # required
  },
  elasticsearch_config: {
    endpoint: "String", # required
    aws_region: "String", # required
  },
  http_config: {
    endpoint: "String",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#api_idString

The API ID for the GraphQL API for the DataSource.

Returns:

  • (String)


181
182
183
184
185
186
187
188
189
190
191
192
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 181

class CreateDataSourceRequest < Struct.new(
  :api_id,
  :name,
  :description,
  :type,
  :service_role_arn,
  :dynamodb_config,
  :lambda_config,
  :elasticsearch_config,
  :http_config)
  include Aws::Structure
end

#descriptionString

A description of the DataSource.

Returns:

  • (String)


181
182
183
184
185
186
187
188
189
190
191
192
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 181

class CreateDataSourceRequest < Struct.new(
  :api_id,
  :name,
  :description,
  :type,
  :service_role_arn,
  :dynamodb_config,
  :lambda_config,
  :elasticsearch_config,
  :http_config)
  include Aws::Structure
end

#dynamodb_configTypes::DynamodbDataSourceConfig

DynamoDB settings.



181
182
183
184
185
186
187
188
189
190
191
192
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 181

class CreateDataSourceRequest < Struct.new(
  :api_id,
  :name,
  :description,
  :type,
  :service_role_arn,
  :dynamodb_config,
  :lambda_config,
  :elasticsearch_config,
  :http_config)
  include Aws::Structure
end

#elasticsearch_configTypes::ElasticsearchDataSourceConfig

Amazon Elasticsearch settings.



181
182
183
184
185
186
187
188
189
190
191
192
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 181

class CreateDataSourceRequest < Struct.new(
  :api_id,
  :name,
  :description,
  :type,
  :service_role_arn,
  :dynamodb_config,
  :lambda_config,
  :elasticsearch_config,
  :http_config)
  include Aws::Structure
end

#http_configTypes::HttpDataSourceConfig

Http endpoint settings.



181
182
183
184
185
186
187
188
189
190
191
192
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 181

class CreateDataSourceRequest < Struct.new(
  :api_id,
  :name,
  :description,
  :type,
  :service_role_arn,
  :dynamodb_config,
  :lambda_config,
  :elasticsearch_config,
  :http_config)
  include Aws::Structure
end

#lambda_configTypes::LambdaDataSourceConfig

AWS Lambda settings.



181
182
183
184
185
186
187
188
189
190
191
192
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 181

class CreateDataSourceRequest < Struct.new(
  :api_id,
  :name,
  :description,
  :type,
  :service_role_arn,
  :dynamodb_config,
  :lambda_config,
  :elasticsearch_config,
  :http_config)
  include Aws::Structure
end

#nameString

A user-supplied name for the DataSource.

Returns:

  • (String)


181
182
183
184
185
186
187
188
189
190
191
192
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 181

class CreateDataSourceRequest < Struct.new(
  :api_id,
  :name,
  :description,
  :type,
  :service_role_arn,
  :dynamodb_config,
  :lambda_config,
  :elasticsearch_config,
  :http_config)
  include Aws::Structure
end

#service_role_arnString

The IAM service role ARN for the data source. The system assumes this role when accessing the data source.

Returns:

  • (String)


181
182
183
184
185
186
187
188
189
190
191
192
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 181

class CreateDataSourceRequest < Struct.new(
  :api_id,
  :name,
  :description,
  :type,
  :service_role_arn,
  :dynamodb_config,
  :lambda_config,
  :elasticsearch_config,
  :http_config)
  include Aws::Structure
end

#typeString

The type of the DataSource.

Returns:

  • (String)


181
182
183
184
185
186
187
188
189
190
191
192
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 181

class CreateDataSourceRequest < Struct.new(
  :api_id,
  :name,
  :description,
  :type,
  :service_role_arn,
  :dynamodb_config,
  :lambda_config,
  :elasticsearch_config,
  :http_config)
  include Aws::Structure
end