Class: AWSCDK::BedrockAgentCore::APIKeyCredentialProvider

Inherits:
Resource
  • Object
show all
Includes:
IAPIKeyCredentialProvider
Defined in:
bedrock_agent_core/api_key_credential_provider.rb

Overview

L2 construct for AWS::BedrockAgentCore::ApiKeyCredentialProvider.

Use this to register an API key identity in AgentCore Token Vault. To attach the identity to a gateway target, use {@link GatewayCredentialProvider.fromApiKeyIdentity } with this construct, or ApiKeyCredentialProvider.bindForGatewayApiKeyTarget with {@link GatewayCredentialProvider.fromApiKeyIdentityArn }.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ APIKeyCredentialProvider

Returns a new instance of APIKeyCredentialProvider.

Parameters:



18
19
20
21
22
23
24
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 18

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::APIKeyCredentialProviderProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5BcGlLZXlDcmVkZW50aWFsUHJvdmlkZXJQcm9wcyJ9")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_api_key_credential_provider_attributes(scope, id, attrs) ⇒ AWSCDK::BedrockAgentCore::IAPIKeyCredentialProvider

Import an existing API key credential provider.

Parameters:

Returns:



61
62
63
64
65
66
67
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 61

def self.from_api_key_credential_provider_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::APIKeyCredentialProviderAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5BcGlLZXlDcmVkZW50aWFsUHJvdmlkZXJBdHRyaWJ1dGVzIn0=")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrockagentcore.ApiKeyCredentialProvider", "fromApiKeyCredentialProviderAttributes", [scope, id, attrs])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :api_key_credential_provider_name => { kind: :property, name: "apiKeyCredentialProviderName", is_optional: false },
    :api_key_credential_provider_ref => { kind: :property, name: "apiKeyCredentialProviderRef", is_optional: false },
    :credential_provider_arn => { kind: :property, name: "credentialProviderArn", is_optional: false },
    :grant_principal => { kind: :property, name: "grantPrincipal", is_optional: false },
    :api_key_secret_arn => { kind: :property, name: "apiKeySecretArn", is_optional: true },
    :created_time => { kind: :property, name: "createdTime", is_optional: true },
    :last_updated_time => { kind: :property, name: "lastUpdatedTime", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :bind_for_gateway_api_key_target => { kind: :method, name: "bindForGatewayApiKeyTarget", is_optional: false },
    :grant => { kind: :method, name: "grant", is_optional: false },
    :grant_admin => { kind: :method, name: "grantAdmin", is_optional: false },
    :grant_full_access => { kind: :method, name: "grantFullAccess", is_optional: false },
    :grant_read => { kind: :method, name: "grantRead", is_optional: false },
    :grant_use => { kind: :method, name: "grantUse", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


115
116
117
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 115

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_bedrockagentcore.ApiKeyCredentialProvider", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#api_key_credential_provider_name ⇒ String

The name of this API key credential provider.

Returns:

  • (String) 


122
123
124
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 122

def api_key_credential_provider_name()
  jsii_get_property("apiKeyCredentialProviderName")
end

#api_key_credential_provider_ref ⇒ AWSCDK::Interfaces::AWSBedrockagentcore::APIKeyCredentialProviderReference

A reference to a ApiKeyCredentialProvider resource.

Returns:



129
130
131
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 129

def api_key_credential_provider_ref()
  jsii_get_property("apiKeyCredentialProviderRef")
end

#api_key_secret_arn ⇒ String?

The ARN of the Secrets Manager secret that stores the API key after the resource is created.

May be undefined for resources imported without this attribute.

Returns:

  • (String, nil) 


152
153
154
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 152

def api_key_secret_arn()
  jsii_get_property("apiKeySecretArn")
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



203
204
205
206
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 203

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



220
221
222
223
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 220

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#bind_for_gateway_api_key_target ⇒ AWSCDK::BedrockAgentCore::GatewayAPIKeyIdentityBinding

ARNs for {@link GatewayCredentialProvider.fromApiKeyIdentity } / {@link GatewayCredentialProvider.fromApiKeyIdentityArn }.

Returns:



263
264
265
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 263

def bind_for_gateway_api_key_target()
  jsii_call_method("bindForGatewayApiKeyTarget", [])
end

#created_time ⇒ String?

Timestamp when the credential provider was created.

Returns:

  • (String, nil) 


159
160
161
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 159

def created_time()
  jsii_get_property("createdTime")
end

#credential_provider_arn ⇒ String

The ARN of this credential provider.

Returns:

  • (String) 


136
137
138
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 136

def credential_provider_arn()
  jsii_get_property("credentialProviderArn")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



87
88
89
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 87

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


226
227
228
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 226

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


240
241
242
243
244
245
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 240

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


255
256
257
258
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 255

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#grant(grantee, *actions) ⇒ AWSCDK::IAM::Grant

[disable-awslint:no-grants].

Parameters:

Returns:



272
273
274
275
276
277
278
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 272

def grant(grantee, *actions)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  actions.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actions[#{index}]")
  end
  jsii_call_method("grant", [grantee, *actions])
end

#grant_admin(grantee) ⇒ AWSCDK::IAM::Grant

[disable-awslint:no-grants].

Parameters:

Returns:



284
285
286
287
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 284

def grant_admin(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantAdmin", [grantee])
end

#grant_full_access(grantee) ⇒ AWSCDK::IAM::Grant

[disable-awslint:no-grants].

Parameters:

Returns:



293
294
295
296
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 293

def grant_full_access(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantFullAccess", [grantee])
end

#grant_principal ⇒ AWSCDK::IAM::IPrincipal

The principal to grant permissions to.

Returns:



143
144
145
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 143

def grant_principal()
  jsii_get_property("grantPrincipal")
end

#grant_read(grantee) ⇒ AWSCDK::IAM::Grant

[disable-awslint:no-grants].

Parameters:

Returns:



302
303
304
305
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 302

def grant_read(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantRead", [grantee])
end

#grant_use(grantee) ⇒ AWSCDK::IAM::Grant

[disable-awslint:no-grants].

Parameters:

Returns:



311
312
313
314
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 311

def grant_use(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantUse", [grantee])
end

#last_updated_time ⇒ String?

Timestamp when the credential provider was last updated.

Returns:

  • (String, nil) 


166
167
168
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 166

def last_updated_time()
  jsii_get_property("lastUpdatedTime")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


72
73
74
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 72

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


101
102
103
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 101

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



108
109
110
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 108

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


173
174
175
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 173

def to_string()
  jsii_call_method("toString", [])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


186
187
188
189
190
191
 
# File 'bedrock_agent_core/api_key_credential_provider.rb', line 186

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end