amazonka-cloudwatch-logs-2.0: Amazon CloudWatch Logs SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudWatchLogs.PutDestinationPolicy

Description

Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination.

Synopsis

Creating a Request

data PutDestinationPolicy Source #

See: newPutDestinationPolicy smart constructor.

Constructors

PutDestinationPolicy' 

Fields

  • forceUpdate :: Maybe Bool

    Specify true if you are updating an existing destination policy to grant permission to an organization ID instead of granting permission to individual AWS accounts. Before you update a destination policy this way, you must first update the subscription filters in the accounts that send logs to this destination. If you do not, the subscription filters might stop working. By specifying true for forceUpdate, you are affirming that you have already updated the subscription filters. For more information, see Updating an existing cross-account subscription

    If you omit this parameter, the default of false is used.

  • destinationName :: Text

    A name for an existing destination.

  • accessPolicy :: Text

    An IAM policy document that authorizes cross-account users to deliver their log events to the associated destination. This can be up to 5120 bytes.

Instances

Instances details
ToJSON PutDestinationPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutDestinationPolicy

ToHeaders PutDestinationPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutDestinationPolicy

ToPath PutDestinationPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutDestinationPolicy

ToQuery PutDestinationPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutDestinationPolicy

AWSRequest PutDestinationPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutDestinationPolicy

Associated Types

type AWSResponse PutDestinationPolicy #

Generic PutDestinationPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutDestinationPolicy

Associated Types

type Rep PutDestinationPolicy :: Type -> Type #

Read PutDestinationPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutDestinationPolicy

Show PutDestinationPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutDestinationPolicy

NFData PutDestinationPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutDestinationPolicy

Methods

rnf :: PutDestinationPolicy -> () #

Eq PutDestinationPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutDestinationPolicy

Hashable PutDestinationPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutDestinationPolicy

type AWSResponse PutDestinationPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutDestinationPolicy

type Rep PutDestinationPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutDestinationPolicy

type Rep PutDestinationPolicy = D1 ('MetaData "PutDestinationPolicy" "Amazonka.CloudWatchLogs.PutDestinationPolicy" "amazonka-cloudwatch-logs-2.0-6gvDalNFsfE8djZ4aTfA4V" 'False) (C1 ('MetaCons "PutDestinationPolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "forceUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "destinationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "accessPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newPutDestinationPolicy Source #

Create a value of PutDestinationPolicy 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:forceUpdate:PutDestinationPolicy', putDestinationPolicy_forceUpdate - Specify true if you are updating an existing destination policy to grant permission to an organization ID instead of granting permission to individual AWS accounts. Before you update a destination policy this way, you must first update the subscription filters in the accounts that send logs to this destination. If you do not, the subscription filters might stop working. By specifying true for forceUpdate, you are affirming that you have already updated the subscription filters. For more information, see Updating an existing cross-account subscription

If you omit this parameter, the default of false is used.

PutDestinationPolicy, putDestinationPolicy_destinationName - A name for an existing destination.

PutDestinationPolicy, putDestinationPolicy_accessPolicy - An IAM policy document that authorizes cross-account users to deliver their log events to the associated destination. This can be up to 5120 bytes.

Request Lenses

putDestinationPolicy_forceUpdate :: Lens' PutDestinationPolicy (Maybe Bool) Source #

Specify true if you are updating an existing destination policy to grant permission to an organization ID instead of granting permission to individual AWS accounts. Before you update a destination policy this way, you must first update the subscription filters in the accounts that send logs to this destination. If you do not, the subscription filters might stop working. By specifying true for forceUpdate, you are affirming that you have already updated the subscription filters. For more information, see Updating an existing cross-account subscription

If you omit this parameter, the default of false is used.

putDestinationPolicy_accessPolicy :: Lens' PutDestinationPolicy Text Source #

An IAM policy document that authorizes cross-account users to deliver their log events to the associated destination. This can be up to 5120 bytes.

Destructuring the Response

data PutDestinationPolicyResponse Source #

See: newPutDestinationPolicyResponse smart constructor.

Instances

Instances details
Generic PutDestinationPolicyResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutDestinationPolicy

Associated Types

type Rep PutDestinationPolicyResponse :: Type -> Type #

Read PutDestinationPolicyResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutDestinationPolicy

Show PutDestinationPolicyResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutDestinationPolicy

NFData PutDestinationPolicyResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutDestinationPolicy

Eq PutDestinationPolicyResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutDestinationPolicy

type Rep PutDestinationPolicyResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutDestinationPolicy

type Rep PutDestinationPolicyResponse = D1 ('MetaData "PutDestinationPolicyResponse" "Amazonka.CloudWatchLogs.PutDestinationPolicy" "amazonka-cloudwatch-logs-2.0-6gvDalNFsfE8djZ4aTfA4V" 'False) (C1 ('MetaCons "PutDestinationPolicyResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPutDestinationPolicyResponse :: PutDestinationPolicyResponse Source #

Create a value of PutDestinationPolicyResponse with all optional fields omitted.

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