Class: Aws::BedrockAgentCoreControl::Types::CreatePolicyEngineRequest

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentCoreControl::Types::CreatePolicyEngineRequest

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 that you provide to ensure the idempotency of the request.

• #description ⇒ String

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

• #encryption_key_arn ⇒ String

  The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.

• #name ⇒ String

  The customer-assigned immutable name for the policy engine.

• #tags ⇒ Hash<String,String>

  A map of tag keys and values to assign to an AgentCore Policy.

Instance Attribute Details

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request with the same client token, the service returns the same response without creating a duplicate policy engine.

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 3327

class CreatePolicyEngineRequest < Struct.new(
  :name,
  :description,
  :client_token,
  :encryption_key_arn,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#description ⇒ String

A human-readable description of the policy engine's purpose and scope (1-4,096 characters). This helps administrators understand the policy engine's role in the overall governance strategy. Document which Gateway this engine will be associated with, what types of tools or workflows it governs, and the team or service responsible for maintaining it. Clear descriptions are essential when managing multiple policy engines across different services or environments.

Returns:

• (String)

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

class CreatePolicyEngineRequest < Struct.new(
  :name,
  :description,
  :client_token,
  :encryption_key_arn,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#encryption_key_arn ⇒ String

The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.

Returns:

• (String)

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

class CreatePolicyEngineRequest < Struct.new(
  :name,
  :description,
  :client_token,
  :encryption_key_arn,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#name ⇒ String

The customer-assigned immutable name for the policy engine. This name identifies the policy engine and cannot be changed after creation.

Returns:

• (String)

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

class CreatePolicyEngineRequest < Struct.new(
  :name,
  :description,
  :client_token,
  :encryption_key_arn,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A map of tag keys and values to assign to an AgentCore Policy. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

Returns:

• (Hash<String,String>)

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

class CreatePolicyEngineRequest < Struct.new(
  :name,
  :description,
  :client_token,
  :encryption_key_arn,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end