Module: AWSCDK::CodeGuruProfiler::IProfilingGroup

Includes:
IResource, Interfaces::AWSCodeguruprofiler::IProfilingGroupRef
Included in:
ProfilingGroup
Defined in:
code_guru_profiler/i_profiling_group.rb

Overview

IResource represents a Profiling Group.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'code_guru_profiler/i_profiling_group.rb', line 118

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :profiling_group_ref => { kind: :property, name: "profilingGroupRef", is_optional: false },
    :profiling_group_arn => { kind: :property, name: "profilingGroupArn", is_optional: false },
    :profiling_group_name => { kind: :property, name: "profilingGroupName", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :grant_publish => { kind: :method, name: "grantPublish", is_optional: false },
    :grant_read => { kind: :method, name: "grantRead", is_optional: false },
  }
end

Instance Method Details

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



85
86
87
88
 
# File 'code_guru_profiler/i_profiling_group.rb', line 85

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:



27
28
29
 
# File 'code_guru_profiler/i_profiling_group.rb', line 27

def env()
  jsii_get_property("env")
end

#grant_publish(grantee) ⇒ AWSCDK::IAM::Grant

Grant access to publish profiling information to the Profiling Group to the given identity.

This will grant the following permissions:

  • codeguru-profiler:ConfigureAgent
  • codeguru-profiler:PostAgentProfile

Parameters:

Returns:



99
100
101
102
 
# File 'code_guru_profiler/i_profiling_group.rb', line 99

def grant_publish(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantPublish", [grantee])
end

#grant_read(grantee) ⇒ AWSCDK::IAM::Grant

Grant access to read profiling information from the Profiling Group to the given identity.

This will grant the following permissions:

  • codeguru-profiler:GetProfile
  • codeguru-profiler:DescribeProfilingGroup

Parameters:

Returns:



113
114
115
116
 
# File 'code_guru_profiler/i_profiling_group.rb', line 113

def grant_read(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantRead", [grantee])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'code_guru_profiler/i_profiling_group.rb', line 12

def node()
  jsii_get_property("node")
end

#profiling_group_arn ⇒ String

The ARN of the profiling group.

Returns:

  • (String) 


48
49
50
 
# File 'code_guru_profiler/i_profiling_group.rb', line 48

def profiling_group_arn()
  jsii_get_property("profilingGroupArn")
end

#profiling_group_name ⇒ String

The name of the profiling group.

Returns:

  • (String) 


55
56
57
 
# File 'code_guru_profiler/i_profiling_group.rb', line 55

def profiling_group_name()
  jsii_get_property("profilingGroupName")
end

#profiling_group_ref ⇒ AWSCDK::Interfaces::AWSCodeguruprofiler::ProfilingGroupReference

A reference to a ProfilingGroup resource.

Returns:



41
42
43
 
# File 'code_guru_profiler/i_profiling_group.rb', line 41

def profiling_group_ref()
  jsii_get_property("profilingGroupRef")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'code_guru_profiler/i_profiling_group.rb', line 34

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

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



66
67
68
69
70
71
 
# File 'code_guru_profiler/i_profiling_group.rb', line 66

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