Package software.aws.awsprototypingsdk.openapigateway

Class ApiGatewayIntegration.Builder

java.lang.Object

software.aws.awsprototypingsdk.openapigateway.ApiGatewayIntegration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ApiGatewayIntegration>

Enclosing interface:

ApiGatewayIntegration

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

A builder for ApiGatewayIntegration

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ApiGatewayIntegration	build()	Builds the configured instance.
ApiGatewayIntegration.Builder	cacheKeyParameters(List<String> cacheKeyParameters)	Sets the value of ApiGatewayIntegration.getCacheKeyParameters()
ApiGatewayIntegration.Builder	cacheNamespace(String cacheNamespace)	Sets the value of ApiGatewayIntegration.getCacheNamespace()
ApiGatewayIntegration.Builder	connectionId(String connectionId)	Sets the value of ApiGatewayIntegration.getConnectionId()
ApiGatewayIntegration.Builder	connectionType(String connectionType)	Sets the value of ApiGatewayIntegration.getConnectionType()
ApiGatewayIntegration.Builder	contentHandling(String contentHandling)	Sets the value of ApiGatewayIntegration.getContentHandling()
ApiGatewayIntegration.Builder	credentials(String credentials)	Sets the value of ApiGatewayIntegration.getCredentials()
ApiGatewayIntegration.Builder	httpMethod(String httpMethod)	Sets the value of ApiGatewayIntegration.getHttpMethod()
ApiGatewayIntegration.Builder	passthroughBehavior(String passthroughBehavior)	Sets the value of ApiGatewayIntegration.getPassthroughBehavior()
ApiGatewayIntegration.Builder	requestParameters(Map<String,String> requestParameters)	Sets the value of ApiGatewayIntegration.getRequestParameters()
ApiGatewayIntegration.Builder	requestTemplates(Map<String,String> requestTemplates)	Sets the value of ApiGatewayIntegration.getRequestTemplates()
ApiGatewayIntegration.Builder	responses(Map<String,? extends ApiGatewayIntegrationResponse> responses)	Sets the value of ApiGatewayIntegration.getResponses()
ApiGatewayIntegration.Builder	timeoutInMillis(Number timeoutInMillis)	Sets the value of ApiGatewayIntegration.getTimeoutInMillis()
ApiGatewayIntegration.Builder	tlsConfig(ApiGatewayIntegrationTlsConfig tlsConfig)	Sets the value of ApiGatewayIntegration.getTlsConfig()
ApiGatewayIntegration.Builder	type(String type)	Sets the value of ApiGatewayIntegration.getType()
ApiGatewayIntegration.Builder	uri(String uri)	Sets the value of ApiGatewayIntegration.getUri()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

cacheKeyParameters

@Stability(Experimental)
public ApiGatewayIntegration.Builder cacheKeyParameters(List<String> cacheKeyParameters)

Sets the value of ApiGatewayIntegration.getCacheKeyParameters()

Parameters:

cacheKeyParameters - A list of request parameters whose values are to be cached.

Returns:

this

cacheNamespace

@Stability(Experimental)
public ApiGatewayIntegration.Builder cacheNamespace(String cacheNamespace)

Sets the value of ApiGatewayIntegration.getCacheNamespace()

Parameters:

cacheNamespace - An API-specific tag group of related cached parameters.

Returns:

this

connectionId

@Stability(Experimental)
public ApiGatewayIntegration.Builder connectionId(String connectionId)

Sets the value of ApiGatewayIntegration.getConnectionId()

Parameters:

connectionId - The ID of a VpcLink for the private integration.

Returns:

this

connectionType

@Stability(Experimental)
public ApiGatewayIntegration.Builder connectionType(String connectionType)

Sets the value of ApiGatewayIntegration.getConnectionType()

Parameters:

connectionType - The integration connection type. The valid value is "VPC_LINK" for private integration or "INTERNET", otherwise.

Returns:

this

contentHandling

@Stability(Experimental)
public ApiGatewayIntegration.Builder contentHandling(String contentHandling)

