Class: AWSCDK::APIGateway::StepFunctionsRestAPI

Inherits:
RestAPI
  • Object
show all
Defined in:
api_gateway/step_functions_rest_api.rb

Overview

Defines an API Gateway REST API with a Synchrounous Express State Machine as a proxy integration.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ StepFunctionsRestAPI

Returns a new instance of StepFunctionsRestAPI.

Parameters:



11
12
13
14
15
16
17
 
# File 'api_gateway/step_functions_rest_api.rb', line 11

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

Class Method Details

.jsii_overridable_methods ⇒ Object 



19
20
21
22
23
24
25
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
 
# File 'api_gateway/step_functions_rest_api.rb', line 19

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :rest_api_id => { kind: :property, name: "restApiId", is_optional: false },
    :rest_api_name => { kind: :property, name: "restApiName", is_optional: false },
    :rest_api_ref => { kind: :property, name: "restApiRef", is_optional: false },
    :rest_api_root_resource_id => { kind: :property, name: "restApiRootResourceId", is_optional: false },
    :root => { kind: :property, name: "root", is_optional: false },
    :url => { kind: :property, name: "url", is_optional: false },
    :domain_name => { kind: :property, name: "domainName", is_optional: true },
    :latest_deployment => { kind: :property, name: "latestDeployment", is_optional: true },
    :deployment_stage => { kind: :property, name: "deploymentStage", is_optional: false },
    :cloud_watch_account => { kind: :property, name: "cloudWatchAccount", is_optional: true },
    :resource_policy => { kind: :property, name: "resourcePolicy", is_optional: true },
    :methods => { kind: :property, name: "methods", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", 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 },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :add_api_key => { kind: :method, name: "addApiKey", is_optional: false },
    :add_domain_name => { kind: :method, name: "addDomainName", is_optional: false },
    :add_gateway_response => { kind: :method, name: "addGatewayResponse", is_optional: false },
    :add_to_resource_policy => { kind: :method, name: "addToResourcePolicy", is_optional: false },
    :add_usage_plan => { kind: :method, name: "addUsagePlan", is_optional: false },
    :arn_for_execute_api => { kind: :method, name: "arnForExecuteApi", is_optional: false },
    :grant_invoke_from_vpc_endpoints_only => { kind: :method, name: "grantInvokeFromVpcEndpointsOnly", is_optional: false },
    :metric => { kind: :method, name: "metric", is_optional: false },
    :metric_cache_hit_count => { kind: :method, name: "metricCacheHitCount", is_optional: false },
    :metric_cache_miss_count => { kind: :method, name: "metricCacheMissCount", is_optional: false },
    :metric_client_error => { kind: :method, name: "metricClientError", is_optional: false },
    :metric_count => { kind: :method, name: "metricCount", is_optional: false },
    :metric_integration_latency => { kind: :method, name: "metricIntegrationLatency", is_optional: false },
    :metric_latency => { kind: :method, name: "metricLatency", is_optional: false },
    :metric_server_error => { kind: :method, name: "metricServerError", is_optional: false },
    :url_for_path => { kind: :method, name: "urlForPath", is_optional: false },
    :add_model => { kind: :method, name: "addModel", is_optional: false },
    :add_request_validator => { kind: :method, name: "addRequestValidator", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


211
212
213
 
# File 'api_gateway/step_functions_rest_api.rb', line 211

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

Instance Method Details

#add_api_key(id, options = nil) ⇒ AWSCDK::APIGateway::IAPIKey

Add an ApiKey to the deploymentStage.

Parameters:

Returns:



317
318
319
320
321
322
 
# File 'api_gateway/step_functions_rest_api.rb', line 317

def add_api_key(id, options = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::APIGateway::APIKeyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5BcGlLZXlPcHRpb25zIn0=")), "options") unless options.nil?
  jsii_call_method("addApiKey", [id, options])
end

#add_domain_name(id, options) ⇒ AWSCDK::APIGateway::DomainName

Defines an API Gateway domain name and maps it to this API.

Parameters:

Returns:



329
330
331
332
333
334
 
# File 'api_gateway/step_functions_rest_api.rb', line 329

def add_domain_name(id, options)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::APIGateway::DomainNameOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5Eb21haW5OYW1lT3B0aW9ucyJ9")), "options")
  jsii_call_method("addDomainName", [id, options])
end

#add_gateway_response(id, options) ⇒ AWSCDK::APIGateway::GatewayResponse

Adds a new gateway response.

Parameters:

Returns:



341
342
343
344
345
346
 
# File 'api_gateway/step_functions_rest_api.rb', line 341

def add_gateway_response(id, options)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::APIGateway::GatewayResponseOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5HYXRld2F5UmVzcG9uc2VPcHRpb25zIn0=")), "options")
  jsii_call_method("addGatewayResponse", [id, options])
end

#add_model(id, props) ⇒ AWSCDK::APIGateway::Model

Adds a new model.

Parameters:

Returns:



510
511
512
513
514
515
 
# File 'api_gateway/step_functions_rest_api.rb', line 510

def add_model(id, props)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  props = props.is_a?(Hash) ? ::AWSCDK::APIGateway::ModelOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5Nb2RlbE9wdGlvbnMifQ==")), "props")
  jsii_call_method("addModel", [id, props])
end

#add_request_validator(id, props) ⇒ AWSCDK::APIGateway::RequestValidator

Adds a new request validator.

Parameters:

Returns:



522
523
524
525
526
527
 
# File 'api_gateway/step_functions_rest_api.rb', line 522

def add_request_validator(id, props)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  props = props.is_a?(Hash) ? ::AWSCDK::APIGateway::RequestValidatorOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5SZXF1ZXN0VmFsaWRhdG9yT3B0aW9ucyJ9")), "props")
  jsii_call_method("addRequestValidator", [id, props])
end

#add_to_resource_policy(statement) ⇒ AWSCDK::IAM::AddToResourcePolicyResult

Adds a statement to the resource policy associated with this rest api.

A resource policy will be automatically created upon the first call to add_to_resource_policy.

Note that this does not work with imported rest api.

Parameters:

Returns:



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

def add_to_resource_policy(statement)
  Jsii::Type.check_type(statement, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLlBvbGljeVN0YXRlbWVudCJ9")), "statement")
  jsii_call_method("addToResourcePolicy", [statement])
end

#add_usage_plan(id, props = nil) ⇒ AWSCDK::APIGateway::UsagePlan

Adds a usage plan.

Parameters:

Returns:



366
367
368
369
370
371
 
# File 'api_gateway/step_functions_rest_api.rb', line 366

def add_usage_plan(id, props = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  props = props.is_a?(Hash) ? ::AWSCDK::APIGateway::UsagePlanProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5Vc2FnZVBsYW5Qcm9wcyJ9")), "props") unless props.nil?
  jsii_call_method("addUsagePlan", [id, props])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



255
256
257
258
 
# File 'api_gateway/step_functions_rest_api.rb', line 255

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) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

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

Parameters:



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

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#arn_for_execute_api(method = nil, path = nil, stage = nil) ⇒ String

Gets the "execute-api" ARN.

Parameters:

  • method (String, nil) (defaults to: nil)
  • path (String, nil) (defaults to: nil)
  • stage (String, nil) (defaults to: nil)

Returns:

  • (String) 


379
380
381
382
383
384
 
# File 'api_gateway/step_functions_rest_api.rb', line 379

def arn_for_execute_api(method = nil, path = nil, stage = nil)
  Jsii::Type.check_type(method, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "method") unless method.nil?
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path") unless path.nil?
  Jsii::Type.check_type(stage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stage") unless stage.nil?
  jsii_call_method("arnForExecuteApi", [method, path, stage])
end

#cloud_watch_account ⇒ AWSCDK::APIGateway::CfnAccount?

Returns:



187
188
189
 
# File 'api_gateway/step_functions_rest_api.rb', line 187

def ()
  jsii_get_property("cloudWatchAccount")
end

#cloud_watch_account=(value) ⇒ Object 



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

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

#deployment_stage ⇒ AWSCDK::APIGateway::Stage

API Gateway stage that points to the latest deployment (if defined).

If deploy is disabled, you will need to explicitly assign this value in order to set up integrations.

Returns:



177
178
179
 
# File 'api_gateway/step_functions_rest_api.rb', line 177

def deployment_stage()
  jsii_get_property("deploymentStage")
end

#deployment_stage=(value) ⇒ Object 



181
182
183
184
 
# File 'api_gateway/step_functions_rest_api.rb', line 181

def deployment_stage=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5TdGFnZSJ9")), "deploymentStage")
  jsii_set_property("deploymentStage", value)
end

#domain_name ⇒ AWSCDK::APIGateway::DomainName?

The first domain name mapped to this API, if defined through the domainName configuration prop, or added via addDomainName.

Returns:



157
158
159
 
# File 'api_gateway/step_functions_rest_api.rb', line 157

def domain_name()
  jsii_get_property("domainName")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



83
84
85
 
# File 'api_gateway/step_functions_rest_api.rb', line 83

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


278
279
280
 
# File 'api_gateway/step_functions_rest_api.rb', line 278

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


292
293
294
295
296
297
 
# File 'api_gateway/step_functions_rest_api.rb', line 292

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


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

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#grant_invoke_from_vpc_endpoints_only(vpc_endpoints) ⇒ void

This method returns an undefined value.

Add a resource policy that only allows API execution from a VPC Endpoint to create a private API.

Parameters:

See Also:



391
392
393
394
 
# File 'api_gateway/step_functions_rest_api.rb', line 391

def grant_invoke_from_vpc_endpoints_only(vpc_endpoints)
  Jsii::Type.check_type(vpc_endpoints, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuSVZwY0VuZHBvaW50In0sImtpbmQiOiJhcnJheSJ9fQ==")), "vpcEndpoints")
  jsii_call_method("grantInvokeFromVpcEndpointsOnly", [vpc_endpoints])
end

#latest_deployment ⇒ AWSCDK::APIGateway::Deployment?

API Gateway deployment that represents the latest changes of the API.

This resource will be automatically updated every time the REST API model changes. This will be undefined if deploy is false.

Returns:



167
168
169
 
# File 'api_gateway/step_functions_rest_api.rb', line 167

def latest_deployment()
  jsii_get_property("latestDeployment")
end

#methods ⇒ Array<AWSCDK::APIGateway::Method>

The list of methods bound to this RestApi.

Returns:



218
219
220
 
# File 'api_gateway/step_functions_rest_api.rb', line 218

def methods()
  jsii_get_property("methods")
end

#metric(metric_name, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Returns the given named metric for this API.

Parameters:

Returns:



401
402
403
404
405
406
 
# File 'api_gateway/step_functions_rest_api.rb', line 401

def metric(metric_name, props = nil)
  Jsii::Type.check_type(metric_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricName")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metric", [metric_name, props])
end

#metric_cache_hit_count(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Metric for the number of requests served from the API cache in a given period.

Default: sum over 5 minutes

Parameters:

Returns:



414
415
416
417
418
 
# File 'api_gateway/step_functions_rest_api.rb', line 414

def metric_cache_hit_count(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricCacheHitCount", [props])
end

#metric_cache_miss_count(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Metric for the number of requests served from the backend in a given period, when API caching is enabled.

Default: sum over 5 minutes

Parameters:

Returns:



426
427
428
429
430
 
# File 'api_gateway/step_functions_rest_api.rb', line 426

def metric_cache_miss_count(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricCacheMissCount", [props])
end

#metric_client_error(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Metric for the number of client-side errors captured in a given period.

Default: sum over 5 minutes

Parameters:

Returns:



438
439
440
441
442
 
# File 'api_gateway/step_functions_rest_api.rb', line 438

def metric_client_error(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricClientError", [props])
end

#metric_count(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Metric for the total number API requests in a given period.

Default: sample count over 5 minutes

Parameters:

Returns:



450
451
452
453
454
 
# File 'api_gateway/step_functions_rest_api.rb', line 450

def metric_count(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricCount", [props])
end

#metric_integration_latency(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.

Default: average over 5 minutes.

Parameters:

Returns:



462
463
464
465
466
 
# File 'api_gateway/step_functions_rest_api.rb', line 462

def metric_integration_latency(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricIntegrationLatency", [props])
end

#metric_latency(props = nil) ⇒ AWSCDK::CloudWatch::Metric

The time between when API Gateway receives a request from a client and when it returns a response to the client.

The latency includes the integration latency and other API Gateway overhead.

Default: average over 5 minutes.

Parameters:

Returns:



476
477
478
479
480
 
# File 'api_gateway/step_functions_rest_api.rb', line 476

def metric_latency(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricLatency", [props])
end

#metric_server_error(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Metric for the number of server-side errors captured in a given period.

Default: sum over 5 minutes

Parameters:

Returns:



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

def metric_server_error(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricServerError", [props])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


68
69
70
 
# File 'api_gateway/step_functions_rest_api.rb', line 68

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


97
98
99
 
# File 'api_gateway/step_functions_rest_api.rb', line 97

def physical_name()
  jsii_get_property("physicalName")
end

#resource_policy ⇒ AWSCDK::IAM::PolicyDocument?

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

Returns:



199
200
201
 
# File 'api_gateway/step_functions_rest_api.rb', line 199

def resource_policy()
  jsii_get_property("resourcePolicy")
end

#resource_policy=(value) ⇒ Object 



203
204
205
206
 
# File 'api_gateway/step_functions_rest_api.rb', line 203

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

#rest_api_id ⇒ String

The ID of this API Gateway RestApi.

Returns:

  • (String) 


111
112
113
 
# File 'api_gateway/step_functions_rest_api.rb', line 111

def rest_api_id()
  jsii_get_property("restApiId")
end

#rest_api_name ⇒ String

A human friendly name for this Rest API.

Note that this is different from rest_api_id.

Returns:

  • (String) 


120
121
122
 
# File 'api_gateway/step_functions_rest_api.rb', line 120

def rest_api_name()
  jsii_get_property("restApiName")
end

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

A reference to a RestApi resource.

Returns:



127
128
129
 
# File 'api_gateway/step_functions_rest_api.rb', line 127

def rest_api_ref()
  jsii_get_property("restApiRef")
end

#rest_api_root_resource_id ⇒ String

The resource ID of the root resource.

Returns:

  • (String) 


134
135
136
 
# File 'api_gateway/step_functions_rest_api.rb', line 134

def rest_api_root_resource_id()
  jsii_get_property("restApiRootResourceId")
end

#root ⇒ AWSCDK::APIGateway::IResource

Represents the root resource of this API endpoint ('/').

Resources and Methods are added to this resource.

Returns:



143
144
145
 
# File 'api_gateway/step_functions_rest_api.rb', line 143

def root()
  jsii_get_property("root")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



104
105
106
 
# File 'api_gateway/step_functions_rest_api.rb', line 104

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


225
226
227
 
# File 'api_gateway/step_functions_rest_api.rb', line 225

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

#url ⇒ String

The deployed root URL of this REST API.

Returns:

  • (String) 


150
151
152
 
# File 'api_gateway/step_functions_rest_api.rb', line 150

def url()
  jsii_get_property("url")
end

#url_for_path(path = nil) ⇒ String

Returns the URL for an HTTP path.

Fails if deployment_stage is not set either by deploy or explicitly.

Parameters:

  • path (String, nil) (defaults to: nil)

Returns:

  • (String) 


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

def url_for_path(path = nil)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path") unless path.nil?
  jsii_call_method("urlForPath", [path])
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) 


238
239
240
241
242
243
 
# File 'api_gateway/step_functions_rest_api.rb', line 238

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