Class: AWSCDK::APIGatewayv2::HttpStage

Inherits:
Resource
  • Object
show all
Includes:
IHttpStage, IStage
Defined in:
api_gatewayv2/http_stage.rb

Overview

Represents a stage where an instance of the API is deployed.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ HttpStage

Returns a new instance of HttpStage.

Parameters:



13
14
15
16
17
18
19
 
# File 'api_gatewayv2/http_stage.rb', line 13

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

Class Method Details

.from_http_stage_attributes(scope, id, attrs) ⇒ AWSCDK::APIGatewayv2::IHttpStage

Import an existing stage into this CDK app.

Parameters:

Returns:



59
60
61
62
63
64
65
 
# File 'api_gatewayv2/http_stage.rb', line 59

def self.from_http_stage_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::APIGatewayv2::HttpStageAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLkh0dHBTdGFnZUF0dHJpYnV0ZXMifQ==")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigatewayv2.HttpStage", "fromHttpStageAttributes", [scope, id, attrs])
end

.jsii_overridable_methods ⇒ Object 



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
 
# File 'api_gatewayv2/http_stage.rb', line 21

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 },
    :api => { kind: :property, name: "api", is_optional: false },
    :base_api => { kind: :property, name: "baseApi", is_optional: false },
    :domain_url => { kind: :property, name: "domainUrl", is_optional: false },
    :is_http_stage => { kind: :property, name: "isHttpStage", is_optional: false },
    :stage_name => { kind: :property, name: "stageName", is_optional: false },
    :stage_ref => { kind: :property, name: "stageRef", is_optional: false },
    :url => { kind: :property, name: "url", 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_stage_variable => { kind: :method, name: "addStageVariable", is_optional: false },
    :default_access_log_format => { kind: :method, name: "defaultAccessLogFormat", is_optional: false },
    :metric => { kind: :method, name: "metric", is_optional: false },
    :metric_client_error => { kind: :method, name: "metricClientError", is_optional: false },
    :metric_count => { kind: :method, name: "metricCount", is_optional: false },
    :metric_data_processed => { kind: :method, name: "metricDataProcessed", 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 },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


113
114
115
 
# File 'api_gatewayv2/http_stage.rb', line 113

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

Instance Method Details

#add_stage_variable(name, value) ⇒ void

This method returns an undefined value.

Adds a stage variable to this stage.

Parameters:

  • name (String)
  • value (String) 


264
265
266
267
268
 
# File 'api_gatewayv2/http_stage.rb', line 264

def add_stage_variable(name, value)
  Jsii::Type.check_type(name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value")
  jsii_call_method("addStageVariable", [name, value])
end

#api ⇒ AWSCDK::APIGatewayv2::IHttpAPI

The API this stage is associated to.

Returns:



120
121
122
 
# File 'api_gatewayv2/http_stage.rb', line 120

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



202
203
204
205
 
# File 'api_gatewayv2/http_stage.rb', line 202

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:



219
220
221
222
 
# File 'api_gatewayv2/http_stage.rb', line 219

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

#base_api ⇒ AWSCDK::APIGatewayv2::IAPI

Returns:



125
126
127
 
# File 'api_gatewayv2/http_stage.rb', line 125

def base_api()
  jsii_get_property("baseApi")
end

#default_access_log_format ⇒ AWSCDK::APIGateway::AccessLogFormat

CLF Log format for HTTP API Stage.

Returns:

See Also:



274
275
276
 
# File 'api_gatewayv2/http_stage.rb', line 274

def default_access_log_format()
  jsii_call_method("defaultAccessLogFormat", [])
end

#domain_url ⇒ String

The custom domain URL to this stage.

Returns:

  • (String) 


132
133
134
 
# File 'api_gatewayv2/http_stage.rb', line 132

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



85
86
87
 
# File 'api_gatewayv2/http_stage.rb', line 85

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


225
226
227
 
# File 'api_gatewayv2/http_stage.rb', line 225

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) 


239
240
241
242
243
244
 
# File 'api_gatewayv2/http_stage.rb', line 239

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) 


254
255
256
257
 
# File 'api_gatewayv2/http_stage.rb', line 254

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

#is_http_stage ⇒ Boolean

Indicates that this is an HTTP Stage.

Will always return true, but is necessary to prevent accidental structural equality in TypeScript.

Returns:

  • (Boolean) 


142
143
144
 
# File 'api_gatewayv2/http_stage.rb', line 142

def is_http_stage()
  jsii_get_property("isHttpStage")
end

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

Return the given named metric for this HTTP Api Gateway Stage.

Parameters:

Returns:



283
284
285
286
287
288
 
# File 'api_gatewayv2/http_stage.rb', line 283

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_client_error(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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

Parameters:

Returns:



294
295
296
297
298
 
# File 'api_gatewayv2/http_stage.rb', line 294

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.

Parameters:

Returns:



304
305
306
307
308
 
# File 'api_gatewayv2/http_stage.rb', line 304

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_data_processed(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Metric for the amount of data processed in bytes.

Parameters:

Returns:



314
315
316
317
318
 
# File 'api_gatewayv2/http_stage.rb', line 314

def metric_data_processed(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("metricDataProcessed", [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.

Parameters:

Returns:



324
325
326
327
328
 
# File 'api_gatewayv2/http_stage.rb', line 324

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.

Parameters:

Returns:



336
337
338
339
340
 
# File 'api_gatewayv2/http_stage.rb', line 336

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.

Parameters:

Returns:



346
347
348
349
350
 
# File 'api_gatewayv2/http_stage.rb', line 346

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) 


70
71
72
 
# File 'api_gatewayv2/http_stage.rb', line 70

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) 


99
100
101
 
# File 'api_gatewayv2/http_stage.rb', line 99

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



106
107
108
 
# File 'api_gatewayv2/http_stage.rb', line 106

def stack()
  jsii_get_property("stack")
end

#stage_name ⇒ String

The name of the stage;

its primary identifier.

Returns:

  • (String) 


151
152
153
 
# File 'api_gatewayv2/http_stage.rb', line 151

def stage_name()
  jsii_get_property("stageName")
end

#stage_ref ⇒ AWSCDK::Interfaces::AWSApigatewayv2::StageReference

A reference to a Stage resource.

Returns:



158
159
160
 
# File 'api_gatewayv2/http_stage.rb', line 158

def stage_ref()
  jsii_get_property("stageRef")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


172
173
174
 
# File 'api_gatewayv2/http_stage.rb', line 172

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

#url ⇒ String

The URL to this stage.

Returns:

  • (String) 


165
166
167
 
# File 'api_gatewayv2/http_stage.rb', line 165

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


185
186
187
188
189
190
 
# File 'api_gatewayv2/http_stage.rb', line 185

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