Class: AWSCDK::IAM::PrincipalBase

Inherits:
Jsii::Object
  • Object
show all
Includes:
IAssumeRolePrincipal, IComparablePrincipal
Defined in:
iam/principal_base.rb

Overview

Base class for policy principals.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ PrincipalBase

Returns a new instance of PrincipalBase.



10
11
12
 
# File 'iam/principal_base.rb', line 10

def initialize
  Jsii::Object.instance_method(:initialize).bind(self).call
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'iam/principal_base.rb', line 14

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 },
    :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 },
  }
end

Instance Method Details

#add_to_assume_role_policy(document) ⇒ 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:



71
72
73
74
 
# File 'iam/principal_base.rb', line 71

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

#add_to_policy(statement) ⇒ Boolean

Add to the policy of this principal.

Parameters:

Returns:

  • (Boolean) 


80
81
82
83
 
# File 'iam/principal_base.rb', line 80

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:



89
90
91
92
 
# File 'iam/principal_base.rb', line 89

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) 


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

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) 


97
98
99
 
# File 'iam/principal_base.rb', line 97

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

#grant_principal ⇒ AWSCDK::IAM::IPrincipal

The principal to grant permissions to.

Returns:



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

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:



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

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) 


60
61
62
 
# File 'iam/principal_base.rb', line 60

def ()
  jsii_get_property("principalAccount")
end

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

JSON-ify the principal.

Used when JSON.stringify() is called

Returns:

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


106
107
108
 
# File 'iam/principal_base.rb', line 106

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

#to_string ⇒ String

Returns a string representation of an object.

Returns:

  • (String) 


113
114
115
 
# File 'iam/principal_base.rb', line 113

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:

  • (AWSCDK::IAM::PrincipalBase) —

    a new PrincipalWithConditions object.



124
125
126
127
 
# File 'iam/principal_base.rb', line 124

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:

  • (AWSCDK::IAM::PrincipalBase) —

    a new SessionTagsPrincipal object.



132
133
134
 
# File 'iam/principal_base.rb', line 132

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