Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.XRay.Types.SamplingRuleUpdate

Description

Synopsis

data SamplingRuleUpdate = SamplingRuleUpdate' {
- attributes :: Maybe (HashMap Text Text)
- fixedRate :: Maybe Double
- hTTPMethod :: Maybe Text
- host :: Maybe Text
- priority :: Maybe Int
- reservoirSize :: Maybe Int
- resourceARN :: Maybe Text
- ruleARN :: Maybe Text
- ruleName :: Maybe Text
- serviceName :: Maybe Text
- serviceType :: Maybe Text
- uRLPath :: Maybe Text
}
newSamplingRuleUpdate :: SamplingRuleUpdate
samplingRuleUpdate_attributes :: Lens' SamplingRuleUpdate (Maybe (HashMap Text Text))
samplingRuleUpdate_fixedRate :: Lens' SamplingRuleUpdate (Maybe Double)
samplingRuleUpdate_hTTPMethod :: Lens' SamplingRuleUpdate (Maybe Text)
samplingRuleUpdate_host :: Lens' SamplingRuleUpdate (Maybe Text)
samplingRuleUpdate_priority :: Lens' SamplingRuleUpdate (Maybe Int)
samplingRuleUpdate_reservoirSize :: Lens' SamplingRuleUpdate (Maybe Int)
samplingRuleUpdate_resourceARN :: Lens' SamplingRuleUpdate (Maybe Text)
samplingRuleUpdate_ruleARN :: Lens' SamplingRuleUpdate (Maybe Text)
samplingRuleUpdate_ruleName :: Lens' SamplingRuleUpdate (Maybe Text)
samplingRuleUpdate_serviceName :: Lens' SamplingRuleUpdate (Maybe Text)
samplingRuleUpdate_serviceType :: Lens' SamplingRuleUpdate (Maybe Text)
samplingRuleUpdate_uRLPath :: Lens' SamplingRuleUpdate (Maybe Text)

Documentation

data SamplingRuleUpdate Source #

A document specifying changes to a sampling rule's configuration.

See: newSamplingRuleUpdate smart constructor.

Constructors

SamplingRuleUpdate'

Fields

attributes :: Maybe (HashMap Text Text)
Matches attributes derived from the request.
fixedRate :: Maybe Double
The percentage of matching requests to instrument, after the reservoir is exhausted.
hTTPMethod :: Maybe Text
Matches the HTTP method of a request.
host :: Maybe Text
Matches the hostname from a request URL.
priority :: Maybe Int
The priority of the sampling rule.
reservoirSize :: Maybe Int
A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
resourceARN :: Maybe Text
Matches the ARN of the Amazon Web Services resource on which the service runs.
ruleARN :: Maybe Text
The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
ruleName :: Maybe Text
The name of the sampling rule. Specify a rule by either name or ARN, but not both.
serviceName :: Maybe Text
Matches the name that the service uses to identify itself in segments.
serviceType :: Maybe Text
Matches the origin that the service uses to identify its type in segments.
uRLPath :: Maybe Text
Matches the path from a request URL.

Instances

Instances details

