Class: AWSCDK::SAM::CfnHttpAPIProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sam/cfn_http_api_props.rb

Overview

Properties for defining a CfnHttpApi.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(access_log_setting: nil, auth: nil, cors_configuration: nil, default_route_settings: nil, definition_body: nil, definition_uri: nil, description: nil, disable_execute_api_endpoint: nil, domain: nil, fail_on_warnings: nil, route_settings: nil, stage_name: nil, stage_variables: nil, tags: nil) ⇒ CfnHttpAPIProps

Returns a new instance of CfnHttpAPIProps.

Parameters:



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
 
# File 'sam/cfn_http_api_props.rb', line 23

def initialize(access_log_setting: nil, auth: nil, cors_configuration: nil, default_route_settings: nil, definition_body: nil, definition_uri: nil, description: nil, disable_execute_api_endpoint: nil, domain: nil, fail_on_warnings: nil, route_settings: nil, stage_name: nil, stage_variables: nil, tags: nil)
  @access_log_setting = access_log_setting.is_a?(Hash) ? ::AWSCDK::SAM::CfnHttpAPI::AccessLogSettingProperty.new(**access_log_setting.transform_keys(&:to_sym)) : access_log_setting
  Jsii::Type.check_type(@access_log_setting, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuSHR0cEFwaS5BY2Nlc3NMb2dTZXR0aW5nUHJvcGVydHkifV19fQ==")), "accessLogSetting") unless @access_log_setting.nil?
  @auth = auth.is_a?(Hash) ? ::AWSCDK::SAM::CfnHttpAPI::HttpAPIAuthProperty.new(**auth.transform_keys(&:to_sym)) : auth
  Jsii::Type.check_type(@auth, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuSHR0cEFwaS5IdHRwQXBpQXV0aFByb3BlcnR5In1dfX0=")), "auth") unless @auth.nil?
  @cors_configuration = cors_configuration.is_a?(Hash) ? ::AWSCDK::SAM::CfnHttpAPI::CorsConfigurationObjectProperty.new(**cors_configuration.transform_keys(&:to_sym)) : cors_configuration
  Jsii::Type.check_type(@cors_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuSHR0cEFwaS5Db3JzQ29uZmlndXJhdGlvbk9iamVjdFByb3BlcnR5In1dfX0=")), "corsConfiguration") unless @cors_configuration.nil?
  @default_route_settings = default_route_settings.is_a?(Hash) ? ::AWSCDK::SAM::CfnHttpAPI::RouteSettingsProperty.new(**default_route_settings.transform_keys(&:to_sym)) : default_route_settings
  Jsii::Type.check_type(@default_route_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuSHR0cEFwaS5Sb3V0ZVNldHRpbmdzUHJvcGVydHkifV19fQ==")), "defaultRouteSettings") unless @default_route_settings.nil?
  @definition_body = definition_body
  Jsii::Type.check_type(@definition_body, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "definitionBody") unless @definition_body.nil?
  @definition_uri = definition_uri.is_a?(Hash) ? ::AWSCDK::SAM::CfnHttpAPI::S3LocationProperty.new(**definition_uri.transform_keys(&:to_sym)) : definition_uri
  Jsii::Type.check_type(@definition_uri, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5JUmVzb2x2YWJsZSJ9LHsiZnFuIjoiYXdzLWNkay1saWIuYXdzX3NhbS5DZm5IdHRwQXBpLlMzTG9jYXRpb25Qcm9wZXJ0eSJ9XX19")), "definitionUri") unless @definition_uri.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @disable_execute_api_endpoint = disable_execute_api_endpoint
  Jsii::Type.check_type(@disable_execute_api_endpoint, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "disableExecuteApiEndpoint") unless @disable_execute_api_endpoint.nil?
  @domain = domain.is_a?(Hash) ? ::AWSCDK::SAM::CfnHttpAPI::HttpAPIDomainConfigurationProperty.new(**domain.transform_keys(&:to_sym)) : domain
  Jsii::Type.check_type(@domain, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuSHR0cEFwaS5IdHRwQXBpRG9tYWluQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "domain") unless @domain.nil?
  @fail_on_warnings = fail_on_warnings
  Jsii::Type.check_type(@fail_on_warnings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "failOnWarnings") unless @fail_on_warnings.nil?
  @route_settings = route_settings.is_a?(Hash) ? ::AWSCDK::SAM::CfnHttpAPI::RouteSettingsProperty.new(**route_settings.transform_keys(&:to_sym)) : route_settings
  Jsii::Type.check_type(@route_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuSHR0cEFwaS5Sb3V0ZVNldHRpbmdzUHJvcGVydHkifV19fQ==")), "routeSettings") unless @route_settings.nil?
  @stage_name = stage_name
  Jsii::Type.check_type(@stage_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stageName") unless @stage_name.nil?
  @stage_variables = stage_variables
  Jsii::Type.check_type(@stage_variables, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "stageVariables") unless @stage_variables.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
end

Instance Attribute Details

#access_log_setting ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



56
57
58
 
# File 'sam/cfn_http_api_props.rb', line 56

def access_log_setting
  @access_log_setting
end

#auth ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



59
60
61
 
# File 'sam/cfn_http_api_props.rb', line 59

def auth
  @auth
end

#cors_configuration ⇒ Boolean, ... (readonly)

Returns:

See Also:



62
63
64
 
# File 'sam/cfn_http_api_props.rb', line 62

def cors_configuration
  @cors_configuration
end

#default_route_settings ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



65
66
67
 
# File 'sam/cfn_http_api_props.rb', line 65

def default_route_settings
  @default_route_settings
end

#definition_body ⇒ Object? (readonly)

Returns:

  • (Object, nil)

See Also:



68
69
70
 
# File 'sam/cfn_http_api_props.rb', line 68

def definition_body
  @definition_body
end

#definition_uri ⇒ String, ... (readonly)

Returns:

See Also:



71
72
73
 
# File 'sam/cfn_http_api_props.rb', line 71

def definition_uri
  @definition_uri
end

#description ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



74
75
76
 
# File 'sam/cfn_http_api_props.rb', line 74

def description
  @description
end

#disable_execute_api_endpoint ⇒ Boolean, ... (readonly)

Returns:

See Also:



77
78
79
 
# File 'sam/cfn_http_api_props.rb', line 77

def disable_execute_api_endpoint
  @disable_execute_api_endpoint
end

#domain ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



80
81
82
 
# File 'sam/cfn_http_api_props.rb', line 80

def domain
  @domain
end

#fail_on_warnings ⇒ Boolean, ... (readonly)

Returns:

See Also:



83
84
85
 
# File 'sam/cfn_http_api_props.rb', line 83

def fail_on_warnings
  @fail_on_warnings
end

#route_settings ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



86
87
88
 
# File 'sam/cfn_http_api_props.rb', line 86

def route_settings
  @route_settings
end

#stage_name ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



89
90
91
 
# File 'sam/cfn_http_api_props.rb', line 89

def stage_name
  @stage_name
end

#stage_variables ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



92
93
94
 
# File 'sam/cfn_http_api_props.rb', line 92

def stage_variables
  @stage_variables
end

#tags ⇒ Hash{String => String}? (readonly)

Returns:

  • (Hash{String => String}, nil)

See Also:



95
96
97
 
# File 'sam/cfn_http_api_props.rb', line 95

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'sam/cfn_http_api_props.rb', line 97

def self.jsii_properties
  {
    :access_log_setting => "accessLogSetting",
    :auth => "auth",
    :cors_configuration => "corsConfiguration",
    :default_route_settings => "defaultRouteSettings",
    :definition_body => "definitionBody",
    :definition_uri => "definitionUri",
    :description => "description",
    :disable_execute_api_endpoint => "disableExecuteApiEndpoint",
    :domain => "domain",
    :fail_on_warnings => "failOnWarnings",
    :route_settings => "routeSettings",
    :stage_name => "stageName",
    :stage_variables => "stageVariables",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'sam/cfn_http_api_props.rb', line 116

def to_jsii
  result = {}
  result.merge!({
    "accessLogSetting" => @access_log_setting,
    "auth" => @auth,
    "corsConfiguration" => @cors_configuration,
    "defaultRouteSettings" => @default_route_settings,
    "definitionBody" => @definition_body,
    "definitionUri" => @definition_uri,
    "description" => @description,
    "disableExecuteApiEndpoint" => @disable_execute_api_endpoint,
    "domain" => @domain,
    "failOnWarnings" => @fail_on_warnings,
    "routeSettings" => @route_settings,
    "stageName" => @stage_name,
    "stageVariables" => @stage_variables,
    "tags" => @tags,
  })
  result.compact
end