awsdevopsguru

Documentation

Index

• func CfnNotificationChannel_CFN_RESOURCE_TYPE_NAME() *string
• func CfnNotificationChannel_IsCfnElement(x interface{}) *bool
• func CfnNotificationChannel_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnNotificationChannel_IsConstruct(x interface{}) *bool
• func CfnResourceCollection_CFN_RESOURCE_TYPE_NAME() *string
• func CfnResourceCollection_IsCfnElement(x interface{}) *bool
• func CfnResourceCollection_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnResourceCollection_IsConstruct(x interface{}) *bool
• func NewCfnNotificationChannel_Override(c CfnNotificationChannel, scope constructs.Construct, id *string, ...)
• func NewCfnResourceCollection_Override(c CfnResourceCollection, scope constructs.Construct, id *string, ...)
• type CfnNotificationChannel
  • func NewCfnNotificationChannel(scope constructs.Construct, id *string, props *CfnNotificationChannelProps) CfnNotificationChannel
• type CfnNotificationChannelProps
• type CfnNotificationChannel_NotificationChannelConfigProperty
• type CfnNotificationChannel_SnsChannelConfigProperty
• type CfnResourceCollection
  • func NewCfnResourceCollection(scope constructs.Construct, id *string, props *CfnResourceCollectionProps) CfnResourceCollection
• type CfnResourceCollectionProps
• type CfnResourceCollection_CloudFormationCollectionFilterProperty
• type CfnResourceCollection_ResourceCollectionFilterProperty

Functions

func CfnNotificationChannel_CFN_RESOURCE_TYPE_NAME

func CfnNotificationChannel_CFN_RESOURCE_TYPE_NAME() *string

func CfnNotificationChannel_IsCfnElement

func CfnNotificationChannel_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 CfnNotificationChannel_IsCfnResource

func CfnNotificationChannel_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnNotificationChannel_IsConstruct

func CfnNotificationChannel_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 CfnResourceCollection_CFN_RESOURCE_TYPE_NAME

func CfnResourceCollection_CFN_RESOURCE_TYPE_NAME() *string

func CfnResourceCollection_IsCfnElement

func CfnResourceCollection_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 CfnResourceCollection_IsCfnResource

func CfnResourceCollection_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnResourceCollection_IsConstruct

func CfnResourceCollection_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 NewCfnNotificationChannel_Override

func NewCfnNotificationChannel_Override(c CfnNotificationChannel, scope constructs.Construct, id *string, props *CfnNotificationChannelProps)

Create a new `AWS::DevOpsGuru::NotificationChannel`.

func NewCfnResourceCollection_Override

func NewCfnResourceCollection_Override(c CfnResourceCollection, scope constructs.Construct, id *string, props *CfnResourceCollectionProps)

Create a new `AWS::DevOpsGuru::ResourceCollection`.

Types

type CfnNotificationChannel

type CfnNotificationChannel interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	Config() interface{}
	SetConfig(val interface{})
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	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::DevOpsGuru::NotificationChannel`.

Adds a notification channel to DevOps Guru. A notification channel is used to notify you about important DevOps Guru events, such as when an insight is generated.

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see [Permissions for cross account Amazon SNS topics](https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html) .

If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see [Permissions for AWS KMS–encrypted Amazon SNS topics](https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html) .

TODO: EXAMPLE

func NewCfnNotificationChannel

func NewCfnNotificationChannel(scope constructs.Construct, id *string, props *CfnNotificationChannelProps) CfnNotificationChannel

Create a new `AWS::DevOpsGuru::NotificationChannel`.

type CfnNotificationChannelProps

type CfnNotificationChannelProps struct {
	// A `NotificationChannelConfig` object that contains information about configured notification channels.
	Config interface{} `json:"config"`
}

Properties for defining a `CfnNotificationChannel`.

TODO: EXAMPLE

type CfnNotificationChannel_NotificationChannelConfigProperty

type CfnNotificationChannel_NotificationChannelConfigProperty struct {
	// Information about a notification channel configured in DevOps Guru to send notifications when insights are created.
	//
	// If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see [Permissions for cross account Amazon SNS topics](https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html) .
	//
	// If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see [Permissions for AWS KMS–encrypted Amazon SNS topics](https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html) .
	Sns interface{} `json:"sns"`
}

Information about notification channels you have configured with DevOps Guru.

The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).

TODO: EXAMPLE

type CfnNotificationChannel_SnsChannelConfigProperty

type CfnNotificationChannel_SnsChannelConfigProperty struct {
	// The Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.
	TopicArn *string `json:"topicArn"`
}

Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see [Permissions for cross account Amazon SNS topics](https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html) .

If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see [Permissions for AWS KMS–encrypted Amazon SNS topics](https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html) .

TODO: EXAMPLE

type CfnResourceCollection

type CfnResourceCollection interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrResourceCollectionType() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	ResourceCollectionFilter() interface{}
	SetResourceCollectionFilter(val interface{})
	Stack() awscdk.Stack
	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::DevOpsGuru::ResourceCollection`.

A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks.

TODO: EXAMPLE

func NewCfnResourceCollection

func NewCfnResourceCollection(scope constructs.Construct, id *string, props *CfnResourceCollectionProps) CfnResourceCollection

Create a new `AWS::DevOpsGuru::ResourceCollection`.

type CfnResourceCollectionProps

type CfnResourceCollectionProps struct {
	// Information about a filter used to specify which AWS resources are analyzed for anomalous behavior by DevOps Guru.
	ResourceCollectionFilter interface{} `json:"resourceCollectionFilter"`
}

Properties for defining a `CfnResourceCollection`.

TODO: EXAMPLE

type CfnResourceCollection_CloudFormationCollectionFilterProperty

type CfnResourceCollection_CloudFormationCollectionFilterProperty struct {
	// An array of CloudFormation stack names.
	StackNames *[]*string `json:"stackNames"`
}

Information about AWS CloudFormation stacks.

You can use up to 500 stacks to specify which AWS resources in your account to analyze. For more information, see [Stacks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) in the *AWS CloudFormation User Guide* .

TODO: EXAMPLE

type CfnResourceCollection_ResourceCollectionFilterProperty

type CfnResourceCollection_ResourceCollectionFilterProperty struct {
	// Information about AWS CloudFormation stacks.
	//
	// You can use up to 500 stacks to specify which AWS resources in your account to analyze. For more information, see [Stacks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) in the *AWS CloudFormation User Guide* .
	CloudFormation interface{} `json:"cloudFormation"`
}

Information about a filter used to specify which AWS resources are analyzed for anomalous behavior by DevOps Guru.

TODO: EXAMPLE