Class: Aws::IoT::Types::MitigationActionParams

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iot/types.rb

Overview

Note:

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

{
  update_device_certificate_params: {
    action: "DEACTIVATE", # required, accepts DEACTIVATE
  },
  update_ca_certificate_params: {
    action: "DEACTIVATE", # required, accepts DEACTIVATE
  },
  add_things_to_thing_group_params: {
    thing_group_names: ["ThingGroupName"], # required
    override_dynamic_groups: false,
  },
  replace_default_policy_version_params: {
    template_name: "BLANK_POLICY", # required, accepts BLANK_POLICY
  },
  enable_io_t_logging_params: {
    role_arn_for_logging: "RoleArn", # required
    log_level: "DEBUG", # required, accepts DEBUG, INFO, ERROR, WARN, DISABLED
  },
  publish_finding_to_sns_params: {
    topic_arn: "SnsTopicArn", # required
  },
}

The set of parameters for this mitigation action. You can specify only one type of parameter (in other words, you can apply only one action for each defined mitigation action).

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#add_things_to_thing_group_params ⇒ Types::AddThingsToThingGroupParams

Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.

Returns:



14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
 
# File 'lib/aws-sdk-iot/types.rb', line 14001

class MitigationActionParams < Struct.new(
  :update_device_certificate_params,
  :update_ca_certificate_params,
  :add_things_to_thing_group_params,
  :replace_default_policy_version_params,
  :enable_io_t_logging_params,
  :publish_finding_to_sns_params)
  SENSITIVE = []
  include Aws::Structure
end

#enable_io_t_logging_params ⇒ Types::EnableIoTLoggingParams

Parameters to define a mitigation action that enables Amazon Web Services IoT Core logging at a specified level of detail.

Returns:



14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
 
# File 'lib/aws-sdk-iot/types.rb', line 14001

class MitigationActionParams < Struct.new(
  :update_device_certificate_params,
  :update_ca_certificate_params,
  :add_things_to_thing_group_params,
  :replace_default_policy_version_params,
  :enable_io_t_logging_params,
  :publish_finding_to_sns_params)
  SENSITIVE = []
  include Aws::Structure
end

#publish_finding_to_sns_params ⇒ Types::PublishFindingToSnsParams

Parameters to define a mitigation action that publishes findings to Amazon Simple Notification Service (Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.

Returns:



14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
 
# File 'lib/aws-sdk-iot/types.rb', line 14001

class MitigationActionParams < Struct.new(
  :update_device_certificate_params,
  :update_ca_certificate_params,
  :add_things_to_thing_group_params,
  :replace_default_policy_version_params,
  :enable_io_t_logging_params,
  :publish_finding_to_sns_params)
  SENSITIVE = []
  include Aws::Structure
end

#replace_default_policy_version_params ⇒ Types::ReplaceDefaultPolicyVersionParams

Parameters to define a mitigation action that adds a blank policy to restrict permissions.

Returns:



14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
 
# File 'lib/aws-sdk-iot/types.rb', line 14001

class MitigationActionParams < Struct.new(
  :update_device_certificate_params,
  :update_ca_certificate_params,
  :add_things_to_thing_group_params,
  :replace_default_policy_version_params,
  :enable_io_t_logging_params,
  :publish_finding_to_sns_params)
  SENSITIVE = []
  include Aws::Structure
end

#update_ca_certificate_params ⇒ Types::UpdateCACertificateParams

Parameters to define a mitigation action that changes the state of the CA certificate to inactive.

Returns:



14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
 
# File 'lib/aws-sdk-iot/types.rb', line 14001

class MitigationActionParams < Struct.new(
  :update_device_certificate_params,
  :update_ca_certificate_params,
  :add_things_to_thing_group_params,
  :replace_default_policy_version_params,
  :enable_io_t_logging_params,
  :publish_finding_to_sns_params)
  SENSITIVE = []
  include Aws::Structure
end

#update_device_certificate_params ⇒ Types::UpdateDeviceCertificateParams

Parameters to define a mitigation action that changes the state of the device certificate to inactive.

Returns:



14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
 
# File 'lib/aws-sdk-iot/types.rb', line 14001

class MitigationActionParams < Struct.new(
  :update_device_certificate_params,
  :update_ca_certificate_params,
  :add_things_to_thing_group_params,
  :replace_default_policy_version_params,
  :enable_io_t_logging_params,
  :publish_finding_to_sns_params)
  SENSITIVE = []
  include Aws::Structure
end