Module: AWSCDK::AppSync::IGraphqlAPI

Includes:
IResource, Interfaces::AWSAppsync::IGraphQLAPIRef
Included in:
GraphqlAPIBase
Defined in:
app_sync/i_graphql_api.rb

Overview

Interface for GraphQL.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'app_sync/i_graphql_api.rb', line 322

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 },
    :graph_ql_api_ref => { kind: :property, name: "graphQlApiRef", is_optional: false },
    :api_id => { kind: :property, name: "apiId", is_optional: false },
    :arn => { kind: :property, name: "arn", is_optional: false },
    :graph_ql_endpoint_arn => { kind: :property, name: "graphQLEndpointArn", is_optional: false },
    :modes => { kind: :property, name: "modes", is_optional: false },
    :visibility => { kind: :property, name: "visibility", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :add_dynamo_db_data_source => { kind: :method, name: "addDynamoDbDataSource", is_optional: false },
    :add_elasticsearch_data_source => { kind: :method, name: "addElasticsearchDataSource", is_optional: false },
    :add_event_bridge_data_source => { kind: :method, name: "addEventBridgeDataSource", is_optional: false },
    :add_http_data_source => { kind: :method, name: "addHttpDataSource", is_optional: false },
    :add_lambda_data_source => { kind: :method, name: "addLambdaDataSource", is_optional: false },
    :add_none_data_source => { kind: :method, name: "addNoneDataSource", is_optional: false },
    :add_open_search_data_source => { kind: :method, name: "addOpenSearchDataSource", is_optional: false },
    :add_rds_data_source => { kind: :method, name: "addRdsDataSource", is_optional: false },
    :add_rds_data_source_v2 => { kind: :method, name: "addRdsDataSourceV2", is_optional: false },
    :add_schema_dependency => { kind: :method, name: "addSchemaDependency", is_optional: false },
    :create_resolver => { kind: :method, name: "createResolver", is_optional: false },
    :grant => { kind: :method, name: "grant", is_optional: false },
    :grant_mutation => { kind: :method, name: "grantMutation", is_optional: false },
    :grant_query => { kind: :method, name: "grantQuery", is_optional: false },
    :grant_subscription => { kind: :method, name: "grantSubscription", is_optional: false },
  }
end

Instance Method Details

#add_dynamo_db_data_source(id, table, options = nil) ⇒ AWSCDK::AppSync::DynamoDBDataSource

add a new DynamoDB data source to this API.

Parameters:

Returns:



117
118
119
120
121
122
123
 
# File 'app_sync/i_graphql_api.rb', line 117

