Class: AWSCDK::AppSync::BaseDataSourceProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_sync/base_data_source_props.rb

Overview

Base properties for an AppSync datasource.

Direct Known Subclasses

BackedDataSourceProps, NoneDataSourceProps

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api:, description: nil, metrics_config: nil, name: nil) ⇒ BaseDataSourceProps

Returns a new instance of BaseDataSourceProps.

Parameters:

  • api (AWSCDK::Interfaces::AWSAppsync::IGraphQLAPIRef) —

    The API to attach this data source to.

  • description (String, nil) (defaults to: nil) —

    the description of the data source.

  • metrics_config (AWSCDK::AppSync::DataSourceMetricsConfig, nil) (defaults to: nil) —

    Whether to enable enhanced metrics of the data source Value will be ignored, if enhancedMetricsConfig.dataSourceLevelMetricsBehavior on AppSync GraphqlApi construct is set to FULL_REQUEST_DATA_SOURCE_METRICS.

  • name (String, nil) (defaults to: nil) —

    The name of the data source.



11
12
13
14
15
16
17
18
19
20
 
# File 'app_sync/base_data_source_props.rb', line 11

def initialize(api:, description: nil, metrics_config: nil, name: nil)
  @api = api
  Jsii::Type.check_type(@api, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcHBzeW5jLklHcmFwaFFMQXBpUmVmIn0=")), "api")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @metrics_config = metrics_config
  Jsii::Type.check_type(@metrics_config, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5EYXRhU291cmNlTWV0cmljc0NvbmZpZyJ9")), "metricsConfig") unless @metrics_config.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
end

Instance Attribute Details

#api ⇒ AWSCDK::Interfaces::AWSAppsync::IGraphQLAPIRef (readonly)

The API to attach this data source to.

Returns:



25
26
27
 
# File 'app_sync/base_data_source_props.rb', line 25

def api
  @api
end

#description ⇒ String? (readonly)

Note:

Default: - None

the description of the data source.

Returns:

  • (String, nil) 


30
31
32
 
# File 'app_sync/base_data_source_props.rb', line 30

def description
  @description
end

#metrics_config ⇒ AWSCDK::AppSync::DataSourceMetricsConfig? (readonly)

Note:

Default: - no metrics configuration

Whether to enable enhanced metrics of the data source Value will be ignored, if enhancedMetricsConfig.dataSourceLevelMetricsBehavior on AppSync GraphqlApi construct is set to FULL_REQUEST_DATA_SOURCE_METRICS.

Returns:



35
36
37
 
# File 'app_sync/base_data_source_props.rb', line 35

def metrics_config
  @metrics_config
end

#name ⇒ String? (readonly)

Note:

Default: - id of data source

The name of the data source.

Returns:

  • (String, nil) 


40
41
42
 
# File 'app_sync/base_data_source_props.rb', line 40

def name
  @name
end

Class Method Details

.jsii_properties ⇒ Object 



42
43
44
45
46
47
48
49
 
# File 'app_sync/base_data_source_props.rb', line 42

def self.jsii_properties
  {
    :api => "api",
    :description => "description",
    :metrics_config => "metricsConfig",
    :name => "name",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



51
52
53
54
55
56
57
58
59
60
 
# File 'app_sync/base_data_source_props.rb', line 51

def to_jsii
  result = {}
  result.merge!({
    "api" => @api,
    "description" => @description,
    "metricsConfig" => @metrics_config,
    "name" => @name,
  })
  result.compact
end