config_recorder_status

State module for managing Amazon Config Recorder status.

async idem_aws.states.aws.config.config_recorder_status.present(hub, ctx, name: str, recording: bool = False, resource_id: str = None) → Dict[str, Any]

Set a new configuration recorder status to record the selected resource configurations.

Parameters:

• name (str) – The name of the recorder.

• recording (bool, Optional) – Specifies recording status of the configuration recorder. Default is False.

• resource_id (str, Optional) – The name of the recorder.

Request syntax:

[aws-config-recorder-status]:
  aws.config.config_recorder_status.present:
  - name: 'string'
  - resource_id: 'string'
  - recording: 'boolean'

Returns:

Dict[str, Any]

Examples

aws-config-recorder-status:
  aws.config.config_recorder_status.present:
    - name: 'config_recorder'
    - resource_id: 'config_recorder'
    - recording: true

async idem_aws.states.aws.config.config_recorder_status.absent(hub, ctx, name: str, resource_id: str = None) → Dict[str, Any]

Reset the configuration recorder status.

Stops recording configurations of the AWS resources you have selected to record in your AWS account.

Parameters:

• name (str) – The name of the recorder.

• resource_id (str, Optional) – AWS Config configuration recorder Name. Idem automatically considers this resource being absent if this field is not specified.

Returns:

Dict[str, Any]

Examples

aws-config-recorder-status:
  aws.config.config_recorder_status.absent:
    - name: 'config_recorder'
    - resource_id: 'config_recorder'

async idem_aws.states.aws.config.config_recorder_status.describe(hub, ctx) → Dict[str, Dict[str, Any]]

Describe the resource in a way that can be recreated/managed with the corresponding “present” function.

Return details about your config recorder status.

Returns:

Dict[str, Any]

Examples

$ idem describe aws.config.config_recorder_status