D'autres exemples de AWS SDK sont disponibles dans le référentiel [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub .
Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
# Exemples de code à AWS Config utiliser AWS SDKs
Les exemples de code suivants vous montrent comment utiliser AWS Config un kit de développement AWS logiciel (SDK).
Les *actions* sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.
**Ressources supplémentaires**
+ **[AWS Config Guide du développeur](https://docs.aws.amazon.com/config/latest/developerguide/WhatIsConfig.html)** — Plus d'informations sur AWS Config.
+ **[AWS Config Référence d'API](https://docs.aws.amazon.com/config/latest/APIReference/Welcome.html)** : détails sur toutes les AWS Config actions disponibles.
+ **[AWS Centre pour les développeurs](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23config)** : exemples de code que vous pouvez filtrer par catégorie ou par recherche en texte intégral.
+ **[AWS Exemples de SDK](https://github.com/awsdocs/aws-doc-sdk-examples)** : GitHub dépôt avec code complet dans les langues préférées. Inclut des instructions sur la configuration et l’exécution du code.
**Contents**
+ [Principes de base](config-service_code_examples_basics.md)
+ [Actions](config-service_code_examples_actions.md)
+ [`DeleteConfigRule`](config-service_example_config-service_DeleteConfigRule_section.md)
+ [`DescribeComplianceByConfigRule`](config-service_example_config-service_DescribeComplianceByConfigRule_section.md)
+ [`DescribeComplianceByResource`](config-service_example_config-service_DescribeComplianceByResource_section.md)
+ [`DescribeConfigRuleEvaluationStatus`](config-service_example_config-service_DescribeConfigRuleEvaluationStatus_section.md)
+ [`DescribeConfigRules`](config-service_example_config-service_DescribeConfigRules_section.md)
+ [`DescribeConfigurationRecorderStatus`](config-service_example_config-service_DescribeConfigurationRecorderStatus_section.md)
+ [`DescribeConfigurationRecorders`](config-service_example_config-service_DescribeConfigurationRecorders_section.md)
+ [`DescribeDeliveryChannels`](config-service_example_config-service_DescribeDeliveryChannels_section.md)
+ [`GetComplianceDetailsByConfigRule`](config-service_example_config-service_GetComplianceDetailsByConfigRule_section.md)
+ [`GetComplianceDetailsByResource`](config-service_example_config-service_GetComplianceDetailsByResource_section.md)
+ [`GetComplianceSummaryByConfigRule`](config-service_example_config-service_GetComplianceSummaryByConfigRule_section.md)
+ [`GetComplianceSummaryByResourceType`](config-service_example_config-service_GetComplianceSummaryByResourceType_section.md)
+ [`PutConfigRule`](config-service_example_config-service_PutConfigRule_section.md)
+ [`PutDeliveryChannel`](config-service_example_config-service_PutDeliveryChannel_section.md)
# Exemples de base pour AWS Config l'utilisation AWS SDKs
Les exemples de code suivants montrent comment utiliser les principes de base de AWS Config with AWS SDKs.
**Contents**
+ [Actions](config-service_code_examples_actions.md)
+ [`DeleteConfigRule`](config-service_example_config-service_DeleteConfigRule_section.md)
+ [`DescribeComplianceByConfigRule`](config-service_example_config-service_DescribeComplianceByConfigRule_section.md)
+ [`DescribeComplianceByResource`](config-service_example_config-service_DescribeComplianceByResource_section.md)
+ [`DescribeConfigRuleEvaluationStatus`](config-service_example_config-service_DescribeConfigRuleEvaluationStatus_section.md)
+ [`DescribeConfigRules`](config-service_example_config-service_DescribeConfigRules_section.md)
+ [`DescribeConfigurationRecorderStatus`](config-service_example_config-service_DescribeConfigurationRecorderStatus_section.md)
+ [`DescribeConfigurationRecorders`](config-service_example_config-service_DescribeConfigurationRecorders_section.md)
+ [`DescribeDeliveryChannels`](config-service_example_config-service_DescribeDeliveryChannels_section.md)
+ [`GetComplianceDetailsByConfigRule`](config-service_example_config-service_GetComplianceDetailsByConfigRule_section.md)
+ [`GetComplianceDetailsByResource`](config-service_example_config-service_GetComplianceDetailsByResource_section.md)
+ [`GetComplianceSummaryByConfigRule`](config-service_example_config-service_GetComplianceSummaryByConfigRule_section.md)
+ [`GetComplianceSummaryByResourceType`](config-service_example_config-service_GetComplianceSummaryByResourceType_section.md)
+ [`PutConfigRule`](config-service_example_config-service_PutConfigRule_section.md)
+ [`PutDeliveryChannel`](config-service_example_config-service_PutDeliveryChannel_section.md)
# Actions d' AWS Config utilisation AWS SDKs
Les exemples de code suivants montrent comment effectuer des AWS Config actions individuelles avec AWS SDKs. Chaque exemple inclut un lien vers GitHub, où vous pouvez trouver des instructions pour configurer et exécuter le code.
Les exemples suivants incluent uniquement les actions les plus couramment utilisées. Pour obtenir la liste complète, consultez la [Référence des API AWS Config](https://docs.aws.amazon.com/config/latest/APIReference/Welcome.html).
**Topics**
+ [`DeleteConfigRule`](config-service_example_config-service_DeleteConfigRule_section.md)
+ [`DescribeComplianceByConfigRule`](config-service_example_config-service_DescribeComplianceByConfigRule_section.md)
+ [`DescribeComplianceByResource`](config-service_example_config-service_DescribeComplianceByResource_section.md)
+ [`DescribeConfigRuleEvaluationStatus`](config-service_example_config-service_DescribeConfigRuleEvaluationStatus_section.md)
+ [`DescribeConfigRules`](config-service_example_config-service_DescribeConfigRules_section.md)
+ [`DescribeConfigurationRecorderStatus`](config-service_example_config-service_DescribeConfigurationRecorderStatus_section.md)
+ [`DescribeConfigurationRecorders`](config-service_example_config-service_DescribeConfigurationRecorders_section.md)
+ [`DescribeDeliveryChannels`](config-service_example_config-service_DescribeDeliveryChannels_section.md)
+ [`GetComplianceDetailsByConfigRule`](config-service_example_config-service_GetComplianceDetailsByConfigRule_section.md)
+ [`GetComplianceDetailsByResource`](config-service_example_config-service_GetComplianceDetailsByResource_section.md)
+ [`GetComplianceSummaryByConfigRule`](config-service_example_config-service_GetComplianceSummaryByConfigRule_section.md)
+ [`GetComplianceSummaryByResourceType`](config-service_example_config-service_GetComplianceSummaryByResourceType_section.md)
+ [`PutConfigRule`](config-service_example_config-service_PutConfigRule_section.md)
+ [`PutDeliveryChannel`](config-service_example_config-service_PutDeliveryChannel_section.md)
# Utilisation `DeleteConfigRule` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `DeleteConfigRule`.
------
#### [ CLI ]
**AWS CLI**
**Pour supprimer une règle AWS Config**
La commande suivante supprime une règle AWS Config nommée `MyConfigRule` :
```
aws configservice delete-config-rule --config-rule-name MyConfigRule
```
+ Pour plus de détails sur l'API, reportez-vous [DeleteConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/delete-config-rule.html)à la section *Référence des AWS CLI commandes*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/config#code-examples).
```
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 delete_config_rule(self, rule_name):
"""
Delete the specified rule.
:param rule_name: The name of the rule to delete.
"""
try:
self.config_client.delete_config_rule(ConfigRuleName=rule_name)
logger.info("Deleted rule %s.", rule_name)
except ClientError:
logger.exception("Couldn't delete rule %s.", rule_name)
raise
```
+ Pour plus de détails sur l'API, consultez [DeleteConfigRule](https://docs.aws.amazon.com/goto/boto3/config-2014-11-12/DeleteConfigRule)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cfs#code-examples).
```
lo_cfs->deleteconfigrule( iv_rule_name ).
MESSAGE 'Deleted AWS Config rule.' TYPE 'I'.
```
+ Pour plus de détails sur l'API, reportez-vous [DeleteConfigRule](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Utilisation de `DescribeComplianceByConfigRule` avec une CLI
Les exemples de code suivants illustrent comment utiliser `DescribeComplianceByConfigRule`.
------
#### [ CLI ]
**AWS CLI**
**Pour obtenir des informations de conformité pour vos règles de AWS Config**
La commande suivante renvoie des informations de conformité pour chaque règle de AWS Config violée par une ou plusieurs AWS ressources :
```
aws configservice describe-compliance-by-config-rule --compliance-types NON_COMPLIANT
```
Dans la sortie, la valeur de chaque attribut `CappedCount` indique le nombre de ressources qui ne sont pas conformes à la règle correspondante. Par exemple, la sortie suivante indique que 3 ressources ne sont pas conformes à la règle nommée `InstanceTypesAreT2micro`.
Sortie :
```
{
"ComplianceByConfigRules": [
{
"Compliance": {
"ComplianceContributorCount": {
"CappedCount": 3,
"CapExceeded": false
},
"ComplianceType": "NON_COMPLIANT"
},
"ConfigRuleName": "InstanceTypesAreT2micro"
},
{
"Compliance": {
"ComplianceContributorCount": {
"CappedCount": 10,
"CapExceeded": false
},
"ComplianceType": "NON_COMPLIANT"
},
"ConfigRuleName": "RequiredTagsForVolumes"
}
]
}
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeComplianceByConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-compliance-by-config-rule.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : Cet exemple récupère les détails de conformité de la règle ebs-optimized-instance, pour laquelle il n'existe aucun résultat d'évaluation actuel pour la règle, il renvoie donc INSUFFIENT\$1DATA**
```
(Get-CFGComplianceByConfigRule -ConfigRuleName ebs-optimized-instance).Compliance
```
**Sortie** :
```
ComplianceContributorCount ComplianceType
-------------------------- --------------
INSUFFICIENT_DATA
```
**Exemple 2 : cet exemple renvoie le nombre de ressources non conformes pour la règle ALB\$1HTTP\$1TO\$1HTTPS\$1REDIRECTION\$1CHECK.**
```
(Get-CFGComplianceByConfigRule -ConfigRuleName ALB_HTTP_TO_HTTPS_REDIRECTION_CHECK -ComplianceType NON_COMPLIANT).Compliance.ComplianceContributorCount
```
**Sortie** :
```
CapExceeded CappedCount
----------- -----------
False 2
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeComplianceByConfigRule](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : Cet exemple récupère les détails de conformité de la règle ebs-optimized-instance, pour laquelle il n'existe aucun résultat d'évaluation actuel pour la règle, il renvoie donc INSUFFIENT\$1DATA**
```
(Get-CFGComplianceByConfigRule -ConfigRuleName ebs-optimized-instance).Compliance
```
**Sortie** :
```
ComplianceContributorCount ComplianceType
-------------------------- --------------
INSUFFICIENT_DATA
```
**Exemple 2 : cet exemple renvoie le nombre de ressources non conformes pour la règle ALB\$1HTTP\$1TO\$1HTTPS\$1REDIRECTION\$1CHECK.**
```
(Get-CFGComplianceByConfigRule -ConfigRuleName ALB_HTTP_TO_HTTPS_REDIRECTION_CHECK -ComplianceType NON_COMPLIANT).Compliance.ComplianceContributorCount
```
**Sortie** :
```
CapExceeded CappedCount
----------- -----------
False 2
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeComplianceByConfigRule](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `DescribeComplianceByResource` avec une CLI
Les exemples de code suivants illustrent comment utiliser `DescribeComplianceByResource`.
------
#### [ CLI ]
**AWS CLI**
**Pour obtenir des informations de conformité pour vos AWS ressources**
La commande suivante renvoie des informations de conformité pour chaque instance EC2 enregistrée par AWS Config et qui enfreint une ou plusieurs règles :
```
aws configservice describe-compliance-by-resource --resource-type AWS::EC2::Instance --compliance-types NON_COMPLIANT
```
Dans la sortie, la valeur de chaque attribut `CappedCount` indique le nombre de règles que la ressource ne respecte pas. Par exemple, la sortie suivante indique que l’instance `i-1a2b3c4d` enfreint 2 règles.
Sortie :
```
{
"ComplianceByResources": [
{
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-1a2b3c4d",
"Compliance": {
"ComplianceContributorCount": {
"CappedCount": 2,
"CapExceeded": false
},
"ComplianceType": "NON_COMPLIANT"
}
},
{
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-2a2b3c4d ",
"Compliance": {
"ComplianceContributorCount": {
"CappedCount": 3,
"CapExceeded": false
},
"ComplianceType": "NON_COMPLIANT"
}
}
]
}
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeComplianceByResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-compliance-by-resource.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cet exemple vérifie le type de ressource `AWS::SSM::ManagedInstanceInventory` pour le type de conformité « CONFORME ».**
```
Get-CFGComplianceByResource -ComplianceType COMPLIANT -ResourceType AWS::SSM::ManagedInstanceInventory
```
**Sortie** :
```
Compliance ResourceId ResourceType
---------- ---------- ------------
Amazon.ConfigService.Model.Compliance i-0123bcf4b567890e3 AWS::SSM::ManagedInstanceInventory
Amazon.ConfigService.Model.Compliance i-0a1234f6f5d6b78f7 AWS::SSM::ManagedInstanceInventory
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeComplianceByResource](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cet exemple vérifie le type de ressource `AWS::SSM::ManagedInstanceInventory` pour le type de conformité « CONFORME ».**
```
Get-CFGComplianceByResource -ComplianceType COMPLIANT -ResourceType AWS::SSM::ManagedInstanceInventory
```
**Sortie** :
```
Compliance ResourceId ResourceType
---------- ---------- ------------
Amazon.ConfigService.Model.Compliance i-0123bcf4b567890e3 AWS::SSM::ManagedInstanceInventory
Amazon.ConfigService.Model.Compliance i-0a1234f6f5d6b78f7 AWS::SSM::ManagedInstanceInventory
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeComplianceByResource](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `DescribeConfigRuleEvaluationStatus` avec une CLI
Les exemples de code suivants illustrent comment utiliser `DescribeConfigRuleEvaluationStatus`.
------
#### [ CLI ]
**AWS CLI**
**Pour obtenir des informations sur le statut d'une règle AWS Config**
La commande suivante renvoie les informations d'état d'une règle AWS Config nommée `MyConfigRule` :
```
aws configservice describe-config-rule-evaluation-status --config-rule-names MyConfigRule
```
Sortie :
```
{
"ConfigRulesEvaluationStatus": [
{
"ConfigRuleArn": "arn:aws:config:us-east-1:123456789012:config-rule/config-rule-abcdef",
"FirstActivatedTime": 1450311703.844,
"ConfigRuleId": "config-rule-abcdef",
"LastSuccessfulInvocationTime": 1450314643.156,
"ConfigRuleName": "MyConfigRule"
}
]
}
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeConfigRuleEvaluationStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-config-rule-evaluation-status.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cet exemple renvoie les informations de statut pour les règles de configuration données.**
```
Get-CFGConfigRuleEvaluationStatus -ConfigRuleName root-account-mfa-enabled, vpc-flow-logs-enabled
```
**Sortie** :
```
ConfigRuleArn : arn:aws:config:eu-west-1:123456789012:config-rule/config-rule-kvq1wk
ConfigRuleId : config-rule-kvq1wk
ConfigRuleName : root-account-mfa-enabled
FirstActivatedTime : 8/27/2019 8:05:17 AM
FirstEvaluationStarted : True
LastErrorCode :
LastErrorMessage :
LastFailedEvaluationTime : 1/1/0001 12:00:00 AM
LastFailedInvocationTime : 1/1/0001 12:00:00 AM
LastSuccessfulEvaluationTime : 12/13/2019 8:12:03 AM
LastSuccessfulInvocationTime : 12/13/2019 8:12:03 AM
ConfigRuleArn : arn:aws:config:eu-west-1:123456789012:config-rule/config-rule-z1s23b
ConfigRuleId : config-rule-z1s23b
ConfigRuleName : vpc-flow-logs-enabled
FirstActivatedTime : 8/14/2019 6:23:44 AM
FirstEvaluationStarted : True
LastErrorCode :
LastErrorMessage :
LastFailedEvaluationTime : 1/1/0001 12:00:00 AM
LastFailedInvocationTime : 1/1/0001 12:00:00 AM
LastSuccessfulEvaluationTime : 12/13/2019 7:12:01 AM
LastSuccessfulInvocationTime : 12/13/2019 7:12:01 AM
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeConfigRuleEvaluationStatus](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cet exemple renvoie les informations de statut pour les règles de configuration données.**
```
Get-CFGConfigRuleEvaluationStatus -ConfigRuleName root-account-mfa-enabled, vpc-flow-logs-enabled
```
**Sortie** :
```
ConfigRuleArn : arn:aws:config:eu-west-1:123456789012:config-rule/config-rule-kvq1wk
ConfigRuleId : config-rule-kvq1wk
ConfigRuleName : root-account-mfa-enabled
FirstActivatedTime : 8/27/2019 8:05:17 AM
FirstEvaluationStarted : True
LastErrorCode :
LastErrorMessage :
LastFailedEvaluationTime : 1/1/0001 12:00:00 AM
LastFailedInvocationTime : 1/1/0001 12:00:00 AM
LastSuccessfulEvaluationTime : 12/13/2019 8:12:03 AM
LastSuccessfulInvocationTime : 12/13/2019 8:12:03 AM
ConfigRuleArn : arn:aws:config:eu-west-1:123456789012:config-rule/config-rule-z1s23b
ConfigRuleId : config-rule-z1s23b
ConfigRuleName : vpc-flow-logs-enabled
FirstActivatedTime : 8/14/2019 6:23:44 AM
FirstEvaluationStarted : True
LastErrorCode :
LastErrorMessage :
LastFailedEvaluationTime : 1/1/0001 12:00:00 AM
LastFailedInvocationTime : 1/1/0001 12:00:00 AM
LastSuccessfulEvaluationTime : 12/13/2019 7:12:01 AM
LastSuccessfulInvocationTime : 12/13/2019 7:12:01 AM
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeConfigRuleEvaluationStatus](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation `DescribeConfigRules` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `DescribeConfigRules`.
------
#### [ CLI ]
**AWS CLI**
**Pour obtenir les détails d'une règle AWS Config**
La commande suivante renvoie les détails d'une règle AWS Config nommée `InstanceTypesAreT2micro` :
```
aws configservice describe-config-rules --config-rule-names InstanceTypesAreT2micro
```
Sortie :
```
{
"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"
}
]
}
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeConfigRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-config-rules.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cet exemple répertorie les règles de configuration du compte, avec les propriétés sélectionnées.**
```
Get-CFGConfigRule | Select-Object ConfigRuleName, ConfigRuleId, ConfigRuleArn, ConfigRuleState
```
**Sortie** :
```
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
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeConfigRules](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cet exemple répertorie les règles de configuration du compte, avec les propriétés sélectionnées.**
```
Get-CFGConfigRule | Select-Object ConfigRuleName, ConfigRuleId, ConfigRuleArn, ConfigRuleState
```
**Sortie** :
```
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
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeConfigRules](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/config#code-examples).
```
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
```
+ Pour plus de détails sur l'API, consultez [DescribeConfigRules](https://docs.aws.amazon.com/goto/boto3/config-2014-11-12/DescribeConfigRules)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cfs#code-examples).
```
DATA(lo_result) = lo_cfs->describeconfigrules(
it_configrulenames = VALUE /aws1/cl_cfsconfigrulenames_w=>tt_configrulenames(
( NEW /aws1/cl_cfsconfigrulenames_w( iv_rule_name ) )
)
).
ot_cfg_rules = lo_result->get_configrules( ).
MESSAGE 'Retrieved AWS Config rule data.' TYPE 'I'.
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeConfigRules](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Utilisation de `DescribeConfigurationRecorderStatus` avec une CLI
Les exemples de code suivants illustrent comment utiliser `DescribeConfigurationRecorderStatus`.
------
#### [ CLI ]
**AWS CLI**
**Pour obtenir des informations sur le statut de l’enregistreur de configuration**
La commande suivante renvoie le statut de l’enregistreur de configuration par défaut :
```
aws configservice describe-configuration-recorder-status
```
Sortie :
```
{
"ConfigurationRecordersStatus": [
{
"name": "default",
"lastStatus": "SUCCESS",
"recording": true,
"lastStatusChangeTime": 1452193834.344,
"lastStartTime": 1441039997.819,
"lastStopTime": 1441039992.835
}
]
}
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeConfigurationRecorderStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-configuration-recorder-status.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cet exemple renvoie le statut des enregistreurs de configuration.**
```
Get-CFGConfigurationRecorderStatus
```
**Sortie** :
```
LastErrorCode :
LastErrorMessage :
LastStartTime : 10/11/2019 10:13:51 AM
LastStatus : Success
LastStatusChangeTime : 12/31/2019 6:14:12 AM
LastStopTime : 10/11/2019 10:13:46 AM
Name : default
Recording : True
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeConfigurationRecorderStatus](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cet exemple renvoie le statut des enregistreurs de configuration.**
```
Get-CFGConfigurationRecorderStatus
```
**Sortie** :
```
LastErrorCode :
LastErrorMessage :
LastStartTime : 10/11/2019 10:13:51 AM
LastStatus : Success
LastStatusChangeTime : 12/31/2019 6:14:12 AM
LastStopTime : 10/11/2019 10:13:46 AM
Name : default
Recording : True
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeConfigurationRecorderStatus](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `DescribeConfigurationRecorders` avec une CLI
Les exemples de code suivants illustrent comment utiliser `DescribeConfigurationRecorders`.
------
#### [ CLI ]
**AWS CLI**
**Pour obtenir des informations sur l’enregistreur de configuration**
La commande suivante renvoie des informations sur l’enregistreur de configuration par défaut :
```
aws configservice describe-configuration-recorders
```
Sortie :
```
{
"ConfigurationRecorders": [
{
"recordingGroup": {
"allSupported": true,
"resourceTypes": [],
"includeGlobalResourceTypes": true
},
"roleARN": "arn:aws:iam::123456789012:role/config-ConfigRole-A1B2C3D4E5F6",
"name": "default"
}
]
}
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeConfigurationRecorders](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-configuration-recorders.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cet exemple renvoie les détails des enregistreurs de configuration.**
```
Get-CFGConfigurationRecorder | Format-List
```
**Sortie** :
```
Name : default
RecordingGroup : Amazon.ConfigService.Model.RecordingGroup
RoleARN : arn:aws:iam::123456789012:role/aws-service-role/config.amazonaws.com/AWSServiceRoleForConfig
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeConfigurationRecorders](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cet exemple renvoie les détails des enregistreurs de configuration.**
```
Get-CFGConfigurationRecorder | Format-List
```
**Sortie** :
```
Name : default
RecordingGroup : Amazon.ConfigService.Model.RecordingGroup
RoleARN : arn:aws:iam::123456789012:role/aws-service-role/config.amazonaws.com/AWSServiceRoleForConfig
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeConfigurationRecorders](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `DescribeDeliveryChannels` avec une CLI
Les exemples de code suivants illustrent comment utiliser `DescribeDeliveryChannels`.
------
#### [ CLI ]
**AWS CLI**
**Pour obtenir les informations concernant le canal de livraison**
La commande suivante renvoie des informations sur le canal de livraison :
```
aws configservice describe-delivery-channels
```
Sortie :
```
{
"DeliveryChannels": [
{
"snsTopicARN": "arn:aws:sns:us-east-1:123456789012:config-topic",
"name": "default",
"s3BucketName": "config-bucket-123456789012"
}
]
}
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeDeliveryChannels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-delivery-channels.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cet exemple extrait le canal de distribution de la région et affiche les détails.**
```
Get-CFGDeliveryChannel -Region eu-west-1 | Select-Object Name, S3BucketName, S3KeyPrefix, @{N="DeliveryFrequency";E={$_.ConfigSnapshotDeliveryProperties.DeliveryFrequency}}
```
**Sortie** :
```
Name S3BucketName S3KeyPrefix DeliveryFrequency
---- ------------ ----------- -----------------
default config-bucket-NA my TwentyFour_Hours
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeDeliveryChannels](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cet exemple extrait le canal de distribution de la région et affiche les détails.**
```
Get-CFGDeliveryChannel -Region eu-west-1 | Select-Object Name, S3BucketName, S3KeyPrefix, @{N="DeliveryFrequency";E={$_.ConfigSnapshotDeliveryProperties.DeliveryFrequency}}
```
**Sortie** :
```
Name S3BucketName S3KeyPrefix DeliveryFrequency
---- ------------ ----------- -----------------
default config-bucket-NA my TwentyFour_Hours
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeDeliveryChannels](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `GetComplianceDetailsByConfigRule` avec une CLI
Les exemples de code suivants illustrent comment utiliser `GetComplianceDetailsByConfigRule`.
------
#### [ CLI ]
**AWS CLI**
**Pour obtenir les résultats de l'évaluation d'une règle AWS Config**
La commande suivante renvoie les résultats de l'évaluation pour toutes les ressources qui ne sont pas conformes à une règle de AWS configuration nommée `InstanceTypesAreT2micro` :
```
aws configservice get-compliance-details-by-config-rule --config-rule-name InstanceTypesAreT2micro --compliance-types NON_COMPLIANT
```
Sortie :
```
{
"EvaluationResults": [
{
"EvaluationResultIdentifier": {
"OrderingTimestamp": 1450314635.065,
"EvaluationResultQualifier": {
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-1a2b3c4d",
"ConfigRuleName": "InstanceTypesAreT2micro"
}
},
"ResultRecordedTime": 1450314645.261,
"ConfigRuleInvokedTime": 1450314642.948,
"ComplianceType": "NON_COMPLIANT"
},
{
"EvaluationResultIdentifier": {
"OrderingTimestamp": 1450314635.065,
"EvaluationResultQualifier": {
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-2a2b3c4d",
"ConfigRuleName": "InstanceTypesAreT2micro"
}
},
"ResultRecordedTime": 1450314645.18,
"ConfigRuleInvokedTime": 1450314642.902,
"ComplianceType": "NON_COMPLIANT"
},
{
"EvaluationResultIdentifier": {
"OrderingTimestamp": 1450314635.065,
"EvaluationResultQualifier": {
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-3a2b3c4d",
"ConfigRuleName": "InstanceTypesAreT2micro"
}
},
"ResultRecordedTime": 1450314643.346,
"ConfigRuleInvokedTime": 1450314643.124,
"ComplianceType": "NON_COMPLIANT"
}
]
}
```
+ Pour plus de détails sur l'API, reportez-vous [GetComplianceDetailsByConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-compliance-details-by-config-rule.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : Cet exemple obtient les résultats de l'évaluation de la règle access-keys-rotated et renvoie la sortie groupée par type de conformité**
```
Get-CFGComplianceDetailsByConfigRule -ConfigRuleName access-keys-rotated | Group-Object ComplianceType
```
**Sortie** :
```
Count Name Group
----- ---- -----
2 COMPLIANT {Amazon.ConfigService.Model.EvaluationResult, Amazon.ConfigService.Model.EvaluationResult}
5 NON_COMPLIANT {Amazon.ConfigService.Model.EvaluationResult, Amazon.ConfigService.Model.EvaluationResult, Amazon.ConfigService.Model.EvaluationRes...
```
**Exemple 2 : Cet exemple interroge les détails de conformité de la règle relative access-keys-rotated aux ressources COMPLIANT.**
```
Get-CFGComplianceDetailsByConfigRule -ConfigRuleName access-keys-rotated -ComplianceType COMPLIANT | ForEach-Object {$_.EvaluationResultIdentifier.EvaluationResultQualifier}
```
**Sortie** :
```
ConfigRuleName ResourceId ResourceType
-------------- ---------- ------------
access-keys-rotated BCAB1CDJ2LITAPVEW3JAH AWS::IAM::User
access-keys-rotated BCAB1CDJ2LITL3EHREM4Q AWS::IAM::User
```
+ Pour plus de détails sur l'API, reportez-vous [GetComplianceDetailsByConfigRule](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : Cet exemple obtient les résultats de l'évaluation de la règle access-keys-rotated et renvoie la sortie groupée par type de conformité**
```
Get-CFGComplianceDetailsByConfigRule -ConfigRuleName access-keys-rotated | Group-Object ComplianceType
```
**Sortie** :
```
Count Name Group
----- ---- -----
2 COMPLIANT {Amazon.ConfigService.Model.EvaluationResult, Amazon.ConfigService.Model.EvaluationResult}
5 NON_COMPLIANT {Amazon.ConfigService.Model.EvaluationResult, Amazon.ConfigService.Model.EvaluationResult, Amazon.ConfigService.Model.EvaluationRes...
```
**Exemple 2 : Cet exemple interroge les détails de conformité de la règle relative access-keys-rotated aux ressources COMPLIANT.**
```
Get-CFGComplianceDetailsByConfigRule -ConfigRuleName access-keys-rotated -ComplianceType COMPLIANT | ForEach-Object {$_.EvaluationResultIdentifier.EvaluationResultQualifier}
```
**Sortie** :
```
ConfigRuleName ResourceId ResourceType
-------------- ---------- ------------
access-keys-rotated BCAB1CDJ2LITAPVEW3JAH AWS::IAM::User
access-keys-rotated BCAB1CDJ2LITL3EHREM4Q AWS::IAM::User
```
+ Pour plus de détails sur l'API, reportez-vous [GetComplianceDetailsByConfigRule](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `GetComplianceDetailsByResource` avec une CLI
Les exemples de code suivants illustrent comment utiliser `GetComplianceDetailsByResource`.
------
#### [ CLI ]
**AWS CLI**
**Pour obtenir les résultats de l'évaluation d'une AWS ressource**
La commande suivante renvoie les résultats d’évaluation pour chaque règle à laquelle l’instance EC2 `i-1a2b3c4d` n’est pas conforme :
```
aws configservice get-compliance-details-by-resource --resource-type AWS::EC2::Instance --resource-id i-1a2b3c4d --compliance-types NON_COMPLIANT
```
Sortie :
```
{
"EvaluationResults": [
{
"EvaluationResultIdentifier": {
"OrderingTimestamp": 1450314635.065,
"EvaluationResultQualifier": {
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-1a2b3c4d",
"ConfigRuleName": "InstanceTypesAreT2micro"
}
},
"ResultRecordedTime": 1450314643.288,
"ConfigRuleInvokedTime": 1450314643.034,
"ComplianceType": "NON_COMPLIANT"
},
{
"EvaluationResultIdentifier": {
"OrderingTimestamp": 1450314635.065,
"EvaluationResultQualifier": {
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-1a2b3c4d",
"ConfigRuleName": "RequiredTagForEC2Instances"
}
},
"ResultRecordedTime": 1450314645.261,
"ConfigRuleInvokedTime": 1450314642.948,
"ComplianceType": "NON_COMPLIANT"
}
]
}
```
+ Pour plus de détails sur l'API, reportez-vous [GetComplianceDetailsByResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-compliance-details-by-resource.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cet exemple d’évaluation donne des résultats pour la ressource donnée.**
```
Get-CFGComplianceDetailsByResource -ResourceId ABCD5STJ4EFGHIVEW6JAH -ResourceType 'AWS::IAM::User'
```
**Sortie** :
```
Annotation :
ComplianceType : COMPLIANT
ConfigRuleInvokedTime : 8/25/2019 11:34:56 PM
EvaluationResultIdentifier : Amazon.ConfigService.Model.EvaluationResultIdentifier
ResultRecordedTime : 8/25/2019 11:34:56 PM
ResultToken :
```
+ Pour plus de détails sur l'API, reportez-vous [GetComplianceDetailsByResource](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cet exemple d’évaluation donne des résultats pour la ressource donnée.**
```
Get-CFGComplianceDetailsByResource -ResourceId ABCD5STJ4EFGHIVEW6JAH -ResourceType 'AWS::IAM::User'
```
**Sortie** :
```
Annotation :
ComplianceType : COMPLIANT
ConfigRuleInvokedTime : 8/25/2019 11:34:56 PM
EvaluationResultIdentifier : Amazon.ConfigService.Model.EvaluationResultIdentifier
ResultRecordedTime : 8/25/2019 11:34:56 PM
ResultToken :
```
+ Pour plus de détails sur l'API, reportez-vous [GetComplianceDetailsByResource](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `GetComplianceSummaryByConfigRule` avec une CLI
Les exemples de code suivants illustrent comment utiliser `GetComplianceSummaryByConfigRule`.
------
#### [ CLI ]
**AWS CLI**
**Pour obtenir le résumé de conformité de vos règles de AWS Config**
La commande suivante renvoie le nombre de règles conformes et non conformes :
```
aws configservice get-compliance-summary-by-config-rule
```
Dans la sortie, la valeur de chaque attribut `CappedCount` indique le nombre de règles conformes ou non conformes.
Sortie :
```
{
"ComplianceSummary": {
"NonCompliantResourceCount": {
"CappedCount": 3,
"CapExceeded": false
},
"ComplianceSummaryTimestamp": 1452204131.493,
"CompliantResourceCount": {
"CappedCount": 2,
"CapExceeded": false
}
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [GetComplianceSummaryByConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-compliance-summary-by-config-rule.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cet exemple renvoie le nombre de règles Config non conformes.**
```
Get-CFGComplianceSummaryByConfigRule -Select ComplianceSummary.NonCompliantResourceCount
```
**Sortie** :
```
CapExceeded CappedCount
----------- -----------
False 9
```
+ Pour plus de détails sur l'API, reportez-vous [GetComplianceSummaryByConfigRule](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cet exemple renvoie le nombre de règles Config non conformes.**
```
Get-CFGComplianceSummaryByConfigRule -Select ComplianceSummary.NonCompliantResourceCount
```
**Sortie** :
```
CapExceeded CappedCount
----------- -----------
False 9
```
+ Pour plus de détails sur l'API, reportez-vous [GetComplianceSummaryByConfigRule](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `GetComplianceSummaryByResourceType` avec une CLI
Les exemples de code suivants illustrent comment utiliser `GetComplianceSummaryByResourceType`.
------
#### [ CLI ]
**AWS CLI**
**Pour obtenir le récapitulatif de la conformité de tous les types de ressources**
La commande suivante renvoie le nombre de AWS ressources non conformes et le nombre de ressources conformes :
```
aws configservice get-compliance-summary-by-resource-type
```
Dans la sortie, la valeur de chaque attribut `CappedCount` indique le nombre de ressources conformes ou non conformes.
Sortie :
```
{
"ComplianceSummariesByResourceType": [
{
"ComplianceSummary": {
"NonCompliantResourceCount": {
"CappedCount": 16,
"CapExceeded": false
},
"ComplianceSummaryTimestamp": 1453237464.543,
"CompliantResourceCount": {
"CappedCount": 10,
"CapExceeded": false
}
}
}
]
}
```
**Pour obtenir le récapitulatif de la conformité d’un type de ressource spécifique**
La commande suivante renvoie le nombre d’instances EC2 conformes et non conformes :
```
aws configservice get-compliance-summary-by-resource-type --resource-types AWS::EC2::Instance
```
Dans la sortie, la valeur de chaque attribut `CappedCount` indique le nombre de ressources conformes ou non conformes.
Sortie :
```
{
"ComplianceSummariesByResourceType": [
{
"ResourceType": "AWS::EC2::Instance",
"ComplianceSummary": {
"NonCompliantResourceCount": {
"CappedCount": 3,
"CapExceeded": false
},
"ComplianceSummaryTimestamp": 1452204923.518,
"CompliantResourceCount": {
"CappedCount": 7,
"CapExceeded": false
}
}
}
]
}
```
+ Pour plus de détails sur l'API, reportez-vous [GetComplianceSummaryByResourceType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-compliance-summary-by-resource-type.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cet exemple renvoie le nombre de ressources conformes ou non conformes et convertit la sortie en json.**
```
Get-CFGComplianceSummaryByResourceType -Select ComplianceSummariesByResourceType.ComplianceSummary | ConvertTo-Json
{
"ComplianceSummaryTimestamp": "2019-12-14T06:14:49.778Z",
"CompliantResourceCount": {
"CapExceeded": false,
"CappedCount": 2
},
"NonCompliantResourceCount": {
"CapExceeded": true,
"CappedCount": 100
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [GetComplianceSummaryByResourceType](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cet exemple renvoie le nombre de ressources conformes ou non conformes et convertit la sortie en json.**
```
Get-CFGComplianceSummaryByResourceType -Select ComplianceSummariesByResourceType.ComplianceSummary | ConvertTo-Json
{
"ComplianceSummaryTimestamp": "2019-12-14T06:14:49.778Z",
"CompliantResourceCount": {
"CapExceeded": false,
"CappedCount": 2
},
"NonCompliantResourceCount": {
"CapExceeded": true,
"CappedCount": 100
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [GetComplianceSummaryByResourceType](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation `PutConfigRule` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `PutConfigRule`.
------
#### [ CLI ]
**AWS CLI**
**Pour ajouter une règle Config AWS gérée**
La commande suivante fournit du code JSON pour ajouter une règle de configuration AWS gérée :
```
aws configservice put-config-rule --config-rule file://RequiredTagsForEC2Instances.json
```
`RequiredTagsForEC2Instances.json` est un fichier JSON qui contient la configuration de la règle :
```
{
"ConfigRuleName": "RequiredTagsForEC2Instances",
"Description": "Checks whether the CostCenter and Owner tags are applied to EC2 instances.",
"Scope": {
"ComplianceResourceTypes": [
"AWS::EC2::Instance"
]
},
"Source": {
"Owner": "AWS",
"SourceIdentifier": "REQUIRED_TAGS"
},
"InputParameters": "{\"tag1Key\":\"CostCenter\",\"tag2Key\":\"Owner\"}"
}
```
Pour l'`ComplianceResourceTypes`attribut, ce code JSON limite la portée aux ressources de ce `AWS::EC2::Instance` type, de sorte que AWS Config évaluera uniquement les instances EC2 par rapport à la règle. Puisque la règle est une règle gérée, l’attribut `Owner` est défini sur `AWS` et l’attribut `SourceIdentifier` est défini sur l’identifiant de règle, `REQUIRED_TAGS`. Pour l’attribut `InputParameters`, les clés de balise requises par la règle, `CostCenter` et `Owner`, sont spécifiées.
Si la commande aboutit, AWS Config ne renvoie aucune sortie. Pour vérifier la configuration des règles, exécutez la describe-config-rules commande et spécifiez le nom de la règle.
**Pour ajouter une règle Config gérée par le client**
La commande suivante fournit du code JSON pour ajouter une règle Config gérée par le client :
```
aws configservice put-config-rule --config-rule file://InstanceTypesAreT2micro.json
```
`InstanceTypesAreT2micro.json` est un fichier JSON qui contient la configuration de la règle :
```
{
"ConfigRuleName": "InstanceTypesAreT2micro",
"Description": "Evaluates whether EC2 instances are the t2.micro type.",
"Scope": {
"ComplianceResourceTypes": [
"AWS::EC2::Instance"
]
},
"Source": {
"Owner": "CUSTOM_LAMBDA",
"SourceIdentifier": "arn:aws:lambda:us-east-1:123456789012:function:InstanceTypeCheck",
"SourceDetails": [
{
"EventSource": "aws.config",
"MessageType": "ConfigurationItemChangeNotification"
}
]
},
"InputParameters": "{\"desiredInstanceType\":\"t2.micro\"}"
}
```
Pour l'`ComplianceResourceTypes`attribut, ce code JSON limite la portée aux ressources de ce `AWS::EC2::Instance` type, de sorte que AWS Config évaluera uniquement les instances EC2 par rapport à la règle. Cette règle étant une règle gérée par le client, l'`Owner`attribut est défini sur`CUSTOM_LAMBDA`, et l'`SourceIdentifier`attribut est défini sur l'ARN de la fonction AWS Lambda. L’objet `SourceDetails` est obligatoire. Les paramètres spécifiés pour l'`InputParameters`attribut sont transmis à la fonction AWS Lambda lorsque AWS Config l'invoque pour évaluer les ressources par rapport à la règle.
Si la commande aboutit, AWS Config ne renvoie aucune sortie. Pour vérifier la configuration des règles, exécutez la describe-config-rules commande et spécifiez le nom de la règle.
+ Pour plus de détails sur l'API, reportez-vous [PutConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/put-config-rule.html)à la section *Référence des AWS CLI commandes*.
------
#### [ Python ]
**Kit SDK for Python (Boto3)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/config#code-examples).
```
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 put_config_rule(self, rule_name):
"""
Sets a configuration rule that prohibits making Amazon S3 buckets publicly
readable.
:param rule_name: The name to give the rule.
"""
try:
self.config_client.put_config_rule(
ConfigRule={
"ConfigRuleName": rule_name,
"Description": "S3 Public Read Prohibited Bucket Rule",
"Scope": {
"ComplianceResourceTypes": [
"AWS::S3::Bucket",
],
},
"Source": {
"Owner": "AWS",
"SourceIdentifier": "S3_BUCKET_PUBLIC_READ_PROHIBITED",
},
"InputParameters": "{}",
"ConfigRuleState": "ACTIVE",
}
)
logger.info("Created configuration rule %s.", rule_name)
except ClientError:
logger.exception("Couldn't create configuration rule %s.", rule_name)
raise
```
+ Pour plus de détails sur l'API, consultez [PutConfigRule](https://docs.aws.amazon.com/goto/boto3/config-2014-11-12/PutConfigRule)le *AWS manuel de référence de l'API SDK for Python (Boto3*).
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cfs#code-examples).
```
" Create a config rule for S3 bucket public read prohibition
lo_cfs->putconfigrule(
io_configrule = NEW /aws1/cl_cfsconfigrule(
iv_configrulename = iv_rule_name
iv_description = |S3 Public Read Prohibited Bucket Rule|
io_scope = NEW /aws1/cl_cfsscope(
it_complianceresourcetypes = VALUE /aws1/cl_cfscplncresrctypes_w=>tt_complianceresourcetypes(
( NEW /aws1/cl_cfscplncresrctypes_w( |AWS::S3::Bucket| ) )
)
)
io_source = NEW /aws1/cl_cfssource(
iv_owner = |AWS|
iv_sourceidentifier = |S3_BUCKET_PUBLIC_READ_PROHIBITED|
)
iv_inputparameters = '{}'
iv_configrulestate = |ACTIVE|
)
).
MESSAGE 'Created AWS Config rule.' TYPE 'I'.
```
+ Pour plus de détails sur l'API, reportez-vous [PutConfigRule](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)à la section de référence du *AWS SDK pour l'API SAP ABAP*.
------
# Utilisation de `PutDeliveryChannel` avec une CLI
Les exemples de code suivants illustrent comment utiliser `PutDeliveryChannel`.
------
#### [ CLI ]
**AWS CLI**
**Pour créer un canal de livraison**
La commande suivante fournit les paramètres du canal de livraison sous forme de code JSON :
```
aws configservice put-delivery-channel --delivery-channel file://deliveryChannel.json
```
Le fichier `deliveryChannel.json` spécifie les attributs du canal de livraison :
```
{
"name": "default",
"s3BucketName": "config-bucket-123456789012",
"snsTopicARN": "arn:aws:sns:us-east-1:123456789012:config-topic",
"configSnapshotDeliveryProperties": {
"deliveryFrequency": "Twelve_Hours"
}
}
```
Cet exemple définit les attributs suivants :
`name` : nom du canal de livraison. Par défaut, AWS Config attribue le nom `default` à un nouveau canal de distribution. Vous ne pouvez pas mettre à jour le nom du canal de distribution avec la commande. `put-delivery-channel` Pour connaître les étapes à suivre pour modifier le nom, consultez Renommer les canaux de livraison. `s3BucketName` - Le nom du compartiment Amazon S3 auquel AWS Config fournit des instantanés de configuration et des fichiers d'historique de configuration. Si vous spécifiez un compartiment appartenant à un autre AWS compte, ce compartiment doit disposer de politiques accordant des autorisations d'accès à Config. AWS Pour de plus d’informations, consultez Autorisations pour le compartiment Amazon S3.
`snsTopicARN`- Le nom de ressource Amazon (ARN) de la rubrique Amazon SNS à laquelle AWS Config envoie des notifications concernant les modifications de configuration. Si vous choisissez un sujet depuis un autre compte, le sujet doit comporter des politiques accordant des autorisations d'accès à Config. AWS Pour plus d’informations, consultez Autorisations relatives à la rubrique Amazon SNS.
`configSnapshotDeliveryProperties`- Contient l'`deliveryFrequency`attribut, qui définit la fréquence à laquelle AWS Config fournit des instantanés de configuration et la fréquence à laquelle il invoque des évaluations pour les règles de configuration périodiques.
Si la commande aboutit, AWS Config ne renvoie aucune sortie. Pour vérifier les paramètres de votre canal de diffusion, exécutez la describe-delivery-channels commande.
+ Pour plus de détails sur l'API, reportez-vous [PutDeliveryChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/put-delivery-channel.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cet exemple modifie la propriété deliveryFrequency d’un canal de livraison existant.**
```
Write-CFGDeliveryChannel -ConfigSnapshotDeliveryProperties_DeliveryFrequency TwentyFour_Hours -DeliveryChannelName default -DeliveryChannel_S3BucketName amzn-s3-demo-bucket -DeliveryChannel_S3KeyPrefix my
```
+ Pour plus de détails sur l'API, reportez-vous [PutDeliveryChannel](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cet exemple modifie la propriété deliveryFrequency d’un canal de livraison existant.**
```
Write-CFGDeliveryChannel -ConfigSnapshotDeliveryProperties_DeliveryFrequency TwentyFour_Hours -DeliveryChannelName default -DeliveryChannel_S3BucketName amzn-s3-demo-bucket -DeliveryChannel_S3KeyPrefix my
```
+ Pour plus de détails sur l'API, reportez-vous [PutDeliveryChannel](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------