ToJSON SamplingRuleUpdate Source #
Instance details Defined in Amazonka.XRay.Types.SamplingRuleUpdate Methods toJSON :: SamplingRuleUpdate -> Value # toEncoding :: SamplingRuleUpdate -> Encoding # toJSONList :: [SamplingRuleUpdate] -> Value # toEncodingList :: [SamplingRuleUpdate] -> Encoding #
Generic SamplingRuleUpdate Source #
Instance details Defined in Amazonka.XRay.Types.SamplingRuleUpdate Associated Types type Rep SamplingRuleUpdate :: Type -> Type # Methods from :: SamplingRuleUpdate -> Rep SamplingRuleUpdate x # to :: Rep SamplingRuleUpdate x -> SamplingRuleUpdate #
Read SamplingRuleUpdate Source #
Instance details Defined in Amazonka.XRay.Types.SamplingRuleUpdate Methods readsPrec :: Int -> ReadS SamplingRuleUpdate # readList :: ReadS [SamplingRuleUpdate] # readPrec :: ReadPrec SamplingRuleUpdate # readListPrec :: ReadPrec [SamplingRuleUpdate] #
Show SamplingRuleUpdate Source #
Instance details Defined in Amazonka.XRay.Types.SamplingRuleUpdate Methods showsPrec :: Int -> SamplingRuleUpdate -> ShowS # show :: SamplingRuleUpdate -> String # showList :: [SamplingRuleUpdate] -> ShowS #
NFData SamplingRuleUpdate Source #
Instance details Defined in Amazonka.XRay.Types.SamplingRuleUpdate Methods rnf :: SamplingRuleUpdate -> () #
Eq SamplingRuleUpdate Source #
Instance details Defined in Amazonka.XRay.Types.SamplingRuleUpdate Methods (==) :: SamplingRuleUpdate -> SamplingRuleUpdate -> Bool # (/=) :: SamplingRuleUpdate -> SamplingRuleUpdate -> Bool #
Hashable SamplingRuleUpdate Source #
Instance details Defined in Amazonka.XRay.Types.SamplingRuleUpdate Methods hashWithSalt :: Int -> SamplingRuleUpdate -> Int # hash :: SamplingRuleUpdate -> Int #
type Rep SamplingRuleUpdate Source #
Instance details Defined in Amazonka.XRay.Types.SamplingRuleUpdate type Rep SamplingRuleUpdate = D1 ('MetaData "SamplingRuleUpdate" "Amazonka.XRay.Types.SamplingRuleUpdate" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "SamplingRuleUpdate'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "fixedRate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: S1 ('MetaSel ('Just "hTTPMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "reservoirSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :: ((S1 ('MetaSel ('Just "resourceARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "ruleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "ruleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "serviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "serviceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "uRLPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newSamplingRuleUpdate :: SamplingRuleUpdate Source #

Create a value of SamplingRuleUpdate 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:attributes:SamplingRuleUpdate', samplingRuleUpdate_attributes - Matches attributes derived from the request.

$sel:fixedRate:SamplingRuleUpdate', samplingRuleUpdate_fixedRate - The percentage of matching requests to instrument, after the reservoir is exhausted.

$sel:hTTPMethod:SamplingRuleUpdate', samplingRuleUpdate_hTTPMethod - Matches the HTTP method of a request.

$sel:host:SamplingRuleUpdate', samplingRuleUpdate_host - Matches the hostname from a request URL.

$sel:priority:SamplingRuleUpdate', samplingRuleUpdate_priority - The priority of the sampling rule.

$sel:reservoirSize:SamplingRuleUpdate', samplingRuleUpdate_reservoirSize - A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.

$sel:resourceARN:SamplingRuleUpdate', samplingRuleUpdate_resourceARN - Matches the ARN of the Amazon Web Services resource on which the service runs.

$sel:ruleARN:SamplingRuleUpdate', samplingRuleUpdate_ruleARN - The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

$sel:ruleName:SamplingRuleUpdate', samplingRuleUpdate_ruleName - The name of the sampling rule. Specify a rule by either name or ARN, but not both.

$sel:serviceName:SamplingRuleUpdate', samplingRuleUpdate_serviceName - Matches the name that the service uses to identify itself in segments.

$sel:serviceType:SamplingRuleUpdate', samplingRuleUpdate_serviceType - Matches the origin that the service uses to identify its type in segments.

$sel:uRLPath:SamplingRuleUpdate', samplingRuleUpdate_uRLPath - Matches the path from a request URL.

samplingRuleUpdate_attributes :: Lens' SamplingRuleUpdate (Maybe (HashMap Text Text)) Source #

Matches attributes derived from the request.

samplingRuleUpdate_fixedRate :: Lens' SamplingRuleUpdate (Maybe Double) Source #

The percentage of matching requests to instrument, after the reservoir is exhausted.

samplingRuleUpdate_hTTPMethod :: Lens' SamplingRuleUpdate (Maybe Text) Source #

Matches the HTTP method of a request.

samplingRuleUpdate_host :: Lens' SamplingRuleUpdate (Maybe Text) Source #

Matches the hostname from a request URL.

samplingRuleUpdate_priority :: Lens' SamplingRuleUpdate (Maybe Int) Source #

The priority of the sampling rule.

samplingRuleUpdate_reservoirSize :: Lens' SamplingRuleUpdate (Maybe Int) Source #

A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.

samplingRuleUpdate_resourceARN :: Lens' SamplingRuleUpdate (Maybe Text) Source #

Matches the ARN of the Amazon Web Services resource on which the service runs.

samplingRuleUpdate_ruleARN :: Lens' SamplingRuleUpdate (Maybe Text) Source #

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

samplingRuleUpdate_ruleName :: Lens' SamplingRuleUpdate (Maybe Text) Source #

The name of the sampling rule. Specify a rule by either name or ARN, but not both.

samplingRuleUpdate_serviceName :: Lens' SamplingRuleUpdate (Maybe Text) Source #

Matches the name that the service uses to identify itself in segments.

samplingRuleUpdate_serviceType :: Lens' SamplingRuleUpdate (Maybe Text) Source #

Matches the origin that the service uses to identify its type in segments.

samplingRuleUpdate_uRLPath :: Lens' SamplingRuleUpdate (Maybe Text) Source #

Matches the path from a request URL.