Module: AWSCDK::APIGateway::IStage

Includes:
IResource, Interfaces::AWSApigateway::IStageRef
Included in:
StageBase
Defined in:
api_gateway/i_stage.rb

Overview

Represents an APIGateway Stage.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'api_gateway/i_stage.rb', line 102

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :stage_ref => { kind: :property, name: "stageRef", is_optional: false },
    :rest_api => { kind: :property, name: "restApi", is_optional: false },
    :stage_name => { kind: :property, name: "stageName", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :add_api_key => { kind: :method, name: "addApiKey", is_optional: false },
  }
end

Instance Method Details

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

Add an ApiKey to this Stage.

Parameters:

Returns:



95
96
97
98
99
100
 
# File 'api_gateway/i_stage.rb', line 95

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

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



85
86
87
88
 
# File 'api_gateway/i_stage.rb', line 85

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
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:



27
28
29
 
# File 'api_gateway/i_stage.rb', line 27

def env()
  jsii_get_property("env")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'api_gateway/i_stage.rb', line 12

def node()
  jsii_get_property("node")
end

#rest_api ⇒ AWSCDK::APIGateway::IRestAPI

RestApi to which this stage is associated.

Returns:



48
49
50
 
# File 'api_gateway/i_stage.rb', line 48

def rest_api()
  jsii_get_property("restApi")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'api_gateway/i_stage.rb', line 34

def stack()
  jsii_get_property("stack")
end

#stage_name ⇒ String

Name of this stage.

Returns:

  • (String) 


55
56
57
 
# File 'api_gateway/i_stage.rb', line 55

def stage_name()
  jsii_get_property("stageName")
end

#stage_ref ⇒ AWSCDK::Interfaces::AWSApigateway::StageReference

A reference to a Stage resource.

Returns:



41
42
43
 
# File 'api_gateway/i_stage.rb', line 41

def stage_ref()
  jsii_get_property("stageRef")
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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



66
67
68
69
70
71
 
# File 'api_gateway/i_stage.rb', line 66

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