Class: AWSCDK::Greengrassv2::CfnDeployment::DeploymentPoliciesProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
greengrassv2/cfn_deployment.rb

Overview

Contains information about policies that define how a deployment updates components and handles failure.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(component_update_policy: nil, configuration_validation_policy: nil, failure_handling_policy: nil) ⇒ DeploymentPoliciesProperty

Returns a new instance of DeploymentPoliciesProperty.

Parameters:



950
951
952
953
954
955
956
957
 
# File 'greengrassv2/cfn_deployment.rb', line 950

def initialize(component_update_policy: nil, configuration_validation_policy: nil, failure_handling_policy: nil)
  @component_update_policy = component_update_policy.is_a?(Hash) ? ::AWSCDK::Greengrassv2::CfnDeployment::DeploymentComponentUpdatePolicyProperty.new(**component_update_policy.transform_keys(&:to_sym)) : component_update_policy
  Jsii::Type.check_type(@component_update_policy, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ncmVlbmdyYXNzdjIuQ2ZuRGVwbG95bWVudC5EZXBsb3ltZW50Q29tcG9uZW50VXBkYXRlUG9saWN5UHJvcGVydHkifV19fQ==")), "componentUpdatePolicy") unless @component_update_policy.nil?
  @configuration_validation_policy = configuration_validation_policy.is_a?(Hash) ? ::AWSCDK::Greengrassv2::CfnDeployment::DeploymentConfigurationValidationPolicyProperty.new(**configuration_validation_policy.transform_keys(&:to_sym)) : configuration_validation_policy
  Jsii::Type.check_type(@configuration_validation_policy, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ncmVlbmdyYXNzdjIuQ2ZuRGVwbG95bWVudC5EZXBsb3ltZW50Q29uZmlndXJhdGlvblZhbGlkYXRpb25Qb2xpY3lQcm9wZXJ0eSJ9XX19")), "configurationValidationPolicy") unless @configuration_validation_policy.nil?
  @failure_handling_policy = failure_handling_policy
  Jsii::Type.check_type(@failure_handling_policy, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "failureHandlingPolicy") unless @failure_handling_policy.nil?
end

Instance Attribute Details

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

The component update policy for the configuration deployment.

This policy defines when it's safe to deploy the configuration to devices.

Returns:

See Also:



965
966
967
 
# File 'greengrassv2/cfn_deployment.rb', line 965

def component_update_policy
  @component_update_policy
end

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

The configuration validation policy for the configuration deployment.

This policy defines how long each component has to validate its configure updates.

Returns:

See Also:



972
973
974
 
# File 'greengrassv2/cfn_deployment.rb', line 972

def configuration_validation_policy
  @configuration_validation_policy
end

#failure_handling_policy ⇒ String? (readonly)

The failure handling policy for the configuration deployment. This policy defines what to do if the deployment fails.

Default: ROLLBACK

Returns:

  • (String, nil)

See Also:



979
980
981
 
# File 'greengrassv2/cfn_deployment.rb', line 979

def failure_handling_policy
  @failure_handling_policy
end

Class Method Details

.jsii_properties ⇒ Object 



981
982
983
984
985
986
987
 
# File 'greengrassv2/cfn_deployment.rb', line 981

def self.jsii_properties
  {
    :component_update_policy => "componentUpdatePolicy",
    :configuration_validation_policy => "configurationValidationPolicy",
    :failure_handling_policy => "failureHandlingPolicy",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



989
990
991
992
993
994
995
996
997
 
# File 'greengrassv2/cfn_deployment.rb', line 989

def to_jsii
  result = {}
  result.merge!({
    "componentUpdatePolicy" => @component_update_policy,
    "configurationValidationPolicy" => @configuration_validation_policy,
    "failureHandlingPolicy" => @failure_handling_policy,
  })
  result.compact
end