DescribeConfigRules 搭配 AWS SDK或 使用 CLI - AWS Config

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

DescribeConfigRules 搭配 AWS SDK或 使用 CLI

下列程式碼範例示範如何使用 DescribeConfigRules。

CLI
AWS CLI

若要取得 AWS Config 規則的詳細資訊

下列命令會傳回名為 的 AWS Config 規則的詳細資訊InstanceTypesAreT2micro：

aws configservice describe-config-rules --config-rule-names InstanceTypesAreT2micro

輸出：

{
    "ConfigRules": [
        {
            "ConfigRuleState": "ACTIVE",
            "Description": "Evaluates whether EC2 instances are the t2.micro type.",
            "ConfigRuleName": "InstanceTypesAreT2micro",
            "ConfigRuleArn": "arn:aws:config:us-east-1:123456789012:config-rule/config-rule-abcdef",
            "Source": {
                "Owner": "CUSTOM_LAMBDA",
                "SourceIdentifier": "arn:aws:lambda:us-east-1:123456789012:function:InstanceTypeCheck",
                "SourceDetails": [
                    {
                        "EventSource": "aws.config",
                        "MessageType": "ConfigurationItemChangeNotification"
                    }
                ]
            },
            "InputParameters": "{\"desiredInstanceType\":\"t2.micro\"}",
            "Scope": {
                "ComplianceResourceTypes": [
                    "AWS::EC2::Instance"
                ]
            },
            "ConfigRuleId": "config-rule-abcdef"
        }
    ]
}
PowerShell
適用於 的工具 PowerShell

範例 1：此範例會列出具有所選屬性的帳戶組態規則。

Get-CFGConfigRule | Select-Object ConfigRuleName, ConfigRuleId, ConfigRuleArn, ConfigRuleState

輸出：

ConfigRuleName                                    ConfigRuleId       ConfigRuleArn                                                        ConfigRuleState
--------------                                    ------------       -------------                                                        ---------------
ALB_REDIRECTION_CHECK                             config-rule-12iyn3 arn:aws:config-service:eu-west-1:123456789012:config-rule/config-rule-12iyn3 ACTIVE
access-keys-rotated                               config-rule-aospfr arn:aws:config-service:eu-west-1:123456789012:config-rule/config-rule-aospfr ACTIVE
autoscaling-group-elb-healthcheck-required        config-rule-cn1f2x arn:aws:config-service:eu-west-1:123456789012:config-rule/config-rule-cn1f2x ACTIVE

  • 如需API詳細資訊，請參閱 AWS Tools for PowerShell Cmdlet 參考 DescribeConfigRules中的 。

Python
SDK for Python （Boto3）
注意

還有更多 。 GitHub尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。

class ConfigWrapper:
    """
    Encapsulates AWS Config functions.
    """

    def __init__(self, config_client):
        """
        :param config_client: A Boto3 AWS Config client.
        """
        self.config_client = config_client


    def describe_config_rule(self, rule_name):
        """
        Gets data for the specified rule.

        :param rule_name: The name of the rule to retrieve.
        :return: The rule data.
        """
        try:
            response = self.config_client.describe_config_rules(
                ConfigRuleNames=[rule_name]
            )
            rule = response["ConfigRules"]
            logger.info("Got data for rule %s.", rule_name)
        except ClientError:
            logger.exception("Couldn't get data for rule %s.", rule_name)
            raise
        else:
            return rule

  • 如需API詳細資訊，請參閱 DescribeConfigRules 中的 AWS SDK for Python （Boto3） API參考 。

如需開發人員指南和程式碼範例的完整清單 AWS SDK，請參閱 AWS Config 搭配 使用 AWS SDK。本主題也包含有關入門的資訊，以及先前SDK版本的詳細資訊。