Class: AWSCDK::AppSync::EventAPIBase
- Inherits:
-
APIBase
- Object
- APIBase
- AWSCDK::AppSync::EventAPIBase
- Includes:
- IEventAPI
- Defined in:
- app_sync/event_api_base.rb
Overview
Base Class for Event API.
Direct Known Subclasses
Class Method Summary collapse
Instance Method Summary collapse
-
#add_channel_namespace(id, options = nil) ⇒ AWSCDK::AppSync::ChannelNamespace
add a new Channel Namespace to this API.
-
#add_dynamo_db_data_source(id, table, options = nil) ⇒ AWSCDK::AppSync::AppSyncDynamoDBDataSource
add a new DynamoDB data source to this API.
-
#add_event_bridge_data_source(id, event_bus, options = nil) ⇒ AWSCDK::AppSync::AppSyncEventBridgeDataSource
Add an EventBridge data source to this api.
-
#add_http_data_source(id, endpoint, options = nil) ⇒ AWSCDK::AppSync::AppSyncHttpDataSource
add a new http data source to this API.
-
#add_lambda_data_source(id, lambda_function, options = nil) ⇒ AWSCDK::AppSync::AppSyncLambdaDataSource
add a new Lambda data source to this API.
-
#add_open_search_data_source(id, domain, options = nil) ⇒ AWSCDK::AppSync::AppSyncOpenSearchDataSource
add a new OpenSearch data source to this API.
-
#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.
-
#api_arn ⇒ String
The ARN of the AWS AppSync Api.
-
#api_id ⇒ String
The unique identifier for the AWS AppSync Api generated by the service.
-
#api_ref ⇒ AWSCDK::Interfaces::AWSAppsync::APIReference
A reference to a Api resource.
-
#apply_cross_stack_reference_strength(strength) ⇒ void
Override the cross-stack reference strength for this resource.
-
#apply_removal_policy(policy) ⇒ void
Apply the given removal policy to this resource.
-
#auth_provider_types ⇒ Array<AWSCDK::AppSync::AppSyncAuthorizationType>
The Authorization Types for this Event Api.
-
#env ⇒ AWSCDK::Interfaces::ResourceEnvironment
The environment this resource belongs to.
- #generate_physical_name ⇒ String
-
#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). -
#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). -
#grant(grantee, resources, *actions) ⇒ AWSCDK::IAM::Grant
Adds an IAM policy statement associated with this Event API to an IAM principal's policy.
-
#grant_connect(grantee) ⇒ AWSCDK::IAM::Grant
Adds an IAM policy statement for EventConnect access to this EventApi to an IAM principal's policy.
-
#grant_publish(grantee) ⇒ AWSCDK::IAM::Grant
Adds an IAM policy statement for EventPublish access to this EventApi to an IAM principal's policy.
-
#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.
-
#grant_subscribe(grantee) ⇒ AWSCDK::IAM::Grant
Adds an IAM policy statement for EventSubscribe access to this EventApi to an IAM principal's policy.
-
#http_dns ⇒ String
The domain name of the Api's HTTP endpoint.
-
#initialize(scope, id, props = nil) ⇒ EventAPIBase
constructor
A new instance of EventAPIBase.
-
#node ⇒ Constructs::Node
The tree node.
-
#physical_name ⇒ String
Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
-
#realtime_dns ⇒ String
The domain name of the Api's real-time endpoint.
-
#stack ⇒ AWSCDK::Stack
The stack in which this resource is defined.
-
#to_string ⇒ String
Returns a string representation of this construct.
-
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
Constructor Details
#initialize(scope, id, props = nil) ⇒ EventAPIBase
Returns a new instance of EventAPIBase.
12 13 14 15 16 17 18 |
# File 'app_sync/event_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 |
# File 'app_sync/event_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_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 }, :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 |
Instance Method Details
#add_channel_namespace(id, options = nil) ⇒ AWSCDK::AppSync::ChannelNamespace
add a new Channel Namespace to this API.
234 235 236 237 238 239 |
# File 'app_sync/event_api_base.rb', line 234 def add_channel_namespace(id, = nil) Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id") = .is_a?(Hash) ? ::AWSCDK::AppSync::ChannelNamespaceOptions.new(**.transform_keys(&:to_sym)) : Jsii::Type.check_type(, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5DaGFubmVsTmFtZXNwYWNlT3B0aW9ucyJ9")), "options") unless .nil? jsii_call_method("addChannelNamespace", [id, ]) end |
#add_dynamo_db_data_source(id, table, options = nil) ⇒ AWSCDK::AppSync::AppSyncDynamoDBDataSource
add a new DynamoDB data source to this API.
247 248 249 250 251 252 253 |
# File 'app_sync/event_api_base.rb', line 247 def add_dynamo_db_data_source(id, table, = 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") = .is_a?(Hash) ? ::AWSCDK::AppSync::AppSyncDataSourceOptions.new(**.transform_keys(&:to_sym)) : Jsii::Type.check_type(, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5BcHBTeW5jRGF0YVNvdXJjZU9wdGlvbnMifQ==")), "options") unless .nil? jsii_call_method("addDynamoDbDataSource", [id, table, ]) end |
#add_event_bridge_data_source(id, event_bus, options = nil) ⇒ AWSCDK::AppSync::AppSyncEventBridgeDataSource
Add an EventBridge data source to this api.
261 262 263 264 265 266 267 |
# File 'app_sync/event_api_base.rb', line 261 def add_event_bridge_data_source(id, event_bus, = 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") = .is_a?(Hash) ? ::AWSCDK::AppSync::AppSyncDataSourceOptions.new(**.transform_keys(&:to_sym)) : Jsii::Type.check_type(, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5BcHBTeW5jRGF0YVNvdXJjZU9wdGlvbnMifQ==")), "options") unless .nil? jsii_call_method("addEventBridgeDataSource", [id, event_bus, ]) end |
#add_http_data_source(id, endpoint, options = nil) ⇒ AWSCDK::AppSync::AppSyncHttpDataSource
add a new http data source to this API.
275 276 277 278 279 280 281 |
# File 'app_sync/event_api_base.rb', line 275 def add_http_data_source(id, endpoint, = 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") = .is_a?(Hash) ? ::AWSCDK::AppSync::AppSyncHttpDataSourceOptions.new(**.transform_keys(&:to_sym)) : Jsii::Type.check_type(, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5BcHBTeW5jSHR0cERhdGFTb3VyY2VPcHRpb25zIn0=")), "options") unless .nil? jsii_call_method("addHttpDataSource", [id, endpoint, ]) end |
#add_lambda_data_source(id, lambda_function, options = nil) ⇒ AWSCDK::AppSync::AppSyncLambdaDataSource
add a new Lambda data source to this API.
289 290 291 292 293 294 295 |
# File 'app_sync/event_api_base.rb', line 289 def add_lambda_data_source(id, lambda_function, = 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") = .is_a?(Hash) ? ::AWSCDK::AppSync::AppSyncDataSourceOptions.new(**.transform_keys(&:to_sym)) : Jsii::Type.check_type(, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5BcHBTeW5jRGF0YVNvdXJjZU9wdGlvbnMifQ==")), "options") unless .nil? jsii_call_method("addLambdaDataSource", [id, lambda_function, ]) end |
#add_open_search_data_source(id, domain, options = nil) ⇒ AWSCDK::AppSync::AppSyncOpenSearchDataSource
add a new OpenSearch data source to this API.
303 304 305 306 307 308 309 |
# File 'app_sync/event_api_base.rb', line 303 def add_open_search_data_source(id, domain, = 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") = .is_a?(Hash) ? ::AWSCDK::AppSync::AppSyncDataSourceOptions.new(**.transform_keys(&:to_sym)) : Jsii::Type.check_type(, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5BcHBTeW5jRGF0YVNvdXJjZU9wdGlvbnMifQ==")), "options") unless .nil? jsii_call_method("addOpenSearchDataSource", [id, domain, ]) 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.
319 320 321 322 323 324 325 326 327 |
# File 'app_sync/event_api_base.rb', line 319 def add_rds_data_source(id, serverless_cluster, secret_store, database_name = nil, = 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? = .is_a?(Hash) ? ::AWSCDK::AppSync::AppSyncDataSourceOptions.new(**.transform_keys(&:to_sym)) : Jsii::Type.check_type(, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5BcHBTeW5jRGF0YVNvdXJjZU9wdGlvbnMifQ==")), "options") unless .nil? jsii_call_method("addRdsDataSource", [id, serverless_cluster, secret_store, database_name, ]) end |
#api_arn ⇒ String
The ARN of the AWS AppSync Api.
100 101 102 |
# File 'app_sync/event_api_base.rb', line 100 def api_arn() jsii_get_property("apiArn") end |
#api_id ⇒ String
The unique identifier for the AWS AppSync Api generated by the service.
107 108 109 |
# File 'app_sync/event_api_base.rb', line 107 def api_id() jsii_get_property("apiId") end |
#api_ref ⇒ AWSCDK::Interfaces::AWSAppsync::APIReference
A reference to a Api resource.
114 115 116 |
# File 'app_sync/event_api_base.rb', line 114 def api_ref() jsii_get_property("apiRef") 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.
172 173 174 175 |
# File 'app_sync/event_api_base.rb', line 172 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).
189 190 191 192 |
# File 'app_sync/event_api_base.rb', line 189 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.
121 122 123 |
# File 'app_sync/event_api_base.rb', line 121 def auth_provider_types() jsii_get_property("authProviderTypes") 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.
72 73 74 |
# File 'app_sync/event_api_base.rb', line 72 def env() jsii_get_property("env") end |
#generate_physical_name ⇒ String
195 196 197 |
# File 'app_sync/event_api_base.rb', line 195 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.
209 210 211 212 213 214 |
# File 'app_sync/event_api_base.rb', line 209 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.
224 225 226 227 |
# File 'app_sync/event_api_base.rb', line 224 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]
337 338 339 340 341 342 343 344 |
# File 'app_sync/event_api_base.rb', line 337 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]
352 353 354 355 |
# File 'app_sync/event_api_base.rb', line 352 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]
364 365 366 367 |
# File 'app_sync/event_api_base.rb', line 364 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]
376 377 378 379 |
# File 'app_sync/event_api_base.rb', line 376 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]
388 389 390 391 |
# File 'app_sync/event_api_base.rb', line 388 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.
128 129 130 |
# File 'app_sync/event_api_base.rb', line 128 def http_dns() jsii_get_property("httpDns") end |
#node ⇒ Constructs::Node
The tree node.
57 58 59 |
# File 'app_sync/event_api_base.rb', line 57 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.
86 87 88 |
# File 'app_sync/event_api_base.rb', line 86 def physical_name() jsii_get_property("physicalName") end |
#realtime_dns ⇒ String
The domain name of the Api's real-time endpoint.
135 136 137 |
# File 'app_sync/event_api_base.rb', line 135 def realtime_dns() jsii_get_property("realtimeDns") end |
#stack ⇒ AWSCDK::Stack
The stack in which this resource is defined.
93 94 95 |
# File 'app_sync/event_api_base.rb', line 93 def stack() jsii_get_property("stack") end |
#to_string ⇒ String
Returns a string representation of this construct.
142 143 144 |
# File 'app_sync/event_api_base.rb', line 142 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.
155 156 157 158 159 160 |
# File 'app_sync/event_api_base.rb', line 155 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 |