Class: AWSCDK::AppSync::GraphqlAPIBase

Inherits:
Resource
  • Object
show all
Includes:
IGraphqlAPI
Defined in:
app_sync/graphql_api_base.rb

Overview

Base Class for GraphQL API.

Direct Known Subclasses

GraphqlAPI

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ GraphqlAPIBase

Returns a new instance of GraphqlAPIBase.

Parameters:



12
13
14
15
16
17
18
 
# File 'app_sync/graphql_api_base.rb', line 12

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::ResourceProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvdXJjZVByb3BzIn0=")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'app_sync/graphql_api_base.rb', line 20

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 },
    :api_id => { kind: :property, name: "apiId", is_optional: false },
    :arn => { kind: :property, name: "arn", is_optional: false },
    :graph_ql_api_ref => { kind: :property, name: "graphQlApiRef", 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 },
    :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 },
    :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:



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

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:



253
254
255
256
257
258
259
 
# File 'app_sync/graphql_api_base.rb', line 253

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:



267
268
269
270
271
272
273
 
# File 'app_sync/graphql_api_base.rb', line 267

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:



281
282
283
284
285
286
287
 
# File 'app_sync/graphql_api_base.rb', line 281

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:



295
296
297
298
299
300
301
 
# File 'app_sync/graphql_api_base.rb', line 295

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:



311
312
313
314
315
316
 
# File 'app_sync/graphql_api_base.rb', line 311

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:



324
325
326
327
328
329
330
 
# File 'app_sync/graphql_api_base.rb', line 324

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:



340
341
342
343
344
345
346
347
348
 
# File 'app_sync/graphql_api_base.rb', line 340

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



358
359
360
361
362
363
364
365
366
 
# File 'app_sync/graphql_api_base.rb', line 358

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) 


372
373
374
375
 
# File 'app_sync/graphql_api_base.rb', line 372

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) 


103
104
105
 
# File 'app_sync/graphql_api_base.rb', line 103

def api_id()
  jsii_get_property("apiId")
end

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



175
176
177
178
 
# File 'app_sync/graphql_api_base.rb', line 175

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:



192
193
194
195
 
# File 'app_sync/graphql_api_base.rb', line 192

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) 


110
111
112
 
# File 'app_sync/graphql_api_base.rb', line 110

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:



382
383
384
385
386
387
 
# File 'app_sync/graphql_api_base.rb', line 382

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:



75
76
77
 
# File 'app_sync/graphql_api_base.rb', line 75

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


198
199
200
 
# File 'app_sync/graphql_api_base.rb', line 198

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) 


212
213
214
215
216
217
 
# File 'app_sync/graphql_api_base.rb', line 212

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) 


227
228
229
230
 
# File 'app_sync/graphql_api_base.rb', line 227

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

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

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

[disable-awslint:no-grants]

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:



397
398
399
400
401
402
403
404
 
# File 'app_sync/graphql_api_base.rb', line 397

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.

[disable-awslint:no-grants]

Parameters:

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

    The principal.

  • fields (Array<String>) —

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

Returns:



413
414
415
416
417
418
419
 
# File 'app_sync/graphql_api_base.rb', line 413

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.

[disable-awslint:no-grants]

Parameters:

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

    The principal.

  • fields (Array<String>) —

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

Returns:



428
429
430
431
432
433
434
 
# File 'app_sync/graphql_api_base.rb', line 428

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.

[disable-awslint:no-grants]

Parameters:

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

    The principal.

  • fields (Array<String>) —

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

Returns:



443
444
445
446
447
448
449
 
# File 'app_sync/graphql_api_base.rb', line 443

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:



117
118
119
 
# File 'app_sync/graphql_api_base.rb', line 117

def graph_ql_api_ref()
  jsii_get_property("graphQlApiRef")
end

#graph_ql_endpoint_arn ⇒ String

The GraphQL endpoint ARN.

Returns:

  • (String) 


124
125
126
 
# File 'app_sync/graphql_api_base.rb', line 124

def graph_ql_endpoint_arn()
  jsii_get_property("graphQLEndpointArn")
end

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

The Authorization Types for this GraphQL Api.

Returns:



131
132
133
 
# File 'app_sync/graphql_api_base.rb', line 131

def modes()
  jsii_get_property("modes")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


60
61
62
 
# File 'app_sync/graphql_api_base.rb', line 60

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) 


89
90
91
 
# File 'app_sync/graphql_api_base.rb', line 89

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



96
97
98
 
# File 'app_sync/graphql_api_base.rb', line 96

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


145
146
147
 
# File 'app_sync/graphql_api_base.rb', line 145

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

#visibility ⇒ AWSCDK::AppSync::Visibility

The visibility of the API.

Returns:



138
139
140
 
# File 'app_sync/graphql_api_base.rb', line 138

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. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


158
159
160
161
162
163
 
# File 'app_sync/graphql_api_base.rb', line 158

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