Sets the value of ApiGatewayIntegration.getContentHandling()

Parameters:

contentHandling - Request payload encoding conversion types. Valid values are 1) CONVERT_TO_TEXT, for converting a binary payload into a base64-encoded string or converting a text payload into a utf-8-encoded string or passing through the text payload natively without modification, and 2) CONVERT_TO_BINARY, for converting a text payload into a base64-decoded blob or passing through a binary payload natively without modification.

Returns:

this

credentials

@Stability(Experimental)
public ApiGatewayIntegration.Builder credentials(String credentials)

Sets the value of ApiGatewayIntegration.getCredentials()

Parameters:

credentials - For AWS IAM role-based credentials, specify the ARN of an appropriate IAM role. If unspecified, credentials default to resource-based permissions that must be added manually to allow the API to access the resource. For more information, see Granting Permissions Using a Resource Policy.

Note: When using IAM credentials, make sure that AWS STS Regional endpoints are enabled for the Region where this API is deployed for best performance.

Returns:

this

httpMethod

@Stability(Experimental)
public ApiGatewayIntegration.Builder httpMethod(String httpMethod)

Sets the value of ApiGatewayIntegration.getHttpMethod()

Parameters:

httpMethod - The HTTP method used in the integration request. For Lambda function invocations, the value must be POST.

Returns:

this

passthroughBehavior

@Stability(Experimental)
public ApiGatewayIntegration.Builder passthroughBehavior(String passthroughBehavior)

Sets the value of ApiGatewayIntegration.getPassthroughBehavior()

Parameters:

passthroughBehavior - Specifies how a request payload of unmapped content type is passed through the integration request without modification. Supported values are when_no_templates, when_no_match, and never.

Returns:

this

requestParameters

@Stability(Experimental)
public ApiGatewayIntegration.Builder requestParameters(Map<String,String> requestParameters)

Sets the value of ApiGatewayIntegration.getRequestParameters()

Parameters:

requestParameters - Specifies mappings from method request parameters to integration request parameters. Supported request parameters are querystring, path, header, and body.

Returns:

this

requestTemplates

@Stability(Experimental)
public ApiGatewayIntegration.Builder requestTemplates(Map<String,String> requestTemplates)

Sets the value of ApiGatewayIntegration.getRequestTemplates()

Parameters:

requestTemplates - Mapping templates for a request payload of specified MIME types.

Returns:

this

responses

@Stability(Experimental)
public ApiGatewayIntegration.Builder responses(Map<String,? extends ApiGatewayIntegrationResponse> responses)

Sets the value of ApiGatewayIntegration.getResponses()

Parameters:

responses - Defines the method's responses and specifies desired parameter mappings or payload mappings from integration responses to method responses.

Returns:

this

timeoutInMillis

@Stability(Experimental)
public ApiGatewayIntegration.Builder timeoutInMillis(Number timeoutInMillis)

Sets the value of ApiGatewayIntegration.getTimeoutInMillis()

Parameters:

timeoutInMillis - Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

Returns:

this

tlsConfig

@Stability(Experimental)
public ApiGatewayIntegration.Builder tlsConfig(ApiGatewayIntegrationTlsConfig tlsConfig)

Sets the value of ApiGatewayIntegration.getTlsConfig()

Parameters:

tlsConfig - Specifies the TLS configuration for an integration.

Returns:

this

type

@Stability(Experimental)
public ApiGatewayIntegration.Builder type(String type)

Sets the value of ApiGatewayIntegration.getType()

Parameters:

type - The type of integration with the specified backend.

Returns:

this

uri

@Stability(Experimental)
public ApiGatewayIntegration.Builder uri(String uri)

Sets the value of ApiGatewayIntegration.getUri()

Parameters:

uri - The endpoint URI of the backend. For integrations of the aws type, this is an ARN value. For the HTTP integration, this is the URL of the HTTP endpoint including the https or http scheme.

Returns:

this

build

@Stability(Experimental)
public ApiGatewayIntegration build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ApiGatewayIntegration

Throws:

NullPointerException - if any required attribute was not provided