@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)
71 lines (70 loc) • 3.38 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Resource Type definition for AWS::Config::RemediationConfiguration
*/
export declare function getRemediationConfiguration(args: GetRemediationConfigurationArgs, opts?: pulumi.InvokeOptions): Promise<GetRemediationConfigurationResult>;
export interface GetRemediationConfigurationArgs {
/**
* The name of the AWS Config rule.
*/
configRuleName: string;
}
export interface GetRemediationConfigurationResult {
/**
* The remediation is triggered automatically.
*/
readonly automatic?: boolean;
/**
* An ExecutionControls object.
*/
readonly executionControls?: outputs.configuration.RemediationConfigurationExecutionControls;
/**
* 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?: 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.
*/
readonly parameters?: any;
/**
* The type of a resource.
*/
readonly resourceType?: 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.
*/
readonly retryAttemptSeconds?: number;
/**
* Target ID is the name of the SSM document.
*/
readonly targetId?: string;
/**
* The type of the target. Target executes remediation. For example, SSM document.
*/
readonly targetType?: 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?: string;
}
/**
* Resource Type definition for AWS::Config::RemediationConfiguration
*/
export declare function getRemediationConfigurationOutput(args: GetRemediationConfigurationOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetRemediationConfigurationResult>;
export interface GetRemediationConfigurationOutputArgs {
/**
* The name of the AWS Config rule.
*/
configRuleName: pulumi.Input<string>;
}