Class: AWSCDK::IAM::ManagedPolicy

Inherits:
Resource
  • Object
show all
Includes:
IGrantable, IManagedPolicy
Defined in:
iam/managed_policy.rb

Overview

Managed policy.

Direct Known Subclasses

CodeBuild::UntrustedCodeBoundaryPolicy

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ ManagedPolicy

Returns a new instance of ManagedPolicy.

Parameters:



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

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::IAM::ManagedPolicyProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLk1hbmFnZWRQb2xpY3lQcm9wcyJ9")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_aws_managed_policy_name(managed_policy_name) ⇒ AWSCDK::IAM::IManagedPolicy

Import a managed policy from one of the policies that AWS manages.

For this managed policy, you only need to know the name to be able to use it.

Some managed policy names start with "service-role/", some start with "job-function/", and some don't start with anything. Include the prefix when constructing this object.

Parameters:

  • managed_policy_name (String)

Returns:



58
59
60
61
 
# File 'iam/managed_policy.rb', line 58

def self.from_aws_managed_policy_name(managed_policy_name)
  Jsii::Type.check_type(managed_policy_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "managedPolicyName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iam.ManagedPolicy", "fromAwsManagedPolicyName", [managed_policy_name])
end

.from_managed_policy_arn(scope, id, managed_policy_arn) ⇒ AWSCDK::IAM::IManagedPolicy

Import an external managed policy by ARN.

For this managed policy, you only need to know the ARN to be able to use it. This can be useful if you got the ARN from a CloudFormation Export.

If the imported Managed Policy ARN is a Token (such as a CfnParameter.valueAsString or a Fn.importValue()) and the referenced managed policy has a path (like arn:...:policy/AdminPolicy/AdminAllow), the managed_policy_name property will not resolve to the correct value. Instead it will resolve to the first path component. We unfortunately cannot express the correct calculation of the full path name as a CloudFormation expression. In this scenario the Managed Policy ARN should be supplied without the path in order to resolve the correct managed policy resource.

Parameters:

  • scope (Constructs::Construct) —

    construct scope.

  • id (String) —

    construct id.

  • managed_policy_arn (String) —

    the ARN of the managed policy to import.

Returns:



81
82
83
84
85
86
 
# File 'iam/managed_policy.rb', line 81

def self.from_managed_policy_arn(scope, id, managed_policy_arn)
  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(managed_policy_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "managedPolicyArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iam.ManagedPolicy", "fromManagedPolicyArn", [scope, id, managed_policy_arn])
end

.from_managed_policy_name(scope, id, managed_policy_name) ⇒ AWSCDK::IAM::IManagedPolicy

Import a customer managed policy from the managedPolicyName.

For this managed policy, you only need to know the name to be able to use it.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • managed_policy_name (String)

Returns:



96
97
98
99
100
101
 
# File 'iam/managed_policy.rb', line 96

def self.from_managed_policy_name(scope, id, managed_policy_name)
  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(managed_policy_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "managedPolicyName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iam.ManagedPolicy", "fromManagedPolicyName", [scope, id, managed_policy_name])
end

