1. Packages
  2. AWS Native
  3. API Docs
  4. configuration
  5. ConfigRule

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

AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi

aws-native.configuration.ConfigRule

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi

    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.AwsNative.Configuration.Inputs.ConfigRuleSource

    Source of events for the AWS Config rule

    Compliance Pulumi.AwsNative.Configuration.Inputs.ComplianceProperties

    Compliance details of the Config rule

    ConfigRuleName string

    Name for the AWS Config rule

    Description string

    Description provided for the AWS Config rule

    EvaluationModes List<Pulumi.AwsNative.Configuration.Inputs.ConfigRuleEvaluationModeConfiguration>

    List of EvaluationModeConfiguration objects

    InputParameters string

    JSON string passed the Lambda function

    MaximumExecutionFrequency string

    Maximum frequency at which the rule has to be evaluated

    Scope Pulumi.AwsNative.Configuration.Inputs.ConfigRuleScope

    Scope to constrain which resources can trigger the AWS Config rule

    Source ConfigRuleSourceArgs

    Source of events for the AWS Config rule

    Compliance CompliancePropertiesArgs

    Compliance details of the Config rule

    ConfigRuleName string

    Name for the AWS Config rule

    Description string

    Description provided for the AWS Config rule

    EvaluationModes []ConfigRuleEvaluationModeConfigurationArgs

    List of EvaluationModeConfiguration objects

    InputParameters string

    JSON string passed the Lambda function

    MaximumExecutionFrequency string

    Maximum frequency at which the rule has to be evaluated

    Scope ConfigRuleScopeArgs

    Scope to constrain which resources can trigger the AWS Config rule

    source ConfigRuleSource

    Source of events for the AWS Config rule

    compliance ComplianceProperties

    Compliance details of the Config rule

    configRuleName String

    Name for the AWS Config rule

    description String

    Description provided for the AWS Config rule

    evaluationModes List<ConfigRuleEvaluationModeConfiguration>

    List of EvaluationModeConfiguration objects

    inputParameters String

    JSON string passed the Lambda function

    maximumExecutionFrequency String

    Maximum frequency at which the rule has to be evaluated

    scope ConfigRuleScope

    Scope to constrain which resources can trigger the AWS Config rule

    source ConfigRuleSource

    Source of events for the AWS Config rule

    compliance ComplianceProperties

    Compliance details of the Config rule

    configRuleName string

    Name for the AWS Config rule

    description string

    Description provided for the AWS Config rule

    evaluationModes ConfigRuleEvaluationModeConfiguration[]

    List of EvaluationModeConfiguration objects

    inputParameters string

    JSON string passed the Lambda function

    maximumExecutionFrequency string

    Maximum frequency at which the rule has to be evaluated

    scope ConfigRuleScope

    Scope to constrain which resources can trigger the AWS Config rule

    source ConfigRuleSourceArgs

    Source of events for the AWS Config rule

    compliance CompliancePropertiesArgs

    Compliance details of the Config rule

    config_rule_name str

    Name for the AWS Config rule

    description str

    Description provided for the AWS Config rule

    evaluation_modes Sequence[ConfigRuleEvaluationModeConfigurationArgs]

    List of EvaluationModeConfiguration objects

    input_parameters str

    JSON string passed the Lambda function

    maximum_execution_frequency str

    Maximum frequency at which the rule has to be evaluated

    scope ConfigRuleScopeArgs

    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

    configRuleName String

    Name for the AWS Config rule

    description String

    Description provided for the AWS Config rule

    evaluationModes List<Property Map>

    List of EvaluationModeConfiguration objects

    inputParameters String

    JSON string passed the Lambda function

    maximumExecutionFrequency String

    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

    ConfigRuleId string

    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

    ConfigRuleId string

    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

    configRuleId String

    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

    configRuleId string

    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_id str

    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

    configRuleId String

    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

    EnableDebugLogDelivery bool

    Logging toggle for custom policy rule

    PolicyRuntime string

    Runtime system for custom policy rule

    PolicyText string

    Policy definition containing logic for custom policy rule

    EnableDebugLogDelivery bool

    Logging toggle for custom policy rule

    PolicyRuntime string

    Runtime system for custom policy rule

    PolicyText string

    Policy definition containing logic for custom policy rule

    enableDebugLogDelivery Boolean

    Logging toggle for custom policy rule

    policyRuntime String

    Runtime system for custom policy rule

    policyText String

    Policy definition containing logic for custom policy rule

    enableDebugLogDelivery boolean

    Logging toggle for custom policy rule

    policyRuntime string

    Runtime system for custom policy rule

    policyText string

    Policy definition containing logic for custom policy rule

    enable_debug_log_delivery bool

    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

    enableDebugLogDelivery Boolean

    Logging toggle for custom policy rule

    policyRuntime String

    Runtime system for custom policy rule

    policyText 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

    ComplianceResourceId string

    ID of the only one resource which we want to trigger the rule

    ComplianceResourceTypes List<string>

    Resource types of resources which we want to trigger the rule

    TagKey string

    Tag key applied only to resources which we want to trigger the rule

    TagValue string

    Tag value applied only to resources which we want to trigger the rule

    ComplianceResourceId string

    ID of the only one resource which we want to trigger the rule

    ComplianceResourceTypes []string

    Resource types of resources which we want to trigger the rule

    TagKey string

    Tag key applied only to resources which we want to trigger the rule

    TagValue string

    Tag value applied only to resources which we want to trigger the rule

    complianceResourceId String

    ID of the only one resource which we want to trigger the rule

    complianceResourceTypes List<String>

    Resource types of resources which we want to trigger the rule

    tagKey String

    Tag key applied only to resources which we want to trigger the rule

    tagValue String

    Tag value applied only to resources which we want to trigger the rule

    complianceResourceId string

    ID of the only one resource which we want to trigger the rule

    complianceResourceTypes string[]

    Resource types of resources which we want to trigger the rule

    tagKey string

    Tag key applied only to resources which we want to trigger the rule

    tagValue string

    Tag value applied only to resources which we want to trigger the rule

    compliance_resource_id str

    ID of the only one resource which we want to trigger the rule

    compliance_resource_types Sequence[str]

    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

    complianceResourceId String

    ID of the only one resource which we want to trigger the rule

    complianceResourceTypes List<String>

    Resource types of resources which we want to trigger the rule

    tagKey String

    Tag key applied only to resources which we want to trigger the rule

    tagValue String

    Tag value applied only to resources which we want to trigger the rule

    ConfigRuleSource, ConfigRuleSourceArgs

    Owner string

    Owner of the config rule

    CustomPolicyDetails Pulumi.AwsNative.Configuration.Inputs.ConfigRuleCustomPolicyDetails

    Custom policy details when rule is custom owned

    SourceDetails List<Pulumi.AwsNative.Configuration.Inputs.ConfigRuleSourceDetail>

    List of message types that can trigger the rule

    SourceIdentifier string

    Identifier for the source of events

    Owner string

    Owner of the config rule

    CustomPolicyDetails ConfigRuleCustomPolicyDetails

    Custom policy details when rule is custom owned

    SourceDetails []ConfigRuleSourceDetail

    List of message types that can trigger the rule

    SourceIdentifier string

    Identifier for the source of events

    owner String

    Owner of the config rule

    customPolicyDetails ConfigRuleCustomPolicyDetails

    Custom policy details when rule is custom owned

    sourceDetails List<ConfigRuleSourceDetail>

    List of message types that can trigger the rule

    sourceIdentifier String

    Identifier for the source of events

    owner string

    Owner of the config rule

    customPolicyDetails ConfigRuleCustomPolicyDetails

    Custom policy details when rule is custom owned

    sourceDetails ConfigRuleSourceDetail[]

    List of message types that can trigger the rule

    sourceIdentifier string

    Identifier for the source of events

    owner str

    Owner of the config rule

    custom_policy_details ConfigRuleCustomPolicyDetails

    Custom policy details when rule is custom owned

    source_details Sequence[ConfigRuleSourceDetail]

    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

    customPolicyDetails Property Map

    Custom policy details when rule is custom owned

    sourceDetails List<Property Map>

    List of message types that can trigger the rule

    sourceIdentifier String

    Identifier for the source of events

    ConfigRuleSourceDetail, ConfigRuleSourceDetailArgs

    EventSource string

    Source of event that can trigger the rule

    MessageType string

    Notification type that can trigger the rule

    MaximumExecutionFrequency string

    Frequency at which the rule has to be evaluated

    EventSource string

    Source of event that can trigger the rule

    MessageType string

    Notification type that can trigger the rule

    MaximumExecutionFrequency string

    Frequency at which the rule has to be evaluated

    eventSource String

    Source of event that can trigger the rule

    messageType String

    Notification type that can trigger the rule

    maximumExecutionFrequency String

    Frequency at which the rule has to be evaluated

    eventSource string

    Source of event that can trigger the rule

    messageType string

    Notification type that can trigger the rule

    maximumExecutionFrequency string

    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_frequency str

    Frequency at which the rule has to be evaluated

    eventSource String

    Source of event that can trigger the rule

    messageType String

    Notification type that can trigger the rule

    maximumExecutionFrequency String

    Frequency at which the rule has to be evaluated

    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.77.0 published on Wednesday, Sep 20, 2023 by Pulumi