Package software.amazon.awssdk.services.migrationhubrefactorspaces.model

Interface ApiGatewayProxyInput.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ApiGatewayProxyInput.Builder,ApiGatewayProxyInput>, SdkBuilder<ApiGatewayProxyInput.Builder,ApiGatewayProxyInput>, SdkPojo

Enclosing class:

ApiGatewayProxyInput

public static interface ApiGatewayProxyInput.Builder
extends SdkPojo, CopyableBuilder<ApiGatewayProxyInput.Builder,ApiGatewayProxyInput>

Method Summary

Modifier and Type	Method	Description
ApiGatewayProxyInput.Builder	endpointType(String endpointType)	The type of endpoint to use for the API Gateway proxy.
ApiGatewayProxyInput.Builder	endpointType(ApiGatewayEndpointType endpointType)	The type of endpoint to use for the API Gateway proxy.
ApiGatewayProxyInput.Builder	stageName(String stageName)	The name of the API Gateway stage.

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 Detail

endpointType

ApiGatewayProxyInput.Builder endpointType(String endpointType)

The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default.

If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API Gateway that has been granted access. For more information about creating a private connection with Refactor Spaces and interface endpoint (Amazon Web Services PrivateLink) availability, see Access Refactor Spaces using an interface endpoint (Amazon Web Services PrivateLink).

Parameters:

endpointType - The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default.

If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API Gateway that has been granted access. For more information about creating a private connection with Refactor Spaces and interface endpoint (Amazon Web Services PrivateLink) availability, see Access Refactor Spaces using an interface endpoint (Amazon Web Services PrivateLink).

Returns:

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

See Also:

ApiGatewayEndpointType, ApiGatewayEndpointType

endpointType

ApiGatewayProxyInput.Builder endpointType(ApiGatewayEndpointType endpointType)

The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default.

If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API Gateway that has been granted access. For more information about creating a private connection with Refactor Spaces and interface endpoint (Amazon Web Services PrivateLink) availability, see Access Refactor Spaces using an interface endpoint (Amazon Web Services PrivateLink).

Parameters:

endpointType - The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default.

If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API Gateway that has been granted access. For more information about creating a private connection with Refactor Spaces and interface endpoint (Amazon Web Services PrivateLink) availability, see Access Refactor Spaces using an interface endpoint (Amazon Web Services PrivateLink).

Returns:

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

See Also:

ApiGatewayEndpointType, ApiGatewayEndpointType

stageName

ApiGatewayProxyInput.Builder stageName(String stageName)

The name of the API Gateway stage. The name defaults to prod.

Parameters:

stageName - The name of the API Gateway stage. The name defaults to prod.

Returns:

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