user_pool_risk_configuration_attachments

Creates, updates, deletes or gets an user_pool_risk_configuration_attachment resource or lists user_pool_risk_configuration_attachments in a region

Overview

Name	user_pool_risk_configuration_attachments
Type	Resource
Description	Resource Type definition for AWS::Cognito::UserPoolRiskConfigurationAttachment
Id	aws.cognito.user_pool_risk_configuration_attachments

Fields

Name	Datatype	Description
user_pool_id	string
client_id	string
risk_exception_configuration	object
compromised_credentials_risk_configuration	object
account_takeover_risk_configuration	object
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	UserPoolId, ClientId, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual user_pool_risk_configuration_attachment.

SELECT
region,
user_pool_id,
client_id,
risk_exception_configuration,
compromised_credentials_risk_configuration,
account_takeover_risk_configuration
FROM aws.cognito.user_pool_risk_configuration_attachments
WHERE region = 'us-east-1' AND data__Identifier = '<UserPoolId>|<ClientId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.cognito.user_pool_risk_configuration_attachments (
 UserPoolId,
 ClientId,
 region
)
SELECT 
'{{ UserPoolId }}',
 '{{ ClientId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.cognito.user_pool_risk_configuration_attachments (
 UserPoolId,
 ClientId,
 RiskExceptionConfiguration,
 CompromisedCredentialsRiskConfiguration,
 AccountTakeoverRiskConfiguration,
 region
)
SELECT 
 '{{ UserPoolId }}',
 '{{ ClientId }}',
 '{{ RiskExceptionConfiguration }}',
 '{{ CompromisedCredentialsRiskConfiguration }}',
 '{{ AccountTakeoverRiskConfiguration }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: user_pool_risk_configuration_attachment
    props:
      - name: UserPoolId
        value: '{{ UserPoolId }}'
      - name: ClientId
        value: '{{ ClientId }}'
      - name: RiskExceptionConfiguration
        value:
          BlockedIPRangeList:
            - '{{ BlockedIPRangeList[0] }}'
          SkippedIPRangeList:
            - '{{ SkippedIPRangeList[0] }}'
      - name: CompromisedCredentialsRiskConfiguration
        value:
          Actions:
            EventAction: '{{ EventAction }}'
          EventFilter:
            - '{{ EventFilter[0] }}'
      - name: AccountTakeoverRiskConfiguration
        value:
          Actions:
            HighAction:
              EventAction: '{{ EventAction }}'
              Notify: '{{ Notify }}'
            LowAction: null
            MediumAction: null
          NotifyConfiguration:
            BlockEmail:
              HtmlBody: '{{ HtmlBody }}'
              Subject: '{{ Subject }}'
              TextBody: '{{ TextBody }}'
            MfaEmail: null
            NoActionEmail: null
            From: '{{ From }}'
            ReplyTo: '{{ ReplyTo }}'
            SourceArn: '{{ SourceArn }}'

DELETE example

/*+ delete */
DELETE FROM aws.cognito.user_pool_risk_configuration_attachments
WHERE data__Identifier = '<UserPoolId|ClientId>'
AND region = 'us-east-1';

Permissions

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

Create

cognito-idp:SetRiskConfiguration,
cognito-idp:DescribeRiskConfiguration,
iam:PassRole

Read

cognito-idp:DescribeRiskConfiguration

Update

cognito-idp:SetRiskConfiguration,
cognito-idp:DescribeRiskConfiguration,
iam:PassRole

Delete

cognito-idp:SetRiskConfiguration,
cognito-idp:DescribeRiskConfiguration