Class: AWSCDK::APIGatewayv2::CfnDeploymentProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
api_gatewayv2/cfn_deployment_props.rb

Overview

Properties for defining a CfnDeployment.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_id:, description: nil, stage_name: nil) ⇒ CfnDeploymentProps

Returns a new instance of CfnDeploymentProps.

Parameters:

  • api_id (String, AWSCDK::Interfaces::AWSApigatewayv2::IAPIRef) —

    The API identifier.

  • description (String, nil) (defaults to: nil) —

    The description for the deployment resource.

  • stage_name (String, nil) (defaults to: nil) —

    The name of an existing stage to associate with the deployment.



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

def initialize(api_id:, description: nil, stage_name: nil)
  @api_id = api_id
  Jsii::Type.check_type(@api_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcGlnYXRld2F5djIuSUFwaVJlZiJ9XX19")), "apiId")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @stage_name = stage_name
  Jsii::Type.check_type(@stage_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stageName") unless @stage_name.nil?
end

Instance Attribute Details

#api_id ⇒ String, AWSCDK::Interfaces::AWSApigatewayv2::IAPIRef (readonly)

The API identifier.

Returns:

See Also:



25
26
27
 
# File 'api_gatewayv2/cfn_deployment_props.rb', line 25

def api_id
  @api_id
end

#description ⇒ String? (readonly)

The description for the deployment resource.

Returns:

  • (String, nil)

See Also:



30
31
32
 
# File 'api_gatewayv2/cfn_deployment_props.rb', line 30

def description
  @description
end

#stage_name ⇒ String? (readonly)

The name of an existing stage to associate with the deployment.

Returns:

  • (String, nil)

See Also:



35
36
37
 
# File 'api_gatewayv2/cfn_deployment_props.rb', line 35

def stage_name
  @stage_name
end

Class Method Details

.jsii_properties ⇒ Object 



37
38
39
40
41
42
43
 
# File 'api_gatewayv2/cfn_deployment_props.rb', line 37

def self.jsii_properties
  {
    :api_id => "apiId",
    :description => "description",
    :stage_name => "stageName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



45
46
47
48
49
50
51
52
53
 
# File 'api_gatewayv2/cfn_deployment_props.rb', line 45

def to_jsii
  result = {}
  result.merge!({
    "apiId" => @api_id,
    "description" => @description,
    "stageName" => @stage_name,
  })
  result.compact
end