Class CfnMethod.IntegrationProperty.Builder
java.lang.Object
software.amazon.awscdk.services.apigateway.CfnMethod.IntegrationProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnMethod.IntegrationProperty>
- Enclosing interface:
CfnMethod.IntegrationProperty
@Stability(Stable)
public static final class CfnMethod.IntegrationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnMethod.IntegrationProperty>
A builder for
CfnMethod.IntegrationProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.cacheKeyParameters
(List<String> cacheKeyParameters) Sets the value ofCfnMethod.IntegrationProperty.getCacheKeyParameters()
cacheNamespace
(String cacheNamespace) Sets the value ofCfnMethod.IntegrationProperty.getCacheNamespace()
connectionId
(String connectionId) Sets the value ofCfnMethod.IntegrationProperty.getConnectionId()
connectionType
(String connectionType) Sets the value ofCfnMethod.IntegrationProperty.getConnectionType()
contentHandling
(String contentHandling) Sets the value ofCfnMethod.IntegrationProperty.getContentHandling()
credentials
(String credentials) Sets the value ofCfnMethod.IntegrationProperty.getCredentials()
integrationHttpMethod
(String integrationHttpMethod) Sets the value ofCfnMethod.IntegrationProperty.getIntegrationHttpMethod()
integrationResponses
(List<? extends Object> integrationResponses) Sets the value ofCfnMethod.IntegrationProperty.getIntegrationResponses()
integrationResponses
(IResolvable integrationResponses) Sets the value ofCfnMethod.IntegrationProperty.getIntegrationResponses()
passthroughBehavior
(String passthroughBehavior) Sets the value ofCfnMethod.IntegrationProperty.getPassthroughBehavior()
requestParameters
(Map<String, String> requestParameters) Sets the value ofCfnMethod.IntegrationProperty.getRequestParameters()
requestParameters
(IResolvable requestParameters) Sets the value ofCfnMethod.IntegrationProperty.getRequestParameters()
requestTemplates
(Map<String, String> requestTemplates) Sets the value ofCfnMethod.IntegrationProperty.getRequestTemplates()
requestTemplates
(IResolvable requestTemplates) Sets the value ofCfnMethod.IntegrationProperty.getRequestTemplates()
timeoutInMillis
(Number timeoutInMillis) Sets the value ofCfnMethod.IntegrationProperty.getTimeoutInMillis()
Sets the value ofCfnMethod.IntegrationProperty.getType()
Sets the value ofCfnMethod.IntegrationProperty.getUri()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
cacheKeyParameters
@Stability(Stable) public CfnMethod.IntegrationProperty.Builder cacheKeyParameters(List<String> cacheKeyParameters) Sets the value ofCfnMethod.IntegrationProperty.getCacheKeyParameters()
- Parameters:
cacheKeyParameters
- A list of request parameters whose values API Gateway caches. To be valid values forcacheKeyParameters
, these parameters must also be specified for MethodrequestParameters
.- Returns:
this
-
cacheNamespace
@Stability(Stable) public CfnMethod.IntegrationProperty.Builder cacheNamespace(String cacheNamespace) Sets the value ofCfnMethod.IntegrationProperty.getCacheNamespace()
- Parameters:
cacheNamespace
- Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as thecacheNamespace
. You can specify the samecacheNamespace
across resources to return the same cached data for requests to different resources.- Returns:
this
-
connectionId
Sets the value ofCfnMethod.IntegrationProperty.getConnectionId()
- Parameters:
connectionId
- The ID of the VpcLink used for the integration whenconnectionType=VPC_LINK
and undefined, otherwise.- Returns:
this
-
connectionType
@Stability(Stable) public CfnMethod.IntegrationProperty.Builder connectionType(String connectionType) Sets the value ofCfnMethod.IntegrationProperty.getConnectionType()
- Parameters:
connectionType
- The type of the network connection to the integration endpoint. The valid value isINTERNET
for connections through the public routable internet orVPC_LINK
for private connections between API Gateway and a network load balancer in a VPC. The default value isINTERNET
.- Returns:
this
-
contentHandling
@Stability(Stable) public CfnMethod.IntegrationProperty.Builder contentHandling(String contentHandling) Sets the value ofCfnMethod.IntegrationProperty.getContentHandling()
- Parameters:
contentHandling
- Specifies how to handle request payload content type conversions. Supported values areCONVERT_TO_BINARY
andCONVERT_TO_TEXT
, with the following behaviors:If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the
passthroughBehavior
is configured to support payload pass-through.- Returns:
this
-
credentials
Sets the value ofCfnMethod.IntegrationProperty.getCredentials()
- Parameters:
credentials
- Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the stringarn:aws:iam::\*:user/\*
. To use resource-based permissions on supported AWS services, specify null.- Returns:
this
-
integrationHttpMethod
@Stability(Stable) public CfnMethod.IntegrationProperty.Builder integrationHttpMethod(String integrationHttpMethod) Sets the value ofCfnMethod.IntegrationProperty.getIntegrationHttpMethod()
- Parameters:
integrationHttpMethod
- Specifies the integration's HTTP method type. For the Type property, if you specifyMOCK
, this property is optional. For Lambda integrations, you must set the integration method toPOST
. For all other types, you must specify this property.- Returns:
this
-
integrationResponses
@Stability(Stable) public CfnMethod.IntegrationProperty.Builder integrationResponses(IResolvable integrationResponses) Sets the value ofCfnMethod.IntegrationProperty.getIntegrationResponses()
- Parameters:
integrationResponses
- Specifies the integration's responses.- Returns:
this
-
integrationResponses
@Stability(Stable) public CfnMethod.IntegrationProperty.Builder integrationResponses(List<? extends Object> integrationResponses) Sets the value ofCfnMethod.IntegrationProperty.getIntegrationResponses()
- Parameters:
integrationResponses
- Specifies the integration's responses.- Returns:
this
-
passthroughBehavior
@Stability(Stable) public CfnMethod.IntegrationProperty.Builder passthroughBehavior(String passthroughBehavior) Sets the value ofCfnMethod.IntegrationProperty.getPassthroughBehavior()
- Parameters:
passthroughBehavior
- Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified inrequestTemplates
. The valid value is one of the following:WHEN_NO_MATCH
: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.WHEN_NO_TEMPLATES
: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.NEVER
: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.- Returns:
this
-
requestParameters
@Stability(Stable) public CfnMethod.IntegrationProperty.Builder requestParameters(IResolvable requestParameters) Sets the value ofCfnMethod.IntegrationProperty.getRequestParameters()
- Parameters:
requestParameters
- A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern ofmethod.request.{location}.{name}
, wherelocation
isquerystring
,path
, orheader
andname
must be a valid and unique method request parameter name.- Returns:
this
-
requestParameters
@Stability(Stable) public CfnMethod.IntegrationProperty.Builder requestParameters(Map<String, String> requestParameters) Sets the value ofCfnMethod.IntegrationProperty.getRequestParameters()
- Parameters:
requestParameters
- A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern ofmethod.request.{location}.{name}
, wherelocation
isquerystring
,path
, orheader
andname
must be a valid and unique method request parameter name.- Returns:
this
-
requestTemplates
@Stability(Stable) public CfnMethod.IntegrationProperty.Builder requestTemplates(IResolvable requestTemplates) Sets the value ofCfnMethod.IntegrationProperty.getRequestTemplates()
- Parameters:
requestTemplates
- Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.- Returns:
this
-
requestTemplates
@Stability(Stable) public CfnMethod.IntegrationProperty.Builder requestTemplates(Map<String, String> requestTemplates) Sets the value ofCfnMethod.IntegrationProperty.getRequestTemplates()
- Parameters:
requestTemplates
- Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.- Returns:
this
-
timeoutInMillis
@Stability(Stable) public CfnMethod.IntegrationProperty.Builder timeoutInMillis(Number timeoutInMillis) Sets the value ofCfnMethod.IntegrationProperty.getTimeoutInMillis()
- Parameters:
timeoutInMillis
- Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.- Returns:
this
-
type
Sets the value ofCfnMethod.IntegrationProperty.getType()
- Parameters:
type
- Specifies an API method integration type. The valid value is one of the following:. For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https
), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with aconnectionType
ofVPC_LINK
is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.- Returns:
this
-
uri
Sets the value ofCfnMethod.IntegrationProperty.getUri()
- Parameters:
uri
- Specifies Uniform Resource Identifier (URI) of the integration endpoint. ForHTTP
orHTTP_PROXY
integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. IfconnectionType
isVPC_LINK
specify the Network Load Balancer DNS name. ForAWS
orAWS_PROXY
integrations, the URI is of the formarn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}
. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be eitherarn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}
orarn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnMethod.IntegrationProperty>
- Returns:
- a new instance of
CfnMethod.IntegrationProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-