UserPoolGroup L2 construct
Define a user pool group.
Example
declare const userPool: cognito.UserPool;
declare const role: iam.Role;
new cognito.UserPoolGroup(this, 'UserPoolGroup', {
userPool,
groupName: 'my-group-name',
precedence: 1,
role, // assign IAM Role
});
// You can also add a group by using addGroup method.
userPool.addGroup('AnotherUserPoolGroup', {
groupName: 'another-group-name'
});
# user_pool: cognito.UserPool
# role: iam.Role
cognito.UserPoolGroup(self, "UserPoolGroup",
user_pool=user_pool,
group_name="my-group-name",
precedence=1,
role=role
)
# You can also add a group by using addGroup method.
user_pool.add_group("AnotherUserPoolGroup",
group_name="another-group-name"
)
UserPool userPool;
Role role;
UserPoolGroup.Builder.create(this, "UserPoolGroup")
.userPool(userPool)
.groupName("my-group-name")
.precedence(1)
.role(role)
.build();
// You can also add a group by using addGroup method.
userPool.addGroup("AnotherUserPoolGroup", UserPoolGroupOptions.builder()
.groupName("another-group-name")
.build());
// Install: dotnet add package Amazon.CDK.Lib
UserPool userPool;
Role role;
new UserPoolGroup(this, "UserPoolGroup", new UserPoolGroupProps {
UserPool = userPool,
GroupName = "my-group-name",
Precedence = 1,
Role = role
});
// You can also add a group by using addGroup method.
userPool.AddGroup("AnotherUserPoolGroup", new UserPoolGroupOptions {
GroupName = "another-group-name"
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var userPool UserPool
var role Role
cognito.NewUserPoolGroup(this, jsii.String("UserPoolGroup"), &UserPoolGroupProps{
UserPool: UserPool,
GroupName: jsii.String("my-group-name"),
Precedence: jsii.Number(1),
Role: Role,
})
// You can also add a group by using addGroup method.
userPool.addGroup(jsii.String("AnotherUserPoolGroup"), &UserPoolGroupOptions{
GroupName: jsii.String("another-group-name"),
})
Initializer
new UserPoolGroup(scope: Construct, id: string, props: UserPoolGroupProps)
UserPoolGroup(scope: Construct, id: str, props: UserPoolGroupProps)
new UserPoolGroup(Construct scope, String id, UserPoolGroupProps props)
new UserPoolGroup(Construct scope, string id, UserPoolGroupProps props)
NewUserPoolGroup(Scope Construct, Id *string, Props UserPoolGroupProps)
Construct Props
descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= no description#Must be unique.
notes
Zero is the highest precedence value.
Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.
Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.
userPoolIUserPoolRefuser_poolIUserPoolRefuserPoolIUserPoolRefUserPoolIUserPoolRefUserPoolIUserPoolRefrequired#Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#userPoolGroupRefUserPoolGroupReferenceuser_pool_group_refUserPoolGroupReferenceuserPoolGroupRefUserPoolGroupReferenceUserPoolGroupRefUserPoolGroupReferenceUserPoolGroupRefUserPoolGroupReferencerequired#Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
fromGroupName(scope: Construct, id: string, groupName: string): IUserPoolGroup@staticmethod def from_group_name(scope: Construct, id: str, group_name: str) -> IUserPoolGrouppublic static IUserPoolGroup fromGroupName(Construct scope, String id, String groupName)public static IUserPoolGroup FromGroupName(Construct scope, string id, string groupName)func FromGroupName(Scope Construct, Id *string, GroupName *string) IUserPoolGroupstatic#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.