Class: AWSCDK::AppSync::OpenSearchDataSourceProps

Inherits:
BackedDataSourceProps
  • Object
show all
Defined in:
app_sync/open_search_data_source_props.rb

Overview

Properties for the OpenSearch Data Source.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api:, description: nil, metrics_config: nil, name: nil, service_role: nil, domain:) ⇒ OpenSearchDataSourceProps

Returns a new instance of OpenSearchDataSourceProps.

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.

  • service_role (AWSCDK::IAM::IRole, nil) (defaults to: nil) —

    The IAM service role to be assumed by AppSync to interact with the data source.

  • domain (AWSCDK::OpenSearchService::IDomain) —

    The OpenSearch domain containing the endpoint for the data source.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'app_sync/open_search_data_source_props.rb', line 13

def initialize(api:, description: nil, metrics_config: nil, name: nil, service_role: nil, domain:)
  @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?
  @service_role = service_role
  Jsii::Type.check_type(@service_role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklSb2xlIn0=")), "serviceRole") unless @service_role.nil?
  @domain = domain
  Jsii::Type.check_type(@domain, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfb3BlbnNlYXJjaHNlcnZpY2UuSURvbWFpbiJ9")), "domain")
end

Instance Attribute Details

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

The API to attach this data source to.

Returns:



31
32
33
 
# File 'app_sync/open_search_data_source_props.rb', line 31

def api
  @api
end

#description ⇒ String? (readonly)

Note:

Default: - None

the description of the data source.

Returns:

  • (String, nil) 


36
37
38
 
# File 'app_sync/open_search_data_source_props.rb', line 36

def description
  @description
end

#domain ⇒ AWSCDK::OpenSearchService::IDomain (readonly)

The OpenSearch domain containing the endpoint for the data source.

Returns:



55
56
57
 
# File 'app_sync/open_search_data_source_props.rb', line 55

def domain
  @domain
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:



41
42
43
 
# File 'app_sync/open_search_data_source_props.rb', line 41

def metrics_config
  @metrics_config
end

#name ⇒ String? (readonly)

Note:

Default: - id of data source

The name of the data source.

Returns:

  • (String, nil) 


46
47
48
 
# File 'app_sync/open_search_data_source_props.rb', line 46

def name
  @name
end

#service_role ⇒ AWSCDK::IAM::IRole? (readonly)

Note:

Default: - Create a new role

The IAM service role to be assumed by AppSync to interact with the data source.

Returns:



51
52
53
 
# File 'app_sync/open_search_data_source_props.rb', line 51

def service_role
  @service_role
end

Class Method Details

.jsii_properties ⇒ Object 



57
58
59
60
61
62
63
64
65
66
 
# File 'app_sync/open_search_data_source_props.rb', line 57

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

Instance Method Details

#to_jsii ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'app_sync/open_search_data_source_props.rb', line 68

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