Class: AWSCDK::APIGateway::CfnRestAPI

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSApigateway::IRestAPIRef
Defined in:
api_gateway/cfn_rest_api.rb

Overview

The AWS::ApiGateway::RestApi resource creates a REST API.

For more information, see restapi:create in the Amazon API Gateway REST API Reference .

On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative , becoming the foundation of the OpenAPI Specification.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new AWS::ApiGateway::RestApi.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::APIGateway::CfnRestAPIProps, nil) (defaults to: nil) —

    Resource properties.



22
23
24
25
26
27
28
 
# File 'api_gateway/cfn_rest_api.rb', line 22

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

Class Method Details

.arn_for_rest_api(resource) ⇒ String

Parameters:

Returns:

  • (String) 


93
94
95
96
 
# File 'api_gateway/cfn_rest_api.rb', line 93

def self.arn_for_rest_api(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcGlnYXRld2F5LklSZXN0QXBpUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.CfnRestApi", "arnForRestApi", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


213
214
215
 
# File 'api_gateway/cfn_rest_api.rb', line 213

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

.from_rest_api_id(scope, id, rest_api_id) ⇒ AWSCDK::Interfaces::AWSApigateway::IRestAPIRef

Creates a new IRestApiRef from a restApiId.

Parameters:

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

Returns:



104
105
106
107
108
109
 
# File 'api_gateway/cfn_rest_api.rb', line 104

def self.from_rest_api_id(scope, id, rest_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(rest_api_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "restApiId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.CfnRestApi", "fromRestApiId", [scope, id, rest_api_id])
end

.is_cfn_rest_api(x) ⇒ Boolean

Checks whether the given object is a CfnRestApi.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


115
116
117
118
 
# File 'api_gateway/cfn_rest_api.rb', line 115

def self.is_cfn_rest_api(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.CfnRestApi", "isCfnRestApi", [x])
end

.jsii_overridable_methods ⇒ Object 



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
 
# File 'api_gateway/cfn_rest_api.rb', line 30

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_rest_api_id => { kind: :property, name: "attrRestApiId", is_optional: false },
    :attr_root_resource_id => { kind: :property, name: "attrRootResourceId", is_optional: false },
    :rest_api_ref => { kind: :property, name: "restApiRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :body => { kind: :property, name: "body", is_optional: false },
    :policy => { kind: :property, name: "policy", is_optional: false },
    :api_key_source_type => { kind: :property, name: "apiKeySourceType", is_optional: true },
    :binary_media_types => { kind: :property, name: "binaryMediaTypes", is_optional: true },
    :body_s3_location => { kind: :property, name: "bodyS3Location", is_optional: true },
    :clone_from => { kind: :property, name: "cloneFrom", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :disable_execute_api_endpoint => { kind: :property, name: "disableExecuteApiEndpoint", is_optional: true },
    :endpoint_access_mode => { kind: :property, name: "endpointAccessMode", is_optional: true },
    :endpoint_configuration => { kind: :property, name: "endpointConfiguration", is_optional: true },
    :fail_on_warnings => { kind: :property, name: "failOnWarnings", is_optional: true },
    :minimum_compression_size => { kind: :property, name: "minimumCompressionSize", is_optional: true },
    :mode => { kind: :property, name: "mode", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :parameters => { kind: :property, name: "parameters", is_optional: true },
    :security_policy => { kind: :property, name: "securityPolicy", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", 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.



488
489
490
491
 
# File 'api_gateway/cfn_rest_api.rb', line 488

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:



500
501
502
503
 
# File 'api_gateway/cfn_rest_api.rb', line 500

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:



510
511
512
513
 
# File 'api_gateway/cfn_rest_api.rb', line 510

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:



521
522
523
524
525
 
# File 'api_gateway/cfn_rest_api.rb', line 521

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.


578
579
580
581
582
 
# File 'api_gateway/cfn_rest_api.rb', line 578

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.



588
589
590
591
 
# File 'api_gateway/cfn_rest_api.rb', line 588

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.



600
601
602
603
604
 
# File 'api_gateway/cfn_rest_api.rb', line 600

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_source_type ⇒ String?

The source of the API key for metering requests according to a usage plan.

Returns:

  • (String, nil) 


272
273
274
 
# File 'api_gateway/cfn_rest_api.rb', line 272

def api_key_source_type()
  jsii_get_property("apiKeySourceType")
end

#api_key_source_type=(value) ⇒ Object 



276
277
278
279
 
# File 'api_gateway/cfn_rest_api.rb', line 276

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



613
614
615
616
 
# File 'api_gateway/cfn_rest_api.rb', line 613

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:



635
636
637
638
639
640
 
# File 'api_gateway/cfn_rest_api.rb', line 635

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

The string identifier of the associated RestApi.

Returns:

  • (String) 


220
221
222
 
# File 'api_gateway/cfn_rest_api.rb', line 220

def attr_rest_api_id()
  jsii_get_property("attrRestApiId")
end

#attr_root_resource_id ⇒ String

The root resource ID for a RestApi resource, such as a0bc123d4e .

Returns:

  • (String) 


227
228
229
 
# File 'api_gateway/cfn_rest_api.rb', line 227

def attr_root_resource_id()
  jsii_get_property("attrRootResourceId")
end

#binary_media_types ⇒ Array<String>?

The list of binary media types supported by the RestApi.

Returns:

  • (Array<String>, nil) 


284
285
286
 
# File 'api_gateway/cfn_rest_api.rb', line 284

def binary_media_types()
  jsii_get_property("binaryMediaTypes")
end

#binary_media_types=(value) ⇒ Object 



288
289
290
291
 
# File 'api_gateway/cfn_rest_api.rb', line 288

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

#body ⇒ Object

An OpenAPI specification that defines a set of RESTful APIs in JSON format.

Returns:

  • (Object) 


248
249
250
 
# File 'api_gateway/cfn_rest_api.rb', line 248

def body()
  jsii_get_property("body")
end

#body=(value) ⇒ Object 



252
253
254
255
 
# File 'api_gateway/cfn_rest_api.rb', line 252

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 Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.

Returns:



296
297
298
 
# File 'api_gateway/cfn_rest_api.rb', line 296

def body_s3_location()
  jsii_get_property("bodyS3Location")
end

#body_s3_location=(value) ⇒ Object 



300
301
302
303
304
 
# File 'api_gateway/cfn_rest_api.rb', line 300

def body_s3_location=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::APIGateway::CfnRestAPI::S3LocationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcGlnYXRld2F5LkNmblJlc3RBcGkuUzNMb2NhdGlvblByb3BlcnR5In1dfX0=")), "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:



166
167
168
 
# File 'api_gateway/cfn_rest_api.rb', line 166

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


171
172
173
 
# File 'api_gateway/cfn_rest_api.rb', line 171

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


644
645
646
647
 
# File 'api_gateway/cfn_rest_api.rb', line 644

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


176
177
178
 
# File 'api_gateway/cfn_rest_api.rb', line 176

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


183
184
185
 
# File 'api_gateway/cfn_rest_api.rb', line 183

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#clone_from ⇒ String?

The ID of the RestApi that you want to clone from.

Returns:

  • (String, nil) 


309
310
311
 
# File 'api_gateway/cfn_rest_api.rb', line 309

def clone_from()
  jsii_get_property("cloneFrom")
end

#clone_from=(value) ⇒ Object 



313
314
315
316
 
# File 'api_gateway/cfn_rest_api.rb', line 313

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


128
129
130
 
# File 'api_gateway/cfn_rest_api.rb', line 128

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The description of the RestApi.

Returns:

  • (String, nil) 


321
322
323
 
# File 'api_gateway/cfn_rest_api.rb', line 321

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



325
326
327
328
 
# File 'api_gateway/cfn_rest_api.rb', line 325

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:



333
334
335
 
# File 'api_gateway/cfn_rest_api.rb', line 333

def disable_execute_api_endpoint()
  jsii_get_property("disableExecuteApiEndpoint")
end

#disable_execute_api_endpoint=(value) ⇒ Object 



337
338
339
340
 
# File 'api_gateway/cfn_rest_api.rb', line 337

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

#endpoint_access_mode ⇒ String?

The endpoint access mode for your RestApi.

Returns:

  • (String, nil) 


345
346
347
 
# File 'api_gateway/cfn_rest_api.rb', line 345

def endpoint_access_mode()
  jsii_get_property("endpointAccessMode")
end

#endpoint_access_mode=(value) ⇒ Object 



349
350
351
352
 
# File 'api_gateway/cfn_rest_api.rb', line 349

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

#endpoint_configuration ⇒ AWSCDK::IResolvable, ...

A list of the endpoint types and IP address types of the API.

Returns:



357
358
359
 
# File 'api_gateway/cfn_rest_api.rb', line 357

def endpoint_configuration()
  jsii_get_property("endpointConfiguration")
end

#endpoint_configuration=(value) ⇒ Object 



361
362
363
364
365
 
# File 'api_gateway/cfn_rest_api.rb', line 361

def endpoint_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::APIGateway::CfnRestAPI::EndpointConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcGlnYXRld2F5LkNmblJlc3RBcGkuRW5kcG9pbnRDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "endpointConfiguration") unless value.nil?
  jsii_set_property("endpointConfiguration", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



188
189
190
 
# File 'api_gateway/cfn_rest_api.rb', line 188

def env()
  jsii_get_property("env")
end

#fail_on_warnings ⇒ Boolean, ...

A query parameter to indicate whether to rollback the API update ( true ) or not ( false ) when a warning is encountered.

Returns:



370
371
372
 
# File 'api_gateway/cfn_rest_api.rb', line 370

def fail_on_warnings()
  jsii_get_property("failOnWarnings")
end

#fail_on_warnings=(value) ⇒ Object 



374
375
376
377
 
# File 'api_gateway/cfn_rest_api.rb', line 374

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:



657
658
659
660
661
 
# File 'api_gateway/cfn_rest_api.rb', line 657

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:



668
669
670
671
 
# File 'api_gateway/cfn_rest_api.rb', line 668

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:



738
739
740
741
 
# File 'api_gateway/cfn_rest_api.rb', line 738

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


140
141
142
 
# File 'api_gateway/cfn_rest_api.rb', line 140

def logical_id()
  jsii_get_property("logicalId")
end

#minimum_compression_size ⇒ Numeric?

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API.

Returns:

  • (Numeric, nil) 


382
383
384
 
# File 'api_gateway/cfn_rest_api.rb', line 382

def minimum_compression_size()
  jsii_get_property("minimumCompressionSize")
end

#minimum_compression_size=(value) ⇒ Object 



386
387
388
389
 
# File 'api_gateway/cfn_rest_api.rb', line 386

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

#mode ⇒ String?

This property applies only when you use OpenAPI to define your REST API.

Returns:

  • (String, nil) 


394
395
396
 
# File 'api_gateway/cfn_rest_api.rb', line 394

def mode()
  jsii_get_property("mode")
end

#mode=(value) ⇒ Object 



398
399
400
401
 
# File 'api_gateway/cfn_rest_api.rb', line 398

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

#name ⇒ String?

The name of the RestApi.

Returns:

  • (String, nil) 


406
407
408
 
# File 'api_gateway/cfn_rest_api.rb', line 406

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



410
411
412
413
 
# File 'api_gateway/cfn_rest_api.rb', line 410

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) 


123
124
125
 
# File 'api_gateway/cfn_rest_api.rb', line 123

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:



679
680
681
 
# File 'api_gateway/cfn_rest_api.rb', line 679

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:



686
687
688
 
# File 'api_gateway/cfn_rest_api.rb', line 686

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.



479
480
481
482
 
# File 'api_gateway/cfn_rest_api.rb', line 479

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

#parameters ⇒ AWSCDK::IResolvable, ...

Custom header parameters as part of the request.

Returns:



418
419
420
 
# File 'api_gateway/cfn_rest_api.rb', line 418

def parameters()
  jsii_get_property("parameters")
end

#parameters=(value) ⇒ Object 



422
423
424
425
 
# File 'api_gateway/cfn_rest_api.rb', line 422

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

#policy ⇒ Object

A policy document that contains the permissions for the RestApi resource.

Returns:

  • (Object) 


260
261
262
 
# File 'api_gateway/cfn_rest_api.rb', line 260

def policy()
  jsii_get_property("policy")
end

#policy=(value) ⇒ Object 



264
265
266
267
 
# File 'api_gateway/cfn_rest_api.rb', line 264

def policy=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "policy")
  jsii_set_property("policy", 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) 


159
160
161
 
# File 'api_gateway/cfn_rest_api.rb', line 159

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:



697
698
699
700
 
# File 'api_gateway/cfn_rest_api.rb', line 697

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


704
705
706
707
 
# File 'api_gateway/cfn_rest_api.rb', line 704

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:



714
715
716
717
718
 
# File 'api_gateway/cfn_rest_api.rb', line 714

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

#rest_api_ref ⇒ AWSCDK::Interfaces::AWSApigateway::RestAPIReference

A reference to a RestApi resource.

Returns:



234
235
236
 
# File 'api_gateway/cfn_rest_api.rb', line 234

def rest_api_ref()
  jsii_get_property("restApiRef")
end

#security_policy ⇒ String?

The Transport Layer Security (TLS) version + cipher suite for this RestApi.

Returns:

  • (String, nil) 


430
431
432
 
# File 'api_gateway/cfn_rest_api.rb', line 430

def security_policy()
  jsii_get_property("securityPolicy")
end

#security_policy=(value) ⇒ Object 



434
435
436
437
 
# File 'api_gateway/cfn_rest_api.rb', line 434

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



723
724
725
 
# File 'api_gateway/cfn_rest_api.rb', line 723

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:



149
150
151
 
# File 'api_gateway/cfn_rest_api.rb', line 149

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



241
242
243
 
# File 'api_gateway/cfn_rest_api.rb', line 241

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The key-value map of strings.

Returns:



442
443
444
 
# File 'api_gateway/cfn_rest_api.rb', line 442

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



446
447
448
449
450
 
# File 'api_gateway/cfn_rest_api.rb', line 446

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



455
456
457
 
# File 'api_gateway/cfn_rest_api.rb', line 455

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


196
197
198
 
# File 'api_gateway/cfn_rest_api.rb', line 196

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


206
207
208
 
# File 'api_gateway/cfn_rest_api.rb', line 206

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


729
730
731
732
 
# File 'api_gateway/cfn_rest_api.rb', line 729

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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) 


468
469
470
471
472
473
 
# File 'api_gateway/cfn_rest_api.rb', line 468

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