APIKeyCredentialProvider
bedrockagentcorecontrol.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | bedrockagentcorecontrol-controller/apis/v1alpha1#APIKeyCredentialProvider |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | APIKeyCredentialProvider |
| ListKind | APIKeyCredentialProviderList |
| Plural | apikeycredentialproviders |
| Singular | apikeycredentialprovider |
Spec
apiKey:
key: string
name: string
namespace: string
name: string
tags: {}
| Field | Description |
|---|---|
| apiKey Required | object The API key to use for authentication. This value is encrypted and stored securely. |
| apiKey.key Required | string Key is the key within the secret |
| apiKey.name Optional | string name is unique within a namespace to reference a secret resource. |
| apiKey.namespace Optional | string namespace defines the space within which the secret name must be unique. |
| name Required | string The name of the API key credential provider. The name must be unique within your account. Regex Pattern: ^[a-zA-Z0-9\-_]+$ |
| tags Optional | object A map of tag keys and values to assign to the API key credential provider. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
partition: string
region: string
apiKeySecretARN:
secretARN: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.partition Optional | string Partition is the AWS partition in which the resource exists or will exist |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| apiKeySecretARN Optional | object The Amazon Resource Name (ARN) of the secret containing the API key. |
| apiKeySecretARN.secretARN Optional | string |
| conditions Optional | array All CRs managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
| controllers to indicate terminal states of the CR and its backend AWS | |
| service API resource | |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |