managed_login_brandings

Creates, updates, deletes or gets a managed_login_branding resource or lists managed_login_brandings in a region

Overview

Name	managed_login_brandings
Type	Resource
Description	Resource Type definition for AWS::Cognito::ManagedLoginBranding
Id	aws.cognito.managed_login_brandings

Fields

Name	Datatype	Description
user_pool_id	string
client_id	string
use_cognito_provided_values	boolean
settings	object
assets	array
managed_login_branding_id	string
return_merged_resources	boolean
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	UserPoolId, 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 managed_login_branding.

SELECT
region,
user_pool_id,
client_id,
use_cognito_provided_values,
settings,
assets,
managed_login_branding_id,
return_merged_resources
FROM aws.cognito.managed_login_brandings
WHERE region = 'us-east-1' AND data__Identifier = '<UserPoolId>|<ManagedLoginBrandingId>';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO aws.cognito.managed_login_brandings (
 UserPoolId,
 ClientId,
 UseCognitoProvidedValues,
 Settings,
 Assets,
 ReturnMergedResources,
 region
)
SELECT 
 '{{ UserPoolId }}',
 '{{ ClientId }}',
 '{{ UseCognitoProvidedValues }}',
 '{{ Settings }}',
 '{{ Assets }}',
 '{{ ReturnMergedResources }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: managed_login_branding
    props:
      - name: UserPoolId
        value: '{{ UserPoolId }}'
      - name: ClientId
        value: '{{ ClientId }}'
      - name: UseCognitoProvidedValues
        value: '{{ UseCognitoProvidedValues }}'
      - name: Settings
        value: {}
      - name: Assets
        value:
          - Category: '{{ Category }}'
            ColorMode: '{{ ColorMode }}'
            Extension: '{{ Extension }}'
            Bytes: '{{ Bytes }}'
            ResourceId: '{{ ResourceId }}'
      - name: ReturnMergedResources
        value: '{{ ReturnMergedResources }}'

DELETE example

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

Permissions

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

Create

cognito-idp:CreateManagedLoginBranding

Read

cognito-idp:DescribeManagedLoginBranding

Update

cognito-idp:UpdateManagedLoginBranding

Delete

cognito-idp:DeleteManagedLoginBranding