Class: AWSCDK::IAM::CfnGroupProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
iam/cfn_group_props.rb

Overview

Properties for defining a CfnGroup.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(group_name: nil, managed_policy_arns: nil, path: nil, policies: nil) ⇒ CfnGroupProps

Returns a new instance of CfnGroupProps.

Parameters:



13
14
15
16
17
18
19
20
21
22
 
# File 'iam/cfn_group_props.rb', line 13

def initialize(group_name: nil, managed_policy_arns: nil, path: nil, policies: nil)
  @group_name = group_name
  Jsii::Type.check_type(@group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "groupName") unless @group_name.nil?
  @managed_policy_arns = managed_policy_arns
  Jsii::Type.check_type(@managed_policy_arns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InVuaW9uIjp7InR5cGVzIjpbeyJwcmltaXRpdmUiOiJzdHJpbmcifSx7ImZxbiI6ImF3cy1jZGstbGliLmludGVyZmFjZXMuYXdzX2lhbS5JTWFuYWdlZFBvbGljeVJlZiJ9XX19LCJraW5kIjoiYXJyYXkifX0=")), "managedPolicyArns") unless @managed_policy_arns.nil?
  @path = path
  Jsii::Type.check_type(@path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path") unless @path.nil?
  @policies = policies
  Jsii::Type.check_type(@policies, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLkNmbkdyb3VwLlBvbGljeVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "policies") unless @policies.nil?
end

Instance Attribute Details

#group_name ⇒ String? (readonly)

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, 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 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"}]]} .

Returns:

  • (String, nil)

See Also:



36
37
38
 
# File 'iam/cfn_group_props.rb', line 36

def group_name
  @group_name
end

#managed_policy_arns ⇒ Array<String, AWSCDK::Interfaces::AWSIAM::IManagedPolicyRef>? (readonly)

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 .

Returns:

See Also:



43
44
45
 
# File 'iam/cfn_group_props.rb', line 43

def managed_policy_arns
  @managed_policy_arns
end

#path ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



52
53
54
 
# File 'iam/cfn_group_props.rb', line 52

def path
  @path
end

#policies ⇒ AWSCDK::IResolvable, ... (readonly)

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 .

Returns:

See Also:



63
64
65
 
# File 'iam/cfn_group_props.rb', line 63

def policies
  @policies
end

Class Method Details

.jsii_properties ⇒ Object 



65
66
67
68
69
70
71
72
 
# File 'iam/cfn_group_props.rb', line 65

def self.jsii_properties
  {
    :group_name => "groupName",
    :managed_policy_arns => "managedPolicyArns",
    :path => "path",
    :policies => "policies",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



74
75
76
77
78
79
80
81
82
83
 
# File 'iam/cfn_group_props.rb', line 74

def to_jsii
  result = {}
  result.merge!({
    "groupName" => @group_name,
    "managedPolicyArns" => @managed_policy_arns,
    "path" => @path,
    "policies" => @policies,
  })
  result.compact
end