AWS Native is in preview. AWS Classic is fully supported.
aws-native.configuration.ConfigRule
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Schema for AWS Config ConfigRule
Create ConfigRule Resource
new ConfigRule(name: string, args: ConfigRuleArgs, opts?: CustomResourceOptions);
@overload
def ConfigRule(resource_name: str,
opts: Optional[ResourceOptions] = None,
compliance: Optional[CompliancePropertiesArgs] = None,
config_rule_name: Optional[str] = None,
description: Optional[str] = None,
evaluation_modes: Optional[Sequence[ConfigRuleEvaluationModeConfigurationArgs]] = None,
input_parameters: Optional[str] = None,
maximum_execution_frequency: Optional[str] = None,
scope: Optional[ConfigRuleScopeArgs] = None,
source: Optional[ConfigRuleSourceArgs] = None)
@overload
def ConfigRule(resource_name: str,
args: ConfigRuleArgs,
opts: Optional[ResourceOptions] = None)
func NewConfigRule(ctx *Context, name string, args ConfigRuleArgs, opts ...ResourceOption) (*ConfigRule, error)
public ConfigRule(string name, ConfigRuleArgs args, CustomResourceOptions? opts = null)
public ConfigRule(String name, ConfigRuleArgs args)
public ConfigRule(String name, ConfigRuleArgs args, CustomResourceOptions options)
type: aws-native:configuration:ConfigRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ConfigRuleArgs
- 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 ConfigRuleArgs
- 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 ConfigRuleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ConfigRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ConfigRuleArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ConfigRule 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 ConfigRule resource accepts the following input properties:
- Source
Pulumi.
Aws Native. Configuration. Inputs. Config Rule Source Source of events for the AWS Config rule
- Compliance
Pulumi.
Aws Native. Configuration. Inputs. Compliance Properties Compliance details of the Config rule
- Config
Rule stringName Name for the AWS Config rule
- Description string
Description provided for the AWS Config rule
- Evaluation
Modes List<Pulumi.Aws Native. Configuration. Inputs. Config Rule Evaluation Mode Configuration> List of EvaluationModeConfiguration objects
- Input
Parameters string JSON string passed the Lambda function
- Maximum
Execution stringFrequency Maximum frequency at which the rule has to be evaluated
- Scope
Pulumi.
Aws Native. Configuration. Inputs. Config Rule Scope Scope to constrain which resources can trigger the AWS Config rule
- Source
Config
Rule Source Args Source of events for the AWS Config rule
- Compliance
Compliance
Properties Args Compliance details of the Config rule
- Config
Rule stringName Name for the AWS Config rule
- Description string
Description provided for the AWS Config rule
- Evaluation
Modes []ConfigRule Evaluation Mode Configuration Args List of EvaluationModeConfiguration objects
- Input
Parameters string JSON string passed the Lambda function
- Maximum
Execution stringFrequency Maximum frequency at which the rule has to be evaluated
- Scope
Config
Rule Scope Args Scope to constrain which resources can trigger the AWS Config rule
- source
Config
Rule Source Source of events for the AWS Config rule
- compliance
Compliance
Properties Compliance details of the Config rule
- config
Rule StringName Name for the AWS Config rule
- description String
Description provided for the AWS Config rule
- evaluation
Modes List<ConfigRule Evaluation Mode Configuration> List of EvaluationModeConfiguration objects
- input
Parameters String JSON string passed the Lambda function
- maximum
Execution StringFrequency Maximum frequency at which the rule has to be evaluated
- scope
Config
Rule Scope Scope to constrain which resources can trigger the AWS Config rule
- source
Config
Rule Source Source of events for the AWS Config rule
- compliance
Compliance
Properties Compliance details of the Config rule
- config
Rule stringName Name for the AWS Config rule
- description string
Description provided for the AWS Config rule
- evaluation
Modes ConfigRule Evaluation Mode Configuration[] List of EvaluationModeConfiguration objects
- input
Parameters string JSON string passed the Lambda function
- maximum
Execution stringFrequency Maximum frequency at which the rule has to be evaluated
- scope
Config
Rule Scope Scope to constrain which resources can trigger the AWS Config rule
- source
Config
Rule Source Args Source of events for the AWS Config rule
- compliance
Compliance
Properties Args Compliance details of the Config rule
- config_
rule_ strname Name for the AWS Config rule
- description str
Description provided for the AWS Config rule
- evaluation_
modes Sequence[ConfigRule Evaluation Mode Configuration Args] List of EvaluationModeConfiguration objects
- input_
parameters str JSON string passed the Lambda function
- maximum_
execution_ strfrequency Maximum frequency at which the rule has to be evaluated
- scope
Config
Rule Scope Args Scope to constrain which resources can trigger the AWS Config rule
- source Property Map
Source of events for the AWS Config rule
- compliance Property Map
Compliance details of the Config rule
- config
Rule StringName Name for the AWS Config rule
- description String
Description provided for the AWS Config rule
- evaluation
Modes List<Property Map> List of EvaluationModeConfiguration objects
- input
Parameters String JSON string passed the Lambda function
- maximum
Execution StringFrequency Maximum frequency at which the rule has to be evaluated
- scope Property Map
Scope to constrain which resources can trigger the AWS Config rule
Outputs
All input properties are implicitly available as output properties. Additionally, the ConfigRule resource produces the following output properties:
- Arn string
ARN generated for the AWS Config rule
- Config
Rule stringId ID of the config rule
- Id string
The provider-assigned unique ID for this managed resource.
- Arn string
ARN generated for the AWS Config rule
- Config
Rule stringId ID of the config rule
- Id string
The provider-assigned unique ID for this managed resource.
- arn String
ARN generated for the AWS Config rule
- config
Rule StringId ID of the config rule
- id String
The provider-assigned unique ID for this managed resource.
- arn string
ARN generated for the AWS Config rule
- config
Rule stringId ID of the config rule
- id string
The provider-assigned unique ID for this managed resource.
- arn str
ARN generated for the AWS Config rule
- config_
rule_ strid ID of the config rule
- id str
The provider-assigned unique ID for this managed resource.
- arn String
ARN generated for the AWS Config rule
- config
Rule StringId ID of the config rule
- id String
The provider-assigned unique ID for this managed resource.
Supporting Types
ComplianceProperties, CompliancePropertiesArgs
- Type string
Compliance type determined by the Config rule
- Type string
Compliance type determined by the Config rule
- type String
Compliance type determined by the Config rule
- type string
Compliance type determined by the Config rule
- type str
Compliance type determined by the Config rule
- type String
Compliance type determined by the Config rule
ConfigRuleCustomPolicyDetails, ConfigRuleCustomPolicyDetailsArgs
- Enable
Debug boolLog Delivery Logging toggle for custom policy rule
- Policy
Runtime string Runtime system for custom policy rule
- Policy
Text string Policy definition containing logic for custom policy rule
- Enable
Debug boolLog Delivery Logging toggle for custom policy rule
- Policy
Runtime string Runtime system for custom policy rule
- Policy
Text string Policy definition containing logic for custom policy rule
- enable
Debug BooleanLog Delivery Logging toggle for custom policy rule
- policy
Runtime String Runtime system for custom policy rule
- policy
Text String Policy definition containing logic for custom policy rule
- enable
Debug booleanLog Delivery Logging toggle for custom policy rule
- policy
Runtime string Runtime system for custom policy rule
- policy
Text string Policy definition containing logic for custom policy rule
- enable_
debug_ boollog_ delivery Logging toggle for custom policy rule
- policy_
runtime str Runtime system for custom policy rule
- policy_
text str Policy definition containing logic for custom policy rule
- enable
Debug BooleanLog Delivery Logging toggle for custom policy rule
- policy
Runtime String Runtime system for custom policy rule
- policy
Text String Policy definition containing logic for custom policy rule
ConfigRuleEvaluationModeConfiguration, ConfigRuleEvaluationModeConfigurationArgs
- Mode string
Mode of evaluation of AWS Config rule
- Mode string
Mode of evaluation of AWS Config rule
- mode String
Mode of evaluation of AWS Config rule
- mode string
Mode of evaluation of AWS Config rule
- mode str
Mode of evaluation of AWS Config rule
- mode String
Mode of evaluation of AWS Config rule
ConfigRuleScope, ConfigRuleScopeArgs
- Compliance
Resource stringId ID of the only one resource which we want to trigger the rule
- Compliance
Resource List<string>Types Resource types of resources which we want to trigger the rule
- Tag
Key string Tag key applied only to resources which we want to trigger the rule
- Tag
Value string Tag value applied only to resources which we want to trigger the rule
- Compliance
Resource stringId ID of the only one resource which we want to trigger the rule
- Compliance
Resource []stringTypes Resource types of resources which we want to trigger the rule
- Tag
Key string Tag key applied only to resources which we want to trigger the rule
- Tag
Value string Tag value applied only to resources which we want to trigger the rule
- compliance
Resource StringId ID of the only one resource which we want to trigger the rule
- compliance
Resource List<String>Types Resource types of resources which we want to trigger the rule
- tag
Key String Tag key applied only to resources which we want to trigger the rule
- tag
Value String Tag value applied only to resources which we want to trigger the rule
- compliance
Resource stringId ID of the only one resource which we want to trigger the rule
- compliance
Resource string[]Types Resource types of resources which we want to trigger the rule
- tag
Key string Tag key applied only to resources which we want to trigger the rule
- tag
Value string Tag value applied only to resources which we want to trigger the rule
- compliance_
resource_ strid ID of the only one resource which we want to trigger the rule
- compliance_
resource_ Sequence[str]types Resource types of resources which we want to trigger the rule
- tag_
key str Tag key applied only to resources which we want to trigger the rule
- tag_
value str Tag value applied only to resources which we want to trigger the rule
- compliance
Resource StringId ID of the only one resource which we want to trigger the rule
- compliance
Resource List<String>Types Resource types of resources which we want to trigger the rule
- tag
Key String Tag key applied only to resources which we want to trigger the rule
- tag
Value String Tag value applied only to resources which we want to trigger the rule
ConfigRuleSource, ConfigRuleSourceArgs
- Owner string
Owner of the config rule
- Custom
Policy Pulumi.Details Aws Native. Configuration. Inputs. Config Rule Custom Policy Details Custom policy details when rule is custom owned
- Source
Details List<Pulumi.Aws Native. Configuration. Inputs. Config Rule Source Detail> List of message types that can trigger the rule
- Source
Identifier string Identifier for the source of events
- Owner string
Owner of the config rule
- Custom
Policy ConfigDetails Rule Custom Policy Details Custom policy details when rule is custom owned
- Source
Details []ConfigRule Source Detail List of message types that can trigger the rule
- Source
Identifier string Identifier for the source of events
- owner String
Owner of the config rule
- custom
Policy ConfigDetails Rule Custom Policy Details Custom policy details when rule is custom owned
- source
Details List<ConfigRule Source Detail> List of message types that can trigger the rule
- source
Identifier String Identifier for the source of events
- owner string
Owner of the config rule
- custom
Policy ConfigDetails Rule Custom Policy Details Custom policy details when rule is custom owned
- source
Details ConfigRule Source Detail[] List of message types that can trigger the rule
- source
Identifier string Identifier for the source of events
- owner str
Owner of the config rule
- custom_
policy_ Configdetails Rule Custom Policy Details Custom policy details when rule is custom owned
- source_
details Sequence[ConfigRule Source Detail] List of message types that can trigger the rule
- source_
identifier str Identifier for the source of events
- owner String
Owner of the config rule
- custom
Policy Property MapDetails Custom policy details when rule is custom owned
- source
Details List<Property Map> List of message types that can trigger the rule
- source
Identifier String Identifier for the source of events
ConfigRuleSourceDetail, ConfigRuleSourceDetailArgs
- Event
Source string Source of event that can trigger the rule
- Message
Type string Notification type that can trigger the rule
- Maximum
Execution stringFrequency Frequency at which the rule has to be evaluated
- Event
Source string Source of event that can trigger the rule
- Message
Type string Notification type that can trigger the rule
- Maximum
Execution stringFrequency Frequency at which the rule has to be evaluated
- event
Source String Source of event that can trigger the rule
- message
Type String Notification type that can trigger the rule
- maximum
Execution StringFrequency Frequency at which the rule has to be evaluated
- event
Source string Source of event that can trigger the rule
- message
Type string Notification type that can trigger the rule
- maximum
Execution stringFrequency Frequency at which the rule has to be evaluated
- event_
source str Source of event that can trigger the rule
- message_
type str Notification type that can trigger the rule
- maximum_
execution_ strfrequency Frequency at which the rule has to be evaluated
- event
Source String Source of event that can trigger the rule
- message
Type String Notification type that can trigger the rule
- maximum
Execution StringFrequency Frequency at which the rule has to be evaluated
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.