Class: AWSCDK::IAM::InstanceProfile

Inherits:
Resource
  • Object
show all
Includes:
IInstanceProfile
Defined in:
iam/instance_profile.rb

Overview

IAM Instance Profile.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of InstanceProfile.

Parameters:



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

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

Class Method Details

.from_instance_profile_arn(scope, id, instance_profile_arn) ⇒ AWSCDK::IAM::IInstanceProfile

Import an existing InstanceProfile from an InstanceProfile ARN.

If the ARN comes from a Token, the InstanceProfile cannot have a path; if so, any attempt to reference its instanceProfileName will fail.

Parameters:

  • scope (Constructs::Construct) —

    construct scope.

  • id (String) —

    construct id.

  • instance_profile_arn (String) —

    the ARN of the exiting InstanceProfile to import.

Returns:



49
50
51
52
53
54
 
# File 'iam/instance_profile.rb', line 49

def self.from_instance_profile_arn(scope, id, instance_profile_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(instance_profile_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceProfileArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iam.InstanceProfile", "fromInstanceProfileArn", [scope, id, instance_profile_arn])
end

.from_instance_profile_attributes(scope, id, attrs) ⇒ AWSCDK::IAM::IInstanceProfile

Import an existing InstanceProfile from given InstanceProfile attributes.

If the ARN comes from a Token, the InstanceProfile cannot have a path; if so, any attempt to reference its instanceProfileName will fail.

Parameters:

Returns:



65
66
67
68
69
70
71
 
# File 'iam/instance_profile.rb', line 65

def self.from_instance_profile_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::IAM::InstanceProfileAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLkluc3RhbmNlUHJvZmlsZUF0dHJpYnV0ZXMifQ==")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iam.InstanceProfile", "fromInstanceProfileAttributes", [scope, id, attrs])
end

.from_instance_profile_name(scope, id, instance_profile_name) ⇒ AWSCDK::IAM::IInstanceProfile

Import an existing InstanceProfile from an InstanceProfile name.

Parameters:

  • scope (Constructs::Construct) —

    construct scope.

  • id (String) —

    construct id.

  • instance_profile_name (String) —

    the name of the existing InstanceProfile to import.

Returns:



79
80
81
82
83
84
 
# File 'iam/instance_profile.rb', line 79

def self.from_instance_profile_name(scope, id, instance_profile_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(instance_profile_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceProfileName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iam.InstanceProfile", "fromInstanceProfileName", [scope, id, instance_profile_name])
end

.jsii_overridable_methods ⇒ Object 



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

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 },
    :instance_profile_arn => { kind: :property, name: "instanceProfileArn", is_optional: false },
    :instance_profile_name => { kind: :property, name: "instanceProfileName", is_optional: false },
    :instance_profile_ref => { kind: :property, name: "instanceProfileRef", is_optional: false },
    :role => { kind: :property, name: "role", 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 },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


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

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

Instance Method Details

#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:



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

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:



214
215
216
217
 
# File 'iam/instance_profile.rb', line 214

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [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:



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

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


220
221
222
 
# File 'iam/instance_profile.rb', line 220

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) 


234
235
236
237
238
239
 
# File 'iam/instance_profile.rb', line 234

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) 


249
250
251
252
 
# File 'iam/instance_profile.rb', line 249

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

#instance_profile_arn ⇒ String

Returns the ARN of this InstanceProfile.

Returns:

  • (String) 


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

def instance_profile_arn()
  jsii_get_property("instanceProfileArn")
end

#instance_profile_name ⇒ String

Returns the name of this InstanceProfile.

Returns:

  • (String) 


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

def instance_profile_name()
  jsii_get_property("instanceProfileName")
end

#instance_profile_ref ⇒ AWSCDK::Interfaces::AWSIAM::InstanceProfileReference

A reference to a InstanceProfile resource.

Returns:



153
154
155
 
# File 'iam/instance_profile.rb', line 153

def instance_profile_ref()
  jsii_get_property("instanceProfileRef")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


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

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) 


118
119
120
 
# File 'iam/instance_profile.rb', line 118

def physical_name()
  jsii_get_property("physicalName")
end

#role ⇒ AWSCDK::IAM::IRole?

Returns the role associated with this InstanceProfile.

Returns:



160
161
162
 
# File 'iam/instance_profile.rb', line 160

def role()
  jsii_get_property("role")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



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

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


167
168
169
 
# File 'iam/instance_profile.rb', line 167

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) 


180
181
182
183
184
185
 
# File 'iam/instance_profile.rb', line 180

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