Interface CreateConsentPortalRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockAgentCoreControlRequest.Builder, Buildable, CopyableBuilder<CreateConsentPortalRequest.Builder,CreateConsentPortalRequest>, SdkBuilder<CreateConsentPortalRequest.Builder,CreateConsentPortalRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateConsentPortalRequest

@Mutable
@NotThreadSafe
public static interface CreateConsentPortalRequest.Builder
extends BedrockAgentCoreControlRequest.Builder, SdkPojo, CopyableBuilder<CreateConsentPortalRequest.Builder,CreateConsentPortalRequest>

Method Summary

Modifier and Type	Method	Description
CreateConsentPortalRequest.Builder	description(String description)	The description of the consent portal.
CreateConsentPortalRequest.Builder	executionRoleArn(String executionRoleArn)	The Amazon Resource Name (ARN) of the IAM role that the consent portal assumes to access the resources defined in its sources.
default CreateConsentPortalRequest.Builder	idpConfig(Consumer<ConsentPortalIdpConfig.Builder> idpConfig)	The identity provider configuration that the consent portal uses to authenticate end users.
CreateConsentPortalRequest.Builder	idpConfig(ConsentPortalIdpConfig idpConfig)	The identity provider configuration that the consent portal uses to authenticate end users.
CreateConsentPortalRequest.Builder	name(String name)	The name of the consent portal.
CreateConsentPortalRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateConsentPortalRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateConsentPortalRequest.Builder	sources(Collection<ConsentPortalSource> sources)	The resources served by the consent portal.
CreateConsentPortalRequest.Builder	sources(Consumer<ConsentPortalSource.Builder>... sources)	The resources served by the consent portal.
CreateConsentPortalRequest.Builder	sources(ConsentPortalSource... sources)	The resources served by the consent portal.
CreateConsentPortalRequest.Builder	tags(Map<String,String> tags)	A map of tag keys and values to assign to the consent portal.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrockagentcorecontrol.model.BedrockAgentCoreControlRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

executionRoleArn

CreateConsentPortalRequest.Builder executionRoleArn(String executionRoleArn)

The Amazon Resource Name (ARN) of the IAM role that the consent portal assumes to access the resources defined in its sources.

Parameters:

executionRoleArn - The Amazon Resource Name (ARN) of the IAM role that the consent portal assumes to access the resources defined in its sources.

Returns:

Returns a reference to this object so that method calls can be chained together.

idpConfig

CreateConsentPortalRequest.Builder idpConfig(ConsentPortalIdpConfig idpConfig)

The identity provider configuration that the consent portal uses to authenticate end users.

Parameters:

idpConfig - The identity provider configuration that the consent portal uses to authenticate end users.

Returns:

Returns a reference to this object so that method calls can be chained together.

idpConfig

default CreateConsentPortalRequest.Builder idpConfig(Consumer<ConsentPortalIdpConfig.Builder> idpConfig)

The identity provider configuration that the consent portal uses to authenticate end users.

This is a convenience method that creates an instance of the ConsentPortalIdpConfig.Builder avoiding the need to create one manually via ConsentPortalIdpConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to idpConfig(ConsentPortalIdpConfig).

Parameters:

idpConfig - a consumer that will call methods on ConsentPortalIdpConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• idpConfig(ConsentPortalIdpConfig)

name

CreateConsentPortalRequest.Builder name(String name)

The name of the consent portal. The name must be unique within your account.

Parameters:

name - The name of the consent portal. The name must be unique within your account.

Returns:

Returns a reference to this object so that method calls can be chained together.

sources

CreateConsentPortalRequest.Builder sources(Collection<ConsentPortalSource> sources)

The resources served by the consent portal. Currently, we only support type agentcore-gateway.

Parameters:

sources - The resources served by the consent portal. Currently, we only support type agentcore-gateway.

Returns:

Returns a reference to this object so that method calls can be chained together.

sources

CreateConsentPortalRequest.Builder sources(ConsentPortalSource... sources)

The resources served by the consent portal. Currently, we only support type agentcore-gateway.

Parameters:

sources - The resources served by the consent portal. Currently, we only support type agentcore-gateway.

Returns:

Returns a reference to this object so that method calls can be chained together.

sources

CreateConsentPortalRequest.Builder sources(Consumer<ConsentPortalSource.Builder>... sources)

The resources served by the consent portal. Currently, we only support type agentcore-gateway.

This is a convenience method that creates an instance of the ConsentPortalSource.Builder avoiding the need to create one manually via ConsentPortalSource.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sources(List<ConsentPortalSource>).

Parameters:

sources - a consumer that will call methods on ConsentPortalSource.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• sources(java.util.Collection<ConsentPortalSource>)

description

CreateConsentPortalRequest.Builder description(String description)

The description of the consent portal.

Parameters:

description - The description of the consent portal.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateConsentPortalRequest.Builder tags(Map<String,String> tags)

A map of tag keys and values to assign to the consent portal. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

Parameters:

tags - A map of tag keys and values to assign to the consent portal. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateConsentPortalRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateConsentPortalRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.