Package software.amazon.awscdk.services.iam

Class CfnGroup.Builder

java.lang.Object
software.amazon.awscdk.services.iam.CfnGroup.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnGroup>
Enclosing class:
CfnGroup
@Stability(Stable) public static final class CfnGroup.Builder extends Object implements software.amazon.jsii.Builder<CfnGroup>
A fluent builder for CfnGroup.

  • Method Details

    • create

      @Stability(Stable) public static CfnGroup.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnGroup.Builder.

    • groupName

      @Stability(Stable) public CfnGroup.Builder groupName(String groupName)
      The name of the group to create. Do not include the path in this value.

      The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both "ADMINS" and "admins". If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the group name.

      If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

      If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates .

      Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]} .

      Parameters:
      groupName - The name of the group to create. Do not include the path in this value. This parameter is required.
      Returns:
      this

    • managedPolicyArns

      @Stability(Stable) public CfnGroup.Builder managedPolicyArns(List<String> managedPolicyArns)
      The Amazon Resource Name (ARN) of the IAM policy you want to attach.

      For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .

      Parameters:
      managedPolicyArns - The Amazon Resource Name (ARN) of the IAM policy you want to attach. This parameter is required.
      Returns:
      this

    • path

      @Stability(Stable) public CfnGroup.Builder path(String path)
      The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide .

      This parameter is optional. If it is not included, it defaults to a slash (/).

      This parameter allows (through its regex pattern ) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! ( \ u0021 ) through the DEL character ( \ u007F ), including most punctuation characters, digits, and upper and lowercased letters.

      Parameters:
      path - The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide . This parameter is required.
      Returns:
      this

    • policies

      @Stability(Stable) public CfnGroup.Builder policies(IResolvable policies)
      Adds or updates an inline policy document that is embedded in the specified IAM group.

      To view AWS::IAM::Group snippets, see Declaring an IAM Group Resource .

      The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail.

      For information about limits on the number of inline policies that you can embed in a group, see Limitations on IAM Entities in the IAM User Guide .

      Parameters:
      policies - Adds or updates an inline policy document that is embedded in the specified IAM group. This parameter is required.
      Returns:
      this

    • policies

      @Stability(Stable) public CfnGroup.Builder policies(List<? extends Object> policies)
      Adds or updates an inline policy document that is embedded in the specified IAM group.

      To view AWS::IAM::Group snippets, see Declaring an IAM Group Resource .

      The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail.

      For information about limits on the number of inline policies that you can embed in a group, see Limitations on IAM Entities in the IAM User Guide .

      Parameters:
      policies - Adds or updates an inline policy document that is embedded in the specified IAM group. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnGroup build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnGroup>
      Returns:
      a newly built instance of CfnGroup.