Package software.amazon.awscdk.services.bedrockagentcore

Interface CfnGatewayTarget.ApiKeyCredentialProviderProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGatewayTarget.ApiKeyCredentialProviderProperty.Jsii$Proxy

Enclosing class:

CfnGatewayTarget

@Stability(Stable)
public static interface CfnGatewayTarget.ApiKeyCredentialProviderProperty
extends software.amazon.jsii.JsiiSerializable

The API key credential provider for the gateway target.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.bedrockagentcore.*;
 ApiKeyCredentialProviderProperty apiKeyCredentialProviderProperty = ApiKeyCredentialProviderProperty.builder()
         .providerArn("providerArn")
         // the properties below are optional
         .credentialLocation("credentialLocation")
         .credentialParameterName("credentialParameterName")
         .credentialPrefix("credentialPrefix")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGatewayTarget.ApiKeyCredentialProviderProperty.Builder	A builder for CfnGatewayTarget.ApiKeyCredentialProviderProperty
static final class	CfnGatewayTarget.ApiKeyCredentialProviderProperty.Jsii$Proxy	An implementation for CfnGatewayTarget.ApiKeyCredentialProviderProperty

Method Summary

Modifier and Type	Method	Description
static CfnGatewayTarget.ApiKeyCredentialProviderProperty.Builder	builder()
default String	getCredentialLocation()	The credential location for the gateway target.
default String	getCredentialParameterName()	The credential parameter name for the provider for the gateway target.
default String	getCredentialPrefix()	The API key credential provider for the gateway target.
String	getProviderArn()	The provider ARN for the gateway target.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getProviderArn

@Stability(Stable)
@NotNull
String getProviderArn()

The provider ARN for the gateway target.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-providerarn

getCredentialLocation

@Stability(Stable)
@Nullable
default String getCredentialLocation()

The credential location for the gateway target.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentiallocation

getCredentialParameterName

@Stability(Stable)
@Nullable
default String getCredentialParameterName()

The credential parameter name for the provider for the gateway target.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentialparametername

getCredentialPrefix

@Stability(Stable)
@Nullable
default String getCredentialPrefix()

The API key credential provider for the gateway target.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentialprefix

builder

@Stability(Stable)
static CfnGatewayTarget.ApiKeyCredentialProviderProperty.Builder builder()

Returns:

a CfnGatewayTarget.ApiKeyCredentialProviderProperty.Builder of CfnGatewayTarget.ApiKeyCredentialProviderProperty