Class: AWSCDK::IAM::CfnGroupPolicyProps

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

Overview

Properties for defining a CfnGroupPolicy.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(group_name:, policy_name:, policy_document: nil) ⇒ CfnGroupPolicyProps

Returns a new instance of CfnGroupPolicyProps.

Parameters:

  • group_name (String) —

    The name of the group to associate the policy with.

  • policy_name (String) —

    The name of the policy document.

  • policy_document (Object, nil) (defaults to: nil) —

    The policy document.



12
13
14
15
16
17
18
19
 
# File 'iam/cfn_group_policy_props.rb', line 12

def initialize(group_name:, policy_name:, policy_document: nil)
  @group_name = group_name
  Jsii::Type.check_type(@group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "groupName")
  @policy_name = policy_name
  Jsii::Type.check_type(@policy_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "policyName")
  @policy_document = policy_document
  Jsii::Type.check_type(@policy_document, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "policyDocument") unless @policy_document.nil?
end

Instance Attribute Details

#group_name ⇒ String (readonly)

The name of the group to associate the policy with.

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: _+=,.@-.

Returns:

  • (String)

See Also:



27
28
29
 
# File 'iam/cfn_group_policy_props.rb', line 27

def group_name
  @group_name
end

#policy_document ⇒ Object? (readonly)

The policy document.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character ( \u0020 ) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF )
  • The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage return ( \u000D )

Returns:

  • (Object, nil)

See Also:



47
48
49
 
# File 'iam/cfn_group_policy_props.rb', line 47

def policy_document
  @policy_document
end

#policy_name ⇒ String (readonly)

The name of the policy document.

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: _+=,.@-

Returns:

  • (String)

See Also:



34
35
36
 
# File 'iam/cfn_group_policy_props.rb', line 34

def policy_name
  @policy_name
end

Class Method Details

.jsii_properties ⇒ Object 



49
50
51
52
53
54
55
 
# File 'iam/cfn_group_policy_props.rb', line 49

def self.jsii_properties
  {
    :group_name => "groupName",
    :policy_name => "policyName",
    :policy_document => "policyDocument",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



57
58
59
60
61
62
63
64
65
 
# File 'iam/cfn_group_policy_props.rb', line 57

def to_jsii
  result = {}
  result.merge!({
    "groupName" => @group_name,
    "policyName" => @policy_name,
    "policyDocument" => @policy_document,
  })
  result.compact
end