delivery_channel#

State module for managing Amazon Config Delivery Channel.

async idem_aws.states.aws.config.delivery_channel.present(hub, ctx, name: str, s3_bucket_name: str, resource_id: str = None, s3_key_prefix: str = None, s3_kms_key_arn: str = None, sns_topic_arn: str = None, config_snapshot_delivery_properties: ConfigSnapshotDeliveryProperties = None) → Dict[str, Any][source]#

Add or update the configuration delivery channel object that delivers the configuration information to an Amazon S3 bucket and to an Amazon SNS topic.

Parameters:

  • name (str) – An Idem name of the delivery channel.

  • s3_bucket_name (str) – The name of the Amazon S3 bucket to which Config delivers configuration snapshots and configuration history files

  • resource_id (str, Optional) – The resource Id of the delivery channel.

  • s3_key_prefix (str, Optional) – The prefix for the specified Amazon S3 bucket.

  • s3_kms_key_arn (str, Optional) – The Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key (KMS key) used to encrypt objects delivered by Config.

  • sns_topic_arn (str, Optional) – The Amazon Resource Name (ARN) of the Amazon SNS topic to which Config sends notifications about configuration changes.

  • config_snapshot_delivery_properties (dict[str, Any], Optional) –

    The options for how often Config delivers configuration snapshots to the Amazon S3 bucket.

    • delivery_frequency (str, Optional): The frequency with which Config delivers configuration snapshots.

Request syntax:
[aws-config-delivery_channel]:
  aws.config.delivery_channel.present:
  - name: 'string'
  - resource_id: 'string'
  - s3_bucket_name: 'string'
  - s3_key_prefix: 'string'
  - s3_kms_key_arn: 'string'
  - sns_topic_arn: 'string'
  - config_snapshot_delivery_properties: dict
    delivery_frequency: 'string'
Returns:

Dict[str, Any]

Examples

aws-config-delivery_channel:
  aws.config.delivery_channel.present:
    - name: 'delivery-channel'
    - resource_id: 'delivery-channel'
    - s3_bucket_name: 'Test-S3'
    - s3_key_prefix: 'S3-prefix'
    - s3_kms_key_arn: 'Test-Kms-Key'
    - sns_topic_arn: 'Test-Topic'
    - config_snapshot_delivery_properties:
      delivery_frequency: 'One_Hour'
async idem_aws.states.aws.config.delivery_channel.absent(hub, ctx, name: str, resource_id: str = None) → Dict[str, Any][source]#

Deletes the specified delivery channel.

Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.

Parameters:

  • name (str) – An Idem name of the rule.

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

Returns:

Dict[str, Any]

Examples

ec2-instance-no-public-ip:
  aws.config.delivery_channel.absent:
  - name: ec2-instance-no-public-ip
  - resource_id: ec2-instance-no-public-ip
async idem_aws.states.aws.config.delivery_channel.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

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

Return details about your delivery channel.

Returns:

Dict[str, Any]

Examples

$ idem describe aws.config.delivery_channel