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

Class CfnGatewayPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.bedrockagentcore.CfnGatewayPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGatewayPropsMixin>

Enclosing class:

CfnGatewayPropsMixin

@Stability(Stable)
public static final class CfnGatewayPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnGatewayPropsMixin>

A fluent builder for CfnGatewayPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnGatewayPropsMixin.Builder	authorizerConfiguration(CfnGatewayPropsMixin.AuthorizerConfigurationProperty authorizerConfiguration)
CfnGatewayPropsMixin.Builder	authorizerConfiguration(IResolvable authorizerConfiguration)
CfnGatewayPropsMixin.Builder	authorizerType(String authorizerType)	The authorizer type for the gateway.
CfnGatewayPropsMixin	build()
static CfnGatewayPropsMixin.Builder	create()
static CfnGatewayPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnGatewayPropsMixin.Builder	description(String description)	The description for the gateway.
CfnGatewayPropsMixin.Builder	exceptionLevel(String exceptionLevel)	The exception level for the gateway.
CfnGatewayPropsMixin.Builder	interceptorConfigurations(List<? extends Object> interceptorConfigurations)
CfnGatewayPropsMixin.Builder	interceptorConfigurations(IResolvable interceptorConfigurations)
CfnGatewayPropsMixin.Builder	kmsKeyArn(String kmsKeyArn)	The KMS key ARN for the gateway.
CfnGatewayPropsMixin.Builder	name(String name)	The name for the gateway.
CfnGatewayPropsMixin.Builder	policyEngineConfiguration(CfnGatewayPropsMixin.GatewayPolicyEngineConfigurationProperty policyEngineConfiguration)	The configuration for a policy engine associated with a gateway.
CfnGatewayPropsMixin.Builder	policyEngineConfiguration(IResolvable policyEngineConfiguration)	The configuration for a policy engine associated with a gateway.
CfnGatewayPropsMixin.Builder	protocolConfiguration(CfnGatewayPropsMixin.GatewayProtocolConfigurationProperty protocolConfiguration)	The protocol configuration for the gateway target.
CfnGatewayPropsMixin.Builder	protocolConfiguration(IResolvable protocolConfiguration)	The protocol configuration for the gateway target.
CfnGatewayPropsMixin.Builder	protocolType(String protocolType)	The protocol type for the gateway target.
CfnGatewayPropsMixin.Builder	roleArn(String roleArn)
CfnGatewayPropsMixin.Builder	tags(Map<String,String> tags)	The tags for the gateway.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnGatewayPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnGatewayPropsMixin.Builder.

create

@Stability(Stable)
public static CfnGatewayPropsMixin.Builder create()

Returns:

a new instance of CfnGatewayPropsMixin.Builder.

authorizerConfiguration

@Stability(Stable)
public CfnGatewayPropsMixin.Builder authorizerConfiguration(IResolvable authorizerConfiguration)

Parameters:

authorizerConfiguration - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-authorizerconfiguration

authorizerConfiguration

@Stability(Stable)
public CfnGatewayPropsMixin.Builder authorizerConfiguration(CfnGatewayPropsMixin.AuthorizerConfigurationProperty authorizerConfiguration)

Parameters:

authorizerConfiguration - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-authorizerconfiguration

authorizerType

@Stability(Stable)
public CfnGatewayPropsMixin.Builder authorizerType(String authorizerType)

The authorizer type for the gateway.

Parameters:

authorizerType - The authorizer type for the gateway. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-authorizertype

description

@Stability(Stable)
public CfnGatewayPropsMixin.Builder description(String description)

The description for the gateway.

Parameters:

description - The description for the gateway. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-description

exceptionLevel

@Stability(Stable)
public CfnGatewayPropsMixin.Builder exceptionLevel(String exceptionLevel)

The exception level for the gateway.

Parameters:

exceptionLevel - The exception level for the gateway. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-exceptionlevel

interceptorConfigurations

@Stability(Stable)
public CfnGatewayPropsMixin.Builder interceptorConfigurations(IResolvable interceptorConfigurations)

Parameters:

interceptorConfigurations - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-interceptorconfigurations

interceptorConfigurations

@Stability(Stable)
public CfnGatewayPropsMixin.Builder interceptorConfigurations(List<? extends Object> interceptorConfigurations)

Parameters:

interceptorConfigurations - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-interceptorconfigurations

kmsKeyArn

@Stability(Stable)
public CfnGatewayPropsMixin.Builder kmsKeyArn(String kmsKeyArn)

The KMS key ARN for the gateway.

Parameters:

kmsKeyArn - The KMS key ARN for the gateway. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-kmskeyarn

name

@Stability(Stable)
public CfnGatewayPropsMixin.Builder name(String name)

The name for the gateway.

Parameters:

name - The name for the gateway. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-name

policyEngineConfiguration

@Stability(Stable)
public CfnGatewayPropsMixin.Builder policyEngineConfiguration(IResolvable policyEngineConfiguration)

The configuration for a policy engine associated with a gateway.

A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.

Parameters:

policyEngineConfiguration - The configuration for a policy engine associated with a gateway. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-policyengineconfiguration

policyEngineConfiguration

@Stability(Stable)
public CfnGatewayPropsMixin.Builder policyEngineConfiguration(CfnGatewayPropsMixin.GatewayPolicyEngineConfigurationProperty policyEngineConfiguration)

The configuration for a policy engine associated with a gateway.

A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.

Parameters:

policyEngineConfiguration - The configuration for a policy engine associated with a gateway. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-policyengineconfiguration

protocolConfiguration

@Stability(Stable)
public CfnGatewayPropsMixin.Builder protocolConfiguration(IResolvable protocolConfiguration)

The protocol configuration for the gateway target.

Parameters:

protocolConfiguration - The protocol configuration for the gateway target. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-protocolconfiguration

protocolConfiguration

@Stability(Stable)
public CfnGatewayPropsMixin.Builder protocolConfiguration(CfnGatewayPropsMixin.GatewayProtocolConfigurationProperty protocolConfiguration)

The protocol configuration for the gateway target.

Parameters:

protocolConfiguration - The protocol configuration for the gateway target. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-protocolconfiguration

protocolType

@Stability(Stable)
public CfnGatewayPropsMixin.Builder protocolType(String protocolType)

The protocol type for the gateway target.

Parameters:

protocolType - The protocol type for the gateway target. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-protocoltype

roleArn

@Stability(Stable)
public CfnGatewayPropsMixin.Builder roleArn(String roleArn)

Parameters:

roleArn - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-rolearn

tags

@Stability(Stable)
public CfnGatewayPropsMixin.Builder tags(Map<String,String> tags)

The tags for the gateway.

Parameters:

tags - The tags for the gateway. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-tags

build

@Stability(Stable)
public CfnGatewayPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnGatewayPropsMixin>

Returns:

a newly built instance of CfnGatewayPropsMixin.