Class: Aws::EventBridgeV2::Types::PutResourcePolicyRequest

Inherits:

Struct

• Object
• Struct
• Aws::EventBridgeV2::Types::PutResourcePolicyRequest

Defined in:

gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #expected_revision_id ⇒ String

  The write succeeds only if the named policy's current revision ID matches this value; a policy that does not exist yet matches only the sentinel "NO_POLICY" (create-only).

• #policy_document ⇒ String

  A resource policy document, as a JSON string.

• #policy_name ⇒ String

  Which named policy to write.

• #resource_arn ⇒ String

  The Amazon Resource Name (ARN) that uniquely identifies an event bus.

Instance Attribute Details

#expected_revision_id ⇒ String

The write succeeds only if the named policy's current revision ID matches this value; a policy that does not exist yet matches only the sentinel "NO_POLICY" (create-only). On mismatch the operation fails with ConflictException. When omitted, the write is unconditional. Every attempt stores a newly generated revision ID, so retrying an unanswered request can conflict with the caller's own earlier attempt; read the policy back and compare it with the one you intended before treating a conflict as another writer's change.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 2240

class PutResourcePolicyRequest < Struct.new(
  :resource_arn,
  :policy_document,
  :policy_name,
  :expected_revision_id)
  SENSITIVE = []
  include Aws::Structure
end

#policy_document ⇒ String

A resource policy document, as a JSON string. The "default" policy can be up to 20 KB (20,480 bytes of UTF-8) by default. This quota is adjustable in Service Quotas. A "default" policy that exceeds the quota is rejected with PolicyLengthExceededException. No policy document can exceed 389,120 bytes of UTF-8, regardless of the quota.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 2240

class PutResourcePolicyRequest < Struct.new(
  :resource_arn,
  :policy_document,
  :policy_name,
  :expected_revision_id)
  SENSITIVE = []
  include Aws::Structure
end

#policy_name ⇒ String

Which named policy to write. Defaults to "default", the customer-managed policy, when omitted (a write AWS Resource Access Manager makes on the owner's behalf resolves to "AWS_RAM" instead). The two writers are exclusive in both directions — only Resource Access Manager can write "AWS_RAM", and only the bus owner can write "default" — so naming the other party's policy fails with AccessDeniedException. A well-formed name that is neither of the two fails with InvalidInputException.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 2240

class PutResourcePolicyRequest < Struct.new(
  :resource_arn,
  :policy_document,
  :policy_name,
  :expected_revision_id)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arn ⇒ String

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 2240

class PutResourcePolicyRequest < Struct.new(
  :resource_arn,
  :policy_document,
  :policy_name,
  :expected_revision_id)
  SENSITIVE = []
  include Aws::Structure
end