Class: AWSCDK::APIGatewayv2::CfnAPI

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSApigatewayv2::IAPIRef
Defined in:
api_gatewayv2/cfn_api.rb

Overview

The AWS::ApiGatewayV2::Api resource creates an API.

WebSocket APIs and HTTP APIs are supported. For more information about WebSocket APIs, see About WebSocket APIs in API Gateway in the API Gateway Developer Guide . For more information about HTTP APIs, see HTTP APIs in the API Gateway Developer Guide.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new AWS::ApiGatewayV2::Api.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::APIGatewayv2::CfnAPIProps, nil) (defaults to: nil) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'api_gatewayv2/cfn_api.rb', line 20

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

Class Method Details

.arn_for_api(resource) ⇒ String

Parameters:

Returns:

  • (String) 


92
93
94
95
 
# File 'api_gatewayv2/cfn_api.rb', line 92

def self.arn_for_api(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcGlnYXRld2F5djIuSUFwaVJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigatewayv2.CfnApi", "arnForApi", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


212
213
214
 
# File 'api_gatewayv2/cfn_api.rb', line 212

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

.from_api_id(scope, id, api_id) ⇒ AWSCDK::Interfaces::AWSApigatewayv2::IAPIRef

Creates a new IApiRef from a apiId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • api_id (String)

Returns:



103
104
105
106
107
108
 
# File 'api_gatewayv2/cfn_api.rb', line 103

def self.from_api_id(scope, id, api_id)
  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(api_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigatewayv2.CfnApi", "fromApiId", [scope, id, api_id])
end

.is_cfn_api(x) ⇒ Boolean

Checks whether the given object is a CfnApi.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


114
115
116
117
 
# File 'api_gatewayv2/cfn_api.rb', line 114

def self.is_cfn_api(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigatewayv2.CfnApi", "isCfnApi", [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
 
# File 'api_gatewayv2/cfn_api.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 },
    :api_ref => { kind: :property, name: "apiRef", is_optional: false },
    :attr_api_endpoint => { kind: :property, name: "attrApiEndpoint", is_optional: false },
    :attr_api_id => { kind: :property, name: "attrApiId", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :body => { kind: :property, name: "body", is_optional: false },
    :api_key_selection_expression => { kind: :property, name: "apiKeySelectionExpression", is_optional: true },
    :base_path => { kind: :property, name: "basePath", is_optional: true },
    :body_s3_location => { kind: :property, name: "bodyS3Location", is_optional: true },
    :cors_configuration => { kind: :property, name: "corsConfiguration", is_optional: true },
    :credentials_arn => { kind: :property, name: "credentialsArn", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :disable_execute_api_endpoint => { kind: :property, name: "disableExecuteApiEndpoint", is_optional: true },
    :disable_schema_validation => { kind: :property, name: "disableSchemaValidation", is_optional: true },
    :fail_on_warnings => { kind: :property, name: "failOnWarnings", is_optional: true },
    :ip_address_type => { kind: :property, name: "ipAddressType", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :protocol_type => { kind: :property, name: "protocolType", is_optional: true },
    :route_key => { kind: :property, name: "routeKey", is_optional: true },
    :route_selection_expression => { kind: :property, name: "routeSelectionExpression", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :target => { kind: :property, name: "target", is_optional: true },
    :version => { kind: :property, name: "version", 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.



500
501
502
503
 
# File 'api_gatewayv2/cfn_api.rb', line 500

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:



512
513
514
515
 
# File 'api_gatewayv2/cfn_api.rb', line 512

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:



522
523
524
525
 
# File 'api_gatewayv2/cfn_api.rb', line 522

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:



533
534
535
536
537
 
# File 'api_gatewayv2/cfn_api.rb', line 533

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.


590
591
592
593
594
 
# File 'api_gatewayv2/cfn_api.rb', line 590

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.



600
601
602
603
 
# File 'api_gatewayv2/cfn_api.rb', line 600

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.



612
613
614
615
616
 
# File 'api_gatewayv2/cfn_api.rb', line 612

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

#api_key_selection_expression ⇒ String?

An API key selection expression.

Returns:

  • (String, nil) 


261
262
263
 
# File 'api_gatewayv2/cfn_api.rb', line 261

def api_key_selection_expression()
  jsii_get_property("apiKeySelectionExpression")
end

#api_key_selection_expression=(value) ⇒ Object 



265
266
267
268
 
# File 'api_gatewayv2/cfn_api.rb', line 265

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

#api_ref ⇒ AWSCDK::Interfaces::AWSApigatewayv2::APIReference

A reference to a Api resource.

Returns:



219
220
221
 
# File 'api_gatewayv2/cfn_api.rb', line 219

def api_ref()
  jsii_get_property("apiRef")
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:



625
626
627
628
 
# File 'api_gatewayv2/cfn_api.rb', line 625

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:



647
648
649
650
651
652
 
# File 'api_gatewayv2/cfn_api.rb', line 647

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_endpoint ⇒ String

The default endpoint for an API.

For example: https://abcdef.execute-api.us-west-2.amazonaws.com .

Returns:

  • (String) 


228
229
230
 
# File 'api_gatewayv2/cfn_api.rb', line 228

def attr_api_endpoint()
  jsii_get_property("attrApiEndpoint")
end

#attr_api_id ⇒ String

The API identifier.

Returns:

  • (String) 


235
236
237
 
# File 'api_gatewayv2/cfn_api.rb', line 235

def attr_api_id()
  jsii_get_property("attrApiId")
end

#base_path ⇒ String?

Specifies how to interpret the base path of the API during import.

Returns:

  • (String, nil) 


273
274
275
 
# File 'api_gatewayv2/cfn_api.rb', line 273

def base_path()
  jsii_get_property("basePath")
end

#base_path=(value) ⇒ Object 



277
278
279
280
 
# File 'api_gatewayv2/cfn_api.rb', line 277

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

#body ⇒ Object

The OpenAPI definition.

Returns:

  • (Object) 


249
250
251
 
# File 'api_gatewayv2/cfn_api.rb', line 249

def body()
  jsii_get_property("body")
end

#body=(value) ⇒ Object 



253
254
255
256
 
# File 'api_gatewayv2/cfn_api.rb', line 253

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

#body_s3_location ⇒ AWSCDK::IResolvable, ...

The S3 location of an OpenAPI definition.

Returns:



285
286
287
 
# File 'api_gatewayv2/cfn_api.rb', line 285

def body_s3_location()
  jsii_get_property("bodyS3Location")
end

#body_s3_location=(value) ⇒ Object 



289
290
291
292
293
 
# File 'api_gatewayv2/cfn_api.rb', line 289

def body_s3_location=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::APIGatewayv2::CfnAPI::BodyS3LocationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcGlnYXRld2F5djIuQ2ZuQXBpLkJvZHlTM0xvY2F0aW9uUHJvcGVydHkifV19fQ==")), "bodyS3Location") unless value.nil?
  jsii_set_property("bodyS3Location", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



165
166
167
 
# File 'api_gatewayv2/cfn_api.rb', line 165

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


170
171
172
 
# File 'api_gatewayv2/cfn_api.rb', line 170

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


656
657
658
659
 
# File 'api_gatewayv2/cfn_api.rb', line 656

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}) 


175
176
177
 
# File 'api_gatewayv2/cfn_api.rb', line 175

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


182
183
184
 
# File 'api_gatewayv2/cfn_api.rb', line 182

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cors_configuration ⇒ AWSCDK::IResolvable, ...

A CORS configuration.

Returns:



298
299
300
 
# File 'api_gatewayv2/cfn_api.rb', line 298

def cors_configuration()
  jsii_get_property("corsConfiguration")
end

#cors_configuration=(value) ⇒ Object 



302
303
304
305
306
 
# File 'api_gatewayv2/cfn_api.rb', line 302

def cors_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::APIGatewayv2::CfnAPI::CorsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcGlnYXRld2F5djIuQ2ZuQXBpLkNvcnNQcm9wZXJ0eSJ9XX19")), "corsConfiguration") unless value.nil?
  jsii_set_property("corsConfiguration", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


127
128
129
 
# File 'api_gatewayv2/cfn_api.rb', line 127

def creation_stack()
  jsii_get_property("creationStack")
end

#credentials_arn ⇒ String?

This property is part of quick create.

Returns:

  • (String, nil) 


311
312
313
 
# File 'api_gatewayv2/cfn_api.rb', line 311

def credentials_arn()
  jsii_get_property("credentialsArn")
end

#credentials_arn=(value) ⇒ Object 



315
316
317
318
 
# File 'api_gatewayv2/cfn_api.rb', line 315

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

#description ⇒ String?

The description of the API.

Returns:

  • (String, nil) 


323
324
325
 
# File 'api_gatewayv2/cfn_api.rb', line 323

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



327
328
329
330
 
# File 'api_gatewayv2/cfn_api.rb', line 327

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

#disable_execute_api_endpoint ⇒ Boolean, ...

Specifies whether clients can invoke your API by using the default execute-api endpoint.

Returns:



335
336
337
 
# File 'api_gatewayv2/cfn_api.rb', line 335

def disable_execute_api_endpoint()
  jsii_get_property("disableExecuteApiEndpoint")
end

#disable_execute_api_endpoint=(value) ⇒ Object 



339
340
341
342
 
# File 'api_gatewayv2/cfn_api.rb', line 339

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

#disable_schema_validation ⇒ Boolean, ...

Avoid validating models when creating a deployment.

Returns:



347
348
349
 
# File 'api_gatewayv2/cfn_api.rb', line 347

def disable_schema_validation()
  jsii_get_property("disableSchemaValidation")
end

#disable_schema_validation=(value) ⇒ Object 



351
352
353
354
 
# File 'api_gatewayv2/cfn_api.rb', line 351

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



187
188
189
 
# File 'api_gatewayv2/cfn_api.rb', line 187

def env()
  jsii_get_property("env")
end

#fail_on_warnings ⇒ Boolean, ...

Specifies whether to rollback the API creation when a warning is encountered.

Returns:



359
360
361
 
# File 'api_gatewayv2/cfn_api.rb', line 359

def fail_on_warnings()
  jsii_get_property("failOnWarnings")
end

#fail_on_warnings=(value) ⇒ Object 



363
364
365
366
 
# File 'api_gatewayv2/cfn_api.rb', line 363

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



669
670
671
672
673
 
# File 'api_gatewayv2/cfn_api.rb', line 669

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:



680
681
682
683
 
# File 'api_gatewayv2/cfn_api.rb', line 680

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



750
751
752
753
 
# File 'api_gatewayv2/cfn_api.rb', line 750

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

#ip_address_type ⇒ String?

The IP address types that can invoke the API.

Returns:

  • (String, nil) 


371
372
373
 
# File 'api_gatewayv2/cfn_api.rb', line 371

def ip_address_type()
  jsii_get_property("ipAddressType")
end

#ip_address_type=(value) ⇒ Object 



375
376
377
378
 
# File 'api_gatewayv2/cfn_api.rb', line 375

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


139
140
141
 
# File 'api_gatewayv2/cfn_api.rb', line 139

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String?

The name of the API.

Returns:

  • (String, nil) 


383
384
385
 
# File 'api_gatewayv2/cfn_api.rb', line 383

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



387
388
389
390
 
# File 'api_gatewayv2/cfn_api.rb', line 387

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


122
123
124
 
# File 'api_gatewayv2/cfn_api.rb', line 122

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:



691
692
693
 
# File 'api_gatewayv2/cfn_api.rb', line 691

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:



698
699
700
 
# File 'api_gatewayv2/cfn_api.rb', line 698

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
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.



491
492
493
494
 
# File 'api_gatewayv2/cfn_api.rb', line 491

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

#protocol_type ⇒ String?

The API protocol.

Returns:

  • (String, nil) 


395
396
397
 
# File 'api_gatewayv2/cfn_api.rb', line 395

def protocol_type()
  jsii_get_property("protocolType")
end

#protocol_type=(value) ⇒ Object 



399
400
401
402
 
# File 'api_gatewayv2/cfn_api.rb', line 399

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


158
159
160
 
# File 'api_gatewayv2/cfn_api.rb', line 158

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:



709
710
711
712
 
# File 'api_gatewayv2/cfn_api.rb', line 709

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}) 


716
717
718
719
 
# File 'api_gatewayv2/cfn_api.rb', line 716

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:



726
727
728
729
730
 
# File 'api_gatewayv2/cfn_api.rb', line 726

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

#route_key ⇒ String?

This property is part of quick create.

Returns:

  • (String, nil) 


407
408
409
 
# File 'api_gatewayv2/cfn_api.rb', line 407

def route_key()
  jsii_get_property("routeKey")
end

#route_key=(value) ⇒ Object 



411
412
413
414
 
# File 'api_gatewayv2/cfn_api.rb', line 411

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

#route_selection_expression ⇒ String?

The route selection expression for the API.

Returns:

  • (String, nil) 


419
420
421
 
# File 'api_gatewayv2/cfn_api.rb', line 419

def route_selection_expression()
  jsii_get_property("routeSelectionExpression")
end

#route_selection_expression=(value) ⇒ Object 



423
424
425
426
 
# File 'api_gatewayv2/cfn_api.rb', line 423

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



735
736
737
 
# File 'api_gatewayv2/cfn_api.rb', line 735

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:



148
149
150
 
# File 'api_gatewayv2/cfn_api.rb', line 148

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



242
243
244
 
# File 'api_gatewayv2/cfn_api.rb', line 242

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Hash{String => String}?

The collection of tags.

Returns:

  • (Hash{String => String}, nil) 


431
432
433
 
# File 'api_gatewayv2/cfn_api.rb', line 431

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



435
436
437
438
 
# File 'api_gatewayv2/cfn_api.rb', line 435

def tags_raw=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#target ⇒ String?

This property is part of quick create.

Returns:

  • (String, nil) 


443
444
445
 
# File 'api_gatewayv2/cfn_api.rb', line 443

def target()
  jsii_get_property("target")
end

#target=(value) ⇒ Object 



447
448
449
450
 
# File 'api_gatewayv2/cfn_api.rb', line 447

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



467
468
469
 
# File 'api_gatewayv2/cfn_api.rb', line 467

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}) 


195
196
197
 
# File 'api_gatewayv2/cfn_api.rb', line 195

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}) 


205
206
207
 
# File 'api_gatewayv2/cfn_api.rb', line 205

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


741
742
743
744
 
# File 'api_gatewayv2/cfn_api.rb', line 741

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

#version ⇒ String?

A version identifier for the API.

Returns:

  • (String, nil) 


455
456
457
 
# File 'api_gatewayv2/cfn_api.rb', line 455

def version()
  jsii_get_property("version")
end

#version=(value) ⇒ Object 



459
460
461
462
 
# File 'api_gatewayv2/cfn_api.rb', line 459

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


480
481
482
483
484
485
 
# File 'api_gatewayv2/cfn_api.rb', line 480

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