Package software.amazon.awscdk.cfnpropertymixins.services.bedrockagentcore

Interface CfnGatewayTargetPropsMixin.ApiKeyCredentialProviderProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGatewayTargetPropsMixin.ApiKeyCredentialProviderProperty.Jsii$Proxy

Enclosing class:

CfnGatewayTargetPropsMixin

@Stability(Stable)
public static interface CfnGatewayTargetPropsMixin.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.cfnpropertymixins.services.bedrockagentcore.*;
 ApiKeyCredentialProviderProperty apiKeyCredentialProviderProperty = ApiKeyCredentialProviderProperty.builder()
         .credentialLocation("credentialLocation")
         .credentialParameterName("credentialParameterName")
         .credentialPrefix("credentialPrefix")
         .providerArn("providerArn")
         .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	CfnGatewayTargetPropsMixin.ApiKeyCredentialProviderProperty.Builder	A builder for CfnGatewayTargetPropsMixin.ApiKeyCredentialProviderProperty
static final class	CfnGatewayTargetPropsMixin.ApiKeyCredentialProviderProperty.Jsii$Proxy	An implementation for CfnGatewayTargetPropsMixin.ApiKeyCredentialProviderProperty

Method Summary

Modifier and Type	Method	Description
static CfnGatewayTargetPropsMixin.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.
default String	getProviderArn()	The provider ARN for the gateway target.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

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

getProviderArn

@Stability(Stable)
@Nullable
default 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

builder

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

Returns:

a CfnGatewayTargetPropsMixin.ApiKeyCredentialProviderProperty.Builder of CfnGatewayTargetPropsMixin.ApiKeyCredentialProviderProperty