Module: AWSCDK::APIGatewayv2::IAPIMapping

Includes:
IResource, Interfaces::AWSApigatewayv2::IAPIMappingRef
Included in:
APIMapping
Defined in:
api_gatewayv2/iapi_mapping.rb

Overview

Represents an ApiGatewayV2 ApiMapping resource.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
 
# File 'api_gatewayv2/iapi_mapping.rb', line 85

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 },
    :api_mapping_ref => { kind: :property, name: "apiMappingRef", is_optional: false },
    :api_mapping_id => { kind: :property, name: "apiMappingId", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
  }
end

Instance Method Details

#api_mapping_id ⇒ String

ID of the api mapping.

Returns:

  • (String) 


50
51
52
 
# File 'api_gatewayv2/iapi_mapping.rb', line 50

def api_mapping_id()
  jsii_get_property("apiMappingId")
end

#api_mapping_ref ⇒ AWSCDK::Interfaces::AWSApigatewayv2::APIMappingReference

A reference to a ApiMapping resource.

Returns:



43
44
45
 
# File 'api_gatewayv2/iapi_mapping.rb', line 43

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



80
81
82
83
 
# File 'api_gatewayv2/iapi_mapping.rb', line 80

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:



29
30
31
 
# File 'api_gatewayv2/iapi_mapping.rb', line 29

def env()
  jsii_get_property("env")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


14
15
16
 
# File 'api_gatewayv2/iapi_mapping.rb', line 14

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



36
37
38
 
# File 'api_gatewayv2/iapi_mapping.rb', line 36

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



61
62
63
64
65
66
 
# File 'api_gatewayv2/iapi_mapping.rb', line 61

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