Package software.amazon.awscdk.services.identitystore

Class CfnGroupMembership

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.identitystore.CfnGroupMembership

All Implemented Interfaces:

IInspectable, IGroupMembershipRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:41.260Z")
@Stability(Stable)
public class CfnGroupMembership
extends CfnResource
implements IInspectable, IGroupMembershipRef

Creates a relationship between a member and a group.

The following identifiers must be specified: GroupId , IdentityStoreId , and MemberId .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.identitystore.*;
 CfnGroupMembership cfnGroupMembership = CfnGroupMembership.Builder.create(this, "MyCfnGroupMembership")
         .groupId("groupId")
         .identityStoreId("identityStoreId")
         .memberId(MemberIdProperty.builder()
                 .userId("userId")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-groupmembership.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnGroupMembership.Builder	A fluent builder for CfnGroupMembership.
static interface	CfnGroupMembership.MemberIdProperty	An object that contains the identifier of a group member.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.identitystore.IGroupMembershipRef

IGroupMembershipRef.Jsii$Default, IGroupMembershipRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnGroupMembership(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnGroupMembership(software.amazon.jsii.JsiiObjectRef objRef)
	CfnGroupMembership(software.constructs.Construct scope, String id, CfnGroupMembershipProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrMembershipId()	The identifier for a GroupMembership in the identity store.
protected Map<String,Object>	getCfnProperties()
String	getGroupId()	The identifier for a group in the identity store.
GroupMembershipReference	getGroupMembershipRef()	A reference to a GroupMembership resource.
String	getIdentityStoreId()	The globally unique identifier for the identity store.
Object	getMemberId()	An object containing the identifier of a group member.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setGroupId(String value)	The identifier for a group in the identity store.
void	setIdentityStoreId(String value)	The globally unique identifier for the identity store.
void	setMemberId(IResolvable value)	An object containing the identifier of a group member.
void	setMemberId(CfnGroupMembership.MemberIdProperty value)	An object containing the identifier of a group member.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnGroupMembership

protected CfnGroupMembership(software.amazon.jsii.JsiiObjectRef objRef)

CfnGroupMembership

protected CfnGroupMembership(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnGroupMembership

@Stability(Stable)
public CfnGroupMembership(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnGroupMembershipProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrMembershipId

@Stability(Stable)
@NotNull
public String getAttrMembershipId()

The identifier for a GroupMembership in the identity store.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getGroupMembershipRef

@Stability(Stable)
@NotNull
public GroupMembershipReference getGroupMembershipRef()

A reference to a GroupMembership resource.

Specified by:

getGroupMembershipRef in interface IGroupMembershipRef

getGroupId

@Stability(Stable)
@NotNull
public String getGroupId()

The identifier for a group in the identity store.

setGroupId

@Stability(Stable)
public void setGroupId(@NotNull
 String value)

The identifier for a group in the identity store.

getIdentityStoreId

@Stability(Stable)
@NotNull
public String getIdentityStoreId()

The globally unique identifier for the identity store.

setIdentityStoreId

@Stability(Stable)
public void setIdentityStoreId(@NotNull
 String value)

The globally unique identifier for the identity store.

getMemberId

@Stability(Stable)
@NotNull
public Object getMemberId()

An object containing the identifier of a group member.

Returns union: either IResolvable or CfnGroupMembership.MemberIdProperty

setMemberId

@Stability(Stable)
public void setMemberId(@NotNull
 IResolvable value)

An object containing the identifier of a group member.

setMemberId

@Stability(Stable)
public void setMemberId(@NotNull
 CfnGroupMembership.MemberIdProperty value)

An object containing the identifier of a group member.