Skip to content
v2.277.0

Experimental

@aws-cdk/aws-bedrock-agentcore-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

ApiKeyCredentialProviderAttributes Struct ​

Attributes for importing an existing API key credential provider.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_agentcore_alpha from '@aws-cdk/aws-bedrock-agentcore-alpha';
const apiKeyCredentialProviderAttributes: bedrock_agentcore_alpha.ApiKeyCredentialProviderAttributes = {
  credentialProviderArn: 'credentialProviderArn',

  // the properties below are optional
  apiKeySecretArn: 'apiKeySecretArn',
  createdTime: 'createdTime',
  lastUpdatedTime: 'lastUpdatedTime',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_bedrock_agentcore_alpha as bedrock_agentcore_alpha

api_key_credential_provider_attributes = bedrock_agentcore_alpha.ApiKeyCredentialProviderAttributes(
    credential_provider_arn="credentialProviderArn",

    # the properties below are optional
    api_key_secret_arn="apiKeySecretArn",
    created_time="createdTime",
    last_updated_time="lastUpdatedTime"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.bedrock.agentcore.alpha.*;

ApiKeyCredentialProviderAttributes apiKeyCredentialProviderAttributes = ApiKeyCredentialProviderAttributes.builder()
        .credentialProviderArn("credentialProviderArn")

        // the properties below are optional
        .apiKeySecretArn("apiKeySecretArn")
        .createdTime("createdTime")
        .lastUpdatedTime("lastUpdatedTime")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Bedrock.Agentcore.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Bedrock.Agentcore.Alpha;

var apiKeyCredentialProviderAttributes = new ApiKeyCredentialProviderAttributes {
    CredentialProviderArn = "credentialProviderArn",

    // the properties below are optional
    ApiKeySecretArn = "apiKeySecretArn",
    CreatedTime = "createdTime",
    LastUpdatedTime = "lastUpdatedTime"
};
go
// Install: go get github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import bedrock_agentcore_alpha "github.com/aws/aws-cdk-go/awsbedrockagentcorealpha"

apiKeyCredentialProviderAttributes := &ApiKeyCredentialProviderAttributes{
	CredentialProviderArn: jsii.String("credentialProviderArn"),

	// the properties below are optional
	ApiKeySecretArn: jsii.String("apiKeySecretArn"),
	CreatedTime: jsii.String("createdTime"),
	LastUpdatedTime: jsii.String("lastUpdatedTime"),
}

Properties ​

apiKeySecretArnoptionalstringapi_key_secret_arnoptionalstrapiKeySecretArnoptionalStringApiKeySecretArnoptionalstringApiKeySecretArnoptional*string#
ARN of the Secrets Manager secret for the API key, if known.

Default: not set; required for {@link ApiKeyCredentialProvider.bindForGatewayApiKeyTarget } on imported providers

createdTimeoptionalstringcreated_timeoptionalstrcreatedTimeoptionalStringCreatedTimeoptionalstringCreatedTimeoptional*string#
Resource creation time.

Default: not set

credentialProviderArnstringcredential_provider_arnstrcredentialProviderArnStringCredentialProviderArnstringCredentialProviderArn*stringrequired#
ARN of the credential provider.
lastUpdatedTimeoptionalstringlast_updated_timeoptionalstrlastUpdatedTimeoptionalStringLastUpdatedTimeoptionalstringLastUpdatedTimeoptional*string#
Resource last-updated time.

Default: not set