Package software.amazon.awscdk.services.iam

Class CfnUserToGroupAddition

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iam.CfnUserToGroupAddition
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.296Z") @Stability(Stable) public class CfnUserToGroupAddition extends CfnResource implements IInspectable
A CloudFormation AWS::IAM::UserToGroupAddition.

Adds the specified user to the specified group.

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.iam.*;
 CfnUserToGroupAddition cfnUserToGroupAddition = CfnUserToGroupAddition.Builder.create(this, "MyCfnUserToGroupAddition")
         .groupName("groupName")
         .users(List.of("users"))
         .build();

  • 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

    • CfnUserToGroupAddition

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

    • CfnUserToGroupAddition

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

    • CfnUserToGroupAddition

      @Stability(Stable) public CfnUserToGroupAddition(@NotNull Construct scope, @NotNull String id, @NotNull CfnUserToGroupAdditionProps props)
      Create a new AWS::IAM::UserToGroupAddition.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getGroupName

      @Stability(Stable) @NotNull public String getGroupName()
      The name of the group to update.

      This parameter allows (through its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

    • setGroupName

      @Stability(Stable) public void setGroupName(@NotNull String value)
      The name of the group to update.

      This parameter allows (through its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

    • getUsers

      @Stability(Stable) @NotNull public List<String> getUsers()
      A list of the names of the users that you want to add to the group.

    • setUsers

      @Stability(Stable) public void setUsers(@NotNull List<String> value)
      A list of the names of the users that you want to add to the group.