AWS SDK Version 3 for .NET
API Reference

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.

Container for the parameters to the UpdateSecurityProfile operation. Updates a Device Defender security profile.

Requires permission to access the UpdateSecurityProfile action.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.IoT.AmazonIoTRequest
      Amazon.IoT.Model.UpdateSecurityProfileRequest

Namespace: Amazon.IoT.Model
Assembly: AWSSDK.IoT.dll
Version: 3.x.y.z

Syntax

C#
public class UpdateSecurityProfileRequest : AmazonIoTRequest
         IAmazonWebServiceRequest

The UpdateSecurityProfileRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AdditionalMetricsToRetain System.Collections.Generic.List<System.String>

Gets and sets the property AdditionalMetricsToRetain.

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.

Public Property AdditionalMetricsToRetainV2 System.Collections.Generic.List<Amazon.IoT.Model.MetricToRetain>

Gets and sets the property AdditionalMetricsToRetainV2.

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.

Public Property AlertTargets System.Collections.Generic.Dictionary<System.String, Amazon.IoT.Model.AlertTarget>

Gets and sets the property AlertTargets.

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

Public Property Behaviors System.Collections.Generic.List<Amazon.IoT.Model.Behavior>

Gets and sets the property Behaviors.

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

Public Property DeleteAdditionalMetricsToRetain System.Boolean

Gets and sets the property DeleteAdditionalMetricsToRetain.

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

Public Property DeleteAlertTargets System.Boolean

Gets and sets the property DeleteAlertTargets.

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

Public Property DeleteBehaviors System.Boolean

Gets and sets the property DeleteBehaviors.

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

Public Property DeleteMetricsExportConfig System.Boolean

Gets and sets the property DeleteMetricsExportConfig.

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

Public Property ExpectedVersion System.Int64

Gets and sets the property ExpectedVersion.

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.

Public Property MetricsExportConfig Amazon.IoT.Model.MetricsExportConfig

Gets and sets the property MetricsExportConfig.

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

Public Property SecurityProfileDescription System.String

Gets and sets the property SecurityProfileDescription.

A description of the security profile.

Public Property SecurityProfileName System.String

Gets and sets the property SecurityProfileName.

The name of the security profile you want to update.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5