Class: AWSCDK::AppSync::SourceAPIAssociation

Inherits:
Resource
  • Object
show all
Includes:
ISourceAPIAssociation
Defined in:
app_sync/source_api_association.rb

Overview

AppSync SourceApiAssociation which associates an AppSync source API to an AppSync Merged API.

The initial creation of the SourceApiAssociation merges the source API into the Merged API schema.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ SourceAPIAssociation

Returns a new instance of SourceAPIAssociation.

Parameters:



14
15
16
17
18
19
20
 
# File 'app_sync/source_api_association.rb', line 14

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::AppSync::SourceAPIAssociationProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5Tb3VyY2VBcGlBc3NvY2lhdGlvblByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_source_api_association_attributes(scope, id, attrs) ⇒ AWSCDK::AppSync::ISourceAPIAssociation

Import Appsync Source Api Association from source API, merged api, and merge type.

Parameters:

Returns:



51
52
53
54
55
56
57
 
# File 'app_sync/source_api_association.rb', line 51

def self.from_source_api_association_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::AppSync::SourceAPIAssociationAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5Tb3VyY2VBcGlBc3NvY2lhdGlvbkF0dHJpYnV0ZXMifQ==")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appsync.SourceApiAssociation", "fromSourceApiAssociationAttributes", [scope, id, attrs])
end

.jsii_overridable_methods ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'app_sync/source_api_association.rb', line 22

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :association => { kind: :property, name: "association", is_optional: false },
    :association_arn => { kind: :property, name: "associationArn", is_optional: false },
    :association_id => { kind: :property, name: "associationId", is_optional: false },
    :merged_api => { kind: :property, name: "mergedApi", is_optional: false },
    :merge_type => { kind: :property, name: "mergeType", is_optional: false },
    :source_api => { kind: :property, name: "sourceApi", is_optional: false },
    :source_api_association_ref => { kind: :property, name: "sourceApiAssociationRef", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


105
106
107
 
# File 'app_sync/source_api_association.rb', line 105

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_appsync.SourceApiAssociation", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



191
192
193
194
 
# File 'app_sync/source_api_association.rb', line 191

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



208
209
210
211
 
# File 'app_sync/source_api_association.rb', line 208

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#association ⇒ AWSCDK::AppSync::CfnSourceAPIAssociation

The underlying CFN source api association resource.

Returns:



112
113
114
 
# File 'app_sync/source_api_association.rb', line 112

def association()
  jsii_get_property("association")
end

#association_arn ⇒ String

The association arn.

Returns:

  • (String) 


119
120
121
 
# File 'app_sync/source_api_association.rb', line 119

def association_arn()
  jsii_get_property("associationArn")
end

#association_id ⇒ String

The association id.

Returns:

  • (String) 


126
127
128
 
# File 'app_sync/source_api_association.rb', line 126

def association_id()
  jsii_get_property("associationId")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



77
78
79
 
# File 'app_sync/source_api_association.rb', line 77

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


214
215
216
 
# File 'app_sync/source_api_association.rb', line 214

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


228
229
230
231
232
233
 
# File 'app_sync/source_api_association.rb', line 228

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


243
244
245
246
 
# File 'app_sync/source_api_association.rb', line 243

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#merge_type ⇒ AWSCDK::AppSync::MergeType

The merge type for the source api association.

Returns:



140
141
142
 
# File 'app_sync/source_api_association.rb', line 140

def merge_type()
  jsii_get_property("mergeType")
end

#merged_api ⇒ AWSCDK::AppSync::IGraphqlAPI

The merged api in the association.

Returns:



133
134
135
 
# File 'app_sync/source_api_association.rb', line 133

def merged_api()
  jsii_get_property("mergedApi")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


62
63
64
 
# File 'app_sync/source_api_association.rb', line 62

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


91
92
93
 
# File 'app_sync/source_api_association.rb', line 91

def physical_name()
  jsii_get_property("physicalName")
end

#source_api ⇒ AWSCDK::AppSync::IGraphqlAPI

The source api in the association.

Returns:



147
148
149
 
# File 'app_sync/source_api_association.rb', line 147

def source_api()
  jsii_get_property("sourceApi")
end

#source_api_association_ref ⇒ AWSCDK::Interfaces::AWSAppsync::SourceAPIAssociationReference

A reference to a SourceApiAssociation resource.

Returns:



154
155
156
 
# File 'app_sync/source_api_association.rb', line 154

def source_api_association_ref()
  jsii_get_property("sourceApiAssociationRef")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



98
99
100
 
# File 'app_sync/source_api_association.rb', line 98

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


161
162
163
 
# File 'app_sync/source_api_association.rb', line 161

def to_string()
  jsii_call_method("toString", [])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


174
175
176
177
178
179
 
# File 'app_sync/source_api_association.rb', line 174

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end