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	awscc.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	Identifier, region
update_resource	UPDATE	Identifier, PatchDocument, region
get_resource	SELECT	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 awscc.cognito.managed_login_brandings
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ user_pool_id }}|{{ managed_login_branding_id }}';

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 awscc.cognito.managed_login_brandings (
  UserPoolId,
  region
)
SELECT
  '{{ user_pool_id }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.cognito.managed_login_brandings (
  UserPoolId,
  ClientId,
  UseCognitoProvidedValues,
  Settings,
  Assets,
  ReturnMergedResources,
  region
)
SELECT
  '{{ user_pool_id }}',
  '{{ client_id }}',
  '{{ use_cognito_provided_values }}',
  '{{ settings }}',
  '{{ assets }}',
  '{{ return_merged_resources }}',
  '{{ 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: user_pool_id
        value: '{{ user_pool_id }}'
      - name: client_id
        value: '{{ client_id }}'
      - name: use_cognito_provided_values
        value: '{{ use_cognito_provided_values }}'
      - name: settings
        value: {}
      - name: assets
        value:
          - category: '{{ category }}'
            color_mode: '{{ color_mode }}'
            extension: '{{ extension }}'
            bytes: '{{ bytes }}'
            resource_id: '{{ resource_id }}'
      - name: return_merged_resources
        value: '{{ return_merged_resources }}'

UPDATE example

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

/*+ update */
UPDATE awscc.cognito.managed_login_brandings
SET PatchDocument = string('{{ {
    "UseCognitoProvidedValues": use_cognito_provided_values,
    "Settings": settings,
    "Assets": assets,
    "ReturnMergedResources": return_merged_resources
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ user_pool_id }}|{{ managed_login_branding_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.cognito.managed_login_brandings
WHERE
  Identifier = '{{ user_pool_id }}|{{ managed_login_branding_id }}' 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