awscodeguruprofiler

Documentation

Index

• func CfnProfilingGroup_CFN_RESOURCE_TYPE_NAME() *string
• func CfnProfilingGroup_IsCfnElement(x interface{}) *bool
• func CfnProfilingGroup_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnProfilingGroup_IsConstruct(x interface{}) *bool
• func NewCfnProfilingGroup_Override(c CfnProfilingGroup, scope constructs.Construct, id *string, ...)
• func NewProfilingGroup_Override(p ProfilingGroup, scope constructs.Construct, id *string, ...)
• func ProfilingGroup_IsConstruct(x interface{}) *bool
• func ProfilingGroup_IsResource(construct constructs.IConstruct) *bool
• type CfnProfilingGroup
  • func NewCfnProfilingGroup(scope constructs.Construct, id *string, props *CfnProfilingGroupProps) CfnProfilingGroup
• type CfnProfilingGroupProps
• type CfnProfilingGroup_ChannelProperty
• type ComputePlatform
• type IProfilingGroup
  • func ProfilingGroup_FromProfilingGroupArn(scope constructs.Construct, id *string, profilingGroupArn *string) IProfilingGroup
  • func ProfilingGroup_FromProfilingGroupName(scope constructs.Construct, id *string, profilingGroupName *string) IProfilingGroup
• type ProfilingGroup
  • func NewProfilingGroup(scope constructs.Construct, id *string, props *ProfilingGroupProps) ProfilingGroup
• type ProfilingGroupProps

Functions

func CfnProfilingGroup_CFN_RESOURCE_TYPE_NAME

func CfnProfilingGroup_CFN_RESOURCE_TYPE_NAME() *string

func CfnProfilingGroup_IsCfnElement

func CfnProfilingGroup_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnProfilingGroup_IsCfnResource

func CfnProfilingGroup_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnProfilingGroup_IsConstruct

func CfnProfilingGroup_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnProfilingGroup_Override

func NewCfnProfilingGroup_Override(c CfnProfilingGroup, scope constructs.Construct, id *string, props *CfnProfilingGroupProps)

Create a new `AWS::CodeGuruProfiler::ProfilingGroup`.

func NewProfilingGroup_Override

func NewProfilingGroup_Override(p ProfilingGroup, scope constructs.Construct, id *string, props *ProfilingGroupProps)

func ProfilingGroup_IsConstruct

func ProfilingGroup_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func ProfilingGroup_IsResource

func ProfilingGroup_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

Types

type CfnProfilingGroup

type CfnProfilingGroup interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AgentPermissions() interface{}
	SetAgentPermissions(val interface{})
	AnomalyDetectionNotificationConfiguration() interface{}
	SetAnomalyDetectionNotificationConfiguration(val interface{})
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ComputePlatform() *string
	SetComputePlatform(val *string)
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	ProfilingGroupName() *string
	SetProfilingGroupName(val *string)
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CodeGuruProfiler::ProfilingGroup`.

Creates a profiling group.

TODO: EXAMPLE

func NewCfnProfilingGroup

func NewCfnProfilingGroup(scope constructs.Construct, id *string, props *CfnProfilingGroupProps) CfnProfilingGroup

Create a new `AWS::CodeGuruProfiler::ProfilingGroup`.

type CfnProfilingGroupProps

type CfnProfilingGroupProps struct {
	// The name of the profiling group.
	ProfilingGroupName *string `json:"profilingGroupName" yaml:"profilingGroupName"`
	// The agent permissions attached to this profiling group.
	//
	// This action group grants `ConfigureAgent` and `PostAgentProfile` permissions to perform actions required by the profiling agent. The Json consists of key `Principals` .
	//
	// *Principals* : A list of string ARNs for the roles and users you want to grant access to the profiling group. Wildcards are not supported in the ARNs. You are allowed to provide up to 50 ARNs. An empty list is not permitted. This is a required key.
	//
	// For more information, see [Resource-based policies in CodeGuru Profiler](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html) in the *Amazon CodeGuru Profiler user guide* , [ConfigureAgent](https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html) , and [PostAgentProfile](https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html) .
	AgentPermissions interface{} `json:"agentPermissions" yaml:"agentPermissions"`
	// Adds anomaly notifications for a profiling group.
	AnomalyDetectionNotificationConfiguration interface{} `json:"anomalyDetectionNotificationConfiguration" yaml:"anomalyDetectionNotificationConfiguration"`
	// The compute platform of the profiling group.
	//
	// Use `AWSLambda` if your application runs on AWS Lambda. Use `Default` if your application runs on a compute platform that is not AWS Lambda , such an Amazon EC2 instance, an on-premises server, or a different platform. If not specified, `Default` is used. This property is immutable.
	ComputePlatform *string `json:"computePlatform" yaml:"computePlatform"`
	// A list of tags to add to the created profiling group.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnProfilingGroup`.

TODO: EXAMPLE

type CfnProfilingGroup_ChannelProperty

type CfnProfilingGroup_ChannelProperty struct {
	// The channel URI.
	ChannelUri *string `json:"channelUri" yaml:"channelUri"`
	// The channel ID.
	ChannelId *string `json:"channelId" yaml:"channelId"`
}

Notification medium for users to get alerted for events that occur in application profile.

We support SNS topic as a notification channel.

TODO: EXAMPLE

type ComputePlatform

type ComputePlatform string

The compute platform of the profiling group.

TODO: EXAMPLE

const (
	ComputePlatform_AWS_LAMBDA ComputePlatform = "AWS_LAMBDA"
	ComputePlatform_DEFAULT    ComputePlatform = "DEFAULT"
)

type IProfilingGroup

type IProfilingGroup interface {
	awscdk.IResource
	// 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
	GrantPublish(grantee awsiam.IGrantable) awsiam.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
	GrantRead(grantee awsiam.IGrantable) awsiam.Grant
	// A name for the profiling group.
	ProfilingGroupName() *string
}

IResource represents a Profiling Group.

func ProfilingGroup_FromProfilingGroupArn

func ProfilingGroup_FromProfilingGroupArn(scope constructs.Construct, id *string, profilingGroupArn *string) IProfilingGroup

Import an existing Profiling Group provided an ARN.

func ProfilingGroup_FromProfilingGroupName

func ProfilingGroup_FromProfilingGroupName(scope constructs.Construct, id *string, profilingGroupName *string) IProfilingGroup

Import an existing Profiling Group provided a Profiling Group Name.

type ProfilingGroup

type ProfilingGroup interface {
	awscdk.Resource
	IProfilingGroup
	Env() *awscdk.ResourceEnvironment
	Node() constructs.Node
	PhysicalName() *string
	ProfilingGroupArn() *string
	ProfilingGroupName() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	GrantPublish(grantee awsiam.IGrantable) awsiam.Grant
	GrantRead(grantee awsiam.IGrantable) awsiam.Grant
	ToString() *string
}

A new Profiling Group.

TODO: EXAMPLE

func NewProfilingGroup

func NewProfilingGroup(scope constructs.Construct, id *string, props *ProfilingGroupProps) ProfilingGroup

type ProfilingGroupProps

type ProfilingGroupProps struct {
	// The compute platform of the profiling group.
	ComputePlatform ComputePlatform `json:"computePlatform" yaml:"computePlatform"`
	// A name for the profiling group.
	ProfilingGroupName *string `json:"profilingGroupName" yaml:"profilingGroupName"`
}

Properties for creating a new Profiling Group.

TODO: EXAMPLE