Class: Aws::BedrockAgentCoreControl::Types::CreatePolicyRequest

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentCoreControl::Types::CreatePolicyRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:description]

Instance Attribute Summary

• #client_token ⇒ String

  A unique, case-sensitive identifier to ensure the idempotency of the request.

• #definition ⇒ Types::PolicyDefinition

  The Cedar policy statement that defines the access control rules.

• #description ⇒ String

  A human-readable description of the policy's purpose and functionality (1-4,096 characters).

• #name ⇒ String

  The customer-assigned immutable name for the policy.

• #policy_engine_id ⇒ String

  The identifier of the policy engine which contains this policy.

• #validation_mode ⇒ String

  The validation mode for the policy creation.

Instance Attribute Details

#client_token ⇒ String

A unique, case-sensitive identifier to ensure the idempotency of the request. The AWS SDK automatically generates this token, so you don't need to provide it in most cases. If you retry a request with the same client token, the service returns the same response without creating a duplicate policy.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 3457

class CreatePolicyRequest < Struct.new(
  :name,
  :definition,
  :description,
  :validation_mode,
  :policy_engine_id,
  :client_token)
  SENSITIVE = [:description]
  include Aws::Structure
end

#definition ⇒ Types::PolicyDefinition

The Cedar policy statement that defines the access control rules. This contains the actual policy logic written in Cedar policy language, specifying effect (permit or forbid), principals, actions, resources, and conditions for agent behavior control.

Returns:

• (Types::PolicyDefinition)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 3457

class CreatePolicyRequest < Struct.new(
  :name,
  :definition,
  :description,
  :validation_mode,
  :policy_engine_id,
  :client_token)
  SENSITIVE = [:description]
  include Aws::Structure
end

#description ⇒ String

A human-readable description of the policy's purpose and functionality (1-4,096 characters). This helps policy administrators understand the policy's intent, business rules, and operational scope. Use this field to document why the policy exists, what business requirement it addresses, and any special considerations for maintenance. Clear descriptions are essential for policy governance, auditing, and troubleshooting.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 3457

class CreatePolicyRequest < Struct.new(
  :name,
  :definition,
  :description,
  :validation_mode,
  :policy_engine_id,
  :client_token)
  SENSITIVE = [:description]
  include Aws::Structure
end

#name ⇒ String

The customer-assigned immutable name for the policy. Must be unique within the account. This name is used for policy identification and cannot be changed after creation.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 3457

class CreatePolicyRequest < Struct.new(
  :name,
  :definition,
  :description,
  :validation_mode,
  :policy_engine_id,
  :client_token)
  SENSITIVE = [:description]
  include Aws::Structure
end

#policy_engine_id ⇒ String

The identifier of the policy engine which contains this policy. Policy engines group related policies and provide the execution context for policy evaluation.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 3457

class CreatePolicyRequest < Struct.new(
  :name,
  :definition,
  :description,
  :validation_mode,
  :policy_engine_id,
  :client_token)
  SENSITIVE = [:description]
  include Aws::Structure
end

#validation_mode ⇒ String

The validation mode for the policy creation. Determines how Cedar analyzer validation results are handled during policy creation. FAIL_ON_ANY_FINDINGS (default) runs the Cedar analyzer to validate the policy against the Cedar schema and tool context, failing creation if the analyzer detects any validation issues to ensure strict conformance. IGNORE_ALL_FINDINGS runs the Cedar analyzer but allows policy creation even if validation issues are detected, useful for testing or when the policy schema is evolving. Use FAIL_ON_ANY_FINDINGS for production policies to ensure correctness, and IGNORE_ALL_FINDINGS only when you understand and accept the analyzer findings.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 3457

class CreatePolicyRequest < Struct.new(
  :name,
  :definition,
  :description,
  :validation_mode,
  :policy_engine_id,
  :client_token)
  SENSITIVE = [:description]
  include Aws::Structure
end