Class: AWSCDK::APIGatewayv2::CfnAPIGatewayManagedOverrides::StageOverridesProperty

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

Overview

The StageOverrides property overrides the stage configuration for an API Gateway-managed stage.

If you remove this property, API Gateway restores the default values.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(access_log_settings: nil, auto_deploy: nil, default_route_settings: nil, description: nil, route_settings: nil, stage_variables: nil) ⇒ StageOverridesProperty

Returns a new instance of StageOverridesProperty.

Parameters:



825
826
827
828
829
830
831
832
833
834
835
836
837
838
 
# File 'api_gatewayv2/cfn_api_gateway_managed_overrides.rb', line 825

def initialize(access_log_settings: nil, auto_deploy: nil, default_route_settings: nil, description: nil, route_settings: nil, stage_variables: nil)
  @access_log_settings = access_log_settings.is_a?(Hash) ? ::AWSCDK::APIGatewayv2::CfnAPIGatewayManagedOverrides::AccessLogSettingsProperty.new(**access_log_settings.transform_keys(&:to_sym)) : access_log_settings
  Jsii::Type.check_type(@access_log_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcGlnYXRld2F5djIuQ2ZuQXBpR2F0ZXdheU1hbmFnZWRPdmVycmlkZXMuQWNjZXNzTG9nU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "accessLogSettings") unless @access_log_settings.nil?
  @auto_deploy = auto_deploy
  Jsii::Type.check_type(@auto_deploy, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "autoDeploy") unless @auto_deploy.nil?
  @default_route_settings = default_route_settings.is_a?(Hash) ? ::AWSCDK::APIGatewayv2::CfnAPIGatewayManagedOverrides::RouteSettingsProperty.new(**default_route_settings.transform_keys(&:to_sym)) : default_route_settings
  Jsii::Type.check_type(@default_route_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcGlnYXRld2F5djIuQ2ZuQXBpR2F0ZXdheU1hbmFnZWRPdmVycmlkZXMuUm91dGVTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "defaultRouteSettings") unless @default_route_settings.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @route_settings = route_settings
  Jsii::Type.check_type(@route_settings, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "routeSettings") unless @route_settings.nil?
  @stage_variables = stage_variables
  Jsii::Type.check_type(@stage_variables, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "stageVariables") unless @stage_variables.nil?
end

Instance Attribute Details

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

Settings for logging access in a stage.

Returns:

See Also:



844
845
846
 
# File 'api_gatewayv2/cfn_api_gateway_managed_overrides.rb', line 844

def access_log_settings
  @access_log_settings
end

#auto_deploy ⇒ Boolean, ... (readonly)

Specifies whether updates to an API automatically trigger a new deployment.

The default value is true .

Returns:

See Also:



851
852
853
 
# File 'api_gatewayv2/cfn_api_gateway_managed_overrides.rb', line 851

def auto_deploy
  @auto_deploy
end

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

The default route settings for the stage.

Returns:

See Also:



856
857
858
 
# File 'api_gatewayv2/cfn_api_gateway_managed_overrides.rb', line 856

def default_route_settings
  @default_route_settings
end

#description ⇒ String? (readonly)

The description for the API stage.

Returns:

  • (String, nil)

See Also:



861
862
863
 
# File 'api_gatewayv2/cfn_api_gateway_managed_overrides.rb', line 861

def description
  @description
end

#route_settings ⇒ Object? (readonly)

Route settings for the stage.

Returns:

  • (Object, nil)

See Also:



866
867
868
 
# File 'api_gatewayv2/cfn_api_gateway_managed_overrides.rb', line 866

def route_settings
  @route_settings
end

#stage_variables ⇒ Object? (readonly)

A map that defines the stage variables for a Stage .

Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Returns:

  • (Object, nil)

See Also:



873
874
875
 
# File 'api_gatewayv2/cfn_api_gateway_managed_overrides.rb', line 873

def stage_variables
  @stage_variables
end

Class Method Details

.jsii_properties ⇒ Object 



875
876
877
878
879
880
881
882
883
884
 
# File 'api_gatewayv2/cfn_api_gateway_managed_overrides.rb', line 875

def self.jsii_properties
  {
    :access_log_settings => "accessLogSettings",
    :auto_deploy => "autoDeploy",
    :default_route_settings => "defaultRouteSettings",
    :description => "description",
    :route_settings => "routeSettings",
    :stage_variables => "stageVariables",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



886
887
888
889
890
891
892
893
894
895
896
897
 
# File 'api_gatewayv2/cfn_api_gateway_managed_overrides.rb', line 886

def to_jsii
  result = {}
  result.merge!({
    "accessLogSettings" => @access_log_settings,
    "autoDeploy" => @auto_deploy,
    "defaultRouteSettings" => @default_route_settings,
    "description" => @description,
    "routeSettings" => @route_settings,
    "stageVariables" => @stage_variables,
  })
  result.compact
end