Class: Anthropic::Models::Organization::ExternalKey

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/anthropic/models/organization/external_key.rb,
sig/anthropic/models/organization/external_key.rbs

Overview

See Also:

  • Anthropic::Resources::Organization::ExternalKeys#create

Defined Under Namespace

Modules: Attachment, ProviderConfig

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, attachment:, created_at:, display_name:, geo:, provider_config:, updated_at:, type: :external_key) ⇒ void

CMEK external key config belonging to the caller's organization.

Configs are organization-scoped. Workspaces attach to a config; once any workspace references it, the provider fields become effectively immutable (existing encrypted data needs the config for decrypt).

Some parameter documentations has been truncated, see Anthropic::Models::Organization::ExternalKey for more details.

Parameters:




# File 'lib/anthropic/models/organization/external_key.rb', line 58

Instance Attribute Details

#attachment ⇒ Anthropic::Models::Organization::ExternalKeyAttachedAttachment, Anthropic::Models::Organization::ExternalKeyUnattachedAttachment

Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an unattached config is inert and can be deleted.

Parameters:

  • value (Anthropic::Models::Organization::ExternalKey::attachment)

Returns:



22
 
# File 'lib/anthropic/models/organization/external_key.rb', line 22

required :attachment, union: -> { Anthropic::Organization::ExternalKey::Attachment }

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


27
 
# File 'lib/anthropic/models/organization/external_key.rb', line 27

required :created_at, Time

#display_name ⇒ String?

Human-friendly display name. Null if none was set.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


33
 
# File 'lib/anthropic/models/organization/external_key.rb', line 33

required :display_name, String, nil?: true

#geo ⇒ String

Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips.

Parameters:

  • value (String)

Returns:

  • (String) 


40
 
# File 'lib/anthropic/models/organization/external_key.rb', line 40

required :geo, String

#id ⇒ String

Identifier of the external key config. A tagged ID prefixed ekey_, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN.

Parameters:

  • value (String)

Returns:

  • (String) 


13
 
# File 'lib/anthropic/models/organization/external_key.rb', line 13

required :id, String

#provider_config ⇒ Anthropic::Models::Organization::AWSExternalKeyConfig, ...

KMS provider identity and auth coordinates.

Parameters:

  • value (Anthropic::Models::Organization::ExternalKey::provider_config)

Returns:



46
 
# File 'lib/anthropic/models/organization/external_key.rb', line 46

required :provider_config, union: -> { Anthropic::Organization::ExternalKey::ProviderConfig }

#type ⇒ Symbol, :external_key

Parameters:

  • value (:external_key)

Returns:

  • (Symbol, :external_key) 


51
 
# File 'lib/anthropic/models/organization/external_key.rb', line 51

required :type, const: :external_key

#updated_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


56
 
# File 'lib/anthropic/models/organization/external_key.rb', line 56

required :updated_at, Time

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


44
 
# File 'sig/anthropic/models/organization/external_key.rbs', line 44

def to_hash: -> {