Class: AWSCDK::AppSync::SourceAPIAssociationProps

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

Overview

Properties for SourceApiAssociation which associates an AppSync Source API with an AppSync Merged API.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(merged_api:, merged_api_execution_role:, source_api:, description: nil, merge_type: nil) ⇒ SourceAPIAssociationProps

Returns a new instance of SourceAPIAssociationProps.

Parameters:



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'app_sync/source_api_association_props.rb', line 12

def initialize(merged_api:, merged_api_execution_role:, source_api:, description: nil, merge_type: nil)
  @merged_api = merged_api
  Jsii::Type.check_type(@merged_api, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5JR3JhcGhxbEFwaSJ9")), "mergedApi")
  @merged_api_execution_role = merged_api_execution_role
  Jsii::Type.check_type(@merged_api_execution_role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklSb2xlIn0=")), "mergedApiExecutionRole")
  @source_api = source_api
  Jsii::Type.check_type(@source_api, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5JR3JhcGhxbEFwaSJ9")), "sourceApi")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @merge_type = merge_type
  Jsii::Type.check_type(@merge_type, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5NZXJnZVR5cGUifQ==")), "mergeType") unless @merge_type.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

Note:

Default: - None

The description of the source api association.

Returns:

  • (String, nil) 


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

def description
  @description
end

#merge_type ⇒ AWSCDK::AppSync::MergeType? (readonly)

Note:

Default: - AUTO_MERGE

The merge type for the source.

Returns:



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

def merge_type
  @merge_type
end

#merged_api ⇒ AWSCDK::AppSync::IGraphqlAPI (readonly)

The merged api to associate.

Returns:



28
29
30
 
# File 'app_sync/source_api_association_props.rb', line 28

def merged_api
  @merged_api
end

#merged_api_execution_role ⇒ AWSCDK::IAM::IRole (readonly)

The merged api execution role for adding the access policy for the source api.

Returns:



32
33
34
 
# File 'app_sync/source_api_association_props.rb', line 32

def merged_api_execution_role
  @merged_api_execution_role
end

#source_api ⇒ AWSCDK::AppSync::IGraphqlAPI (readonly)

The source api to associate.

Returns:



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

def source_api
  @source_api
end

Class Method Details

.jsii_properties ⇒ Object 



48
49
50
51
52
53
54
55
56
 
# File 'app_sync/source_api_association_props.rb', line 48

def self.jsii_properties
  {
    :merged_api => "mergedApi",
    :merged_api_execution_role => "mergedApiExecutionRole",
    :source_api => "sourceApi",
    :description => "description",
    :merge_type => "mergeType",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
 
# File 'app_sync/source_api_association_props.rb', line 58

def to_jsii
  result = {}
  result.merge!({
    "mergedApi" => @merged_api,
    "mergedApiExecutionRole" => @merged_api_execution_role,
    "sourceApi" => @source_api,
    "description" => @description,
    "mergeType" => @merge_type,
  })
  result.compact
end