Class: AWSCDK::AppSync::AppSyncDataSourceOptions

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

Overview

Optional configuration for data sources.

Direct Known Subclasses

AppSyncHttpDataSourceOptions

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(description: nil, name: nil) ⇒ AppSyncDataSourceOptions

Returns a new instance of AppSyncDataSourceOptions.

Parameters:

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

    The description of the data source.

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

    The name of the data source, overrides the id given by CDK.



9
10
11
12
13
14
 
# File 'app_sync/app_sync_data_source_options.rb', line 9

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

Instance Attribute Details

#description ⇒ String? (readonly)

Note:

Default: - No description

The description of the data source.

Returns:

  • (String, nil) 


20
21
22
 
# File 'app_sync/app_sync_data_source_options.rb', line 20

def description
  @description
end

#name ⇒ String? (readonly)

Note:

Default: - generated by CDK given the id

The name of the data source, overrides the id given by CDK.

Returns:

  • (String, nil) 


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

def name
  @name
end

Class Method Details

.jsii_properties ⇒ Object 



27
28
29
30
31
32
 
# File 'app_sync/app_sync_data_source_options.rb', line 27

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

Instance Method Details

#to_jsii ⇒ Object 



34
35
36
37
38
39
40
41
 
# File 'app_sync/app_sync_data_source_options.rb', line 34

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