class CfnSecurityProfilePropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.IoT.Mixins.CfnSecurityProfilePropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiot/mixins#CfnSecurityProfilePropsMixin
Java	software.amazon.awscdk.mixins.preview.services.iot.mixins.CfnSecurityProfilePropsMixin
Python	aws_cdk.mixins_preview.aws_iot.mixins.CfnSecurityProfilePropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_iot » mixins » CfnSecurityProfilePropsMixin

Implements IMixin

Extends Mixin

Use the AWS::IoT::SecurityProfile resource to create a Device Defender security profile.

For API reference, see CreateSecurityProfile and for general information, see Detect .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-securityprofile.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as iot_mixins } from '@aws-cdk/mixins-preview/aws-iot';
const cfnSecurityProfilePropsMixin = new iot_mixins.CfnSecurityProfilePropsMixin({
  additionalMetricsToRetainV2: [{
    exportMetric: false,
    metric: 'metric',
    metricDimension: {
      dimensionName: 'dimensionName',
      operator: 'operator',
    },
  }],
  alertTargets: {
    alertTargetsKey: {
      alertTargetArn: 'alertTargetArn',
      roleArn: 'roleArn',
    },
  },
  behaviors: [{
    criteria: {
      comparisonOperator: 'comparisonOperator',
      consecutiveDatapointsToAlarm: 123,
      consecutiveDatapointsToClear: 123,
      durationSeconds: 123,
      mlDetectionConfig: {
        confidenceLevel: 'confidenceLevel',
      },
      statisticalThreshold: {
        statistic: 'statistic',
      },
      value: {
        cidrs: ['cidrs'],
        count: 'count',
        number: 123,
        numbers: [123],
        ports: [123],
        strings: ['strings'],
      },
    },
    exportMetric: false,
    metric: 'metric',
    metricDimension: {
      dimensionName: 'dimensionName',
      operator: 'operator',
    },
    name: 'name',
    suppressAlerts: false,
  }],
  metricsExportConfig: {
    mqttTopic: 'mqttTopic',
    roleArn: 'roleArn',
  },
  securityProfileDescription: 'securityProfileDescription',
  securityProfileName: 'securityProfileName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  targetArns: ['targetArns'],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnSecurityProfilePropsMixin(props: CfnSecurityProfileMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnSecurityProfileMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::IoT::SecurityProfile.

Properties

Name	Type	Description
props	CfnSecurityProfileMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnSecurityProfileMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.