NAME

Paws::IoT::CreateSecurityProfile - Arguments for method CreateSecurityProfile on Paws::IoT

DESCRIPTION

This class represents the parameters used for calling the method CreateSecurityProfile on the AWS IoT service. Use the attributes of this class as arguments to method CreateSecurityProfile.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateSecurityProfile.

SYNOPSIS

my $iot = Paws->service('IoT');
my $CreateSecurityProfileResponse = $iot->CreateSecurityProfile(
  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
  SecurityProfileDescription => 'MySecurityProfileDescription',   # OPTIONAL
  Tags                       => [
    {
      Key   => 'MyTagKey',      # min: 1, max: 128
      Value => 'MyTagValue',    # min: 1, max: 256; OPTIONAL
    },
    ...
  ],    # OPTIONAL
);

# Results:
my $SecurityProfileArn = $CreateSecurityProfileResponse->SecurityProfileArn;
my $SecurityProfileName =
  $CreateSecurityProfileResponse->SecurityProfileName;

# Returns a L<Paws::IoT::CreateSecurityProfileResponse> 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/CreateSecurityProfile

ATTRIBUTES

AdditionalMetricsToRetain => ArrayRef[Str|Undef]

Please use CreateSecurityProfileRequest$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

Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

Behaviors => ArrayRef[Paws::IoT::Behavior]

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

SecurityProfileDescription => Str

A description of the security profile.

REQUIRED SecurityProfileName => Str

The name you are giving to the security profile.

Tags => ArrayRef[Paws::IoT::Tag]

Metadata that can be used to manage the security profile.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateSecurityProfile 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