Class: AWSCDK::SAM::CfnAPI

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

Overview

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

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnAPI

Create a new AWS::Serverless::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::SAM::CfnAPIProps) —

    Resource properties.



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

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::SAM::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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FtLkNmbkFwaVByb3BzIn0=")), "props")
  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) 


194
195
196
 
# File 'sam/cfn_api.rb', line 194

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

.is_cfn_api(x) ⇒ Boolean

Checks whether the given object is a CfnApi.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


96
97
98
99
 
# File 'sam/cfn_api.rb', line 96

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_sam.CfnApi", "isCfnApi", [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
81
82
83
84
85
86
87
88
89
90
 
# File 'sam/cfn_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 },
    :api_ref => { kind: :property, name: "apiRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :definition_body => { kind: :property, name: "definitionBody", is_optional: false },
    :gateway_responses => { kind: :property, name: "gatewayResponses", is_optional: false },
    :models => { kind: :property, name: "models", is_optional: false },
    :stage_name => { kind: :property, name: "stageName", is_optional: false },
    :access_log_setting => { kind: :property, name: "accessLogSetting", is_optional: true },
    :always_deploy => { kind: :property, name: "alwaysDeploy", is_optional: true },
    :auth => { kind: :property, name: "auth", is_optional: true },
    :binary_media_types => { kind: :property, name: "binaryMediaTypes", is_optional: true },
    :cache_cluster_enabled => { kind: :property, name: "cacheClusterEnabled", is_optional: true },
    :cache_cluster_size => { kind: :property, name: "cacheClusterSize", is_optional: true },
    :canary_setting => { kind: :property, name: "canarySetting", is_optional: true },
    :cors => { kind: :property, name: "cors", 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 },
    :endpoint_configuration => { kind: :property, name: "endpointConfiguration", is_optional: true },
    :method_settings => { kind: :property, name: "methodSettings", is_optional: true },
    :minimum_compression_size => { kind: :property, name: "minimumCompressionSize", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :open_api_version => { kind: :property, name: "openApiVersion", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :tracing_enabled => { kind: :property, name: "tracingEnabled", is_optional: true },
    :variables => { kind: :property, name: "variables", 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) 


201
202
203
 
# File 'sam/cfn_api.rb', line 201

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

Instance Method Details

#access_log_setting ⇒ AWSCDK::IResolvable, ...

Returns:



260
261
262
 
# File 'sam/cfn_api.rb', line 260

def access_log_setting()
  jsii_get_property("accessLogSetting")
end

#access_log_setting=(value) ⇒ Object 



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

def access_log_setting=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SAM::CfnAPI::AccessLogSettingProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuQXBpLkFjY2Vzc0xvZ1NldHRpbmdQcm9wZXJ0eSJ9XX19")), "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.



502
503
504
505
 
# File 'sam/cfn_api.rb', line 502

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:



514
515
516
517
 
# File 'sam/cfn_api.rb', line 514

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:



524
525
526
527
 
# File 'sam/cfn_api.rb', line 524

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:



535
536
537
538
539
 
# File 'sam/cfn_api.rb', line 535

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.


592
593
594
595
596
 
# File 'sam/cfn_api.rb', line 592

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.



602
603
604
605
 
# File 'sam/cfn_api.rb', line 602

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.



614
615
616
617
618
 
# File 'sam/cfn_api.rb', line 614

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

#always_deploy ⇒ Boolean, ...

Returns:



271
272
273
 
# File 'sam/cfn_api.rb', line 271

def always_deploy()
  jsii_get_property("alwaysDeploy")
end

#always_deploy=(value) ⇒ Object 



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

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

#api_ref ⇒ AWSCDK::Interfaces::AWSSAM::APIReference

A reference to a Api resource.

Returns:



208
209
210
 
# File 'sam/cfn_api.rb', line 208

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:



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

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:



649
650
651
652
653
654
 
# File 'sam/cfn_api.rb', line 649

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:



281
282
283
 
# File 'sam/cfn_api.rb', line 281

def auth()
  jsii_get_property("auth")
end

#auth=(value) ⇒ Object 



285
286
287
288
289
 
# File 'sam/cfn_api.rb', line 285

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

#binary_media_types ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


292
293
294
 
# File 'sam/cfn_api.rb', line 292

def binary_media_types()
  jsii_get_property("binaryMediaTypes")
end

#binary_media_types=(value) ⇒ Object 



296
297
298
299
 
# File 'sam/cfn_api.rb', line 296

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

#cache_cluster_enabled ⇒ Boolean, ...

Returns:



302
303
304
 
# File 'sam/cfn_api.rb', line 302

def cache_cluster_enabled()
  jsii_get_property("cacheClusterEnabled")
end

#cache_cluster_enabled=(value) ⇒ Object 



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

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

#cache_cluster_size ⇒ String?

Returns:

  • (String, nil) 


312
313
314
 
# File 'sam/cfn_api.rb', line 312

def cache_cluster_size()
  jsii_get_property("cacheClusterSize")
end

#cache_cluster_size=(value) ⇒ Object 



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

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

#canary_setting ⇒ AWSCDK::IResolvable, ...

Returns:



322
323
324
 
# File 'sam/cfn_api.rb', line 322

def canary_setting()
  jsii_get_property("canarySetting")
end

#canary_setting=(value) ⇒ Object 



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

def canary_setting=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SAM::CfnAPI::CanarySettingProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuQXBpLkNhbmFyeVNldHRpbmdQcm9wZXJ0eSJ9XX19")), "canarySetting") unless value.nil?
  jsii_set_property("canarySetting", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


152
153
154
 
# File 'sam/cfn_api.rb', line 152

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


658
659
660
661
 
# File 'sam/cfn_api.rb', line 658

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


157
158
159
 
# File 'sam/cfn_api.rb', line 157

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


164
165
166
 
# File 'sam/cfn_api.rb', line 164

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cors ⇒ String, ...

Returns:



333
334
335
 
# File 'sam/cfn_api.rb', line 333

def cors()
  jsii_get_property("cors")
end

#cors=(value) ⇒ Object 



337
338
339
340
341
 
# File 'sam/cfn_api.rb', line 337

def cors=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SAM::CfnAPI::CorsConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5JUmVzb2x2YWJsZSJ9LHsiZnFuIjoiYXdzLWNkay1saWIuYXdzX3NhbS5DZm5BcGkuQ29yc0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "cors") unless value.nil?
  jsii_set_property("cors", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


109
110
111
 
# File 'sam/cfn_api.rb', line 109

def creation_stack()
  jsii_get_property("creationStack")
end

#definition_body ⇒ Object

Returns:

  • (Object) 


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

def definition_body()
  jsii_get_property("definitionBody")
end

#definition_body=(value) ⇒ Object 



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

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:



344
345
346
 
# File 'sam/cfn_api.rb', line 344

def definition_uri()
  jsii_get_property("definitionUri")
end

#definition_uri=(value) ⇒ Object 



348
349
350
351
352
 
# File 'sam/cfn_api.rb', line 348

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

#description ⇒ String?

Returns:

  • (String, nil) 


355
356
357
 
# File 'sam/cfn_api.rb', line 355

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



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

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:



365
366
367
 
# File 'sam/cfn_api.rb', line 365

def disable_execute_api_endpoint()
  jsii_get_property("disableExecuteApiEndpoint")
end

#disable_execute_api_endpoint=(value) ⇒ Object 



369
370
371
372
 
# File 'sam/cfn_api.rb', line 369

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:



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

def domain()
  jsii_get_property("domain")
end

#domain=(value) ⇒ Object 



379
380
381
382
383
 
# File 'sam/cfn_api.rb', line 379

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

#endpoint_configuration ⇒ String, ...

Returns:



386
387
388
 
# File 'sam/cfn_api.rb', line 386

def endpoint_configuration()
  jsii_get_property("endpointConfiguration")
end

#endpoint_configuration=(value) ⇒ Object 



390
391
392
393
394
 
# File 'sam/cfn_api.rb', line 390

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



169
170
171
 
# File 'sam/cfn_api.rb', line 169

def env()
  jsii_get_property("env")
end

#gateway_responses ⇒ Object

Returns:

  • (Object) 


230
231
232
 
# File 'sam/cfn_api.rb', line 230

def gateway_responses()
  jsii_get_property("gatewayResponses")
end

#gateway_responses=(value) ⇒ Object 



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

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



671
672
673
674
675
 
# File 'sam/cfn_api.rb', line 671

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:



682
683
684
685
 
# File 'sam/cfn_api.rb', line 682

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:



752
753
754
755
 
# File 'sam/cfn_api.rb', line 752

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) 


121
122
123
 
# File 'sam/cfn_api.rb', line 121

def logical_id()
  jsii_get_property("logicalId")
end

#method_settings ⇒ Array<Object>, ...

Returns:



397
398
399
 
# File 'sam/cfn_api.rb', line 397

def method_settings()
  jsii_get_property("methodSettings")
end

#method_settings=(value) ⇒ Object 



401
402
403
404
 
# File 'sam/cfn_api.rb', line 401

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

#minimum_compression_size ⇒ Numeric?

Returns:

  • (Numeric, nil) 


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

def minimum_compression_size()
  jsii_get_property("minimumCompressionSize")
end

#minimum_compression_size=(value) ⇒ Object 



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

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

#models ⇒ Object

Returns:

  • (Object) 


240
241
242
 
# File 'sam/cfn_api.rb', line 240

def models()
  jsii_get_property("models")
end

#models=(value) ⇒ Object 



244
245
246
247
 
# File 'sam/cfn_api.rb', line 244

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

#name ⇒ String?

Returns:

  • (String, nil) 


417
418
419
 
# File 'sam/cfn_api.rb', line 417

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



421
422
423
424
 
# File 'sam/cfn_api.rb', line 421

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) 


104
105
106
 
# File 'sam/cfn_api.rb', line 104

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:



693
694
695
 
# File 'sam/cfn_api.rb', line 693

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:



700
701
702
 
# File 'sam/cfn_api.rb', line 700

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

#open_api_version ⇒ String?

Returns:

  • (String, nil) 


427
428
429
 
# File 'sam/cfn_api.rb', line 427

def open_api_version()
  jsii_get_property("openApiVersion")
end

#open_api_version=(value) ⇒ Object 



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

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

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

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

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



493
494
495
496
 
# File 'sam/cfn_api.rb', line 493

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) 


140
141
142
 
# File 'sam/cfn_api.rb', line 140

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:



711
712
713
714
 
# File 'sam/cfn_api.rb', line 711

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


718
719
720
721
 
# File 'sam/cfn_api.rb', line 718

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:



728
729
730
731
732
 
# File 'sam/cfn_api.rb', line 728

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

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



737
738
739
 
# File 'sam/cfn_api.rb', line 737

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:



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

def stack()
  jsii_get_property("stack")
end

#stage_name ⇒ String

Returns:

  • (String) 


250
251
252
 
# File 'sam/cfn_api.rb', line 250

def stage_name()
  jsii_get_property("stageName")
end

#stage_name=(value) ⇒ Object 



254
255
256
257
 
# File 'sam/cfn_api.rb', line 254

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

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



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

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Hash{String => String}?

Returns:

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


437
438
439
 
# File 'sam/cfn_api.rb', line 437

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



441
442
443
444
 
# File 'sam/cfn_api.rb', line 441

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



469
470
471
 
# File 'sam/cfn_api.rb', line 469

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

#tracing_enabled ⇒ Boolean, ...

Returns:



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

def tracing_enabled()
  jsii_get_property("tracingEnabled")
end

#tracing_enabled=(value) ⇒ Object 



451
452
453
454
 
# File 'sam/cfn_api.rb', line 451

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


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

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


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

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


743
744
745
746
 
# File 'sam/cfn_api.rb', line 743

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

#variables ⇒ AWSCDK::IResolvable, ...

Returns:



457
458
459
 
# File 'sam/cfn_api.rb', line 457

def variables()
  jsii_get_property("variables")
end

#variables=(value) ⇒ Object 



461
462
463
464
 
# File 'sam/cfn_api.rb', line 461

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


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

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