Class CfnUserPoolUserToGroupAttachmentPropsMixin
Adds a user to a group.
Implements
Inherited Members
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Cognito
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public class CfnUserPoolUserToGroupAttachmentPropsMixin : Mixin, IMixin
Syntax (vb)
Public Class CfnUserPoolUserToGroupAttachmentPropsMixin Inherits Mixin Implements IMixin
Remarks
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
CloudformationResource: AWS::Cognito::UserPoolUserToGroupAttachment
Mixin: true
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.CfnPropertyMixins.AWS.Cognito;
using Amazon.CDK;
IMergeStrategy mergeStrategy;
var cfnUserPoolUserToGroupAttachmentPropsMixin = new CfnUserPoolUserToGroupAttachmentPropsMixin(new CfnUserPoolUserToGroupAttachmentMixinProps {
GroupName = "groupName",
Username = "username",
UserPoolId = "userPoolId"
}, new CfnPropertyMixinOptions {
Strategy = mergeStrategy
});
Synopsis
Constructors
| CfnUserPoolUserToGroupAttachmentPropsMixin(ICfnUserPoolUserToGroupAttachmentMixinProps, ICfnPropertyMixinOptions?) | Create a mixin to apply properties to |
Properties
| CFN_PROPERTY_KEYS | Adds a user to a group. |
| Props | Adds a user to a group. |
| Strategy | Adds a user to a group. |
Methods
| ApplyTo(IConstruct) | Apply the mixin properties to the construct. |
| Supports(IConstruct) | Check if this mixin supports the given construct. |
Constructors
CfnUserPoolUserToGroupAttachmentPropsMixin(ICfnUserPoolUserToGroupAttachmentMixinProps, ICfnPropertyMixinOptions?)
Create a mixin to apply properties to AWS::Cognito::UserPoolUserToGroupAttachment.
public CfnUserPoolUserToGroupAttachmentPropsMixin(ICfnUserPoolUserToGroupAttachmentMixinProps props, ICfnPropertyMixinOptions? options = null)
Parameters
- props ICfnUserPoolUserToGroupAttachmentMixinProps
L1 properties to apply.
- options ICfnPropertyMixinOptions
Mixin options.
Remarks
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
CloudformationResource: AWS::Cognito::UserPoolUserToGroupAttachment
Mixin: true
ExampleMetadata: fixture=_generated
Properties
CFN_PROPERTY_KEYS
Adds a user to a group.
protected static string[] CFN_PROPERTY_KEYS { get; }
Property Value
string[]
Remarks
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
CloudformationResource: AWS::Cognito::UserPoolUserToGroupAttachment
Mixin: true
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.CfnPropertyMixins.AWS.Cognito;
using Amazon.CDK;
IMergeStrategy mergeStrategy;
var cfnUserPoolUserToGroupAttachmentPropsMixin = new CfnUserPoolUserToGroupAttachmentPropsMixin(new CfnUserPoolUserToGroupAttachmentMixinProps {
GroupName = "groupName",
Username = "username",
UserPoolId = "userPoolId"
}, new CfnPropertyMixinOptions {
Strategy = mergeStrategy
});
Props
Adds a user to a group.
protected virtual ICfnUserPoolUserToGroupAttachmentMixinProps Props { get; }
Property Value
ICfnUserPoolUserToGroupAttachmentMixinProps
Remarks
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
CloudformationResource: AWS::Cognito::UserPoolUserToGroupAttachment
Mixin: true
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.CfnPropertyMixins.AWS.Cognito;
using Amazon.CDK;
IMergeStrategy mergeStrategy;
var cfnUserPoolUserToGroupAttachmentPropsMixin = new CfnUserPoolUserToGroupAttachmentPropsMixin(new CfnUserPoolUserToGroupAttachmentMixinProps {
GroupName = "groupName",
Username = "username",
UserPoolId = "userPoolId"
}, new CfnPropertyMixinOptions {
Strategy = mergeStrategy
});
Strategy
Adds a user to a group.
protected virtual IMergeStrategy Strategy { get; }
Property Value
Remarks
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
CloudformationResource: AWS::Cognito::UserPoolUserToGroupAttachment
Mixin: true
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.CfnPropertyMixins.AWS.Cognito;
using Amazon.CDK;
IMergeStrategy mergeStrategy;
var cfnUserPoolUserToGroupAttachmentPropsMixin = new CfnUserPoolUserToGroupAttachmentPropsMixin(new CfnUserPoolUserToGroupAttachmentMixinProps {
GroupName = "groupName",
Username = "username",
UserPoolId = "userPoolId"
}, new CfnPropertyMixinOptions {
Strategy = mergeStrategy
});
Methods
ApplyTo(IConstruct)
Apply the mixin properties to the construct.
public override void ApplyTo(IConstruct construct)
Parameters
- construct IConstruct
Overrides
Remarks
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
CloudformationResource: AWS::Cognito::UserPoolUserToGroupAttachment
Mixin: true
ExampleMetadata: fixture=_generated
Supports(IConstruct)
Check if this mixin supports the given construct.
public override bool Supports(IConstruct construct)
Parameters
- construct IConstruct
Returns
Overrides
Remarks
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
CloudformationResource: AWS::Cognito::UserPoolUserToGroupAttachment
Mixin: true
ExampleMetadata: fixture=_generated