Module: AWSCDK::AppSync::ISourceAPIAssociation

Includes:
IResource, Interfaces::AWSAppsync::ISourceAPIAssociationRef
Included in:
SourceAPIAssociation
Defined in:
app_sync/i_source_api_association.rb

Overview

Interface for AppSync Source Api Association.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'app_sync/i_source_api_association.rb', line 104

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :source_api_association_ref => { kind: :property, name: "sourceApiAssociationRef", 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 },
    :source_api => { kind: :property, name: "sourceApi", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
  }
end

Instance Method Details

#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:



99
100
101
102
 
# File 'app_sync/i_source_api_association.rb', line 99

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

#association_arn ⇒ String

The association arn.

Returns:

  • (String) 


48
49
50
 
# File 'app_sync/i_source_api_association.rb', line 48

def association_arn()
  jsii_get_property("associationArn")
end

#association_id ⇒ String

The association id.

Returns:

  • (String) 


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

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:



27
28
29
 
# File 'app_sync/i_source_api_association.rb', line 27

def env()
  jsii_get_property("env")
end

#merged_api ⇒ AWSCDK::AppSync::IGraphqlAPI

The merged api in the association.

Returns:



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

def merged_api()
  jsii_get_property("mergedApi")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'app_sync/i_source_api_association.rb', line 12

def node()
  jsii_get_property("node")
end

#source_api ⇒ AWSCDK::AppSync::IGraphqlAPI

The source api in the association.

Returns:



69
70
71
 
# File 'app_sync/i_source_api_association.rb', line 69

def source_api()
  jsii_get_property("sourceApi")
end

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

A reference to a SourceApiAssociation resource.

Returns:



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

def source_api_association_ref()
  jsii_get_property("sourceApiAssociationRef")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'app_sync/i_source_api_association.rb', line 34

def stack()
  jsii_get_property("stack")
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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



80
81
82
83
84
85
 
# File 'app_sync/i_source_api_association.rb', line 80

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