Class: Aws::IoT::Types::CreateMitigationActionRequest

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

Overview

Note:

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

{
  action_name: "MitigationActionName", # required
  role_arn: "RoleArn", # required
  action_params: { # required
    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
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#action_nameString

A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).

Returns:

  • (String)


3906
3907
3908
3909
3910
3911
3912
3913
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3906

class CreateMitigationActionRequest < Struct.new(
  :action_name,
  :role_arn,
  :action_params,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#action_paramsTypes::MitigationActionParams

Defines the type of action and the parameters for that action.



3906
3907
3908
3909
3910
3911
3912
3913
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3906

class CreateMitigationActionRequest < Struct.new(
  :action_name,
  :role_arn,
  :action_params,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The ARN of the IAM role that is used to apply the mitigation action.

Returns:

  • (String)


3906
3907
3908
3909
3910
3911
3912
3913
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3906

class CreateMitigationActionRequest < Struct.new(
  :action_name,
  :role_arn,
  :action_params,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

Metadata that can be used to manage the mitigation action.

Returns:



3906
3907
3908
3909
3910
3911
3912
3913
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3906

class CreateMitigationActionRequest < Struct.new(
  :action_name,
  :role_arn,
  :action_params,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end