.jsii_overridable_methods ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'iam/managed_policy.rb', line 21

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 },
    :description => { kind: :property, name: "description", is_optional: false },
    :document => { kind: :property, name: "document", is_optional: false },
    :grant_principal => { kind: :property, name: "grantPrincipal", is_optional: false },
    :managed_policy_arn => { kind: :property, name: "managedPolicyArn", is_optional: false },
    :managed_policy_name => { kind: :property, name: "managedPolicyName", is_optional: false },
    :managed_policy_ref => { kind: :property, name: "managedPolicyRef", is_optional: false },
    :path => { kind: :property, name: "path", is_optional: false },
    :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_statements => { kind: :method, name: "addStatements", is_optional: false },
    :attach_to_group => { kind: :method, name: "attachToGroup", is_optional: false },
    :attach_to_role => { kind: :method, name: "attachToRole", is_optional: false },
    :attach_to_user => { kind: :method, name: "attachToUser", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


149
150
151
 
# File 'iam/managed_policy.rb', line 149

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

Instance Method Details

#add_statements(*statement) ⇒ void

This method returns an undefined value.

Adds a statement to the policy document.

Parameters:



296
297
298
299
300
301
 
# File 'iam/managed_policy.rb', line 296

def add_statements(*statement)
  statement.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLlBvbGljeVN0YXRlbWVudCJ9")), "statement[#{index}]")
  end
  jsii_call_method("addStatements", [*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:



235
236
237
238
 
# File 'iam/managed_policy.rb', line 235

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:



252
253
254
255
 
# File 'iam/managed_policy.rb', line 252

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

#attach_to_group(group) ⇒ void

This method returns an undefined value.

Attaches this policy to a group.

Parameters:



307
308
309
310
 
# File 'iam/managed_policy.rb', line 307

def attach_to_group(group)
  Jsii::Type.check_type(group, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pYW0uSUdyb3VwUmVmIn0=")), "group")
  jsii_call_method("attachToGroup", [group])
end

#attach_to_role(role) ⇒ void

This method returns an undefined value.

Attaches this policy to a role.

Parameters:



316
317
318
319
 
# File 'iam/managed_policy.rb', line 316

def attach_to_role(role)
  Jsii::Type.check_type(role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklSb2xlIn0=")), "role")
  jsii_call_method("attachToRole", [role])
end

#attach_to_user(user) ⇒ void

This method returns an undefined value.

Attaches this policy to a user.

Parameters:



325
326
327
328
 
# File 'iam/managed_policy.rb', line 325

def attach_to_user(user)
  Jsii::Type.check_type(user, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pYW0uSVVzZXJSZWYifQ==")), "user")
  jsii_call_method("attachToUser", [user])
end

#description ⇒ String

The description of this policy.

Returns:

  • (String) 


156
157
158
 
# File 'iam/managed_policy.rb', line 156

def description()
  jsii_get_property("description")
end

#document ⇒ AWSCDK::IAM::PolicyDocument

The policy document.

Returns:



163
164
165
 
# File 'iam/managed_policy.rb', line 163

def document()
  jsii_get_property("document")
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:



121
122
123
 
# File 'iam/managed_policy.rb', line 121

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


258
259
260
 
# File 'iam/managed_policy.rb', line 258

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) 


272
273
274
275
276
277
 
# File 'iam/managed_policy.rb', line 272

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) 


287
288
289
290
 
# File 'iam/managed_policy.rb', line 287

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_principal ⇒ AWSCDK::IAM::IPrincipal

The principal to grant permissions to.

Returns:



170
171
172
 
# File 'iam/managed_policy.rb', line 170

def grant_principal()
  jsii_get_property("grantPrincipal")
end

#managed_policy_arn ⇒ String

Returns the ARN of this managed policy.

Returns:

  • (String) 


177
178
179
 
# File 'iam/managed_policy.rb', line 177

def managed_policy_arn()
  jsii_get_property("managedPolicyArn")
end

#managed_policy_name ⇒ String

The name of this policy.

Returns:

  • (String) 


184
185
186
 
# File 'iam/managed_policy.rb', line 184

def managed_policy_name()
  jsii_get_property("managedPolicyName")
end

#managed_policy_ref ⇒ AWSCDK::Interfaces::AWSIAM::ManagedPolicyReference

A reference to a ManagedPolicy resource.

Returns:



191
192
193
 
# File 'iam/managed_policy.rb', line 191

def managed_policy_ref()
  jsii_get_property("managedPolicyRef")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


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

def node()
  jsii_get_property("node")
end

#path ⇒ String

The path of this policy.

Returns:

  • (String) 


198
199
200
 
# File 'iam/managed_policy.rb', line 198

def path()
  jsii_get_property("path")
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) 


135
136
137
 
# File 'iam/managed_policy.rb', line 135

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



142
143
144
 
# File 'iam/managed_policy.rb', line 142

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


205
206
207
 
# File 'iam/managed_policy.rb', line 205

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) 


218
219
220
221
222
223
 
# File 'iam/managed_policy.rb', line 218

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