libZSservicesZSamazonka-cloudwatchZSamazonka-cloudwatch
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudWatch.PutInsightRule

Description

Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see Using Contributor Insights to Analyze High-Cardinality Data.

If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.

Synopsis

Creating a Request

data PutInsightRule Source #

See: newPutInsightRule smart constructor.

Constructors

PutInsightRule' 

Fields

  • tags :: Maybe [Tag]

    A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.

    Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

    To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.

    If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this parameter are ignored. To change the tags of an existing rule, use TagResource.

  • ruleState :: Maybe Text

    The state of the rule. Valid values are ENABLED and DISABLED.

  • ruleName :: Text

    A unique name for the rule.

  • ruleDefinition :: Text

    The definition of the rule, as a JSON object. For details on the valid syntax, see Contributor Insights Rule Syntax.

Instances

Instances details
Eq PutInsightRule Source # 
Instance details

Defined in Amazonka.CloudWatch.PutInsightRule

Read PutInsightRule Source # 
Instance details

Defined in Amazonka.CloudWatch.PutInsightRule

Show PutInsightRule Source # 
Instance details

Defined in Amazonka.CloudWatch.PutInsightRule

Generic PutInsightRule Source # 
Instance details

Defined in Amazonka.CloudWatch.PutInsightRule

Associated Types

type Rep PutInsightRule :: Type -> Type #

NFData PutInsightRule Source # 
Instance details

Defined in Amazonka.CloudWatch.PutInsightRule

Methods

rnf :: PutInsightRule -> () #

Hashable PutInsightRule Source # 
Instance details

Defined in Amazonka.CloudWatch.PutInsightRule

AWSRequest PutInsightRule Source # 
Instance details

Defined in Amazonka.CloudWatch.PutInsightRule

Associated Types

type AWSResponse PutInsightRule #

ToHeaders PutInsightRule Source # 
Instance details

Defined in Amazonka.CloudWatch.PutInsightRule

ToPath PutInsightRule Source # 
Instance details

Defined in Amazonka.CloudWatch.PutInsightRule

ToQuery PutInsightRule Source # 
Instance details

Defined in Amazonka.CloudWatch.PutInsightRule

type Rep PutInsightRule Source # 
Instance details

Defined in Amazonka.CloudWatch.PutInsightRule

type Rep PutInsightRule = D1 ('MetaData "PutInsightRule" "Amazonka.CloudWatch.PutInsightRule" "libZSservicesZSamazonka-cloudwatchZSamazonka-cloudwatch" 'False) (C1 ('MetaCons "PutInsightRule'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "ruleState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "ruleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "ruleDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse PutInsightRule Source # 
Instance details

Defined in Amazonka.CloudWatch.PutInsightRule

newPutInsightRule Source #

Create a value of PutInsightRule with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:tags:PutInsightRule', putInsightRule_tags - A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.

If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this parameter are ignored. To change the tags of an existing rule, use TagResource.

$sel:ruleState:PutInsightRule', putInsightRule_ruleState - The state of the rule. Valid values are ENABLED and DISABLED.

$sel:ruleName:PutInsightRule', putInsightRule_ruleName - A unique name for the rule.

$sel:ruleDefinition:PutInsightRule', putInsightRule_ruleDefinition - The definition of the rule, as a JSON object. For details on the valid syntax, see Contributor Insights Rule Syntax.

Request Lenses

putInsightRule_tags :: Lens' PutInsightRule (Maybe [Tag]) Source #

A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.

If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this parameter are ignored. To change the tags of an existing rule, use TagResource.

putInsightRule_ruleState :: Lens' PutInsightRule (Maybe Text) Source #

The state of the rule. Valid values are ENABLED and DISABLED.

putInsightRule_ruleDefinition :: Lens' PutInsightRule Text Source #

The definition of the rule, as a JSON object. For details on the valid syntax, see Contributor Insights Rule Syntax.

Destructuring the Response

data PutInsightRuleResponse Source #

See: newPutInsightRuleResponse smart constructor.

Constructors

PutInsightRuleResponse' 

Fields

Instances

Instances details
Eq PutInsightRuleResponse Source # 
Instance details

Defined in Amazonka.CloudWatch.PutInsightRule

Read PutInsightRuleResponse Source # 
Instance details

Defined in Amazonka.CloudWatch.PutInsightRule

Show PutInsightRuleResponse Source # 
Instance details

Defined in Amazonka.CloudWatch.PutInsightRule

Generic PutInsightRuleResponse Source # 
Instance details

Defined in Amazonka.CloudWatch.PutInsightRule

Associated Types

type Rep PutInsightRuleResponse :: Type -> Type #

NFData PutInsightRuleResponse Source # 
Instance details

Defined in Amazonka.CloudWatch.PutInsightRule

Methods

rnf :: PutInsightRuleResponse -> () #

type Rep PutInsightRuleResponse Source # 
Instance details

Defined in Amazonka.CloudWatch.PutInsightRule

type Rep PutInsightRuleResponse = D1 ('MetaData "PutInsightRuleResponse" "Amazonka.CloudWatch.PutInsightRule" "libZSservicesZSamazonka-cloudwatchZSamazonka-cloudwatch" 'False) (C1 ('MetaCons "PutInsightRuleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutInsightRuleResponse Source #

Create a value of PutInsightRuleResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:PutInsightRuleResponse', putInsightRuleResponse_httpStatus - The response's http status code.

Response Lenses