Interface CfnGroupProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnGroupProps.Jsii$Proxy
CfnGroup
.
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.*; Object policyDocument; CfnGroupProps cfnGroupProps = CfnGroupProps.builder() .groupName("groupName") .managedPolicyArns(List.of("managedPolicyArns")) .path("path") .policies(List.of(PolicyProperty.builder() .policyDocument(policyDocument) .policyName("policyName") .build())) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnGroupProps
static final class
An implementation forCfnGroupProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnGroupProps.Builder
builder()
default String
The name of the group to create.The Amazon Resource Name (ARN) of the IAM policy you want to attach.default String
getPath()
The path to the group.default Object
Adds or updates an inline policy document that is embedded in the specified IAM group.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getGroupName
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
andAWS::Region
to create a Region-specific name, as in the following example:{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}
.- See Also:
-
getManagedPolicyArns
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 .
- See Also:
-
getPath
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 ! (
!
) through the DEL character (
), including most punctuation characters, digits, and upper and lowercased letters.- See Also:
-
getPolicies
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 .
- See Also:
-
builder
- Returns:
- a
CfnGroupProps.Builder
ofCfnGroupProps
-