NAME
Paws::IoT::UpdateSecurityProfile - Arguments for method UpdateSecurityProfile on Paws::IoT
DESCRIPTION
This class represents the parameters used for calling the method UpdateSecurityProfile on the AWS IoT service. Use the attributes of this class as arguments to method UpdateSecurityProfile.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateSecurityProfile.
SYNOPSIS
my $iot = Paws->service('IoT');
my $UpdateSecurityProfileResponse = $iot->UpdateSecurityProfile(
SecurityProfileName => 'MySecurityProfileName',
AdditionalMetricsToRetain => [ 'MyBehaviorMetric', ... ], # OPTIONAL
AdditionalMetricsToRetainV2 => [
{
Metric => 'MyBehaviorMetric',
MetricDimension => {
DimensionName => 'MyDimensionName', # min: 1, max: 128
Operator => 'IN', # values: IN, NOT_IN; OPTIONAL
}, # OPTIONAL
},
...
], # OPTIONAL
AlertTargets => {
'SNS' => {
AlertTargetArn => 'MyAlertTargetArn',
RoleArn => 'MyRoleArn', # min: 20, max: 2048
}, # key: values: SNS
}, # OPTIONAL
Behaviors => [
{
Name => 'MyBehaviorName', # min: 1, max: 128
Criteria => {
ComparisonOperator => 'less-than'
, # values: less-than, less-than-equals, greater-than, greater-than-equals, in-cidr-set, not-in-cidr-set, in-port-set, not-in-port-set, in-set, not-in-set; OPTIONAL
ConsecutiveDatapointsToAlarm => 1, # min: 1, max: 10; OPTIONAL
ConsecutiveDatapointsToClear => 1, # min: 1, max: 10; OPTIONAL
DurationSeconds => 1, # OPTIONAL
MlDetectionConfig => {
ConfidenceLevel => 'LOW', # values: LOW, MEDIUM, HIGH
}, # OPTIONAL
StatisticalThreshold => {
Statistic => 'MyEvaluationStatistic', # OPTIONAL
}, # OPTIONAL
Value => {
Cidrs => [
'MyCidr', ... # min: 2, max: 43
], # OPTIONAL
Count => 1, # OPTIONAL
Number => 1, # OPTIONAL
Numbers => [
1, ... # OPTIONAL
], # OPTIONAL
Ports => [
1, ... # max: 65535
], # OPTIONAL
Strings => [ 'MystringValue', ... ], # OPTIONAL
}, # OPTIONAL
}, # OPTIONAL
Metric => 'MyBehaviorMetric',
MetricDimension => {
DimensionName => 'MyDimensionName', # min: 1, max: 128
Operator => 'IN', # values: IN, NOT_IN; OPTIONAL
}, # OPTIONAL
SuppressAlerts => 1, # OPTIONAL
},
...
], # OPTIONAL
DeleteAdditionalMetricsToRetain => 1, # OPTIONAL
DeleteAlertTargets => 1, # OPTIONAL
DeleteBehaviors => 1, # OPTIONAL
ExpectedVersion => 1, # OPTIONAL
SecurityProfileDescription => 'MySecurityProfileDescription', # OPTIONAL
);
# Results:
my $AdditionalMetricsToRetain =
$UpdateSecurityProfileResponse->AdditionalMetricsToRetain;
my $AdditionalMetricsToRetainV2 =
$UpdateSecurityProfileResponse->AdditionalMetricsToRetainV2;
my $AlertTargets = $UpdateSecurityProfileResponse->AlertTargets;
my $Behaviors = $UpdateSecurityProfileResponse->Behaviors;
my $CreationDate = $UpdateSecurityProfileResponse->CreationDate;
my $LastModifiedDate = $UpdateSecurityProfileResponse->LastModifiedDate;
my $SecurityProfileArn = $UpdateSecurityProfileResponse->SecurityProfileArn;
my $SecurityProfileDescription =
$UpdateSecurityProfileResponse->SecurityProfileDescription;
my $SecurityProfileName =
$UpdateSecurityProfileResponse->SecurityProfileName;
my $Version = $UpdateSecurityProfileResponse->Version;
# Returns a L<Paws::IoT::UpdateSecurityProfileResponse> object.Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/iot/UpdateSecurityProfile
ATTRIBUTES
AdditionalMetricsToRetain => ArrayRef[Str|Undef]
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.
AdditionalMetricsToRetainV2 => ArrayRef[Paws::IoT::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.
AlertTargets => Paws::IoT::AlertTargets
Where the alerts are sent. (Alerts are always sent to the console.)
Behaviors => ArrayRef[Paws::IoT::Behavior]
Specifies the behaviors that, when violated by a device (thing), cause an alert.
DeleteAdditionalMetricsToRetain => Bool
If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.
DeleteAlertTargets => Bool
If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.
DeleteBehaviors => Bool
If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.
ExpectedVersion => Int
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.
SecurityProfileDescription => Str
A description of the security profile.
REQUIRED SecurityProfileName => Str
The name of the security profile you want to update.
SEE ALSO
This class forms part of Paws, documenting arguments for method UpdateSecurityProfile in Paws::IoT
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues