AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::GreengrassV2::Types::DeploymentPolicies

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb

Overview

Note:

When making an API call, you may pass DeploymentPolicies data as a hash:

{
  failure_handling_policy: "ROLLBACK", # accepts ROLLBACK, DO_NOTHING
  component_update_policy: {
    timeout_in_seconds: 1,
    action: "NOTIFY_COMPONENTS", # accepts NOTIFY_COMPONENTS, SKIP_NOTIFY_COMPONENTS
  },
  configuration_validation_policy: {
    timeout_in_seconds: 1,
  },
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#component_update_policyTypes::DeploymentComponentUpdatePolicy

The component update policy for the configuration deployment. This policy defines when it's safe to deploy the configuration to devices.



1316
1317
1318
1319
1320
1321
1322
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 1316

class DeploymentPolicies < Struct.new(
  :failure_handling_policy,
  :component_update_policy,
  :configuration_validation_policy)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_validation_policyTypes::DeploymentConfigurationValidationPolicy

The configuration validation policy for the configuration deployment. This policy defines how long each component has to validate its configure updates.



1316
1317
1318
1319
1320
1321
1322
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 1316

class DeploymentPolicies < Struct.new(
  :failure_handling_policy,
  :component_update_policy,
  :configuration_validation_policy)
  SENSITIVE = []
  include Aws::Structure
end

#failure_handling_policyString

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

Default: ROLLBACK

Returns:

  • (String)


1316
1317
1318
1319
1320
1321
1322
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 1316

class DeploymentPolicies < Struct.new(
  :failure_handling_policy,
  :component_update_policy,
  :configuration_validation_policy)
  SENSITIVE = []
  include Aws::Structure
end