def add_dynamo_db_data_source(id, table, options = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(table, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZHluYW1vZGIuSVRhYmxlIn0=")), "table")
  options = options.is_a?(Hash) ? ::AWSCDK::AppSync::DataSourceOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5EYXRhU291cmNlT3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("addDynamoDbDataSource", [id, table, options])
end

#add_elasticsearch_data_source(id, domain, options = nil) ⇒ AWSCDK::AppSync::ElasticsearchDataSource

Deprecated.
  • use addOpenSearchDataSource

add a new elasticsearch data source to this API.

Parameters:

Returns:



132
133
134
135
136
137
138
 
# File 'app_sync/i_graphql_api.rb', line 132

def add_elasticsearch_data_source(id, domain, options = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(domain, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY3NlYXJjaC5JRG9tYWluIn0=")), "domain")
  options = options.is_a?(Hash) ? ::AWSCDK::AppSync::DataSourceOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5EYXRhU291cmNlT3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("addElasticsearchDataSource", [id, domain, options])
end

#add_event_bridge_data_source(id, event_bus, options = nil) ⇒ AWSCDK::AppSync::EventBridgeDataSource

Add an EventBridge data source to this api.

Parameters:

Returns:



146
147
148
149
150
151
152
 
# File 'app_sync/i_graphql_api.rb', line 146

def add_event_bridge_data_source(id, event_bus, options = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(event_bus, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZXZlbnRzLklFdmVudEJ1cyJ9")), "eventBus")
  options = options.is_a?(Hash) ? ::AWSCDK::AppSync::DataSourceOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5EYXRhU291cmNlT3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("addEventBridgeDataSource", [id, event_bus, options])
end

#add_http_data_source(id, endpoint, options = nil) ⇒ AWSCDK::AppSync::HttpDataSource

add a new http data source to this API.

Parameters:

  • id (String) —

    The data source's id.

  • endpoint (String) —

    The http endpoint.

  • options (AWSCDK::AppSync::HttpDataSourceOptions, nil) (defaults to: nil) —

    The optional configuration for this data source.

Returns:



160
161
162
163
164
165
166
 
# File 'app_sync/i_graphql_api.rb', line 160

def add_http_data_source(id, endpoint, options = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(endpoint, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endpoint")
  options = options.is_a?(Hash) ? ::AWSCDK::AppSync::HttpDataSourceOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5IdHRwRGF0YVNvdXJjZU9wdGlvbnMifQ==")), "options") unless options.nil?
  jsii_call_method("addHttpDataSource", [id, endpoint, options])
end

#add_lambda_data_source(id, lambda_function, options = nil) ⇒ AWSCDK::AppSync::LambdaDataSource

add a new Lambda data source to this API.

Parameters:

Returns:



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

def add_lambda_data_source(id, lambda_function, options = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(lambda_function, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLklGdW5jdGlvbiJ9")), "lambdaFunction")
  options = options.is_a?(Hash) ? ::AWSCDK::AppSync::DataSourceOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5EYXRhU291cmNlT3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("addLambdaDataSource", [id, lambda_function, options])
end

#add_none_data_source(id, options = nil) ⇒ AWSCDK::AppSync::NoneDataSource

add a new dummy data source to this API.

Useful for pipeline resolvers and for backend changes that don't require a data source.

Parameters:

Returns:



190
191
192
193
194
195
 
# File 'app_sync/i_graphql_api.rb', line 190

def add_none_data_source(id, options = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::AppSync::DataSourceOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5EYXRhU291cmNlT3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("addNoneDataSource", [id, options])
end

#add_open_search_data_source(id, domain, options = nil) ⇒ AWSCDK::AppSync::OpenSearchDataSource

Add a new OpenSearch data source to this API.

Parameters:

Returns:



203
204
205
206
207
208
209
 
# File 'app_sync/i_graphql_api.rb', line 203

def add_open_search_data_source(id, domain, options = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(domain, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfb3BlbnNlYXJjaHNlcnZpY2UuSURvbWFpbiJ9")), "domain")
  options = options.is_a?(Hash) ? ::AWSCDK::AppSync::DataSourceOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5EYXRhU291cmNlT3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("addOpenSearchDataSource", [id, domain, options])
end

#add_rds_data_source(id, serverless_cluster, secret_store, database_name = nil, options = nil) ⇒ AWSCDK::AppSync::RDSDataSource

add a new Rds data source to this API.

Parameters:

  • id (String) —

    The data source's id.

  • serverless_cluster (AWSCDK::RDS::IServerlessCluster) —

    The serverless cluster to interact with this data source.

  • secret_store (AWSCDK::SecretsManager::ISecret) —

    The secret store that contains the username and password for the serverless cluster.

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

    The optional name of the database to use within the cluster.

  • options (AWSCDK::AppSync::DataSourceOptions, nil) (defaults to: nil) —

    The optional configuration for this data source.

Returns:



219
220
221
222
223
224
225
226
227
 
# File 'app_sync/i_graphql_api.rb', line 219

def add_rds_data_source(id, serverless_cluster, secret_store, database_name = nil, options = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(serverless_cluster, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLklTZXJ2ZXJsZXNzQ2x1c3RlciJ9")), "serverlessCluster")
  Jsii::Type.check_type(secret_store, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VjcmV0c21hbmFnZXIuSVNlY3JldCJ9")), "secretStore")
  Jsii::Type.check_type(database_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "databaseName") unless database_name.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::AppSync::DataSourceOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5EYXRhU291cmNlT3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("addRdsDataSource", [id, serverless_cluster, secret_store, database_name, options])
end

#add_rds_data_source_v2(id, serverless_cluster, secret_store, database_name = nil, options = nil) ⇒ AWSCDK::AppSync::RDSDataSource

add a new Rds Serverless V2 data source to this API.

Parameters:

  • id (String) —

    The data source's id.

  • serverless_cluster (AWSCDK::RDS::IDatabaseCluster) —

    The serverless V2 cluster to interact with this data source.

  • secret_store (AWSCDK::SecretsManager::ISecret) —

    The secret store that contains the username and password for the serverless cluster.

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

    The optional name of the database to use within the cluster.

  • options (AWSCDK::AppSync::DataSourceOptions, nil) (defaults to: nil) —

    The optional configuration for this data source.

Returns:



237
238
239
240
241
242
243
244
245
 
# File 'app_sync/i_graphql_api.rb', line 237

def add_rds_data_source_v2(id, serverless_cluster, secret_store, database_name = nil, options = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(serverless_cluster, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLklEYXRhYmFzZUNsdXN0ZXIifQ==")), "serverlessCluster")
  Jsii::Type.check_type(secret_store, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VjcmV0c21hbmFnZXIuSVNlY3JldCJ9")), "secretStore")
  Jsii::Type.check_type(database_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "databaseName") unless database_name.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::AppSync::DataSourceOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5EYXRhU291cmNlT3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("addRdsDataSourceV2", [id, serverless_cluster, secret_store, database_name, options])
end

#add_schema_dependency(construct) ⇒ Boolean

Add schema dependency if not imported.

Parameters:

Returns:

  • (Boolean) 


251
252
253
254
 
# File 'app_sync/i_graphql_api.rb', line 251

def add_schema_dependency(construct)
  Jsii::Type.check_type(construct, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "construct")
  jsii_call_method("addSchemaDependency", [construct])
end

#api_id ⇒ String

a unique AWS AppSync GraphQL API identifier i.e. 'lxz775lwdrgcndgz3nurvac7oa'.

Returns:

  • (String) 


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

def api_id()
  jsii_get_property("apiId")
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:



106
107
108
109
 
# File 'app_sync/i_graphql_api.rb', line 106

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

#arn ⇒ String

the ARN of the API.

Returns:

  • (String) 


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

def arn()
  jsii_get_property("arn")
end

#create_resolver(id, props) ⇒ AWSCDK::AppSync::Resolver

creates a new resolver for this datasource and API using the given properties.

Parameters:

Returns:



261
262
263
264
265
266
 
# File 'app_sync/i_graphql_api.rb', line 261

def create_resolver(id, props)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  props = props.is_a?(Hash) ? ::AWSCDK::AppSync::ExtendedResolverProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5FeHRlbmRlZFJlc29sdmVyUHJvcHMifQ==")), "props")
  jsii_call_method("createResolver", [id, props])
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_graphql_api.rb', line 27

def env()
  jsii_get_property("env")
end

#grant(grantee, resources, *actions) ⇒ AWSCDK::IAM::Grant

Adds an IAM policy statement associated with this GraphQLApi to an IAM principal's policy.

Parameters:

  • grantee (AWSCDK::IAM::IGrantable) —

    The principal.

  • resources (AWSCDK::AppSync::IAMResource) —

    The set of resources to allow (i.e. ...:[region]:[accountId]:apis/GraphQLId/...).

  • actions (Array<String>) —

    The actions that should be granted to the principal (i.e. appsync:graphql ).

Returns:



274
275
276
277
278
279
280
281
 
# File 'app_sync/i_graphql_api.rb', line 274

def grant(grantee, resources, *actions)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  Jsii::Type.check_type(resources, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5JYW1SZXNvdXJjZSJ9")), "resources")
  actions.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actions[#{index}]")
  end
  jsii_call_method("grant", [grantee, resources, *actions])
end

#grant_mutation(grantee, *fields) ⇒ AWSCDK::IAM::Grant

Adds an IAM policy statement for Mutation access to this GraphQLApi to an IAM principal's policy.

Parameters:

  • grantee (AWSCDK::IAM::IGrantable) —

    The principal.

  • fields (Array<String>) —

    The fields to grant access to that are Mutations (leave blank for all).

Returns:



288
289
290
291
292
293
294
 
# File 'app_sync/i_graphql_api.rb', line 288

def grant_mutation(grantee, *fields)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  fields.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fields[#{index}]")
  end
  jsii_call_method("grantMutation", [grantee, *fields])
end

#grant_query(grantee, *fields) ⇒ AWSCDK::IAM::Grant

Adds an IAM policy statement for Query access to this GraphQLApi to an IAM principal's policy.

Parameters:

  • grantee (AWSCDK::IAM::IGrantable) —

    The principal.

  • fields (Array<String>) —

    The fields to grant access to that are Queries (leave blank for all).

Returns:



301
302
303
304
305
306
307
 
# File 'app_sync/i_graphql_api.rb', line 301

def grant_query(grantee, *fields)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  fields.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fields[#{index}]")
  end
  jsii_call_method("grantQuery", [grantee, *fields])
end

#grant_subscription(grantee, *fields) ⇒ AWSCDK::IAM::Grant

Adds an IAM policy statement for Subscription access to this GraphQLApi to an IAM principal's policy.

Parameters:

  • grantee (AWSCDK::IAM::IGrantable) —

    The principal.

  • fields (Array<String>) —

    The fields to grant access to that are Subscriptions (leave blank for all).

Returns:



314
315
316
317
318
319
320
 
# File 'app_sync/i_graphql_api.rb', line 314

def grant_subscription(grantee, *fields)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  fields.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fields[#{index}]")
  end
  jsii_call_method("grantSubscription", [grantee, *fields])
end

#graph_ql_api_ref ⇒ AWSCDK::Interfaces::AWSAppsync::GraphQLAPIReference

A reference to a GraphQLApi resource.

Returns:



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

def graph_ql_api_ref()
  jsii_get_property("graphQlApiRef")
end

#graph_ql_endpoint_arn ⇒ String

The GraphQL endpoint ARN.

Returns:

  • (String) 


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

def graph_ql_endpoint_arn()
  jsii_get_property("graphQLEndpointArn")
end

#modes ⇒ Array<AWSCDK::AppSync::AuthorizationType>

The Authorization Types for this GraphQL Api.

Returns:



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

def modes()
  jsii_get_property("modes")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


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

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



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

def stack()
  jsii_get_property("stack")
end

#visibility ⇒ AWSCDK::AppSync::Visibility

the visibility of the API.

Returns:



76
77
78
 
# File 'app_sync/i_graphql_api.rb', line 76

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



87
88
89
90
91
92
 
# File 'app_sync/i_graphql_api.rb', line 87

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