Class: AWSCDK::BedrockAgentCore::CfnAPIKeyCredentialProviderProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
bedrock_agent_core/cfn_api_key_credential_provider_props.rb

Overview

Properties for defining a CfnApiKeyCredentialProvider.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, api_key: nil, api_key_secret_config: nil, api_key_secret_source: nil, tags: nil) ⇒ CfnAPIKeyCredentialProviderProps

Returns a new instance of CfnAPIKeyCredentialProviderProps.

Parameters:

  • name (String) —

    The name of the API key credential provider.

  • api_key (String, nil) (defaults to: nil) —

    The API key to use for authentication.

  • api_key_secret_config (AWSCDK::IResolvable, AWSCDK::BedrockAgentCore::CfnAPIKeyCredentialProvider::SecretReferenceProperty, nil) (defaults to: nil) —

    A reference to a customer-provided secret stored in AWS Secrets Manager.

  • api_key_secret_source (String, nil) (defaults to: nil) —

    The source of the API key secret.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    Tags to assign to the API key credential provider.



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'bedrock_agent_core/cfn_api_key_credential_provider_props.rb', line 14

def initialize(name:, api_key: nil, api_key_secret_config: nil, api_key_secret_source: nil, tags: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @api_key = api_key
  Jsii::Type.check_type(@api_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiKey") unless @api_key.nil?
  @api_key_secret_config = api_key_secret_config.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::CfnAPIKeyCredentialProvider::SecretReferenceProperty.new(**api_key_secret_config.transform_keys(&:to_sym)) : api_key_secret_config
  Jsii::Type.check_type(@api_key_secret_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrYWdlbnRjb3JlLkNmbkFwaUtleUNyZWRlbnRpYWxQcm92aWRlci5TZWNyZXRSZWZlcmVuY2VQcm9wZXJ0eSJ9XX19")), "apiKeySecretConfig") unless @api_key_secret_config.nil?
  @api_key_secret_source = api_key_secret_source
  Jsii::Type.check_type(@api_key_secret_source, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiKeySecretSource") unless @api_key_secret_source.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#api_key ⇒ String? (readonly)

The API key to use for authentication.

Returns:

  • (String, nil)

See Also:



36
37
38
 
# File 'bedrock_agent_core/cfn_api_key_credential_provider_props.rb', line 36

def api_key
  @api_key
end

#api_key_secret_config ⇒ AWSCDK::IResolvable, ... (readonly)

A reference to a customer-provided secret stored in AWS Secrets Manager.

Returns:

See Also:



41
42
43
 
# File 'bedrock_agent_core/cfn_api_key_credential_provider_props.rb', line 41

def api_key_secret_config
  @api_key_secret_config
end

#api_key_secret_source ⇒ String? (readonly)

The source of the API key secret.

Use MANAGED for service-managed secrets or EXTERNAL for customer-provided secrets.

Returns:

  • (String, nil)

See Also:



48
49
50
 
# File 'bedrock_agent_core/cfn_api_key_credential_provider_props.rb', line 48

def api_key_secret_source
  @api_key_secret_source
end

#name ⇒ String (readonly)

The name of the API key credential provider.

Returns:

  • (String)

See Also:



31
32
33
 
# File 'bedrock_agent_core/cfn_api_key_credential_provider_props.rb', line 31

def name
  @name
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

Tags to assign to the API key credential provider.

Returns:

See Also:



53
54
55
 
# File 'bedrock_agent_core/cfn_api_key_credential_provider_props.rb', line 53

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



55
56
57
58
59
60
61
62
63
 
# File 'bedrock_agent_core/cfn_api_key_credential_provider_props.rb', line 55

def self.jsii_properties
  {
    :name => "name",
    :api_key => "apiKey",
    :api_key_secret_config => "apiKeySecretConfig",
    :api_key_secret_source => "apiKeySecretSource",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
 
# File 'bedrock_agent_core/cfn_api_key_credential_provider_props.rb', line 65

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "apiKey" => @api_key,
    "apiKeySecretConfig" => @api_key_secret_config,
    "apiKeySecretSource" => @api_key_secret_source,
    "tags" => @tags,
  })
  result.compact
end