Class: AWSCDK::AppSync::EventAPI

Inherits:
EventAPIBase
  • Object
show all
Defined in:
app_sync/event_api.rb

Overview

An AppSync Event API.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ EventAPI

Returns a new instance of EventAPI.

Parameters:



11
12
13
14
15
16
17
 
# File 'app_sync/event_api.rb', line 11

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

Class Method Details

.from_event_api_attributes(scope, id, attrs) ⇒ AWSCDK::AppSync::IEventAPI

Import a Event API through this function.

Parameters:

Returns:



67
68
69
70
71
72
73
 
# File 'app_sync/event_api.rb', line 67

def self.from_event_api_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::EventAPIAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5FdmVudEFwaUF0dHJpYnV0ZXMifQ==")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appsync.EventApi", "fromEventApiAttributes", [scope, id, attrs])
end

.jsii_overridable_methods ⇒ Object 



19
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
56
57
58
59
 
# File 'app_sync/event_api.rb', line 19

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_arn => { kind: :property, name: "apiArn", is_optional: false },
    :api_id => { kind: :property, name: "apiId", is_optional: false },
    :api_ref => { kind: :property, name: "apiRef", is_optional: false },
    :auth_provider_types => { kind: :property, name: "authProviderTypes", is_optional: false },
    :http_dns => { kind: :property, name: "httpDns", is_optional: false },
    :realtime_dns => { kind: :property, name: "realtimeDns", is_optional: false },
    :api_keys => { kind: :property, name: "apiKeys", is_optional: false },
    :app_sync_domain_name => { kind: :property, name: "appSyncDomainName", is_optional: false },
    :connection_mode_types => { kind: :property, name: "connectionModeTypes", is_optional: false },
    :custom_http_endpoint => { kind: :property, name: "customHttpEndpoint", is_optional: false },
    :custom_realtime_endpoint => { kind: :property, name: "customRealtimeEndpoint", is_optional: false },
    :default_publish_mode_types => { kind: :property, name: "defaultPublishModeTypes", is_optional: false },
    :default_subscribe_mode_types => { kind: :property, name: "defaultSubscribeModeTypes", is_optional: false },
    :log_group => { kind: :property, name: "logGroup", 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_channel_namespace => { kind: :method, name: "addChannelNamespace", is_optional: false },
    :add_dynamo_db_data_source => { kind: :method, name: "addDynamoDbDataSource", 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_open_search_data_source => { kind: :method, name: "addOpenSearchDataSource", is_optional: false },
    :add_rds_data_source => { kind: :method, name: "addRdsDataSource", is_optional: false },
    :grant => { kind: :method, name: "grant", is_optional: false },
    :grant_connect => { kind: :method, name: "grantConnect", is_optional: false },
    :grant_publish => { kind: :method, name: "grantPublish", is_optional: false },
    :grant_publish_and_subscribe => { kind: :method, name: "grantPublishAndSubscribe", is_optional: false },
    :grant_subscribe => { kind: :method, name: "grantSubscribe", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


163
164
165
 
# File 'app_sync/event_api.rb', line 163

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

Instance Method Details

#add_channel_namespace(id, options = nil) ⇒ AWSCDK::AppSync::ChannelNamespace

add a new Channel Namespace to this API.

Parameters:

Returns:



321
322
323
324
325
326
 
# File 'app_sync/event_api.rb', line 321

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

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

add a new DynamoDB data source to this API.

Parameters:

Returns:



334
335
336
337
338
339
340
 
# File 'app_sync/event_api.rb', line 334

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::AppSyncDataSourceOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5BcHBTeW5jRGF0YVNvdXJjZU9wdGlvbnMifQ==")), "options") unless options.nil?
  jsii_call_method("addDynamoDbDataSource", [id, table, options])
end

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

Add an EventBridge data source to this api.

Parameters:

Returns:



348
349
350
351
352
353
354
 
# File 'app_sync/event_api.rb', line 348

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::AppSyncDataSourceOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5BcHBTeW5jRGF0YVNvdXJjZU9wdGlvbnMifQ==")), "options") unless options.nil?
  jsii_call_method("addEventBridgeDataSource", [id, event_bus, options])
end

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

add a new http data source to this API.

Parameters:

Returns:



362
363
364
365
366
367
368
 
# File 'app_sync/event_api.rb', line 362

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::AppSyncHttpDataSourceOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5BcHBTeW5jSHR0cERhdGFTb3VyY2VPcHRpb25zIn0=")), "options") unless options.nil?
  jsii_call_method("addHttpDataSource", [id, endpoint, options])
end

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

add a new Lambda data source to this API.

Parameters:

Returns:



376
377
378
379
380
381
382
 
# File 'app_sync/event_api.rb', line 376

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::AppSyncDataSourceOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5BcHBTeW5jRGF0YVNvdXJjZU9wdGlvbnMifQ==")), "options") unless options.nil?
  jsii_call_method("addLambdaDataSource", [id, lambda_function, options])
end

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

add a new OpenSearch data source to this API.

Parameters:

Returns:



390
391
392
393
394
395
396
 
# File 'app_sync/event_api.rb', line 390

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::AppSyncDataSourceOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5BcHBTeW5jRGF0YVNvdXJjZU9wdGlvbnMifQ==")), "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::AppSyncRDSDataSource

add a new Rds data source to this API.

Parameters:

Returns:



406
407
408
409
410
411
412
413
414
 
# File 'app_sync/event_api.rb', line 406

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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuYXdzX3Jkcy5JRGF0YWJhc2VDbHVzdGVyIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLklTZXJ2ZXJsZXNzQ2x1c3RlciJ9XX19")), "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::AppSyncDataSourceOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5BcHBTeW5jRGF0YVNvdXJjZU9wdGlvbnMifQ==")), "options") unless options.nil?
  jsii_call_method("addRdsDataSource", [id, serverless_cluster, secret_store, database_name, options])
end

#api_arn ⇒ String

the ARN of the API.

Returns:

  • (String) 


121
122
123
 
# File 'app_sync/event_api.rb', line 121

def api_arn()
  jsii_get_property("apiArn")
end

#api_id ⇒ String

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

Returns:

  • (String) 


128
129
130
 
# File 'app_sync/event_api.rb', line 128

def api_id()
  jsii_get_property("apiId")
end

#api_keys ⇒ Hash{String => AWSCDK::AppSync::CfnAPIKey}

Note:

Default: - no api key

The configured API keys, if present.

The key of this object is an apiKey name (apiKeyConfig.name) if specified, Default otherwise.

Returns:



173
174
175
 
# File 'app_sync/event_api.rb', line 173

def api_keys()
  jsii_get_property("apiKeys")
end

#api_ref ⇒ AWSCDK::Interfaces::AWSAppsync::APIReference

A reference to a Api resource.

Returns:



135
136
137
 
# File 'app_sync/event_api.rb', line 135

def api_ref()
  jsii_get_property("apiRef")
end

#app_sync_domain_name ⇒ String

The AppSyncDomainName of the associated custom domain.

Returns:

  • (String) 


180
181
182
 
# File 'app_sync/event_api.rb', line 180

def app_sync_domain_name()
  jsii_get_property("appSyncDomainName")
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:



259
260
261
262
 
# File 'app_sync/event_api.rb', line 259

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:



276
277
278
279
 
# File 'app_sync/event_api.rb', line 276

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

#auth_provider_types ⇒ Array<AWSCDK::AppSync::AppSyncAuthorizationType>

The Authorization Types for this Event Api.

Returns:



142
143
144
 
# File 'app_sync/event_api.rb', line 142

def auth_provider_types()
  jsii_get_property("authProviderTypes")
end

#connection_mode_types ⇒ Array<AWSCDK::AppSync::AppSyncAuthorizationType>

The connection auth modes for this Event Api.

Returns:



187
188
189
 
# File 'app_sync/event_api.rb', line 187

def connection_mode_types()
  jsii_get_property("connectionModeTypes")
end

#custom_http_endpoint ⇒ String

The HTTP Endpoint of the associated custom domain.

Returns:

  • (String) 


194
195
196
 
# File 'app_sync/event_api.rb', line 194

def custom_http_endpoint()
  jsii_get_property("customHttpEndpoint")
end

#custom_realtime_endpoint ⇒ String

The Realtime Endpoint of the associated custom domain.

Returns:

  • (String) 


201
202
203
 
# File 'app_sync/event_api.rb', line 201

def custom_realtime_endpoint()
  jsii_get_property("customRealtimeEndpoint")
end

#default_publish_mode_types ⇒ Array<AWSCDK::AppSync::AppSyncAuthorizationType>

The default publish auth modes for this Event Api.

Returns:



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

def default_publish_mode_types()
  jsii_get_property("defaultPublishModeTypes")
end

#default_subscribe_mode_types ⇒ Array<AWSCDK::AppSync::AppSyncAuthorizationType>

The default subscribe auth modes for this Event Api.

Returns:



215
216
217
 
# File 'app_sync/event_api.rb', line 215

def default_subscribe_mode_types()
  jsii_get_property("defaultSubscribeModeTypes")
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:



93
94
95
 
# File 'app_sync/event_api.rb', line 93

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


282
283
284
 
# File 'app_sync/event_api.rb', line 282

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) 


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

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) 


311
312
313
314
 
# File 'app_sync/event_api.rb', line 311

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 Event API to an IAM principal's policy.

[disable-awslint:no-grants]

Parameters:

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

    The principal.

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

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

  • actions (Array<String>) —

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

Returns:



424
425
426
427
428
429
430
431
 
# File 'app_sync/event_api.rb', line 424

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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5BcHBTeW5jRXZlbnRSZXNvdXJjZSJ9")), "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_connect(grantee) ⇒ AWSCDK::IAM::Grant

Adds an IAM policy statement for EventConnect access to this EventApi to an IAM principal's policy.

[disable-awslint:no-grants]

Parameters:

Returns:



439
440
441
442
 
# File 'app_sync/event_api.rb', line 439

def grant_connect(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantConnect", [grantee])
end

#grant_publish(grantee) ⇒ AWSCDK::IAM::Grant

Adds an IAM policy statement for EventPublish access to this EventApi to an IAM principal's policy.

This grants publish permission for all channels within the API. [disable-awslint:no-grants]

Parameters:

Returns:



451
452
453
454
 
# File 'app_sync/event_api.rb', line 451

def grant_publish(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantPublish", [grantee])
end

#grant_publish_and_subscribe(grantee) ⇒ AWSCDK::IAM::Grant

Adds an IAM policy statement to publish and subscribe to this API for an IAM principal's policy.

This grants publish & subscribe permission for all channels within the API. [disable-awslint:no-grants]

Parameters:

Returns:



463
464
465
466
 
# File 'app_sync/event_api.rb', line 463

def grant_publish_and_subscribe(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantPublishAndSubscribe", [grantee])
end

#grant_subscribe(grantee) ⇒ AWSCDK::IAM::Grant

Adds an IAM policy statement for EventSubscribe access to this EventApi to an IAM principal's policy.

This grants subscribe permission for all channels within the API. [disable-awslint:no-grants]

Parameters:

Returns:



475
476
477
478
 
# File 'app_sync/event_api.rb', line 475

def grant_subscribe(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantSubscribe", [grantee])
end

#http_dns ⇒ String

the domain name of the Api's HTTP endpoint.

Returns:

  • (String) 


149
150
151
 
# File 'app_sync/event_api.rb', line 149

def http_dns()
  jsii_get_property("httpDns")
end

#log_group ⇒ AWSCDK::Logs::ILogGroup

the CloudWatch Log Group for this API.

Returns:



222
223
224
 
# File 'app_sync/event_api.rb', line 222

def log_group()
  jsii_get_property("logGroup")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


78
79
80
 
# File 'app_sync/event_api.rb', line 78

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) 


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

def physical_name()
  jsii_get_property("physicalName")
end

#realtime_dns ⇒ String

the domain name of the Api's real-time endpoint.

Returns:

  • (String) 


156
157
158
 
# File 'app_sync/event_api.rb', line 156

def realtime_dns()
  jsii_get_property("realtimeDns")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



114
115
116
 
# File 'app_sync/event_api.rb', line 114

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


229
230
231
 
# File 'app_sync/event_api.rb', line 229

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) 


242
243
244
245
246
247
 
# File 'app_sync/event_api.rb', line 242

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