Class: AWSCDK::AppSync::CfnGraphQLAPI

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSAppsync::IGraphQLAPIRef
Defined in:
app_sync/cfn_graph_qlapi.rb

Overview

The AWS::AppSync::GraphQLApi resource creates a new AWS AppSync GraphQL API.

This is the top-level construct for your application. For more information, see Quick Start in the AWS AppSync Developer Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnGraphQLAPI

Create a new AWS::AppSync::GraphQLApi.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::AppSync::CfnGraphQLAPIProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'app_sync/cfn_graph_qlapi.rb', line 20

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

Class Method Details

.arn_for_graph_ql_api(resource) ⇒ String

Parameters:

Returns:

  • (String) 


97
98
99
100
 
# File 'app_sync/cfn_graph_qlapi.rb', line 97

def self.arn_for_graph_ql_api(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcHBzeW5jLklHcmFwaFFMQXBpUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appsync.CfnGraphQLApi", "arnForGraphQLApi", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


204
205
206
 
# File 'app_sync/cfn_graph_qlapi.rb', line 204

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

.is_cfn_graph_ql_api(x) ⇒ Boolean

Checks whether the given object is a CfnGraphQLApi.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

def self.is_cfn_graph_ql_api(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appsync.CfnGraphQLApi", "isCfnGraphQLApi", [x])
end

.jsii_overridable_methods ⇒ Object 



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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'app_sync/cfn_graph_qlapi.rb', line 28

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_api_id => { kind: :property, name: "attrApiId", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_graph_ql_dns => { kind: :property, name: "attrGraphQlDns", is_optional: false },
    :attr_graph_ql_endpoint_arn => { kind: :property, name: "attrGraphQlEndpointArn", is_optional: false },
    :attr_graph_ql_url => { kind: :property, name: "attrGraphQlUrl", is_optional: false },
    :attr_realtime_dns => { kind: :property, name: "attrRealtimeDns", is_optional: false },
    :attr_realtime_url => { kind: :property, name: "attrRealtimeUrl", is_optional: false },
    :graph_ql_api_ref => { kind: :property, name: "graphQlApiRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :authentication_type => { kind: :property, name: "authenticationType", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :additional_authentication_providers => { kind: :property, name: "additionalAuthenticationProviders", is_optional: true },
    :api_type => { kind: :property, name: "apiType", is_optional: true },
    :enhanced_metrics_config => { kind: :property, name: "enhancedMetricsConfig", is_optional: true },
    :environment_variables => { kind: :property, name: "environmentVariables", is_optional: true },
    :introspection_config => { kind: :property, name: "introspectionConfig", is_optional: true },
    :lambda_authorizer_config => { kind: :property, name: "lambdaAuthorizerConfig", is_optional: true },
    :log_config => { kind: :property, name: "logConfig", is_optional: true },
    :merged_api_execution_role_arn => { kind: :property, name: "mergedApiExecutionRoleArn", is_optional: true },
    :open_id_connect_config => { kind: :property, name: "openIdConnectConfig", is_optional: true },
    :owner_contact => { kind: :property, name: "ownerContact", is_optional: true },
    :query_depth_limit => { kind: :property, name: "queryDepthLimit", is_optional: true },
    :resolver_count_limit => { kind: :property, name: "resolverCountLimit", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :user_pool_config => { kind: :property, name: "userPoolConfig", is_optional: true },
    :visibility => { kind: :property, name: "visibility", is_optional: true },
    :xray_enabled => { kind: :property, name: "xrayEnabled", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", 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 },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



531
532
533
534
 
# File 'app_sync/cfn_graph_qlapi.rb', line 531

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



543
544
545
546
 
# File 'app_sync/cfn_graph_qlapi.rb', line 543

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



553
554
555
556
 
# File 'app_sync/cfn_graph_qlapi.rb', line 553

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



564
565
566
567
568
 
# File 'app_sync/cfn_graph_qlapi.rb', line 564

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


621
622
623
624
625
 
# File 'app_sync/cfn_graph_qlapi.rb', line 621

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



631
632
633
634
 
# File 'app_sync/cfn_graph_qlapi.rb', line 631

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



643
644
645
646
647
 
# File 'app_sync/cfn_graph_qlapi.rb', line 643

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#additional_authentication_providers ⇒ AWSCDK::IResolvable, ...

A list of additional authentication providers for the GraphqlApi API.

Returns:



300
301
302
 
# File 'app_sync/cfn_graph_qlapi.rb', line 300

def additional_authentication_providers()
  jsii_get_property("additionalAuthenticationProviders")
end

#additional_authentication_providers=(value) ⇒ Object 



304
305
306
307
 
# File 'app_sync/cfn_graph_qlapi.rb', line 304

def additional_authentication_providers=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5DZm5HcmFwaFFMQXBpLkFkZGl0aW9uYWxBdXRoZW50aWNhdGlvblByb3ZpZGVyUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "additionalAuthenticationProviders") unless value.nil?
  jsii_set_property("additionalAuthenticationProviders", value)
end

#api_type ⇒ String?

The value that indicates whether the GraphQL API is a standard API ( GRAPHQL ) or merged API ( MERGED ).

Returns:

  • (String, nil) 


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

def api_type()
  jsii_get_property("apiType")
end

#api_type=(value) ⇒ Object 



316
317
318
319
 
# File 'app_sync/cfn_graph_qlapi.rb', line 316

def api_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiType") unless value.nil?
  jsii_set_property("apiType", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



656
657
658
659
 
# File 'app_sync/cfn_graph_qlapi.rb', line 656

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 = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



678
679
680
681
682
683
 
# File 'app_sync/cfn_graph_qlapi.rb', line 678

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_api_id ⇒ String

Unique AWS AppSync GraphQL API identifier.

Returns:

  • (String) 


211
212
213
 
# File 'app_sync/cfn_graph_qlapi.rb', line 211

def attr_api_id()
  jsii_get_property("attrApiId")
end

#attr_arn ⇒ String

The Amazon Resource Name (ARN) of the API key, such as arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid .

Returns:

  • (String) 


218
219
220
 
# File 'app_sync/cfn_graph_qlapi.rb', line 218

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_graph_ql_dns ⇒ String

The fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API.

Returns:

  • (String) 


225
226
227
 
# File 'app_sync/cfn_graph_qlapi.rb', line 225

def attr_graph_ql_dns()
  jsii_get_property("attrGraphQlDns")
end

#attr_graph_ql_endpoint_arn ⇒ String

The GraphQL endpoint ARN.

Returns:

  • (String) 


232
233
234
 
# File 'app_sync/cfn_graph_qlapi.rb', line 232

def attr_graph_ql_endpoint_arn()
  jsii_get_property("attrGraphQlEndpointArn")
end

#attr_graph_ql_url ⇒ String

The Endpoint URL of your GraphQL API.

Returns:

  • (String) 


239
240
241
 
# File 'app_sync/cfn_graph_qlapi.rb', line 239

def attr_graph_ql_url()
  jsii_get_property("attrGraphQlUrl")
end

#attr_realtime_dns ⇒ String

The fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL API.

Returns:

  • (String) 


246
247
248
 
# File 'app_sync/cfn_graph_qlapi.rb', line 246

def attr_realtime_dns()
  jsii_get_property("attrRealtimeDns")
end

#attr_realtime_url ⇒ String

The GraphQL API real-time endpoint URL.

For more information, see Discovering the real-time endpoint from the GraphQL endpoint .

Returns:

  • (String) 


255
256
257
 
# File 'app_sync/cfn_graph_qlapi.rb', line 255

def attr_realtime_url()
  jsii_get_property("attrRealtimeUrl")
end

#authentication_type ⇒ String

Security configuration for your GraphQL API.

Returns:

  • (String) 


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

def authentication_type()
  jsii_get_property("authenticationType")
end

#authentication_type=(value) ⇒ Object 



280
281
282
283
 
# File 'app_sync/cfn_graph_qlapi.rb', line 280

def authentication_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authenticationType")
  jsii_set_property("authenticationType", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



157
158
159
 
# File 'app_sync/cfn_graph_qlapi.rb', line 157

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


162
163
164
 
# File 'app_sync/cfn_graph_qlapi.rb', line 162

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


687
688
689
690
 
# File 'app_sync/cfn_graph_qlapi.rb', line 687

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


167
168
169
 
# File 'app_sync/cfn_graph_qlapi.rb', line 167

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


174
175
176
 
# File 'app_sync/cfn_graph_qlapi.rb', line 174

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


119
120
121
 
# File 'app_sync/cfn_graph_qlapi.rb', line 119

def creation_stack()
  jsii_get_property("creationStack")
end

#enhanced_metrics_config ⇒ AWSCDK::IResolvable, ...

Enables and controls the enhanced metrics feature.

Returns:



324
325
326
 
# File 'app_sync/cfn_graph_qlapi.rb', line 324

def enhanced_metrics_config()
  jsii_get_property("enhancedMetricsConfig")
end

#enhanced_metrics_config=(value) ⇒ Object 



328
329
330
331
332
 
# File 'app_sync/cfn_graph_qlapi.rb', line 328

def enhanced_metrics_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AppSync::CfnGraphQLAPI::EnhancedMetricsConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzeW5jLkNmbkdyYXBoUUxBcGkuRW5oYW5jZWRNZXRyaWNzQ29uZmlnUHJvcGVydHkifV19fQ==")), "enhancedMetricsConfig") unless value.nil?
  jsii_set_property("enhancedMetricsConfig", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



179
180
181
 
# File 'app_sync/cfn_graph_qlapi.rb', line 179

def env()
  jsii_get_property("env")
end

#environment_variables ⇒ AWSCDK::IResolvable, ...

A map containing the list of resources with their properties and environment variables.

Returns:



337
338
339
 
# File 'app_sync/cfn_graph_qlapi.rb', line 337

def environment_variables()
  jsii_get_property("environmentVariables")
end

#environment_variables=(value) ⇒ Object 



341
342
343
344
 
# File 'app_sync/cfn_graph_qlapi.rb', line 341

def environment_variables=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "environmentVariables") unless value.nil?
  jsii_set_property("environmentVariables", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



700
701
702
703
704
 
# File 'app_sync/cfn_graph_qlapi.rb', line 700

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



711
712
713
714
 
# File 'app_sync/cfn_graph_qlapi.rb', line 711

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

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

A reference to a GraphQLApi resource.

Returns:



262
263
264
 
# File 'app_sync/cfn_graph_qlapi.rb', line 262

def graph_ql_api_ref()
  jsii_get_property("graphQlApiRef")
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



781
782
783
784
 
# File 'app_sync/cfn_graph_qlapi.rb', line 781

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#introspection_config ⇒ String?

Sets the value of the GraphQL API to enable ( ENABLED ) or disable ( DISABLED ) introspection.

Returns:

  • (String, nil) 


349
350
351
 
# File 'app_sync/cfn_graph_qlapi.rb', line 349

def introspection_config()
  jsii_get_property("introspectionConfig")
end

#introspection_config=(value) ⇒ Object 



353
354
355
356
 
# File 'app_sync/cfn_graph_qlapi.rb', line 353

def introspection_config=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "introspectionConfig") unless value.nil?
  jsii_set_property("introspectionConfig", value)
end

#lambda_authorizer_config ⇒ AWSCDK::IResolvable, ...

A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.

Returns:



361
362
363
 
# File 'app_sync/cfn_graph_qlapi.rb', line 361

def lambda_authorizer_config()
  jsii_get_property("lambdaAuthorizerConfig")
end

#lambda_authorizer_config=(value) ⇒ Object 



365
366
367
368
369
 
# File 'app_sync/cfn_graph_qlapi.rb', line 365

def lambda_authorizer_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AppSync::CfnGraphQLAPI::LambdaAuthorizerConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzeW5jLkNmbkdyYXBoUUxBcGkuTGFtYmRhQXV0aG9yaXplckNvbmZpZ1Byb3BlcnR5In1dfX0=")), "lambdaAuthorizerConfig") unless value.nil?
  jsii_set_property("lambdaAuthorizerConfig", value)
end

#log_config ⇒ AWSCDK::IResolvable, ...

The Amazon CloudWatch Logs configuration.

Returns:



374
375
376
 
# File 'app_sync/cfn_graph_qlapi.rb', line 374

def log_config()
  jsii_get_property("logConfig")
end

#log_config=(value) ⇒ Object 



378
379
380
381
382
 
# File 'app_sync/cfn_graph_qlapi.rb', line 378

def log_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AppSync::CfnGraphQLAPI::LogConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzeW5jLkNmbkdyYXBoUUxBcGkuTG9nQ29uZmlnUHJvcGVydHkifV19fQ==")), "logConfig") unless value.nil?
  jsii_set_property("logConfig", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


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

def logical_id()
  jsii_get_property("logicalId")
end

#merged_api_execution_role_arn ⇒ String?

The AWS Identity and Access Management service role ARN for a merged API.

Returns:

  • (String, nil) 


387
388
389
 
# File 'app_sync/cfn_graph_qlapi.rb', line 387

def merged_api_execution_role_arn()
  jsii_get_property("mergedApiExecutionRoleArn")
end

#merged_api_execution_role_arn=(value) ⇒ Object 



391
392
393
394
 
# File 'app_sync/cfn_graph_qlapi.rb', line 391

def merged_api_execution_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mergedApiExecutionRoleArn") unless value.nil?
  jsii_set_property("mergedApiExecutionRoleArn", value)
end

#name ⇒ String

The API name.

Returns:

  • (String) 


288
289
290
 
# File 'app_sync/cfn_graph_qlapi.rb', line 288

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



292
293
294
295
 
# File 'app_sync/cfn_graph_qlapi.rb', line 292

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


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

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



722
723
724
 
# File 'app_sync/cfn_graph_qlapi.rb', line 722

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



729
730
731
 
# File 'app_sync/cfn_graph_qlapi.rb', line 729

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#open_id_connect_config ⇒ AWSCDK::IResolvable, ...

The OpenID Connect configuration.

Returns:



399
400
401
 
# File 'app_sync/cfn_graph_qlapi.rb', line 399

def open_id_connect_config()
  jsii_get_property("openIdConnectConfig")
end

#open_id_connect_config=(value) ⇒ Object 



403
404
405
406
407
 
# File 'app_sync/cfn_graph_qlapi.rb', line 403

def open_id_connect_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AppSync::CfnGraphQLAPI::OpenIDConnectConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzeW5jLkNmbkdyYXBoUUxBcGkuT3BlbklEQ29ubmVjdENvbmZpZ1Byb3BlcnR5In1dfX0=")), "openIdConnectConfig") unless value.nil?
  jsii_set_property("openIdConnectConfig", value)
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



522
523
524
525
 
# File 'app_sync/cfn_graph_qlapi.rb', line 522

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#owner_contact ⇒ String?

The owner contact information for an API resource.

Returns:

  • (String, nil) 


412
413
414
 
# File 'app_sync/cfn_graph_qlapi.rb', line 412

def owner_contact()
  jsii_get_property("ownerContact")
end

#owner_contact=(value) ⇒ Object 



416
417
418
419
 
# File 'app_sync/cfn_graph_qlapi.rb', line 416

def owner_contact=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ownerContact") unless value.nil?
  jsii_set_property("ownerContact", value)
end

#query_depth_limit ⇒ Numeric?

The maximum depth a query can have in a single request.

Returns:

  • (Numeric, nil) 


424
425
426
 
# File 'app_sync/cfn_graph_qlapi.rb', line 424

def query_depth_limit()
  jsii_get_property("queryDepthLimit")
end

#query_depth_limit=(value) ⇒ Object 



428
429
430
431
 
# File 'app_sync/cfn_graph_qlapi.rb', line 428

def query_depth_limit=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "queryDepthLimit") unless value.nil?
  jsii_set_property("queryDepthLimit", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


150
151
152
 
# File 'app_sync/cfn_graph_qlapi.rb', line 150

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



740
741
742
743
 
# File 'app_sync/cfn_graph_qlapi.rb', line 740

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


747
748
749
750
 
# File 'app_sync/cfn_graph_qlapi.rb', line 747

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



757
758
759
760
761
 
# File 'app_sync/cfn_graph_qlapi.rb', line 757

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#resolver_count_limit ⇒ Numeric?

The maximum number of resolvers that can be invoked in a single request.

Returns:

  • (Numeric, nil) 


436
437
438
 
# File 'app_sync/cfn_graph_qlapi.rb', line 436

def resolver_count_limit()
  jsii_get_property("resolverCountLimit")
end

#resolver_count_limit=(value) ⇒ Object 



440
441
442
443
 
# File 'app_sync/cfn_graph_qlapi.rb', line 440

def resolver_count_limit=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "resolverCountLimit") unless value.nil?
  jsii_set_property("resolverCountLimit", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



766
767
768
 
# File 'app_sync/cfn_graph_qlapi.rb', line 766

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



140
141
142
 
# File 'app_sync/cfn_graph_qlapi.rb', line 140

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



269
270
271
 
# File 'app_sync/cfn_graph_qlapi.rb', line 269

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

An arbitrary set of tags (key-value pairs) for this GraphQL API.

Returns:



448
449
450
 
# File 'app_sync/cfn_graph_qlapi.rb', line 448

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



452
453
454
455
456
 
# File 'app_sync/cfn_graph_qlapi.rb', line 452

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



498
499
500
 
# File 'app_sync/cfn_graph_qlapi.rb', line 498

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

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


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

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


197
198
199
 
# File 'app_sync/cfn_graph_qlapi.rb', line 197

def updated_properties()
  jsii_get_property("updatedProperties")
end

#user_pool_config ⇒ AWSCDK::IResolvable, ...

Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.

Returns:



461
462
463
 
# File 'app_sync/cfn_graph_qlapi.rb', line 461

def user_pool_config()
  jsii_get_property("userPoolConfig")
end

#user_pool_config=(value) ⇒ Object 



465
466
467
468
469
 
# File 'app_sync/cfn_graph_qlapi.rb', line 465

def user_pool_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AppSync::CfnGraphQLAPI::UserPoolConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzeW5jLkNmbkdyYXBoUUxBcGkuVXNlclBvb2xDb25maWdQcm9wZXJ0eSJ9XX19")), "userPoolConfig") unless value.nil?
  jsii_set_property("userPoolConfig", value)
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


772
773
774
775
 
# File 'app_sync/cfn_graph_qlapi.rb', line 772

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#visibility ⇒ String?

Sets the scope of the GraphQL API to public ( GLOBAL ) or private ( PRIVATE ).

Returns:

  • (String, nil) 


474
475
476
 
# File 'app_sync/cfn_graph_qlapi.rb', line 474

def visibility()
  jsii_get_property("visibility")
end

#visibility=(value) ⇒ Object 



478
479
480
481
 
# File 'app_sync/cfn_graph_qlapi.rb', line 478

def visibility=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "visibility") unless value.nil?
  jsii_set_property("visibility", value)
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) 


511
512
513
514
515
516
 
# File 'app_sync/cfn_graph_qlapi.rb', line 511

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

#xray_enabled ⇒ Boolean, ...

A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi .

Returns:



486
487
488
 
# File 'app_sync/cfn_graph_qlapi.rb', line 486

def xray_enabled()
  jsii_get_property("xrayEnabled")
end

#xray_enabled=(value) ⇒ Object 



490
491
492
493
 
# File 'app_sync/cfn_graph_qlapi.rb', line 490

def xray_enabled=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "xrayEnabled") unless value.nil?
  jsii_set_property("xrayEnabled", value)
end