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.This parameter is deprecated.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Where the alerts are sent. (Alerts are always sent to the console.)
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AlertTargets |
Specifies the behaviors that, when violated by a device (thing), cause an alert.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Behaviors |
Amazon.PowerShell.Cmdlets.IOT.AmazonIoTClientCmdlet.ClientConfig
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-DeleteAdditionalMetricsToRetain <
Boolean>
If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | DeleteAlertTargets |
If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | DeleteBehaviors |
-DeleteMetricsExportConfig <
Boolean>
Set the value as true to delete metrics export related configurations.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-ExpectedVersion <Int64>
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-MetricsExportConfig_MqttTopic <
String>
The MQTT topic that Device Defender Detect should publish messages to for metrics export.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-MetricsExportConfig_RoleArn <
String>
This role ARN has permission to publish MQTT messages, after which Device Defender Detect can assume the role and publish messages on your behalf.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Changes the cmdlet behavior to return the value passed to the SecurityProfileName parameter. The -PassThru parameter is deprecated, use -Select '^SecurityProfileName' instead. This parameter will be removed in a future version.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-SecurityProfileDescription <
String>
A description of the security profile.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The name of the security profile you want to update.
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoT.Model.UpdateSecurityProfileResponse). Specifying the name of a property of type Amazon.IoT.Model.UpdateSecurityProfileResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |