Class: Aws::IoT::Types::UpdateSecurityProfileRequest

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

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#additional_metrics_to_retain ⇒ Array<String>

Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

Returns:

  • (Array<String>) 


18570
18571
18572
18573
18574
18575
18576
18577
18578
18579
18580
18581
18582
18583
18584
18585
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 18570

class UpdateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :delete_behaviors,
  :delete_alert_targets,
  :delete_additional_metrics_to_retain,
  :expected_version,
  :metrics_export_config,
  :delete_metrics_export_config)
  SENSITIVE = []
  include Aws::Structure
end

#additional_metrics_to_retain_v2 ⇒ Array<Types::MetricToRetain>

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

Returns:



18570
18571
18572
18573
18574
18575
18576
18577
18578
18579
18580
18581
18582
18583
18584
18585
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 18570

class UpdateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :delete_behaviors,
  :delete_alert_targets,
  :delete_additional_metrics_to_retain,
  :expected_version,
  :metrics_export_config,
  :delete_metrics_export_config)
  SENSITIVE = []
  include Aws::Structure
end

#alert_targets ⇒ Hash<String,Types::AlertTarget>

Where the alerts are sent. (Alerts are always sent to the console.)

Returns:



18570
18571
18572
18573
18574
18575
18576
18577
18578
18579
18580
18581
18582
18583
18584
18585
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 18570

class UpdateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :delete_behaviors,
  :delete_alert_targets,
  :delete_additional_metrics_to_retain,
  :expected_version,
  :metrics_export_config,
  :delete_metrics_export_config)
  SENSITIVE = []
  include Aws::Structure
end

#behaviors ⇒ Array<Types::Behavior>

Specifies the behaviors that, when violated by a device (thing), cause an alert.

Returns:



18570
18571
18572
18573
18574
18575
18576
18577
18578
18579
18580
18581
18582
18583
18584
18585
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 18570

class UpdateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :delete_behaviors,
  :delete_alert_targets,
  :delete_additional_metrics_to_retain,
  :expected_version,
  :metrics_export_config,
  :delete_metrics_export_config)
  SENSITIVE = []
  include Aws::Structure
end

#delete_additional_metrics_to_retain ⇒ Boolean

If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.

Returns:

  • (Boolean) 


18570
18571
18572
18573
18574
18575
18576
18577
18578
18579
18580
18581
18582
18583
18584
18585
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 18570

class UpdateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :delete_behaviors,
  :delete_alert_targets,
  :delete_additional_metrics_to_retain,
  :expected_version,
  :metrics_export_config,
  :delete_metrics_export_config)
  SENSITIVE = []
  include Aws::Structure
end

#delete_alert_targets ⇒ Boolean

If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.

Returns:

  • (Boolean) 


18570
18571
18572
18573
18574
18575
18576
18577
18578
18579
18580
18581
18582
18583
18584
18585
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 18570

class UpdateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :delete_behaviors,
  :delete_alert_targets,
  :delete_additional_metrics_to_retain,
  :expected_version,
  :metrics_export_config,
  :delete_metrics_export_config)
  SENSITIVE = []
  include Aws::Structure
end

#delete_behaviors ⇒ Boolean

If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.

Returns:

  • (Boolean) 


18570
18571
18572
18573
18574
18575
18576
18577
18578
18579
18580
18581
18582
18583
18584
18585
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 18570

class UpdateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :delete_behaviors,
  :delete_alert_targets,
  :delete_additional_metrics_to_retain,
  :expected_version,
  :metrics_export_config,
  :delete_metrics_export_config)
  SENSITIVE = []
  include Aws::Structure
end

#delete_metrics_export_config ⇒ Boolean

Set the value as true to delete metrics export related configurations.

Returns:

  • (Boolean) 


18570
18571
18572
18573
18574
18575
18576
18577
18578
18579
18580
18581
18582
18583
18584
18585
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 18570

class UpdateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :delete_behaviors,
  :delete_alert_targets,
  :delete_additional_metrics_to_retain,
  :expected_version,
  :metrics_export_config,
  :delete_metrics_export_config)
  SENSITIVE = []
  include Aws::Structure
end

#expected_version ⇒ Integer

The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.

Returns:

  • (Integer) 


18570
18571
18572
18573
18574
18575
18576
18577
18578
18579
18580
18581
18582
18583
18584
18585
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 18570

class UpdateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :delete_behaviors,
  :delete_alert_targets,
  :delete_additional_metrics_to_retain,
  :expected_version,
  :metrics_export_config,
  :delete_metrics_export_config)
  SENSITIVE = []
  include Aws::Structure
end

#metrics_export_config ⇒ Types::MetricsExportConfig

Specifies the MQTT topic and role ARN required for metric export.

Returns:



18570
18571
18572
18573
18574
18575
18576
18577
18578
18579
18580
18581
18582
18583
18584
18585
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 18570

class UpdateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :delete_behaviors,
  :delete_alert_targets,
  :delete_additional_metrics_to_retain,
  :expected_version,
  :metrics_export_config,
  :delete_metrics_export_config)
  SENSITIVE = []
  include Aws::Structure
end

#security_profile_description ⇒ String

A description of the security profile.

Returns:

  • (String) 


18570
18571
18572
18573
18574
18575
18576
18577
18578
18579
18580
18581
18582
18583
18584
18585
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 18570

class UpdateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :delete_behaviors,
  :delete_alert_targets,
  :delete_additional_metrics_to_retain,
  :expected_version,
  :metrics_export_config,
  :delete_metrics_export_config)
  SENSITIVE = []
  include Aws::Structure
end

#security_profile_name ⇒ String

The name of the security profile you want to update.

Returns:

  • (String) 


18570
18571
18572
18573
18574
18575
18576
18577
18578
18579
18580
18581
18582
18583
18584
18585
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 18570

class UpdateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :delete_behaviors,
  :delete_alert_targets,
  :delete_additional_metrics_to_retain,
  :expected_version,
  :metrics_export_config,
  :delete_metrics_export_config)
  SENSITIVE = []
  include Aws::Structure
end