Class: AWSCDK::SAM::CfnHttpAPI

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSSAM::IHttpAPIRef
Defined in:
sam/cfn_http_api.rb

Overview

https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new AWS::Serverless::HttpApi.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::SAM::CfnHttpAPIProps, nil) (defaults to: nil) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'sam/cfn_http_api.rb', line 18

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

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


184
185
186
 
# File 'sam/cfn_http_api.rb', line 184

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

.is_cfn_http_api(x) ⇒ Boolean

Checks whether the given object is a CfnHttpApi.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


86
87
88
89
 
# File 'sam/cfn_http_api.rb', line 86

def self.is_cfn_http_api(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_sam.CfnHttpApi", "isCfnHttpApi", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'sam/cfn_http_api.rb', line 26

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 },
    :http_api_ref => { kind: :property, name: "httpApiRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :definition_body => { kind: :property, name: "definitionBody", is_optional: false },
    :access_log_setting => { kind: :property, name: "accessLogSetting", is_optional: true },
    :auth => { kind: :property, name: "auth", is_optional: true },
    :cors_configuration => { kind: :property, name: "corsConfiguration", is_optional: true },
    :default_route_settings => { kind: :property, name: "defaultRouteSettings", is_optional: true },
    :definition_uri => { kind: :property, name: "definitionUri", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :disable_execute_api_endpoint => { kind: :property, name: "disableExecuteApiEndpoint", is_optional: true },
    :domain => { kind: :property, name: "domain", is_optional: true },
    :fail_on_warnings => { kind: :property, name: "failOnWarnings", is_optional: true },
    :route_settings => { kind: :property, name: "routeSettings", is_optional: true },
    :stage_name => { kind: :property, name: "stageName", is_optional: true },
    :stage_variables => { kind: :property, name: "stageVariables", 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

.REQUIRED_TRANSFORM ⇒ String

The Transform a template must use in order to use this resource.

Returns:

  • (String) 


191
192
193
 
# File 'sam/cfn_http_api.rb', line 191

def self.REQUIRED_TRANSFORM()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_sam.CfnHttpApi", "REQUIRED_TRANSFORM")
end

Instance Method Details

#access_log_setting ⇒ AWSCDK::IResolvable, ...

Returns:



220
221
222
 
# File 'sam/cfn_http_api.rb', line 220

def access_log_setting()
  jsii_get_property("accessLogSetting")
end

#access_log_setting=(value) ⇒ Object 



224
225
226
227
228
 
# File 'sam/cfn_http_api.rb', line 224

def access_log_setting=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SAM::CfnHttpAPI::AccessLogSettingProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuSHR0cEFwaS5BY2Nlc3NMb2dTZXR0aW5nUHJvcGVydHkifV19fQ==")), "accessLogSetting") unless value.nil?
  jsii_set_property("accessLogSetting", value)
end

#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.



392
393
394
395
 
# File 'sam/cfn_http_api.rb', line 392

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:



404
405
406
407
 
# File 'sam/cfn_http_api.rb', line 404

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:



414
415
416
417
 
# File 'sam/cfn_http_api.rb', line 414

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:



425
426
427
428
429
 
# File 'sam/cfn_http_api.rb', line 425

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.


482
483
484
485
486
 
# File 'sam/cfn_http_api.rb', line 482

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.



492
493
494
495
 
# File 'sam/cfn_http_api.rb', line 492

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.



504
505
506
507
508
 
# File 'sam/cfn_http_api.rb', line 504

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

#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:



517
518
519
520
 
# File 'sam/cfn_http_api.rb', line 517

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:



539
540
541
542
543
544
 
# File 'sam/cfn_http_api.rb', line 539

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

#auth ⇒ AWSCDK::IResolvable, ...

Returns:



231
232
233
 
# File 'sam/cfn_http_api.rb', line 231

def auth()
  jsii_get_property("auth")
end

#auth=(value) ⇒ Object 



235
236
237
238
239
 
# File 'sam/cfn_http_api.rb', line 235

def auth=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SAM::CfnHttpAPI::HttpAPIAuthProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuSHR0cEFwaS5IdHRwQXBpQXV0aFByb3BlcnR5In1dfX0=")), "auth") unless value.nil?
  jsii_set_property("auth", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



137
138
139
 
# File 'sam/cfn_http_api.rb', line 137

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


142
143
144
 
# File 'sam/cfn_http_api.rb', line 142

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


548
549
550
551
 
# File 'sam/cfn_http_api.rb', line 548

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


147
148
149
 
# File 'sam/cfn_http_api.rb', line 147

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


154
155
156
 
# File 'sam/cfn_http_api.rb', line 154

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cors_configuration ⇒ Boolean, ...

Returns:



242
243
244
 
# File 'sam/cfn_http_api.rb', line 242

def cors_configuration()
  jsii_get_property("corsConfiguration")
end

#cors_configuration=(value) ⇒ Object 



246
247
248
249
250
 
# File 'sam/cfn_http_api.rb', line 246

def cors_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SAM::CfnHttpAPI::CorsConfigurationObjectProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuSHR0cEFwaS5Db3JzQ29uZmlndXJhdGlvbk9iamVjdFByb3BlcnR5In1dfX0=")), "corsConfiguration") unless value.nil?
  jsii_set_property("corsConfiguration", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


99
100
101
 
# File 'sam/cfn_http_api.rb', line 99

def creation_stack()
  jsii_get_property("creationStack")
end

#default_route_settings ⇒ AWSCDK::IResolvable, ...

Returns:



253
254
255
 
# File 'sam/cfn_http_api.rb', line 253

def default_route_settings()
  jsii_get_property("defaultRouteSettings")
end

#default_route_settings=(value) ⇒ Object 



257
258
259
260
261
 
# File 'sam/cfn_http_api.rb', line 257

def default_route_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SAM::CfnHttpAPI::RouteSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuSHR0cEFwaS5Sb3V0ZVNldHRpbmdzUHJvcGVydHkifV19fQ==")), "defaultRouteSettings") unless value.nil?
  jsii_set_property("defaultRouteSettings", value)
end

#definition_body ⇒ Object

Returns:

  • (Object) 


210
211
212
 
# File 'sam/cfn_http_api.rb', line 210

def definition_body()
  jsii_get_property("definitionBody")
end

#definition_body=(value) ⇒ Object 



214
215
216
217
 
# File 'sam/cfn_http_api.rb', line 214

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

#definition_uri ⇒ String, ...

Returns:



264
265
266
 
# File 'sam/cfn_http_api.rb', line 264

def definition_uri()
  jsii_get_property("definitionUri")
end

#definition_uri=(value) ⇒ Object 



268
269
270
271
272
 
# File 'sam/cfn_http_api.rb', line 268

def definition_uri=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SAM::CfnHttpAPI::S3LocationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5JUmVzb2x2YWJsZSJ9LHsiZnFuIjoiYXdzLWNkay1saWIuYXdzX3NhbS5DZm5IdHRwQXBpLlMzTG9jYXRpb25Qcm9wZXJ0eSJ9XX19")), "definitionUri") unless value.nil?
  jsii_set_property("definitionUri", value)
end

#description ⇒ String?

Returns:

  • (String, nil) 


275
276
277
 
# File 'sam/cfn_http_api.rb', line 275

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



279
280
281
282
 
# File 'sam/cfn_http_api.rb', line 279

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, ...

Returns:



285
286
287
 
# File 'sam/cfn_http_api.rb', line 285

def disable_execute_api_endpoint()
  jsii_get_property("disableExecuteApiEndpoint")
end

#disable_execute_api_endpoint=(value) ⇒ Object 



289
290
291
292
 
# File 'sam/cfn_http_api.rb', line 289

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

#domain ⇒ AWSCDK::IResolvable, ...

Returns:



295
296
297
 
# File 'sam/cfn_http_api.rb', line 295

def domain()
  jsii_get_property("domain")
end

#domain=(value) ⇒ Object 



299
300
301
302
303
 
# File 'sam/cfn_http_api.rb', line 299

def domain=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SAM::CfnHttpAPI::HttpAPIDomainConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuSHR0cEFwaS5IdHRwQXBpRG9tYWluQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "domain") unless value.nil?
  jsii_set_property("domain", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



159
160
161
 
# File 'sam/cfn_http_api.rb', line 159

def env()
  jsii_get_property("env")
end

#fail_on_warnings ⇒ Boolean, ...

Returns:



306
307
308
 
# File 'sam/cfn_http_api.rb', line 306

def fail_on_warnings()
  jsii_get_property("failOnWarnings")
end

#fail_on_warnings=(value) ⇒ Object 



310
311
312
313
 
# File 'sam/cfn_http_api.rb', line 310

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:



561
562
563
564
565
 
# File 'sam/cfn_http_api.rb', line 561

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:



572
573
574
575
 
# File 'sam/cfn_http_api.rb', line 572

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

#http_api_ref ⇒ AWSCDK::Interfaces::AWSSAM::HttpAPIReference

A reference to a HttpApi resource.

Returns:



198
199
200
 
# File 'sam/cfn_http_api.rb', line 198

def http_api_ref()
  jsii_get_property("httpApiRef")
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



642
643
644
645
 
# File 'sam/cfn_http_api.rb', line 642

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) 


111
112
113
 
# File 'sam/cfn_http_api.rb', line 111

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


94
95
96
 
# File 'sam/cfn_http_api.rb', line 94

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:



583
584
585
 
# File 'sam/cfn_http_api.rb', line 583

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:



590
591
592
 
# File 'sam/cfn_http_api.rb', line 590

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.



383
384
385
386
 
# File 'sam/cfn_http_api.rb', line 383

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

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


130
131
132
 
# File 'sam/cfn_http_api.rb', line 130

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:



601
602
603
604
 
# File 'sam/cfn_http_api.rb', line 601

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


608
609
610
611
 
# File 'sam/cfn_http_api.rb', line 608

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:



618
619
620
621
622
 
# File 'sam/cfn_http_api.rb', line 618

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_settings ⇒ AWSCDK::IResolvable, ...

Returns:



316
317
318
 
# File 'sam/cfn_http_api.rb', line 316

def route_settings()
  jsii_get_property("routeSettings")
end

#route_settings=(value) ⇒ Object 



320
321
322
323
324
 
# File 'sam/cfn_http_api.rb', line 320

def route_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SAM::CfnHttpAPI::RouteSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuSHR0cEFwaS5Sb3V0ZVNldHRpbmdzUHJvcGVydHkifV19fQ==")), "routeSettings") unless value.nil?
  jsii_set_property("routeSettings", 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.



627
628
629
 
# File 'sam/cfn_http_api.rb', line 627

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:



120
121
122
 
# File 'sam/cfn_http_api.rb', line 120

def stack()
  jsii_get_property("stack")
end

#stage_name ⇒ String?

Returns:

  • (String, nil) 


327
328
329
 
# File 'sam/cfn_http_api.rb', line 327

def stage_name()
  jsii_get_property("stageName")
end

#stage_name=(value) ⇒ Object 



331
332
333
334
 
# File 'sam/cfn_http_api.rb', line 331

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

#stage_variables ⇒ AWSCDK::IResolvable, ...

Returns:



337
338
339
 
# File 'sam/cfn_http_api.rb', line 337

def stage_variables()
  jsii_get_property("stageVariables")
end

#stage_variables=(value) ⇒ Object 



341
342
343
344
 
# File 'sam/cfn_http_api.rb', line 341

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

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



205
206
207
 
# File 'sam/cfn_http_api.rb', line 205

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Hash{String => String}?

Returns:

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


347
348
349
 
# File 'sam/cfn_http_api.rb', line 347

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



351
352
353
354
 
# File 'sam/cfn_http_api.rb', line 351

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



359
360
361
 
# File 'sam/cfn_http_api.rb', line 359

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


167
168
169
 
# File 'sam/cfn_http_api.rb', line 167

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


177
178
179
 
# File 'sam/cfn_http_api.rb', line 177

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


633
634
635
636
 
# File 'sam/cfn_http_api.rb', line 633

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) 


372
373
374
375
376
377
 
# File 'sam/cfn_http_api.rb', line 372

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