Class: AWSCDK::IAM::CompositePrincipal

Inherits:
PrincipalBase
  • Object
show all
Defined in:
iam/composite_principal.rb

Overview

Represents a principal that has multiple types of principals.

A composite principal cannot have conditions. i.e. multiple ServicePrincipals that form a composite principal

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*principals) ⇒ CompositePrincipal

Returns a new instance of CompositePrincipal.

Parameters:



12
13
14
15
16
17
 
# File 'iam/composite_principal.rb', line 12

def initialize(*principals)
  principals.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklQcmluY2lwYWwifQ==")), "principals[#{index}]")
  end
  Jsii::Object.instance_method(:initialize).bind(self).call(*principals)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'iam/composite_principal.rb', line 19

def self.jsii_overridable_methods
  {
    :assume_role_action => { kind: :property, name: "assumeRoleAction", is_optional: false },
    :grant_principal => { kind: :property, name: "grantPrincipal", is_optional: false },
    :policy_fragment => { kind: :property, name: "policyFragment", is_optional: false },
    :principal_account => { kind: :property, name: "principalAccount", is_optional: true },
    :principals => { kind: :property, name: "principals", is_optional: false },
    :add_to_assume_role_policy => { kind: :method, name: "addToAssumeRolePolicy", is_optional: false },
    :add_to_policy => { kind: :method, name: "addToPolicy", is_optional: false },
    :add_to_principal_policy => { kind: :method, name: "addToPrincipalPolicy", is_optional: false },
    :dedupe_string => { kind: :method, name: "dedupeString", is_optional: false },
    :to_json => { kind: :method, name: "toJSON", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with_conditions => { kind: :method, name: "withConditions", is_optional: false },
    :with_session_tags => { kind: :method, name: "withSessionTags", is_optional: false },
    :add_principals => { kind: :method, name: "addPrincipals", is_optional: false },
  }
end

Instance Method Details

#add_principals(*principals) ⇒ AWSCDK::IAM::CompositePrincipal

Adds IAM principals to the composite principal.

Composite principals cannot have conditions.

Parameters:

Returns:

  • (AWSCDK::IAM::CompositePrincipal) 


157
158
159
160
161
162
 
# File 'iam/composite_principal.rb', line 157

def add_principals(*principals)
  principals.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklQcmluY2lwYWwifQ==")), "principals[#{index}]")
  end
  jsii_call_method("addPrincipals", [*principals])
end

#add_to_assume_role_policy(doc) ⇒ void

This method returns an undefined value.

Add the principal to the AssumeRolePolicyDocument.

Add the statements to the AssumeRolePolicyDocument necessary to give this principal permissions to assume the given role.

Parameters:



85
86
87
88
 
# File 'iam/composite_principal.rb', line 85

def add_to_assume_role_policy(doc)
  Jsii::Type.check_type(doc, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLlBvbGljeURvY3VtZW50In0=")), "doc")
  jsii_call_method("addToAssumeRolePolicy", [doc])
end

#add_to_policy(statement) ⇒ Boolean

Add to the policy of this principal.

Parameters:

Returns:

  • (Boolean) 


94
95
96
97
 
# File 'iam/composite_principal.rb', line 94

def add_to_policy(statement)
  Jsii::Type.check_type(statement, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLlBvbGljeVN0YXRlbWVudCJ9")), "statement")
  jsii_call_method("addToPolicy", [statement])
end

#add_to_principal_policy(_statement) ⇒ AWSCDK::IAM::AddToPrincipalPolicyResult

Add to the policy of this principal.

Parameters:

Returns:



103
104
105
106
 
# File 'iam/composite_principal.rb', line 103

def add_to_principal_policy(_statement)
  Jsii::Type.check_type(_statement, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLlBvbGljeVN0YXRlbWVudCJ9")), "_statement")
  jsii_call_method("addToPrincipalPolicy", [_statement])
end

#assume_role_action ⇒ String

When this Principal is used in an AssumeRole policy, the action to use.

Returns:

  • (String) 


41
42
43
 
# File 'iam/composite_principal.rb', line 41

def assume_role_action()
  jsii_get_property("assumeRoleAction")
end

#dedupe_string ⇒ String?

Return whether or not this principal is equal to the given principal.

Returns:

  • (String, nil) 


111
112
113
 
# File 'iam/composite_principal.rb', line 111

def dedupe_string()
  jsii_call_method("dedupeString", [])
end

#grant_principal ⇒ AWSCDK::IAM::IPrincipal

The principal to grant permissions to.

Returns:



48
49
50
 
# File 'iam/composite_principal.rb', line 48

def grant_principal()
  jsii_get_property("grantPrincipal")
end

#policy_fragment ⇒ AWSCDK::IAM::PrincipalPolicyFragment

Return the policy fragment that identifies this principal in a Policy.

Returns:



55
56
57
 
# File 'iam/composite_principal.rb', line 55

def policy_fragment()
  jsii_get_property("policyFragment")
end

#principal_account ⇒ String?

The AWS account ID of this principal.

Can be undefined when the account is not known (for example, for service principals). Can be a Token - in that case, it's assumed to be AWS::AccountId.

Returns:

  • (String, nil) 


67
68
69
 
# File 'iam/composite_principal.rb', line 67

def ()
  jsii_get_property("principalAccount")
end

#principals ⇒ Array<AWSCDK::IAM::IPrincipal>

Returns the principals that make up the CompositePrincipal.

Returns:



74
75
76
 
# File 'iam/composite_principal.rb', line 74

def principals()
  jsii_get_property("principals")
end

#to_json ⇒ Hash{String => Array<String>}

JSON-ify the principal.

Used when JSON.stringify() is called

Returns:

  • (Hash{String => Array<String>}) 


120
121
122
 
# File 'iam/composite_principal.rb', line 120

def to_json()
  jsii_call_method("toJSON", [])
end

#to_string ⇒ String

Returns a string representation of an object.

Returns:

  • (String) 


127
128
129
 
# File 'iam/composite_principal.rb', line 127

def to_string()
  jsii_call_method("toString", [])
end

#with_conditions(conditions) ⇒ AWSCDK::IAM::PrincipalBase

Returns a new PrincipalWithConditions using this principal as the base, with the passed conditions added.

When there is a value for the same operator and key in both the principal and the conditions parameter, the value from the conditions parameter will be used.

Parameters:

  • conditions (Hash{String => Object})

Returns:



138
139
140
141
 
# File 'iam/composite_principal.rb', line 138

def with_conditions(conditions)
  Jsii::Type.check_type(conditions, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "conditions")
  jsii_call_method("withConditions", [conditions])
end

#with_session_tags ⇒ AWSCDK::IAM::PrincipalBase

Returns a new principal using this principal as the base, with session tags enabled.

Returns:



146
147
148
 
# File 'iam/composite_principal.rb', line 146

def with_session_tags()
  jsii_call_method("withSessionTags", [])
end