Class: AWSCDK::IAM::OrganizationPrincipal

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

Overview

A principal that represents an AWS Organization.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(organization_id) ⇒ OrganizationPrincipal

Returns a new instance of OrganizationPrincipal.

Parameters:

  • organization_id (String) —

    The unique identifier (ID) of an organization (i.e. o-12345abcde) It must match regex pattern ^o-[a-z0-9]10,32$.

See Also:



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

def initialize(organization_id)
  Jsii::Type.check_type(organization_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "organizationId")
  Jsii::Object.instance_method(:initialize).bind(self).call(organization_id)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



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

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 },
    :organization_id => { kind: :property, name: "organizationId", 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 },
  }
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:



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

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) 


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

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:



98
99
100
101
 
# File 'iam/organization_principal.rb', line 98

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) 


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

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) 


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

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

#grant_principal ⇒ AWSCDK::IAM::IPrincipal

The principal to grant permissions to.

Returns:



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

def grant_principal()
  jsii_get_property("grantPrincipal")
end

#organization_id ⇒ String

The unique identifier (ID) of an organization (i.e. o-12345abcde) It must match regex pattern ^o-[a-z0-9]10,32$.

Returns:

  • (String) 


69
70
71
 
# File 'iam/organization_principal.rb', line 69

def organization_id()
  jsii_get_property("organizationId")
end

#policy_fragment ⇒ AWSCDK::IAM::PrincipalPolicyFragment

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

Returns:



50
51
52
 
# File 'iam/organization_principal.rb', line 50

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) 


62
63
64
 
# File 'iam/organization_principal.rb', line 62

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>}) 


115
116
117
 
# File 'iam/organization_principal.rb', line 115

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

#to_string ⇒ String

Returns a string representation of an object.

Returns:

  • (String) 


122
123
124
 
# File 'iam/organization_principal.rb', line 122

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:



133
134
135
136
 
# File 'iam/organization_principal.rb', line 133

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:



141
142
143
 
# File 'iam/organization_principal.rb', line 141

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