Class: AWSCDK::APIGateway::CfnStage

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

Overview

The AWS::ApiGateway::Stage resource creates a stage for a deployment.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnStage

Create a new AWS::ApiGateway::Stage.

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::CfnStageProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'api_gateway/cfn_stage.rb', line 18

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


184
185
186
 
# File 'api_gateway/cfn_stage.rb', line 184

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

.is_cfn_stage(x) ⇒ Boolean

Checks whether the given object is a CfnStage.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


86
87
88
89
 
# File 'api_gateway/cfn_stage.rb', line 86

def self.is_cfn_stage(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.CfnStage", "isCfnStage", [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 'api_gateway/cfn_stage.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 },
    :stage_ref => { kind: :property, name: "stageRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :rest_api_id => { kind: :property, name: "restApiId", is_optional: false },
    :access_log_setting => { kind: :property, name: "accessLogSetting", 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 },
    :client_certificate_id => { kind: :property, name: "clientCertificateId", is_optional: true },
    :deployment_id => { kind: :property, name: "deploymentId", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :documentation_version => { kind: :property, name: "documentationVersion", is_optional: true },
    :method_settings => { kind: :property, name: "methodSettings", is_optional: true },
    :stage_name => { kind: :property, name: "stageName", 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

Instance Method Details

#access_log_setting ⇒ AWSCDK::IResolvable, ...

Access log settings, including the access log format and access log destination ARN.

Returns:



217
218
219
 
# File 'api_gateway/cfn_stage.rb', line 217

def access_log_setting()
  jsii_get_property("accessLogSetting")
end

#access_log_setting=(value) ⇒ Object 



221
222
223
224
225
 
# File 'api_gateway/cfn_stage.rb', line 221

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



409
410
411
412
 
# File 'api_gateway/cfn_stage.rb', line 409

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:



421
422
423
424
 
# File 'api_gateway/cfn_stage.rb', line 421

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:



431
432
433
434
 
# File 'api_gateway/cfn_stage.rb', line 431

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:



442
443
444
445
446
 
# File 'api_gateway/cfn_stage.rb', line 442

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.


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

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.



509
510
511
512
 
# File 'api_gateway/cfn_stage.rb', line 509

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.



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

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:



534
535
536
537
 
# File 'api_gateway/cfn_stage.rb', line 534

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:



556
557
558
559
560
561
 
# File 'api_gateway/cfn_stage.rb', line 556

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

#cache_cluster_enabled ⇒ Boolean, ...

Specifies whether a cache cluster is enabled for the stage.

Returns:



230
231
232
 
# File 'api_gateway/cfn_stage.rb', line 230

def cache_cluster_enabled()
  jsii_get_property("cacheClusterEnabled")
end

#cache_cluster_enabled=(value) ⇒ Object 



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

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?

The stage's cache capacity in GB.

Returns:

  • (String, nil) 


242
243
244
 
# File 'api_gateway/cfn_stage.rb', line 242

def cache_cluster_size()
  jsii_get_property("cacheClusterSize")
end

#cache_cluster_size=(value) ⇒ Object 



246
247
248
249
 
# File 'api_gateway/cfn_stage.rb', line 246

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

Settings for the canary deployment in this stage.

Returns:



254
255
256
 
# File 'api_gateway/cfn_stage.rb', line 254

def canary_setting()
  jsii_get_property("canarySetting")
end

#canary_setting=(value) ⇒ Object 



258
259
260
261
262
 
# File 'api_gateway/cfn_stage.rb', line 258

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



137
138
139
 
# File 'api_gateway/cfn_stage.rb', line 137

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


142
143
144
 
# File 'api_gateway/cfn_stage.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) 


565
566
567
568
 
# File 'api_gateway/cfn_stage.rb', line 565

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 'api_gateway/cfn_stage.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 'api_gateway/cfn_stage.rb', line 154

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#client_certificate_id ⇒ String?

The identifier of a client certificate for an API stage.

Returns:

  • (String, nil) 


267
268
269
 
# File 'api_gateway/cfn_stage.rb', line 267

def client_certificate_id()
  jsii_get_property("clientCertificateId")
end

#client_certificate_id=(value) ⇒ Object 



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

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


99
100
101
 
# File 'api_gateway/cfn_stage.rb', line 99

def creation_stack()
  jsii_get_property("creationStack")
end

#deployment_id ⇒ String?

The identifier of the Deployment that the stage points to.

Returns:

  • (String, nil) 


279
280
281
 
# File 'api_gateway/cfn_stage.rb', line 279

def deployment_id()
  jsii_get_property("deploymentId")
end

#deployment_id=(value) ⇒ Object 



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

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

#description ⇒ String?

The stage's description.

Returns:

  • (String, nil) 


291
292
293
 
# File 'api_gateway/cfn_stage.rb', line 291

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



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

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

#documentation_version ⇒ String?

The version of the associated API documentation.

Returns:

  • (String, nil) 


303
304
305
 
# File 'api_gateway/cfn_stage.rb', line 303

def documentation_version()
  jsii_get_property("documentationVersion")
end

#documentation_version=(value) ⇒ Object 



307
308
309
310
 
# File 'api_gateway/cfn_stage.rb', line 307

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



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

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



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

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:



589
590
591
592
 
# File 'api_gateway/cfn_stage.rb', line 589

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:



659
660
661
662
 
# File 'api_gateway/cfn_stage.rb', line 659

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 'api_gateway/cfn_stage.rb', line 111

def logical_id()
  jsii_get_property("logicalId")
end

#method_settings ⇒ AWSCDK::IResolvable, ...

A map that defines the method settings for a Stage resource.

Returns:



315
316
317
 
# File 'api_gateway/cfn_stage.rb', line 315

def method_settings()
  jsii_get_property("methodSettings")
end

#method_settings=(value) ⇒ Object 



319
320
321
322
 
# File 'api_gateway/cfn_stage.rb', line 319

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


94
95
96
 
# File 'api_gateway/cfn_stage.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:



600
601
602
 
# File 'api_gateway/cfn_stage.rb', line 600

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:



607
608
609
 
# File 'api_gateway/cfn_stage.rb', line 607

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.



400
401
402
403
 
# File 'api_gateway/cfn_stage.rb', line 400

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 'api_gateway/cfn_stage.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:



618
619
620
621
 
# File 'api_gateway/cfn_stage.rb', line 618

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


625
626
627
628
 
# File 'api_gateway/cfn_stage.rb', line 625

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:



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

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

The string identifier of the associated RestApi.

Returns:

  • (String) 


205
206
207
 
# File 'api_gateway/cfn_stage.rb', line 205

def rest_api_id()
  jsii_get_property("restApiId")
end

#rest_api_id=(value) ⇒ Object 



209
210
211
212
 
# File 'api_gateway/cfn_stage.rb', line 209

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



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

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 'api_gateway/cfn_stage.rb', line 120

def stack()
  jsii_get_property("stack")
end

#stage_name ⇒ String?

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.

Returns:

  • (String, nil) 


327
328
329
 
# File 'api_gateway/cfn_stage.rb', line 327

def stage_name()
  jsii_get_property("stageName")
end

#stage_name=(value) ⇒ Object 



331
332
333
334
 
# File 'api_gateway/cfn_stage.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_ref ⇒ AWSCDK::Interfaces::AWSApigateway::StageReference

A reference to a Stage resource.

Returns:



191
192
193
 
# File 'api_gateway/cfn_stage.rb', line 191

def stage_ref()
  jsii_get_property("stageRef")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



198
199
200
 
# File 'api_gateway/cfn_stage.rb', line 198

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The collection of tags.

Returns:



339
340
341
 
# File 'api_gateway/cfn_stage.rb', line 339

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



343
344
345
346
347
 
# File 'api_gateway/cfn_stage.rb', line 343

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



376
377
378
 
# File 'api_gateway/cfn_stage.rb', line 376

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

#tracing_enabled ⇒ Boolean, ...

Specifies whether active tracing with X-ray is enabled for the Stage.

Returns:



352
353
354
 
# File 'api_gateway/cfn_stage.rb', line 352

def tracing_enabled()
  jsii_get_property("tracingEnabled")
end

#tracing_enabled=(value) ⇒ Object 



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

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


167
168
169
 
# File 'api_gateway/cfn_stage.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 'api_gateway/cfn_stage.rb', line 177

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


650
651
652
653
 
# File 'api_gateway/cfn_stage.rb', line 650

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

A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value.

Returns:



364
365
366
 
# File 'api_gateway/cfn_stage.rb', line 364

def variables()
  jsii_get_property("variables")
end

#variables=(value) ⇒ Object 



368
369
370
371
 
# File 'api_gateway/cfn_stage.rb', line 368

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) 


389
390
391
392
393
394
 
# File 'api_gateway/cfn_stage.rb', line 389

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