@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
97 lines (96 loc) • 4.07 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Resource Type definition for AWS::BedrockAgentCore::ApiKeyCredentialProvider
*/
export declare class ApiKeyCredentialProvider extends pulumi.CustomResource {
/**
* Get an existing ApiKeyCredentialProvider resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): ApiKeyCredentialProvider;
/**
* Returns true if the given object is an instance of ApiKeyCredentialProvider. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ApiKeyCredentialProvider;
/**
* The API key to use for authentication
*/
readonly apiKey: pulumi.Output<string | undefined>;
/**
* The ARN of the API key secret in AWS Secrets Manager
*/
readonly apiKeySecretArn: pulumi.Output<outputs.bedrockagentcore.ApiKeyCredentialProviderApiKeySecretArn>;
/**
* Configuration for a customer-provided secret containing the API key
*/
readonly apiKeySecretConfig: pulumi.Output<outputs.bedrockagentcore.ApiKeyCredentialProviderSecretReference | undefined>;
/**
* The JSON key within the secret that contains the API key value
*/
readonly apiKeySecretJsonKey: pulumi.Output<string>;
/**
* The source of the API key secret. Use MANAGED for service-managed secrets or EXTERNAL for customer-provided secrets.
*/
readonly apiKeySecretSource: pulumi.Output<enums.bedrockagentcore.ApiKeyCredentialProviderApiKeySecretSource | undefined>;
/**
* The timestamp when the credential provider was created
*/
readonly createdTime: pulumi.Output<string>;
/**
* The Amazon Resource Name (ARN) of the API key credential provider
*/
readonly credentialProviderArn: pulumi.Output<string>;
/**
* The timestamp when the credential provider was last updated
*/
readonly lastUpdatedTime: pulumi.Output<string>;
/**
* The name of the API key credential provider
*/
readonly name: pulumi.Output<string>;
/**
* Tags to assign to the API key credential provider
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* Create a ApiKeyCredentialProvider resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: ApiKeyCredentialProviderArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a ApiKeyCredentialProvider resource.
*/
export interface ApiKeyCredentialProviderArgs {
/**
* The API key to use for authentication
*/
apiKey?: pulumi.Input<string>;
/**
* Configuration for a customer-provided secret containing the API key
*/
apiKeySecretConfig?: pulumi.Input<inputs.bedrockagentcore.ApiKeyCredentialProviderSecretReferenceArgs>;
/**
* The source of the API key secret. Use MANAGED for service-managed secrets or EXTERNAL for customer-provided secrets.
*/
apiKeySecretSource?: pulumi.Input<enums.bedrockagentcore.ApiKeyCredentialProviderApiKeySecretSource>;
/**
* The name of the API key credential provider
*/
name?: pulumi.Input<string>;
/**
* Tags to assign to the API key credential provider
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
}