Show / Hide Table of Contents

Class CfnInvestigationGroupPropsMixin

Creates an investigation group in your account.

Inheritance
object
Mixin
CfnInvestigationGroupPropsMixin
Implements
IMixin
Inherited Members
Mixin.IsMixin(object)
Namespace: Amazon.CDK.Mixins.Preview.AWS.AIOps.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public class CfnInvestigationGroupPropsMixin : Mixin, IMixin
Syntax (vb)
Public Class CfnInvestigationGroupPropsMixin Inherits Mixin Implements IMixin
Remarks

Creating an investigation group is a one-time setup task for each Region in your account. It is a necessary task to be able to perform investigations.

Settings in the investigation group help you centrally manage the common properties of your investigations, such as the following:

    Currently, you can have one investigation group in each Region in your account. Each investigation in a Region is a part of the investigation group in that Region

    To create an investigation group and set up CloudWatch investigations, you must be signed in to an IAM principal that has either the AIOpsConsoleAdminPolicy or the AdministratorAccess IAM policy attached, or to an account that has similar permissions.

    You can configure CloudWatch alarms to start investigations and add events to investigations. If you create your investigation group with <code>CreateInvestigationGroup</code> and you want to enable alarms to do this, you must use <code>PutInvestigationGroupPolicy</code> to create a resource policy that grants this permission to CloudWatch alarms.
    

    For more information about configuring CloudWatch alarms, see Using Amazon CloudWatch alarms

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html

    CloudformationResource: AWS::AIOps::InvestigationGroup

    Mixin: true

    ExampleMetadata: fixture=_generated

    Examples
    // The code below shows an example of how to instantiate this type.
                 // The values are placeholders you should change.
                 using Amazon.CDK.Mixins.Preview.Mixins;
                 using Amazon.CDK.Mixins.Preview.AWS.AIOps.Mixins;
    
                 var cfnInvestigationGroupPropsMixin = new CfnInvestigationGroupPropsMixin(new CfnInvestigationGroupMixinProps {
                     ChatbotNotificationChannels = new [] { new ChatbotNotificationChannelProperty {
                         ChatConfigurationArns = new [] { "chatConfigurationArns" },
                         SnsTopicArn = "snsTopicArn"
                     } },
                     CrossAccountConfigurations = new [] { new CrossAccountConfigurationProperty {
                         SourceRoleArn = "sourceRoleArn"
                     } },
                     EncryptionConfig = new EncryptionConfigMapProperty {
                         EncryptionConfigurationType = "encryptionConfigurationType",
                         KmsKeyId = "kmsKeyId"
                     },
                     InvestigationGroupPolicy = "investigationGroupPolicy",
                     IsCloudTrailEventHistoryEnabled = false,
                     Name = "name",
                     RetentionInDays = 123,
                     RoleArn = "roleArn",
                     TagKeyBoundaries = new [] { "tagKeyBoundaries" },
                     Tags = new [] { new CfnTag {
                         Key = "key",
                         Value = "value"
                     } }
                 }, new CfnPropertyMixinOptions {
                     Strategy = PropertyMergeStrategy.OVERRIDE
                 });

    Synopsis

    Constructors

    CfnInvestigationGroupPropsMixin(ICfnInvestigationGroupMixinProps, ICfnPropertyMixinOptions?)

    Create a mixin to apply properties to AWS::AIOps::InvestigationGroup.

    Properties

    CFN_PROPERTY_KEYS

    Creates an investigation group in your account.

    Props

    Creates an investigation group in your account.

    Strategy

    Creates an investigation group in your account.

    Methods

    ApplyTo(IConstruct)

    Apply the mixin properties to the construct.

    Supports(IConstruct)

    Check if this mixin supports the given construct.

    Constructors

    CfnInvestigationGroupPropsMixin(ICfnInvestigationGroupMixinProps, ICfnPropertyMixinOptions?)

    Create a mixin to apply properties to AWS::AIOps::InvestigationGroup.

    public CfnInvestigationGroupPropsMixin(ICfnInvestigationGroupMixinProps props, ICfnPropertyMixinOptions? options = null)
    Parameters
    props ICfnInvestigationGroupMixinProps

    L1 properties to apply.

    options ICfnPropertyMixinOptions

    Mixin options.

    Remarks

    Creating an investigation group is a one-time setup task for each Region in your account. It is a necessary task to be able to perform investigations.

    Settings in the investigation group help you centrally manage the common properties of your investigations, such as the following:

      Currently, you can have one investigation group in each Region in your account. Each investigation in a Region is a part of the investigation group in that Region

      To create an investigation group and set up CloudWatch investigations, you must be signed in to an IAM principal that has either the AIOpsConsoleAdminPolicy or the AdministratorAccess IAM policy attached, or to an account that has similar permissions.

      You can configure CloudWatch alarms to start investigations and add events to investigations. If you create your investigation group with <code>CreateInvestigationGroup</code> and you want to enable alarms to do this, you must use <code>PutInvestigationGroupPolicy</code> to create a resource policy that grants this permission to CloudWatch alarms.
      

      For more information about configuring CloudWatch alarms, see Using Amazon CloudWatch alarms

      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html

      CloudformationResource: AWS::AIOps::InvestigationGroup

      Mixin: true

      ExampleMetadata: fixture=_generated

      Properties

      CFN_PROPERTY_KEYS

      Creates an investigation group in your account.

      protected static string[] CFN_PROPERTY_KEYS { get; }
      Property Value

      string[]

      Remarks

      Creating an investigation group is a one-time setup task for each Region in your account. It is a necessary task to be able to perform investigations.

      Settings in the investigation group help you centrally manage the common properties of your investigations, such as the following:

        Currently, you can have one investigation group in each Region in your account. Each investigation in a Region is a part of the investigation group in that Region

        To create an investigation group and set up CloudWatch investigations, you must be signed in to an IAM principal that has either the AIOpsConsoleAdminPolicy or the AdministratorAccess IAM policy attached, or to an account that has similar permissions.

        You can configure CloudWatch alarms to start investigations and add events to investigations. If you create your investigation group with <code>CreateInvestigationGroup</code> and you want to enable alarms to do this, you must use <code>PutInvestigationGroupPolicy</code> to create a resource policy that grants this permission to CloudWatch alarms.
        

        For more information about configuring CloudWatch alarms, see Using Amazon CloudWatch alarms

        See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html

        CloudformationResource: AWS::AIOps::InvestigationGroup

        Mixin: true

        ExampleMetadata: fixture=_generated

        Examples
        // The code below shows an example of how to instantiate this type.
                     // The values are placeholders you should change.
                     using Amazon.CDK.Mixins.Preview.Mixins;
                     using Amazon.CDK.Mixins.Preview.AWS.AIOps.Mixins;
        
                     var cfnInvestigationGroupPropsMixin = new CfnInvestigationGroupPropsMixin(new CfnInvestigationGroupMixinProps {
                         ChatbotNotificationChannels = new [] { new ChatbotNotificationChannelProperty {
                             ChatConfigurationArns = new [] { "chatConfigurationArns" },
                             SnsTopicArn = "snsTopicArn"
                         } },
                         CrossAccountConfigurations = new [] { new CrossAccountConfigurationProperty {
                             SourceRoleArn = "sourceRoleArn"
                         } },
                         EncryptionConfig = new EncryptionConfigMapProperty {
                             EncryptionConfigurationType = "encryptionConfigurationType",
                             KmsKeyId = "kmsKeyId"
                         },
                         InvestigationGroupPolicy = "investigationGroupPolicy",
                         IsCloudTrailEventHistoryEnabled = false,
                         Name = "name",
                         RetentionInDays = 123,
                         RoleArn = "roleArn",
                         TagKeyBoundaries = new [] { "tagKeyBoundaries" },
                         Tags = new [] { new CfnTag {
                             Key = "key",
                             Value = "value"
                         } }
                     }, new CfnPropertyMixinOptions {
                         Strategy = PropertyMergeStrategy.OVERRIDE
                     });

        Props

        Creates an investigation group in your account.

        protected virtual ICfnInvestigationGroupMixinProps Props { get; }
        Property Value

        ICfnInvestigationGroupMixinProps

        Remarks

        Creating an investigation group is a one-time setup task for each Region in your account. It is a necessary task to be able to perform investigations.

        Settings in the investigation group help you centrally manage the common properties of your investigations, such as the following:

          Currently, you can have one investigation group in each Region in your account. Each investigation in a Region is a part of the investigation group in that Region

          To create an investigation group and set up CloudWatch investigations, you must be signed in to an IAM principal that has either the AIOpsConsoleAdminPolicy or the AdministratorAccess IAM policy attached, or to an account that has similar permissions.

          You can configure CloudWatch alarms to start investigations and add events to investigations. If you create your investigation group with <code>CreateInvestigationGroup</code> and you want to enable alarms to do this, you must use <code>PutInvestigationGroupPolicy</code> to create a resource policy that grants this permission to CloudWatch alarms.
          

          For more information about configuring CloudWatch alarms, see Using Amazon CloudWatch alarms

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html

          CloudformationResource: AWS::AIOps::InvestigationGroup

          Mixin: true

          ExampleMetadata: fixture=_generated

          Examples
          // The code below shows an example of how to instantiate this type.
                       // The values are placeholders you should change.
                       using Amazon.CDK.Mixins.Preview.Mixins;
                       using Amazon.CDK.Mixins.Preview.AWS.AIOps.Mixins;
          
                       var cfnInvestigationGroupPropsMixin = new CfnInvestigationGroupPropsMixin(new CfnInvestigationGroupMixinProps {
                           ChatbotNotificationChannels = new [] { new ChatbotNotificationChannelProperty {
                               ChatConfigurationArns = new [] { "chatConfigurationArns" },
                               SnsTopicArn = "snsTopicArn"
                           } },
                           CrossAccountConfigurations = new [] { new CrossAccountConfigurationProperty {
                               SourceRoleArn = "sourceRoleArn"
                           } },
                           EncryptionConfig = new EncryptionConfigMapProperty {
                               EncryptionConfigurationType = "encryptionConfigurationType",
                               KmsKeyId = "kmsKeyId"
                           },
                           InvestigationGroupPolicy = "investigationGroupPolicy",
                           IsCloudTrailEventHistoryEnabled = false,
                           Name = "name",
                           RetentionInDays = 123,
                           RoleArn = "roleArn",
                           TagKeyBoundaries = new [] { "tagKeyBoundaries" },
                           Tags = new [] { new CfnTag {
                               Key = "key",
                               Value = "value"
                           } }
                       }, new CfnPropertyMixinOptions {
                           Strategy = PropertyMergeStrategy.OVERRIDE
                       });

          Strategy

          Creates an investigation group in your account.

          protected virtual PropertyMergeStrategy Strategy { get; }
          Property Value

          PropertyMergeStrategy

          Remarks

          Creating an investigation group is a one-time setup task for each Region in your account. It is a necessary task to be able to perform investigations.

          Settings in the investigation group help you centrally manage the common properties of your investigations, such as the following:

            Currently, you can have one investigation group in each Region in your account. Each investigation in a Region is a part of the investigation group in that Region

            To create an investigation group and set up CloudWatch investigations, you must be signed in to an IAM principal that has either the AIOpsConsoleAdminPolicy or the AdministratorAccess IAM policy attached, or to an account that has similar permissions.

            You can configure CloudWatch alarms to start investigations and add events to investigations. If you create your investigation group with <code>CreateInvestigationGroup</code> and you want to enable alarms to do this, you must use <code>PutInvestigationGroupPolicy</code> to create a resource policy that grants this permission to CloudWatch alarms.
            

            For more information about configuring CloudWatch alarms, see Using Amazon CloudWatch alarms

            See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html

            CloudformationResource: AWS::AIOps::InvestigationGroup

            Mixin: true

            ExampleMetadata: fixture=_generated

            Examples
            // The code below shows an example of how to instantiate this type.
                         // The values are placeholders you should change.
                         using Amazon.CDK.Mixins.Preview.Mixins;
                         using Amazon.CDK.Mixins.Preview.AWS.AIOps.Mixins;
            
                         var cfnInvestigationGroupPropsMixin = new CfnInvestigationGroupPropsMixin(new CfnInvestigationGroupMixinProps {
                             ChatbotNotificationChannels = new [] { new ChatbotNotificationChannelProperty {
                                 ChatConfigurationArns = new [] { "chatConfigurationArns" },
                                 SnsTopicArn = "snsTopicArn"
                             } },
                             CrossAccountConfigurations = new [] { new CrossAccountConfigurationProperty {
                                 SourceRoleArn = "sourceRoleArn"
                             } },
                             EncryptionConfig = new EncryptionConfigMapProperty {
                                 EncryptionConfigurationType = "encryptionConfigurationType",
                                 KmsKeyId = "kmsKeyId"
                             },
                             InvestigationGroupPolicy = "investigationGroupPolicy",
                             IsCloudTrailEventHistoryEnabled = false,
                             Name = "name",
                             RetentionInDays = 123,
                             RoleArn = "roleArn",
                             TagKeyBoundaries = new [] { "tagKeyBoundaries" },
                             Tags = new [] { new CfnTag {
                                 Key = "key",
                                 Value = "value"
                             } }
                         }, new CfnPropertyMixinOptions {
                             Strategy = PropertyMergeStrategy.OVERRIDE
                         });

            Methods

            ApplyTo(IConstruct)

            Apply the mixin properties to the construct.

            public override IConstruct ApplyTo(IConstruct construct)
            Parameters
            construct IConstruct
            Returns

            IConstruct

            Overrides
            Mixin.ApplyTo(IConstruct)
            Remarks

            Creating an investigation group is a one-time setup task for each Region in your account. It is a necessary task to be able to perform investigations.

            Settings in the investigation group help you centrally manage the common properties of your investigations, such as the following:

              Currently, you can have one investigation group in each Region in your account. Each investigation in a Region is a part of the investigation group in that Region

              To create an investigation group and set up CloudWatch investigations, you must be signed in to an IAM principal that has either the AIOpsConsoleAdminPolicy or the AdministratorAccess IAM policy attached, or to an account that has similar permissions.

              You can configure CloudWatch alarms to start investigations and add events to investigations. If you create your investigation group with <code>CreateInvestigationGroup</code> and you want to enable alarms to do this, you must use <code>PutInvestigationGroupPolicy</code> to create a resource policy that grants this permission to CloudWatch alarms.
              

              For more information about configuring CloudWatch alarms, see Using Amazon CloudWatch alarms

              See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html

              CloudformationResource: AWS::AIOps::InvestigationGroup

              Mixin: true

              ExampleMetadata: fixture=_generated

              Supports(IConstruct)

              Check if this mixin supports the given construct.

              public override bool Supports(IConstruct construct)
              Parameters
              construct IConstruct
              Returns

              bool

              Overrides
              Mixin.Supports(IConstruct)
              Remarks

              Creating an investigation group is a one-time setup task for each Region in your account. It is a necessary task to be able to perform investigations.

              Settings in the investigation group help you centrally manage the common properties of your investigations, such as the following:

                Currently, you can have one investigation group in each Region in your account. Each investigation in a Region is a part of the investigation group in that Region

                To create an investigation group and set up CloudWatch investigations, you must be signed in to an IAM principal that has either the AIOpsConsoleAdminPolicy or the AdministratorAccess IAM policy attached, or to an account that has similar permissions.

                You can configure CloudWatch alarms to start investigations and add events to investigations. If you create your investigation group with <code>CreateInvestigationGroup</code> and you want to enable alarms to do this, you must use <code>PutInvestigationGroupPolicy</code> to create a resource policy that grants this permission to CloudWatch alarms.
                

                For more information about configuring CloudWatch alarms, see Using Amazon CloudWatch alarms

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html

                CloudformationResource: AWS::AIOps::InvestigationGroup

                Mixin: true

                ExampleMetadata: fixture=_generated

                Implements

                IMixin
                Back to top Generated by DocFX