log_delivery_configurations

Creates, updates, deletes or gets a log_delivery_configuration resource or lists log_delivery_configurations in a region

Overview

Name	log_delivery_configurations
Type	Resource
Description	Resource Type definition for AWS::Cognito::LogDeliveryConfiguration
Id	awscc.cognito.log_delivery_configurations

Fields

Name	Datatype	Description
id	string
user_pool_id	string
▶log_configurations	array
region	string	AWS region.

For more information, see AWS::Cognito::LogDeliveryConfiguration.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	UserPoolId, region
delete_resource	DELETE	Identifier, region
update_resource	UPDATE	Identifier, PatchDocument, region
get_resource	SELECT	Identifier, region

SELECT examples

Gets all properties from an individual log_delivery_configuration.

SELECT
  region,
  id,
  user_pool_id,
  log_configurations
FROM awscc.cognito.log_delivery_configurations
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ id }}';

INSERT example

Use the following StackQL query and manifest file to create a new log_delivery_configuration resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.cognito.log_delivery_configurations (
  UserPoolId,
  region
)
SELECT
  '{{ user_pool_id }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.cognito.log_delivery_configurations (
  UserPoolId,
  LogConfigurations,
  region
)
SELECT
  '{{ user_pool_id }}',
  '{{ log_configurations }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: log_delivery_configuration
    props:
      - name: user_pool_id
        value: '{{ user_pool_id }}'
      - name: log_configurations
        value:
          - log_level: '{{ log_level }}'
            event_source: '{{ event_source }}'
            cloud_watch_logs_configuration:
              log_group_arn: '{{ log_group_arn }}'
            s3_configuration:
              bucket_arn: '{{ bucket_arn }}'
            firehose_configuration:
              stream_arn: '{{ stream_arn }}'

UPDATE example

Use the following StackQL query and manifest file to update a log_delivery_configuration resource, using stack-deploy.

/*+ update */
UPDATE awscc.cognito.log_delivery_configurations
SET PatchDocument = string('{{ {
    "LogConfigurations": log_configurations
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.cognito.log_delivery_configurations
WHERE
  Identifier = '{{ id }}' AND
  region = 'us-east-1';

Permissions

To operate on the log_delivery_configurations resource, the following permissions are required:

Create

cognito-idp:GetLogDeliveryConfiguration,
cognito-idp:SetLogDeliveryConfiguration,
logs:CreateLogDelivery,
logs:GetLogDelivery,
logs:UpdateLogDelivery,
logs:DeleteLogDelivery,
logs:ListLogDeliveries,
logs:PutResourcePolicy,
logs:DescribeResourcePolicies,
logs:DescribeLogGroups,
s3:GetBucketPolicy,
s3:PutBucketPolicy,
s3:ListBucket,
s3:PutObject,
s3:GetBucketAcl,
firehose:TagDeliveryStream,
iam:CreateServiceLinkedRole

Read

cognito-idp:GetLogDeliveryConfiguration

Update

cognito-idp:GetLogDeliveryConfiguration,
cognito-idp:SetLogDeliveryConfiguration,
logs:CreateLogDelivery,
logs:GetLogDelivery,
logs:UpdateLogDelivery,
logs:DeleteLogDelivery,
logs:ListLogDeliveries,
logs:PutResourcePolicy,
logs:DescribeResourcePolicies,
logs:DescribeLogGroups,
s3:GetBucketPolicy,
s3:PutBucketPolicy,
s3:ListBucket,
s3:PutObject,
s3:GetBucketAcl,
firehose:TagDeliveryStream,
iam:CreateServiceLinkedRole

Delete

cognito-idp:GetLogDeliveryConfiguration,
cognito-idp:SetLogDeliveryConfiguration,
logs:CreateLogDelivery,
logs:GetLogDelivery,
logs:UpdateLogDelivery,
logs:DeleteLogDelivery,
logs:ListLogDeliveries,
logs:PutResourcePolicy,
logs:DescribeResourcePolicies,
logs:DescribeLogGroups,
s3:GetBucketPolicy,
s3:PutBucketPolicy,
s3:ListBucket,
s3:PutObject,
s3:GetBucketAcl,
firehose:TagDeliveryStream,
iam:CreateServiceLinkedRole