@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
136 lines (135 loc) • 6.98 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource Type definition for AWS::Config::RemediationConfiguration
*/
export declare class RemediationConfiguration extends pulumi.CustomResource {
/**
* Get an existing RemediationConfiguration resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): RemediationConfiguration;
/**
* Returns true if the given object is an instance of RemediationConfiguration. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is RemediationConfiguration;
/**
* The remediation is triggered automatically.
*/
readonly automatic: pulumi.Output<boolean | undefined>;
/**
* The name of the AWS Config rule.
*/
readonly configRuleName: pulumi.Output<string>;
/**
* An ExecutionControls object.
*/
readonly executionControls: pulumi.Output<outputs.configuration.RemediationConfigurationExecutionControls | undefined>;
/**
* The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.
*
* For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptSeconds as 50 seconds, AWS Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.
*/
readonly maximumAutomaticAttempts: pulumi.Output<number | undefined>;
/**
* An object of the RemediationParameterValue. For more information, see [RemediationParameterValue](https://docs.aws.amazon.com/config/latest/APIReference/API_RemediationParameterValue.html) .
*
* > The type is a map of strings to RemediationParameterValue.
*
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Config::RemediationConfiguration` for more information about the expected schema for this property.
*/
readonly parameters: pulumi.Output<any | undefined>;
/**
* The type of a resource.
*/
readonly resourceType: pulumi.Output<string | undefined>;
/**
* Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts. If `MaximumAutomaticAttempts` remediation attempts have been made under `RetryAttemptSeconds` , a remediation exception will be added to the resource. If you do not select a number, the default is 60 seconds.
*
* For example, if you specify `RetryAttemptSeconds` as 50 seconds and `MaximumAutomaticAttempts` as 5, AWS Config will run auto-remediations 5 times within 50 seconds before adding a remediation exception to the resource.
*/
readonly retryAttemptSeconds: pulumi.Output<number | undefined>;
/**
* Target ID is the name of the SSM document.
*/
readonly targetId: pulumi.Output<string>;
/**
* The type of the target. Target executes remediation. For example, SSM document.
*/
readonly targetType: pulumi.Output<string>;
/**
* Version of the target. For example, version of the SSM document.
*
* > If you make backward incompatible changes to the SSM document, you must call PutRemediationConfiguration API again to ensure the remediations can run.
*/
readonly targetVersion: pulumi.Output<string | undefined>;
/**
* Create a RemediationConfiguration resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: RemediationConfigurationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a RemediationConfiguration resource.
*/
export interface RemediationConfigurationArgs {
/**
* The remediation is triggered automatically.
*/
automatic?: pulumi.Input<boolean>;
/**
* The name of the AWS Config rule.
*/
configRuleName: pulumi.Input<string>;
/**
* An ExecutionControls object.
*/
executionControls?: pulumi.Input<inputs.configuration.RemediationConfigurationExecutionControlsArgs>;
/**
* The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.
*
* For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptSeconds as 50 seconds, AWS Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.
*/
maximumAutomaticAttempts?: pulumi.Input<number>;
/**
* An object of the RemediationParameterValue. For more information, see [RemediationParameterValue](https://docs.aws.amazon.com/config/latest/APIReference/API_RemediationParameterValue.html) .
*
* > The type is a map of strings to RemediationParameterValue.
*
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Config::RemediationConfiguration` for more information about the expected schema for this property.
*/
parameters?: any;
/**
* The type of a resource.
*/
resourceType?: pulumi.Input<string>;
/**
* Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts. If `MaximumAutomaticAttempts` remediation attempts have been made under `RetryAttemptSeconds` , a remediation exception will be added to the resource. If you do not select a number, the default is 60 seconds.
*
* For example, if you specify `RetryAttemptSeconds` as 50 seconds and `MaximumAutomaticAttempts` as 5, AWS Config will run auto-remediations 5 times within 50 seconds before adding a remediation exception to the resource.
*/
retryAttemptSeconds?: pulumi.Input<number>;
/**
* Target ID is the name of the SSM document.
*/
targetId: pulumi.Input<string>;
/**
* The type of the target. Target executes remediation. For example, SSM document.
*/
targetType: pulumi.Input<string>;
/**
* Version of the target. For example, version of the SSM document.
*
* > If you make backward incompatible changes to the SSM document, you must call PutRemediationConfiguration API again to ensure the remediations can run.
*/
targetVersion?: pulumi.Input<string>;
}