class CfnUserPoolUserToGroupAttachmentPropsMixin

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

Implements IMixin

Extends Mixin

Adds a user to a group.

A user who is in a group can present a preferred-role claim to an identity pool, and populates a cognito:groups claim to their access and identity tokens.

Amazon Cognito evaluates AWS Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more - Signing AWS API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolusertogroupattachment.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 cfnUserPoolUserToGroupAttachmentPropsMixin = new cognito_mixins.CfnUserPoolUserToGroupAttachmentPropsMixin({
  groupName: 'groupName',
  username: 'username',
  userPoolId: 'userPoolId',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnUserPoolUserToGroupAttachmentPropsMixin(props: CfnUserPoolUserToGroupAttachmentMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

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

Properties

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

---

props

Type: CfnUserPoolUserToGroupAttachmentMixinProps

---

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.