Class: AWSCDK::IAM::LazyRole

Inherits:
Resource
  • Object
show all
Includes:
IRole
Defined in:
iam/lazy_role.rb

Overview

An IAM role that only gets attached to the construct tree once it gets used, not before.

This construct can be used to simplify logic in other constructs which need to create a role but only if certain configurations occur (such as when AutoScaling is configured). The role can be configured in one place, but if it never gets used it doesn't get instantiated and will not be synthesized or deployed.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ LazyRole

Returns a new instance of LazyRole.

Parameters:



18
19
20
21
22
23
24
 
# File 'iam/lazy_role.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::IAM::LazyRoleProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLkxhenlSb2xlUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'iam/lazy_role.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :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 },
    :role_arn => { kind: :property, name: "roleArn", is_optional: false },
    :role_id => { kind: :property, name: "roleId", is_optional: false },
    :role_name => { kind: :property, name: "roleName", is_optional: false },
    :role_ref => { kind: :property, name: "roleRef", is_optional: false },
    :principal_account => { kind: :property, name: "principalAccount", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :add_managed_policy => { kind: :method, name: "addManagedPolicy", is_optional: false },
    :add_to_policy => { kind: :method, name: "addToPolicy", is_optional: false },
    :add_to_principal_policy => { kind: :method, name: "addToPrincipalPolicy", is_optional: false },
    :attach_inline_policy => { kind: :method, name: "attachInlinePolicy", is_optional: false },
    :grant => { kind: :method, name: "grant", is_optional: false },
    :grant_assume_role => { kind: :method, name: "grantAssumeRole", is_optional: false },
    :grant_pass_role => { kind: :method, name: "grantPassRole", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


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

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_iam.LazyRole", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#add_managed_policy(policy) ⇒ void

This method returns an undefined value.

Attaches a managed policy to this role.

Parameters:



262
263
264
265
 
# File 'iam/lazy_role.rb', line 262

def add_managed_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklNYW5hZ2VkUG9saWN5In0=")), "policy")
  jsii_call_method("addManagedPolicy", [policy])
end

#add_to_policy(statement) ⇒ Boolean

Add to the policy of this principal.

Parameters:

Returns:

  • (Boolean) 


271
272
273
274
 
# File 'iam/lazy_role.rb', line 271

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

Adds a permission to the role's default policy document.

If there is no default policy attached to this role, it will be created.

Parameters:

Returns:



282
283
284
285
 
# File 'iam/lazy_role.rb', line 282

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

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



201
202
203
204
 
# File 'iam/lazy_role.rb', line 201

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



218
219
220
221
 
# File 'iam/lazy_role.rb', line 218

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#assume_role_action ⇒ String

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

Returns:

  • (String) 


110
111
112
 
# File 'iam/lazy_role.rb', line 110

def assume_role_action()
  jsii_get_property("assumeRoleAction")
end

#attach_inline_policy(policy) ⇒ void

This method returns an undefined value.

Attaches a policy to this role.

Parameters:



291
292
293
294
 
# File 'iam/lazy_role.rb', line 291

def attach_inline_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLlBvbGljeSJ9")), "policy")
  jsii_call_method("attachInlinePolicy", [policy])
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



75
76
77
 
# File 'iam/lazy_role.rb', line 75

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


224
225
226
 
# File 'iam/lazy_role.rb', line 224

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


238
239
240
241
242
243
 
# File 'iam/lazy_role.rb', line 238

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


253
254
255
256
 
# File 'iam/lazy_role.rb', line 253

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#grant(identity, *actions) ⇒ AWSCDK::IAM::Grant

Grant the actions defined in actions to the identity Principal on this resource.

Parameters:

Returns:



301
302
303
304
305
306
307
 
# File 'iam/lazy_role.rb', line 301

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

#grant_assume_role(identity) ⇒ AWSCDK::IAM::Grant

Grant permissions to the given principal to assume this role.

Parameters:

Returns:



313
314
315
316
 
# File 'iam/lazy_role.rb', line 313

def grant_assume_role(identity)
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklQcmluY2lwYWwifQ==")), "identity")
  jsii_call_method("grantAssumeRole", [identity])
end

#grant_pass_role(identity) ⇒ AWSCDK::IAM::Grant

Grant permissions to the given principal to pass this role.

Parameters:

Returns:



322
323
324
325
 
# File 'iam/lazy_role.rb', line 322

def grant_pass_role(identity)
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklQcmluY2lwYWwifQ==")), "identity")
  jsii_call_method("grantPassRole", [identity])
end

#grant_principal ⇒ AWSCDK::IAM::IPrincipal

The principal to grant permissions to.

Returns:



117
118
119
 
# File 'iam/lazy_role.rb', line 117

def grant_principal()
  jsii_get_property("grantPrincipal")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


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

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


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

def physical_name()
  jsii_get_property("physicalName")
end

#policy_fragment ⇒ AWSCDK::IAM::PrincipalPolicyFragment

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

Returns:



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

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) 


164
165
166
 
# File 'iam/lazy_role.rb', line 164

def ()
  jsii_get_property("principalAccount")
end

#role_arn ⇒ String

Returns the ARN of this role.

Returns:

  • (String) 


131
132
133
 
# File 'iam/lazy_role.rb', line 131

def role_arn()
  jsii_get_property("roleArn")
end

#role_id ⇒ String

Returns the stable and unique string identifying the role (i.e. AIDAJQABLZS4A3QDU576Q).

Returns:

  • (String) 


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

def role_id()
  jsii_get_property("roleId")
end

#role_name ⇒ String

Returns the name of this role.

Returns:

  • (String) 


145
146
147
 
# File 'iam/lazy_role.rb', line 145

def role_name()
  jsii_get_property("roleName")
end

#role_ref ⇒ AWSCDK::Interfaces::AWSIAM::RoleReference

A reference to a Role resource.

Returns:



152
153
154
 
# File 'iam/lazy_role.rb', line 152

def role_ref()
  jsii_get_property("roleRef")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



96
97
98
 
# File 'iam/lazy_role.rb', line 96

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


171
172
173
 
# File 'iam/lazy_role.rb', line 171

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

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


184
185
186
187
188
189
 
# File 'iam/lazy_role.rb', line 184

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end