Class: AWSCDK::AppSync::CfnSourceAPIAssociationProps

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

Overview

Properties for defining a CfnSourceApiAssociation.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(description: nil, merged_api_identifier: nil, source_api_association_config: nil, source_api_identifier: nil) ⇒ CfnSourceAPIAssociationProps

Returns a new instance of CfnSourceAPIAssociationProps.

Parameters:

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

    The description field of the association configuration.

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

    The identifier of the AppSync Merged API.

  • source_api_association_config (AWSCDK::IResolvable, AWSCDK::AppSync::CfnSourceAPIAssociation::SourceAPIAssociationConfigProperty, nil) (defaults to: nil) —

    The SourceApiAssociationConfig object data.

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

    The identifier of the AppSync Source API.



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

def initialize(description: nil, merged_api_identifier: nil, source_api_association_config: nil, source_api_identifier: nil)
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @merged_api_identifier = merged_api_identifier
  Jsii::Type.check_type(@merged_api_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mergedApiIdentifier") unless @merged_api_identifier.nil?
  @source_api_association_config = source_api_association_config.is_a?(Hash) ? ::AWSCDK::AppSync::CfnSourceAPIAssociation::SourceAPIAssociationConfigProperty.new(**source_api_association_config.transform_keys(&:to_sym)) : source_api_association_config
  Jsii::Type.check_type(@source_api_association_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzeW5jLkNmblNvdXJjZUFwaUFzc29jaWF0aW9uLlNvdXJjZUFwaUFzc29jaWF0aW9uQ29uZmlnUHJvcGVydHkifV19fQ==")), "sourceApiAssociationConfig") unless @source_api_association_config.nil?
  @source_api_identifier = source_api_identifier
  Jsii::Type.check_type(@source_api_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceApiIdentifier") unless @source_api_identifier.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

The description field of the association configuration.

Returns:

  • (String, nil)

See Also:



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

def description
  @description
end

#merged_api_identifier ⇒ String? (readonly)

The identifier of the AppSync Merged API.

This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

Returns:

  • (String, nil)

See Also:



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

def merged_api_identifier
  @merged_api_identifier
end

#source_api_association_config ⇒ AWSCDK::IResolvable, ... (readonly)

The SourceApiAssociationConfig object data.

Returns:

See Also:



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

def source_api_association_config
  @source_api_association_config
end

#source_api_identifier ⇒ String? (readonly)

The identifier of the AppSync Source API.

This is generated by the AppSync service. In most cases, source APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.

Returns:

  • (String, nil)

See Also:



47
48
49
 
# File 'app_sync/cfn_source_api_association_props.rb', line 47

def source_api_identifier
  @source_api_identifier
end

Class Method Details

.jsii_properties ⇒ Object 



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

def self.jsii_properties
  {
    :description => "description",
    :merged_api_identifier => "mergedApiIdentifier",
    :source_api_association_config => "sourceApiAssociationConfig",
    :source_api_identifier => "sourceApiIdentifier",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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

def to_jsii
  result = {}
  result.merge!({
    "description" => @description,
    "mergedApiIdentifier" => @merged_api_identifier,
    "sourceApiAssociationConfig" => @source_api_association_config,
    "sourceApiIdentifier" => @source_api_identifier,
  })
  result.compact
end