Class: Aws::CloudWatchLogs::Types::PutDestinationPolicyRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudwatchlogs/types.rb

Overview

Note:

When making an API call, you may pass PutDestinationPolicyRequest data as a hash:

{
  destination_name: "DestinationName", # required
  access_policy: "AccessPolicy", # required
  force_update: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_policyString

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.

Returns:

  • (String)

2032
2033
2034
2035
2036
2037
2038
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 2032

class PutDestinationPolicyRequest < Struct.new(
  :destination_name,
  :access_policy,
  :force_update)
  SENSITIVE = []
  include Aws::Structure
end

#destination_nameString

A name for an existing destination.

Returns:

  • (String)

2032
2033
2034
2035
2036
2037
2038
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 2032

class PutDestinationPolicyRequest < Struct.new(
  :destination_name,
  :access_policy,
  :force_update)
  SENSITIVE = []
  include Aws::Structure
end

#force_updateBoolean

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.

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Cross-Account-Log_Subscription-Update.html

Returns:

  • (Boolean)

2032
2033
2034
2035
2036
2037
2038
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 2032

class PutDestinationPolicyRequest < Struct.new(
  :destination_name,
  :access_policy,
  :force_update)
  SENSITIVE = []
  include Aws::Structure
end