Class: Aws::XRay::Types::PutResourcePolicyRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bypass_policy_lockout_check ⇒ Boolean

A flag to indicate whether to bypass the resource policy lockout safety check.

Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true indiscriminately.

Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent ‘PutResourcePolicy` request.

The default value is false.

Returns:

  • (Boolean) 


2327
2328
2329
2330
2331
2332
2333
2334
 
# File 'lib/aws-sdk-xray/types.rb', line 2327

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

#policy_document ⇒ String

The resource policy document, which can be up to 5kb in size.

Returns:

  • (String) 


2327
2328
2329
2330
2331
2332
2333
2334
 
# File 'lib/aws-sdk-xray/types.rb', line 2327

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

#policy_name ⇒ String

The name of the resource policy. Must be unique within a specific Amazon Web Services account.

Returns:

  • (String) 


2327
2328
2329
2330
2331
2332
2333
2334
 
# File 'lib/aws-sdk-xray/types.rb', line 2327

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

#policy_revision_id ⇒ String

Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy is created if it does not exist, or updated with an incremented revision id. The revision id is unique to each policy in the account.

If the policy revision id does not match the latest revision id, the operation will fail with an ‘InvalidPolicyRevisionIdException` exception. You can also provide a `PolicyRevisionId` of 0. In this case, the operation will fail with an `InvalidPolicyRevisionIdException` exception if a resource policy with the same name already exists.

Returns:

  • (String) 


2327
2328
2329
2330
2331
2332
2333
2334
 
# File 'lib/aws-sdk-xray/types.rb', line 2327

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