Package software.amazon.awscdk.services.bedrockagentcore

Interface CfnGatewayTarget.OAuthCredentialProviderProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGatewayTarget.OAuthCredentialProviderProperty.Jsii$Proxy

Enclosing class:

CfnGatewayTarget

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

The OAuth 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.*;
 OAuthCredentialProviderProperty oAuthCredentialProviderProperty = OAuthCredentialProviderProperty.builder()
         .providerArn("providerArn")
         .scopes(List.of("scopes"))
         // the properties below are optional
         .customParameters(Map.of(
                 "customParametersKey", "customParameters"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnGatewayTarget.OAuthCredentialProviderProperty.Builder	builder()
default Object	getCustomParameters()	The OAuth credential provider.
String	getProviderArn()	The provider ARN for the gateway target.
List<String>	getScopes()	The OAuth credential provider scopes.

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-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-providerarn

getScopes

@Stability(Stable)
@NotNull
List<String> getScopes()

The OAuth credential provider scopes.

See Also:

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

getCustomParameters

@Stability(Stable)
@Nullable
default Object getCustomParameters()

The OAuth credential provider.

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

See Also:

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

builder

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

Returns:

a CfnGatewayTarget.OAuthCredentialProviderProperty.Builder of CfnGatewayTarget.OAuthCredentialProviderProperty