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

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

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.iot.MitigationAction

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    Mitigation actions can be used to take actions to mitigate issues that were found in an Audit finding or Detect violation.

    Create MitigationAction Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new MitigationAction(name: string, args: MitigationActionArgs, opts?: CustomResourceOptions);
    @overload
def MitigationAction(resource_name: str,
                     args: MitigationActionArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def MitigationAction(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     action_params: Optional[MitigationActionActionParamsArgs] = None,
                     role_arn: Optional[str] = None,
                     action_name: Optional[str] = None,
                     tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewMitigationAction(ctx *Context, name string, args MitigationActionArgs, opts ...ResourceOption) (*MitigationAction, error)
    public MitigationAction(string name, MitigationActionArgs args, CustomResourceOptions? opts = null)
    public MitigationAction(String name, MitigationActionArgs args)
public MitigationAction(String name, MitigationActionArgs args, CustomResourceOptions options)

    type: aws-native:iot:MitigationAction
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args MitigationActionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args MitigationActionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args MitigationActionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MitigationActionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MitigationActionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    MitigationAction Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The MitigationAction resource accepts the following input properties:

    ActionParams Pulumi.AwsNative.IoT.Inputs.MitigationActionActionParams
    The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply.
    RoleArn string
    The IAM role ARN used to apply this mitigation action.
    ActionName string
    A unique identifier for the mitigation action.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    ActionParams MitigationActionActionParamsArgs
    The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply.
    RoleArn string
    The IAM role ARN used to apply this mitigation action.
    ActionName string
    A unique identifier for the mitigation action.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    actionParams MitigationActionActionParams
    The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply.
    roleArn String
    The IAM role ARN used to apply this mitigation action.
    actionName String
    A unique identifier for the mitigation action.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    actionParams MitigationActionActionParams
    The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply.
    roleArn string
    The IAM role ARN used to apply this mitigation action.
    actionName string
    A unique identifier for the mitigation action.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    action_params MitigationActionActionParamsArgs
    The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply.
    role_arn str
    The IAM role ARN used to apply this mitigation action.
    action_name str
    A unique identifier for the mitigation action.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    actionParams Property Map
    The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply.
    roleArn String
    The IAM role ARN used to apply this mitigation action.
    actionName String
    A unique identifier for the mitigation action.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the MitigationAction resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    MitigationActionArn string
    The Amazon Resource Name (ARN) of the mitigation action.
    MitigationActionId string
    The ID of the mitigation action.
    Id string
    The provider-assigned unique ID for this managed resource.
    MitigationActionArn string
    The Amazon Resource Name (ARN) of the mitigation action.
    MitigationActionId string
    The ID of the mitigation action.
    id String
    The provider-assigned unique ID for this managed resource.
    mitigationActionArn String
    The Amazon Resource Name (ARN) of the mitigation action.
    mitigationActionId String
    The ID of the mitigation action.
    id string
    The provider-assigned unique ID for this managed resource.
    mitigationActionArn string
    The Amazon Resource Name (ARN) of the mitigation action.
    mitigationActionId string
    The ID of the mitigation action.
    id str
    The provider-assigned unique ID for this managed resource.
    mitigation_action_arn str
    The Amazon Resource Name (ARN) of the mitigation action.
    mitigation_action_id str
    The ID of the mitigation action.
    id String
    The provider-assigned unique ID for this managed resource.
    mitigationActionArn String
    The Amazon Resource Name (ARN) of the mitigation action.
    mitigationActionId String
    The ID of the mitigation action.

    Supporting Types

    MitigationActionActionParams, MitigationActionActionParamsArgs

    AddThingsToThingGroupParams Pulumi.AwsNative.IoT.Inputs.MitigationActionAddThingsToThingGroupParams
    Specifies the group to which you want to add the devices.
    EnableIoTLoggingParams Pulumi.AwsNative.IoT.Inputs.MitigationActionEnableIoTLoggingParams
    Specifies the logging level and the role with permissions for logging. You cannot specify a logging level of DISABLED .
    PublishFindingToSnsParams Pulumi.AwsNative.IoT.Inputs.MitigationActionPublishFindingToSnsParams
    Specifies the topic to which the finding should be published.
    ReplaceDefaultPolicyVersionParams Pulumi.AwsNative.IoT.Inputs.MitigationActionReplaceDefaultPolicyVersionParams
    Replaces the policy version with a default or blank policy. You specify the template name. Only a value of BLANK_POLICY is currently supported.
    UpdateCaCertificateParams Pulumi.AwsNative.IoT.Inputs.MitigationActionUpdateCaCertificateParams
    Specifies the new state for the CA certificate. Only a value of DEACTIVATE is currently supported.
    UpdateDeviceCertificateParams Pulumi.AwsNative.IoT.Inputs.MitigationActionUpdateDeviceCertificateParams
    Specifies the new state for a device certificate. Only a value of DEACTIVATE is currently supported.
    AddThingsToThingGroupParams MitigationActionAddThingsToThingGroupParams
    Specifies the group to which you want to add the devices.
    EnableIoTLoggingParams MitigationActionEnableIoTLoggingParams
    Specifies the logging level and the role with permissions for logging. You cannot specify a logging level of DISABLED .
    PublishFindingToSnsParams MitigationActionPublishFindingToSnsParams
    Specifies the topic to which the finding should be published.
    ReplaceDefaultPolicyVersionParams MitigationActionReplaceDefaultPolicyVersionParams
    Replaces the policy version with a default or blank policy. You specify the template name. Only a value of BLANK_POLICY is currently supported.
    UpdateCaCertificateParams MitigationActionUpdateCaCertificateParams
    Specifies the new state for the CA certificate. Only a value of DEACTIVATE is currently supported.
    UpdateDeviceCertificateParams MitigationActionUpdateDeviceCertificateParams
    Specifies the new state for a device certificate. Only a value of DEACTIVATE is currently supported.
    addThingsToThingGroupParams MitigationActionAddThingsToThingGroupParams
    Specifies the group to which you want to add the devices.
    enableIoTLoggingParams MitigationActionEnableIoTLoggingParams
    Specifies the logging level and the role with permissions for logging. You cannot specify a logging level of DISABLED .
    publishFindingToSnsParams MitigationActionPublishFindingToSnsParams
    Specifies the topic to which the finding should be published.
    replaceDefaultPolicyVersionParams MitigationActionReplaceDefaultPolicyVersionParams
    Replaces the policy version with a default or blank policy. You specify the template name. Only a value of BLANK_POLICY is currently supported.
    updateCaCertificateParams MitigationActionUpdateCaCertificateParams
    Specifies the new state for the CA certificate. Only a value of DEACTIVATE is currently supported.
    updateDeviceCertificateParams MitigationActionUpdateDeviceCertificateParams
    Specifies the new state for a device certificate. Only a value of DEACTIVATE is currently supported.
    addThingsToThingGroupParams MitigationActionAddThingsToThingGroupParams
    Specifies the group to which you want to add the devices.
    enableIoTLoggingParams MitigationActionEnableIoTLoggingParams
    Specifies the logging level and the role with permissions for logging. You cannot specify a logging level of DISABLED .
    publishFindingToSnsParams MitigationActionPublishFindingToSnsParams
    Specifies the topic to which the finding should be published.
    replaceDefaultPolicyVersionParams MitigationActionReplaceDefaultPolicyVersionParams
    Replaces the policy version with a default or blank policy. You specify the template name. Only a value of BLANK_POLICY is currently supported.
    updateCaCertificateParams MitigationActionUpdateCaCertificateParams
    Specifies the new state for the CA certificate. Only a value of DEACTIVATE is currently supported.
    updateDeviceCertificateParams MitigationActionUpdateDeviceCertificateParams
    Specifies the new state for a device certificate. Only a value of DEACTIVATE is currently supported.
    add_things_to_thing_group_params MitigationActionAddThingsToThingGroupParams
    Specifies the group to which you want to add the devices.
    enable_io_t_logging_params MitigationActionEnableIoTLoggingParams
    Specifies the logging level and the role with permissions for logging. You cannot specify a logging level of DISABLED .
    publish_finding_to_sns_params MitigationActionPublishFindingToSnsParams
    Specifies the topic to which the finding should be published.
    replace_default_policy_version_params MitigationActionReplaceDefaultPolicyVersionParams
    Replaces the policy version with a default or blank policy. You specify the template name. Only a value of BLANK_POLICY is currently supported.
    update_ca_certificate_params MitigationActionUpdateCaCertificateParams
    Specifies the new state for the CA certificate. Only a value of DEACTIVATE is currently supported.
    update_device_certificate_params MitigationActionUpdateDeviceCertificateParams
    Specifies the new state for a device certificate. Only a value of DEACTIVATE is currently supported.
    addThingsToThingGroupParams Property Map
    Specifies the group to which you want to add the devices.
    enableIoTLoggingParams Property Map
    Specifies the logging level and the role with permissions for logging. You cannot specify a logging level of DISABLED .
    publishFindingToSnsParams Property Map
    Specifies the topic to which the finding should be published.
    replaceDefaultPolicyVersionParams Property Map
    Replaces the policy version with a default or blank policy. You specify the template name. Only a value of BLANK_POLICY is currently supported.
    updateCaCertificateParams Property Map
    Specifies the new state for the CA certificate. Only a value of DEACTIVATE is currently supported.
    updateDeviceCertificateParams Property Map
    Specifies the new state for a device certificate. Only a value of DEACTIVATE is currently supported.

    MitigationActionAddThingsToThingGroupParams, MitigationActionAddThingsToThingGroupParamsArgs

    ThingGroupNames List<string>
    The list of groups to which you want to add the things that triggered the mitigation action.
    OverrideDynamicGroups bool
    Specifies if this mitigation action can move the things that triggered the mitigation action out of one or more dynamic thing groups.
    ThingGroupNames []string
    The list of groups to which you want to add the things that triggered the mitigation action.
    OverrideDynamicGroups bool
    Specifies if this mitigation action can move the things that triggered the mitigation action out of one or more dynamic thing groups.
    thingGroupNames List<String>
    The list of groups to which you want to add the things that triggered the mitigation action.
    overrideDynamicGroups Boolean
    Specifies if this mitigation action can move the things that triggered the mitigation action out of one or more dynamic thing groups.
    thingGroupNames string[]
    The list of groups to which you want to add the things that triggered the mitigation action.
    overrideDynamicGroups boolean
    Specifies if this mitigation action can move the things that triggered the mitigation action out of one or more dynamic thing groups.
    thing_group_names Sequence[str]
    The list of groups to which you want to add the things that triggered the mitigation action.
    override_dynamic_groups bool
    Specifies if this mitigation action can move the things that triggered the mitigation action out of one or more dynamic thing groups.
    thingGroupNames List<String>
    The list of groups to which you want to add the things that triggered the mitigation action.
    overrideDynamicGroups Boolean
    Specifies if this mitigation action can move the things that triggered the mitigation action out of one or more dynamic thing groups.

    MitigationActionEnableIoTLoggingParams, MitigationActionEnableIoTLoggingParamsArgs

    LogLevel Pulumi.AwsNative.IoT.MitigationActionEnableIoTLoggingParamsLogLevel
    Specifies which types of information are logged.
    RoleArnForLogging string
    The ARN of the IAM role used for logging.
    LogLevel MitigationActionEnableIoTLoggingParamsLogLevel
    Specifies which types of information are logged.
    RoleArnForLogging string
    The ARN of the IAM role used for logging.
    logLevel MitigationActionEnableIoTLoggingParamsLogLevel
    Specifies which types of information are logged.
    roleArnForLogging String
    The ARN of the IAM role used for logging.
    logLevel MitigationActionEnableIoTLoggingParamsLogLevel
    Specifies which types of information are logged.
    roleArnForLogging string
    The ARN of the IAM role used for logging.
    log_level MitigationActionEnableIoTLoggingParamsLogLevel
    Specifies which types of information are logged.
    role_arn_for_logging str
    The ARN of the IAM role used for logging.
    logLevel "DEBUG" | "INFO" | "ERROR" | "WARN" | "UNSET_VALUE"
    Specifies which types of information are logged.
    roleArnForLogging String
    The ARN of the IAM role used for logging.

    MitigationActionEnableIoTLoggingParamsLogLevel, MitigationActionEnableIoTLoggingParamsLogLevelArgs

    Debug
    DEBUG
    Info
    INFO
    Error
    ERROR
    Warn
    WARN
    UnsetValue
    UNSET_VALUE
    MitigationActionEnableIoTLoggingParamsLogLevelDebug
    DEBUG
    MitigationActionEnableIoTLoggingParamsLogLevelInfo
    INFO
    MitigationActionEnableIoTLoggingParamsLogLevelError
    ERROR
    MitigationActionEnableIoTLoggingParamsLogLevelWarn
    WARN
    MitigationActionEnableIoTLoggingParamsLogLevelUnsetValue
    UNSET_VALUE
    Debug
    DEBUG
    Info
    INFO
    Error
    ERROR
    Warn
    WARN
    UnsetValue
    UNSET_VALUE
    Debug
    DEBUG
    Info
    INFO
    Error
    ERROR
    Warn
    WARN
    UnsetValue
    UNSET_VALUE
    DEBUG
    DEBUG
    INFO
    INFO
    ERROR
    ERROR
    WARN
    WARN
    UNSET_VALUE
    UNSET_VALUE
    "DEBUG"
    DEBUG
    "INFO"
    INFO
    "ERROR"
    ERROR
    "WARN"
    WARN
    "UNSET_VALUE"
    UNSET_VALUE

    MitigationActionPublishFindingToSnsParams, MitigationActionPublishFindingToSnsParamsArgs

    TopicArn string
    The ARN of the topic to which you want to publish the findings.
    TopicArn string
    The ARN of the topic to which you want to publish the findings.
    topicArn String
    The ARN of the topic to which you want to publish the findings.
    topicArn string
    The ARN of the topic to which you want to publish the findings.
    topic_arn str
    The ARN of the topic to which you want to publish the findings.
    topicArn String
    The ARN of the topic to which you want to publish the findings.

    MitigationActionReplaceDefaultPolicyVersionParams, MitigationActionReplaceDefaultPolicyVersionParamsArgs

    TemplateName Pulumi.AwsNative.IoT.MitigationActionReplaceDefaultPolicyVersionParamsTemplateName
    The name of the template to be applied. The only supported value is BLANK_POLICY .
    TemplateName MitigationActionReplaceDefaultPolicyVersionParamsTemplateName
    The name of the template to be applied. The only supported value is BLANK_POLICY .
    templateName MitigationActionReplaceDefaultPolicyVersionParamsTemplateName
    The name of the template to be applied. The only supported value is BLANK_POLICY .
    templateName MitigationActionReplaceDefaultPolicyVersionParamsTemplateName
    The name of the template to be applied. The only supported value is BLANK_POLICY .
    template_name MitigationActionReplaceDefaultPolicyVersionParamsTemplateName
    The name of the template to be applied. The only supported value is BLANK_POLICY .
    templateName "BLANK_POLICY" | "UNSET_VALUE"
    The name of the template to be applied. The only supported value is BLANK_POLICY .

    MitigationActionReplaceDefaultPolicyVersionParamsTemplateName, MitigationActionReplaceDefaultPolicyVersionParamsTemplateNameArgs

    BlankPolicy
    BLANK_POLICY
    UnsetValue
    UNSET_VALUE
    MitigationActionReplaceDefaultPolicyVersionParamsTemplateNameBlankPolicy
    BLANK_POLICY
    MitigationActionReplaceDefaultPolicyVersionParamsTemplateNameUnsetValue
    UNSET_VALUE
    BlankPolicy
    BLANK_POLICY
    UnsetValue
    UNSET_VALUE
    BlankPolicy
    BLANK_POLICY
    UnsetValue
    UNSET_VALUE
    BLANK_POLICY
    BLANK_POLICY
    UNSET_VALUE
    UNSET_VALUE
    "BLANK_POLICY"
    BLANK_POLICY
    "UNSET_VALUE"
    UNSET_VALUE

    MitigationActionUpdateCaCertificateParams, MitigationActionUpdateCaCertificateParamsArgs

    Action Pulumi.AwsNative.IoT.MitigationActionUpdateCaCertificateParamsAction
    The action that you want to apply to the CA certificate. The only supported value is DEACTIVATE .
    Action MitigationActionUpdateCaCertificateParamsAction
    The action that you want to apply to the CA certificate. The only supported value is DEACTIVATE .
    action MitigationActionUpdateCaCertificateParamsAction
    The action that you want to apply to the CA certificate. The only supported value is DEACTIVATE .
    action MitigationActionUpdateCaCertificateParamsAction
    The action that you want to apply to the CA certificate. The only supported value is DEACTIVATE .
    action MitigationActionUpdateCaCertificateParamsAction
    The action that you want to apply to the CA certificate. The only supported value is DEACTIVATE .
    action "DEACTIVATE" | "UNSET_VALUE"
    The action that you want to apply to the CA certificate. The only supported value is DEACTIVATE .

    MitigationActionUpdateCaCertificateParamsAction, MitigationActionUpdateCaCertificateParamsActionArgs

    Deactivate
    DEACTIVATE
    UnsetValue
    UNSET_VALUE
    MitigationActionUpdateCaCertificateParamsActionDeactivate
    DEACTIVATE
    MitigationActionUpdateCaCertificateParamsActionUnsetValue
    UNSET_VALUE
    Deactivate
    DEACTIVATE
    UnsetValue
    UNSET_VALUE
    Deactivate
    DEACTIVATE
    UnsetValue
    UNSET_VALUE
    DEACTIVATE
    DEACTIVATE
    UNSET_VALUE
    UNSET_VALUE
    "DEACTIVATE"
    DEACTIVATE
    "UNSET_VALUE"
    UNSET_VALUE

    MitigationActionUpdateDeviceCertificateParams, MitigationActionUpdateDeviceCertificateParamsArgs

    Action Pulumi.AwsNative.IoT.MitigationActionUpdateDeviceCertificateParamsAction
    The action that you want to apply to the device certificate. The only supported value is DEACTIVATE .
    Action MitigationActionUpdateDeviceCertificateParamsAction
    The action that you want to apply to the device certificate. The only supported value is DEACTIVATE .
    action MitigationActionUpdateDeviceCertificateParamsAction
    The action that you want to apply to the device certificate. The only supported value is DEACTIVATE .
    action MitigationActionUpdateDeviceCertificateParamsAction
    The action that you want to apply to the device certificate. The only supported value is DEACTIVATE .
    action MitigationActionUpdateDeviceCertificateParamsAction
    The action that you want to apply to the device certificate. The only supported value is DEACTIVATE .
    action "DEACTIVATE" | "UNSET_VALUE"
    The action that you want to apply to the device certificate. The only supported value is DEACTIVATE .

    MitigationActionUpdateDeviceCertificateParamsAction, MitigationActionUpdateDeviceCertificateParamsActionArgs

    Deactivate
    DEACTIVATE
    UnsetValue
    UNSET_VALUE
    MitigationActionUpdateDeviceCertificateParamsActionDeactivate
    DEACTIVATE
    MitigationActionUpdateDeviceCertificateParamsActionUnsetValue
    UNSET_VALUE
    Deactivate
    DEACTIVATE
    UnsetValue
    UNSET_VALUE
    Deactivate
    DEACTIVATE
    UnsetValue
    UNSET_VALUE
    DEACTIVATE
    DEACTIVATE
    UNSET_VALUE
    UNSET_VALUE
    "DEACTIVATE"
    DEACTIVATE
    "UNSET_VALUE"
    UNSET_VALUE

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    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.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native