PutDestinationPolicyCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { CloudWatchLogsClient, PutDestinationPolicyCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import
// const { CloudWatchLogsClient, PutDestinationPolicyCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
const client = new CloudWatchLogsClient(config);
const input = { // PutDestinationPolicyRequest
  destinationName: "STRING_VALUE", // required
  accessPolicy: "STRING_VALUE", // required
  forceUpdate: true || false,
};
const command = new PutDestinationPolicyCommand(input);
const response = await client.send(command);
// {};

PutDestinationPolicyCommand Input

See PutDestinationPolicyCommandInput for more details

Parameter
Type
Description
accessPolicy
Required
string | undefined

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.

destinationName
Required
string | undefined

A name for an existing destination.

forceUpdate
boolean | undefined

Specify true if you are updating an existing destination policy to grant permission to an organization ID instead of granting permission to individual Amazon Web Services 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.

PutDestinationPolicyCommand Output

See PutDestinationPolicyCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
InvalidParameterException
client

A parameter is specified incorrectly.

OperationAbortedException
client

Multiple concurrent requests to update the same resource were in conflict.

ServiceUnavailableException
server

The service cannot complete the request.

CloudWatchLogsServiceException
Base exception class for all service exceptions from CloudWatchLogs service.