1. Packages
  2. AWS Native
  3. API Docs
  4. iot
  5. getSecurityProfile

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi

aws-native.iot.getSecurityProfile

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi

    A security profile defines a set of expected behaviors for devices in your account.

    Using getSecurityProfile

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSecurityProfile(args: GetSecurityProfileArgs, opts?: InvokeOptions): Promise<GetSecurityProfileResult>
    function getSecurityProfileOutput(args: GetSecurityProfileOutputArgs, opts?: InvokeOptions): Output<GetSecurityProfileResult>
    def get_security_profile(security_profile_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetSecurityProfileResult
    def get_security_profile_output(security_profile_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetSecurityProfileResult]
    func LookupSecurityProfile(ctx *Context, args *LookupSecurityProfileArgs, opts ...InvokeOption) (*LookupSecurityProfileResult, error)
    func LookupSecurityProfileOutput(ctx *Context, args *LookupSecurityProfileOutputArgs, opts ...InvokeOption) LookupSecurityProfileResultOutput

    > Note: This function is named LookupSecurityProfile in the Go SDK.

    public static class GetSecurityProfile 
    {
        public static Task<GetSecurityProfileResult> InvokeAsync(GetSecurityProfileArgs args, InvokeOptions? opts = null)
        public static Output<GetSecurityProfileResult> Invoke(GetSecurityProfileInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSecurityProfileResult> getSecurityProfile(GetSecurityProfileArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:iot:getSecurityProfile
      arguments:
        # arguments dictionary

    The following arguments are supported:

    SecurityProfileName string
    A unique identifier for the security profile.
    SecurityProfileName string
    A unique identifier for the security profile.
    securityProfileName String
    A unique identifier for the security profile.
    securityProfileName string
    A unique identifier for the security profile.
    security_profile_name str
    A unique identifier for the security profile.
    securityProfileName String
    A unique identifier for the security profile.

    getSecurityProfile Result

    The following output properties are available:

    AdditionalMetricsToRetainV2 List<Pulumi.AwsNative.IoT.Outputs.SecurityProfileMetricToRetain>
    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.
    AlertTargets Dictionary<string, Pulumi.AwsNative.IoT.Outputs.SecurityProfileAlertTarget>
    Specifies the destinations to which alerts are sent.
    Behaviors List<Pulumi.AwsNative.IoT.Outputs.SecurityProfileBehavior>
    Specifies the behaviors that, when violated by a device (thing), cause an alert.
    MetricsExportConfig Pulumi.AwsNative.IoT.Outputs.MetricsExportConfigProperties
    A structure containing the mqtt topic for metrics export.
    SecurityProfileArn string
    The ARN (Amazon resource name) of the created security profile.
    SecurityProfileDescription string
    A description of the security profile.
    Tags List<Pulumi.AwsNative.IoT.Outputs.SecurityProfileTag>
    Metadata that can be used to manage the security profile.
    TargetArns List<string>
    A set of target ARNs that the security profile is attached to.
    AdditionalMetricsToRetainV2 []SecurityProfileMetricToRetain
    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.
    AlertTargets map[string]SecurityProfileAlertTarget
    Specifies the destinations to which alerts are sent.
    Behaviors []SecurityProfileBehavior
    Specifies the behaviors that, when violated by a device (thing), cause an alert.
    MetricsExportConfig MetricsExportConfigProperties
    A structure containing the mqtt topic for metrics export.
    SecurityProfileArn string
    The ARN (Amazon resource name) of the created security profile.
    SecurityProfileDescription string
    A description of the security profile.
    Tags []SecurityProfileTag
    Metadata that can be used to manage the security profile.
    TargetArns []string
    A set of target ARNs that the security profile is attached to.
    additionalMetricsToRetainV2 List<SecurityProfileMetricToRetain>
    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.
    alertTargets Map<String,SecurityProfileAlertTarget>
    Specifies the destinations to which alerts are sent.
    behaviors List<SecurityProfileBehavior>
    Specifies the behaviors that, when violated by a device (thing), cause an alert.
    metricsExportConfig MetricsExportConfigProperties
    A structure containing the mqtt topic for metrics export.
    securityProfileArn String
    The ARN (Amazon resource name) of the created security profile.
    securityProfileDescription String
    A description of the security profile.
    tags List<SecurityProfileTag>
    Metadata that can be used to manage the security profile.
    targetArns List<String>
    A set of target ARNs that the security profile is attached to.
    additionalMetricsToRetainV2 SecurityProfileMetricToRetain[]
    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.
    alertTargets {[key: string]: SecurityProfileAlertTarget}
    Specifies the destinations to which alerts are sent.
    behaviors SecurityProfileBehavior[]
    Specifies the behaviors that, when violated by a device (thing), cause an alert.
    metricsExportConfig MetricsExportConfigProperties
    A structure containing the mqtt topic for metrics export.
    securityProfileArn string
    The ARN (Amazon resource name) of the created security profile.
    securityProfileDescription string
    A description of the security profile.
    tags SecurityProfileTag[]
    Metadata that can be used to manage the security profile.
    targetArns string[]
    A set of target ARNs that the security profile is attached to.
    additional_metrics_to_retain_v2 Sequence[SecurityProfileMetricToRetain]
    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.
    alert_targets Mapping[str, SecurityProfileAlertTarget]
    Specifies the destinations to which alerts are sent.
    behaviors Sequence[SecurityProfileBehavior]
    Specifies the behaviors that, when violated by a device (thing), cause an alert.
    metrics_export_config MetricsExportConfigProperties
    A structure containing the mqtt topic for metrics export.
    security_profile_arn str
    The ARN (Amazon resource name) of the created security profile.
    security_profile_description str
    A description of the security profile.
    tags Sequence[SecurityProfileTag]
    Metadata that can be used to manage the security profile.
    target_arns Sequence[str]
    A set of target ARNs that the security profile is attached to.
    additionalMetricsToRetainV2 List<Property Map>
    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.
    alertTargets Map<Property Map>
    Specifies the destinations to which alerts are sent.
    behaviors List<Property Map>
    Specifies the behaviors that, when violated by a device (thing), cause an alert.
    metricsExportConfig Property Map
    A structure containing the mqtt topic for metrics export.
    securityProfileArn String
    The ARN (Amazon resource name) of the created security profile.
    securityProfileDescription String
    A description of the security profile.
    tags List<Property Map>
    Metadata that can be used to manage the security profile.
    targetArns List<String>
    A set of target ARNs that the security profile is attached to.

    Supporting Types

    MetricsExportConfigProperties

    MqttTopic string
    The topic for metrics export.
    RoleArn string
    The ARN of the role that grants permission to publish to mqtt topic.
    MqttTopic string
    The topic for metrics export.
    RoleArn string
    The ARN of the role that grants permission to publish to mqtt topic.
    mqttTopic String
    The topic for metrics export.
    roleArn String
    The ARN of the role that grants permission to publish to mqtt topic.
    mqttTopic string
    The topic for metrics export.
    roleArn string
    The ARN of the role that grants permission to publish to mqtt topic.
    mqtt_topic str
    The topic for metrics export.
    role_arn str
    The ARN of the role that grants permission to publish to mqtt topic.
    mqttTopic String
    The topic for metrics export.
    roleArn String
    The ARN of the role that grants permission to publish to mqtt topic.

    SecurityProfileAlertTarget

    AlertTargetArn string
    The ARN of the notification target to which alerts are sent.
    RoleArn string
    The ARN of the role that grants permission to send alerts to the notification target.
    AlertTargetArn string
    The ARN of the notification target to which alerts are sent.
    RoleArn string
    The ARN of the role that grants permission to send alerts to the notification target.
    alertTargetArn String
    The ARN of the notification target to which alerts are sent.
    roleArn String
    The ARN of the role that grants permission to send alerts to the notification target.
    alertTargetArn string
    The ARN of the notification target to which alerts are sent.
    roleArn string
    The ARN of the role that grants permission to send alerts to the notification target.
    alert_target_arn str
    The ARN of the notification target to which alerts are sent.
    role_arn str
    The ARN of the role that grants permission to send alerts to the notification target.
    alertTargetArn String
    The ARN of the notification target to which alerts are sent.
    roleArn String
    The ARN of the role that grants permission to send alerts to the notification target.

    SecurityProfileBehavior

    Name string
    The name for the behavior.
    Criteria Pulumi.AwsNative.IoT.Inputs.SecurityProfileBehaviorCriteria
    ExportMetric bool
    Metric string
    What is measured by the behavior.
    MetricDimension Pulumi.AwsNative.IoT.Inputs.SecurityProfileMetricDimension
    SuppressAlerts bool
    Manage Detect alarm SNS notifications by setting behavior notification to on or suppressed. Detect will continue to performing device behavior evaluations. However, suppressed alarms wouldn't be forwarded for SNS notification.
    Name string
    The name for the behavior.
    Criteria SecurityProfileBehaviorCriteria
    ExportMetric bool
    Metric string
    What is measured by the behavior.
    MetricDimension SecurityProfileMetricDimension
    SuppressAlerts bool
    Manage Detect alarm SNS notifications by setting behavior notification to on or suppressed. Detect will continue to performing device behavior evaluations. However, suppressed alarms wouldn't be forwarded for SNS notification.
    name String
    The name for the behavior.
    criteria SecurityProfileBehaviorCriteria
    exportMetric Boolean
    metric String
    What is measured by the behavior.
    metricDimension SecurityProfileMetricDimension
    suppressAlerts Boolean
    Manage Detect alarm SNS notifications by setting behavior notification to on or suppressed. Detect will continue to performing device behavior evaluations. However, suppressed alarms wouldn't be forwarded for SNS notification.
    name string
    The name for the behavior.
    criteria SecurityProfileBehaviorCriteria
    exportMetric boolean
    metric string
    What is measured by the behavior.
    metricDimension SecurityProfileMetricDimension
    suppressAlerts boolean
    Manage Detect alarm SNS notifications by setting behavior notification to on or suppressed. Detect will continue to performing device behavior evaluations. However, suppressed alarms wouldn't be forwarded for SNS notification.
    name str
    The name for the behavior.
    criteria SecurityProfileBehaviorCriteria
    export_metric bool
    metric str
    What is measured by the behavior.
    metric_dimension SecurityProfileMetricDimension
    suppress_alerts bool
    Manage Detect alarm SNS notifications by setting behavior notification to on or suppressed. Detect will continue to performing device behavior evaluations. However, suppressed alarms wouldn't be forwarded for SNS notification.
    name String
    The name for the behavior.
    criteria Property Map
    exportMetric Boolean
    metric String
    What is measured by the behavior.
    metricDimension Property Map
    suppressAlerts Boolean
    Manage Detect alarm SNS notifications by setting behavior notification to on or suppressed. Detect will continue to performing device behavior evaluations. However, suppressed alarms wouldn't be forwarded for SNS notification.

    SecurityProfileBehaviorCriteria

    ComparisonOperator Pulumi.AwsNative.IoT.SecurityProfileBehaviorCriteriaComparisonOperator
    The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold).
    ConsecutiveDatapointsToAlarm int
    If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.
    ConsecutiveDatapointsToClear int
    If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.
    DurationSeconds int
    Use this to specify the time duration over which the behavior is evaluated.
    MlDetectionConfig Pulumi.AwsNative.IoT.Inputs.SecurityProfileMachineLearningDetectionConfig
    StatisticalThreshold Pulumi.AwsNative.IoT.Inputs.SecurityProfileStatisticalThreshold
    Value Pulumi.AwsNative.IoT.Inputs.SecurityProfileMetricValue
    ComparisonOperator SecurityProfileBehaviorCriteriaComparisonOperator
    The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold).
    ConsecutiveDatapointsToAlarm int
    If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.
    ConsecutiveDatapointsToClear int
    If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.
    DurationSeconds int
    Use this to specify the time duration over which the behavior is evaluated.
    MlDetectionConfig SecurityProfileMachineLearningDetectionConfig
    StatisticalThreshold SecurityProfileStatisticalThreshold
    Value SecurityProfileMetricValue
    comparisonOperator SecurityProfileBehaviorCriteriaComparisonOperator
    The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold).
    consecutiveDatapointsToAlarm Integer
    If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.
    consecutiveDatapointsToClear Integer
    If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.
    durationSeconds Integer
    Use this to specify the time duration over which the behavior is evaluated.
    mlDetectionConfig SecurityProfileMachineLearningDetectionConfig
    statisticalThreshold SecurityProfileStatisticalThreshold
    value SecurityProfileMetricValue
    comparisonOperator SecurityProfileBehaviorCriteriaComparisonOperator
    The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold).
    consecutiveDatapointsToAlarm number
    If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.
    consecutiveDatapointsToClear number
    If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.
    durationSeconds number
    Use this to specify the time duration over which the behavior is evaluated.
    mlDetectionConfig SecurityProfileMachineLearningDetectionConfig
    statisticalThreshold SecurityProfileStatisticalThreshold
    value SecurityProfileMetricValue
    comparison_operator SecurityProfileBehaviorCriteriaComparisonOperator
    The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold).
    consecutive_datapoints_to_alarm int
    If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.
    consecutive_datapoints_to_clear int
    If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.
    duration_seconds int
    Use this to specify the time duration over which the behavior is evaluated.
    ml_detection_config SecurityProfileMachineLearningDetectionConfig
    statistical_threshold SecurityProfileStatisticalThreshold
    value SecurityProfileMetricValue
    comparisonOperator "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"
    The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold).
    consecutiveDatapointsToAlarm Number
    If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.
    consecutiveDatapointsToClear Number
    If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.
    durationSeconds Number
    Use this to specify the time duration over which the behavior is evaluated.
    mlDetectionConfig Property Map
    statisticalThreshold Property Map
    value Property Map

    SecurityProfileBehaviorCriteriaComparisonOperator

    SecurityProfileMachineLearningDetectionConfig

    ConfidenceLevel Pulumi.AwsNative.IoT.SecurityProfileMachineLearningDetectionConfigConfidenceLevel
    The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.
    ConfidenceLevel SecurityProfileMachineLearningDetectionConfigConfidenceLevel
    The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.
    confidenceLevel SecurityProfileMachineLearningDetectionConfigConfidenceLevel
    The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.
    confidenceLevel SecurityProfileMachineLearningDetectionConfigConfidenceLevel
    The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.
    confidence_level SecurityProfileMachineLearningDetectionConfigConfidenceLevel
    The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.
    confidenceLevel "LOW" | "MEDIUM" | "HIGH"
    The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.

    SecurityProfileMachineLearningDetectionConfigConfidenceLevel

    SecurityProfileMetricDimension

    DimensionName string
    A unique identifier for the dimension.
    Operator Pulumi.AwsNative.IoT.SecurityProfileMetricDimensionOperator
    Defines how the dimensionValues of a dimension are interpreted.
    DimensionName string
    A unique identifier for the dimension.
    Operator SecurityProfileMetricDimensionOperator
    Defines how the dimensionValues of a dimension are interpreted.
    dimensionName String
    A unique identifier for the dimension.
    operator SecurityProfileMetricDimensionOperator
    Defines how the dimensionValues of a dimension are interpreted.
    dimensionName string
    A unique identifier for the dimension.
    operator SecurityProfileMetricDimensionOperator
    Defines how the dimensionValues of a dimension are interpreted.
    dimension_name str
    A unique identifier for the dimension.
    operator SecurityProfileMetricDimensionOperator
    Defines how the dimensionValues of a dimension are interpreted.
    dimensionName String
    A unique identifier for the dimension.
    operator "IN" | "NOT_IN"
    Defines how the dimensionValues of a dimension are interpreted.

    SecurityProfileMetricDimensionOperator

    SecurityProfileMetricToRetain

    Metric string
    What is measured by the behavior.
    ExportMetric bool
    MetricDimension SecurityProfileMetricDimension
    metric String
    What is measured by the behavior.
    exportMetric Boolean
    metricDimension SecurityProfileMetricDimension
    metric string
    What is measured by the behavior.
    exportMetric boolean
    metricDimension SecurityProfileMetricDimension
    metric String
    What is measured by the behavior.
    exportMetric Boolean
    metricDimension Property Map

    SecurityProfileMetricValue

    Cidrs List<string>
    If the ComparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.
    Count string
    If the ComparisonOperator calls for a numeric value, use this to specify that (integer) numeric value to be compared with the metric.
    Number double
    The numeral value of a metric.
    Numbers List<double>
    The numeral values of a metric.
    Ports List<int>
    If the ComparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.
    Strings List<string>
    The string values of a metric.
    Cidrs []string
    If the ComparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.
    Count string
    If the ComparisonOperator calls for a numeric value, use this to specify that (integer) numeric value to be compared with the metric.
    Number float64
    The numeral value of a metric.
    Numbers []float64
    The numeral values of a metric.
    Ports []int
    If the ComparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.
    Strings []string
    The string values of a metric.
    cidrs List<String>
    If the ComparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.
    count String
    If the ComparisonOperator calls for a numeric value, use this to specify that (integer) numeric value to be compared with the metric.
    number Double
    The numeral value of a metric.
    numbers List<Double>
    The numeral values of a metric.
    ports List<Integer>
    If the ComparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.
    strings List<String>
    The string values of a metric.
    cidrs string[]
    If the ComparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.
    count string
    If the ComparisonOperator calls for a numeric value, use this to specify that (integer) numeric value to be compared with the metric.
    number number
    The numeral value of a metric.
    numbers number[]
    The numeral values of a metric.
    ports number[]
    If the ComparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.
    strings string[]
    The string values of a metric.
    cidrs Sequence[str]
    If the ComparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.
    count str
    If the ComparisonOperator calls for a numeric value, use this to specify that (integer) numeric value to be compared with the metric.
    number float
    The numeral value of a metric.
    numbers Sequence[float]
    The numeral values of a metric.
    ports Sequence[int]
    If the ComparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.
    strings Sequence[str]
    The string values of a metric.
    cidrs List<String>
    If the ComparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.
    count String
    If the ComparisonOperator calls for a numeric value, use this to specify that (integer) numeric value to be compared with the metric.
    number Number
    The numeral value of a metric.
    numbers List<Number>
    The numeral values of a metric.
    ports List<Number>
    If the ComparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.
    strings List<String>
    The string values of a metric.

    SecurityProfileStatisticalThreshold

    Statistic Pulumi.AwsNative.IoT.SecurityProfileStatisticalThresholdStatistic
    The percentile which resolves to a threshold value by which compliance with a behavior is determined
    Statistic SecurityProfileStatisticalThresholdStatistic
    The percentile which resolves to a threshold value by which compliance with a behavior is determined
    statistic SecurityProfileStatisticalThresholdStatistic
    The percentile which resolves to a threshold value by which compliance with a behavior is determined
    statistic SecurityProfileStatisticalThresholdStatistic
    The percentile which resolves to a threshold value by which compliance with a behavior is determined
    statistic SecurityProfileStatisticalThresholdStatistic
    The percentile which resolves to a threshold value by which compliance with a behavior is determined
    statistic "Average" | "p0" | "p0.1" | "p0.01" | "p1" | "p10" | "p50" | "p90" | "p99" | "p99.9" | "p99.99" | "p100"
    The percentile which resolves to a threshold value by which compliance with a behavior is determined

    SecurityProfileStatisticalThresholdStatistic

    SecurityProfileTag

    Key string
    The tag's key.
    Value string
    The tag's value.
    Key string
    The tag's key.
    Value string
    The tag's value.
    key String
    The tag's key.
    value String
    The tag's value.
    key string
    The tag's key.
    value string
    The tag's value.
    key str
    The tag's key.
    value str
    The tag's value.
    key String
    The tag's key.
    value String
    The tag's value.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi