Skip to content
v2.275.0

CredentialProviderConfigurationProperty Struct ​

The credential provider configuration for the gateway target.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrockagentcore as bedrockagentcore } from 'aws-cdk-lib';
const credentialProviderConfigurationProperty: bedrockagentcore.CfnGatewayTarget.CredentialProviderConfigurationProperty = {
  credentialProviderType: 'credentialProviderType',

  // the properties below are optional
  credentialProvider: {
    apiKeyCredentialProvider: {
      providerArn: 'providerArn',

      // the properties below are optional
      credentialLocation: 'credentialLocation',
      credentialParameterName: 'credentialParameterName',
      credentialPrefix: 'credentialPrefix',
    },
    iamCredentialProvider: {
      service: 'service',

      // the properties below are optional
      region: 'region',
    },
    oauthCredentialProvider: {
      providerArn: 'providerArn',
      scopes: ['scopes'],

      // the properties below are optional
      customParameters: {
        customParametersKey: 'customParameters',
      },
      defaultReturnUrl: 'defaultReturnUrl',
      grantType: 'grantType',
    },
  },
};

Properties ​

credentialProvideroptionalIResolvable | CfnGatewayTarget.CredentialProviderPropertycredential_provideroptionaltyping.Union[IResolvable, CredentialProviderProperty]credentialProvideroptionalIResolvableCredentialProvideroptionalIResolvableCredentialProvideroptionalinterface{}#
The credential provider for the gateway target.
credentialProviderTypestringcredential_provider_typestrcredentialProviderTypeStringCredentialProviderTypestringCredentialProviderType*stringrequired#
The credential provider type for the gateway target.