class CfnManagedLoginBrandingPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Cognito.Mixins.CfnManagedLoginBrandingPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscognito/mixins#CfnManagedLoginBrandingPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.cognito.mixins.CfnManagedLoginBrandingPropsMixin
Python	aws_cdk.mixins_preview.aws_cognito.mixins.CfnManagedLoginBrandingPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_cognito » mixins » CfnManagedLoginBrandingPropsMixin

Implements IMixin

Extends Mixin

Creates a new set of branding settings for a user pool style and associates it with an app client.

This operation is the programmatic option for the creation of a new style in the branding designer.

Provides values for UI customization in a Settings JSON object and image files in an Assets array. To send the JSON object Document type parameter in Settings , you might need to update to the most recent version of your AWS SDK.

This operation has a 2-megabyte request-size limit and include the CSS settings and image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito doesn't require that you pass all parameters in one request and preserves existing style settings that you don't specify. If your request is larger than 2MB, separate it into multiple requests, each with a size smaller than the limit.

As a best practice, modify the output of DescribeManagedLoginBrandingByClient into the request parameters for this operation. To get all settings, set ReturnMergedResources to true . For more information, see API and SDK operations for managed login branding

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as cognito_mixins } from '@aws-cdk/mixins-preview/aws-cognito';

declare const settings: any;
const cfnManagedLoginBrandingPropsMixin = new cognito_mixins.CfnManagedLoginBrandingPropsMixin({
  assets: [{
    bytes: 'bytes',
    category: 'category',
    colorMode: 'colorMode',
    extension: 'extension',
    resourceId: 'resourceId',
  }],
  clientId: 'clientId',
  returnMergedResources: false,
  settings: settings,
  useCognitoProvidedValues: false,
  userPoolId: 'userPoolId',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnManagedLoginBrandingPropsMixin(props: CfnManagedLoginBrandingMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnManagedLoginBrandingMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::Cognito::ManagedLoginBranding.

Properties

Name	Type	Description
props	CfnManagedLoginBrandingMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnManagedLoginBrandingMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.