class CfnUserPoolGroupPropsMixin

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

Implements IMixin

Extends Mixin

A user pool group.

Contains details about the group and the way that it contributes to IAM role decisions with identity pools. Identity pools can make decisions about the IAM role to assign based on groups: users get credentials for the role associated with their highest-priority group.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.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';
const cfnUserPoolGroupPropsMixin = new cognito_mixins.CfnUserPoolGroupPropsMixin({
  description: 'description',
  groupName: 'groupName',
  precedence: 123,
  roleArn: 'roleArn',
  userPoolId: 'userPoolId',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnUserPoolGroupPropsMixin(props: CfnUserPoolGroupMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

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

Properties

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

---

props

Type: CfnUserPoolGroupMixinProps

---

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.