Interface CreatePortalRequest.Builder

All Superinterfaces:

ApiGatewayV2Request.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreatePortalRequest.Builder,CreatePortalRequest>, SdkBuilder<CreatePortalRequest.Builder,CreatePortalRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreatePortalRequest

@Mutable
@NotThreadSafe
public static interface CreatePortalRequest.Builder
extends ApiGatewayV2Request.Builder, SdkPojo, CopyableBuilder<CreatePortalRequest.Builder,CreatePortalRequest>

Method Summary

Modifier and Type	Method	Description
default CreatePortalRequest.Builder	authorization(Consumer<Authorization.Builder> authorization)	The authentication configuration for the portal.
CreatePortalRequest.Builder	authorization(Authorization authorization)	The authentication configuration for the portal.
default CreatePortalRequest.Builder	endpointConfiguration(Consumer<EndpointConfigurationRequest.Builder> endpointConfiguration)	The domain configuration for the portal.
CreatePortalRequest.Builder	endpointConfiguration(EndpointConfigurationRequest endpointConfiguration)	The domain configuration for the portal.
CreatePortalRequest.Builder	includedPortalProductArns(String... includedPortalProductArns)	The ARNs of the portal products included in the portal.
CreatePortalRequest.Builder	includedPortalProductArns(Collection<String> includedPortalProductArns)	The ARNs of the portal products included in the portal.
CreatePortalRequest.Builder	logoUri(String logoUri)	The URI for the portal logo image that is displayed in the portal header.
CreatePortalRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreatePortalRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreatePortalRequest.Builder	portalContent(Consumer<PortalContent.Builder> portalContent)	The content of the portal.
CreatePortalRequest.Builder	portalContent(PortalContent portalContent)	The content of the portal.
CreatePortalRequest.Builder	rumAppMonitorName(String rumAppMonitorName)	The name of the Amazon CloudWatch RUM app monitor for the portal.
CreatePortalRequest.Builder	tags(Map<String,String> tags)	The collection of tags.

Methods inherited from interface software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Request.Builder

build

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

overrideConfiguration

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

authorization

CreatePortalRequest.Builder authorization(Authorization authorization)

The authentication configuration for the portal.

Parameters:

authorization - The authentication configuration for the portal.

Returns:

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

authorization

default CreatePortalRequest.Builder authorization(Consumer<Authorization.Builder> authorization)

The authentication configuration for the portal.

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

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

Parameters:

authorization - a consumer that will call methods on Authorization.Builder

Returns:

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

See Also:

• authorization(Authorization)

endpointConfiguration

CreatePortalRequest.Builder endpointConfiguration(EndpointConfigurationRequest endpointConfiguration)

The domain configuration for the portal. Use a default domain provided by API Gateway or provide a fully-qualified domain name that you own.

Parameters:

endpointConfiguration - The domain configuration for the portal. Use a default domain provided by API Gateway or provide a fully-qualified domain name that you own.

Returns:

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

endpointConfiguration

default CreatePortalRequest.Builder endpointConfiguration(Consumer<EndpointConfigurationRequest.Builder> endpointConfiguration)

The domain configuration for the portal. Use a default domain provided by API Gateway or provide a fully-qualified domain name that you own.

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

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

Parameters:

endpointConfiguration - a consumer that will call methods on EndpointConfigurationRequest.Builder

Returns:

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

See Also:

• endpointConfiguration(EndpointConfigurationRequest)

includedPortalProductArns

CreatePortalRequest.Builder includedPortalProductArns(Collection<String> includedPortalProductArns)

The ARNs of the portal products included in the portal.

Parameters:

includedPortalProductArns - The ARNs of the portal products included in the portal.

Returns:

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

includedPortalProductArns

CreatePortalRequest.Builder includedPortalProductArns(String... includedPortalProductArns)

The ARNs of the portal products included in the portal.

Parameters:

includedPortalProductArns - The ARNs of the portal products included in the portal.

Returns:

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

logoUri

CreatePortalRequest.Builder logoUri(String logoUri)

The URI for the portal logo image that is displayed in the portal header.

Parameters:

logoUri - The URI for the portal logo image that is displayed in the portal header.

Returns:

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

portalContent

CreatePortalRequest.Builder portalContent(PortalContent portalContent)

The content of the portal.

Parameters:

portalContent - The content of the portal.

Returns:

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

portalContent

default CreatePortalRequest.Builder portalContent(Consumer<PortalContent.Builder> portalContent)

The content of the portal.

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

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

Parameters:

portalContent - a consumer that will call methods on PortalContent.Builder

Returns:

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

See Also:

• portalContent(PortalContent)

rumAppMonitorName

CreatePortalRequest.Builder rumAppMonitorName(String rumAppMonitorName)

The name of the Amazon CloudWatch RUM app monitor for the portal.

Parameters:

rumAppMonitorName - The name of the Amazon CloudWatch RUM app monitor for the portal.

Returns:

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

tags

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

The collection of tags. Each tag element is associated with a given resource.

Parameters:

tags - The collection of tags. Each tag element is associated with a given resource.

Returns:

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

overrideConfiguration

CreatePortalRequest.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

CreatePortalRequest.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.